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