~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/fs/ubifs/ubifs.h

Version: ~ [ linux-5.7-rc7 ] ~ [ linux-5.6.14 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.42 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.124 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.181 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.224 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.224 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.84 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp