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