drivers/staging/lustre/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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2014, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/include/lustre/ll_fiemap.h
  33  *
  34  * FIEMAP data structures and flags. This header file will be used until
  35  * fiemap.h is available in the upstream kernel.
  36  *
  37  * Author: Kalpak Shah <kalpak.shah@sun.com>
  38  * Author: Andreas Dilger <adilger@sun.com>
  39  */
  40
  41 #ifndef _LUSTRE_FIEMAP_H
  42 #define _LUSTRE_FIEMAP_H
  43
  44 struct ll_fiemap_extent {
  45         __u64 fe_logical;  /* logical offset in bytes for the start of
  46                             * the extent from the beginning of the file
  47                             */
  48         __u64 fe_physical; /* physical offset in bytes for the start
  49                             * of the extent from the beginning of the disk
  50                             */
  51         __u64 fe_length;   /* length in bytes for this extent */
  52         __u64 fe_reserved64[2];
  53         __u32 fe_flags;    /* FIEMAP_EXTENT_* flags for this extent */
  54         __u32 fe_device;   /* device number for this extent */
  55         __u32 fe_reserved[2];
  56 };
  57
  58 struct ll_user_fiemap {
  59         __u64 fm_start;  /* logical offset (inclusive) at
  60                           * which to start mapping (in)
  61                           */
  62         __u64 fm_length; /* logical length of mapping which
  63                           * userspace wants (in)
  64                           */
  65         __u32 fm_flags;  /* FIEMAP_FLAG_* flags for request (in/out) */
  66         __u32 fm_mapped_extents;/* number of extents that were mapped (out) */
  67         __u32 fm_extent_count;  /* size of fm_extents array (in) */
  68         __u32 fm_reserved;
  69         struct ll_fiemap_extent fm_extents[0]; /* array of mapped extents (out) */
  70 };
  71
  72 #define FIEMAP_MAX_OFFSET      (~0ULL)
  73
  74 #define FIEMAP_FLAG_SYNC                0x00000001 /* sync file data before
  75                                                     * map
  76                                                     */
  77 #define FIEMAP_FLAG_XATTR               0x00000002 /* map extended attribute
  78                                                     * tree
  79                                                     */
  80 #define FIEMAP_EXTENT_LAST              0x00000001 /* Last extent in file. */
  81 #define FIEMAP_EXTENT_UNKNOWN           0x00000002 /* Data location unknown. */
  82 #define FIEMAP_EXTENT_DELALLOC          0x00000004 /* Location still pending.
  83                                                     * Sets EXTENT_UNKNOWN.
  84                                                     */
  85 #define FIEMAP_EXTENT_ENCODED           0x00000008 /* Data can not be read
  86                                                     * while fs is unmounted
  87                                                     */
  88 #define FIEMAP_EXTENT_DATA_ENCRYPTED    0x00000080 /* Data is encrypted by fs.
  89                                                     * Sets EXTENT_NO_DIRECT.
  90                                                     */
  91 #define FIEMAP_EXTENT_NOT_ALIGNED       0x00000100 /* Extent offsets may not be
  92                                                     * block aligned.
  93                                                     */
  94 #define FIEMAP_EXTENT_DATA_INLINE       0x00000200 /* Data mixed with metadata.
  95                                                     * Sets EXTENT_NOT_ALIGNED.*/
  96 #define FIEMAP_EXTENT_DATA_TAIL         0x00000400 /* Multiple files in block.
  97                                                     * Sets EXTENT_NOT_ALIGNED.
  98                                                     */
  99 #define FIEMAP_EXTENT_UNWRITTEN         0x00000800 /* Space allocated, but
 100                                                     * no data (i.e. zero).
 101                                                     */
 102 #define FIEMAP_EXTENT_MERGED            0x00001000 /* File does not natively
 103                                                     * support extents. Result
 104                                                     * merged for efficiency.
 105                                                     */
 106
 107 static inline size_t fiemap_count_to_size(size_t extent_count)
 108 {
 109         return (sizeof(struct ll_user_fiemap) + extent_count *
 110                                                sizeof(struct ll_fiemap_extent));
 111 }
 112
 113 static inline unsigned fiemap_size_to_count(size_t array_size)
 114 {
 115         return ((array_size - sizeof(struct ll_user_fiemap)) /
 116                                                sizeof(struct ll_fiemap_extent));
 117 }
 118
 119 #define FIEMAP_FLAG_DEVICE_ORDER 0x40000000 /* return device ordered mapping */
 120
 121 #ifdef FIEMAP_FLAGS_COMPAT
 122 #undef FIEMAP_FLAGS_COMPAT
 123 #endif
 124
 125 /* Lustre specific flags - use a high bit, don't conflict with upstream flag */
 126 #define FIEMAP_EXTENT_NO_DIRECT  0x40000000 /* Data mapping undefined */
 127 #define FIEMAP_EXTENT_NET        0x80000000 /* Data stored remotely.
 128                                              * Sets NO_DIRECT flag
 129                                              */
 130
 131 #endif /* _LUSTRE_FIEMAP_H */