ubifs.h 64 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884
  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. #ifndef __UBIFS_H__
  23. #define __UBIFS_H__
  24. #include <asm/div64.h>
  25. #include <linux/statfs.h>
  26. #include <linux/fs.h>
  27. #include <linux/err.h>
  28. #include <linux/sched.h>
  29. #include <linux/slab.h>
  30. #include <linux/vmalloc.h>
  31. #include <linux/spinlock.h>
  32. #include <linux/mutex.h>
  33. #include <linux/rwsem.h>
  34. #include <linux/mtd/ubi.h>
  35. #include <linux/pagemap.h>
  36. #include <linux/backing-dev.h>
  37. #include <linux/security.h>
  38. #include <linux/xattr.h>
  39. #include <linux/random.h>
  40. #define __FS_HAS_ENCRYPTION IS_ENABLED(CONFIG_UBIFS_FS_ENCRYPTION)
  41. #include <linux/fscrypt.h>
  42. #include "ubifs-media.h"
  43. /* Version of this UBIFS implementation */
  44. #define UBIFS_VERSION 1
  45. /* UBIFS file system VFS magic number */
  46. #define UBIFS_SUPER_MAGIC 0x24051905
  47. /* Number of UBIFS blocks per VFS page */
  48. #define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE)
  49. #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT)
  50. /* "File system end of life" sequence number watermark */
  51. #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL
  52. #define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL
  53. /*
  54. * Minimum amount of LEBs reserved for the index. At present the index needs at
  55. * least 2 LEBs: one for the index head and one for in-the-gaps method (which
  56. * currently does not cater for the index head and so excludes it from
  57. * consideration).
  58. */
  59. #define MIN_INDEX_LEBS 2
  60. /* Minimum amount of data UBIFS writes to the flash */
  61. #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
  62. /*
  63. * Currently we do not support inode number overlapping and re-using, so this
  64. * watermark defines dangerous inode number level. This should be fixed later,
  65. * although it is difficult to exceed current limit. Another option is to use
  66. * 64-bit inode numbers, but this means more overhead.
  67. */
  68. #define INUM_WARN_WATERMARK 0xFFF00000
  69. #define INUM_WATERMARK 0xFFFFFF00
  70. /* Maximum number of entries in each LPT (LEB category) heap */
  71. #define LPT_HEAP_SZ 256
  72. /*
  73. * Background thread name pattern. The numbers are UBI device and volume
  74. * numbers.
  75. */
  76. #define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
  77. /* Maximum possible inode number (only 32-bit inodes are supported now) */
  78. #define MAX_INUM 0xFFFFFFFF
  79. /* Number of non-data journal heads */
  80. #define NONDATA_JHEADS_CNT 2
  81. /* Shorter names for journal head numbers for internal usage */
  82. #define GCHD UBIFS_GC_HEAD
  83. #define BASEHD UBIFS_BASE_HEAD
  84. #define DATAHD UBIFS_DATA_HEAD
  85. /* 'No change' value for 'ubifs_change_lp()' */
  86. #define LPROPS_NC 0x80000001
  87. /*
  88. * There is no notion of truncation key because truncation nodes do not exist
  89. * in TNC. However, when replaying, it is handy to introduce fake "truncation"
  90. * keys for truncation nodes because the code becomes simpler. So we define
  91. * %UBIFS_TRUN_KEY type.
  92. *
  93. * But otherwise, out of the journal reply scope, the truncation keys are
  94. * invalid.
  95. */
  96. #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT
  97. #define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT
  98. /*
  99. * How much a directory entry/extended attribute entry adds to the parent/host
  100. * inode.
  101. */
  102. #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
  103. /* How much an extended attribute adds to the host inode */
  104. #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8)
  105. /*
  106. * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered
  107. * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are
  108. * considered "young". This is used by shrinker when selecting znode to trim
  109. * off.
  110. */
  111. #define OLD_ZNODE_AGE 20
  112. #define YOUNG_ZNODE_AGE 5
  113. /*
  114. * Some compressors, like LZO, may end up with more data then the input buffer.
  115. * So UBIFS always allocates larger output buffer, to be sure the compressor
  116. * will not corrupt memory in case of worst case compression.
  117. */
  118. #define WORST_COMPR_FACTOR 2
  119. #ifdef CONFIG_UBIFS_FS_ENCRYPTION
  120. #define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE
  121. #else
  122. #define UBIFS_CIPHER_BLOCK_SIZE 0
  123. #endif
  124. /*
  125. * How much memory is needed for a buffer where we compress a data node.
  126. */
  127. #define COMPRESSED_DATA_NODE_BUF_SZ \
  128. (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR)
  129. /* Maximum expected tree height for use by bottom_up_buf */
  130. #define BOTTOM_UP_HEIGHT 64
  131. /* Maximum number of data nodes to bulk-read */
  132. #define UBIFS_MAX_BULK_READ 32
  133. /*
  134. * Lockdep classes for UBIFS inode @ui_mutex.
  135. */
  136. enum {
  137. WB_MUTEX_1 = 0,
  138. WB_MUTEX_2 = 1,
  139. WB_MUTEX_3 = 2,
  140. WB_MUTEX_4 = 3,
  141. };
  142. /*
  143. * Znode flags (actually, bit numbers which store the flags).
  144. *
  145. * DIRTY_ZNODE: znode is dirty
  146. * COW_ZNODE: znode is being committed and a new instance of this znode has to
  147. * be created before changing this znode
  148. * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is
  149. * still in the commit list and the ongoing commit operation
  150. * will commit it, and delete this znode after it is done
  151. */
  152. enum {
  153. DIRTY_ZNODE = 0,
  154. COW_ZNODE = 1,
  155. OBSOLETE_ZNODE = 2,
  156. };
  157. /*
  158. * Commit states.
  159. *
  160. * COMMIT_RESTING: commit is not wanted
  161. * COMMIT_BACKGROUND: background commit has been requested
  162. * COMMIT_REQUIRED: commit is required
  163. * COMMIT_RUNNING_BACKGROUND: background commit is running
  164. * COMMIT_RUNNING_REQUIRED: commit is running and it is required
  165. * COMMIT_BROKEN: commit failed
  166. */
  167. enum {
  168. COMMIT_RESTING = 0,
  169. COMMIT_BACKGROUND,
  170. COMMIT_REQUIRED,
  171. COMMIT_RUNNING_BACKGROUND,
  172. COMMIT_RUNNING_REQUIRED,
  173. COMMIT_BROKEN,
  174. };
  175. /*
  176. * 'ubifs_scan_a_node()' return values.
  177. *
  178. * SCANNED_GARBAGE: scanned garbage
  179. * SCANNED_EMPTY_SPACE: scanned empty space
  180. * SCANNED_A_NODE: scanned a valid node
  181. * SCANNED_A_CORRUPT_NODE: scanned a corrupted node
  182. * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length
  183. *
  184. * Greater than zero means: 'scanned that number of padding bytes'
  185. */
  186. enum {
  187. SCANNED_GARBAGE = 0,
  188. SCANNED_EMPTY_SPACE = -1,
  189. SCANNED_A_NODE = -2,
  190. SCANNED_A_CORRUPT_NODE = -3,
  191. SCANNED_A_BAD_PAD_NODE = -4,
  192. };
  193. /*
  194. * LPT cnode flag bits.
  195. *
  196. * DIRTY_CNODE: cnode is dirty
  197. * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted),
  198. * so it can (and must) be freed when the commit is finished
  199. * COW_CNODE: cnode is being committed and must be copied before writing
  200. */
  201. enum {
  202. DIRTY_CNODE = 0,
  203. OBSOLETE_CNODE = 1,
  204. COW_CNODE = 2,
  205. };
  206. /*
  207. * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
  208. *
  209. * LTAB_DIRTY: ltab node is dirty
  210. * LSAVE_DIRTY: lsave node is dirty
  211. */
  212. enum {
  213. LTAB_DIRTY = 1,
  214. LSAVE_DIRTY = 2,
  215. };
  216. /*
  217. * Return codes used by the garbage collector.
  218. * @LEB_FREED: the logical eraseblock was freed and is ready to use
  219. * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit
  220. * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes
  221. */
  222. enum {
  223. LEB_FREED,
  224. LEB_FREED_IDX,
  225. LEB_RETAINED,
  226. };
  227. /*
  228. * Action taken upon a failed ubifs_assert().
  229. * @ASSACT_REPORT: just report the failed assertion
  230. * @ASSACT_RO: switch to read-only mode
  231. * @ASSACT_PANIC: call BUG() and possible panic the kernel
  232. */
  233. enum {
  234. ASSACT_REPORT = 0,
  235. ASSACT_RO,
  236. ASSACT_PANIC,
  237. };
  238. /**
  239. * struct ubifs_old_idx - index node obsoleted since last commit start.
  240. * @rb: rb-tree node
  241. * @lnum: LEB number of obsoleted index node
  242. * @offs: offset of obsoleted index node
  243. */
  244. struct ubifs_old_idx {
  245. struct rb_node rb;
  246. int lnum;
  247. int offs;
  248. };
  249. /* The below union makes it easier to deal with keys */
  250. union ubifs_key {
  251. uint8_t u8[UBIFS_SK_LEN];
  252. uint32_t u32[UBIFS_SK_LEN/4];
  253. uint64_t u64[UBIFS_SK_LEN/8];
  254. __le32 j32[UBIFS_SK_LEN/4];
  255. };
  256. /**
  257. * struct ubifs_scan_node - UBIFS scanned node information.
  258. * @list: list of scanned nodes
  259. * @key: key of node scanned (if it has one)
  260. * @sqnum: sequence number
  261. * @type: type of node scanned
  262. * @offs: offset with LEB of node scanned
  263. * @len: length of node scanned
  264. * @node: raw node
  265. */
  266. struct ubifs_scan_node {
  267. struct list_head list;
  268. union ubifs_key key;
  269. unsigned long long sqnum;
  270. int type;
  271. int offs;
  272. int len;
  273. void *node;
  274. };
  275. /**
  276. * struct ubifs_scan_leb - UBIFS scanned LEB information.
  277. * @lnum: logical eraseblock number
  278. * @nodes_cnt: number of nodes scanned
  279. * @nodes: list of struct ubifs_scan_node
  280. * @endpt: end point (and therefore the start of empty space)
  281. * @buf: buffer containing entire LEB scanned
  282. */
  283. struct ubifs_scan_leb {
  284. int lnum;
  285. int nodes_cnt;
  286. struct list_head nodes;
  287. int endpt;
  288. void *buf;
  289. };
  290. /**
  291. * struct ubifs_gced_idx_leb - garbage-collected indexing LEB.
  292. * @list: list
  293. * @lnum: LEB number
  294. * @unmap: OK to unmap this LEB
  295. *
  296. * This data structure is used to temporary store garbage-collected indexing
  297. * LEBs - they are not released immediately, but only after the next commit.
  298. * This is needed to guarantee recoverability.
  299. */
  300. struct ubifs_gced_idx_leb {
  301. struct list_head list;
  302. int lnum;
  303. int unmap;
  304. };
  305. /**
  306. * struct ubifs_inode - UBIFS in-memory inode description.
  307. * @vfs_inode: VFS inode description object
  308. * @creat_sqnum: sequence number at time of creation
  309. * @del_cmtno: commit number corresponding to the time the inode was deleted,
  310. * protected by @c->commit_sem;
  311. * @xattr_size: summarized size of all extended attributes in bytes
  312. * @xattr_cnt: count of extended attributes this inode has
  313. * @xattr_names: sum of lengths of all extended attribute names belonging to
  314. * this inode
  315. * @dirty: non-zero if the inode is dirty
  316. * @xattr: non-zero if this is an extended attribute inode
  317. * @bulk_read: non-zero if bulk-read should be used
  318. * @ui_mutex: serializes inode write-back with the rest of VFS operations,
  319. * serializes "clean <-> dirty" state changes, serializes bulk-read,
  320. * protects @dirty, @bulk_read, @ui_size, and @xattr_size
  321. * @ui_lock: protects @synced_i_size
  322. * @synced_i_size: synchronized size of inode, i.e. the value of inode size
  323. * currently stored on the flash; used only for regular file
  324. * inodes
  325. * @ui_size: inode size used by UBIFS when writing to flash
  326. * @flags: inode flags (@UBIFS_COMPR_FL, etc)
  327. * @compr_type: default compression type used for this inode
  328. * @last_page_read: page number of last page read (for bulk read)
  329. * @read_in_a_row: number of consecutive pages read in a row (for bulk read)
  330. * @data_len: length of the data attached to the inode
  331. * @data: inode's data
  332. *
  333. * @ui_mutex exists for two main reasons. At first it prevents inodes from
  334. * being written back while UBIFS changing them, being in the middle of an VFS
  335. * operation. This way UBIFS makes sure the inode fields are consistent. For
  336. * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and
  337. * write-back must not write any of them before we have finished.
  338. *
  339. * The second reason is budgeting - UBIFS has to budget all operations. If an
  340. * operation is going to mark an inode dirty, it has to allocate budget for
  341. * this. It cannot just mark it dirty because there is no guarantee there will
  342. * be enough flash space to write the inode back later. This means UBIFS has
  343. * to have full control over inode "clean <-> dirty" transitions (and pages
  344. * actually). But unfortunately, VFS marks inodes dirty in many places, and it
  345. * does not ask the file-system if it is allowed to do so (there is a notifier,
  346. * but it is not enough), i.e., there is no mechanism to synchronize with this.
  347. * So UBIFS has its own inode dirty flag and its own mutex to serialize
  348. * "clean <-> dirty" transitions.
  349. *
  350. * The @synced_i_size field is used to make sure we never write pages which are
  351. * beyond last synchronized inode size. See 'ubifs_writepage()' for more
  352. * information.
  353. *
  354. * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses
  355. * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot
  356. * make sure @inode->i_size is always changed under @ui_mutex, because it
  357. * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would
  358. * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields
  359. * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one
  360. * could consider to rework locking and base it on "shadow" fields.
  361. */
  362. struct ubifs_inode {
  363. struct inode vfs_inode;
  364. unsigned long long creat_sqnum;
  365. unsigned long long del_cmtno;
  366. unsigned int xattr_size;
  367. unsigned int xattr_cnt;
  368. unsigned int xattr_names;
  369. unsigned int dirty:1;
  370. unsigned int xattr:1;
  371. unsigned int bulk_read:1;
  372. unsigned int compr_type:2;
  373. struct mutex ui_mutex;
  374. spinlock_t ui_lock;
  375. loff_t synced_i_size;
  376. loff_t ui_size;
  377. int flags;
  378. pgoff_t last_page_read;
  379. pgoff_t read_in_a_row;
  380. int data_len;
  381. void *data;
  382. };
  383. /**
  384. * struct ubifs_unclean_leb - records a LEB recovered under read-only mode.
  385. * @list: list
  386. * @lnum: LEB number of recovered LEB
  387. * @endpt: offset where recovery ended
  388. *
  389. * This structure records a LEB identified during recovery that needs to be
  390. * cleaned but was not because UBIFS was mounted read-only. The information
  391. * is used to clean the LEB when remounting to read-write mode.
  392. */
  393. struct ubifs_unclean_leb {
  394. struct list_head list;
  395. int lnum;
  396. int endpt;
  397. };
  398. /*
  399. * LEB properties flags.
  400. *
  401. * LPROPS_UNCAT: not categorized
  402. * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
  403. * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
  404. * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
  405. * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs
  406. * LPROPS_EMPTY: LEB is empty, not taken
  407. * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken
  408. * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken
  409. * LPROPS_CAT_MASK: mask for the LEB categories above
  410. * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media)
  411. * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash)
  412. */
  413. enum {
  414. LPROPS_UNCAT = 0,
  415. LPROPS_DIRTY = 1,
  416. LPROPS_DIRTY_IDX = 2,
  417. LPROPS_FREE = 3,
  418. LPROPS_HEAP_CNT = 3,
  419. LPROPS_EMPTY = 4,
  420. LPROPS_FREEABLE = 5,
  421. LPROPS_FRDI_IDX = 6,
  422. LPROPS_CAT_MASK = 15,
  423. LPROPS_TAKEN = 16,
  424. LPROPS_INDEX = 32,
  425. };
  426. /**
  427. * struct ubifs_lprops - logical eraseblock properties.
  428. * @free: amount of free space in bytes
  429. * @dirty: amount of dirty space in bytes
  430. * @flags: LEB properties flags (see above)
  431. * @lnum: LEB number
  432. * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE)
  433. * @hpos: heap position in heap of same-category lprops (other categories)
  434. */
  435. struct ubifs_lprops {
  436. int free;
  437. int dirty;
  438. int flags;
  439. int lnum;
  440. union {
  441. struct list_head list;
  442. int hpos;
  443. };
  444. };
  445. /**
  446. * struct ubifs_lpt_lprops - LPT logical eraseblock properties.
  447. * @free: amount of free space in bytes
  448. * @dirty: amount of dirty space in bytes
  449. * @tgc: trivial GC flag (1 => unmap after commit end)
  450. * @cmt: commit flag (1 => reserved for commit)
  451. */
  452. struct ubifs_lpt_lprops {
  453. int free;
  454. int dirty;
  455. unsigned tgc:1;
  456. unsigned cmt:1;
  457. };
  458. /**
  459. * struct ubifs_lp_stats - statistics of eraseblocks in the main area.
  460. * @empty_lebs: number of empty LEBs
  461. * @taken_empty_lebs: number of taken LEBs
  462. * @idx_lebs: number of indexing LEBs
  463. * @total_free: total free space in bytes (includes all LEBs)
  464. * @total_dirty: total dirty space in bytes (includes all LEBs)
  465. * @total_used: total used space in bytes (does not include index LEBs)
  466. * @total_dead: total dead space in bytes (does not include index LEBs)
  467. * @total_dark: total dark space in bytes (does not include index LEBs)
  468. *
  469. * The @taken_empty_lebs field counts the LEBs that are in the transient state
  470. * of having been "taken" for use but not yet written to. @taken_empty_lebs is
  471. * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be
  472. * used by itself (in which case 'unused_lebs' would be a better name). In the
  473. * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained
  474. * by GC, but unlike other empty LEBs that are "taken", it may not be written
  475. * straight away (i.e. before the next commit start or unmount), so either
  476. * @gc_lnum must be specially accounted for, or the current approach followed
  477. * i.e. count it under @taken_empty_lebs.
  478. *
  479. * @empty_lebs includes @taken_empty_lebs.
  480. *
  481. * @total_used, @total_dead and @total_dark fields do not account indexing
  482. * LEBs.
  483. */
  484. struct ubifs_lp_stats {
  485. int empty_lebs;
  486. int taken_empty_lebs;
  487. int idx_lebs;
  488. long long total_free;
  489. long long total_dirty;
  490. long long total_used;
  491. long long total_dead;
  492. long long total_dark;
  493. };
  494. struct ubifs_nnode;
  495. /**
  496. * struct ubifs_cnode - LEB Properties Tree common node.
  497. * @parent: parent nnode
  498. * @cnext: next cnode to commit
  499. * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
  500. * @iip: index in parent
  501. * @level: level in the tree (zero for pnodes, greater than zero for nnodes)
  502. * @num: node number
  503. */
  504. struct ubifs_cnode {
  505. struct ubifs_nnode *parent;
  506. struct ubifs_cnode *cnext;
  507. unsigned long flags;
  508. int iip;
  509. int level;
  510. int num;
  511. };
  512. /**
  513. * struct ubifs_pnode - LEB Properties Tree leaf node.
  514. * @parent: parent nnode
  515. * @cnext: next cnode to commit
  516. * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
  517. * @iip: index in parent
  518. * @level: level in the tree (always zero for pnodes)
  519. * @num: node number
  520. * @lprops: LEB properties array
  521. */
  522. struct ubifs_pnode {
  523. struct ubifs_nnode *parent;
  524. struct ubifs_cnode *cnext;
  525. unsigned long flags;
  526. int iip;
  527. int level;
  528. int num;
  529. struct ubifs_lprops lprops[UBIFS_LPT_FANOUT];
  530. };
  531. /**
  532. * struct ubifs_nbranch - LEB Properties Tree internal node branch.
  533. * @lnum: LEB number of child
  534. * @offs: offset of child
  535. * @nnode: nnode child
  536. * @pnode: pnode child
  537. * @cnode: cnode child
  538. */
  539. struct ubifs_nbranch {
  540. int lnum;
  541. int offs;
  542. union {
  543. struct ubifs_nnode *nnode;
  544. struct ubifs_pnode *pnode;
  545. struct ubifs_cnode *cnode;
  546. };
  547. };
  548. /**
  549. * struct ubifs_nnode - LEB Properties Tree internal node.
  550. * @parent: parent nnode
  551. * @cnext: next cnode to commit
  552. * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
  553. * @iip: index in parent
  554. * @level: level in the tree (always greater than zero for nnodes)
  555. * @num: node number
  556. * @nbranch: branches to child nodes
  557. */
  558. struct ubifs_nnode {
  559. struct ubifs_nnode *parent;
  560. struct ubifs_cnode *cnext;
  561. unsigned long flags;
  562. int iip;
  563. int level;
  564. int num;
  565. struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT];
  566. };
  567. /**
  568. * struct ubifs_lpt_heap - heap of categorized lprops.
  569. * @arr: heap array
  570. * @cnt: number in heap
  571. * @max_cnt: maximum number allowed in heap
  572. *
  573. * There are %LPROPS_HEAP_CNT heaps.
  574. */
  575. struct ubifs_lpt_heap {
  576. struct ubifs_lprops **arr;
  577. int cnt;
  578. int max_cnt;
  579. };
  580. /*
  581. * Return codes for LPT scan callback function.
  582. *
  583. * LPT_SCAN_CONTINUE: continue scanning
  584. * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory
  585. * LPT_SCAN_STOP: stop scanning
  586. */
  587. enum {
  588. LPT_SCAN_CONTINUE = 0,
  589. LPT_SCAN_ADD = 1,
  590. LPT_SCAN_STOP = 2,
  591. };
  592. struct ubifs_info;
  593. /* Callback used by the 'ubifs_lpt_scan_nolock()' function */
  594. typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c,
  595. const struct ubifs_lprops *lprops,
  596. int in_tree, void *data);
  597. /**
  598. * struct ubifs_wbuf - UBIFS write-buffer.
  599. * @c: UBIFS file-system description object
  600. * @buf: write-buffer (of min. flash I/O unit size)
  601. * @lnum: logical eraseblock number the write-buffer points to
  602. * @offs: write-buffer offset in this logical eraseblock
  603. * @avail: number of bytes available in the write-buffer
  604. * @used: number of used bytes in the write-buffer
  605. * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range)
  606. * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep
  607. * up by 'mutex_lock_nested()).
  608. * @sync_callback: write-buffer synchronization callback
  609. * @io_mutex: serializes write-buffer I/O
  610. * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes
  611. * fields
  612. * @timer: write-buffer timer
  613. * @no_timer: non-zero if this write-buffer does not have a timer
  614. * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing
  615. * @next_ino: points to the next position of the following inode number
  616. * @inodes: stores the inode numbers of the nodes which are in wbuf
  617. *
  618. * The write-buffer synchronization callback is called when the write-buffer is
  619. * synchronized in order to notify how much space was wasted due to
  620. * write-buffer padding and how much free space is left in the LEB.
  621. *
  622. * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under
  623. * spin-lock or mutex because they are written under both mutex and spin-lock.
  624. * @buf is appended to under mutex but overwritten under both mutex and
  625. * spin-lock. Thus the data between @buf and @buf + @used can be read under
  626. * spinlock.
  627. */
  628. struct ubifs_wbuf {
  629. struct ubifs_info *c;
  630. void *buf;
  631. int lnum;
  632. int offs;
  633. int avail;
  634. int used;
  635. int size;
  636. int jhead;
  637. int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad);
  638. struct mutex io_mutex;
  639. spinlock_t lock;
  640. struct hrtimer timer;
  641. unsigned int no_timer:1;
  642. unsigned int need_sync:1;
  643. int next_ino;
  644. ino_t *inodes;
  645. };
  646. /**
  647. * struct ubifs_bud - bud logical eraseblock.
  648. * @lnum: logical eraseblock number
  649. * @start: where the (uncommitted) bud data starts
  650. * @jhead: journal head number this bud belongs to
  651. * @list: link in the list buds belonging to the same journal head
  652. * @rb: link in the tree of all buds
  653. */
  654. struct ubifs_bud {
  655. int lnum;
  656. int start;
  657. int jhead;
  658. struct list_head list;
  659. struct rb_node rb;
  660. };
  661. /**
  662. * struct ubifs_jhead - journal head.
  663. * @wbuf: head's write-buffer
  664. * @buds_list: list of bud LEBs belonging to this journal head
  665. * @grouped: non-zero if UBIFS groups nodes when writing to this journal head
  666. *
  667. * Note, the @buds list is protected by the @c->buds_lock.
  668. */
  669. struct ubifs_jhead {
  670. struct ubifs_wbuf wbuf;
  671. struct list_head buds_list;
  672. unsigned int grouped:1;
  673. };
  674. /**
  675. * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
  676. * @key: key
  677. * @znode: znode address in memory
  678. * @lnum: LEB number of the target node (indexing node or data node)
  679. * @offs: target node offset within @lnum
  680. * @len: target node length
  681. */
  682. struct ubifs_zbranch {
  683. union ubifs_key key;
  684. union {
  685. struct ubifs_znode *znode;
  686. void *leaf;
  687. };
  688. int lnum;
  689. int offs;
  690. int len;
  691. };
  692. /**
  693. * struct ubifs_znode - in-memory representation of an indexing node.
  694. * @parent: parent znode or NULL if it is the root
  695. * @cnext: next znode to commit
  696. * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE)
  697. * @time: last access time (seconds)
  698. * @level: level of the entry in the TNC tree
  699. * @child_cnt: count of child znodes
  700. * @iip: index in parent's zbranch array
  701. * @alt: lower bound of key range has altered i.e. child inserted at slot 0
  702. * @lnum: LEB number of the corresponding indexing node
  703. * @offs: offset of the corresponding indexing node
  704. * @len: length of the corresponding indexing node
  705. * @zbranch: array of znode branches (@c->fanout elements)
  706. *
  707. * Note! The @lnum, @offs, and @len fields are not really needed - we have them
  708. * only for internal consistency check. They could be removed to save some RAM.
  709. */
  710. struct ubifs_znode {
  711. struct ubifs_znode *parent;
  712. struct ubifs_znode *cnext;
  713. unsigned long flags;
  714. time64_t time;
  715. int level;
  716. int child_cnt;
  717. int iip;
  718. int alt;
  719. int lnum;
  720. int offs;
  721. int len;
  722. struct ubifs_zbranch zbranch[];
  723. };
  724. /**
  725. * struct bu_info - bulk-read information.
  726. * @key: first data node key
  727. * @zbranch: zbranches of data nodes to bulk read
  728. * @buf: buffer to read into
  729. * @buf_len: buffer length
  730. * @gc_seq: GC sequence number to detect races with GC
  731. * @cnt: number of data nodes for bulk read
  732. * @blk_cnt: number of data blocks including holes
  733. * @oef: end of file reached
  734. */
  735. struct bu_info {
  736. union ubifs_key key;
  737. struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ];
  738. void *buf;
  739. int buf_len;
  740. int gc_seq;
  741. int cnt;
  742. int blk_cnt;
  743. int eof;
  744. };
  745. /**
  746. * struct ubifs_node_range - node length range description data structure.
  747. * @len: fixed node length
  748. * @min_len: minimum possible node length
  749. * @max_len: maximum possible node length
  750. *
  751. * If @max_len is %0, the node has fixed length @len.
  752. */
  753. struct ubifs_node_range {
  754. union {
  755. int len;
  756. int min_len;
  757. };
  758. int max_len;
  759. };
  760. /**
  761. * struct ubifs_compressor - UBIFS compressor description structure.
  762. * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc)
  763. * @cc: cryptoapi compressor handle
  764. * @comp_mutex: mutex used during compression
  765. * @decomp_mutex: mutex used during decompression
  766. * @name: compressor name
  767. * @capi_name: cryptoapi compressor name
  768. */
  769. struct ubifs_compressor {
  770. int compr_type;
  771. struct crypto_comp *cc;
  772. struct mutex *comp_mutex;
  773. struct mutex *decomp_mutex;
  774. const char *name;
  775. const char *capi_name;
  776. };
  777. /**
  778. * struct ubifs_budget_req - budget requirements of an operation.
  779. *
  780. * @fast: non-zero if the budgeting should try to acquire budget quickly and
  781. * should not try to call write-back
  782. * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields
  783. * have to be re-calculated
  784. * @new_page: non-zero if the operation adds a new page
  785. * @dirtied_page: non-zero if the operation makes a page dirty
  786. * @new_dent: non-zero if the operation adds a new directory entry
  787. * @mod_dent: non-zero if the operation removes or modifies an existing
  788. * directory entry
  789. * @new_ino: non-zero if the operation adds a new inode
  790. * @new_ino_d: how much data newly created inode contains
  791. * @dirtied_ino: how many inodes the operation makes dirty
  792. * @dirtied_ino_d: how much data dirtied inode contains
  793. * @idx_growth: how much the index will supposedly grow
  794. * @data_growth: how much new data the operation will supposedly add
  795. * @dd_growth: how much data that makes other data dirty the operation will
  796. * supposedly add
  797. *
  798. * @idx_growth, @data_growth and @dd_growth are not used in budget request. The
  799. * budgeting subsystem caches index and data growth values there to avoid
  800. * re-calculating them when the budget is released. However, if @idx_growth is
  801. * %-1, it is calculated by the release function using other fields.
  802. *
  803. * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d
  804. * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made
  805. * dirty by the re-name operation.
  806. *
  807. * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to
  808. * make sure the amount of inode data which contribute to @new_ino_d and
  809. * @dirtied_ino_d fields are aligned.
  810. */
  811. struct ubifs_budget_req {
  812. unsigned int fast:1;
  813. unsigned int recalculate:1;
  814. #ifndef UBIFS_DEBUG
  815. unsigned int new_page:1;
  816. unsigned int dirtied_page:1;
  817. unsigned int new_dent:1;
  818. unsigned int mod_dent:1;
  819. unsigned int new_ino:1;
  820. unsigned int new_ino_d:13;
  821. unsigned int dirtied_ino:4;
  822. unsigned int dirtied_ino_d:15;
  823. #else
  824. /* Not bit-fields to check for overflows */
  825. unsigned int new_page;
  826. unsigned int dirtied_page;
  827. unsigned int new_dent;
  828. unsigned int mod_dent;
  829. unsigned int new_ino;
  830. unsigned int new_ino_d;
  831. unsigned int dirtied_ino;
  832. unsigned int dirtied_ino_d;
  833. #endif
  834. int idx_growth;
  835. int data_growth;
  836. int dd_growth;
  837. };
  838. /**
  839. * struct ubifs_orphan - stores the inode number of an orphan.
  840. * @rb: rb-tree node of rb-tree of orphans sorted by inode number
  841. * @list: list head of list of orphans in order added
  842. * @new_list: list head of list of orphans added since the last commit
  843. * @cnext: next orphan to commit
  844. * @dnext: next orphan to delete
  845. * @inum: inode number
  846. * @new: %1 => added since the last commit, otherwise %0
  847. * @cmt: %1 => commit pending, otherwise %0
  848. * @del: %1 => delete pending, otherwise %0
  849. */
  850. struct ubifs_orphan {
  851. struct rb_node rb;
  852. struct list_head list;
  853. struct list_head new_list;
  854. struct ubifs_orphan *cnext;
  855. struct ubifs_orphan *dnext;
  856. ino_t inum;
  857. unsigned new:1;
  858. unsigned cmt:1;
  859. unsigned del:1;
  860. };
  861. /**
  862. * struct ubifs_mount_opts - UBIFS-specific mount options information.
  863. * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
  864. * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable)
  865. * @chk_data_crc: enable/disable CRC data checking when reading data nodes
  866. * (%0 default, %1 disable, %2 enable)
  867. * @override_compr: override default compressor (%0 - do not override and use
  868. * superblock compressor, %1 - override and use compressor
  869. * specified in @compr_type)
  870. * @compr_type: compressor type to override the superblock compressor with
  871. * (%UBIFS_COMPR_NONE, etc)
  872. */
  873. struct ubifs_mount_opts {
  874. unsigned int unmount_mode:2;
  875. unsigned int bulk_read:2;
  876. unsigned int chk_data_crc:2;
  877. unsigned int override_compr:1;
  878. unsigned int compr_type:2;
  879. };
  880. /**
  881. * struct ubifs_budg_info - UBIFS budgeting information.
  882. * @idx_growth: amount of bytes budgeted for index growth
  883. * @data_growth: amount of bytes budgeted for cached data
  884. * @dd_growth: amount of bytes budgeted for cached data that will make
  885. * other data dirty
  886. * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but
  887. * which still have to be taken into account because the index
  888. * has not been committed so far
  889. * @old_idx_sz: size of index on flash
  890. * @min_idx_lebs: minimum number of LEBs required for the index
  891. * @nospace: non-zero if the file-system does not have flash space (used as
  892. * optimization)
  893. * @nospace_rp: the same as @nospace, but additionally means that even reserved
  894. * pool is full
  895. * @page_budget: budget for a page (constant, never changed after mount)
  896. * @inode_budget: budget for an inode (constant, never changed after mount)
  897. * @dent_budget: budget for a directory entry (constant, never changed after
  898. * mount)
  899. */
  900. struct ubifs_budg_info {
  901. long long idx_growth;
  902. long long data_growth;
  903. long long dd_growth;
  904. long long uncommitted_idx;
  905. unsigned long long old_idx_sz;
  906. int min_idx_lebs;
  907. unsigned int nospace:1;
  908. unsigned int nospace_rp:1;
  909. int page_budget;
  910. int inode_budget;
  911. int dent_budget;
  912. };
  913. struct ubifs_debug_info;
  914. /**
  915. * struct ubifs_info - UBIFS file-system description data structure
  916. * (per-superblock).
  917. * @vfs_sb: VFS @struct super_block object
  918. *
  919. * @highest_inum: highest used inode number
  920. * @max_sqnum: current global sequence number
  921. * @cmt_no: commit number of the last successfully completed commit, protected
  922. * by @commit_sem
  923. * @cnt_lock: protects @highest_inum and @max_sqnum counters
  924. * @fmt_version: UBIFS on-flash format version
  925. * @ro_compat_version: R/O compatibility version
  926. * @uuid: UUID from super block
  927. *
  928. * @lhead_lnum: log head logical eraseblock number
  929. * @lhead_offs: log head offset
  930. * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
  931. * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
  932. * @bud_bytes
  933. * @min_log_bytes: minimum required number of bytes in the log
  934. * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
  935. * committed buds
  936. *
  937. * @buds: tree of all buds indexed by bud LEB number
  938. * @bud_bytes: how many bytes of flash is used by buds
  939. * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
  940. * lists
  941. * @jhead_cnt: count of journal heads
  942. * @jheads: journal heads (head zero is base head)
  943. * @max_bud_bytes: maximum number of bytes allowed in buds
  944. * @bg_bud_bytes: number of bud bytes when background commit is initiated
  945. * @old_buds: buds to be released after commit ends
  946. * @max_bud_cnt: maximum number of buds
  947. *
  948. * @commit_sem: synchronizes committer with other processes
  949. * @cmt_state: commit state
  950. * @cs_lock: commit state lock
  951. * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
  952. *
  953. * @big_lpt: flag that LPT is too big to write whole during commit
  954. * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up
  955. * @double_hash: flag indicating that we can do lookups by hash
  956. * @encrypted: flag indicating that this file system contains encrypted files
  957. * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
  958. * recovery)
  959. * @bulk_read: enable bulk-reads
  960. * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
  961. * @rw_incompat: the media is not R/W compatible
  962. * @assert_action: action to take when a ubifs_assert() fails
  963. *
  964. * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
  965. * @calc_idx_sz
  966. * @zroot: zbranch which points to the root index node and znode
  967. * @cnext: next znode to commit
  968. * @enext: next znode to commit to empty space
  969. * @gap_lebs: array of LEBs used by the in-gaps commit method
  970. * @cbuf: commit buffer
  971. * @ileb_buf: buffer for commit in-the-gaps method
  972. * @ileb_len: length of data in ileb_buf
  973. * @ihead_lnum: LEB number of index head
  974. * @ihead_offs: offset of index head
  975. * @ilebs: pre-allocated index LEBs
  976. * @ileb_cnt: number of pre-allocated index LEBs
  977. * @ileb_nxt: next pre-allocated index LEBs
  978. * @old_idx: tree of index nodes obsoleted since the last commit start
  979. * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
  980. *
  981. * @mst_node: master node
  982. * @mst_offs: offset of valid master node
  983. *
  984. * @max_bu_buf_len: maximum bulk-read buffer length
  985. * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
  986. * @bu: pre-allocated bulk-read information
  987. *
  988. * @write_reserve_mutex: protects @write_reserve_buf
  989. * @write_reserve_buf: on the write path we allocate memory, which might
  990. * sometimes be unavailable, in which case we use this
  991. * write reserve buffer
  992. *
  993. * @log_lebs: number of logical eraseblocks in the log
  994. * @log_bytes: log size in bytes
  995. * @log_last: last LEB of the log
  996. * @lpt_lebs: number of LEBs used for lprops table
  997. * @lpt_first: first LEB of the lprops table area
  998. * @lpt_last: last LEB of the lprops table area
  999. * @orph_lebs: number of LEBs used for the orphan area
  1000. * @orph_first: first LEB of the orphan area
  1001. * @orph_last: last LEB of the orphan area
  1002. * @main_lebs: count of LEBs in the main area
  1003. * @main_first: first LEB of the main area
  1004. * @main_bytes: main area size in bytes
  1005. *
  1006. * @key_hash_type: type of the key hash
  1007. * @key_hash: direntry key hash function
  1008. * @key_fmt: key format
  1009. * @key_len: key length
  1010. * @fanout: fanout of the index tree (number of links per indexing node)
  1011. *
  1012. * @min_io_size: minimal input/output unit size
  1013. * @min_io_shift: number of bits in @min_io_size minus one
  1014. * @max_write_size: maximum amount of bytes the underlying flash can write at a
  1015. * time (MTD write buffer size)
  1016. * @max_write_shift: number of bits in @max_write_size minus one
  1017. * @leb_size: logical eraseblock size in bytes
  1018. * @leb_start: starting offset of logical eraseblocks within physical
  1019. * eraseblocks
  1020. * @half_leb_size: half LEB size
  1021. * @idx_leb_size: how many bytes of an LEB are effectively available when it is
  1022. * used to store indexing nodes (@leb_size - @max_idx_node_sz)
  1023. * @leb_cnt: count of logical eraseblocks
  1024. * @max_leb_cnt: maximum count of logical eraseblocks
  1025. * @old_leb_cnt: count of logical eraseblocks before re-size
  1026. * @ro_media: the underlying UBI volume is read-only
  1027. * @ro_mount: the file-system was mounted as read-only
  1028. * @ro_error: UBIFS switched to R/O mode because an error happened
  1029. *
  1030. * @dirty_pg_cnt: number of dirty pages (not used)
  1031. * @dirty_zn_cnt: number of dirty znodes
  1032. * @clean_zn_cnt: number of clean znodes
  1033. *
  1034. * @space_lock: protects @bi and @lst
  1035. * @lst: lprops statistics
  1036. * @bi: budgeting information
  1037. * @calc_idx_sz: temporary variable which is used to calculate new index size
  1038. * (contains accurate new index size at end of TNC commit start)
  1039. *
  1040. * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
  1041. * I/O unit
  1042. * @mst_node_alsz: master node aligned size
  1043. * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
  1044. * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
  1045. * @max_inode_sz: maximum possible inode size in bytes
  1046. * @max_znode_sz: size of znode in bytes
  1047. *
  1048. * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
  1049. * data nodes of maximum size - used in free space reporting
  1050. * @dead_wm: LEB dead space watermark
  1051. * @dark_wm: LEB dark space watermark
  1052. * @block_cnt: count of 4KiB blocks on the FS
  1053. *
  1054. * @ranges: UBIFS node length ranges
  1055. * @ubi: UBI volume descriptor
  1056. * @di: UBI device information
  1057. * @vi: UBI volume information
  1058. *
  1059. * @orph_tree: rb-tree of orphan inode numbers
  1060. * @orph_list: list of orphan inode numbers in order added
  1061. * @orph_new: list of orphan inode numbers added since last commit
  1062. * @orph_cnext: next orphan to commit
  1063. * @orph_dnext: next orphan to delete
  1064. * @orphan_lock: lock for orph_tree and orph_new
  1065. * @orph_buf: buffer for orphan nodes
  1066. * @new_orphans: number of orphans since last commit
  1067. * @cmt_orphans: number of orphans being committed
  1068. * @tot_orphans: number of orphans in the rb_tree
  1069. * @max_orphans: maximum number of orphans allowed
  1070. * @ohead_lnum: orphan head LEB number
  1071. * @ohead_offs: orphan head offset
  1072. * @no_orphs: non-zero if there are no orphans
  1073. *
  1074. * @bgt: UBIFS background thread
  1075. * @bgt_name: background thread name
  1076. * @need_bgt: if background thread should run
  1077. * @need_wbuf_sync: if write-buffers have to be synchronized
  1078. *
  1079. * @gc_lnum: LEB number used for garbage collection
  1080. * @sbuf: a buffer of LEB size used by GC and replay for scanning
  1081. * @idx_gc: list of index LEBs that have been garbage collected
  1082. * @idx_gc_cnt: number of elements on the idx_gc list
  1083. * @gc_seq: incremented for every non-index LEB garbage collected
  1084. * @gced_lnum: last non-index LEB that was garbage collected
  1085. *
  1086. * @infos_list: links all 'ubifs_info' objects
  1087. * @umount_mutex: serializes shrinker and un-mount
  1088. * @shrinker_run_no: shrinker run number
  1089. *
  1090. * @space_bits: number of bits needed to record free or dirty space
  1091. * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
  1092. * @lpt_offs_bits: number of bits needed to record an offset in the LPT
  1093. * @lpt_spc_bits: number of bits needed to space in the LPT
  1094. * @pcnt_bits: number of bits needed to record pnode or nnode number
  1095. * @lnum_bits: number of bits needed to record LEB number
  1096. * @nnode_sz: size of on-flash nnode
  1097. * @pnode_sz: size of on-flash pnode
  1098. * @ltab_sz: size of on-flash LPT lprops table
  1099. * @lsave_sz: size of on-flash LPT save table
  1100. * @pnode_cnt: number of pnodes
  1101. * @nnode_cnt: number of nnodes
  1102. * @lpt_hght: height of the LPT
  1103. * @pnodes_have: number of pnodes in memory
  1104. *
  1105. * @lp_mutex: protects lprops table and all the other lprops-related fields
  1106. * @lpt_lnum: LEB number of the root nnode of the LPT
  1107. * @lpt_offs: offset of the root nnode of the LPT
  1108. * @nhead_lnum: LEB number of LPT head
  1109. * @nhead_offs: offset of LPT head
  1110. * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
  1111. * @dirty_nn_cnt: number of dirty nnodes
  1112. * @dirty_pn_cnt: number of dirty pnodes
  1113. * @check_lpt_free: flag that indicates LPT GC may be needed
  1114. * @lpt_sz: LPT size
  1115. * @lpt_nod_buf: buffer for an on-flash nnode or pnode
  1116. * @lpt_buf: buffer of LEB size used by LPT
  1117. * @nroot: address in memory of the root nnode of the LPT
  1118. * @lpt_cnext: next LPT node to commit
  1119. * @lpt_heap: array of heaps of categorized lprops
  1120. * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
  1121. * previous commit start
  1122. * @uncat_list: list of un-categorized LEBs
  1123. * @empty_list: list of empty LEBs
  1124. * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size)
  1125. * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size)
  1126. * @freeable_cnt: number of freeable LEBs in @freeable_list
  1127. * @in_a_category_cnt: count of lprops which are in a certain category, which
  1128. * basically meants that they were loaded from the flash
  1129. *
  1130. * @ltab_lnum: LEB number of LPT's own lprops table
  1131. * @ltab_offs: offset of LPT's own lprops table
  1132. * @ltab: LPT's own lprops table
  1133. * @ltab_cmt: LPT's own lprops table (commit copy)
  1134. * @lsave_cnt: number of LEB numbers in LPT's save table
  1135. * @lsave_lnum: LEB number of LPT's save table
  1136. * @lsave_offs: offset of LPT's save table
  1137. * @lsave: LPT's save table
  1138. * @lscan_lnum: LEB number of last LPT scan
  1139. *
  1140. * @rp_size: size of the reserved pool in bytes
  1141. * @report_rp_size: size of the reserved pool reported to user-space
  1142. * @rp_uid: reserved pool user ID
  1143. * @rp_gid: reserved pool group ID
  1144. *
  1145. * @empty: %1 if the UBI device is empty
  1146. * @need_recovery: %1 if the file-system needs recovery
  1147. * @replaying: %1 during journal replay
  1148. * @mounting: %1 while mounting
  1149. * @probing: %1 while attempting to mount if SB_SILENT mount flag is set
  1150. * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode
  1151. * @replay_list: temporary list used during journal replay
  1152. * @replay_buds: list of buds to replay
  1153. * @cs_sqnum: sequence number of first node in the log (commit start node)
  1154. * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W
  1155. * mode
  1156. * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted
  1157. * FS to R/W mode
  1158. * @size_tree: inode size information for recovery
  1159. * @mount_opts: UBIFS-specific mount options
  1160. *
  1161. * @dbg: debugging-related information
  1162. */
  1163. struct ubifs_info {
  1164. struct super_block *vfs_sb;
  1165. ino_t highest_inum;
  1166. unsigned long long max_sqnum;
  1167. unsigned long long cmt_no;
  1168. spinlock_t cnt_lock;
  1169. int fmt_version;
  1170. int ro_compat_version;
  1171. unsigned char uuid[16];
  1172. int lhead_lnum;
  1173. int lhead_offs;
  1174. int ltail_lnum;
  1175. struct mutex log_mutex;
  1176. int min_log_bytes;
  1177. long long cmt_bud_bytes;
  1178. struct rb_root buds;
  1179. long long bud_bytes;
  1180. spinlock_t buds_lock;
  1181. int jhead_cnt;
  1182. struct ubifs_jhead *jheads;
  1183. long long max_bud_bytes;
  1184. long long bg_bud_bytes;
  1185. struct list_head old_buds;
  1186. int max_bud_cnt;
  1187. struct rw_semaphore commit_sem;
  1188. int cmt_state;
  1189. spinlock_t cs_lock;
  1190. wait_queue_head_t cmt_wq;
  1191. unsigned int big_lpt:1;
  1192. unsigned int space_fixup:1;
  1193. unsigned int double_hash:1;
  1194. unsigned int encrypted:1;
  1195. unsigned int no_chk_data_crc:1;
  1196. unsigned int bulk_read:1;
  1197. unsigned int default_compr:2;
  1198. unsigned int rw_incompat:1;
  1199. unsigned int assert_action:2;
  1200. struct mutex tnc_mutex;
  1201. struct ubifs_zbranch zroot;
  1202. struct ubifs_znode *cnext;
  1203. struct ubifs_znode *enext;
  1204. int *gap_lebs;
  1205. void *cbuf;
  1206. void *ileb_buf;
  1207. int ileb_len;
  1208. int ihead_lnum;
  1209. int ihead_offs;
  1210. int *ilebs;
  1211. int ileb_cnt;
  1212. int ileb_nxt;
  1213. struct rb_root old_idx;
  1214. int *bottom_up_buf;
  1215. struct ubifs_mst_node *mst_node;
  1216. int mst_offs;
  1217. int max_bu_buf_len;
  1218. struct mutex bu_mutex;
  1219. struct bu_info bu;
  1220. struct mutex write_reserve_mutex;
  1221. void *write_reserve_buf;
  1222. int log_lebs;
  1223. long long log_bytes;
  1224. int log_last;
  1225. int lpt_lebs;
  1226. int lpt_first;
  1227. int lpt_last;
  1228. int orph_lebs;
  1229. int orph_first;
  1230. int orph_last;
  1231. int main_lebs;
  1232. int main_first;
  1233. long long main_bytes;
  1234. uint8_t key_hash_type;
  1235. uint32_t (*key_hash)(const char *str, int len);
  1236. int key_fmt;
  1237. int key_len;
  1238. int fanout;
  1239. int min_io_size;
  1240. int min_io_shift;
  1241. int max_write_size;
  1242. int max_write_shift;
  1243. int leb_size;
  1244. int leb_start;
  1245. int half_leb_size;
  1246. int idx_leb_size;
  1247. int leb_cnt;
  1248. int max_leb_cnt;
  1249. int old_leb_cnt;
  1250. unsigned int ro_media:1;
  1251. unsigned int ro_mount:1;
  1252. unsigned int ro_error:1;
  1253. atomic_long_t dirty_pg_cnt;
  1254. atomic_long_t dirty_zn_cnt;
  1255. atomic_long_t clean_zn_cnt;
  1256. spinlock_t space_lock;
  1257. struct ubifs_lp_stats lst;
  1258. struct ubifs_budg_info bi;
  1259. unsigned long long calc_idx_sz;
  1260. int ref_node_alsz;
  1261. int mst_node_alsz;
  1262. int min_idx_node_sz;
  1263. int max_idx_node_sz;
  1264. long long max_inode_sz;
  1265. int max_znode_sz;
  1266. int leb_overhead;
  1267. int dead_wm;
  1268. int dark_wm;
  1269. int block_cnt;
  1270. struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
  1271. struct ubi_volume_desc *ubi;
  1272. struct ubi_device_info di;
  1273. struct ubi_volume_info vi;
  1274. struct rb_root orph_tree;
  1275. struct list_head orph_list;
  1276. struct list_head orph_new;
  1277. struct ubifs_orphan *orph_cnext;
  1278. struct ubifs_orphan *orph_dnext;
  1279. spinlock_t orphan_lock;
  1280. void *orph_buf;
  1281. int new_orphans;
  1282. int cmt_orphans;
  1283. int tot_orphans;
  1284. int max_orphans;
  1285. int ohead_lnum;
  1286. int ohead_offs;
  1287. int no_orphs;
  1288. struct task_struct *bgt;
  1289. char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
  1290. int need_bgt;
  1291. int need_wbuf_sync;
  1292. int gc_lnum;
  1293. void *sbuf;
  1294. struct list_head idx_gc;
  1295. int idx_gc_cnt;
  1296. int gc_seq;
  1297. int gced_lnum;
  1298. struct list_head infos_list;
  1299. struct mutex umount_mutex;
  1300. unsigned int shrinker_run_no;
  1301. int space_bits;
  1302. int lpt_lnum_bits;
  1303. int lpt_offs_bits;
  1304. int lpt_spc_bits;
  1305. int pcnt_bits;
  1306. int lnum_bits;
  1307. int nnode_sz;
  1308. int pnode_sz;
  1309. int ltab_sz;
  1310. int lsave_sz;
  1311. int pnode_cnt;
  1312. int nnode_cnt;
  1313. int lpt_hght;
  1314. int pnodes_have;
  1315. struct mutex lp_mutex;
  1316. int lpt_lnum;
  1317. int lpt_offs;
  1318. int nhead_lnum;
  1319. int nhead_offs;
  1320. int lpt_drty_flgs;
  1321. int dirty_nn_cnt;
  1322. int dirty_pn_cnt;
  1323. int check_lpt_free;
  1324. long long lpt_sz;
  1325. void *lpt_nod_buf;
  1326. void *lpt_buf;
  1327. struct ubifs_nnode *nroot;
  1328. struct ubifs_cnode *lpt_cnext;
  1329. struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
  1330. struct ubifs_lpt_heap dirty_idx;
  1331. struct list_head uncat_list;
  1332. struct list_head empty_list;
  1333. struct list_head freeable_list;
  1334. struct list_head frdi_idx_list;
  1335. int freeable_cnt;
  1336. int in_a_category_cnt;
  1337. int ltab_lnum;
  1338. int ltab_offs;
  1339. struct ubifs_lpt_lprops *ltab;
  1340. struct ubifs_lpt_lprops *ltab_cmt;
  1341. int lsave_cnt;
  1342. int lsave_lnum;
  1343. int lsave_offs;
  1344. int *lsave;
  1345. int lscan_lnum;
  1346. long long rp_size;
  1347. long long report_rp_size;
  1348. kuid_t rp_uid;
  1349. kgid_t rp_gid;
  1350. /* The below fields are used only during mounting and re-mounting */
  1351. unsigned int empty:1;
  1352. unsigned int need_recovery:1;
  1353. unsigned int replaying:1;
  1354. unsigned int mounting:1;
  1355. unsigned int remounting_rw:1;
  1356. unsigned int probing:1;
  1357. struct list_head replay_list;
  1358. struct list_head replay_buds;
  1359. unsigned long long cs_sqnum;
  1360. struct list_head unclean_leb_list;
  1361. struct ubifs_mst_node *rcvrd_mst_node;
  1362. struct rb_root size_tree;
  1363. struct ubifs_mount_opts mount_opts;
  1364. struct ubifs_debug_info *dbg;
  1365. };
  1366. extern struct list_head ubifs_infos;
  1367. extern spinlock_t ubifs_infos_lock;
  1368. extern atomic_long_t ubifs_clean_zn_cnt;
  1369. extern const struct super_operations ubifs_super_operations;
  1370. extern const struct address_space_operations ubifs_file_address_operations;
  1371. extern const struct file_operations ubifs_file_operations;
  1372. extern const struct inode_operations ubifs_file_inode_operations;
  1373. extern const struct file_operations ubifs_dir_operations;
  1374. extern const struct inode_operations ubifs_dir_inode_operations;
  1375. extern const struct inode_operations ubifs_symlink_inode_operations;
  1376. extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
  1377. /* io.c */
  1378. void ubifs_ro_mode(struct ubifs_info *c, int err);
  1379. int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs,
  1380. int len, int even_ebadmsg);
  1381. int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
  1382. int len);
  1383. int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
  1384. int ubifs_leb_unmap(struct ubifs_info *c, int lnum);
  1385. int ubifs_leb_map(struct ubifs_info *c, int lnum);
  1386. int ubifs_is_mapped(const struct ubifs_info *c, int lnum);
  1387. int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
  1388. int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs);
  1389. int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
  1390. int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
  1391. int lnum, int offs);
  1392. int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
  1393. int lnum, int offs);
  1394. int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
  1395. int offs);
  1396. int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
  1397. int offs, int quiet, int must_chk_crc);
  1398. void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
  1399. void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
  1400. int ubifs_io_init(struct ubifs_info *c);
  1401. void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
  1402. int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
  1403. int ubifs_bg_wbufs_sync(struct ubifs_info *c);
  1404. void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
  1405. int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
  1406. /* scan.c */
  1407. struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
  1408. int offs, void *sbuf, int quiet);
  1409. void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
  1410. int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
  1411. int offs, int quiet);
  1412. struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
  1413. int offs, void *sbuf);
  1414. void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
  1415. int lnum, int offs);
  1416. int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
  1417. void *buf, int offs);
  1418. void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
  1419. void *buf);
  1420. /* log.c */
  1421. void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
  1422. void ubifs_create_buds_lists(struct ubifs_info *c);
  1423. int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
  1424. struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
  1425. struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
  1426. int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
  1427. int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
  1428. int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
  1429. int ubifs_consolidate_log(struct ubifs_info *c);
  1430. /* journal.c */
  1431. int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
  1432. const struct fscrypt_name *nm, const struct inode *inode,
  1433. int deletion, int xent);
  1434. int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
  1435. const union ubifs_key *key, const void *buf, int len);
  1436. int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
  1437. int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
  1438. int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,
  1439. const struct inode *fst_inode,
  1440. const struct fscrypt_name *fst_nm,
  1441. const struct inode *snd_dir,
  1442. const struct inode *snd_inode,
  1443. const struct fscrypt_name *snd_nm, int sync);
  1444. int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
  1445. const struct inode *old_inode,
  1446. const struct fscrypt_name *old_nm,
  1447. const struct inode *new_dir,
  1448. const struct inode *new_inode,
  1449. const struct fscrypt_name *new_nm,
  1450. const struct inode *whiteout, int sync);
  1451. int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
  1452. loff_t old_size, loff_t new_size);
  1453. int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
  1454. const struct inode *inode, const struct fscrypt_name *nm);
  1455. int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
  1456. const struct inode *inode2);
  1457. /* budget.c */
  1458. int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
  1459. void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
  1460. void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
  1461. struct ubifs_inode *ui);
  1462. int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
  1463. struct ubifs_budget_req *req);
  1464. void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
  1465. struct ubifs_budget_req *req);
  1466. void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
  1467. struct ubifs_budget_req *req);
  1468. long long ubifs_get_free_space(struct ubifs_info *c);
  1469. long long ubifs_get_free_space_nolock(struct ubifs_info *c);
  1470. int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
  1471. void ubifs_convert_page_budget(struct ubifs_info *c);
  1472. long long ubifs_reported_space(const struct ubifs_info *c, long long free);
  1473. long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
  1474. /* find.c */
  1475. int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
  1476. int squeeze);
  1477. int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
  1478. int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
  1479. int min_space, int pick_free);
  1480. int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
  1481. int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
  1482. /* tnc.c */
  1483. int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
  1484. struct ubifs_znode **zn, int *n);
  1485. int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
  1486. void *node, const struct fscrypt_name *nm);
  1487. int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key,
  1488. void *node, uint32_t secondary_hash);
  1489. int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
  1490. void *node, int *lnum, int *offs);
  1491. int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
  1492. int offs, int len);
  1493. int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
  1494. int old_lnum, int old_offs, int lnum, int offs, int len);
  1495. int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
  1496. int lnum, int offs, int len, const struct fscrypt_name *nm);
  1497. int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
  1498. int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
  1499. const struct fscrypt_name *nm);
  1500. int ubifs_tnc_remove_dh(struct ubifs_info *c, const union ubifs_key *key,
  1501. uint32_t cookie);
  1502. int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
  1503. union ubifs_key *to_key);
  1504. int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
  1505. struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
  1506. union ubifs_key *key,
  1507. const struct fscrypt_name *nm);
  1508. void ubifs_tnc_close(struct ubifs_info *c);
  1509. int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
  1510. int lnum, int offs, int is_idx);
  1511. int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
  1512. int lnum, int offs);
  1513. /* Shared by tnc.c for tnc_commit.c */
  1514. void destroy_old_idx(struct ubifs_info *c);
  1515. int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
  1516. int lnum, int offs);
  1517. int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
  1518. int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
  1519. int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
  1520. /* tnc_misc.c */
  1521. struct ubifs_znode *ubifs_tnc_levelorder_next(const struct ubifs_info *c,
  1522. struct ubifs_znode *zr,
  1523. struct ubifs_znode *znode);
  1524. int ubifs_search_zbranch(const struct ubifs_info *c,
  1525. const struct ubifs_znode *znode,
  1526. const union ubifs_key *key, int *n);
  1527. struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
  1528. struct ubifs_znode *ubifs_tnc_postorder_next(const struct ubifs_info *c,
  1529. struct ubifs_znode *znode);
  1530. long ubifs_destroy_tnc_subtree(const struct ubifs_info *c,
  1531. struct ubifs_znode *zr);
  1532. struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
  1533. struct ubifs_zbranch *zbr,
  1534. struct ubifs_znode *parent, int iip);
  1535. int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
  1536. void *node);
  1537. /* tnc_commit.c */
  1538. int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
  1539. int ubifs_tnc_end_commit(struct ubifs_info *c);
  1540. /* shrinker.c */
  1541. unsigned long ubifs_shrink_scan(struct shrinker *shrink,
  1542. struct shrink_control *sc);
  1543. unsigned long ubifs_shrink_count(struct shrinker *shrink,
  1544. struct shrink_control *sc);
  1545. /* commit.c */
  1546. int ubifs_bg_thread(void *info);
  1547. void ubifs_commit_required(struct ubifs_info *c);
  1548. void ubifs_request_bg_commit(struct ubifs_info *c);
  1549. int ubifs_run_commit(struct ubifs_info *c);
  1550. void ubifs_recovery_commit(struct ubifs_info *c);
  1551. int ubifs_gc_should_commit(struct ubifs_info *c);
  1552. void ubifs_wait_for_commit(struct ubifs_info *c);
  1553. /* master.c */
  1554. int ubifs_read_master(struct ubifs_info *c);
  1555. int ubifs_write_master(struct ubifs_info *c);
  1556. /* sb.c */
  1557. int ubifs_read_superblock(struct ubifs_info *c);
  1558. struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c);
  1559. int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
  1560. int ubifs_fixup_free_space(struct ubifs_info *c);
  1561. int ubifs_enable_encryption(struct ubifs_info *c);
  1562. /* replay.c */
  1563. int ubifs_validate_entry(struct ubifs_info *c,
  1564. const struct ubifs_dent_node *dent);
  1565. int ubifs_replay_journal(struct ubifs_info *c);
  1566. /* gc.c */
  1567. int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
  1568. int ubifs_gc_start_commit(struct ubifs_info *c);
  1569. int ubifs_gc_end_commit(struct ubifs_info *c);
  1570. void ubifs_destroy_idx_gc(struct ubifs_info *c);
  1571. int ubifs_get_idx_gc_leb(struct ubifs_info *c);
  1572. int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
  1573. /* orphan.c */
  1574. int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
  1575. void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
  1576. int ubifs_orphan_start_commit(struct ubifs_info *c);
  1577. int ubifs_orphan_end_commit(struct ubifs_info *c);
  1578. int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
  1579. int ubifs_clear_orphans(struct ubifs_info *c);
  1580. /* lpt.c */
  1581. int ubifs_calc_lpt_geom(struct ubifs_info *c);
  1582. int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
  1583. int *lpt_lebs, int *big_lpt);
  1584. int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
  1585. struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
  1586. struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
  1587. int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
  1588. ubifs_lpt_scan_callback scan_cb, void *data);
  1589. /* Shared by lpt.c for lpt_commit.c */
  1590. void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
  1591. void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
  1592. struct ubifs_lpt_lprops *ltab);
  1593. void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
  1594. struct ubifs_pnode *pnode);
  1595. void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
  1596. struct ubifs_nnode *nnode);
  1597. struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
  1598. struct ubifs_nnode *parent, int iip);
  1599. struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
  1600. struct ubifs_nnode *parent, int iip);
  1601. int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
  1602. void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
  1603. void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
  1604. uint32_t ubifs_unpack_bits(const struct ubifs_info *c, uint8_t **addr, int *pos, int nrbits);
  1605. struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
  1606. /* Needed only in debugging code in lpt_commit.c */
  1607. int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
  1608. struct ubifs_nnode *nnode);
  1609. /* lpt_commit.c */
  1610. int ubifs_lpt_start_commit(struct ubifs_info *c);
  1611. int ubifs_lpt_end_commit(struct ubifs_info *c);
  1612. int ubifs_lpt_post_commit(struct ubifs_info *c);
  1613. void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
  1614. /* lprops.c */
  1615. const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
  1616. const struct ubifs_lprops *lp,
  1617. int free, int dirty, int flags,
  1618. int idx_gc_cnt);
  1619. void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
  1620. void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
  1621. int cat);
  1622. void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
  1623. struct ubifs_lprops *new_lprops);
  1624. void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
  1625. int ubifs_categorize_lprops(const struct ubifs_info *c,
  1626. const struct ubifs_lprops *lprops);
  1627. int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
  1628. int flags_set, int flags_clean, int idx_gc_cnt);
  1629. int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
  1630. int flags_set, int flags_clean);
  1631. int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
  1632. const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
  1633. const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
  1634. const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
  1635. const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
  1636. int ubifs_calc_dark(const struct ubifs_info *c, int spc);
  1637. /* file.c */
  1638. int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync);
  1639. int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
  1640. #ifdef CONFIG_UBIFS_ATIME_SUPPORT
  1641. int ubifs_update_time(struct inode *inode, struct timespec64 *time, int flags);
  1642. #endif
  1643. /* dir.c */
  1644. struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir,
  1645. umode_t mode);
  1646. int ubifs_getattr(const struct path *path, struct kstat *stat,
  1647. u32 request_mask, unsigned int flags);
  1648. int ubifs_check_dir_empty(struct inode *dir);
  1649. /* xattr.c */
  1650. extern const struct xattr_handler *ubifs_xattr_handlers[];
  1651. ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
  1652. int ubifs_xattr_set(struct inode *host, const char *name, const void *value,
  1653. size_t size, int flags, bool check_lock);
  1654. ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf,
  1655. size_t size);
  1656. #ifdef CONFIG_UBIFS_FS_XATTR
  1657. void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum);
  1658. #else
  1659. static inline void ubifs_evict_xattr_inode(struct ubifs_info *c,
  1660. ino_t xattr_inum) { }
  1661. #endif
  1662. #ifdef CONFIG_UBIFS_FS_SECURITY
  1663. extern int ubifs_init_security(struct inode *dentry, struct inode *inode,
  1664. const struct qstr *qstr);
  1665. #else
  1666. static inline int ubifs_init_security(struct inode *dentry,
  1667. struct inode *inode, const struct qstr *qstr)
  1668. {
  1669. return 0;
  1670. }
  1671. #endif
  1672. /* super.c */
  1673. struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
  1674. /* recovery.c */
  1675. int ubifs_recover_master_node(struct ubifs_info *c);
  1676. int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
  1677. struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
  1678. int offs, void *sbuf, int jhead);
  1679. struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
  1680. int offs, void *sbuf);
  1681. int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf);
  1682. int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf);
  1683. int ubifs_rcvry_gc_commit(struct ubifs_info *c);
  1684. int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
  1685. int deletion, loff_t new_size);
  1686. int ubifs_recover_size(struct ubifs_info *c);
  1687. void ubifs_destroy_size_tree(struct ubifs_info *c);
  1688. /* ioctl.c */
  1689. long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
  1690. void ubifs_set_inode_flags(struct inode *inode);
  1691. #ifdef CONFIG_COMPAT
  1692. long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
  1693. #endif
  1694. /* compressor.c */
  1695. int __init ubifs_compressors_init(void);
  1696. void ubifs_compressors_exit(void);
  1697. void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len,
  1698. void *out_buf, int *out_len, int *compr_type);
  1699. int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len,
  1700. void *out, int *out_len, int compr_type);
  1701. #include "debug.h"
  1702. #include "misc.h"
  1703. #include "key.h"
  1704. #ifndef CONFIG_UBIFS_FS_ENCRYPTION
  1705. static inline int ubifs_encrypt(const struct inode *inode,
  1706. struct ubifs_data_node *dn,
  1707. unsigned int in_len, unsigned int *out_len,
  1708. int block)
  1709. {
  1710. struct ubifs_info *c = inode->i_sb->s_fs_info;
  1711. ubifs_assert(c, 0);
  1712. return -EOPNOTSUPP;
  1713. }
  1714. static inline int ubifs_decrypt(const struct inode *inode,
  1715. struct ubifs_data_node *dn,
  1716. unsigned int *out_len, int block)
  1717. {
  1718. struct ubifs_info *c = inode->i_sb->s_fs_info;
  1719. ubifs_assert(c, 0);
  1720. return -EOPNOTSUPP;
  1721. }
  1722. #else
  1723. /* crypto.c */
  1724. int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn,
  1725. unsigned int in_len, unsigned int *out_len, int block);
  1726. int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn,
  1727. unsigned int *out_len, int block);
  1728. #endif
  1729. extern const struct fscrypt_operations ubifs_crypt_operations;
  1730. static inline bool ubifs_crypt_is_encrypted(const struct inode *inode)
  1731. {
  1732. const struct ubifs_inode *ui = ubifs_inode(inode);
  1733. return ui->flags & UBIFS_CRYPT_FL;
  1734. }
  1735. /* Normal UBIFS messages */
  1736. __printf(2, 3)
  1737. void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...);
  1738. __printf(2, 3)
  1739. void ubifs_err(const struct ubifs_info *c, const char *fmt, ...);
  1740. __printf(2, 3)
  1741. void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...);
  1742. /*
  1743. * A conditional variant of 'ubifs_err()' which doesn't output anything
  1744. * if probing (ie. SB_SILENT set).
  1745. */
  1746. #define ubifs_errc(c, fmt, ...) \
  1747. do { \
  1748. if (!(c)->probing) \
  1749. ubifs_err(c, fmt, ##__VA_ARGS__); \
  1750. } while (0)
  1751. #endif /* !__UBIFS_H__ */