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