Root/
1 | /* |
2 | * This file is part of UBIFS. |
3 | * |
4 | * Copyright (C) 2006-2008 Nokia Corporation. |
5 | * |
6 | * This program is free software; you can redistribute it and/or modify it |
7 | * under the terms of the GNU General Public License version 2 as published by |
8 | * the Free Software Foundation. |
9 | * |
10 | * This program is distributed in the hope that it will be useful, but WITHOUT |
11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
13 | * more details. |
14 | * |
15 | * You should have received a copy of the GNU General Public License along with |
16 | * this program; if not, write to the Free Software Foundation, Inc., 51 |
17 | * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
18 | * |
19 | * Authors: Artem Bityutskiy (Битюцкий Артём) |
20 | * Adrian Hunter |
21 | */ |
22 | |
23 | /* |
24 | * This file describes UBIFS on-flash format and contains definitions of all the |
25 | * relevant data structures and constants. |
26 | * |
27 | * All UBIFS on-flash objects are stored in the form of nodes. All nodes start |
28 | * with the UBIFS node magic number and have the same common header. Nodes |
29 | * always sit at 8-byte aligned positions on the media and node header sizes are |
30 | * also 8-byte aligned (except for the indexing node and the padding node). |
31 | */ |
32 | |
33 | #ifndef __UBIFS_MEDIA_H__ |
34 | #define __UBIFS_MEDIA_H__ |
35 | |
36 | /* UBIFS node magic number (must not have the padding byte first or last) */ |
37 | #define UBIFS_NODE_MAGIC 0x06101831 |
38 | |
39 | /* |
40 | * UBIFS on-flash format version. This version is increased when the on-flash |
41 | * format is changing. If this happens, UBIFS is will support older versions as |
42 | * well. But older UBIFS code will not support newer formats. Format changes |
43 | * will be rare and only when absolutely necessary, e.g. to fix a bug or to add |
44 | * a new feature. |
45 | * |
46 | * UBIFS went into mainline kernel with format version 4. The older formats |
47 | * were development formats. |
48 | */ |
49 | #define UBIFS_FORMAT_VERSION 4 |
50 | |
51 | /* |
52 | * Read-only compatibility version. If the UBIFS format is changed, older UBIFS |
53 | * implementations will not be able to mount newer formats in read-write mode. |
54 | * However, depending on the change, it may be possible to mount newer formats |
55 | * in R/O mode. This is indicated by the R/O compatibility version which is |
56 | * stored in the super-block. |
57 | * |
58 | * This is needed to support boot-loaders which only need R/O mounting. With |
59 | * this flag it is possible to do UBIFS format changes without a need to update |
60 | * boot-loaders. |
61 | */ |
62 | #define UBIFS_RO_COMPAT_VERSION 0 |
63 | |
64 | /* Minimum logical eraseblock size in bytes */ |
65 | #define UBIFS_MIN_LEB_SZ (15*1024) |
66 | |
67 | /* Initial CRC32 value used when calculating CRC checksums */ |
68 | #define UBIFS_CRC32_INIT 0xFFFFFFFFU |
69 | |
70 | /* |
71 | * UBIFS does not try to compress data if its length is less than the below |
72 | * constant. |
73 | */ |
74 | #define UBIFS_MIN_COMPR_LEN 128 |
75 | |
76 | /* |
77 | * If compressed data length is less than %UBIFS_MIN_COMPRESS_DIFF bytes |
78 | * shorter than uncompressed data length, UBIFS prefers to leave this data |
79 | * node uncompress, because it'll be read faster. |
80 | */ |
81 | #define UBIFS_MIN_COMPRESS_DIFF 64 |
82 | |
83 | /* Root inode number */ |
84 | #define UBIFS_ROOT_INO 1 |
85 | |
86 | /* Lowest inode number used for regular inodes (not UBIFS-only internal ones) */ |
87 | #define UBIFS_FIRST_INO 64 |
88 | |
89 | /* |
90 | * Maximum file name and extended attribute length (must be a multiple of 8, |
91 | * minus 1). |
92 | */ |
93 | #define UBIFS_MAX_NLEN 255 |
94 | |
95 | /* Maximum number of data journal heads */ |
96 | #define UBIFS_MAX_JHEADS 1 |
97 | |
98 | /* |
99 | * Size of UBIFS data block. Note, UBIFS is not a block oriented file-system, |
100 | * which means that it does not treat the underlying media as consisting of |
101 | * blocks like in case of hard drives. Do not be confused. UBIFS block is just |
102 | * the maximum amount of data which one data node can have or which can be |
103 | * attached to an inode node. |
104 | */ |
105 | #define UBIFS_BLOCK_SIZE 4096 |
106 | #define UBIFS_BLOCK_SHIFT 12 |
107 | |
108 | /* UBIFS padding byte pattern (must not be first or last byte of node magic) */ |
109 | #define UBIFS_PADDING_BYTE 0xCE |
110 | |
111 | /* Maximum possible key length */ |
112 | #define UBIFS_MAX_KEY_LEN 16 |
113 | |
114 | /* Key length ("simple" format) */ |
115 | #define UBIFS_SK_LEN 8 |
116 | |
117 | /* Minimum index tree fanout */ |
118 | #define UBIFS_MIN_FANOUT 3 |
119 | |
120 | /* Maximum number of levels in UBIFS indexing B-tree */ |
121 | #define UBIFS_MAX_LEVELS 512 |
122 | |
123 | /* Maximum amount of data attached to an inode in bytes */ |
124 | #define UBIFS_MAX_INO_DATA UBIFS_BLOCK_SIZE |
125 | |
126 | /* LEB Properties Tree fanout (must be power of 2) and fanout shift */ |
127 | #define UBIFS_LPT_FANOUT 4 |
128 | #define UBIFS_LPT_FANOUT_SHIFT 2 |
129 | |
130 | /* LEB Properties Tree bit field sizes */ |
131 | #define UBIFS_LPT_CRC_BITS 16 |
132 | #define UBIFS_LPT_CRC_BYTES 2 |
133 | #define UBIFS_LPT_TYPE_BITS 4 |
134 | |
135 | /* The key is always at the same position in all keyed nodes */ |
136 | #define UBIFS_KEY_OFFSET offsetof(struct ubifs_ino_node, key) |
137 | |
138 | /* Garbage collector journal head number */ |
139 | #define UBIFS_GC_HEAD 0 |
140 | /* Base journal head number */ |
141 | #define UBIFS_BASE_HEAD 1 |
142 | /* Data journal head number */ |
143 | #define UBIFS_DATA_HEAD 2 |
144 | |
145 | /* |
146 | * LEB Properties Tree node types. |
147 | * |
148 | * UBIFS_LPT_PNODE: LPT leaf node (contains LEB properties) |
149 | * UBIFS_LPT_NNODE: LPT internal node |
150 | * UBIFS_LPT_LTAB: LPT's own lprops table |
151 | * UBIFS_LPT_LSAVE: LPT's save table (big model only) |
152 | * UBIFS_LPT_NODE_CNT: count of LPT node types |
153 | * UBIFS_LPT_NOT_A_NODE: all ones (15 for 4 bits) is never a valid node type |
154 | */ |
155 | enum { |
156 | UBIFS_LPT_PNODE, |
157 | UBIFS_LPT_NNODE, |
158 | UBIFS_LPT_LTAB, |
159 | UBIFS_LPT_LSAVE, |
160 | UBIFS_LPT_NODE_CNT, |
161 | UBIFS_LPT_NOT_A_NODE = (1 << UBIFS_LPT_TYPE_BITS) - 1, |
162 | }; |
163 | |
164 | /* |
165 | * UBIFS inode types. |
166 | * |
167 | * UBIFS_ITYPE_REG: regular file |
168 | * UBIFS_ITYPE_DIR: directory |
169 | * UBIFS_ITYPE_LNK: soft link |
170 | * UBIFS_ITYPE_BLK: block device node |
171 | * UBIFS_ITYPE_CHR: character device node |
172 | * UBIFS_ITYPE_FIFO: fifo |
173 | * UBIFS_ITYPE_SOCK: socket |
174 | * UBIFS_ITYPES_CNT: count of supported file types |
175 | */ |
176 | enum { |
177 | UBIFS_ITYPE_REG, |
178 | UBIFS_ITYPE_DIR, |
179 | UBIFS_ITYPE_LNK, |
180 | UBIFS_ITYPE_BLK, |
181 | UBIFS_ITYPE_CHR, |
182 | UBIFS_ITYPE_FIFO, |
183 | UBIFS_ITYPE_SOCK, |
184 | UBIFS_ITYPES_CNT, |
185 | }; |
186 | |
187 | /* |
188 | * Supported key hash functions. |
189 | * |
190 | * UBIFS_KEY_HASH_R5: R5 hash |
191 | * UBIFS_KEY_HASH_TEST: test hash which just returns first 4 bytes of the name |
192 | */ |
193 | enum { |
194 | UBIFS_KEY_HASH_R5, |
195 | UBIFS_KEY_HASH_TEST, |
196 | }; |
197 | |
198 | /* |
199 | * Supported key formats. |
200 | * |
201 | * UBIFS_SIMPLE_KEY_FMT: simple key format |
202 | */ |
203 | enum { |
204 | UBIFS_SIMPLE_KEY_FMT, |
205 | }; |
206 | |
207 | /* |
208 | * The simple key format uses 29 bits for storing UBIFS block number and hash |
209 | * value. |
210 | */ |
211 | #define UBIFS_S_KEY_BLOCK_BITS 29 |
212 | #define UBIFS_S_KEY_BLOCK_MASK 0x1FFFFFFF |
213 | #define UBIFS_S_KEY_HASH_BITS UBIFS_S_KEY_BLOCK_BITS |
214 | #define UBIFS_S_KEY_HASH_MASK UBIFS_S_KEY_BLOCK_MASK |
215 | |
216 | /* |
217 | * Key types. |
218 | * |
219 | * UBIFS_INO_KEY: inode node key |
220 | * UBIFS_DATA_KEY: data node key |
221 | * UBIFS_DENT_KEY: directory entry node key |
222 | * UBIFS_XENT_KEY: extended attribute entry key |
223 | * UBIFS_KEY_TYPES_CNT: number of supported key types |
224 | */ |
225 | enum { |
226 | UBIFS_INO_KEY, |
227 | UBIFS_DATA_KEY, |
228 | UBIFS_DENT_KEY, |
229 | UBIFS_XENT_KEY, |
230 | UBIFS_KEY_TYPES_CNT, |
231 | }; |
232 | |
233 | /* Count of LEBs reserved for the superblock area */ |
234 | #define UBIFS_SB_LEBS 1 |
235 | /* Count of LEBs reserved for the master area */ |
236 | #define UBIFS_MST_LEBS 2 |
237 | |
238 | /* First LEB of the superblock area */ |
239 | #define UBIFS_SB_LNUM 0 |
240 | /* First LEB of the master area */ |
241 | #define UBIFS_MST_LNUM (UBIFS_SB_LNUM + UBIFS_SB_LEBS) |
242 | /* First LEB of the log area */ |
243 | #define UBIFS_LOG_LNUM (UBIFS_MST_LNUM + UBIFS_MST_LEBS) |
244 | |
245 | /* |
246 | * The below constants define the absolute minimum values for various UBIFS |
247 | * media areas. Many of them actually depend of flash geometry and the FS |
248 | * configuration (number of journal heads, orphan LEBs, etc). This means that |
249 | * the smallest volume size which can be used for UBIFS cannot be pre-defined |
250 | * by these constants. The file-system that meets the below limitation will not |
251 | * necessarily mount. UBIFS does run-time calculations and validates the FS |
252 | * size. |
253 | */ |
254 | |
255 | /* Minimum number of logical eraseblocks in the log */ |
256 | #define UBIFS_MIN_LOG_LEBS 2 |
257 | /* Minimum number of bud logical eraseblocks (one for each head) */ |
258 | #define UBIFS_MIN_BUD_LEBS 3 |
259 | /* Minimum number of journal logical eraseblocks */ |
260 | #define UBIFS_MIN_JNL_LEBS (UBIFS_MIN_LOG_LEBS + UBIFS_MIN_BUD_LEBS) |
261 | /* Minimum number of LPT area logical eraseblocks */ |
262 | #define UBIFS_MIN_LPT_LEBS 2 |
263 | /* Minimum number of orphan area logical eraseblocks */ |
264 | #define UBIFS_MIN_ORPH_LEBS 1 |
265 | /* |
266 | * Minimum number of main area logical eraseblocks (buds, 3 for the index, 1 |
267 | * for GC, 1 for deletions, and at least 1 for committed data). |
268 | */ |
269 | #define UBIFS_MIN_MAIN_LEBS (UBIFS_MIN_BUD_LEBS + 6) |
270 | |
271 | /* Minimum number of logical eraseblocks */ |
272 | #define UBIFS_MIN_LEB_CNT (UBIFS_SB_LEBS + UBIFS_MST_LEBS + \ |
273 | UBIFS_MIN_LOG_LEBS + UBIFS_MIN_LPT_LEBS + \ |
274 | UBIFS_MIN_ORPH_LEBS + UBIFS_MIN_MAIN_LEBS) |
275 | |
276 | /* Node sizes (N.B. these are guaranteed to be multiples of 8) */ |
277 | #define UBIFS_CH_SZ sizeof(struct ubifs_ch) |
278 | #define UBIFS_INO_NODE_SZ sizeof(struct ubifs_ino_node) |
279 | #define UBIFS_DATA_NODE_SZ sizeof(struct ubifs_data_node) |
280 | #define UBIFS_DENT_NODE_SZ sizeof(struct ubifs_dent_node) |
281 | #define UBIFS_TRUN_NODE_SZ sizeof(struct ubifs_trun_node) |
282 | #define UBIFS_PAD_NODE_SZ sizeof(struct ubifs_pad_node) |
283 | #define UBIFS_SB_NODE_SZ sizeof(struct ubifs_sb_node) |
284 | #define UBIFS_MST_NODE_SZ sizeof(struct ubifs_mst_node) |
285 | #define UBIFS_REF_NODE_SZ sizeof(struct ubifs_ref_node) |
286 | #define UBIFS_IDX_NODE_SZ sizeof(struct ubifs_idx_node) |
287 | #define UBIFS_CS_NODE_SZ sizeof(struct ubifs_cs_node) |
288 | #define UBIFS_ORPH_NODE_SZ sizeof(struct ubifs_orph_node) |
289 | /* Extended attribute entry nodes are identical to directory entry nodes */ |
290 | #define UBIFS_XENT_NODE_SZ UBIFS_DENT_NODE_SZ |
291 | /* Only this does not have to be multiple of 8 bytes */ |
292 | #define UBIFS_BRANCH_SZ sizeof(struct ubifs_branch) |
293 | |
294 | /* Maximum node sizes (N.B. these are guaranteed to be multiples of 8) */ |
295 | #define UBIFS_MAX_DATA_NODE_SZ (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE) |
296 | #define UBIFS_MAX_INO_NODE_SZ (UBIFS_INO_NODE_SZ + UBIFS_MAX_INO_DATA) |
297 | #define UBIFS_MAX_DENT_NODE_SZ (UBIFS_DENT_NODE_SZ + UBIFS_MAX_NLEN + 1) |
298 | #define UBIFS_MAX_XENT_NODE_SZ UBIFS_MAX_DENT_NODE_SZ |
299 | |
300 | /* The largest UBIFS node */ |
301 | #define UBIFS_MAX_NODE_SZ UBIFS_MAX_INO_NODE_SZ |
302 | |
303 | /* |
304 | * On-flash inode flags. |
305 | * |
306 | * UBIFS_COMPR_FL: use compression for this inode |
307 | * UBIFS_SYNC_FL: I/O on this inode has to be synchronous |
308 | * UBIFS_IMMUTABLE_FL: inode is immutable |
309 | * UBIFS_APPEND_FL: writes to the inode may only append data |
310 | * UBIFS_DIRSYNC_FL: I/O on this directory inode has to be synchronous |
311 | * UBIFS_XATTR_FL: this inode is the inode for an extended attribute value |
312 | * |
313 | * Note, these are on-flash flags which correspond to ioctl flags |
314 | * (@FS_COMPR_FL, etc). They have the same values now, but generally, do not |
315 | * have to be the same. |
316 | */ |
317 | enum { |
318 | UBIFS_COMPR_FL = 0x01, |
319 | UBIFS_SYNC_FL = 0x02, |
320 | UBIFS_IMMUTABLE_FL = 0x04, |
321 | UBIFS_APPEND_FL = 0x08, |
322 | UBIFS_DIRSYNC_FL = 0x10, |
323 | UBIFS_XATTR_FL = 0x20, |
324 | }; |
325 | |
326 | /* Inode flag bits used by UBIFS */ |
327 | #define UBIFS_FL_MASK 0x0000001F |
328 | |
329 | /* |
330 | * UBIFS compression algorithms. |
331 | * |
332 | * UBIFS_COMPR_NONE: no compression |
333 | * UBIFS_COMPR_LZO: LZO compression |
334 | * UBIFS_COMPR_ZLIB: ZLIB compression |
335 | * UBIFS_COMPR_TYPES_CNT: count of supported compression types |
336 | */ |
337 | enum { |
338 | UBIFS_COMPR_NONE, |
339 | UBIFS_COMPR_LZO, |
340 | UBIFS_COMPR_ZLIB, |
341 | UBIFS_COMPR_TYPES_CNT, |
342 | }; |
343 | |
344 | /* |
345 | * UBIFS node types. |
346 | * |
347 | * UBIFS_INO_NODE: inode node |
348 | * UBIFS_DATA_NODE: data node |
349 | * UBIFS_DENT_NODE: directory entry node |
350 | * UBIFS_XENT_NODE: extended attribute node |
351 | * UBIFS_TRUN_NODE: truncation node |
352 | * UBIFS_PAD_NODE: padding node |
353 | * UBIFS_SB_NODE: superblock node |
354 | * UBIFS_MST_NODE: master node |
355 | * UBIFS_REF_NODE: LEB reference node |
356 | * UBIFS_IDX_NODE: index node |
357 | * UBIFS_CS_NODE: commit start node |
358 | * UBIFS_ORPH_NODE: orphan node |
359 | * UBIFS_NODE_TYPES_CNT: count of supported node types |
360 | * |
361 | * Note, we index arrays by these numbers, so keep them low and contiguous. |
362 | * Node type constants for inodes, direntries and so on have to be the same as |
363 | * corresponding key type constants. |
364 | */ |
365 | enum { |
366 | UBIFS_INO_NODE, |
367 | UBIFS_DATA_NODE, |
368 | UBIFS_DENT_NODE, |
369 | UBIFS_XENT_NODE, |
370 | UBIFS_TRUN_NODE, |
371 | UBIFS_PAD_NODE, |
372 | UBIFS_SB_NODE, |
373 | UBIFS_MST_NODE, |
374 | UBIFS_REF_NODE, |
375 | UBIFS_IDX_NODE, |
376 | UBIFS_CS_NODE, |
377 | UBIFS_ORPH_NODE, |
378 | UBIFS_NODE_TYPES_CNT, |
379 | }; |
380 | |
381 | /* |
382 | * Master node flags. |
383 | * |
384 | * UBIFS_MST_DIRTY: rebooted uncleanly - master node is dirty |
385 | * UBIFS_MST_NO_ORPHS: no orphan inodes present |
386 | * UBIFS_MST_RCVRY: written by recovery |
387 | */ |
388 | enum { |
389 | UBIFS_MST_DIRTY = 1, |
390 | UBIFS_MST_NO_ORPHS = 2, |
391 | UBIFS_MST_RCVRY = 4, |
392 | }; |
393 | |
394 | /* |
395 | * Node group type (used by recovery to recover whole group or none). |
396 | * |
397 | * UBIFS_NO_NODE_GROUP: this node is not part of a group |
398 | * UBIFS_IN_NODE_GROUP: this node is a part of a group |
399 | * UBIFS_LAST_OF_NODE_GROUP: this node is the last in a group |
400 | */ |
401 | enum { |
402 | UBIFS_NO_NODE_GROUP = 0, |
403 | UBIFS_IN_NODE_GROUP, |
404 | UBIFS_LAST_OF_NODE_GROUP, |
405 | }; |
406 | |
407 | /* |
408 | * Superblock flags. |
409 | * |
410 | * UBIFS_FLG_BIGLPT: if "big" LPT model is used if set |
411 | */ |
412 | enum { |
413 | UBIFS_FLG_BIGLPT = 0x02, |
414 | }; |
415 | |
416 | /** |
417 | * struct ubifs_ch - common header node. |
418 | * @magic: UBIFS node magic number (%UBIFS_NODE_MAGIC) |
419 | * @crc: CRC-32 checksum of the node header |
420 | * @sqnum: sequence number |
421 | * @len: full node length |
422 | * @node_type: node type |
423 | * @group_type: node group type |
424 | * @padding: reserved for future, zeroes |
425 | * |
426 | * Every UBIFS node starts with this common part. If the node has a key, the |
427 | * key always goes next. |
428 | */ |
429 | struct ubifs_ch { |
430 | __le32 magic; |
431 | __le32 crc; |
432 | __le64 sqnum; |
433 | __le32 len; |
434 | __u8 node_type; |
435 | __u8 group_type; |
436 | __u8 padding[2]; |
437 | } __attribute__ ((packed)); |
438 | |
439 | /** |
440 | * union ubifs_dev_desc - device node descriptor. |
441 | * @new: new type device descriptor |
442 | * @huge: huge type device descriptor |
443 | * |
444 | * This data structure describes major/minor numbers of a device node. In an |
445 | * inode is a device node then its data contains an object of this type. UBIFS |
446 | * uses standard Linux "new" and "huge" device node encodings. |
447 | */ |
448 | union ubifs_dev_desc { |
449 | __le32 new; |
450 | __le64 huge; |
451 | } __attribute__ ((packed)); |
452 | |
453 | /** |
454 | * struct ubifs_ino_node - inode node. |
455 | * @ch: common header |
456 | * @key: node key |
457 | * @creat_sqnum: sequence number at time of creation |
458 | * @size: inode size in bytes (amount of uncompressed data) |
459 | * @atime_sec: access time seconds |
460 | * @ctime_sec: creation time seconds |
461 | * @mtime_sec: modification time seconds |
462 | * @atime_nsec: access time nanoseconds |
463 | * @ctime_nsec: creation time nanoseconds |
464 | * @mtime_nsec: modification time nanoseconds |
465 | * @nlink: number of hard links |
466 | * @uid: owner ID |
467 | * @gid: group ID |
468 | * @mode: access flags |
469 | * @flags: per-inode flags (%UBIFS_COMPR_FL, %UBIFS_SYNC_FL, etc) |
470 | * @data_len: inode data length |
471 | * @xattr_cnt: count of extended attributes this inode has |
472 | * @xattr_size: summarized size of all extended attributes in bytes |
473 | * @padding1: reserved for future, zeroes |
474 | * @xattr_names: sum of lengths of all extended attribute names belonging to |
475 | * this inode |
476 | * @compr_type: compression type used for this inode |
477 | * @padding2: reserved for future, zeroes |
478 | * @data: data attached to the inode |
479 | * |
480 | * Note, even though inode compression type is defined by @compr_type, some |
481 | * nodes of this inode may be compressed with different compressor - this |
482 | * happens if compression type is changed while the inode already has data |
483 | * nodes. But @compr_type will be use for further writes to the inode. |
484 | * |
485 | * Note, do not forget to amend 'zero_ino_node_unused()' function when changing |
486 | * the padding fields. |
487 | */ |
488 | struct ubifs_ino_node { |
489 | struct ubifs_ch ch; |
490 | __u8 key[UBIFS_MAX_KEY_LEN]; |
491 | __le64 creat_sqnum; |
492 | __le64 size; |
493 | __le64 atime_sec; |
494 | __le64 ctime_sec; |
495 | __le64 mtime_sec; |
496 | __le32 atime_nsec; |
497 | __le32 ctime_nsec; |
498 | __le32 mtime_nsec; |
499 | __le32 nlink; |
500 | __le32 uid; |
501 | __le32 gid; |
502 | __le32 mode; |
503 | __le32 flags; |
504 | __le32 data_len; |
505 | __le32 xattr_cnt; |
506 | __le32 xattr_size; |
507 | __u8 padding1[4]; /* Watch 'zero_ino_node_unused()' if changing! */ |
508 | __le32 xattr_names; |
509 | __le16 compr_type; |
510 | __u8 padding2[26]; /* Watch 'zero_ino_node_unused()' if changing! */ |
511 | __u8 data[]; |
512 | } __attribute__ ((packed)); |
513 | |
514 | /** |
515 | * struct ubifs_dent_node - directory entry node. |
516 | * @ch: common header |
517 | * @key: node key |
518 | * @inum: target inode number |
519 | * @padding1: reserved for future, zeroes |
520 | * @type: type of the target inode (%UBIFS_ITYPE_REG, %UBIFS_ITYPE_DIR, etc) |
521 | * @nlen: name length |
522 | * @padding2: reserved for future, zeroes |
523 | * @name: zero-terminated name |
524 | * |
525 | * Note, do not forget to amend 'zero_dent_node_unused()' function when |
526 | * changing the padding fields. |
527 | */ |
528 | struct ubifs_dent_node { |
529 | struct ubifs_ch ch; |
530 | __u8 key[UBIFS_MAX_KEY_LEN]; |
531 | __le64 inum; |
532 | __u8 padding1; |
533 | __u8 type; |
534 | __le16 nlen; |
535 | __u8 padding2[4]; /* Watch 'zero_dent_node_unused()' if changing! */ |
536 | __u8 name[]; |
537 | } __attribute__ ((packed)); |
538 | |
539 | /** |
540 | * struct ubifs_data_node - data node. |
541 | * @ch: common header |
542 | * @key: node key |
543 | * @size: uncompressed data size in bytes |
544 | * @compr_type: compression type (%UBIFS_COMPR_NONE, %UBIFS_COMPR_LZO, etc) |
545 | * @padding: reserved for future, zeroes |
546 | * @data: data |
547 | * |
548 | * Note, do not forget to amend 'zero_data_node_unused()' function when |
549 | * changing the padding fields. |
550 | */ |
551 | struct ubifs_data_node { |
552 | struct ubifs_ch ch; |
553 | __u8 key[UBIFS_MAX_KEY_LEN]; |
554 | __le32 size; |
555 | __le16 compr_type; |
556 | __u8 padding[2]; /* Watch 'zero_data_node_unused()' if changing! */ |
557 | __u8 data[]; |
558 | } __attribute__ ((packed)); |
559 | |
560 | /** |
561 | * struct ubifs_trun_node - truncation node. |
562 | * @ch: common header |
563 | * @inum: truncated inode number |
564 | * @padding: reserved for future, zeroes |
565 | * @old_size: size before truncation |
566 | * @new_size: size after truncation |
567 | * |
568 | * This node exists only in the journal and never goes to the main area. Note, |
569 | * do not forget to amend 'zero_trun_node_unused()' function when changing the |
570 | * padding fields. |
571 | */ |
572 | struct ubifs_trun_node { |
573 | struct ubifs_ch ch; |
574 | __le32 inum; |
575 | __u8 padding[12]; /* Watch 'zero_trun_node_unused()' if changing! */ |
576 | __le64 old_size; |
577 | __le64 new_size; |
578 | } __attribute__ ((packed)); |
579 | |
580 | /** |
581 | * struct ubifs_pad_node - padding node. |
582 | * @ch: common header |
583 | * @pad_len: how many bytes after this node are unused (because padded) |
584 | * @padding: reserved for future, zeroes |
585 | */ |
586 | struct ubifs_pad_node { |
587 | struct ubifs_ch ch; |
588 | __le32 pad_len; |
589 | } __attribute__ ((packed)); |
590 | |
591 | /** |
592 | * struct ubifs_sb_node - superblock node. |
593 | * @ch: common header |
594 | * @padding: reserved for future, zeroes |
595 | * @key_hash: type of hash function used in keys |
596 | * @key_fmt: format of the key |
597 | * @flags: file-system flags (%UBIFS_FLG_BIGLPT, etc) |
598 | * @min_io_size: minimal input/output unit size |
599 | * @leb_size: logical eraseblock size in bytes |
600 | * @leb_cnt: count of LEBs used by file-system |
601 | * @max_leb_cnt: maximum count of LEBs used by file-system |
602 | * @max_bud_bytes: maximum amount of data stored in buds |
603 | * @log_lebs: log size in logical eraseblocks |
604 | * @lpt_lebs: number of LEBs used for lprops table |
605 | * @orph_lebs: number of LEBs used for recording orphans |
606 | * @jhead_cnt: count of journal heads |
607 | * @fanout: tree fanout (max. number of links per indexing node) |
608 | * @lsave_cnt: number of LEB numbers in LPT's save table |
609 | * @fmt_version: UBIFS on-flash format version |
610 | * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc) |
611 | * @padding1: reserved for future, zeroes |
612 | * @rp_uid: reserve pool UID |
613 | * @rp_gid: reserve pool GID |
614 | * @rp_size: size of the reserved pool in bytes |
615 | * @padding2: reserved for future, zeroes |
616 | * @time_gran: time granularity in nanoseconds |
617 | * @uuid: UUID generated when the file system image was created |
618 | * @ro_compat_version: UBIFS R/O compatibility version |
619 | */ |
620 | struct ubifs_sb_node { |
621 | struct ubifs_ch ch; |
622 | __u8 padding[2]; |
623 | __u8 key_hash; |
624 | __u8 key_fmt; |
625 | __le32 flags; |
626 | __le32 min_io_size; |
627 | __le32 leb_size; |
628 | __le32 leb_cnt; |
629 | __le32 max_leb_cnt; |
630 | __le64 max_bud_bytes; |
631 | __le32 log_lebs; |
632 | __le32 lpt_lebs; |
633 | __le32 orph_lebs; |
634 | __le32 jhead_cnt; |
635 | __le32 fanout; |
636 | __le32 lsave_cnt; |
637 | __le32 fmt_version; |
638 | __le16 default_compr; |
639 | __u8 padding1[2]; |
640 | __le32 rp_uid; |
641 | __le32 rp_gid; |
642 | __le64 rp_size; |
643 | __le32 time_gran; |
644 | __u8 uuid[16]; |
645 | __le32 ro_compat_version; |
646 | __u8 padding2[3968]; |
647 | } __attribute__ ((packed)); |
648 | |
649 | /** |
650 | * struct ubifs_mst_node - master node. |
651 | * @ch: common header |
652 | * @highest_inum: highest inode number in the committed index |
653 | * @cmt_no: commit number |
654 | * @flags: various flags (%UBIFS_MST_DIRTY, etc) |
655 | * @log_lnum: start of the log |
656 | * @root_lnum: LEB number of the root indexing node |
657 | * @root_offs: offset within @root_lnum |
658 | * @root_len: root indexing node length |
659 | * @gc_lnum: LEB reserved for garbage collection (%-1 value means the LEB was |
660 | * not reserved and should be reserved on mount) |
661 | * @ihead_lnum: LEB number of index head |
662 | * @ihead_offs: offset of index head |
663 | * @index_size: size of index on flash |
664 | * @total_free: total free space in bytes |
665 | * @total_dirty: total dirty space in bytes |
666 | * @total_used: total used space in bytes (includes only data LEBs) |
667 | * @total_dead: total dead space in bytes (includes only data LEBs) |
668 | * @total_dark: total dark space in bytes (includes only data LEBs) |
669 | * @lpt_lnum: LEB number of LPT root nnode |
670 | * @lpt_offs: offset of LPT root nnode |
671 | * @nhead_lnum: LEB number of LPT head |
672 | * @nhead_offs: offset of LPT head |
673 | * @ltab_lnum: LEB number of LPT's own lprops table |
674 | * @ltab_offs: offset of LPT's own lprops table |
675 | * @lsave_lnum: LEB number of LPT's save table (big model only) |
676 | * @lsave_offs: offset of LPT's save table (big model only) |
677 | * @lscan_lnum: LEB number of last LPT scan |
678 | * @empty_lebs: number of empty logical eraseblocks |
679 | * @idx_lebs: number of indexing logical eraseblocks |
680 | * @leb_cnt: count of LEBs used by file-system |
681 | * @padding: reserved for future, zeroes |
682 | */ |
683 | struct ubifs_mst_node { |
684 | struct ubifs_ch ch; |
685 | __le64 highest_inum; |
686 | __le64 cmt_no; |
687 | __le32 flags; |
688 | __le32 log_lnum; |
689 | __le32 root_lnum; |
690 | __le32 root_offs; |
691 | __le32 root_len; |
692 | __le32 gc_lnum; |
693 | __le32 ihead_lnum; |
694 | __le32 ihead_offs; |
695 | __le64 index_size; |
696 | __le64 total_free; |
697 | __le64 total_dirty; |
698 | __le64 total_used; |
699 | __le64 total_dead; |
700 | __le64 total_dark; |
701 | __le32 lpt_lnum; |
702 | __le32 lpt_offs; |
703 | __le32 nhead_lnum; |
704 | __le32 nhead_offs; |
705 | __le32 ltab_lnum; |
706 | __le32 ltab_offs; |
707 | __le32 lsave_lnum; |
708 | __le32 lsave_offs; |
709 | __le32 lscan_lnum; |
710 | __le32 empty_lebs; |
711 | __le32 idx_lebs; |
712 | __le32 leb_cnt; |
713 | __u8 padding[344]; |
714 | } __attribute__ ((packed)); |
715 | |
716 | /** |
717 | * struct ubifs_ref_node - logical eraseblock reference node. |
718 | * @ch: common header |
719 | * @lnum: the referred logical eraseblock number |
720 | * @offs: start offset in the referred LEB |
721 | * @jhead: journal head number |
722 | * @padding: reserved for future, zeroes |
723 | */ |
724 | struct ubifs_ref_node { |
725 | struct ubifs_ch ch; |
726 | __le32 lnum; |
727 | __le32 offs; |
728 | __le32 jhead; |
729 | __u8 padding[28]; |
730 | } __attribute__ ((packed)); |
731 | |
732 | /** |
733 | * struct ubifs_branch - key/reference/length branch |
734 | * @lnum: LEB number of the target node |
735 | * @offs: offset within @lnum |
736 | * @len: target node length |
737 | * @key: key |
738 | */ |
739 | struct ubifs_branch { |
740 | __le32 lnum; |
741 | __le32 offs; |
742 | __le32 len; |
743 | __u8 key[]; |
744 | } __attribute__ ((packed)); |
745 | |
746 | /** |
747 | * struct ubifs_idx_node - indexing node. |
748 | * @ch: common header |
749 | * @child_cnt: number of child index nodes |
750 | * @level: tree level |
751 | * @branches: LEB number / offset / length / key branches |
752 | */ |
753 | struct ubifs_idx_node { |
754 | struct ubifs_ch ch; |
755 | __le16 child_cnt; |
756 | __le16 level; |
757 | __u8 branches[]; |
758 | } __attribute__ ((packed)); |
759 | |
760 | /** |
761 | * struct ubifs_cs_node - commit start node. |
762 | * @ch: common header |
763 | * @cmt_no: commit number |
764 | */ |
765 | struct ubifs_cs_node { |
766 | struct ubifs_ch ch; |
767 | __le64 cmt_no; |
768 | } __attribute__ ((packed)); |
769 | |
770 | /** |
771 | * struct ubifs_orph_node - orphan node. |
772 | * @ch: common header |
773 | * @cmt_no: commit number (also top bit is set on the last node of the commit) |
774 | * @inos: inode numbers of orphans |
775 | */ |
776 | struct ubifs_orph_node { |
777 | struct ubifs_ch ch; |
778 | __le64 cmt_no; |
779 | __le64 inos[]; |
780 | } __attribute__ ((packed)); |
781 | |
782 | #endif /* __UBIFS_MEDIA_H__ */ |
783 |
Branches:
ben-wpan
ben-wpan-stefan
javiroman/ks7010
jz-2.6.34
jz-2.6.34-rc5
jz-2.6.34-rc6
jz-2.6.34-rc7
jz-2.6.35
jz-2.6.36
jz-2.6.37
jz-2.6.38
jz-2.6.39
jz-3.0
jz-3.1
jz-3.11
jz-3.12
jz-3.13
jz-3.15
jz-3.16
jz-3.18-dt
jz-3.2
jz-3.3
jz-3.4
jz-3.5
jz-3.6
jz-3.6-rc2-pwm
jz-3.9
jz-3.9-clk
jz-3.9-rc8
jz47xx
jz47xx-2.6.38
master
Tags:
od-2011-09-04
od-2011-09-18
v2.6.34-rc5
v2.6.34-rc6
v2.6.34-rc7
v3.9