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