2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Artem Bityutskiy (Битюцкий Артём)
26 #include <asm/div64.h>
27 #include <linux/statfs.h>
29 #include <linux/err.h>
30 #include <linux/sched.h>
31 #include <linux/slab.h>
32 #include <linux/vmalloc.h>
33 #include <linux/spinlock.h>
34 #include <linux/mutex.h>
35 #include <linux/rwsem.h>
36 #include <linux/mtd/ubi.h>
37 #include <linux/pagemap.h>
38 #include <linux/backing-dev.h>
39 #include <linux/security.h>
40 #include <linux/xattr.h>
41 #include <linux/random.h>
42 #include <crypto/hash_info.h>
43 #include <crypto/hash.h>
44 #include <crypto/algapi.h>
46 #define __FS_HAS_ENCRYPTION IS_ENABLED(CONFIG_UBIFS_FS_ENCRYPTION)
47 #include <linux/fscrypt.h>
49 #include "ubifs-media.h"
51 /* Version of this UBIFS implementation */
52 #define UBIFS_VERSION 1
54 /* UBIFS file system VFS magic number */
55 #define UBIFS_SUPER_MAGIC 0x24051905
57 /* Number of UBIFS blocks per VFS page */
58 #define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE)
59 #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT)
61 /* "File system end of life" sequence number watermark */
62 #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL
63 #define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL
66 * Minimum amount of LEBs reserved for the index. At present the index needs at
67 * least 2 LEBs: one for the index head and one for in-the-gaps method (which
68 * currently does not cater for the index head and so excludes it from
71 #define MIN_INDEX_LEBS 2
73 /* Minimum amount of data UBIFS writes to the flash */
74 #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
77 * Currently we do not support inode number overlapping and re-using, so this
78 * watermark defines dangerous inode number level. This should be fixed later,
79 * although it is difficult to exceed current limit. Another option is to use
80 * 64-bit inode numbers, but this means more overhead.
82 #define INUM_WARN_WATERMARK 0xFFF00000
83 #define INUM_WATERMARK 0xFFFFFF00
85 /* Maximum number of entries in each LPT (LEB category) heap */
86 #define LPT_HEAP_SZ 256
89 * Background thread name pattern. The numbers are UBI device and volume
92 #define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
94 /* Maximum possible inode number (only 32-bit inodes are supported now) */
95 #define MAX_INUM 0xFFFFFFFF
97 /* Number of non-data journal heads */
98 #define NONDATA_JHEADS_CNT 2
100 /* Shorter names for journal head numbers for internal usage */
101 #define GCHD UBIFS_GC_HEAD
102 #define BASEHD UBIFS_BASE_HEAD
103 #define DATAHD UBIFS_DATA_HEAD
105 /* 'No change' value for 'ubifs_change_lp()' */
106 #define LPROPS_NC 0x80000001
109 * There is no notion of truncation key because truncation nodes do not exist
110 * in TNC. However, when replaying, it is handy to introduce fake "truncation"
111 * keys for truncation nodes because the code becomes simpler. So we define
112 * %UBIFS_TRUN_KEY type.
114 * But otherwise, out of the journal reply scope, the truncation keys are
117 #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT
118 #define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT
121 * How much a directory entry/extended attribute entry adds to the parent/host
124 #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
126 /* How much an extended attribute adds to the host inode */
127 #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8)
130 * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered
131 * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are
132 * considered "young". This is used by shrinker when selecting znode to trim
135 #define OLD_ZNODE_AGE 20
136 #define YOUNG_ZNODE_AGE 5
139 * Some compressors, like LZO, may end up with more data then the input buffer.
140 * So UBIFS always allocates larger output buffer, to be sure the compressor
141 * will not corrupt memory in case of worst case compression.
143 #define WORST_COMPR_FACTOR 2
145 #ifdef CONFIG_UBIFS_FS_ENCRYPTION
146 #define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE
148 #define UBIFS_CIPHER_BLOCK_SIZE 0
152 * How much memory is needed for a buffer where we compress a data node.
154 #define COMPRESSED_DATA_NODE_BUF_SZ \
155 (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR)
157 /* Maximum expected tree height for use by bottom_up_buf */
158 #define BOTTOM_UP_HEIGHT 64
160 /* Maximum number of data nodes to bulk-read */
161 #define UBIFS_MAX_BULK_READ 32
163 #ifdef CONFIG_UBIFS_FS_AUTHENTICATION
164 #define UBIFS_HASH_ARR_SZ UBIFS_MAX_HASH_LEN
165 #define UBIFS_HMAC_ARR_SZ UBIFS_MAX_HMAC_LEN
167 #define UBIFS_HASH_ARR_SZ 0
168 #define UBIFS_HMAC_ARR_SZ 0
172 * Lockdep classes for UBIFS inode @ui_mutex.
182 * Znode flags (actually, bit numbers which store the flags).
184 * DIRTY_ZNODE: znode is dirty
185 * COW_ZNODE: znode is being committed and a new instance of this znode has to
186 * be created before changing this znode
187 * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is
188 * still in the commit list and the ongoing commit operation
189 * will commit it, and delete this znode after it is done
200 * COMMIT_RESTING: commit is not wanted
201 * COMMIT_BACKGROUND: background commit has been requested
202 * COMMIT_REQUIRED: commit is required
203 * COMMIT_RUNNING_BACKGROUND: background commit is running
204 * COMMIT_RUNNING_REQUIRED: commit is running and it is required
205 * COMMIT_BROKEN: commit failed
211 COMMIT_RUNNING_BACKGROUND,
212 COMMIT_RUNNING_REQUIRED,
217 * 'ubifs_scan_a_node()' return values.
219 * SCANNED_GARBAGE: scanned garbage
220 * SCANNED_EMPTY_SPACE: scanned empty space
221 * SCANNED_A_NODE: scanned a valid node
222 * SCANNED_A_CORRUPT_NODE: scanned a corrupted node
223 * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length
225 * Greater than zero means: 'scanned that number of padding bytes'
229 SCANNED_EMPTY_SPACE = -1,
231 SCANNED_A_CORRUPT_NODE = -3,
232 SCANNED_A_BAD_PAD_NODE = -4,
236 * LPT cnode flag bits.
238 * DIRTY_CNODE: cnode is dirty
239 * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted),
240 * so it can (and must) be freed when the commit is finished
241 * COW_CNODE: cnode is being committed and must be copied before writing
250 * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
252 * LTAB_DIRTY: ltab node is dirty
253 * LSAVE_DIRTY: lsave node is dirty
261 * Return codes used by the garbage collector.
262 * @LEB_FREED: the logical eraseblock was freed and is ready to use
263 * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit
264 * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes
273 * Action taken upon a failed ubifs_assert().
274 * @ASSACT_REPORT: just report the failed assertion
275 * @ASSACT_RO: switch to read-only mode
276 * @ASSACT_PANIC: call BUG() and possible panic the kernel
285 * struct ubifs_old_idx - index node obsoleted since last commit start.
287 * @lnum: LEB number of obsoleted index node
288 * @offs: offset of obsoleted index node
290 struct ubifs_old_idx {
296 /* The below union makes it easier to deal with keys */
298 uint8_t u8[UBIFS_SK_LEN];
299 uint32_t u32[UBIFS_SK_LEN/4];
300 uint64_t u64[UBIFS_SK_LEN/8];
301 __le32 j32[UBIFS_SK_LEN/4];
305 * struct ubifs_scan_node - UBIFS scanned node information.
306 * @list: list of scanned nodes
307 * @key: key of node scanned (if it has one)
308 * @sqnum: sequence number
309 * @type: type of node scanned
310 * @offs: offset with LEB of node scanned
311 * @len: length of node scanned
314 struct ubifs_scan_node {
315 struct list_head list;
317 unsigned long long sqnum;
325 * struct ubifs_scan_leb - UBIFS scanned LEB information.
326 * @lnum: logical eraseblock number
327 * @nodes_cnt: number of nodes scanned
328 * @nodes: list of struct ubifs_scan_node
329 * @endpt: end point (and therefore the start of empty space)
330 * @buf: buffer containing entire LEB scanned
332 struct ubifs_scan_leb {
335 struct list_head nodes;
341 * struct ubifs_gced_idx_leb - garbage-collected indexing LEB.
344 * @unmap: OK to unmap this LEB
346 * This data structure is used to temporary store garbage-collected indexing
347 * LEBs - they are not released immediately, but only after the next commit.
348 * This is needed to guarantee recoverability.
350 struct ubifs_gced_idx_leb {
351 struct list_head list;
357 * struct ubifs_inode - UBIFS in-memory inode description.
358 * @vfs_inode: VFS inode description object
359 * @creat_sqnum: sequence number at time of creation
360 * @del_cmtno: commit number corresponding to the time the inode was deleted,
361 * protected by @c->commit_sem;
362 * @xattr_size: summarized size of all extended attributes in bytes
363 * @xattr_cnt: count of extended attributes this inode has
364 * @xattr_names: sum of lengths of all extended attribute names belonging to
366 * @dirty: non-zero if the inode is dirty
367 * @xattr: non-zero if this is an extended attribute inode
368 * @bulk_read: non-zero if bulk-read should be used
369 * @ui_mutex: serializes inode write-back with the rest of VFS operations,
370 * serializes "clean <-> dirty" state changes, serializes bulk-read,
371 * protects @dirty, @bulk_read, @ui_size, and @xattr_size
372 * @ui_lock: protects @synced_i_size
373 * @synced_i_size: synchronized size of inode, i.e. the value of inode size
374 * currently stored on the flash; used only for regular file
376 * @ui_size: inode size used by UBIFS when writing to flash
377 * @flags: inode flags (@UBIFS_COMPR_FL, etc)
378 * @compr_type: default compression type used for this inode
379 * @last_page_read: page number of last page read (for bulk read)
380 * @read_in_a_row: number of consecutive pages read in a row (for bulk read)
381 * @data_len: length of the data attached to the inode
382 * @data: inode's data
384 * @ui_mutex exists for two main reasons. At first it prevents inodes from
385 * being written back while UBIFS changing them, being in the middle of an VFS
386 * operation. This way UBIFS makes sure the inode fields are consistent. For
387 * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and
388 * write-back must not write any of them before we have finished.
390 * The second reason is budgeting - UBIFS has to budget all operations. If an
391 * operation is going to mark an inode dirty, it has to allocate budget for
392 * this. It cannot just mark it dirty because there is no guarantee there will
393 * be enough flash space to write the inode back later. This means UBIFS has
394 * to have full control over inode "clean <-> dirty" transitions (and pages
395 * actually). But unfortunately, VFS marks inodes dirty in many places, and it
396 * does not ask the file-system if it is allowed to do so (there is a notifier,
397 * but it is not enough), i.e., there is no mechanism to synchronize with this.
398 * So UBIFS has its own inode dirty flag and its own mutex to serialize
399 * "clean <-> dirty" transitions.
401 * The @synced_i_size field is used to make sure we never write pages which are
402 * beyond last synchronized inode size. See 'ubifs_writepage()' for more
405 * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses
406 * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot
407 * make sure @inode->i_size is always changed under @ui_mutex, because it
408 * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would
409 * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields
410 * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one
411 * could consider to rework locking and base it on "shadow" fields.
414 struct inode vfs_inode;
415 unsigned long long creat_sqnum;
416 unsigned long long del_cmtno;
417 unsigned int xattr_size;
418 unsigned int xattr_cnt;
419 unsigned int xattr_names;
420 unsigned int dirty:1;
421 unsigned int xattr:1;
422 unsigned int bulk_read:1;
423 unsigned int compr_type:2;
424 struct mutex ui_mutex;
426 loff_t synced_i_size;
429 pgoff_t last_page_read;
430 pgoff_t read_in_a_row;
436 * struct ubifs_unclean_leb - records a LEB recovered under read-only mode.
438 * @lnum: LEB number of recovered LEB
439 * @endpt: offset where recovery ended
441 * This structure records a LEB identified during recovery that needs to be
442 * cleaned but was not because UBIFS was mounted read-only. The information
443 * is used to clean the LEB when remounting to read-write mode.
445 struct ubifs_unclean_leb {
446 struct list_head list;
452 * LEB properties flags.
454 * LPROPS_UNCAT: not categorized
455 * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
456 * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
457 * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
458 * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs
459 * LPROPS_EMPTY: LEB is empty, not taken
460 * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken
461 * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken
462 * LPROPS_CAT_MASK: mask for the LEB categories above
463 * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media)
464 * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash)
469 LPROPS_DIRTY_IDX = 2,
475 LPROPS_CAT_MASK = 15,
481 * struct ubifs_lprops - logical eraseblock properties.
482 * @free: amount of free space in bytes
483 * @dirty: amount of dirty space in bytes
484 * @flags: LEB properties flags (see above)
486 * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE)
487 * @hpos: heap position in heap of same-category lprops (other categories)
489 struct ubifs_lprops {
495 struct list_head list;
501 * struct ubifs_lpt_lprops - LPT logical eraseblock properties.
502 * @free: amount of free space in bytes
503 * @dirty: amount of dirty space in bytes
504 * @tgc: trivial GC flag (1 => unmap after commit end)
505 * @cmt: commit flag (1 => reserved for commit)
507 struct ubifs_lpt_lprops {
515 * struct ubifs_lp_stats - statistics of eraseblocks in the main area.
516 * @empty_lebs: number of empty LEBs
517 * @taken_empty_lebs: number of taken LEBs
518 * @idx_lebs: number of indexing LEBs
519 * @total_free: total free space in bytes (includes all LEBs)
520 * @total_dirty: total dirty space in bytes (includes all LEBs)
521 * @total_used: total used space in bytes (does not include index LEBs)
522 * @total_dead: total dead space in bytes (does not include index LEBs)
523 * @total_dark: total dark space in bytes (does not include index LEBs)
525 * The @taken_empty_lebs field counts the LEBs that are in the transient state
526 * of having been "taken" for use but not yet written to. @taken_empty_lebs is
527 * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be
528 * used by itself (in which case 'unused_lebs' would be a better name). In the
529 * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained
530 * by GC, but unlike other empty LEBs that are "taken", it may not be written
531 * straight away (i.e. before the next commit start or unmount), so either
532 * @gc_lnum must be specially accounted for, or the current approach followed
533 * i.e. count it under @taken_empty_lebs.
535 * @empty_lebs includes @taken_empty_lebs.
537 * @total_used, @total_dead and @total_dark fields do not account indexing
540 struct ubifs_lp_stats {
542 int taken_empty_lebs;
544 long long total_free;
545 long long total_dirty;
546 long long total_used;
547 long long total_dead;
548 long long total_dark;
554 * struct ubifs_cnode - LEB Properties Tree common node.
555 * @parent: parent nnode
556 * @cnext: next cnode to commit
557 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
558 * @iip: index in parent
559 * @level: level in the tree (zero for pnodes, greater than zero for nnodes)
563 struct ubifs_nnode *parent;
564 struct ubifs_cnode *cnext;
572 * struct ubifs_pnode - LEB Properties Tree leaf node.
573 * @parent: parent nnode
574 * @cnext: next cnode to commit
575 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
576 * @iip: index in parent
577 * @level: level in the tree (always zero for pnodes)
579 * @lprops: LEB properties array
582 struct ubifs_nnode *parent;
583 struct ubifs_cnode *cnext;
588 struct ubifs_lprops lprops[UBIFS_LPT_FANOUT];
592 * struct ubifs_nbranch - LEB Properties Tree internal node branch.
593 * @lnum: LEB number of child
594 * @offs: offset of child
595 * @nnode: nnode child
596 * @pnode: pnode child
597 * @cnode: cnode child
599 struct ubifs_nbranch {
603 struct ubifs_nnode *nnode;
604 struct ubifs_pnode *pnode;
605 struct ubifs_cnode *cnode;
610 * struct ubifs_nnode - LEB Properties Tree internal node.
611 * @parent: parent nnode
612 * @cnext: next cnode to commit
613 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
614 * @iip: index in parent
615 * @level: level in the tree (always greater than zero for nnodes)
617 * @nbranch: branches to child nodes
620 struct ubifs_nnode *parent;
621 struct ubifs_cnode *cnext;
626 struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT];
630 * struct ubifs_lpt_heap - heap of categorized lprops.
632 * @cnt: number in heap
633 * @max_cnt: maximum number allowed in heap
635 * There are %LPROPS_HEAP_CNT heaps.
637 struct ubifs_lpt_heap {
638 struct ubifs_lprops **arr;
644 * Return codes for LPT scan callback function.
646 * LPT_SCAN_CONTINUE: continue scanning
647 * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory
648 * LPT_SCAN_STOP: stop scanning
651 LPT_SCAN_CONTINUE = 0,
658 /* Callback used by the 'ubifs_lpt_scan_nolock()' function */
659 typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c,
660 const struct ubifs_lprops *lprops,
661 int in_tree, void *data);
664 * struct ubifs_wbuf - UBIFS write-buffer.
665 * @c: UBIFS file-system description object
666 * @buf: write-buffer (of min. flash I/O unit size)
667 * @lnum: logical eraseblock number the write-buffer points to
668 * @offs: write-buffer offset in this logical eraseblock
669 * @avail: number of bytes available in the write-buffer
670 * @used: number of used bytes in the write-buffer
671 * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range)
672 * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep
673 * up by 'mutex_lock_nested()).
674 * @sync_callback: write-buffer synchronization callback
675 * @io_mutex: serializes write-buffer I/O
676 * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes
678 * @timer: write-buffer timer
679 * @no_timer: non-zero if this write-buffer does not have a timer
680 * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing
681 * @next_ino: points to the next position of the following inode number
682 * @inodes: stores the inode numbers of the nodes which are in wbuf
684 * The write-buffer synchronization callback is called when the write-buffer is
685 * synchronized in order to notify how much space was wasted due to
686 * write-buffer padding and how much free space is left in the LEB.
688 * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under
689 * spin-lock or mutex because they are written under both mutex and spin-lock.
690 * @buf is appended to under mutex but overwritten under both mutex and
691 * spin-lock. Thus the data between @buf and @buf + @used can be read under
695 struct ubifs_info *c;
703 int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad);
704 struct mutex io_mutex;
706 struct hrtimer timer;
707 unsigned int no_timer:1;
708 unsigned int need_sync:1;
714 * struct ubifs_bud - bud logical eraseblock.
715 * @lnum: logical eraseblock number
716 * @start: where the (uncommitted) bud data starts
717 * @jhead: journal head number this bud belongs to
718 * @list: link in the list buds belonging to the same journal head
719 * @rb: link in the tree of all buds
720 * @log_hash: the log hash from the commit start node up to this bud
726 struct list_head list;
728 struct shash_desc *log_hash;
732 * struct ubifs_jhead - journal head.
733 * @wbuf: head's write-buffer
734 * @buds_list: list of bud LEBs belonging to this journal head
735 * @grouped: non-zero if UBIFS groups nodes when writing to this journal head
736 * @log_hash: the log hash from the commit start node up to this journal head
738 * Note, the @buds list is protected by the @c->buds_lock.
741 struct ubifs_wbuf wbuf;
742 struct list_head buds_list;
743 unsigned int grouped:1;
744 struct shash_desc *log_hash;
748 * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
750 * @znode: znode address in memory
751 * @lnum: LEB number of the target node (indexing node or data node)
752 * @offs: target node offset within @lnum
753 * @len: target node length
754 * @hash: the hash of the target node
756 struct ubifs_zbranch {
759 struct ubifs_znode *znode;
765 u8 hash[UBIFS_HASH_ARR_SZ];
769 * struct ubifs_znode - in-memory representation of an indexing node.
770 * @parent: parent znode or NULL if it is the root
771 * @cnext: next znode to commit
772 * @cparent: parent node for this commit
773 * @ciip: index in cparent's zbranch array
774 * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE)
775 * @time: last access time (seconds)
776 * @level: level of the entry in the TNC tree
777 * @child_cnt: count of child znodes
778 * @iip: index in parent's zbranch array
779 * @alt: lower bound of key range has altered i.e. child inserted at slot 0
780 * @lnum: LEB number of the corresponding indexing node
781 * @offs: offset of the corresponding indexing node
782 * @len: length of the corresponding indexing node
783 * @zbranch: array of znode branches (@c->fanout elements)
785 * Note! The @lnum, @offs, and @len fields are not really needed - we have them
786 * only for internal consistency check. They could be removed to save some RAM.
789 struct ubifs_znode *parent;
790 struct ubifs_znode *cnext;
791 struct ubifs_znode *cparent;
802 struct ubifs_zbranch zbranch[];
806 * struct bu_info - bulk-read information.
807 * @key: first data node key
808 * @zbranch: zbranches of data nodes to bulk read
809 * @buf: buffer to read into
810 * @buf_len: buffer length
811 * @gc_seq: GC sequence number to detect races with GC
812 * @cnt: number of data nodes for bulk read
813 * @blk_cnt: number of data blocks including holes
814 * @oef: end of file reached
818 struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ];
828 * struct ubifs_node_range - node length range description data structure.
829 * @len: fixed node length
830 * @min_len: minimum possible node length
831 * @max_len: maximum possible node length
833 * If @max_len is %0, the node has fixed length @len.
835 struct ubifs_node_range {
844 * struct ubifs_compressor - UBIFS compressor description structure.
845 * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc)
846 * @cc: cryptoapi compressor handle
847 * @comp_mutex: mutex used during compression
848 * @decomp_mutex: mutex used during decompression
849 * @name: compressor name
850 * @capi_name: cryptoapi compressor name
852 struct ubifs_compressor {
854 struct crypto_comp *cc;
855 struct mutex *comp_mutex;
856 struct mutex *decomp_mutex;
858 const char *capi_name;
862 * struct ubifs_budget_req - budget requirements of an operation.
864 * @fast: non-zero if the budgeting should try to acquire budget quickly and
865 * should not try to call write-back
866 * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields
867 * have to be re-calculated
868 * @new_page: non-zero if the operation adds a new page
869 * @dirtied_page: non-zero if the operation makes a page dirty
870 * @new_dent: non-zero if the operation adds a new directory entry
871 * @mod_dent: non-zero if the operation removes or modifies an existing
873 * @new_ino: non-zero if the operation adds a new inode
874 * @new_ino_d: how much data newly created inode contains
875 * @dirtied_ino: how many inodes the operation makes dirty
876 * @dirtied_ino_d: how much data dirtied inode contains
877 * @idx_growth: how much the index will supposedly grow
878 * @data_growth: how much new data the operation will supposedly add
879 * @dd_growth: how much data that makes other data dirty the operation will
882 * @idx_growth, @data_growth and @dd_growth are not used in budget request. The
883 * budgeting subsystem caches index and data growth values there to avoid
884 * re-calculating them when the budget is released. However, if @idx_growth is
885 * %-1, it is calculated by the release function using other fields.
887 * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d
888 * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made
889 * dirty by the re-name operation.
891 * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to
892 * make sure the amount of inode data which contribute to @new_ino_d and
893 * @dirtied_ino_d fields are aligned.
895 struct ubifs_budget_req {
897 unsigned int recalculate:1;
899 unsigned int new_page:1;
900 unsigned int dirtied_page:1;
901 unsigned int new_dent:1;
902 unsigned int mod_dent:1;
903 unsigned int new_ino:1;
904 unsigned int new_ino_d:13;
905 unsigned int dirtied_ino:4;
906 unsigned int dirtied_ino_d:15;
908 /* Not bit-fields to check for overflows */
909 unsigned int new_page;
910 unsigned int dirtied_page;
911 unsigned int new_dent;
912 unsigned int mod_dent;
913 unsigned int new_ino;
914 unsigned int new_ino_d;
915 unsigned int dirtied_ino;
916 unsigned int dirtied_ino_d;
924 * struct ubifs_orphan - stores the inode number of an orphan.
925 * @rb: rb-tree node of rb-tree of orphans sorted by inode number
926 * @list: list head of list of orphans in order added
927 * @new_list: list head of list of orphans added since the last commit
928 * @cnext: next orphan to commit
929 * @dnext: next orphan to delete
930 * @inum: inode number
931 * @new: %1 => added since the last commit, otherwise %0
932 * @cmt: %1 => commit pending, otherwise %0
933 * @del: %1 => delete pending, otherwise %0
935 struct ubifs_orphan {
937 struct list_head list;
938 struct list_head new_list;
939 struct ubifs_orphan *cnext;
940 struct ubifs_orphan *dnext;
948 * struct ubifs_mount_opts - UBIFS-specific mount options information.
949 * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
950 * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable)
951 * @chk_data_crc: enable/disable CRC data checking when reading data nodes
952 * (%0 default, %1 disable, %2 enable)
953 * @override_compr: override default compressor (%0 - do not override and use
954 * superblock compressor, %1 - override and use compressor
955 * specified in @compr_type)
956 * @compr_type: compressor type to override the superblock compressor with
957 * (%UBIFS_COMPR_NONE, etc)
959 struct ubifs_mount_opts {
960 unsigned int unmount_mode:2;
961 unsigned int bulk_read:2;
962 unsigned int chk_data_crc:2;
963 unsigned int override_compr:1;
964 unsigned int compr_type:2;
968 * struct ubifs_budg_info - UBIFS budgeting information.
969 * @idx_growth: amount of bytes budgeted for index growth
970 * @data_growth: amount of bytes budgeted for cached data
971 * @dd_growth: amount of bytes budgeted for cached data that will make
973 * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but
974 * which still have to be taken into account because the index
975 * has not been committed so far
976 * @old_idx_sz: size of index on flash
977 * @min_idx_lebs: minimum number of LEBs required for the index
978 * @nospace: non-zero if the file-system does not have flash space (used as
980 * @nospace_rp: the same as @nospace, but additionally means that even reserved
982 * @page_budget: budget for a page (constant, never changed after mount)
983 * @inode_budget: budget for an inode (constant, never changed after mount)
984 * @dent_budget: budget for a directory entry (constant, never changed after
987 struct ubifs_budg_info {
988 long long idx_growth;
989 long long data_growth;
991 long long uncommitted_idx;
992 unsigned long long old_idx_sz;
994 unsigned int nospace:1;
995 unsigned int nospace_rp:1;
1001 struct ubifs_debug_info;
1004 * struct ubifs_info - UBIFS file-system description data structure
1006 * @vfs_sb: VFS @struct super_block object
1007 * @sup_node: The super block node as read from the device
1009 * @highest_inum: highest used inode number
1010 * @max_sqnum: current global sequence number
1011 * @cmt_no: commit number of the last successfully completed commit, protected
1013 * @cnt_lock: protects @highest_inum and @max_sqnum counters
1014 * @fmt_version: UBIFS on-flash format version
1015 * @ro_compat_version: R/O compatibility version
1016 * @uuid: UUID from super block
1018 * @lhead_lnum: log head logical eraseblock number
1019 * @lhead_offs: log head offset
1020 * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
1021 * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
1023 * @min_log_bytes: minimum required number of bytes in the log
1024 * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
1027 * @buds: tree of all buds indexed by bud LEB number
1028 * @bud_bytes: how many bytes of flash is used by buds
1029 * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
1031 * @jhead_cnt: count of journal heads
1032 * @jheads: journal heads (head zero is base head)
1033 * @max_bud_bytes: maximum number of bytes allowed in buds
1034 * @bg_bud_bytes: number of bud bytes when background commit is initiated
1035 * @old_buds: buds to be released after commit ends
1036 * @max_bud_cnt: maximum number of buds
1038 * @commit_sem: synchronizes committer with other processes
1039 * @cmt_state: commit state
1040 * @cs_lock: commit state lock
1041 * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
1043 * @big_lpt: flag that LPT is too big to write whole during commit
1044 * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up
1045 * @double_hash: flag indicating that we can do lookups by hash
1046 * @encrypted: flag indicating that this file system contains encrypted files
1047 * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
1049 * @bulk_read: enable bulk-reads
1050 * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
1051 * @rw_incompat: the media is not R/W compatible
1052 * @assert_action: action to take when a ubifs_assert() fails
1053 * @authenticated: flag indigating the FS is mounted in authenticated mode
1055 * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
1057 * @zroot: zbranch which points to the root index node and znode
1058 * @cnext: next znode to commit
1059 * @enext: next znode to commit to empty space
1060 * @gap_lebs: array of LEBs used by the in-gaps commit method
1061 * @cbuf: commit buffer
1062 * @ileb_buf: buffer for commit in-the-gaps method
1063 * @ileb_len: length of data in ileb_buf
1064 * @ihead_lnum: LEB number of index head
1065 * @ihead_offs: offset of index head
1066 * @ilebs: pre-allocated index LEBs
1067 * @ileb_cnt: number of pre-allocated index LEBs
1068 * @ileb_nxt: next pre-allocated index LEBs
1069 * @old_idx: tree of index nodes obsoleted since the last commit start
1070 * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
1072 * @mst_node: master node
1073 * @mst_offs: offset of valid master node
1075 * @max_bu_buf_len: maximum bulk-read buffer length
1076 * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
1077 * @bu: pre-allocated bulk-read information
1079 * @write_reserve_mutex: protects @write_reserve_buf
1080 * @write_reserve_buf: on the write path we allocate memory, which might
1081 * sometimes be unavailable, in which case we use this
1082 * write reserve buffer
1084 * @log_lebs: number of logical eraseblocks in the log
1085 * @log_bytes: log size in bytes
1086 * @log_last: last LEB of the log
1087 * @lpt_lebs: number of LEBs used for lprops table
1088 * @lpt_first: first LEB of the lprops table area
1089 * @lpt_last: last LEB of the lprops table area
1090 * @orph_lebs: number of LEBs used for the orphan area
1091 * @orph_first: first LEB of the orphan area
1092 * @orph_last: last LEB of the orphan area
1093 * @main_lebs: count of LEBs in the main area
1094 * @main_first: first LEB of the main area
1095 * @main_bytes: main area size in bytes
1097 * @key_hash_type: type of the key hash
1098 * @key_hash: direntry key hash function
1099 * @key_fmt: key format
1100 * @key_len: key length
1101 * @hash_len: The length of the index node hashes
1102 * @fanout: fanout of the index tree (number of links per indexing node)
1104 * @min_io_size: minimal input/output unit size
1105 * @min_io_shift: number of bits in @min_io_size minus one
1106 * @max_write_size: maximum amount of bytes the underlying flash can write at a
1107 * time (MTD write buffer size)
1108 * @max_write_shift: number of bits in @max_write_size minus one
1109 * @leb_size: logical eraseblock size in bytes
1110 * @leb_start: starting offset of logical eraseblocks within physical
1112 * @half_leb_size: half LEB size
1113 * @idx_leb_size: how many bytes of an LEB are effectively available when it is
1114 * used to store indexing nodes (@leb_size - @max_idx_node_sz)
1115 * @leb_cnt: count of logical eraseblocks
1116 * @max_leb_cnt: maximum count of logical eraseblocks
1117 * @old_leb_cnt: count of logical eraseblocks before re-size
1118 * @ro_media: the underlying UBI volume is read-only
1119 * @ro_mount: the file-system was mounted as read-only
1120 * @ro_error: UBIFS switched to R/O mode because an error happened
1122 * @dirty_pg_cnt: number of dirty pages (not used)
1123 * @dirty_zn_cnt: number of dirty znodes
1124 * @clean_zn_cnt: number of clean znodes
1126 * @space_lock: protects @bi and @lst
1127 * @lst: lprops statistics
1128 * @bi: budgeting information
1129 * @calc_idx_sz: temporary variable which is used to calculate new index size
1130 * (contains accurate new index size at end of TNC commit start)
1132 * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
1134 * @mst_node_alsz: master node aligned size
1135 * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
1136 * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
1137 * @max_inode_sz: maximum possible inode size in bytes
1138 * @max_znode_sz: size of znode in bytes
1140 * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
1141 * data nodes of maximum size - used in free space reporting
1142 * @dead_wm: LEB dead space watermark
1143 * @dark_wm: LEB dark space watermark
1144 * @block_cnt: count of 4KiB blocks on the FS
1146 * @ranges: UBIFS node length ranges
1147 * @ubi: UBI volume descriptor
1148 * @di: UBI device information
1149 * @vi: UBI volume information
1151 * @orph_tree: rb-tree of orphan inode numbers
1152 * @orph_list: list of orphan inode numbers in order added
1153 * @orph_new: list of orphan inode numbers added since last commit
1154 * @orph_cnext: next orphan to commit
1155 * @orph_dnext: next orphan to delete
1156 * @orphan_lock: lock for orph_tree and orph_new
1157 * @orph_buf: buffer for orphan nodes
1158 * @new_orphans: number of orphans since last commit
1159 * @cmt_orphans: number of orphans being committed
1160 * @tot_orphans: number of orphans in the rb_tree
1161 * @max_orphans: maximum number of orphans allowed
1162 * @ohead_lnum: orphan head LEB number
1163 * @ohead_offs: orphan head offset
1164 * @no_orphs: non-zero if there are no orphans
1166 * @bgt: UBIFS background thread
1167 * @bgt_name: background thread name
1168 * @need_bgt: if background thread should run
1169 * @need_wbuf_sync: if write-buffers have to be synchronized
1171 * @gc_lnum: LEB number used for garbage collection
1172 * @sbuf: a buffer of LEB size used by GC and replay for scanning
1173 * @idx_gc: list of index LEBs that have been garbage collected
1174 * @idx_gc_cnt: number of elements on the idx_gc list
1175 * @gc_seq: incremented for every non-index LEB garbage collected
1176 * @gced_lnum: last non-index LEB that was garbage collected
1178 * @infos_list: links all 'ubifs_info' objects
1179 * @umount_mutex: serializes shrinker and un-mount
1180 * @shrinker_run_no: shrinker run number
1182 * @space_bits: number of bits needed to record free or dirty space
1183 * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
1184 * @lpt_offs_bits: number of bits needed to record an offset in the LPT
1185 * @lpt_spc_bits: number of bits needed to space in the LPT
1186 * @pcnt_bits: number of bits needed to record pnode or nnode number
1187 * @lnum_bits: number of bits needed to record LEB number
1188 * @nnode_sz: size of on-flash nnode
1189 * @pnode_sz: size of on-flash pnode
1190 * @ltab_sz: size of on-flash LPT lprops table
1191 * @lsave_sz: size of on-flash LPT save table
1192 * @pnode_cnt: number of pnodes
1193 * @nnode_cnt: number of nnodes
1194 * @lpt_hght: height of the LPT
1195 * @pnodes_have: number of pnodes in memory
1197 * @lp_mutex: protects lprops table and all the other lprops-related fields
1198 * @lpt_lnum: LEB number of the root nnode of the LPT
1199 * @lpt_offs: offset of the root nnode of the LPT
1200 * @nhead_lnum: LEB number of LPT head
1201 * @nhead_offs: offset of LPT head
1202 * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
1203 * @dirty_nn_cnt: number of dirty nnodes
1204 * @dirty_pn_cnt: number of dirty pnodes
1205 * @check_lpt_free: flag that indicates LPT GC may be needed
1207 * @lpt_nod_buf: buffer for an on-flash nnode or pnode
1208 * @lpt_buf: buffer of LEB size used by LPT
1209 * @nroot: address in memory of the root nnode of the LPT
1210 * @lpt_cnext: next LPT node to commit
1211 * @lpt_heap: array of heaps of categorized lprops
1212 * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
1213 * previous commit start
1214 * @uncat_list: list of un-categorized LEBs
1215 * @empty_list: list of empty LEBs
1216 * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size)
1217 * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size)
1218 * @freeable_cnt: number of freeable LEBs in @freeable_list
1219 * @in_a_category_cnt: count of lprops which are in a certain category, which
1220 * basically meants that they were loaded from the flash
1222 * @ltab_lnum: LEB number of LPT's own lprops table
1223 * @ltab_offs: offset of LPT's own lprops table
1224 * @ltab: LPT's own lprops table
1225 * @ltab_cmt: LPT's own lprops table (commit copy)
1226 * @lsave_cnt: number of LEB numbers in LPT's save table
1227 * @lsave_lnum: LEB number of LPT's save table
1228 * @lsave_offs: offset of LPT's save table
1229 * @lsave: LPT's save table
1230 * @lscan_lnum: LEB number of last LPT scan
1232 * @rp_size: size of the reserved pool in bytes
1233 * @report_rp_size: size of the reserved pool reported to user-space
1234 * @rp_uid: reserved pool user ID
1235 * @rp_gid: reserved pool group ID
1237 * @hash_tfm: the hash transformation used for hashing nodes
1238 * @hmac_tfm: the HMAC transformation for this filesystem
1239 * @hmac_desc_len: length of the HMAC used for authentication
1240 * @auth_key_name: the authentication key name
1241 * @auth_hash_name: the name of the hash algorithm used for authentication
1242 * @auth_hash_algo: the authentication hash used for this fs
1243 * @log_hash: the log hash from the commit start node up to the latest reference
1246 * @empty: %1 if the UBI device is empty
1247 * @need_recovery: %1 if the file-system needs recovery
1248 * @replaying: %1 during journal replay
1249 * @mounting: %1 while mounting
1250 * @probing: %1 while attempting to mount if SB_SILENT mount flag is set
1251 * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode
1252 * @replay_list: temporary list used during journal replay
1253 * @replay_buds: list of buds to replay
1254 * @cs_sqnum: sequence number of first node in the log (commit start node)
1255 * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W
1257 * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted
1259 * @size_tree: inode size information for recovery
1260 * @mount_opts: UBIFS-specific mount options
1262 * @dbg: debugging-related information
1265 struct super_block *vfs_sb;
1266 struct ubifs_sb_node *sup_node;
1269 unsigned long long max_sqnum;
1270 unsigned long long cmt_no;
1271 spinlock_t cnt_lock;
1273 int ro_compat_version;
1274 unsigned char uuid[16];
1279 struct mutex log_mutex;
1281 long long cmt_bud_bytes;
1283 struct rb_root buds;
1284 long long bud_bytes;
1285 spinlock_t buds_lock;
1287 struct ubifs_jhead *jheads;
1288 long long max_bud_bytes;
1289 long long bg_bud_bytes;
1290 struct list_head old_buds;
1293 struct rw_semaphore commit_sem;
1296 wait_queue_head_t cmt_wq;
1298 unsigned int big_lpt:1;
1299 unsigned int space_fixup:1;
1300 unsigned int double_hash:1;
1301 unsigned int encrypted:1;
1302 unsigned int no_chk_data_crc:1;
1303 unsigned int bulk_read:1;
1304 unsigned int default_compr:2;
1305 unsigned int rw_incompat:1;
1306 unsigned int assert_action:2;
1307 unsigned int authenticated:1;
1309 struct mutex tnc_mutex;
1310 struct ubifs_zbranch zroot;
1311 struct ubifs_znode *cnext;
1312 struct ubifs_znode *enext;
1322 struct rb_root old_idx;
1325 struct ubifs_mst_node *mst_node;
1329 struct mutex bu_mutex;
1332 struct mutex write_reserve_mutex;
1333 void *write_reserve_buf;
1336 long long log_bytes;
1346 long long main_bytes;
1348 uint8_t key_hash_type;
1349 uint32_t (*key_hash)(const char *str, int len);
1358 int max_write_shift;
1366 unsigned int ro_media:1;
1367 unsigned int ro_mount:1;
1368 unsigned int ro_error:1;
1370 atomic_long_t dirty_pg_cnt;
1371 atomic_long_t dirty_zn_cnt;
1372 atomic_long_t clean_zn_cnt;
1374 spinlock_t space_lock;
1375 struct ubifs_lp_stats lst;
1376 struct ubifs_budg_info bi;
1377 unsigned long long calc_idx_sz;
1381 int min_idx_node_sz;
1382 int max_idx_node_sz;
1383 long long max_inode_sz;
1391 struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
1392 struct ubi_volume_desc *ubi;
1393 struct ubi_device_info di;
1394 struct ubi_volume_info vi;
1396 struct rb_root orph_tree;
1397 struct list_head orph_list;
1398 struct list_head orph_new;
1399 struct ubifs_orphan *orph_cnext;
1400 struct ubifs_orphan *orph_dnext;
1401 spinlock_t orphan_lock;
1411 struct task_struct *bgt;
1412 char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
1418 struct list_head idx_gc;
1423 struct list_head infos_list;
1424 struct mutex umount_mutex;
1425 unsigned int shrinker_run_no;
1442 struct mutex lp_mutex;
1454 struct ubifs_nnode *nroot;
1455 struct ubifs_cnode *lpt_cnext;
1456 struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
1457 struct ubifs_lpt_heap dirty_idx;
1458 struct list_head uncat_list;
1459 struct list_head empty_list;
1460 struct list_head freeable_list;
1461 struct list_head frdi_idx_list;
1463 int in_a_category_cnt;
1467 struct ubifs_lpt_lprops *ltab;
1468 struct ubifs_lpt_lprops *ltab_cmt;
1476 long long report_rp_size;
1480 struct crypto_shash *hash_tfm;
1481 struct crypto_shash *hmac_tfm;
1483 char *auth_key_name;
1484 char *auth_hash_name;
1485 enum hash_algo auth_hash_algo;
1487 struct shash_desc *log_hash;
1489 /* The below fields are used only during mounting and re-mounting */
1490 unsigned int empty:1;
1491 unsigned int need_recovery:1;
1492 unsigned int replaying:1;
1493 unsigned int mounting:1;
1494 unsigned int remounting_rw:1;
1495 unsigned int probing:1;
1496 struct list_head replay_list;
1497 struct list_head replay_buds;
1498 unsigned long long cs_sqnum;
1499 struct list_head unclean_leb_list;
1500 struct ubifs_mst_node *rcvrd_mst_node;
1501 struct rb_root size_tree;
1502 struct ubifs_mount_opts mount_opts;
1504 struct ubifs_debug_info *dbg;
1507 extern struct list_head ubifs_infos;
1508 extern spinlock_t ubifs_infos_lock;
1509 extern atomic_long_t ubifs_clean_zn_cnt;
1510 extern const struct super_operations ubifs_super_operations;
1511 extern const struct address_space_operations ubifs_file_address_operations;
1512 extern const struct file_operations ubifs_file_operations;
1513 extern const struct inode_operations ubifs_file_inode_operations;
1514 extern const struct file_operations ubifs_dir_operations;
1515 extern const struct inode_operations ubifs_dir_inode_operations;
1516 extern const struct inode_operations ubifs_symlink_inode_operations;
1517 extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
1520 static inline int ubifs_authenticated(const struct ubifs_info *c)
1522 return (IS_ENABLED(CONFIG_UBIFS_FS_AUTHENTICATION)) && c->authenticated;
1525 struct shash_desc *__ubifs_hash_get_desc(const struct ubifs_info *c);
1526 static inline struct shash_desc *ubifs_hash_get_desc(const struct ubifs_info *c)
1528 return ubifs_authenticated(c) ? __ubifs_hash_get_desc(c) : NULL;
1531 static inline int ubifs_shash_init(const struct ubifs_info *c,
1532 struct shash_desc *desc)
1534 if (ubifs_authenticated(c))
1535 return crypto_shash_init(desc);
1540 static inline int ubifs_shash_update(const struct ubifs_info *c,
1541 struct shash_desc *desc, const void *buf,
1546 if (ubifs_authenticated(c)) {
1547 err = crypto_shash_update(desc, buf, len);
1555 static inline int ubifs_shash_final(const struct ubifs_info *c,
1556 struct shash_desc *desc, u8 *out)
1558 return ubifs_authenticated(c) ? crypto_shash_final(desc, out) : 0;
1561 int __ubifs_node_calc_hash(const struct ubifs_info *c, const void *buf,
1563 static inline int ubifs_node_calc_hash(const struct ubifs_info *c,
1564 const void *buf, u8 *hash)
1566 if (ubifs_authenticated(c))
1567 return __ubifs_node_calc_hash(c, buf, hash);
1572 int ubifs_prepare_auth_node(struct ubifs_info *c, void *node,
1573 struct shash_desc *inhash);
1576 * ubifs_check_hash - compare two hashes
1577 * @c: UBIFS file-system description object
1578 * @expected: first hash
1581 * Compare two hashes @expected and @got. Returns 0 when they are equal, a
1582 * negative error code otherwise.
1584 static inline int ubifs_check_hash(const struct ubifs_info *c,
1585 const u8 *expected, const u8 *got)
1587 return crypto_memneq(expected, got, c->hash_len);
1591 * ubifs_check_hmac - compare two HMACs
1592 * @c: UBIFS file-system description object
1593 * @expected: first HMAC
1596 * Compare two hashes @expected and @got. Returns 0 when they are equal, a
1597 * negative error code otherwise.
1599 static inline int ubifs_check_hmac(const struct ubifs_info *c,
1600 const u8 *expected, const u8 *got)
1602 return crypto_memneq(expected, got, c->hmac_desc_len);
1605 void ubifs_bad_hash(const struct ubifs_info *c, const void *node,
1606 const u8 *hash, int lnum, int offs);
1608 int __ubifs_node_check_hash(const struct ubifs_info *c, const void *buf,
1609 const u8 *expected);
1610 static inline int ubifs_node_check_hash(const struct ubifs_info *c,
1611 const void *buf, const u8 *expected)
1613 if (ubifs_authenticated(c))
1614 return __ubifs_node_check_hash(c, buf, expected);
1619 int ubifs_init_authentication(struct ubifs_info *c);
1620 void __ubifs_exit_authentication(struct ubifs_info *c);
1621 static inline void ubifs_exit_authentication(struct ubifs_info *c)
1623 if (ubifs_authenticated(c))
1624 __ubifs_exit_authentication(c);
1628 * ubifs_branch_hash - returns a pointer to the hash of a branch
1629 * @c: UBIFS file-system description object
1630 * @br: branch to get the hash from
1632 * This returns a pointer to the hash of a branch. Since the key already is a
1633 * dynamically sized object we cannot use a struct member here.
1635 static inline u8 *ubifs_branch_hash(struct ubifs_info *c,
1636 struct ubifs_branch *br)
1638 return (void *)br + sizeof(*br) + c->key_len;
1642 * ubifs_copy_hash - copy a hash
1643 * @c: UBIFS file-system description object
1644 * @from: source hash
1645 * @to: destination hash
1647 * With authentication this copies a hash, otherwise does nothing.
1649 static inline void ubifs_copy_hash(const struct ubifs_info *c, const u8 *from,
1652 if (ubifs_authenticated(c))
1653 memcpy(to, from, c->hash_len);
1656 int __ubifs_node_insert_hmac(const struct ubifs_info *c, void *buf,
1657 int len, int ofs_hmac);
1658 static inline int ubifs_node_insert_hmac(const struct ubifs_info *c, void *buf,
1659 int len, int ofs_hmac)
1661 if (ubifs_authenticated(c))
1662 return __ubifs_node_insert_hmac(c, buf, len, ofs_hmac);
1667 int __ubifs_node_verify_hmac(const struct ubifs_info *c, const void *buf,
1668 int len, int ofs_hmac);
1669 static inline int ubifs_node_verify_hmac(const struct ubifs_info *c,
1670 const void *buf, int len, int ofs_hmac)
1672 if (ubifs_authenticated(c))
1673 return __ubifs_node_verify_hmac(c, buf, len, ofs_hmac);
1679 * ubifs_auth_node_sz - returns the size of an authentication node
1680 * @c: UBIFS file-system description object
1682 * This function returns the size of an authentication node which can
1683 * be 0 for unauthenticated filesystems or the real size of an auth node
1684 * authentication is enabled.
1686 static inline int ubifs_auth_node_sz(const struct ubifs_info *c)
1688 if (ubifs_authenticated(c))
1689 return sizeof(struct ubifs_auth_node) + c->hmac_desc_len;
1694 int ubifs_hmac_wkm(struct ubifs_info *c, u8 *hmac);
1696 int __ubifs_shash_copy_state(const struct ubifs_info *c, struct shash_desc *src,
1697 struct shash_desc *target);
1698 static inline int ubifs_shash_copy_state(const struct ubifs_info *c,
1699 struct shash_desc *src,
1700 struct shash_desc *target)
1702 if (ubifs_authenticated(c))
1703 return __ubifs_shash_copy_state(c, src, target);
1709 void ubifs_ro_mode(struct ubifs_info *c, int err);
1710 int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs,
1711 int len, int even_ebadmsg);
1712 int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
1714 int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
1715 int ubifs_leb_unmap(struct ubifs_info *c, int lnum);
1716 int ubifs_leb_map(struct ubifs_info *c, int lnum);
1717 int ubifs_is_mapped(const struct ubifs_info *c, int lnum);
1718 int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
1719 int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs);
1720 int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
1721 int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
1722 int lnum, int offs);
1723 int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
1724 int lnum, int offs);
1725 int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
1727 int ubifs_write_node_hmac(struct ubifs_info *c, void *buf, int len, int lnum,
1728 int offs, int hmac_offs);
1729 int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
1730 int offs, int quiet, int must_chk_crc);
1731 void ubifs_init_node(struct ubifs_info *c, void *buf, int len, int pad);
1732 void ubifs_crc_node(struct ubifs_info *c, void *buf, int len);
1733 void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
1734 int ubifs_prepare_node_hmac(struct ubifs_info *c, void *node, int len,
1735 int hmac_offs, int pad);
1736 void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
1737 int ubifs_io_init(struct ubifs_info *c);
1738 void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
1739 int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
1740 int ubifs_bg_wbufs_sync(struct ubifs_info *c);
1741 void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
1742 int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
1745 struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
1746 int offs, void *sbuf, int quiet);
1747 void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
1748 int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
1749 int offs, int quiet);
1750 struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
1751 int offs, void *sbuf);
1752 void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1753 int lnum, int offs);
1754 int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1755 void *buf, int offs);
1756 void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
1760 void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
1761 void ubifs_create_buds_lists(struct ubifs_info *c);
1762 int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
1763 struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
1764 struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
1765 int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
1766 int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
1767 int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
1768 int ubifs_consolidate_log(struct ubifs_info *c);
1771 int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
1772 const struct fscrypt_name *nm, const struct inode *inode,
1773 int deletion, int xent);
1774 int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
1775 const union ubifs_key *key, const void *buf, int len);
1776 int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
1777 int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
1778 int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,
1779 const struct inode *fst_inode,
1780 const struct fscrypt_name *fst_nm,
1781 const struct inode *snd_dir,
1782 const struct inode *snd_inode,
1783 const struct fscrypt_name *snd_nm, int sync);
1784 int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
1785 const struct inode *old_inode,
1786 const struct fscrypt_name *old_nm,
1787 const struct inode *new_dir,
1788 const struct inode *new_inode,
1789 const struct fscrypt_name *new_nm,
1790 const struct inode *whiteout, int sync);
1791 int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
1792 loff_t old_size, loff_t new_size);
1793 int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
1794 const struct inode *inode, const struct fscrypt_name *nm);
1795 int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
1796 const struct inode *inode2);
1799 int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
1800 void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
1801 void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
1802 struct ubifs_inode *ui);
1803 int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
1804 struct ubifs_budget_req *req);
1805 void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
1806 struct ubifs_budget_req *req);
1807 void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
1808 struct ubifs_budget_req *req);
1809 long long ubifs_get_free_space(struct ubifs_info *c);
1810 long long ubifs_get_free_space_nolock(struct ubifs_info *c);
1811 int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
1812 void ubifs_convert_page_budget(struct ubifs_info *c);
1813 long long ubifs_reported_space(const struct ubifs_info *c, long long free);
1814 long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
1817 int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
1819 int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
1820 int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
1821 int min_space, int pick_free);
1822 int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
1823 int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
1826 int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
1827 struct ubifs_znode **zn, int *n);
1828 int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
1829 void *node, const struct fscrypt_name *nm);
1830 int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key,
1831 void *node, uint32_t secondary_hash);
1832 int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
1833 void *node, int *lnum, int *offs);
1834 int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
1835 int offs, int len, const u8 *hash);
1836 int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
1837 int old_lnum, int old_offs, int lnum, int offs, int len);
1838 int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
1839 int lnum, int offs, int len, const u8 *hash,
1840 const struct fscrypt_name *nm);
1841 int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
1842 int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
1843 const struct fscrypt_name *nm);
1844 int ubifs_tnc_remove_dh(struct ubifs_info *c, const union ubifs_key *key,
1846 int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
1847 union ubifs_key *to_key);
1848 int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
1849 struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
1850 union ubifs_key *key,
1851 const struct fscrypt_name *nm);
1852 void ubifs_tnc_close(struct ubifs_info *c);
1853 int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
1854 int lnum, int offs, int is_idx);
1855 int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
1856 int lnum, int offs);
1857 /* Shared by tnc.c for tnc_commit.c */
1858 void destroy_old_idx(struct ubifs_info *c);
1859 int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
1860 int lnum, int offs);
1861 int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
1862 int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
1863 int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
1866 struct ubifs_znode *ubifs_tnc_levelorder_next(const struct ubifs_info *c,
1867 struct ubifs_znode *zr,
1868 struct ubifs_znode *znode);
1869 int ubifs_search_zbranch(const struct ubifs_info *c,
1870 const struct ubifs_znode *znode,
1871 const union ubifs_key *key, int *n);
1872 struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
1873 struct ubifs_znode *ubifs_tnc_postorder_next(const struct ubifs_info *c,
1874 struct ubifs_znode *znode);
1875 long ubifs_destroy_tnc_subtree(const struct ubifs_info *c,
1876 struct ubifs_znode *zr);
1877 struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
1878 struct ubifs_zbranch *zbr,
1879 struct ubifs_znode *parent, int iip);
1880 int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
1884 int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
1885 int ubifs_tnc_end_commit(struct ubifs_info *c);
1888 unsigned long ubifs_shrink_scan(struct shrinker *shrink,
1889 struct shrink_control *sc);
1890 unsigned long ubifs_shrink_count(struct shrinker *shrink,
1891 struct shrink_control *sc);
1894 int ubifs_bg_thread(void *info);
1895 void ubifs_commit_required(struct ubifs_info *c);
1896 void ubifs_request_bg_commit(struct ubifs_info *c);
1897 int ubifs_run_commit(struct ubifs_info *c);
1898 void ubifs_recovery_commit(struct ubifs_info *c);
1899 int ubifs_gc_should_commit(struct ubifs_info *c);
1900 void ubifs_wait_for_commit(struct ubifs_info *c);
1903 int ubifs_compare_master_node(struct ubifs_info *c, void *m1, void *m2);
1904 int ubifs_read_master(struct ubifs_info *c);
1905 int ubifs_write_master(struct ubifs_info *c);
1908 int ubifs_read_superblock(struct ubifs_info *c);
1909 int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
1910 int ubifs_fixup_free_space(struct ubifs_info *c);
1911 int ubifs_enable_encryption(struct ubifs_info *c);
1914 int ubifs_validate_entry(struct ubifs_info *c,
1915 const struct ubifs_dent_node *dent);
1916 int ubifs_replay_journal(struct ubifs_info *c);
1919 int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
1920 int ubifs_gc_start_commit(struct ubifs_info *c);
1921 int ubifs_gc_end_commit(struct ubifs_info *c);
1922 void ubifs_destroy_idx_gc(struct ubifs_info *c);
1923 int ubifs_get_idx_gc_leb(struct ubifs_info *c);
1924 int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
1927 int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
1928 void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
1929 int ubifs_orphan_start_commit(struct ubifs_info *c);
1930 int ubifs_orphan_end_commit(struct ubifs_info *c);
1931 int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
1932 int ubifs_clear_orphans(struct ubifs_info *c);
1935 int ubifs_calc_lpt_geom(struct ubifs_info *c);
1936 int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
1937 int *lpt_lebs, int *big_lpt, u8 *hash);
1938 int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
1939 struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
1940 struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
1941 int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
1942 ubifs_lpt_scan_callback scan_cb, void *data);
1944 /* Shared by lpt.c for lpt_commit.c */
1945 void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
1946 void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
1947 struct ubifs_lpt_lprops *ltab);
1948 void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
1949 struct ubifs_pnode *pnode);
1950 void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
1951 struct ubifs_nnode *nnode);
1952 struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
1953 struct ubifs_nnode *parent, int iip);
1954 struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
1955 struct ubifs_nnode *parent, int iip);
1956 struct ubifs_pnode *ubifs_pnode_lookup(struct ubifs_info *c, int i);
1957 int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
1958 void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
1959 void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
1960 uint32_t ubifs_unpack_bits(const struct ubifs_info *c, uint8_t **addr, int *pos, int nrbits);
1961 struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
1962 /* Needed only in debugging code in lpt_commit.c */
1963 int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
1964 struct ubifs_nnode *nnode);
1965 int ubifs_lpt_calc_hash(struct ubifs_info *c, u8 *hash);
1968 int ubifs_lpt_start_commit(struct ubifs_info *c);
1969 int ubifs_lpt_end_commit(struct ubifs_info *c);
1970 int ubifs_lpt_post_commit(struct ubifs_info *c);
1971 void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
1974 const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
1975 const struct ubifs_lprops *lp,
1976 int free, int dirty, int flags,
1978 void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
1979 void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
1981 void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
1982 struct ubifs_lprops *new_lprops);
1983 void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
1984 int ubifs_categorize_lprops(const struct ubifs_info *c,
1985 const struct ubifs_lprops *lprops);
1986 int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1987 int flags_set, int flags_clean, int idx_gc_cnt);
1988 int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1989 int flags_set, int flags_clean);
1990 int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
1991 const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
1992 const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
1993 const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
1994 const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
1995 int ubifs_calc_dark(const struct ubifs_info *c, int spc);
1998 int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync);
1999 int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
2000 #ifdef CONFIG_UBIFS_ATIME_SUPPORT
2001 int ubifs_update_time(struct inode *inode, struct timespec64 *time, int flags);
2005 struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir,
2007 int ubifs_getattr(const struct path *path, struct kstat *stat,
2008 u32 request_mask, unsigned int flags);
2009 int ubifs_check_dir_empty(struct inode *dir);
2012 extern const struct xattr_handler *ubifs_xattr_handlers[];
2013 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
2014 int ubifs_xattr_set(struct inode *host, const char *name, const void *value,
2015 size_t size, int flags, bool check_lock);
2016 ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf,
2019 #ifdef CONFIG_UBIFS_FS_XATTR
2020 void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum);
2022 static inline void ubifs_evict_xattr_inode(struct ubifs_info *c,
2023 ino_t xattr_inum) { }
2026 #ifdef CONFIG_UBIFS_FS_SECURITY
2027 extern int ubifs_init_security(struct inode *dentry, struct inode *inode,
2028 const struct qstr *qstr);
2030 static inline int ubifs_init_security(struct inode *dentry,
2031 struct inode *inode, const struct qstr *qstr)
2039 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
2042 int ubifs_recover_master_node(struct ubifs_info *c);
2043 int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
2044 struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
2045 int offs, void *sbuf, int jhead);
2046 struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
2047 int offs, void *sbuf);
2048 int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf);
2049 int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf);
2050 int ubifs_rcvry_gc_commit(struct ubifs_info *c);
2051 int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
2052 int deletion, loff_t new_size);
2053 int ubifs_recover_size(struct ubifs_info *c, bool in_place);
2054 void ubifs_destroy_size_tree(struct ubifs_info *c);
2057 long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
2058 void ubifs_set_inode_flags(struct inode *inode);
2059 #ifdef CONFIG_COMPAT
2060 long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
2064 int __init ubifs_compressors_init(void);
2065 void ubifs_compressors_exit(void);
2066 void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len,
2067 void *out_buf, int *out_len, int *compr_type);
2068 int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len,
2069 void *out, int *out_len, int compr_type);
2075 #ifndef CONFIG_UBIFS_FS_ENCRYPTION
2076 static inline int ubifs_encrypt(const struct inode *inode,
2077 struct ubifs_data_node *dn,
2078 unsigned int in_len, unsigned int *out_len,
2081 struct ubifs_info *c = inode->i_sb->s_fs_info;
2085 static inline int ubifs_decrypt(const struct inode *inode,
2086 struct ubifs_data_node *dn,
2087 unsigned int *out_len, int block)
2089 struct ubifs_info *c = inode->i_sb->s_fs_info;
2095 int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn,
2096 unsigned int in_len, unsigned int *out_len, int block);
2097 int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn,
2098 unsigned int *out_len, int block);
2101 extern const struct fscrypt_operations ubifs_crypt_operations;
2103 static inline bool ubifs_crypt_is_encrypted(const struct inode *inode)
2105 const struct ubifs_inode *ui = ubifs_inode(inode);
2107 return ui->flags & UBIFS_CRYPT_FL;
2110 /* Normal UBIFS messages */
2112 void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...);
2114 void ubifs_err(const struct ubifs_info *c, const char *fmt, ...);
2116 void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...);
2118 * A conditional variant of 'ubifs_err()' which doesn't output anything
2119 * if probing (ie. SB_SILENT set).
2121 #define ubifs_errc(c, fmt, ...) \
2123 if (!(c)->probing) \
2124 ubifs_err(c, fmt, ##__VA_ARGS__); \
2127 #endif /* !__UBIFS_H__ */