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