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