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