lustre/include/lustre/ll_fiemap.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lustre/ll_fiemap.h
  37  *
  38  * FIEMAP data structures and flags. This header file will be used until
  39  * fiemap.h is available in the upstream kernel.
  40  *
  41  * Author: Kalpak Shah <kalpak.shah@sun.com>
  42  * Author: Andreas Dilger <adilger@sun.com>
  43  */
  44
  45 #ifndef _LUSTRE_FIEMAP_H
  46 #define _LUSTRE_FIEMAP_H
  47
  48 #if !defined(HAVE_LINUX_FIEMAP_H) || !defined(__KERNEL__)
  49
  50 #ifndef __KERNEL__
  51 #include <libcfs/posix/posix-types.h>
  52 #endif
  53
  54 struct ll_fiemap_extent {
  55         __u64 fe_logical;  /* logical offset in bytes for the start of
  56                             * the extent from the beginning of the file */
  57         __u64 fe_physical; /* physical offset in bytes for the start
  58                             * of the extent from the beginning of the disk */
  59         __u64 fe_length;   /* length in bytes for this extent */
  60         __u64 fe_reserved64[2];
  61         __u32 fe_flags;    /* FIEMAP_EXTENT_* flags for this extent */
  62         __u32 fe_device;   /* device number for this extent */
  63         __u32 fe_reserved[2];
  64 };
  65
  66 struct ll_user_fiemap {
  67         __u64 fm_start;  /* logical offset (inclusive) at
  68                           * which to start mapping (in) */
  69         __u64 fm_length; /* logical length of mapping which
  70                           * userspace wants (in) */
  71         __u32 fm_flags;  /* FIEMAP_FLAG_* flags for request (in/out) */
  72         __u32 fm_mapped_extents;/* number of extents that were mapped (out) */
  73         __u32 fm_extent_count;  /* size of fm_extents array (in) */
  74         __u32 fm_reserved;
  75         struct ll_fiemap_extent fm_extents[0]; /* array of mapped extents (out) */
  76 };
  77
  78 #define FIEMAP_MAX_OFFSET      (~0ULL)
  79
  80 #define FIEMAP_FLAG_SYNC         0x00000001 /* sync file data before map */
  81 #define FIEMAP_FLAG_XATTR        0x00000002 /* map extended attribute tree */
  82
  83 #define FIEMAP_EXTENT_LAST              0x00000001 /* Last extent in file. */
  84 #define FIEMAP_EXTENT_UNKNOWN           0x00000002 /* Data location unknown. */
  85 #define FIEMAP_EXTENT_DELALLOC          0x00000004 /* Location still pending.
  86                                                     * Sets EXTENT_UNKNOWN. */
  87 #define FIEMAP_EXTENT_ENCODED           0x00000008 /* Data can not be read
  88                                                     * while fs is unmounted */
  89 #define FIEMAP_EXTENT_DATA_ENCRYPTED    0x00000080 /* Data is encrypted by fs.
  90                                                     * Sets EXTENT_NO_DIRECT. */
  91 #define FIEMAP_EXTENT_NOT_ALIGNED       0x00000100 /* Extent offsets may not be
  92                                                     * block aligned. */
  93 #define FIEMAP_EXTENT_DATA_INLINE       0x00000200 /* Data mixed with metadata.
  94                                                     * Sets EXTENT_NOT_ALIGNED.*/
  95 #define FIEMAP_EXTENT_DATA_TAIL         0x00000400 /* Multiple files in block.
  96                                                     * Sets EXTENT_NOT_ALIGNED.*/
  97 #define FIEMAP_EXTENT_UNWRITTEN         0x00000800 /* Space allocated, but
  98                                                     * no data (i.e. zero). */
  99 #define FIEMAP_EXTENT_MERGED            0x00001000 /* File does not natively
 100                                                     * support extents. Result
 101                                                     * merged for efficiency. */
 102
 103 #else
 104
 105 #define ll_fiemap_extent fiemap_extent
 106 #define ll_user_fiemap   fiemap
 107 #define fe_device        fe_reserved[0]
 108
 109 #endif /* HAVE_LINUX_FIEMAP_H */
 110
 111 static inline size_t fiemap_count_to_size(size_t extent_count)
 112 {
 113         return (sizeof(struct ll_user_fiemap) + extent_count *
 114                                                sizeof(struct ll_fiemap_extent));
 115 }
 116
 117 static inline unsigned fiemap_size_to_count(size_t array_size)
 118 {
 119         return ((array_size - sizeof(struct ll_user_fiemap)) /
 120                                                sizeof(struct ll_fiemap_extent));
 121 }
 122
 123 #define FIEMAP_FLAG_DEVICE_ORDER 0x40000000 /* return device ordered mapping */
 124
 125 #ifdef FIEMAP_FLAGS_COMPAT
 126 #undef FIEMAP_FLAGS_COMPAT
 127 #endif
 128
 129 /* Lustre specific flags - use a high bit, don't conflict with upstream flag */
 130 #define FIEMAP_EXTENT_NO_DIRECT         0x40000000 /* Data mapping undefined */
 131 #define FIEMAP_EXTENT_NET               0x80000000 /* Data stored remotely.
 132                                                     * Sets NO_DIRECT flag */
 133
 134 #endif /* _LUSTRE_FIEMAP_H */