lustre/include/lustre/ll_fiemap.h

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