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 struct ll_fiemap_extent {
47 __u64 fe_logical; /* logical offset in bytes for the start of
48 * the extent from the beginning of the file */
49 __u64 fe_physical; /* physical offset in bytes for the start
50 * of the extent from the beginning of the disk */
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 __u64 fm_length; /* logical length of mapping which
62 * userspace wants (in) */
63 __u32 fm_flags; /* FIEMAP_FLAG_* flags for request (in/out) */
64 __u32 fm_mapped_extents;/* number of extents that were mapped (out) */
65 __u32 fm_extent_count; /* size of fm_extents array (in) */
66 __u32 fm_reserved;
67 struct ll_fiemap_extent fm_extents[0]; /* array of mapped extents (out) */
68 };
69
70 #define FIEMAP_MAX_OFFSET (~0ULL)
71
72 #define FIEMAP_FLAG_SYNC 0x00000001 /* sync file data before map */
73 #define FIEMAP_FLAG_XATTR 0x00000002 /* map extended attribute tree */
74
75 #define FIEMAP_EXTENT_LAST 0x00000001 /* Last extent in file. */
76 #define FIEMAP_EXTENT_UNKNOWN 0x00000002 /* Data location unknown. */
77 #define FIEMAP_EXTENT_DELALLOC 0x00000004 /* Location still pending.
78 * Sets EXTENT_UNKNOWN. */
79 #define FIEMAP_EXTENT_ENCODED 0x00000008 /* Data can not be read
80 * while fs is unmounted */
81 #define FIEMAP_EXTENT_DATA_ENCRYPTED 0x00000080 /* Data is encrypted by fs.
82 * Sets EXTENT_NO_DIRECT. */
83 #define FIEMAP_EXTENT_NOT_ALIGNED 0x00000100 /* Extent offsets may not be
84 * block aligned. */
85 #define FIEMAP_EXTENT_DATA_INLINE 0x00000200 /* Data mixed with metadata.
86 * Sets EXTENT_NOT_ALIGNED.*/
87 #define FIEMAP_EXTENT_DATA_TAIL 0x00000400 /* Multiple files in block.
88 * Sets EXTENT_NOT_ALIGNED.*/
89 #define FIEMAP_EXTENT_UNWRITTEN 0x00000800 /* Space allocated, but
90 * no data (i.e. zero). */
91 #define FIEMAP_EXTENT_MERGED 0x00001000 /* File does not natively
92 * support extents. Result
93 * merged for efficiency. */
94
fiemap_count_to_size(size_t extent_count)95 static inline size_t fiemap_count_to_size(size_t extent_count)
96 {
97 return (sizeof(struct ll_user_fiemap) + extent_count *
98 sizeof(struct ll_fiemap_extent));
99 }
100
fiemap_size_to_count(size_t array_size)101 static inline unsigned fiemap_size_to_count(size_t array_size)
102 {
103 return ((array_size - sizeof(struct ll_user_fiemap)) /
104 sizeof(struct ll_fiemap_extent));
105 }
106
107 #define FIEMAP_FLAG_DEVICE_ORDER 0x40000000 /* return device ordered mapping */
108
109 #ifdef FIEMAP_FLAGS_COMPAT
110 #undef FIEMAP_FLAGS_COMPAT
111 #endif
112
113 /* Lustre specific flags - use a high bit, don't conflict with upstream flag */
114 #define FIEMAP_EXTENT_NO_DIRECT 0x40000000 /* Data mapping undefined */
115 #define FIEMAP_EXTENT_NET 0x80000000 /* Data stored remotely.
116 * Sets NO_DIRECT flag */
117
118 #endif /* _LUSTRE_FIEMAP_H */
119