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