[PATCH] Extract and use wake_up_klogd()
[linux-2.6.git] / fs / hfsplus / hfsplus_raw.h
1 /*
2  *  linux/include/linux/hfsplus_raw.h
3  *
4  * Copyright (C) 1999
5  * Brad Boyer (flar@pants.nu)
6  * (C) 2003 Ardis Technologies <roman@ardistech.com>
7  *
8  * Format of structures on disk
9  * Information taken from Apple Technote #1150 (HFS Plus Volume Format)
10  *
11  */
12
13 #ifndef _LINUX_HFSPLUS_RAW_H
14 #define _LINUX_HFSPLUS_RAW_H
15
16 #include <linux/types.h>
17
18 #define __packed __attribute__ ((packed))
19
20 /* Some constants */
21 #define HFSPLUS_SECTOR_SIZE        512
22 #define HFSPLUS_SECTOR_SHIFT         9
23 #define HFSPLUS_VOLHEAD_SECTOR       2
24 #define HFSPLUS_VOLHEAD_SIG     0x482b
25 #define HFSPLUS_VOLHEAD_SIGX    0x4858
26 #define HFSPLUS_SUPER_MAGIC     0x482b
27 #define HFSPLUS_MIN_VERSION          4
28 #define HFSPLUS_CURRENT_VERSION      5
29
30 #define HFSP_WRAP_MAGIC         0x4244
31 #define HFSP_WRAP_ATTRIB_SLOCK  0x8000
32 #define HFSP_WRAP_ATTRIB_SPARED 0x0200
33
34 #define HFSP_WRAPOFF_SIG          0x00
35 #define HFSP_WRAPOFF_ATTRIB       0x0A
36 #define HFSP_WRAPOFF_ABLKSIZE     0x14
37 #define HFSP_WRAPOFF_ABLKSTART    0x1C
38 #define HFSP_WRAPOFF_EMBEDSIG     0x7C
39 #define HFSP_WRAPOFF_EMBEDEXT     0x7E
40
41 #define HFSP_HIDDENDIR_NAME     "\xe2\x90\x80\xe2\x90\x80\xe2\x90\x80\xe2\x90\x80HFS+ Private Data"
42
43 #define HFSP_HARDLINK_TYPE      0x686c6e6b      /* 'hlnk' */
44 #define HFSP_HFSPLUS_CREATOR    0x6866732b      /* 'hfs+' */
45
46 #define HFSP_SYMLINK_TYPE       0x736c6e6b      /* 'slnk' */
47 #define HFSP_SYMLINK_CREATOR    0x72686170      /* 'rhap' */
48
49 #define HFSP_MOUNT_VERSION      0x482b4c78      /* 'H+Lx' */
50
51 /* Structures used on disk */
52
53 typedef __be32 hfsplus_cnid;
54 typedef __be16 hfsplus_unichr;
55
56 /* A "string" as used in filenames, etc. */
57 struct hfsplus_unistr {
58         __be16 length;
59         hfsplus_unichr unicode[255];
60 } __packed;
61
62 #define HFSPLUS_MAX_STRLEN 255
63
64 /* POSIX permissions */
65 struct hfsplus_perm {
66         __be32 owner;
67         __be32 group;
68         u8  rootflags;
69         u8  userflags;
70         __be16 mode;
71         __be32 dev;
72 } __packed;
73
74 #define HFSPLUS_FLG_NODUMP      0x01
75 #define HFSPLUS_FLG_IMMUTABLE   0x02
76 #define HFSPLUS_FLG_APPEND      0x04
77
78 /* A single contiguous area of a file */
79 struct hfsplus_extent {
80         __be32 start_block;
81         __be32 block_count;
82 } __packed;
83 typedef struct hfsplus_extent hfsplus_extent_rec[8];
84
85 /* Information for a "Fork" in a file */
86 struct hfsplus_fork_raw {
87         __be64 total_size;
88         __be32 clump_size;
89         __be32 total_blocks;
90         hfsplus_extent_rec extents;
91 } __packed;
92
93 /* HFS+ Volume Header */
94 struct hfsplus_vh {
95         __be16 signature;
96         __be16 version;
97         __be32 attributes;
98         __be32 last_mount_vers;
99         u32 reserved;
100
101         __be32 create_date;
102         __be32 modify_date;
103         __be32 backup_date;
104         __be32 checked_date;
105
106         __be32 file_count;
107         __be32 folder_count;
108
109         __be32 blocksize;
110         __be32 total_blocks;
111         __be32 free_blocks;
112
113         __be32 next_alloc;
114         __be32 rsrc_clump_sz;
115         __be32 data_clump_sz;
116         hfsplus_cnid next_cnid;
117
118         __be32 write_count;
119         __be64 encodings_bmp;
120
121         u8 finder_info[32];
122
123         struct hfsplus_fork_raw alloc_file;
124         struct hfsplus_fork_raw ext_file;
125         struct hfsplus_fork_raw cat_file;
126         struct hfsplus_fork_raw attr_file;
127         struct hfsplus_fork_raw start_file;
128 } __packed;
129
130 /* HFS+ volume attributes */
131 #define HFSPLUS_VOL_UNMNT               (1 << 8)
132 #define HFSPLUS_VOL_SPARE_BLK           (1 << 9)
133 #define HFSPLUS_VOL_NOCACHE             (1 << 10)
134 #define HFSPLUS_VOL_INCNSTNT            (1 << 11)
135 #define HFSPLUS_VOL_NODEID_REUSED       (1 << 12)
136 #define HFSPLUS_VOL_JOURNALED           (1 << 13)
137 #define HFSPLUS_VOL_SOFTLOCK            (1 << 15)
138
139 /* HFS+ BTree node descriptor */
140 struct hfs_bnode_desc {
141         __be32 next;
142         __be32 prev;
143         s8 type;
144         u8 height;
145         __be16 num_recs;
146         u16 reserved;
147 } __packed;
148
149 /* HFS+ BTree node types */
150 #define HFS_NODE_INDEX  0x00
151 #define HFS_NODE_HEADER 0x01
152 #define HFS_NODE_MAP    0x02
153 #define HFS_NODE_LEAF   0xFF
154
155 /* HFS+ BTree header */
156 struct hfs_btree_header_rec {
157         __be16 depth;
158         __be32 root;
159         __be32 leaf_count;
160         __be32 leaf_head;
161         __be32 leaf_tail;
162         __be16 node_size;
163         __be16 max_key_len;
164         __be32 node_count;
165         __be32 free_nodes;
166         u16 reserved1;
167         __be32 clump_size;
168         u8 btree_type;
169         u8 key_type;
170         __be32 attributes;
171         u32 reserved3[16];
172 } __packed;
173
174 /* BTree attributes */
175 #define HFS_TREE_BIGKEYS        2
176 #define HFS_TREE_VARIDXKEYS     4
177
178 /* HFS+ BTree misc info */
179 #define HFSPLUS_TREE_HEAD 0
180 #define HFSPLUS_NODE_MXSZ 32768
181
182 /* Some special File ID numbers (stolen from hfs.h) */
183 #define HFSPLUS_POR_CNID                1       /* Parent Of the Root */
184 #define HFSPLUS_ROOT_CNID               2       /* ROOT directory */
185 #define HFSPLUS_EXT_CNID                3       /* EXTents B-tree */
186 #define HFSPLUS_CAT_CNID                4       /* CATalog B-tree */
187 #define HFSPLUS_BAD_CNID                5       /* BAD blocks file */
188 #define HFSPLUS_ALLOC_CNID              6       /* ALLOCation file */
189 #define HFSPLUS_START_CNID              7       /* STARTup file */
190 #define HFSPLUS_ATTR_CNID               8       /* ATTRibutes file */
191 #define HFSPLUS_EXCH_CNID               15      /* ExchangeFiles temp id */
192 #define HFSPLUS_FIRSTUSER_CNID          16      /* first available user id */
193
194 /* btree key type */
195 #define HFSPLUS_KEY_CASEFOLDING         0xCF    /* case-insensitive */
196 #define HFSPLUS_KEY_BINARY              0xBC    /* case-sensitive */
197
198 /* HFS+ catalog entry key */
199 struct hfsplus_cat_key {
200         __be16 key_len;
201         hfsplus_cnid parent;
202         struct hfsplus_unistr name;
203 } __packed;
204
205
206 /* Structs from hfs.h */
207 struct hfsp_point {
208         __be16 v;
209         __be16 h;
210 } __packed;
211
212 struct hfsp_rect {
213         __be16 top;
214         __be16 left;
215         __be16 bottom;
216         __be16 right;
217 } __packed;
218
219
220 /* HFS directory info (stolen from hfs.h */
221 struct DInfo {
222         struct hfsp_rect frRect;
223         __be16 frFlags;
224         struct hfsp_point frLocation;
225         __be16 frView;
226 } __packed;
227
228 struct DXInfo {
229         struct hfsp_point frScroll;
230         __be32 frOpenChain;
231         __be16 frUnused;
232         __be16 frComment;
233         __be32 frPutAway;
234 } __packed;
235
236 /* HFS+ folder data (part of an hfsplus_cat_entry) */
237 struct hfsplus_cat_folder {
238         __be16 type;
239         __be16 flags;
240         __be32 valence;
241         hfsplus_cnid id;
242         __be32 create_date;
243         __be32 content_mod_date;
244         __be32 attribute_mod_date;
245         __be32 access_date;
246         __be32 backup_date;
247         struct hfsplus_perm permissions;
248         struct DInfo user_info;
249         struct DXInfo finder_info;
250         __be32 text_encoding;
251         u32 reserved;
252 } __packed;
253
254 /* HFS file info (stolen from hfs.h) */
255 struct FInfo {
256         __be32 fdType;
257         __be32 fdCreator;
258         __be16 fdFlags;
259         struct hfsp_point fdLocation;
260         __be16 fdFldr;
261 } __packed;
262
263 struct FXInfo {
264         __be16 fdIconID;
265         u8 fdUnused[8];
266         __be16 fdComment;
267         __be32 fdPutAway;
268 } __packed;
269
270 /* HFS+ file data (part of a cat_entry) */
271 struct hfsplus_cat_file {
272         __be16 type;
273         __be16 flags;
274         u32 reserved1;
275         hfsplus_cnid id;
276         __be32 create_date;
277         __be32 content_mod_date;
278         __be32 attribute_mod_date;
279         __be32 access_date;
280         __be32 backup_date;
281         struct hfsplus_perm permissions;
282         struct FInfo user_info;
283         struct FXInfo finder_info;
284         __be32 text_encoding;
285         u32 reserved2;
286
287         struct hfsplus_fork_raw data_fork;
288         struct hfsplus_fork_raw rsrc_fork;
289 } __packed;
290
291 /* File attribute bits */
292 #define HFSPLUS_FILE_LOCKED             0x0001
293 #define HFSPLUS_FILE_THREAD_EXISTS      0x0002
294
295 /* HFS+ catalog thread (part of a cat_entry) */
296 struct hfsplus_cat_thread {
297         __be16 type;
298         s16 reserved;
299         hfsplus_cnid parentID;
300         struct hfsplus_unistr nodeName;
301 } __packed;
302
303 #define HFSPLUS_MIN_THREAD_SZ 10
304
305 /* A data record in the catalog tree */
306 typedef union {
307         __be16 type;
308         struct hfsplus_cat_folder folder;
309         struct hfsplus_cat_file file;
310         struct hfsplus_cat_thread thread;
311 } __packed hfsplus_cat_entry;
312
313 /* HFS+ catalog entry type */
314 #define HFSPLUS_FOLDER         0x0001
315 #define HFSPLUS_FILE           0x0002
316 #define HFSPLUS_FOLDER_THREAD  0x0003
317 #define HFSPLUS_FILE_THREAD    0x0004
318
319 /* HFS+ extents tree key */
320 struct hfsplus_ext_key {
321         __be16 key_len;
322         u8 fork_type;
323         u8 pad;
324         hfsplus_cnid cnid;
325         __be32 start_block;
326 } __packed;
327
328 #define HFSPLUS_EXT_KEYLEN 12
329
330 /* HFS+ generic BTree key */
331 typedef union {
332         __be16 key_len;
333         struct hfsplus_cat_key cat;
334         struct hfsplus_ext_key ext;
335 } __packed hfsplus_btree_key;
336
337 #endif