ubifs-media.h 22 KB

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