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