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