squashfs_fs.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. #ifndef SQUASHFS_FS
  3. #define SQUASHFS_FS
  4. /*
  5. * Squashfs
  6. *
  7. * Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008
  8. * Phillip Lougher <[email protected]>
  9. *
  10. * squashfs_fs.h
  11. */
  12. #define SQUASHFS_CACHED_FRAGMENTS CONFIG_SQUASHFS_FRAGMENT_CACHE_SIZE
  13. #define SQUASHFS_MAJOR 4
  14. #define SQUASHFS_MINOR 0
  15. #define SQUASHFS_START 0
  16. /* size of metadata (inode and directory) blocks */
  17. #define SQUASHFS_METADATA_SIZE 8192
  18. #define SQUASHFS_BLOCK_OFFSET 2
  19. /* default size of block device I/O */
  20. #ifdef CONFIG_SQUASHFS_4K_DEVBLK_SIZE
  21. #define SQUASHFS_DEVBLK_SIZE 4096
  22. #else
  23. #define SQUASHFS_DEVBLK_SIZE 1024
  24. #endif
  25. #define SQUASHFS_FILE_MAX_SIZE 1048576
  26. #define SQUASHFS_FILE_MAX_LOG 20
  27. /* Max length of filename (not 255) */
  28. #define SQUASHFS_NAME_LEN 256
  29. /* Max value for directory header count*/
  30. #define SQUASHFS_DIR_COUNT 256
  31. #define SQUASHFS_INVALID_FRAG (0xffffffffU)
  32. #define SQUASHFS_INVALID_XATTR (0xffffffffU)
  33. #define SQUASHFS_INVALID_BLK (-1LL)
  34. /* Filesystem flags */
  35. #define SQUASHFS_NOI 0
  36. #define SQUASHFS_NOD 1
  37. #define SQUASHFS_NOF 3
  38. #define SQUASHFS_NO_FRAG 4
  39. #define SQUASHFS_ALWAYS_FRAG 5
  40. #define SQUASHFS_DUPLICATE 6
  41. #define SQUASHFS_EXPORT 7
  42. #define SQUASHFS_COMP_OPT 10
  43. #define SQUASHFS_BIT(flag, bit) ((flag >> bit) & 1)
  44. #define SQUASHFS_UNCOMPRESSED_INODES(flags) SQUASHFS_BIT(flags, \
  45. SQUASHFS_NOI)
  46. #define SQUASHFS_UNCOMPRESSED_DATA(flags) SQUASHFS_BIT(flags, \
  47. SQUASHFS_NOD)
  48. #define SQUASHFS_UNCOMPRESSED_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
  49. SQUASHFS_NOF)
  50. #define SQUASHFS_NO_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
  51. SQUASHFS_NO_FRAG)
  52. #define SQUASHFS_ALWAYS_FRAGMENTS(flags) SQUASHFS_BIT(flags, \
  53. SQUASHFS_ALWAYS_FRAG)
  54. #define SQUASHFS_DUPLICATES(flags) SQUASHFS_BIT(flags, \
  55. SQUASHFS_DUPLICATE)
  56. #define SQUASHFS_EXPORTABLE(flags) SQUASHFS_BIT(flags, \
  57. SQUASHFS_EXPORT)
  58. #define SQUASHFS_COMP_OPTS(flags) SQUASHFS_BIT(flags, \
  59. SQUASHFS_COMP_OPT)
  60. /* Inode types including extended types */
  61. #define SQUASHFS_DIR_TYPE 1
  62. #define SQUASHFS_REG_TYPE 2
  63. #define SQUASHFS_SYMLINK_TYPE 3
  64. #define SQUASHFS_BLKDEV_TYPE 4
  65. #define SQUASHFS_CHRDEV_TYPE 5
  66. #define SQUASHFS_FIFO_TYPE 6
  67. #define SQUASHFS_SOCKET_TYPE 7
  68. #define SQUASHFS_LDIR_TYPE 8
  69. #define SQUASHFS_LREG_TYPE 9
  70. #define SQUASHFS_LSYMLINK_TYPE 10
  71. #define SQUASHFS_LBLKDEV_TYPE 11
  72. #define SQUASHFS_LCHRDEV_TYPE 12
  73. #define SQUASHFS_LFIFO_TYPE 13
  74. #define SQUASHFS_LSOCKET_TYPE 14
  75. /* Max type value stored in directory entry */
  76. #define SQUASHFS_MAX_DIR_TYPE 7
  77. /* Xattr types */
  78. #define SQUASHFS_XATTR_USER 0
  79. #define SQUASHFS_XATTR_TRUSTED 1
  80. #define SQUASHFS_XATTR_SECURITY 2
  81. #define SQUASHFS_XATTR_VALUE_OOL 256
  82. #define SQUASHFS_XATTR_PREFIX_MASK 0xff
  83. /* Flag whether block is compressed or uncompressed, bit is set if block is
  84. * uncompressed */
  85. #define SQUASHFS_COMPRESSED_BIT (1 << 15)
  86. #define SQUASHFS_COMPRESSED_SIZE(B) (((B) & ~SQUASHFS_COMPRESSED_BIT) ? \
  87. (B) & ~SQUASHFS_COMPRESSED_BIT : SQUASHFS_COMPRESSED_BIT)
  88. #define SQUASHFS_COMPRESSED(B) (!((B) & SQUASHFS_COMPRESSED_BIT))
  89. #define SQUASHFS_COMPRESSED_BIT_BLOCK (1 << 24)
  90. #define SQUASHFS_COMPRESSED_SIZE_BLOCK(B) ((B) & \
  91. ~SQUASHFS_COMPRESSED_BIT_BLOCK)
  92. #define SQUASHFS_COMPRESSED_BLOCK(B) (!((B) & SQUASHFS_COMPRESSED_BIT_BLOCK))
  93. static inline int squashfs_block_size(__le32 raw)
  94. {
  95. u32 size = le32_to_cpu(raw);
  96. return (size >> 25) ? -EIO : size;
  97. }
  98. /*
  99. * Inode number ops. Inodes consist of a compressed block number, and an
  100. * uncompressed offset within that block
  101. */
  102. #define SQUASHFS_INODE_BLK(A) ((unsigned int) ((A) >> 16))
  103. #define SQUASHFS_INODE_OFFSET(A) ((unsigned int) ((A) & 0xffff))
  104. #define SQUASHFS_MKINODE(A, B) ((long long)(((long long) (A)\
  105. << 16) + (B)))
  106. /* fragment and fragment table defines */
  107. #define SQUASHFS_FRAGMENT_BYTES(A) \
  108. ((A) * sizeof(struct squashfs_fragment_entry))
  109. #define SQUASHFS_FRAGMENT_INDEX(A) (SQUASHFS_FRAGMENT_BYTES(A) / \
  110. SQUASHFS_METADATA_SIZE)
  111. #define SQUASHFS_FRAGMENT_INDEX_OFFSET(A) (SQUASHFS_FRAGMENT_BYTES(A) % \
  112. SQUASHFS_METADATA_SIZE)
  113. #define SQUASHFS_FRAGMENT_INDEXES(A) ((SQUASHFS_FRAGMENT_BYTES(A) + \
  114. SQUASHFS_METADATA_SIZE - 1) / \
  115. SQUASHFS_METADATA_SIZE)
  116. #define SQUASHFS_FRAGMENT_INDEX_BYTES(A) (SQUASHFS_FRAGMENT_INDEXES(A) *\
  117. sizeof(u64))
  118. /* inode lookup table defines */
  119. #define SQUASHFS_LOOKUP_BYTES(A) ((A) * sizeof(u64))
  120. #define SQUASHFS_LOOKUP_BLOCK(A) (SQUASHFS_LOOKUP_BYTES(A) / \
  121. SQUASHFS_METADATA_SIZE)
  122. #define SQUASHFS_LOOKUP_BLOCK_OFFSET(A) (SQUASHFS_LOOKUP_BYTES(A) % \
  123. SQUASHFS_METADATA_SIZE)
  124. #define SQUASHFS_LOOKUP_BLOCKS(A) ((SQUASHFS_LOOKUP_BYTES(A) + \
  125. SQUASHFS_METADATA_SIZE - 1) / \
  126. SQUASHFS_METADATA_SIZE)
  127. #define SQUASHFS_LOOKUP_BLOCK_BYTES(A) (SQUASHFS_LOOKUP_BLOCKS(A) *\
  128. sizeof(u64))
  129. /* uid/gid lookup table defines */
  130. #define SQUASHFS_ID_BYTES(A) ((A) * sizeof(unsigned int))
  131. #define SQUASHFS_ID_BLOCK(A) (SQUASHFS_ID_BYTES(A) / \
  132. SQUASHFS_METADATA_SIZE)
  133. #define SQUASHFS_ID_BLOCK_OFFSET(A) (SQUASHFS_ID_BYTES(A) % \
  134. SQUASHFS_METADATA_SIZE)
  135. #define SQUASHFS_ID_BLOCKS(A) ((SQUASHFS_ID_BYTES(A) + \
  136. SQUASHFS_METADATA_SIZE - 1) / \
  137. SQUASHFS_METADATA_SIZE)
  138. #define SQUASHFS_ID_BLOCK_BYTES(A) (SQUASHFS_ID_BLOCKS(A) *\
  139. sizeof(u64))
  140. /* xattr id lookup table defines */
  141. #define SQUASHFS_XATTR_BYTES(A) (((u64) (A)) * sizeof(struct squashfs_xattr_id))
  142. #define SQUASHFS_XATTR_BLOCK(A) (SQUASHFS_XATTR_BYTES(A) / \
  143. SQUASHFS_METADATA_SIZE)
  144. #define SQUASHFS_XATTR_BLOCK_OFFSET(A) (SQUASHFS_XATTR_BYTES(A) % \
  145. SQUASHFS_METADATA_SIZE)
  146. #define SQUASHFS_XATTR_BLOCKS(A) ((SQUASHFS_XATTR_BYTES(A) + \
  147. SQUASHFS_METADATA_SIZE - 1) / \
  148. SQUASHFS_METADATA_SIZE)
  149. #define SQUASHFS_XATTR_BLOCK_BYTES(A) (SQUASHFS_XATTR_BLOCKS(A) *\
  150. sizeof(u64))
  151. #define SQUASHFS_XATTR_BLK(A) ((unsigned int) ((A) >> 16))
  152. #define SQUASHFS_XATTR_OFFSET(A) ((unsigned int) ((A) & 0xffff))
  153. /* cached data constants for filesystem */
  154. #define SQUASHFS_CACHED_BLKS 8
  155. /* meta index cache */
  156. #define SQUASHFS_META_INDEXES (SQUASHFS_METADATA_SIZE / sizeof(unsigned int))
  157. #define SQUASHFS_META_ENTRIES 127
  158. #define SQUASHFS_META_SLOTS 8
  159. struct meta_entry {
  160. u64 data_block;
  161. unsigned int index_block;
  162. unsigned short offset;
  163. unsigned short pad;
  164. };
  165. struct meta_index {
  166. unsigned int inode_number;
  167. unsigned int offset;
  168. unsigned short entries;
  169. unsigned short skip;
  170. unsigned short locked;
  171. unsigned short pad;
  172. struct meta_entry meta_entry[SQUASHFS_META_ENTRIES];
  173. };
  174. /*
  175. * definitions for structures on disk
  176. */
  177. #define ZLIB_COMPRESSION 1
  178. #define LZMA_COMPRESSION 2
  179. #define LZO_COMPRESSION 3
  180. #define XZ_COMPRESSION 4
  181. #define LZ4_COMPRESSION 5
  182. #define ZSTD_COMPRESSION 6
  183. struct squashfs_super_block {
  184. __le32 s_magic;
  185. __le32 inodes;
  186. __le32 mkfs_time;
  187. __le32 block_size;
  188. __le32 fragments;
  189. __le16 compression;
  190. __le16 block_log;
  191. __le16 flags;
  192. __le16 no_ids;
  193. __le16 s_major;
  194. __le16 s_minor;
  195. __le64 root_inode;
  196. __le64 bytes_used;
  197. __le64 id_table_start;
  198. __le64 xattr_id_table_start;
  199. __le64 inode_table_start;
  200. __le64 directory_table_start;
  201. __le64 fragment_table_start;
  202. __le64 lookup_table_start;
  203. };
  204. struct squashfs_dir_index {
  205. __le32 index;
  206. __le32 start_block;
  207. __le32 size;
  208. unsigned char name[];
  209. };
  210. struct squashfs_base_inode {
  211. __le16 inode_type;
  212. __le16 mode;
  213. __le16 uid;
  214. __le16 guid;
  215. __le32 mtime;
  216. __le32 inode_number;
  217. };
  218. struct squashfs_ipc_inode {
  219. __le16 inode_type;
  220. __le16 mode;
  221. __le16 uid;
  222. __le16 guid;
  223. __le32 mtime;
  224. __le32 inode_number;
  225. __le32 nlink;
  226. };
  227. struct squashfs_lipc_inode {
  228. __le16 inode_type;
  229. __le16 mode;
  230. __le16 uid;
  231. __le16 guid;
  232. __le32 mtime;
  233. __le32 inode_number;
  234. __le32 nlink;
  235. __le32 xattr;
  236. };
  237. struct squashfs_dev_inode {
  238. __le16 inode_type;
  239. __le16 mode;
  240. __le16 uid;
  241. __le16 guid;
  242. __le32 mtime;
  243. __le32 inode_number;
  244. __le32 nlink;
  245. __le32 rdev;
  246. };
  247. struct squashfs_ldev_inode {
  248. __le16 inode_type;
  249. __le16 mode;
  250. __le16 uid;
  251. __le16 guid;
  252. __le32 mtime;
  253. __le32 inode_number;
  254. __le32 nlink;
  255. __le32 rdev;
  256. __le32 xattr;
  257. };
  258. struct squashfs_symlink_inode {
  259. __le16 inode_type;
  260. __le16 mode;
  261. __le16 uid;
  262. __le16 guid;
  263. __le32 mtime;
  264. __le32 inode_number;
  265. __le32 nlink;
  266. __le32 symlink_size;
  267. char symlink[];
  268. };
  269. struct squashfs_reg_inode {
  270. __le16 inode_type;
  271. __le16 mode;
  272. __le16 uid;
  273. __le16 guid;
  274. __le32 mtime;
  275. __le32 inode_number;
  276. __le32 start_block;
  277. __le32 fragment;
  278. __le32 offset;
  279. __le32 file_size;
  280. __le16 block_list[];
  281. };
  282. struct squashfs_lreg_inode {
  283. __le16 inode_type;
  284. __le16 mode;
  285. __le16 uid;
  286. __le16 guid;
  287. __le32 mtime;
  288. __le32 inode_number;
  289. __le64 start_block;
  290. __le64 file_size;
  291. __le64 sparse;
  292. __le32 nlink;
  293. __le32 fragment;
  294. __le32 offset;
  295. __le32 xattr;
  296. __le16 block_list[];
  297. };
  298. struct squashfs_dir_inode {
  299. __le16 inode_type;
  300. __le16 mode;
  301. __le16 uid;
  302. __le16 guid;
  303. __le32 mtime;
  304. __le32 inode_number;
  305. __le32 start_block;
  306. __le32 nlink;
  307. __le16 file_size;
  308. __le16 offset;
  309. __le32 parent_inode;
  310. };
  311. struct squashfs_ldir_inode {
  312. __le16 inode_type;
  313. __le16 mode;
  314. __le16 uid;
  315. __le16 guid;
  316. __le32 mtime;
  317. __le32 inode_number;
  318. __le32 nlink;
  319. __le32 file_size;
  320. __le32 start_block;
  321. __le32 parent_inode;
  322. __le16 i_count;
  323. __le16 offset;
  324. __le32 xattr;
  325. struct squashfs_dir_index index[];
  326. };
  327. union squashfs_inode {
  328. struct squashfs_base_inode base;
  329. struct squashfs_dev_inode dev;
  330. struct squashfs_ldev_inode ldev;
  331. struct squashfs_symlink_inode symlink;
  332. struct squashfs_reg_inode reg;
  333. struct squashfs_lreg_inode lreg;
  334. struct squashfs_dir_inode dir;
  335. struct squashfs_ldir_inode ldir;
  336. struct squashfs_ipc_inode ipc;
  337. struct squashfs_lipc_inode lipc;
  338. };
  339. struct squashfs_dir_entry {
  340. __le16 offset;
  341. __le16 inode_number;
  342. __le16 type;
  343. __le16 size;
  344. char name[];
  345. };
  346. struct squashfs_dir_header {
  347. __le32 count;
  348. __le32 start_block;
  349. __le32 inode_number;
  350. };
  351. struct squashfs_fragment_entry {
  352. __le64 start_block;
  353. __le32 size;
  354. unsigned int unused;
  355. };
  356. struct squashfs_xattr_entry {
  357. __le16 type;
  358. __le16 size;
  359. char data[];
  360. };
  361. struct squashfs_xattr_val {
  362. __le32 vsize;
  363. char value[];
  364. };
  365. struct squashfs_xattr_id {
  366. __le64 xattr;
  367. __le32 count;
  368. __le32 size;
  369. };
  370. struct squashfs_xattr_id_table {
  371. __le64 xattr_table_start;
  372. __le32 xattr_ids;
  373. __le32 unused;
  374. };
  375. #endif