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