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  2008 Sun Microsystems, Inc. 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 #ifndef HAVE_LINUX_FIEMAP_H
  49
  50 struct ll_fiemap_extent {
  51         __u64   fe_logical;  /* logical offset in bytes for the start of
  52                               * the extent from the beginning of the file */
  53         __u64   fe_physical; /* physical offset in bytes for the start
  54                               * of the extent from the beginning of the disk */
  55         __u64   fe_length;   /* length in bytes for the extent */
  56         __u32   fe_flags;    /* FIEMAP_EXTENT_* flags for the extent */
  57         __u32   fe_device;   /* device number for this extent */
  58 };
  59
  60 struct ll_user_fiemap {
  61         __u64   fm_start;         /* logical offset (inclusive) at
  62                                    * which to start mapping (in) */
  63         __u64   fm_length;        /* logical length of mapping which
  64                                    * userspace wants (in) */
  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                                                    * Lustre uses first extent to
  71                                                    * send end_offset */
  72 };
  73
  74 #define FIEMAP_MAX_OFFSET      (~0ULL)
  75
  76 #define FIEMAP_FLAG_SYNC         0x00000001 /* sync file data before map */
  77 #define FIEMAP_FLAG_XATTR        0x00000002 /* map extended attribute tree */
  78 #define FIEMAP_FLAG_DEVICE_ORDER 0x40000000 /* return device ordered mapping */
  79
  80 #define FIEMAP_FLAGS_COMPAT    (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_XATTR | \
  81                                 FIEMAP_FLAG_DEVICE_ORDER)
  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_NO_DIRECT        0x00000008 /* Data mapping undefined */
  88 #define FIEMAP_EXTENT_SECONDARY        0x00000010 /* Data copied offline. May
  89                                                    * set EXTENT_NO_DIRECT. */
  90 #define FIEMAP_EXTENT_NET              0x00000020 /* Data stored remotely.
  91                                                    * Sets EXTENT_NO_DIRECT. */
  92 #define FIEMAP_EXTENT_DATA_COMPRESSED  0x00000040 /* Data is compressed by fs.
  93                                                    * Sets EXTENT_NO_DIRECT. */
  94 #define FIEMAP_EXTENT_DATA_ENCRYPTED   0x00000080 /* Data is encrypted by fs.
  95                                                    * Sets EXTENT_NO_DIRECT. */
  96 #define FIEMAP_EXTENT_NOT_ALIGNED      0x00000100 /* Extent offsets may not be
  97                                                    * block aligned. */
  98 #define FIEMAP_EXTENT_DATA_INLINE      0x00000200 /* Data mixed with metadata.
  99                                                    * Sets EXTENT_NOT_ALIGNED.*/
 100 #define FIEMAP_EXTENT_DATA_TAIL        0x00000400 /* Multiple files in block.
 101                                                    * Sets EXTENT_NOT_ALIGNED.*/
 102 #define FIEMAP_EXTENT_UNWRITTEN        0x00000800 /* Space allocated, but
 103                                                    * no data (i.e. zero). */
 104 #define FIEMAP_EXTENT_MERGED           0x00001000 /* File does not natively
 105                                                    * support extents. Result
 106                                                    * merged for efficiency. */
 107
 108 #else
 109
 110 #define ll_fiemap_extent fiemap_extent
 111 #define ll_user_fiemap   fiemap
 112
 113 #endif /* HAVE_LINUX_FIEMAP_H */
 114
 115 static inline size_t fiemap_count_to_size(size_t extent_count)
 116 {
 117         return (sizeof(struct ll_user_fiemap) + extent_count *
 118                                                sizeof(struct ll_fiemap_extent));
 119 }
 120
 121 static inline unsigned fiemap_size_to_count(size_t array_size)
 122 {
 123         return ((array_size - sizeof(struct ll_user_fiemap)) /
 124                                                sizeof(struct ll_fiemap_extent));
 125 }
 126
 127 #endif /* _LUSTRE_FIEMAP_H */