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

source code of linux/fs/ubifs/ubifs.h