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