projects/linux·blob master · refs

2163 lines · 72.2 KiB

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