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