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