blob: 0a8341e1408842263ae409611002db8aa604b044 [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
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +020066/*
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).
71 */
72#define MIN_INDEX_LEBS 2
73
Artem Bityutskiy1e517642008-07-14 19:08:37 +030074/* Minimum amount of data UBIFS writes to the flash */
75#define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
76
77/*
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.
82 */
83#define INUM_WARN_WATERMARK 0xFFF00000
84#define INUM_WATERMARK 0xFFFFFF00
85
86/* Largest key size supported in this implementation */
87#define CUR_MAX_KEY_LEN UBIFS_SK_LEN
88
89/* Maximum number of entries in each LPT (LEB category) heap */
90#define LPT_HEAP_SZ 256
91
92/*
93 * Background thread name pattern. The numbers are UBI device and volume
94 * numbers.
95 */
96#define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
97
98/* Default write-buffer synchronization timeout (5 secs) */
99#define DEFAULT_WBUF_TIMEOUT (5 * HZ)
100
101/* Maximum possible inode number (only 32-bit inodes are supported now) */
102#define MAX_INUM 0xFFFFFFFF
103
104/* Number of non-data journal heads */
105#define NONDATA_JHEADS_CNT 2
106
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
113
114/* 'No change' value for 'ubifs_change_lp()' */
115#define LPROPS_NC 0x80000001
116
117/*
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.
122 */
123#define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT
124
125/*
126 * How much a directory entry/extended attribute entry adds to the parent/host
127 * inode.
128 */
129#define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
130
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)
133
134/*
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.
139 */
140#define OLD_ZNODE_AGE 20
141#define YOUNG_ZNODE_AGE 5
142
143/*
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.
147 */
148#define WORST_COMPR_FACTOR 2
149
150/* Maximum expected tree height for use by bottom_up_buf */
151#define BOTTOM_UP_HEIGHT 64
152
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300153/* Maximum number of data nodes to bulk-read */
154#define UBIFS_MAX_BULK_READ 32
155
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300156/*
157 * Lockdep classes for UBIFS inode @ui_mutex.
158 */
159enum {
160 WB_MUTEX_1 = 0,
161 WB_MUTEX_2 = 1,
162 WB_MUTEX_3 = 2,
163};
164
165/*
166 * Znode flags (actually, bit numbers which store the flags).
167 *
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
174 */
175enum {
176 DIRTY_ZNODE = 0,
177 COW_ZNODE = 1,
178 OBSOLETE_ZNODE = 2,
179};
180
181/*
182 * Commit states.
183 *
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
190 */
191enum {
192 COMMIT_RESTING = 0,
193 COMMIT_BACKGROUND,
194 COMMIT_REQUIRED,
195 COMMIT_RUNNING_BACKGROUND,
196 COMMIT_RUNNING_REQUIRED,
197 COMMIT_BROKEN,
198};
199
200/*
201 * 'ubifs_scan_a_node()' return values.
202 *
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
208 *
209 * Greater than zero means: 'scanned that number of padding bytes'
210 */
211enum {
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,
217};
218
219/*
220 * LPT cnode flag bits.
221 *
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
226 */
227enum {
228 DIRTY_CNODE = 0,
229 COW_CNODE = 1,
230 OBSOLETE_CNODE = 2,
231};
232
233/*
234 * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
235 *
236 * LTAB_DIRTY: ltab node is dirty
237 * LSAVE_DIRTY: lsave node is dirty
238 */
239enum {
240 LTAB_DIRTY = 1,
241 LSAVE_DIRTY = 2,
242};
243
244/*
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
249 */
250enum {
251 LEB_FREED,
252 LEB_FREED_IDX,
253 LEB_RETAINED,
254};
255
256/**
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
261 */
262struct ubifs_old_idx {
263 struct rb_node rb;
264 int lnum;
265 int offs;
266};
267
268/* The below union makes it easier to deal with keys */
269union 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];
274};
275
276/**
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
285 */
286struct 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;
294};
295
296/**
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
304 */
305struct ubifs_scan_leb {
306 int lnum;
307 int nodes_cnt;
308 struct list_head nodes;
309 int endpt;
310 int ecc;
311 void *buf;
312};
313
314/**
315 * struct ubifs_gced_idx_leb - garbage-collected indexing LEB.
316 * @list: list
317 * @lnum: LEB number
318 * @unmap: OK to unmap this LEB
319 *
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.
323 */
324struct ubifs_gced_idx_leb {
325 struct list_head list;
326 int lnum;
327 int unmap;
328};
329
330/**
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
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300334 * @del_cmtno: commit number corresponding to the time the inode was deleted,
335 * protected by @c->commit_sem;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300336 * @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
Artem Bityutskiy625bf372008-09-08 16:13:38 +0300342 * @bulk_read: non-zero if bulk-read should be used
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300343 * @ui_mutex: serializes inode write-back with the rest of VFS operations,
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300344 * serializes "clean <-> dirty" state changes, serializes bulk-read,
Artem Bityutskiyba60eca2008-09-08 16:38:01 +0300345 * protects @dirty, @bulk_read, @ui_size, and @xattr_size
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300346 * @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
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300353 * @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)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300355 * @data_len: length of the data attached to the inode
356 * @data: inode's data
357 *
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.
363 *
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.
374 *
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.
378 *
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.
386 */
387struct ubifs_inode {
388 struct inode vfs_inode;
Adrian Hunterbc8133552008-07-23 15:23:11 +0300389 unsigned long long creat_sqnum;
390 unsigned long long del_cmtno;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300391 unsigned int xattr_size;
392 unsigned int xattr_cnt;
393 unsigned int xattr_names;
394 unsigned int dirty:1;
395 unsigned int xattr:1;
Artem Bityutskiy625bf372008-09-08 16:13:38 +0300396 unsigned int bulk_read:1;
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +0200397 unsigned int compr_type:2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300398 struct mutex ui_mutex;
399 spinlock_t ui_lock;
400 loff_t synced_i_size;
401 loff_t ui_size;
402 int flags;
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300403 pgoff_t last_page_read;
404 pgoff_t read_in_a_row;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300405 int data_len;
406 void *data;
407};
408
409/**
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
414 *
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.
418 */
419struct ubifs_unclean_leb {
420 struct list_head list;
421 int lnum;
422 int endpt;
423};
424
425/*
426 * LEB properties flags.
427 *
428 * LPROPS_UNCAT: not categorized
Artem Bityutskiy70782022009-01-19 19:57:27 +0200429 * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
Artem Bityutskiy21a60252008-12-12 11:13:17 -0500430 * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
Artem Bityutskiy70782022009-01-19 19:57:27 +0200431 * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300432 * 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)
439 */
440enum {
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,
452};
453
454/**
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)
462 */
463struct ubifs_lprops {
464 int free;
465 int dirty;
466 int flags;
467 int lnum;
468 union {
469 struct list_head list;
470 int hpos;
471 };
472};
473
474/**
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)
480 */
481struct ubifs_lpt_lprops {
482 int free;
483 int dirty;
Artem Bityutskiyf92b9822008-12-28 11:34:26 +0200484 unsigned tgc:1;
485 unsigned cmt:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300486};
487
488/**
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
Artem Bityutskiyd3cf5022008-12-16 17:52:35 +0200493 * @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)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300498 *
Artem Bityutskiyd3cf5022008-12-16 17:52:35 +0200499 * 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.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300508 *
Artem Bityutskiyd3cf5022008-12-16 17:52:35 +0200509 * @empty_lebs includes @taken_empty_lebs.
510 *
511 * @total_used, @total_dead and @total_dark fields do not account indexing
512 * LEBs.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300513 */
514struct 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;
523};
524
525struct ubifs_nnode;
526
527/**
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
535 */
536struct 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;
543};
544
545/**
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
554 */
555struct 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];
563};
564
565/**
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
572 */
573struct 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;
580 };
581};
582
583/**
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
592 */
593struct 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];
601};
602
603/**
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
608 *
609 * There are %LPROPS_HEAP_CNT heaps.
610 */
611struct ubifs_lpt_heap {
612 struct ubifs_lprops **arr;
613 int cnt;
614 int max_cnt;
615};
616
617/*
618 * Return codes for LPT scan callback function.
619 *
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
623 */
624enum {
625 LPT_SCAN_CONTINUE = 0,
626 LPT_SCAN_ADD = 1,
627 LPT_SCAN_STOP = 2,
628};
629
630struct ubifs_info;
631
632/* Callback used by the 'ubifs_lpt_scan_nolock()' function */
633typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c,
634 const struct ubifs_lprops *lprops,
635 int in_tree, void *data);
636
637/**
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
658 *
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.
662 *
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.
668 */
669struct 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;
686};
687
688/**
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
695 */
696struct ubifs_bud {
697 int lnum;
698 int start;
699 int jhead;
700 struct list_head list;
701 struct rb_node rb;
702};
703
704/**
705 * struct ubifs_jhead - journal head.
706 * @wbuf: head's write-buffer
707 * @buds_list: list of bud LEBs belonging to this journal head
708 *
709 * Note, the @buds list is protected by the @c->buds_lock.
710 */
711struct ubifs_jhead {
712 struct ubifs_wbuf wbuf;
713 struct list_head buds_list;
714};
715
716/**
717 * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
718 * @key: key
719 * @znode: znode address in memory
Artem Bityutskiybe616782008-09-08 18:08:39 +0300720 * @lnum: LEB number of the target node (indexing node or data node)
721 * @offs: target node offset within @lnum
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300722 * @len: target node length
723 */
724struct ubifs_zbranch {
725 union ubifs_key key;
726 union {
727 struct ubifs_znode *znode;
728 void *leaf;
729 };
730 int lnum;
731 int offs;
732 int len;
733};
734
735/**
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)
749 */
750struct 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[];
763};
764
765/**
Artem Bityutskiy39ce81c2008-11-18 18:09:49 +0200766 * struct bu_info - bulk-read information.
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300767 * @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
775 */
776struct 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;
785};
786
787/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300788 * 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
792 *
793 * If @max_len is %0, the node has fixed length @len.
794 */
795struct ubifs_node_range {
796 union {
797 int len;
798 int min_len;
799 };
800 int max_len;
801};
802
803/**
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
811 */
812struct 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;
819};
820
821/**
822 * struct ubifs_budget_req - budget requirements of an operation.
823 *
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300824 * @fast: non-zero if the budgeting should try to acquire budget quickly and
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300825 * 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
841 *
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.
846 *
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.
Artem Bityutskiydab4b4d2008-07-24 14:52:45 +0300850 *
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.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300854 */
855struct ubifs_budget_req {
856 unsigned int fast:1;
857 unsigned int recalculate:1;
Artem Bityutskiy547000d2008-07-24 14:42:05 +0300858#ifndef UBIFS_DEBUG
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300859 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;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300865 unsigned int dirtied_ino:4;
866 unsigned int dirtied_ino_d:15;
867#else
868 /* Not bit-fields to check for overflows */
Artem Bityutskiy547000d2008-07-24 14:42:05 +0300869 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;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300875 unsigned int dirtied_ino;
876 unsigned int dirtied_ino_d;
877#endif
878 int idx_growth;
879 int data_growth;
880 int dd_growth;
881};
882
883/**
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
892 */
893struct 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;
901};
902
903/**
904 * struct ubifs_mount_opts - UBIFS-specific mount options information.
905 * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200906 * @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)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300914 */
915struct ubifs_mount_opts {
916 unsigned int unmount_mode:2;
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300917 unsigned int bulk_read:2;
Adrian Hunter2953e732008-09-04 16:26:00 +0300918 unsigned int chk_data_crc:2;
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200919 unsigned int override_compr:1;
920 unsigned int compr_type:2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300921};
922
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +0300923struct ubifs_debug_info;
924
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300925/**
926 * struct ubifs_info - UBIFS file-system description data structure
927 * (per-superblock).
928 * @vfs_sb: VFS @struct super_block object
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300929 * @bdi: backing device info object to make VFS happy and disable read-ahead
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300930 *
931 * @highest_inum: highest used inode number
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300932 * @max_sqnum: current global sequence number
Artem Bityutskiy014eb042008-07-21 17:14:29 +0300933 * @cmt_no: commit number of the last successfully completed commit, protected
934 * by @commit_sem
Adrian Hunter81ffa382008-08-01 15:35:08 +0300935 * @cnt_lock: protects @highest_inum and @max_sqnum counters
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300936 * @fmt_version: UBIFS on-flash format version
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +0200937 * @ro_compat_version: R/O compatibility version
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300938 * @uuid: UUID from super block
939 *
940 * @lhead_lnum: log head logical eraseblock number
941 * @lhead_offs: log head offset
942 * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
943 * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
944 * @bud_bytes
945 * @min_log_bytes: minimum required number of bytes in the log
946 * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
947 * committed buds
948 *
949 * @buds: tree of all buds indexed by bud LEB number
950 * @bud_bytes: how many bytes of flash is used by buds
951 * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
952 * lists
953 * @jhead_cnt: count of journal heads
954 * @jheads: journal heads (head zero is base head)
955 * @max_bud_bytes: maximum number of bytes allowed in buds
956 * @bg_bud_bytes: number of bud bytes when background commit is initiated
957 * @old_buds: buds to be released after commit ends
958 * @max_bud_cnt: maximum number of buds
959 *
960 * @commit_sem: synchronizes committer with other processes
961 * @cmt_state: commit state
962 * @cs_lock: commit state lock
963 * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
Artem Bityutskiy625bf372008-09-08 16:13:38 +0300964 *
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300965 * @big_lpt: flag that LPT is too big to write whole during commit
Artem Bityutskiy625bf372008-09-08 16:13:38 +0300966 * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
967 * recovery)
968 * @bulk_read: enable bulk-reads
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +0200969 * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +0200970 * @rw_incompat: the media is not R/W compatible
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300971 *
972 * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
973 * @calc_idx_sz
974 * @zroot: zbranch which points to the root index node and znode
975 * @cnext: next znode to commit
976 * @enext: next znode to commit to empty space
977 * @gap_lebs: array of LEBs used by the in-gaps commit method
978 * @cbuf: commit buffer
979 * @ileb_buf: buffer for commit in-the-gaps method
980 * @ileb_len: length of data in ileb_buf
981 * @ihead_lnum: LEB number of index head
982 * @ihead_offs: offset of index head
983 * @ilebs: pre-allocated index LEBs
984 * @ileb_cnt: number of pre-allocated index LEBs
985 * @ileb_nxt: next pre-allocated index LEBs
986 * @old_idx: tree of index nodes obsoleted since the last commit start
987 * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300988 *
989 * @mst_node: master node
990 * @mst_offs: offset of valid master node
991 * @mst_mutex: protects the master node area, @mst_node, and @mst_offs
Artem Bityutskiy3477d202008-11-19 11:53:15 +0200992 *
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +0200993 * @max_bu_buf_len: maximum bulk-read buffer length
Artem Bityutskiy3477d202008-11-19 11:53:15 +0200994 * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
995 * @bu: pre-allocated bulk-read information
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300996 *
997 * @log_lebs: number of logical eraseblocks in the log
998 * @log_bytes: log size in bytes
999 * @log_last: last LEB of the log
1000 * @lpt_lebs: number of LEBs used for lprops table
1001 * @lpt_first: first LEB of the lprops table area
1002 * @lpt_last: last LEB of the lprops table area
1003 * @orph_lebs: number of LEBs used for the orphan area
1004 * @orph_first: first LEB of the orphan area
1005 * @orph_last: last LEB of the orphan area
1006 * @main_lebs: count of LEBs in the main area
1007 * @main_first: first LEB of the main area
1008 * @main_bytes: main area size in bytes
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001009 *
1010 * @key_hash_type: type of the key hash
1011 * @key_hash: direntry key hash function
1012 * @key_fmt: key format
1013 * @key_len: key length
1014 * @fanout: fanout of the index tree (number of links per indexing node)
1015 *
1016 * @min_io_size: minimal input/output unit size
1017 * @min_io_shift: number of bits in @min_io_size minus one
1018 * @leb_size: logical eraseblock size in bytes
1019 * @half_leb_size: half LEB size
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +02001020 * @idx_leb_size: how many bytes of an LEB are effectively available when it is
1021 * used to store indexing nodes (@leb_size - @max_idx_node_sz)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001022 * @leb_cnt: count of logical eraseblocks
1023 * @max_leb_cnt: maximum count of logical eraseblocks
1024 * @old_leb_cnt: count of logical eraseblocks before re-size
1025 * @ro_media: the underlying UBI volume is read-only
1026 *
1027 * @dirty_pg_cnt: number of dirty pages (not used)
1028 * @dirty_zn_cnt: number of dirty znodes
1029 * @clean_zn_cnt: number of clean znodes
1030 *
1031 * @budg_idx_growth: amount of bytes budgeted for index growth
1032 * @budg_data_growth: amount of bytes budgeted for cached data
1033 * @budg_dd_growth: amount of bytes budgeted for cached data that will make
1034 * other data dirty
1035 * @budg_uncommitted_idx: amount of bytes were budgeted for growth of the index,
1036 * but which still have to be taken into account because
1037 * the index has not been committed so far
1038 * @space_lock: protects @budg_idx_growth, @budg_data_growth, @budg_dd_growth,
Artem Bityutskiyba60eca2008-09-08 16:38:01 +03001039 * @budg_uncommited_idx, @min_idx_lebs, @old_idx_sz, @lst,
1040 * @nospace, and @nospace_rp;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001041 * @min_idx_lebs: minimum number of LEBs required for the index
1042 * @old_idx_sz: size of index on flash
1043 * @calc_idx_sz: temporary variable which is used to calculate new index size
1044 * (contains accurate new index size at end of TNC commit start)
1045 * @lst: lprops statistics
Artem Bityutskiyba60eca2008-09-08 16:38:01 +03001046 * @nospace: non-zero if the file-system does not have flash space (used as
1047 * optimization)
1048 * @nospace_rp: the same as @nospace, but additionally means that even reserved
1049 * pool is full
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001050 *
1051 * @page_budget: budget for a page
1052 * @inode_budget: budget for an inode
1053 * @dent_budget: budget for a directory entry
1054 *
1055 * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
1056 * I/O unit
1057 * @mst_node_alsz: master node aligned size
1058 * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
1059 * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
1060 * @max_inode_sz: maximum possible inode size in bytes
1061 * @max_znode_sz: size of znode in bytes
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +03001062 *
1063 * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
1064 * data nodes of maximum size - used in free space reporting
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001065 * @dead_wm: LEB dead space watermark
1066 * @dark_wm: LEB dark space watermark
1067 * @block_cnt: count of 4KiB blocks on the FS
1068 *
1069 * @ranges: UBIFS node length ranges
1070 * @ubi: UBI volume descriptor
1071 * @di: UBI device information
1072 * @vi: UBI volume information
1073 *
1074 * @orph_tree: rb-tree of orphan inode numbers
1075 * @orph_list: list of orphan inode numbers in order added
1076 * @orph_new: list of orphan inode numbers added since last commit
1077 * @orph_cnext: next orphan to commit
1078 * @orph_dnext: next orphan to delete
1079 * @orphan_lock: lock for orph_tree and orph_new
1080 * @orph_buf: buffer for orphan nodes
1081 * @new_orphans: number of orphans since last commit
1082 * @cmt_orphans: number of orphans being committed
1083 * @tot_orphans: number of orphans in the rb_tree
1084 * @max_orphans: maximum number of orphans allowed
1085 * @ohead_lnum: orphan head LEB number
1086 * @ohead_offs: orphan head offset
1087 * @no_orphs: non-zero if there are no orphans
1088 *
1089 * @bgt: UBIFS background thread
1090 * @bgt_name: background thread name
1091 * @need_bgt: if background thread should run
1092 * @need_wbuf_sync: if write-buffers have to be synchronized
1093 *
1094 * @gc_lnum: LEB number used for garbage collection
1095 * @sbuf: a buffer of LEB size used by GC and replay for scanning
1096 * @idx_gc: list of index LEBs that have been garbage collected
1097 * @idx_gc_cnt: number of elements on the idx_gc list
Adrian Hunter601c0bc2008-08-22 14:23:35 +03001098 * @gc_seq: incremented for every non-index LEB garbage collected
1099 * @gced_lnum: last non-index LEB that was garbage collected
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001100 *
1101 * @infos_list: links all 'ubifs_info' objects
1102 * @umount_mutex: serializes shrinker and un-mount
1103 * @shrinker_run_no: shrinker run number
1104 *
1105 * @space_bits: number of bits needed to record free or dirty space
1106 * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
1107 * @lpt_offs_bits: number of bits needed to record an offset in the LPT
1108 * @lpt_spc_bits: number of bits needed to space in the LPT
1109 * @pcnt_bits: number of bits needed to record pnode or nnode number
1110 * @lnum_bits: number of bits needed to record LEB number
1111 * @nnode_sz: size of on-flash nnode
1112 * @pnode_sz: size of on-flash pnode
1113 * @ltab_sz: size of on-flash LPT lprops table
1114 * @lsave_sz: size of on-flash LPT save table
1115 * @pnode_cnt: number of pnodes
1116 * @nnode_cnt: number of nnodes
1117 * @lpt_hght: height of the LPT
1118 * @pnodes_have: number of pnodes in memory
1119 *
1120 * @lp_mutex: protects lprops table and all the other lprops-related fields
1121 * @lpt_lnum: LEB number of the root nnode of the LPT
1122 * @lpt_offs: offset of the root nnode of the LPT
1123 * @nhead_lnum: LEB number of LPT head
1124 * @nhead_offs: offset of LPT head
1125 * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
1126 * @dirty_nn_cnt: number of dirty nnodes
1127 * @dirty_pn_cnt: number of dirty pnodes
Adrian Hunter73944a62008-09-12 18:13:31 +03001128 * @check_lpt_free: flag that indicates LPT GC may be needed
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001129 * @lpt_sz: LPT size
1130 * @lpt_nod_buf: buffer for an on-flash nnode or pnode
1131 * @lpt_buf: buffer of LEB size used by LPT
1132 * @nroot: address in memory of the root nnode of the LPT
1133 * @lpt_cnext: next LPT node to commit
1134 * @lpt_heap: array of heaps of categorized lprops
1135 * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
1136 * previous commit start
1137 * @uncat_list: list of un-categorized LEBs
1138 * @empty_list: list of empty LEBs
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +02001139 * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size)
1140 * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001141 * @freeable_cnt: number of freeable LEBs in @freeable_list
1142 *
1143 * @ltab_lnum: LEB number of LPT's own lprops table
1144 * @ltab_offs: offset of LPT's own lprops table
1145 * @ltab: LPT's own lprops table
1146 * @ltab_cmt: LPT's own lprops table (commit copy)
1147 * @lsave_cnt: number of LEB numbers in LPT's save table
1148 * @lsave_lnum: LEB number of LPT's save table
1149 * @lsave_offs: offset of LPT's save table
1150 * @lsave: LPT's save table
1151 * @lscan_lnum: LEB number of last LPT scan
1152 *
1153 * @rp_size: size of the reserved pool in bytes
1154 * @report_rp_size: size of the reserved pool reported to user-space
1155 * @rp_uid: reserved pool user ID
1156 * @rp_gid: reserved pool group ID
1157 *
1158 * @empty: if the UBI device is empty
1159 * @replay_tree: temporary tree used during journal replay
1160 * @replay_list: temporary list used during journal replay
1161 * @replay_buds: list of buds to replay
1162 * @cs_sqnum: sequence number of first node in the log (commit start node)
1163 * @replay_sqnum: sequence number of node currently being replayed
1164 * @need_recovery: file-system needs recovery
1165 * @replaying: set to %1 during journal replay
1166 * @unclean_leb_list: LEBs to recover when mounting ro to rw
1167 * @rcvrd_mst_node: recovered master node to write when mounting ro to rw
1168 * @size_tree: inode size information for recovery
1169 * @remounting_rw: set while remounting from ro to rw (sb flags have MS_RDONLY)
Adrian Hunter2953e732008-09-04 16:26:00 +03001170 * @always_chk_crc: always check CRCs (while mounting and remounting rw)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001171 * @mount_opts: UBIFS-specific mount options
1172 *
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001173 * @dbg: debugging-related information
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001174 */
1175struct ubifs_info {
1176 struct super_block *vfs_sb;
1177 struct backing_dev_info bdi;
1178
1179 ino_t highest_inum;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001180 unsigned long long max_sqnum;
1181 unsigned long long cmt_no;
1182 spinlock_t cnt_lock;
1183 int fmt_version;
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001184 int ro_compat_version;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001185 unsigned char uuid[16];
1186
1187 int lhead_lnum;
1188 int lhead_offs;
1189 int ltail_lnum;
1190 struct mutex log_mutex;
1191 int min_log_bytes;
1192 long long cmt_bud_bytes;
1193
1194 struct rb_root buds;
1195 long long bud_bytes;
1196 spinlock_t buds_lock;
1197 int jhead_cnt;
1198 struct ubifs_jhead *jheads;
1199 long long max_bud_bytes;
1200 long long bg_bud_bytes;
1201 struct list_head old_buds;
1202 int max_bud_cnt;
1203
1204 struct rw_semaphore commit_sem;
1205 int cmt_state;
1206 spinlock_t cs_lock;
1207 wait_queue_head_t cmt_wq;
Artem Bityutskiy625bf372008-09-08 16:13:38 +03001208
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001209 unsigned int big_lpt:1;
Artem Bityutskiy625bf372008-09-08 16:13:38 +03001210 unsigned int no_chk_data_crc:1;
1211 unsigned int bulk_read:1;
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02001212 unsigned int default_compr:2;
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001213 unsigned int rw_incompat:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001214
1215 struct mutex tnc_mutex;
1216 struct ubifs_zbranch zroot;
1217 struct ubifs_znode *cnext;
1218 struct ubifs_znode *enext;
1219 int *gap_lebs;
1220 void *cbuf;
1221 void *ileb_buf;
1222 int ileb_len;
1223 int ihead_lnum;
1224 int ihead_offs;
1225 int *ilebs;
1226 int ileb_cnt;
1227 int ileb_nxt;
1228 struct rb_root old_idx;
1229 int *bottom_up_buf;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001230
1231 struct ubifs_mst_node *mst_node;
1232 int mst_offs;
1233 struct mutex mst_mutex;
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001234
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +02001235 int max_bu_buf_len;
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001236 struct mutex bu_mutex;
1237 struct bu_info bu;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001238
1239 int log_lebs;
1240 long long log_bytes;
1241 int log_last;
1242 int lpt_lebs;
1243 int lpt_first;
1244 int lpt_last;
1245 int orph_lebs;
1246 int orph_first;
1247 int orph_last;
1248 int main_lebs;
1249 int main_first;
1250 long long main_bytes;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001251
1252 uint8_t key_hash_type;
1253 uint32_t (*key_hash)(const char *str, int len);
1254 int key_fmt;
1255 int key_len;
1256 int fanout;
1257
1258 int min_io_size;
1259 int min_io_shift;
1260 int leb_size;
1261 int half_leb_size;
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +02001262 int idx_leb_size;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001263 int leb_cnt;
1264 int max_leb_cnt;
1265 int old_leb_cnt;
1266 int ro_media;
1267
1268 atomic_long_t dirty_pg_cnt;
1269 atomic_long_t dirty_zn_cnt;
1270 atomic_long_t clean_zn_cnt;
1271
1272 long long budg_idx_growth;
1273 long long budg_data_growth;
1274 long long budg_dd_growth;
1275 long long budg_uncommitted_idx;
1276 spinlock_t space_lock;
1277 int min_idx_lebs;
1278 unsigned long long old_idx_sz;
1279 unsigned long long calc_idx_sz;
1280 struct ubifs_lp_stats lst;
Artem Bityutskiyba60eca2008-09-08 16:38:01 +03001281 unsigned int nospace:1;
1282 unsigned int nospace_rp:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001283
1284 int page_budget;
1285 int inode_budget;
1286 int dent_budget;
1287
1288 int ref_node_alsz;
1289 int mst_node_alsz;
1290 int min_idx_node_sz;
1291 int max_idx_node_sz;
1292 long long max_inode_sz;
1293 int max_znode_sz;
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +03001294
1295 int leb_overhead;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001296 int dead_wm;
1297 int dark_wm;
1298 int block_cnt;
1299
1300 struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
1301 struct ubi_volume_desc *ubi;
1302 struct ubi_device_info di;
1303 struct ubi_volume_info vi;
1304
1305 struct rb_root orph_tree;
1306 struct list_head orph_list;
1307 struct list_head orph_new;
1308 struct ubifs_orphan *orph_cnext;
1309 struct ubifs_orphan *orph_dnext;
1310 spinlock_t orphan_lock;
1311 void *orph_buf;
1312 int new_orphans;
1313 int cmt_orphans;
1314 int tot_orphans;
1315 int max_orphans;
1316 int ohead_lnum;
1317 int ohead_offs;
1318 int no_orphs;
1319
1320 struct task_struct *bgt;
1321 char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
1322 int need_bgt;
1323 int need_wbuf_sync;
1324
1325 int gc_lnum;
1326 void *sbuf;
1327 struct list_head idx_gc;
1328 int idx_gc_cnt;
Artem Bityutskiyf92b9822008-12-28 11:34:26 +02001329 int gc_seq;
1330 int gced_lnum;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001331
1332 struct list_head infos_list;
1333 struct mutex umount_mutex;
1334 unsigned int shrinker_run_no;
1335
1336 int space_bits;
1337 int lpt_lnum_bits;
1338 int lpt_offs_bits;
1339 int lpt_spc_bits;
1340 int pcnt_bits;
1341 int lnum_bits;
1342 int nnode_sz;
1343 int pnode_sz;
1344 int ltab_sz;
1345 int lsave_sz;
1346 int pnode_cnt;
1347 int nnode_cnt;
1348 int lpt_hght;
1349 int pnodes_have;
1350
1351 struct mutex lp_mutex;
1352 int lpt_lnum;
1353 int lpt_offs;
1354 int nhead_lnum;
1355 int nhead_offs;
1356 int lpt_drty_flgs;
1357 int dirty_nn_cnt;
1358 int dirty_pn_cnt;
Adrian Hunter73944a62008-09-12 18:13:31 +03001359 int check_lpt_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001360 long long lpt_sz;
1361 void *lpt_nod_buf;
1362 void *lpt_buf;
1363 struct ubifs_nnode *nroot;
1364 struct ubifs_cnode *lpt_cnext;
1365 struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
1366 struct ubifs_lpt_heap dirty_idx;
1367 struct list_head uncat_list;
1368 struct list_head empty_list;
1369 struct list_head freeable_list;
1370 struct list_head frdi_idx_list;
1371 int freeable_cnt;
1372
1373 int ltab_lnum;
1374 int ltab_offs;
1375 struct ubifs_lpt_lprops *ltab;
1376 struct ubifs_lpt_lprops *ltab_cmt;
1377 int lsave_cnt;
1378 int lsave_lnum;
1379 int lsave_offs;
1380 int *lsave;
1381 int lscan_lnum;
1382
1383 long long rp_size;
1384 long long report_rp_size;
1385 uid_t rp_uid;
1386 gid_t rp_gid;
1387
1388 /* The below fields are used only during mounting and re-mounting */
1389 int empty;
1390 struct rb_root replay_tree;
1391 struct list_head replay_list;
1392 struct list_head replay_buds;
1393 unsigned long long cs_sqnum;
1394 unsigned long long replay_sqnum;
1395 int need_recovery;
1396 int replaying;
1397 struct list_head unclean_leb_list;
1398 struct ubifs_mst_node *rcvrd_mst_node;
1399 struct rb_root size_tree;
1400 int remounting_rw;
Adrian Hunter2953e732008-09-04 16:26:00 +03001401 int always_chk_crc;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001402 struct ubifs_mount_opts mount_opts;
1403
1404#ifdef CONFIG_UBIFS_FS_DEBUG
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001405 struct ubifs_debug_info *dbg;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001406#endif
1407};
1408
1409extern struct list_head ubifs_infos;
1410extern spinlock_t ubifs_infos_lock;
1411extern atomic_long_t ubifs_clean_zn_cnt;
1412extern struct kmem_cache *ubifs_inode_slab;
Artem Bityutskiye8b81562009-01-15 17:43:23 +02001413extern const struct super_operations ubifs_super_operations;
1414extern const struct address_space_operations ubifs_file_address_operations;
1415extern const struct file_operations ubifs_file_operations;
1416extern const struct inode_operations ubifs_file_inode_operations;
1417extern const struct file_operations ubifs_dir_operations;
1418extern const struct inode_operations ubifs_dir_inode_operations;
1419extern const struct inode_operations ubifs_symlink_inode_operations;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001420extern struct backing_dev_info ubifs_backing_dev_info;
1421extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
1422
1423/* io.c */
Adrian Hunterff46d7b2008-07-21 15:39:05 +03001424void ubifs_ro_mode(struct ubifs_info *c, int err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001425int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
1426int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs,
1427 int dtype);
1428int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
1429int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
1430 int lnum, int offs);
1431int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
1432 int lnum, int offs);
1433int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
1434 int offs, int dtype);
1435int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
Artem Bityutskiy6f7ab6d2009-01-27 16:12:31 +02001436 int offs, int quiet, int must_chk_crc);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001437void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
1438void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
1439int ubifs_io_init(struct ubifs_info *c);
1440void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
1441int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
1442int ubifs_bg_wbufs_sync(struct ubifs_info *c);
1443void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
1444int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
1445
1446/* scan.c */
1447struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
1448 int offs, void *sbuf);
1449void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
1450int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
1451 int offs, int quiet);
1452struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
1453 int offs, void *sbuf);
1454void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1455 int lnum, int offs);
1456int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1457 void *buf, int offs);
1458void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
1459 void *buf);
1460
1461/* log.c */
1462void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
1463void ubifs_create_buds_lists(struct ubifs_info *c);
1464int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
1465struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
1466struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
1467int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
1468int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
1469int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
1470int ubifs_consolidate_log(struct ubifs_info *c);
1471
1472/* journal.c */
1473int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
1474 const struct qstr *nm, const struct inode *inode,
1475 int deletion, int xent);
1476int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
1477 const union ubifs_key *key, const void *buf, int len);
Artem Bityutskiy1f286812008-07-22 12:06:13 +03001478int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
Artem Bityutskiyde94eb52008-07-22 13:06:20 +03001479int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001480int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
1481 const struct dentry *old_dentry,
1482 const struct inode *new_dir,
1483 const struct dentry *new_dentry, int sync);
1484int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
1485 loff_t old_size, loff_t new_size);
1486int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
1487 const struct inode *inode, const struct qstr *nm);
1488int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
1489 const struct inode *inode2);
1490
1491/* budget.c */
1492int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
1493void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
1494void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
1495 struct ubifs_inode *ui);
1496int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
1497 struct ubifs_budget_req *req);
1498void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
1499 struct ubifs_budget_req *req);
1500void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
1501 struct ubifs_budget_req *req);
Artem Bityutskiy7dad1812008-08-25 18:58:19 +03001502long long ubifs_get_free_space(struct ubifs_info *c);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001503long long ubifs_get_free_space_nolock(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001504int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
1505void ubifs_convert_page_budget(struct ubifs_info *c);
Artem Bityutskiy4d61db42008-12-18 14:06:51 +02001506long long ubifs_reported_space(const struct ubifs_info *c, long long free);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001507long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
1508
1509/* find.c */
Artem Bityutskiy3edaae72009-03-03 19:22:53 +02001510int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001511 int squeeze);
1512int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
1513int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
1514 int min_space, int pick_free);
1515int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
1516int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
1517
1518/* tnc.c */
1519int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
1520 struct ubifs_znode **zn, int *n);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001521int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
1522 void *node, const struct qstr *nm);
1523int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
1524 void *node, int *lnum, int *offs);
1525int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
1526 int offs, int len);
1527int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
1528 int old_lnum, int old_offs, int lnum, int offs, int len);
1529int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
1530 int lnum, int offs, int len, const struct qstr *nm);
1531int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
1532int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
1533 const struct qstr *nm);
1534int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
1535 union ubifs_key *to_key);
1536int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
1537struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
1538 union ubifs_key *key,
1539 const struct qstr *nm);
1540void ubifs_tnc_close(struct ubifs_info *c);
1541int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
1542 int lnum, int offs, int is_idx);
1543int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
1544 int lnum, int offs);
1545/* Shared by tnc.c for tnc_commit.c */
1546void destroy_old_idx(struct ubifs_info *c);
1547int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
1548 int lnum, int offs);
1549int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
Adrian Hunter4793e7c2008-09-02 16:29:46 +03001550int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
1551int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001552
1553/* tnc_misc.c */
1554struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr,
1555 struct ubifs_znode *znode);
1556int ubifs_search_zbranch(const struct ubifs_info *c,
1557 const struct ubifs_znode *znode,
1558 const union ubifs_key *key, int *n);
1559struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
1560struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode);
1561long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr);
1562struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
1563 struct ubifs_zbranch *zbr,
1564 struct ubifs_znode *parent, int iip);
1565int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
1566 void *node);
1567
1568/* tnc_commit.c */
1569int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
1570int ubifs_tnc_end_commit(struct ubifs_info *c);
1571
1572/* shrinker.c */
1573int ubifs_shrinker(int nr_to_scan, gfp_t gfp_mask);
1574
1575/* commit.c */
1576int ubifs_bg_thread(void *info);
1577void ubifs_commit_required(struct ubifs_info *c);
1578void ubifs_request_bg_commit(struct ubifs_info *c);
1579int ubifs_run_commit(struct ubifs_info *c);
1580void ubifs_recovery_commit(struct ubifs_info *c);
1581int ubifs_gc_should_commit(struct ubifs_info *c);
1582void ubifs_wait_for_commit(struct ubifs_info *c);
1583
1584/* master.c */
1585int ubifs_read_master(struct ubifs_info *c);
1586int ubifs_write_master(struct ubifs_info *c);
1587
1588/* sb.c */
1589int ubifs_read_superblock(struct ubifs_info *c);
1590struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c);
1591int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
1592
1593/* replay.c */
1594int ubifs_validate_entry(struct ubifs_info *c,
1595 const struct ubifs_dent_node *dent);
1596int ubifs_replay_journal(struct ubifs_info *c);
1597
1598/* gc.c */
1599int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
1600int ubifs_gc_start_commit(struct ubifs_info *c);
1601int ubifs_gc_end_commit(struct ubifs_info *c);
Adrian Hunterb466f172009-01-29 12:59:33 +02001602void ubifs_destroy_idx_gc(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001603int ubifs_get_idx_gc_leb(struct ubifs_info *c);
1604int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
1605
1606/* orphan.c */
1607int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
1608void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
1609int ubifs_orphan_start_commit(struct ubifs_info *c);
1610int ubifs_orphan_end_commit(struct ubifs_info *c);
1611int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
Adrian Hunter49d128a2009-01-26 10:55:40 +02001612int ubifs_clear_orphans(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001613
1614/* lpt.c */
1615int ubifs_calc_lpt_geom(struct ubifs_info *c);
1616int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
1617 int *lpt_lebs, int *big_lpt);
1618int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
1619struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
1620struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
1621int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
1622 ubifs_lpt_scan_callback scan_cb, void *data);
1623
1624/* Shared by lpt.c for lpt_commit.c */
1625void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
1626void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
1627 struct ubifs_lpt_lprops *ltab);
1628void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
1629 struct ubifs_pnode *pnode);
1630void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
1631 struct ubifs_nnode *nnode);
1632struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
1633 struct ubifs_nnode *parent, int iip);
1634struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
1635 struct ubifs_nnode *parent, int iip);
1636int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
1637void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
1638void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
1639uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits);
1640struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
Artem Bityutskiy2ba5f7a2008-10-31 17:32:30 +02001641/* Needed only in debugging code in lpt_commit.c */
1642int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
1643 struct ubifs_nnode *nnode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001644
1645/* lpt_commit.c */
1646int ubifs_lpt_start_commit(struct ubifs_info *c);
1647int ubifs_lpt_end_commit(struct ubifs_info *c);
1648int ubifs_lpt_post_commit(struct ubifs_info *c);
1649void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
1650
1651/* lprops.c */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001652const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
1653 const struct ubifs_lprops *lp,
1654 int free, int dirty, int flags,
1655 int idx_gc_cnt);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001656void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001657void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
1658 int cat);
1659void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
1660 struct ubifs_lprops *new_lprops);
1661void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
1662int ubifs_categorize_lprops(const struct ubifs_info *c,
1663 const struct ubifs_lprops *lprops);
1664int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1665 int flags_set, int flags_clean, int idx_gc_cnt);
1666int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1667 int flags_set, int flags_clean);
1668int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
1669const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
1670const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
1671const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
1672const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
1673
1674/* file.c */
1675int ubifs_fsync(struct file *file, struct dentry *dentry, int datasync);
1676int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
1677
1678/* dir.c */
1679struct inode *ubifs_new_inode(struct ubifs_info *c, const struct inode *dir,
1680 int mode);
1681int ubifs_getattr(struct vfsmount *mnt, struct dentry *dentry,
1682 struct kstat *stat);
1683
1684/* xattr.c */
1685int ubifs_setxattr(struct dentry *dentry, const char *name,
1686 const void *value, size_t size, int flags);
1687ssize_t ubifs_getxattr(struct dentry *dentry, const char *name, void *buf,
1688 size_t size);
1689ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
1690int ubifs_removexattr(struct dentry *dentry, const char *name);
1691
1692/* super.c */
1693struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
1694
1695/* recovery.c */
1696int ubifs_recover_master_node(struct ubifs_info *c);
1697int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
1698struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
1699 int offs, void *sbuf, int grouped);
1700struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
1701 int offs, void *sbuf);
1702int ubifs_recover_inl_heads(const struct ubifs_info *c, void *sbuf);
1703int ubifs_clean_lebs(const struct ubifs_info *c, void *sbuf);
1704int ubifs_rcvry_gc_commit(struct ubifs_info *c);
1705int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
1706 int deletion, loff_t new_size);
1707int ubifs_recover_size(struct ubifs_info *c);
1708void ubifs_destroy_size_tree(struct ubifs_info *c);
1709
1710/* ioctl.c */
1711long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1712void ubifs_set_inode_flags(struct inode *inode);
1713#ifdef CONFIG_COMPAT
1714long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1715#endif
1716
1717/* compressor.c */
1718int __init ubifs_compressors_init(void);
Alexey Dobriyan995be042008-12-04 17:04:18 +03001719void ubifs_compressors_exit(void);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001720void ubifs_compress(const void *in_buf, int in_len, void *out_buf, int *out_len,
1721 int *compr_type);
1722int ubifs_decompress(const void *buf, int len, void *out, int *out_len,
1723 int compr_type);
1724
1725#include "debug.h"
1726#include "misc.h"
1727#include "key.h"
1728
1729#endif /* !__UBIFS_H__ */