bdc7935a5e411bac63f6dd8a4945ab0a9da98734
[sfrench/cifs-2.6.git] / fs / ubifs / ubifs-media.h
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  * xattr name of UBIFS encryption context, we don't use a prefix
305  * nor a long name to not waste space on the flash.
306  */
307 #define UBIFS_XATTR_NAME_ENCRYPTION_CONTEXT "c"
308
309
310 /*
311  * On-flash inode flags.
312  *
313  * UBIFS_COMPR_FL: use compression for this inode
314  * UBIFS_SYNC_FL:  I/O on this inode has to be synchronous
315  * UBIFS_IMMUTABLE_FL: inode is immutable
316  * UBIFS_APPEND_FL: writes to the inode may only append data
317  * UBIFS_DIRSYNC_FL: I/O on this directory inode has to be synchronous
318  * UBIFS_XATTR_FL: this inode is the inode for an extended attribute value
319  * UBIFS_CRYPT_FL: use encryption for this inode
320  *
321  * Note, these are on-flash flags which correspond to ioctl flags
322  * (@FS_COMPR_FL, etc). They have the same values now, but generally, do not
323  * have to be the same.
324  */
325 enum {
326         UBIFS_COMPR_FL     = 0x01,
327         UBIFS_SYNC_FL      = 0x02,
328         UBIFS_IMMUTABLE_FL = 0x04,
329         UBIFS_APPEND_FL    = 0x08,
330         UBIFS_DIRSYNC_FL   = 0x10,
331         UBIFS_XATTR_FL     = 0x20,
332         UBIFS_CRYPT_FL     = 0x40,
333 };
334
335 /* Inode flag bits used by UBIFS */
336 #define UBIFS_FL_MASK 0x0000001F
337
338 /*
339  * UBIFS compression algorithms.
340  *
341  * UBIFS_COMPR_NONE: no compression
342  * UBIFS_COMPR_LZO: LZO compression
343  * UBIFS_COMPR_ZLIB: ZLIB compression
344  * UBIFS_COMPR_TYPES_CNT: count of supported compression types
345  */
346 enum {
347         UBIFS_COMPR_NONE,
348         UBIFS_COMPR_LZO,
349         UBIFS_COMPR_ZLIB,
350         UBIFS_COMPR_TYPES_CNT,
351 };
352
353 /*
354  * UBIFS node types.
355  *
356  * UBIFS_INO_NODE: inode node
357  * UBIFS_DATA_NODE: data node
358  * UBIFS_DENT_NODE: directory entry node
359  * UBIFS_XENT_NODE: extended attribute node
360  * UBIFS_TRUN_NODE: truncation node
361  * UBIFS_PAD_NODE: padding node
362  * UBIFS_SB_NODE: superblock node
363  * UBIFS_MST_NODE: master node
364  * UBIFS_REF_NODE: LEB reference node
365  * UBIFS_IDX_NODE: index node
366  * UBIFS_CS_NODE: commit start node
367  * UBIFS_ORPH_NODE: orphan node
368  * UBIFS_NODE_TYPES_CNT: count of supported node types
369  *
370  * Note, we index arrays by these numbers, so keep them low and contiguous.
371  * Node type constants for inodes, direntries and so on have to be the same as
372  * corresponding key type constants.
373  */
374 enum {
375         UBIFS_INO_NODE,
376         UBIFS_DATA_NODE,
377         UBIFS_DENT_NODE,
378         UBIFS_XENT_NODE,
379         UBIFS_TRUN_NODE,
380         UBIFS_PAD_NODE,
381         UBIFS_SB_NODE,
382         UBIFS_MST_NODE,
383         UBIFS_REF_NODE,
384         UBIFS_IDX_NODE,
385         UBIFS_CS_NODE,
386         UBIFS_ORPH_NODE,
387         UBIFS_NODE_TYPES_CNT,
388 };
389
390 /*
391  * Master node flags.
392  *
393  * UBIFS_MST_DIRTY: rebooted uncleanly - master node is dirty
394  * UBIFS_MST_NO_ORPHS: no orphan inodes present
395  * UBIFS_MST_RCVRY: written by recovery
396  */
397 enum {
398         UBIFS_MST_DIRTY = 1,
399         UBIFS_MST_NO_ORPHS = 2,
400         UBIFS_MST_RCVRY = 4,
401 };
402
403 /*
404  * Node group type (used by recovery to recover whole group or none).
405  *
406  * UBIFS_NO_NODE_GROUP: this node is not part of a group
407  * UBIFS_IN_NODE_GROUP: this node is a part of a group
408  * UBIFS_LAST_OF_NODE_GROUP: this node is the last in a group
409  */
410 enum {
411         UBIFS_NO_NODE_GROUP = 0,
412         UBIFS_IN_NODE_GROUP,
413         UBIFS_LAST_OF_NODE_GROUP,
414 };
415
416 /*
417  * Superblock flags.
418  *
419  * UBIFS_FLG_BIGLPT: if "big" LPT model is used if set
420  * UBIFS_FLG_SPACE_FIXUP: first-mount "fixup" of free space within LEBs needed
421  * UBIFS_FLG_DOUBLE_HASH: store a 32bit cookie in directory entry nodes to
422  *                        support 64bit cookies for lookups by hash
423  * UBIFS_FLG_ENCRYPTION: this filesystem contains encrypted files
424  */
425 enum {
426         UBIFS_FLG_BIGLPT = 0x02,
427         UBIFS_FLG_SPACE_FIXUP = 0x04,
428         UBIFS_FLG_DOUBLE_HASH = 0x08,
429         UBIFS_FLG_ENCRYPTION = 0x10,
430 };
431
432 /**
433  * struct ubifs_ch - common header node.
434  * @magic: UBIFS node magic number (%UBIFS_NODE_MAGIC)
435  * @crc: CRC-32 checksum of the node header
436  * @sqnum: sequence number
437  * @len: full node length
438  * @node_type: node type
439  * @group_type: node group type
440  * @padding: reserved for future, zeroes
441  *
442  * Every UBIFS node starts with this common part. If the node has a key, the
443  * key always goes next.
444  */
445 struct ubifs_ch {
446         __le32 magic;
447         __le32 crc;
448         __le64 sqnum;
449         __le32 len;
450         __u8 node_type;
451         __u8 group_type;
452         __u8 padding[2];
453 } __packed;
454
455 /**
456  * union ubifs_dev_desc - device node descriptor.
457  * @new: new type device descriptor
458  * @huge: huge type device descriptor
459  *
460  * This data structure describes major/minor numbers of a device node. In an
461  * inode is a device node then its data contains an object of this type. UBIFS
462  * uses standard Linux "new" and "huge" device node encodings.
463  */
464 union ubifs_dev_desc {
465         __le32 new;
466         __le64 huge;
467 } __packed;
468
469 /**
470  * struct ubifs_ino_node - inode node.
471  * @ch: common header
472  * @key: node key
473  * @creat_sqnum: sequence number at time of creation
474  * @size: inode size in bytes (amount of uncompressed data)
475  * @atime_sec: access time seconds
476  * @ctime_sec: creation time seconds
477  * @mtime_sec: modification time seconds
478  * @atime_nsec: access time nanoseconds
479  * @ctime_nsec: creation time nanoseconds
480  * @mtime_nsec: modification time nanoseconds
481  * @nlink: number of hard links
482  * @uid: owner ID
483  * @gid: group ID
484  * @mode: access flags
485  * @flags: per-inode flags (%UBIFS_COMPR_FL, %UBIFS_SYNC_FL, etc)
486  * @data_len: inode data length
487  * @xattr_cnt: count of extended attributes this inode has
488  * @xattr_size: summarized size of all extended attributes in bytes
489  * @padding1: reserved for future, zeroes
490  * @xattr_names: sum of lengths of all extended attribute names belonging to
491  *               this inode
492  * @compr_type: compression type used for this inode
493  * @padding2: reserved for future, zeroes
494  * @data: data attached to the inode
495  *
496  * Note, even though inode compression type is defined by @compr_type, some
497  * nodes of this inode may be compressed with different compressor - this
498  * happens if compression type is changed while the inode already has data
499  * nodes. But @compr_type will be use for further writes to the inode.
500  *
501  * Note, do not forget to amend 'zero_ino_node_unused()' function when changing
502  * the padding fields.
503  */
504 struct ubifs_ino_node {
505         struct ubifs_ch ch;
506         __u8 key[UBIFS_MAX_KEY_LEN];
507         __le64 creat_sqnum;
508         __le64 size;
509         __le64 atime_sec;
510         __le64 ctime_sec;
511         __le64 mtime_sec;
512         __le32 atime_nsec;
513         __le32 ctime_nsec;
514         __le32 mtime_nsec;
515         __le32 nlink;
516         __le32 uid;
517         __le32 gid;
518         __le32 mode;
519         __le32 flags;
520         __le32 data_len;
521         __le32 xattr_cnt;
522         __le32 xattr_size;
523         __u8 padding1[4]; /* Watch 'zero_ino_node_unused()' if changing! */
524         __le32 xattr_names;
525         __le16 compr_type;
526         __u8 padding2[26]; /* Watch 'zero_ino_node_unused()' if changing! */
527         __u8 data[];
528 } __packed;
529
530 /**
531  * struct ubifs_dent_node - directory entry node.
532  * @ch: common header
533  * @key: node key
534  * @inum: target inode number
535  * @padding1: reserved for future, zeroes
536  * @type: type of the target inode (%UBIFS_ITYPE_REG, %UBIFS_ITYPE_DIR, etc)
537  * @nlen: name length
538  * @cookie: A 32bits random number, used to construct a 64bits
539  *          identifier.
540  * @name: zero-terminated name
541  *
542  * Note, do not forget to amend 'zero_dent_node_unused()' function when
543  * changing the padding fields.
544  */
545 struct ubifs_dent_node {
546         struct ubifs_ch ch;
547         __u8 key[UBIFS_MAX_KEY_LEN];
548         __le64 inum;
549         __u8 padding1;
550         __u8 type;
551         __le16 nlen;
552         __le32 cookie;
553         __u8 name[];
554 } __packed;
555
556 /**
557  * struct ubifs_data_node - data node.
558  * @ch: common header
559  * @key: node key
560  * @size: uncompressed data size in bytes
561  * @compr_type: compression type (%UBIFS_COMPR_NONE, %UBIFS_COMPR_LZO, etc)
562  * @compr_size: compressed data size in bytes, only valid when data is encrypted
563  * @data: data
564  *
565  */
566 struct ubifs_data_node {
567         struct ubifs_ch ch;
568         __u8 key[UBIFS_MAX_KEY_LEN];
569         __le32 size;
570         __le16 compr_type;
571         __le16 compr_size;
572         __u8 data[];
573 } __packed;
574
575 /**
576  * struct ubifs_trun_node - truncation node.
577  * @ch: common header
578  * @inum: truncated inode number
579  * @padding: reserved for future, zeroes
580  * @old_size: size before truncation
581  * @new_size: size after truncation
582  *
583  * This node exists only in the journal and never goes to the main area. Note,
584  * do not forget to amend 'zero_trun_node_unused()' function when changing the
585  * padding fields.
586  */
587 struct ubifs_trun_node {
588         struct ubifs_ch ch;
589         __le32 inum;
590         __u8 padding[12]; /* Watch 'zero_trun_node_unused()' if changing! */
591         __le64 old_size;
592         __le64 new_size;
593 } __packed;
594
595 /**
596  * struct ubifs_pad_node - padding node.
597  * @ch: common header
598  * @pad_len: how many bytes after this node are unused (because padded)
599  * @padding: reserved for future, zeroes
600  */
601 struct ubifs_pad_node {
602         struct ubifs_ch ch;
603         __le32 pad_len;
604 } __packed;
605
606 /**
607  * struct ubifs_sb_node - superblock node.
608  * @ch: common header
609  * @padding: reserved for future, zeroes
610  * @key_hash: type of hash function used in keys
611  * @key_fmt: format of the key
612  * @flags: file-system flags (%UBIFS_FLG_BIGLPT, etc)
613  * @min_io_size: minimal input/output unit size
614  * @leb_size: logical eraseblock size in bytes
615  * @leb_cnt: count of LEBs used by file-system
616  * @max_leb_cnt: maximum count of LEBs used by file-system
617  * @max_bud_bytes: maximum amount of data stored in buds
618  * @log_lebs: log size in logical eraseblocks
619  * @lpt_lebs: number of LEBs used for lprops table
620  * @orph_lebs: number of LEBs used for recording orphans
621  * @jhead_cnt: count of journal heads
622  * @fanout: tree fanout (max. number of links per indexing node)
623  * @lsave_cnt: number of LEB numbers in LPT's save table
624  * @fmt_version: UBIFS on-flash format version
625  * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
626  * @padding1: reserved for future, zeroes
627  * @rp_uid: reserve pool UID
628  * @rp_gid: reserve pool GID
629  * @rp_size: size of the reserved pool in bytes
630  * @padding2: reserved for future, zeroes
631  * @time_gran: time granularity in nanoseconds
632  * @uuid: UUID generated when the file system image was created
633  * @ro_compat_version: UBIFS R/O compatibility version
634  */
635 struct ubifs_sb_node {
636         struct ubifs_ch ch;
637         __u8 padding[2];
638         __u8 key_hash;
639         __u8 key_fmt;
640         __le32 flags;
641         __le32 min_io_size;
642         __le32 leb_size;
643         __le32 leb_cnt;
644         __le32 max_leb_cnt;
645         __le64 max_bud_bytes;
646         __le32 log_lebs;
647         __le32 lpt_lebs;
648         __le32 orph_lebs;
649         __le32 jhead_cnt;
650         __le32 fanout;
651         __le32 lsave_cnt;
652         __le32 fmt_version;
653         __le16 default_compr;
654         __u8 padding1[2];
655         __le32 rp_uid;
656         __le32 rp_gid;
657         __le64 rp_size;
658         __le32 time_gran;
659         __u8 uuid[16];
660         __le32 ro_compat_version;
661         __u8 padding2[3968];
662 } __packed;
663
664 /**
665  * struct ubifs_mst_node - master node.
666  * @ch: common header
667  * @highest_inum: highest inode number in the committed index
668  * @cmt_no: commit number
669  * @flags: various flags (%UBIFS_MST_DIRTY, etc)
670  * @log_lnum: start of the log
671  * @root_lnum: LEB number of the root indexing node
672  * @root_offs: offset within @root_lnum
673  * @root_len: root indexing node length
674  * @gc_lnum: LEB reserved for garbage collection (%-1 value means the LEB was
675  * not reserved and should be reserved on mount)
676  * @ihead_lnum: LEB number of index head
677  * @ihead_offs: offset of index head
678  * @index_size: size of index on flash
679  * @total_free: total free space in bytes
680  * @total_dirty: total dirty space in bytes
681  * @total_used: total used space in bytes (includes only data LEBs)
682  * @total_dead: total dead space in bytes (includes only data LEBs)
683  * @total_dark: total dark space in bytes (includes only data LEBs)
684  * @lpt_lnum: LEB number of LPT root nnode
685  * @lpt_offs: offset of LPT root nnode
686  * @nhead_lnum: LEB number of LPT head
687  * @nhead_offs: offset of LPT head
688  * @ltab_lnum: LEB number of LPT's own lprops table
689  * @ltab_offs: offset of LPT's own lprops table
690  * @lsave_lnum: LEB number of LPT's save table (big model only)
691  * @lsave_offs: offset of LPT's save table (big model only)
692  * @lscan_lnum: LEB number of last LPT scan
693  * @empty_lebs: number of empty logical eraseblocks
694  * @idx_lebs: number of indexing logical eraseblocks
695  * @leb_cnt: count of LEBs used by file-system
696  * @padding: reserved for future, zeroes
697  */
698 struct ubifs_mst_node {
699         struct ubifs_ch ch;
700         __le64 highest_inum;
701         __le64 cmt_no;
702         __le32 flags;
703         __le32 log_lnum;
704         __le32 root_lnum;
705         __le32 root_offs;
706         __le32 root_len;
707         __le32 gc_lnum;
708         __le32 ihead_lnum;
709         __le32 ihead_offs;
710         __le64 index_size;
711         __le64 total_free;
712         __le64 total_dirty;
713         __le64 total_used;
714         __le64 total_dead;
715         __le64 total_dark;
716         __le32 lpt_lnum;
717         __le32 lpt_offs;
718         __le32 nhead_lnum;
719         __le32 nhead_offs;
720         __le32 ltab_lnum;
721         __le32 ltab_offs;
722         __le32 lsave_lnum;
723         __le32 lsave_offs;
724         __le32 lscan_lnum;
725         __le32 empty_lebs;
726         __le32 idx_lebs;
727         __le32 leb_cnt;
728         __u8 padding[344];
729 } __packed;
730
731 /**
732  * struct ubifs_ref_node - logical eraseblock reference node.
733  * @ch: common header
734  * @lnum: the referred logical eraseblock number
735  * @offs: start offset in the referred LEB
736  * @jhead: journal head number
737  * @padding: reserved for future, zeroes
738  */
739 struct ubifs_ref_node {
740         struct ubifs_ch ch;
741         __le32 lnum;
742         __le32 offs;
743         __le32 jhead;
744         __u8 padding[28];
745 } __packed;
746
747 /**
748  * struct ubifs_branch - key/reference/length branch
749  * @lnum: LEB number of the target node
750  * @offs: offset within @lnum
751  * @len: target node length
752  * @key: key
753  */
754 struct ubifs_branch {
755         __le32 lnum;
756         __le32 offs;
757         __le32 len;
758         __u8 key[];
759 } __packed;
760
761 /**
762  * struct ubifs_idx_node - indexing node.
763  * @ch: common header
764  * @child_cnt: number of child index nodes
765  * @level: tree level
766  * @branches: LEB number / offset / length / key branches
767  */
768 struct ubifs_idx_node {
769         struct ubifs_ch ch;
770         __le16 child_cnt;
771         __le16 level;
772         __u8 branches[];
773 } __packed;
774
775 /**
776  * struct ubifs_cs_node - commit start node.
777  * @ch: common header
778  * @cmt_no: commit number
779  */
780 struct ubifs_cs_node {
781         struct ubifs_ch ch;
782         __le64 cmt_no;
783 } __packed;
784
785 /**
786  * struct ubifs_orph_node - orphan node.
787  * @ch: common header
788  * @cmt_no: commit number (also top bit is set on the last node of the commit)
789  * @inos: inode numbers of orphans
790  */
791 struct ubifs_orph_node {
792         struct ubifs_ch ch;
793         __le64 cmt_no;
794         __le64 inos[];
795 } __packed;
796
797 #endif /* __UBIFS_MEDIA_H__ */