]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/ubifs/ubifs.h
UBUNTU: Ubuntu-4.13.0-45.50
[mirror_ubuntu-artful-kernel.git] / fs / ubifs / ubifs.h
CommitLineData
1e51764a
AB
1/*
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
1e51764a
AB
23#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>
5a0e3ad6 31#include <linux/slab.h>
1e51764a
AB
32#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>
d7f0b70d 39#include <linux/security.h>
2b88fc21 40#include <linux/xattr.h>
46f47e48
EB
41#ifdef CONFIG_UBIFS_FS_ENCRYPTION
42#include <linux/fscrypt_supp.h>
43#else
44#include <linux/fscrypt_notsupp.h>
45#endif
cc41a536 46#include <linux/random.h>
1e51764a
AB
47#include "ubifs-media.h"
48
49/* Version of this UBIFS implementation */
50#define UBIFS_VERSION 1
51
1e51764a
AB
52/* UBIFS file system VFS magic number */
53#define UBIFS_SUPER_MAGIC 0x24051905
54
55/* Number of UBIFS blocks per VFS page */
09cbfeaf
KS
56#define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE)
57#define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT)
1e51764a
AB
58
59/* "File system end of life" sequence number watermark */
60#define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL
61#define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL
62
af14a1ad
AB
63/*
64 * Minimum amount of LEBs reserved for the index. At present the index needs at
65 * least 2 LEBs: one for the index head and one for in-the-gaps method (which
66 * currently does not cater for the index head and so excludes it from
67 * consideration).
68 */
69#define MIN_INDEX_LEBS 2
70
1e51764a
AB
71/* Minimum amount of data UBIFS writes to the flash */
72#define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
73
74/*
75 * Currently we do not support inode number overlapping and re-using, so this
76 * watermark defines dangerous inode number level. This should be fixed later,
77 * although it is difficult to exceed current limit. Another option is to use
78 * 64-bit inode numbers, but this means more overhead.
79 */
80#define INUM_WARN_WATERMARK 0xFFF00000
81#define INUM_WATERMARK 0xFFFFFF00
82
1e51764a
AB
83/* Maximum number of entries in each LPT (LEB category) heap */
84#define LPT_HEAP_SZ 256
85
86/*
87 * Background thread name pattern. The numbers are UBI device and volume
88 * numbers.
89 */
90#define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
91
1e51764a
AB
92/* Maximum possible inode number (only 32-bit inodes are supported now) */
93#define MAX_INUM 0xFFFFFFFF
94
95/* Number of non-data journal heads */
96#define NONDATA_JHEADS_CNT 2
97
d6d14009
AB
98/* Shorter names for journal head numbers for internal usage */
99#define GCHD UBIFS_GC_HEAD
100#define BASEHD UBIFS_BASE_HEAD
101#define DATAHD UBIFS_DATA_HEAD
1e51764a
AB
102
103/* 'No change' value for 'ubifs_change_lp()' */
104#define LPROPS_NC 0x80000001
105
106/*
107 * There is no notion of truncation key because truncation nodes do not exist
108 * in TNC. However, when replaying, it is handy to introduce fake "truncation"
109 * keys for truncation nodes because the code becomes simpler. So we define
110 * %UBIFS_TRUN_KEY type.
ba2f48f7
AB
111 *
112 * But otherwise, out of the journal reply scope, the truncation keys are
113 * invalid.
1e51764a 114 */
ba2f48f7
AB
115#define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT
116#define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT
1e51764a
AB
117
118/*
119 * How much a directory entry/extended attribute entry adds to the parent/host
120 * inode.
121 */
122#define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
123
124/* How much an extended attribute adds to the host inode */
125#define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8)
126
127/*
128 * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered
129 * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are
130 * considered "young". This is used by shrinker when selecting znode to trim
131 * off.
132 */
133#define OLD_ZNODE_AGE 20
134#define YOUNG_ZNODE_AGE 5
135
136/*
137 * Some compressors, like LZO, may end up with more data then the input buffer.
138 * So UBIFS always allocates larger output buffer, to be sure the compressor
139 * will not corrupt memory in case of worst case compression.
140 */
141#define WORST_COMPR_FACTOR 2
142
7799953b
RW
143#ifdef CONFIG_UBIFS_FS_ENCRYPTION
144#define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE
145#else
146#define UBIFS_CIPHER_BLOCK_SIZE 0
147#endif
148
d882962f 149/*
d3f9db00 150 * How much memory is needed for a buffer where we compress a data node.
d882962f
MC
151 */
152#define COMPRESSED_DATA_NODE_BUF_SZ \
153 (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR)
154
1e51764a
AB
155/* Maximum expected tree height for use by bottom_up_buf */
156#define BOTTOM_UP_HEIGHT 64
157
4793e7c5
AH
158/* Maximum number of data nodes to bulk-read */
159#define UBIFS_MAX_BULK_READ 32
160
1e51764a
AB
161/*
162 * Lockdep classes for UBIFS inode @ui_mutex.
163 */
164enum {
165 WB_MUTEX_1 = 0,
166 WB_MUTEX_2 = 1,
167 WB_MUTEX_3 = 2,
9e0a1fff 168 WB_MUTEX_4 = 3,
1e51764a
AB
169};
170
171/*
172 * Znode flags (actually, bit numbers which store the flags).
173 *
174 * DIRTY_ZNODE: znode is dirty
175 * COW_ZNODE: znode is being committed and a new instance of this znode has to
176 * be created before changing this znode
177 * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is
178 * still in the commit list and the ongoing commit operation
179 * will commit it, and delete this znode after it is done
180 */
181enum {
182 DIRTY_ZNODE = 0,
183 COW_ZNODE = 1,
184 OBSOLETE_ZNODE = 2,
185};
186
187/*
188 * Commit states.
189 *
190 * COMMIT_RESTING: commit is not wanted
191 * COMMIT_BACKGROUND: background commit has been requested
192 * COMMIT_REQUIRED: commit is required
193 * COMMIT_RUNNING_BACKGROUND: background commit is running
194 * COMMIT_RUNNING_REQUIRED: commit is running and it is required
195 * COMMIT_BROKEN: commit failed
196 */
197enum {
198 COMMIT_RESTING = 0,
199 COMMIT_BACKGROUND,
200 COMMIT_REQUIRED,
201 COMMIT_RUNNING_BACKGROUND,
202 COMMIT_RUNNING_REQUIRED,
203 COMMIT_BROKEN,
204};
205
206/*
207 * 'ubifs_scan_a_node()' return values.
208 *
209 * SCANNED_GARBAGE: scanned garbage
210 * SCANNED_EMPTY_SPACE: scanned empty space
211 * SCANNED_A_NODE: scanned a valid node
212 * SCANNED_A_CORRUPT_NODE: scanned a corrupted node
213 * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length
214 *
215 * Greater than zero means: 'scanned that number of padding bytes'
216 */
217enum {
218 SCANNED_GARBAGE = 0,
219 SCANNED_EMPTY_SPACE = -1,
220 SCANNED_A_NODE = -2,
221 SCANNED_A_CORRUPT_NODE = -3,
222 SCANNED_A_BAD_PAD_NODE = -4,
223};
224
225/*
226 * LPT cnode flag bits.
227 *
228 * DIRTY_CNODE: cnode is dirty
1e51764a 229 * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted),
37662447
AB
230 * so it can (and must) be freed when the commit is finished
231 * COW_CNODE: cnode is being committed and must be copied before writing
1e51764a
AB
232 */
233enum {
234 DIRTY_CNODE = 0,
37662447
AB
235 OBSOLETE_CNODE = 1,
236 COW_CNODE = 2,
1e51764a
AB
237};
238
239/*
240 * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
241 *
242 * LTAB_DIRTY: ltab node is dirty
243 * LSAVE_DIRTY: lsave node is dirty
244 */
245enum {
246 LTAB_DIRTY = 1,
247 LSAVE_DIRTY = 2,
248};
249
250/*
251 * Return codes used by the garbage collector.
252 * @LEB_FREED: the logical eraseblock was freed and is ready to use
253 * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit
254 * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes
255 */
256enum {
257 LEB_FREED,
258 LEB_FREED_IDX,
259 LEB_RETAINED,
260};
261
262/**
263 * struct ubifs_old_idx - index node obsoleted since last commit start.
264 * @rb: rb-tree node
265 * @lnum: LEB number of obsoleted index node
266 * @offs: offset of obsoleted index node
267 */
268struct ubifs_old_idx {
269 struct rb_node rb;
270 int lnum;
271 int offs;
272};
273
274/* The below union makes it easier to deal with keys */
275union ubifs_key {
7ca58bad
AB
276 uint8_t u8[UBIFS_SK_LEN];
277 uint32_t u32[UBIFS_SK_LEN/4];
278 uint64_t u64[UBIFS_SK_LEN/8];
279 __le32 j32[UBIFS_SK_LEN/4];
1e51764a
AB
280};
281
282/**
283 * struct ubifs_scan_node - UBIFS scanned node information.
284 * @list: list of scanned nodes
285 * @key: key of node scanned (if it has one)
286 * @sqnum: sequence number
287 * @type: type of node scanned
288 * @offs: offset with LEB of node scanned
289 * @len: length of node scanned
290 * @node: raw node
291 */
292struct ubifs_scan_node {
293 struct list_head list;
294 union ubifs_key key;
295 unsigned long long sqnum;
296 int type;
297 int offs;
298 int len;
299 void *node;
300};
301
302/**
303 * struct ubifs_scan_leb - UBIFS scanned LEB information.
304 * @lnum: logical eraseblock number
305 * @nodes_cnt: number of nodes scanned
306 * @nodes: list of struct ubifs_scan_node
307 * @endpt: end point (and therefore the start of empty space)
1e51764a
AB
308 * @buf: buffer containing entire LEB scanned
309 */
310struct ubifs_scan_leb {
311 int lnum;
312 int nodes_cnt;
313 struct list_head nodes;
314 int endpt;
1e51764a
AB
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
de94eb55
AB
338 * @del_cmtno: commit number corresponding to the time the inode was deleted,
339 * protected by @c->commit_sem;
1e51764a
AB
340 * @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
625bf371 346 * @bulk_read: non-zero if bulk-read should be used
1e51764a 347 * @ui_mutex: serializes inode write-back with the rest of VFS operations,
4793e7c5 348 * serializes "clean <-> dirty" state changes, serializes bulk-read,
ba60ecab 349 * protects @dirty, @bulk_read, @ui_size, and @xattr_size
1e51764a
AB
350 * @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
4793e7c5
AH
357 * @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)
1e51764a
AB
359 * @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
c4361570
AB
386 * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would
387 * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields
388 * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one
1e51764a
AB
389 * could consider to rework locking and base it on "shadow" fields.
390 */
391struct ubifs_inode {
392 struct inode vfs_inode;
bc813355
AH
393 unsigned long long creat_sqnum;
394 unsigned long long del_cmtno;
1e51764a
AB
395 unsigned int xattr_size;
396 unsigned int xattr_cnt;
397 unsigned int xattr_names;
398 unsigned int dirty:1;
399 unsigned int xattr:1;
625bf371 400 unsigned int bulk_read:1;
a1dc080c 401 unsigned int compr_type:2;
1e51764a
AB
402 struct mutex ui_mutex;
403 spinlock_t ui_lock;
404 loff_t synced_i_size;
405 loff_t ui_size;
406 int flags;
4793e7c5
AH
407 pgoff_t last_page_read;
408 pgoff_t read_in_a_row;
1e51764a
AB
409 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
7078202e 433 * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
21a60258 434 * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
7078202e 435 * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
1e51764a
AB
436 * 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;
f92b9826
AB
488 unsigned tgc:1;
489 unsigned cmt:1;
1e51764a
AB
490};
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
d3cf502b
AB
497 * @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)
1e51764a 502 *
d3cf502b
AB
503 * 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.
1e51764a 512 *
d3cf502b
AB
513 * @empty_lebs includes @taken_empty_lebs.
514 *
515 * @total_used, @total_dead and @total_dark fields do not account indexing
516 * LEBs.
1e51764a
AB
517 */
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
3c89f396 649 * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range)
1e51764a
AB
650 * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep
651 * up by 'mutex_lock_nested()).
652 * @sync_callback: write-buffer synchronization callback
653 * @io_mutex: serializes write-buffer I/O
654 * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes
655 * fields
656 * @timer: write-buffer timer
681947d2
AH
657 * @no_timer: non-zero if this write-buffer does not have a timer
658 * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing
1e51764a
AB
659 * @next_ino: points to the next position of the following inode number
660 * @inodes: stores the inode numbers of the nodes which are in wbuf
661 *
662 * The write-buffer synchronization callback is called when the write-buffer is
663 * synchronized in order to notify how much space was wasted due to
664 * write-buffer padding and how much free space is left in the LEB.
665 *
666 * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under
667 * spin-lock or mutex because they are written under both mutex and spin-lock.
668 * @buf is appended to under mutex but overwritten under both mutex and
669 * spin-lock. Thus the data between @buf and @buf + @used can be read under
670 * spinlock.
671 */
672struct ubifs_wbuf {
673 struct ubifs_info *c;
674 void *buf;
675 int lnum;
676 int offs;
677 int avail;
678 int used;
3c89f396 679 int size;
1e51764a
AB
680 int jhead;
681 int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad);
682 struct mutex io_mutex;
683 spinlock_t lock;
f2c5dbd7 684 struct hrtimer timer;
0b335b9d
AB
685 unsigned int no_timer:1;
686 unsigned int need_sync:1;
1e51764a
AB
687 int next_ino;
688 ino_t *inodes;
689};
690
691/**
692 * struct ubifs_bud - bud logical eraseblock.
693 * @lnum: logical eraseblock number
694 * @start: where the (uncommitted) bud data starts
695 * @jhead: journal head number this bud belongs to
696 * @list: link in the list buds belonging to the same journal head
697 * @rb: link in the tree of all buds
698 */
699struct ubifs_bud {
700 int lnum;
701 int start;
702 int jhead;
703 struct list_head list;
704 struct rb_node rb;
705};
706
707/**
708 * struct ubifs_jhead - journal head.
709 * @wbuf: head's write-buffer
710 * @buds_list: list of bud LEBs belonging to this journal head
1a0b0699 711 * @grouped: non-zero if UBIFS groups nodes when writing to this journal head
1e51764a
AB
712 *
713 * Note, the @buds list is protected by the @c->buds_lock.
714 */
715struct ubifs_jhead {
716 struct ubifs_wbuf wbuf;
717 struct list_head buds_list;
1a0b0699 718 unsigned int grouped:1;
1e51764a
AB
719};
720
721/**
722 * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
723 * @key: key
724 * @znode: znode address in memory
be61678b
AB
725 * @lnum: LEB number of the target node (indexing node or data node)
726 * @offs: target node offset within @lnum
1e51764a
AB
727 * @len: target node length
728 */
729struct ubifs_zbranch {
730 union ubifs_key key;
731 union {
732 struct ubifs_znode *znode;
733 void *leaf;
734 };
735 int lnum;
736 int offs;
737 int len;
738};
739
740/**
741 * struct ubifs_znode - in-memory representation of an indexing node.
742 * @parent: parent znode or NULL if it is the root
743 * @cnext: next znode to commit
744 * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE)
745 * @time: last access time (seconds)
746 * @level: level of the entry in the TNC tree
747 * @child_cnt: count of child znodes
748 * @iip: index in parent's zbranch array
749 * @alt: lower bound of key range has altered i.e. child inserted at slot 0
750 * @lnum: LEB number of the corresponding indexing node
751 * @offs: offset of the corresponding indexing node
752 * @len: length of the corresponding indexing node
753 * @zbranch: array of znode branches (@c->fanout elements)
f70b7e52
AB
754 *
755 * Note! The @lnum, @offs, and @len fields are not really needed - we have them
756 * only for internal consistency check. They could be removed to save some RAM.
1e51764a
AB
757 */
758struct ubifs_znode {
759 struct ubifs_znode *parent;
760 struct ubifs_znode *cnext;
761 unsigned long flags;
762 unsigned long time;
763 int level;
764 int child_cnt;
765 int iip;
766 int alt;
f70b7e52
AB
767 int lnum;
768 int offs;
769 int len;
1e51764a
AB
770 struct ubifs_zbranch zbranch[];
771};
772
4793e7c5 773/**
39ce81ce 774 * struct bu_info - bulk-read information.
4793e7c5
AH
775 * @key: first data node key
776 * @zbranch: zbranches of data nodes to bulk read
777 * @buf: buffer to read into
778 * @buf_len: buffer length
779 * @gc_seq: GC sequence number to detect races with GC
780 * @cnt: number of data nodes for bulk read
781 * @blk_cnt: number of data blocks including holes
782 * @oef: end of file reached
783 */
784struct bu_info {
785 union ubifs_key key;
786 struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ];
787 void *buf;
788 int buf_len;
789 int gc_seq;
790 int cnt;
791 int blk_cnt;
792 int eof;
793};
794
1e51764a
AB
795/**
796 * struct ubifs_node_range - node length range description data structure.
797 * @len: fixed node length
798 * @min_len: minimum possible node length
799 * @max_len: maximum possible node length
800 *
801 * If @max_len is %0, the node has fixed length @len.
802 */
803struct ubifs_node_range {
804 union {
805 int len;
806 int min_len;
807 };
808 int max_len;
809};
810
811/**
812 * struct ubifs_compressor - UBIFS compressor description structure.
813 * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc)
814 * @cc: cryptoapi compressor handle
815 * @comp_mutex: mutex used during compression
816 * @decomp_mutex: mutex used during decompression
817 * @name: compressor name
818 * @capi_name: cryptoapi compressor name
819 */
820struct ubifs_compressor {
821 int compr_type;
822 struct crypto_comp *cc;
823 struct mutex *comp_mutex;
824 struct mutex *decomp_mutex;
825 const char *name;
826 const char *capi_name;
827};
828
829/**
830 * struct ubifs_budget_req - budget requirements of an operation.
831 *
de94eb55 832 * @fast: non-zero if the budgeting should try to acquire budget quickly and
1e51764a
AB
833 * should not try to call write-back
834 * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields
835 * have to be re-calculated
836 * @new_page: non-zero if the operation adds a new page
837 * @dirtied_page: non-zero if the operation makes a page dirty
838 * @new_dent: non-zero if the operation adds a new directory entry
839 * @mod_dent: non-zero if the operation removes or modifies an existing
840 * directory entry
841 * @new_ino: non-zero if the operation adds a new inode
7d25b361 842 * @new_ino_d: how much data newly created inode contains
1e51764a 843 * @dirtied_ino: how many inodes the operation makes dirty
7d25b361 844 * @dirtied_ino_d: how much data dirtied inode contains
1e51764a
AB
845 * @idx_growth: how much the index will supposedly grow
846 * @data_growth: how much new data the operation will supposedly add
847 * @dd_growth: how much data that makes other data dirty the operation will
848 * supposedly add
849 *
850 * @idx_growth, @data_growth and @dd_growth are not used in budget request. The
851 * budgeting subsystem caches index and data growth values there to avoid
852 * re-calculating them when the budget is released. However, if @idx_growth is
853 * %-1, it is calculated by the release function using other fields.
854 *
855 * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d
856 * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made
857 * dirty by the re-name operation.
dab4b4d2
AB
858 *
859 * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to
860 * make sure the amount of inode data which contribute to @new_ino_d and
861 * @dirtied_ino_d fields are aligned.
1e51764a
AB
862 */
863struct ubifs_budget_req {
864 unsigned int fast:1;
865 unsigned int recalculate:1;
547000da 866#ifndef UBIFS_DEBUG
1e51764a
AB
867 unsigned int new_page:1;
868 unsigned int dirtied_page:1;
869 unsigned int new_dent:1;
870 unsigned int mod_dent:1;
871 unsigned int new_ino:1;
872 unsigned int new_ino_d:13;
1e51764a
AB
873 unsigned int dirtied_ino:4;
874 unsigned int dirtied_ino_d:15;
875#else
876 /* Not bit-fields to check for overflows */
547000da
AB
877 unsigned int new_page;
878 unsigned int dirtied_page;
879 unsigned int new_dent;
880 unsigned int mod_dent;
881 unsigned int new_ino;
882 unsigned int new_ino_d;
1e51764a
AB
883 unsigned int dirtied_ino;
884 unsigned int dirtied_ino_d;
885#endif
886 int idx_growth;
887 int data_growth;
888 int dd_growth;
889};
890
891/**
892 * struct ubifs_orphan - stores the inode number of an orphan.
893 * @rb: rb-tree node of rb-tree of orphans sorted by inode number
894 * @list: list head of list of orphans in order added
895 * @new_list: list head of list of orphans added since the last commit
896 * @cnext: next orphan to commit
897 * @dnext: next orphan to delete
898 * @inum: inode number
899 * @new: %1 => added since the last commit, otherwise %0
2928f0d0 900 * @cmt: %1 => commit pending, otherwise %0
8afd500c 901 * @del: %1 => delete pending, otherwise %0
1e51764a
AB
902 */
903struct ubifs_orphan {
904 struct rb_node rb;
905 struct list_head list;
906 struct list_head new_list;
907 struct ubifs_orphan *cnext;
908 struct ubifs_orphan *dnext;
909 ino_t inum;
2928f0d0
AT
910 unsigned new:1;
911 unsigned cmt:1;
8afd500c 912 unsigned del:1;
1e51764a
AB
913};
914
915/**
916 * struct ubifs_mount_opts - UBIFS-specific mount options information.
917 * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
d3f9db00 918 * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable)
553dea4d 919 * @chk_data_crc: enable/disable CRC data checking when reading data nodes
d3f9db00 920 * (%0 default, %1 disable, %2 enable)
553dea4d
AB
921 * @override_compr: override default compressor (%0 - do not override and use
922 * superblock compressor, %1 - override and use compressor
923 * specified in @compr_type)
924 * @compr_type: compressor type to override the superblock compressor with
925 * (%UBIFS_COMPR_NONE, etc)
1e51764a
AB
926 */
927struct ubifs_mount_opts {
928 unsigned int unmount_mode:2;
4793e7c5 929 unsigned int bulk_read:2;
2953e73f 930 unsigned int chk_data_crc:2;
553dea4d
AB
931 unsigned int override_compr:1;
932 unsigned int compr_type:2;
1e51764a
AB
933};
934
b137545c
AB
935/**
936 * struct ubifs_budg_info - UBIFS budgeting information.
937 * @idx_growth: amount of bytes budgeted for index growth
938 * @data_growth: amount of bytes budgeted for cached data
939 * @dd_growth: amount of bytes budgeted for cached data that will make
940 * other data dirty
941 * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but
942 * which still have to be taken into account because the index
943 * has not been committed so far
944 * @old_idx_sz: size of index on flash
945 * @min_idx_lebs: minimum number of LEBs required for the index
946 * @nospace: non-zero if the file-system does not have flash space (used as
947 * optimization)
948 * @nospace_rp: the same as @nospace, but additionally means that even reserved
949 * pool is full
d3f9db00
YG
950 * @page_budget: budget for a page (constant, never changed after mount)
951 * @inode_budget: budget for an inode (constant, never changed after mount)
952 * @dent_budget: budget for a directory entry (constant, never changed after
b137545c
AB
953 * mount)
954 */
955struct ubifs_budg_info {
956 long long idx_growth;
957 long long data_growth;
958 long long dd_growth;
959 long long uncommitted_idx;
960 unsigned long long old_idx_sz;
961 int min_idx_lebs;
962 unsigned int nospace:1;
963 unsigned int nospace_rp:1;
964 int page_budget;
965 int inode_budget;
966 int dent_budget;
967};
968
17c2f9f8
AB
969struct ubifs_debug_info;
970
1e51764a
AB
971/**
972 * struct ubifs_info - UBIFS file-system description data structure
973 * (per-superblock).
974 * @vfs_sb: VFS @struct super_block object
1e51764a
AB
975 *
976 * @highest_inum: highest used inode number
1e51764a 977 * @max_sqnum: current global sequence number
014eb04b
AB
978 * @cmt_no: commit number of the last successfully completed commit, protected
979 * by @commit_sem
81ffa38e 980 * @cnt_lock: protects @highest_inum and @max_sqnum counters
1e51764a 981 * @fmt_version: UBIFS on-flash format version
963f0cf6 982 * @ro_compat_version: R/O compatibility version
1e51764a
AB
983 * @uuid: UUID from super block
984 *
985 * @lhead_lnum: log head logical eraseblock number
986 * @lhead_offs: log head offset
987 * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
988 * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
989 * @bud_bytes
990 * @min_log_bytes: minimum required number of bytes in the log
991 * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
992 * committed buds
993 *
994 * @buds: tree of all buds indexed by bud LEB number
995 * @bud_bytes: how many bytes of flash is used by buds
996 * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
997 * lists
998 * @jhead_cnt: count of journal heads
999 * @jheads: journal heads (head zero is base head)
1000 * @max_bud_bytes: maximum number of bytes allowed in buds
1001 * @bg_bud_bytes: number of bud bytes when background commit is initiated
1002 * @old_buds: buds to be released after commit ends
1003 * @max_bud_cnt: maximum number of buds
1004 *
1005 * @commit_sem: synchronizes committer with other processes
1006 * @cmt_state: commit state
1007 * @cs_lock: commit state lock
1008 * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
625bf371 1009 *
1e51764a 1010 * @big_lpt: flag that LPT is too big to write whole during commit
9f58d350 1011 * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up
d63d61c1 1012 * @double_hash: flag indicating that we can do lookups by hash
e021986e 1013 * @encrypted: flag indicating that this file system contains encrypted files
625bf371
AB
1014 * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
1015 * recovery)
1016 * @bulk_read: enable bulk-reads
a1dc080c 1017 * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
963f0cf6 1018 * @rw_incompat: the media is not R/W compatible
1e51764a
AB
1019 *
1020 * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
1021 * @calc_idx_sz
1022 * @zroot: zbranch which points to the root index node and znode
1023 * @cnext: next znode to commit
1024 * @enext: next znode to commit to empty space
1025 * @gap_lebs: array of LEBs used by the in-gaps commit method
1026 * @cbuf: commit buffer
1027 * @ileb_buf: buffer for commit in-the-gaps method
1028 * @ileb_len: length of data in ileb_buf
1029 * @ihead_lnum: LEB number of index head
1030 * @ihead_offs: offset of index head
1031 * @ilebs: pre-allocated index LEBs
1032 * @ileb_cnt: number of pre-allocated index LEBs
1033 * @ileb_nxt: next pre-allocated index LEBs
1034 * @old_idx: tree of index nodes obsoleted since the last commit start
1035 * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
1e51764a
AB
1036 *
1037 * @mst_node: master node
1038 * @mst_offs: offset of valid master node
3477d204 1039 *
6c0c42cd 1040 * @max_bu_buf_len: maximum bulk-read buffer length
3477d204
AB
1041 * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
1042 * @bu: pre-allocated bulk-read information
1e51764a 1043 *
d882962f
MC
1044 * @write_reserve_mutex: protects @write_reserve_buf
1045 * @write_reserve_buf: on the write path we allocate memory, which might
1046 * sometimes be unavailable, in which case we use this
1047 * write reserve buffer
1048 *
1e51764a
AB
1049 * @log_lebs: number of logical eraseblocks in the log
1050 * @log_bytes: log size in bytes
1051 * @log_last: last LEB of the log
1052 * @lpt_lebs: number of LEBs used for lprops table
1053 * @lpt_first: first LEB of the lprops table area
1054 * @lpt_last: last LEB of the lprops table area
1055 * @orph_lebs: number of LEBs used for the orphan area
1056 * @orph_first: first LEB of the orphan area
1057 * @orph_last: last LEB of the orphan area
1058 * @main_lebs: count of LEBs in the main area
1059 * @main_first: first LEB of the main area
1060 * @main_bytes: main area size in bytes
1e51764a
AB
1061 *
1062 * @key_hash_type: type of the key hash
1063 * @key_hash: direntry key hash function
1064 * @key_fmt: key format
1065 * @key_len: key length
1066 * @fanout: fanout of the index tree (number of links per indexing node)
1067 *
1068 * @min_io_size: minimal input/output unit size
1069 * @min_io_shift: number of bits in @min_io_size minus one
3e8e2e0c
AB
1070 * @max_write_size: maximum amount of bytes the underlying flash can write at a
1071 * time (MTD write buffer size)
1072 * @max_write_shift: number of bits in @max_write_size minus one
1e51764a 1073 * @leb_size: logical eraseblock size in bytes
ca2ec61d
AB
1074 * @leb_start: starting offset of logical eraseblocks within physical
1075 * eraseblocks
1e51764a 1076 * @half_leb_size: half LEB size
fb1cd01a
AB
1077 * @idx_leb_size: how many bytes of an LEB are effectively available when it is
1078 * used to store indexing nodes (@leb_size - @max_idx_node_sz)
1e51764a
AB
1079 * @leb_cnt: count of logical eraseblocks
1080 * @max_leb_cnt: maximum count of logical eraseblocks
1081 * @old_leb_cnt: count of logical eraseblocks before re-size
1082 * @ro_media: the underlying UBI volume is read-only
2ef13294 1083 * @ro_mount: the file-system was mounted as read-only
2680d722 1084 * @ro_error: UBIFS switched to R/O mode because an error happened
1e51764a
AB
1085 *
1086 * @dirty_pg_cnt: number of dirty pages (not used)
1087 * @dirty_zn_cnt: number of dirty znodes
1088 * @clean_zn_cnt: number of clean znodes
1089 *
b137545c
AB
1090 * @space_lock: protects @bi and @lst
1091 * @lst: lprops statistics
1092 * @bi: budgeting information
1e51764a
AB
1093 * @calc_idx_sz: temporary variable which is used to calculate new index size
1094 * (contains accurate new index size at end of TNC commit start)
1e51764a
AB
1095 *
1096 * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
b137545c 1097 * I/O unit
1e51764a
AB
1098 * @mst_node_alsz: master node aligned size
1099 * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
1100 * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
1101 * @max_inode_sz: maximum possible inode size in bytes
1102 * @max_znode_sz: size of znode in bytes
9bbb5726
AB
1103 *
1104 * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
1105 * data nodes of maximum size - used in free space reporting
1e51764a
AB
1106 * @dead_wm: LEB dead space watermark
1107 * @dark_wm: LEB dark space watermark
1108 * @block_cnt: count of 4KiB blocks on the FS
1109 *
1110 * @ranges: UBIFS node length ranges
1111 * @ubi: UBI volume descriptor
1112 * @di: UBI device information
1113 * @vi: UBI volume information
1114 *
1115 * @orph_tree: rb-tree of orphan inode numbers
1116 * @orph_list: list of orphan inode numbers in order added
1117 * @orph_new: list of orphan inode numbers added since last commit
1118 * @orph_cnext: next orphan to commit
1119 * @orph_dnext: next orphan to delete
1120 * @orphan_lock: lock for orph_tree and orph_new
1121 * @orph_buf: buffer for orphan nodes
1122 * @new_orphans: number of orphans since last commit
1123 * @cmt_orphans: number of orphans being committed
1124 * @tot_orphans: number of orphans in the rb_tree
1125 * @max_orphans: maximum number of orphans allowed
1126 * @ohead_lnum: orphan head LEB number
1127 * @ohead_offs: orphan head offset
1128 * @no_orphs: non-zero if there are no orphans
1129 *
1130 * @bgt: UBIFS background thread
1131 * @bgt_name: background thread name
1132 * @need_bgt: if background thread should run
1133 * @need_wbuf_sync: if write-buffers have to be synchronized
1134 *
1135 * @gc_lnum: LEB number used for garbage collection
1136 * @sbuf: a buffer of LEB size used by GC and replay for scanning
1137 * @idx_gc: list of index LEBs that have been garbage collected
1138 * @idx_gc_cnt: number of elements on the idx_gc list
601c0bc4
AH
1139 * @gc_seq: incremented for every non-index LEB garbage collected
1140 * @gced_lnum: last non-index LEB that was garbage collected
1e51764a
AB
1141 *
1142 * @infos_list: links all 'ubifs_info' objects
1143 * @umount_mutex: serializes shrinker and un-mount
1144 * @shrinker_run_no: shrinker run number
1145 *
1146 * @space_bits: number of bits needed to record free or dirty space
1147 * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
1148 * @lpt_offs_bits: number of bits needed to record an offset in the LPT
1149 * @lpt_spc_bits: number of bits needed to space in the LPT
1150 * @pcnt_bits: number of bits needed to record pnode or nnode number
1151 * @lnum_bits: number of bits needed to record LEB number
1152 * @nnode_sz: size of on-flash nnode
1153 * @pnode_sz: size of on-flash pnode
1154 * @ltab_sz: size of on-flash LPT lprops table
1155 * @lsave_sz: size of on-flash LPT save table
1156 * @pnode_cnt: number of pnodes
1157 * @nnode_cnt: number of nnodes
1158 * @lpt_hght: height of the LPT
1159 * @pnodes_have: number of pnodes in memory
1160 *
1161 * @lp_mutex: protects lprops table and all the other lprops-related fields
1162 * @lpt_lnum: LEB number of the root nnode of the LPT
1163 * @lpt_offs: offset of the root nnode of the LPT
1164 * @nhead_lnum: LEB number of LPT head
1165 * @nhead_offs: offset of LPT head
1166 * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
1167 * @dirty_nn_cnt: number of dirty nnodes
1168 * @dirty_pn_cnt: number of dirty pnodes
73944a6d 1169 * @check_lpt_free: flag that indicates LPT GC may be needed
1e51764a
AB
1170 * @lpt_sz: LPT size
1171 * @lpt_nod_buf: buffer for an on-flash nnode or pnode
1172 * @lpt_buf: buffer of LEB size used by LPT
1173 * @nroot: address in memory of the root nnode of the LPT
1174 * @lpt_cnext: next LPT node to commit
1175 * @lpt_heap: array of heaps of categorized lprops
1176 * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
1177 * previous commit start
1178 * @uncat_list: list of un-categorized LEBs
1179 * @empty_list: list of empty LEBs
fb1cd01a
AB
1180 * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size)
1181 * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size)
1e51764a 1182 * @freeable_cnt: number of freeable LEBs in @freeable_list
98a1eebd
AB
1183 * @in_a_category_cnt: count of lprops which are in a certain category, which
1184 * basically meants that they were loaded from the flash
1e51764a
AB
1185 *
1186 * @ltab_lnum: LEB number of LPT's own lprops table
1187 * @ltab_offs: offset of LPT's own lprops table
1188 * @ltab: LPT's own lprops table
1189 * @ltab_cmt: LPT's own lprops table (commit copy)
1190 * @lsave_cnt: number of LEB numbers in LPT's save table
1191 * @lsave_lnum: LEB number of LPT's save table
1192 * @lsave_offs: offset of LPT's save table
1193 * @lsave: LPT's save table
1194 * @lscan_lnum: LEB number of last LPT scan
1195 *
1196 * @rp_size: size of the reserved pool in bytes
1197 * @report_rp_size: size of the reserved pool reported to user-space
1198 * @rp_uid: reserved pool user ID
1199 * @rp_gid: reserved pool group ID
1200 *
d8cdda3e
AB
1201 * @empty: %1 if the UBI device is empty
1202 * @need_recovery: %1 if the file-system needs recovery
1203 * @replaying: %1 during journal replay
18d1d7fb 1204 * @mounting: %1 while mounting
90bea5a3 1205 * @probing: %1 while attempting to mount if MS_SILENT mount flag is set
d8cdda3e 1206 * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode
1e51764a
AB
1207 * @replay_list: temporary list used during journal replay
1208 * @replay_buds: list of buds to replay
1209 * @cs_sqnum: sequence number of first node in the log (commit start node)
1210 * @replay_sqnum: sequence number of node currently being replayed
2ef13294
AB
1211 * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W
1212 * mode
1213 * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted
1214 * FS to R/W mode
1e51764a 1215 * @size_tree: inode size information for recovery
1e51764a
AB
1216 * @mount_opts: UBIFS-specific mount options
1217 *
17c2f9f8 1218 * @dbg: debugging-related information
1e51764a
AB
1219 */
1220struct ubifs_info {
1221 struct super_block *vfs_sb;
1e51764a
AB
1222
1223 ino_t highest_inum;
1e51764a
AB
1224 unsigned long long max_sqnum;
1225 unsigned long long cmt_no;
1226 spinlock_t cnt_lock;
1227 int fmt_version;
963f0cf6 1228 int ro_compat_version;
1e51764a
AB
1229 unsigned char uuid[16];
1230
1231 int lhead_lnum;
1232 int lhead_offs;
1233 int ltail_lnum;
1234 struct mutex log_mutex;
1235 int min_log_bytes;
1236 long long cmt_bud_bytes;
1237
1238 struct rb_root buds;
1239 long long bud_bytes;
1240 spinlock_t buds_lock;
1241 int jhead_cnt;
1242 struct ubifs_jhead *jheads;
1243 long long max_bud_bytes;
1244 long long bg_bud_bytes;
1245 struct list_head old_buds;
1246 int max_bud_cnt;
1247
1248 struct rw_semaphore commit_sem;
1249 int cmt_state;
1250 spinlock_t cs_lock;
1251 wait_queue_head_t cmt_wq;
625bf371 1252
1e51764a 1253 unsigned int big_lpt:1;
9f58d350 1254 unsigned int space_fixup:1;
d63d61c1 1255 unsigned int double_hash:1;
e021986e 1256 unsigned int encrypted:1;
625bf371
AB
1257 unsigned int no_chk_data_crc:1;
1258 unsigned int bulk_read:1;
a1dc080c 1259 unsigned int default_compr:2;
963f0cf6 1260 unsigned int rw_incompat:1;
1e51764a
AB
1261
1262 struct mutex tnc_mutex;
1263 struct ubifs_zbranch zroot;
1264 struct ubifs_znode *cnext;
1265 struct ubifs_znode *enext;
1266 int *gap_lebs;
1267 void *cbuf;
1268 void *ileb_buf;
1269 int ileb_len;
1270 int ihead_lnum;
1271 int ihead_offs;
1272 int *ilebs;
1273 int ileb_cnt;
1274 int ileb_nxt;
1275 struct rb_root old_idx;
1276 int *bottom_up_buf;
1e51764a
AB
1277
1278 struct ubifs_mst_node *mst_node;
1279 int mst_offs;
3477d204 1280
6c0c42cd 1281 int max_bu_buf_len;
3477d204
AB
1282 struct mutex bu_mutex;
1283 struct bu_info bu;
1e51764a 1284
d882962f
MC
1285 struct mutex write_reserve_mutex;
1286 void *write_reserve_buf;
1287
1e51764a
AB
1288 int log_lebs;
1289 long long log_bytes;
1290 int log_last;
1291 int lpt_lebs;
1292 int lpt_first;
1293 int lpt_last;
1294 int orph_lebs;
1295 int orph_first;
1296 int orph_last;
1297 int main_lebs;
1298 int main_first;
1299 long long main_bytes;
1e51764a
AB
1300
1301 uint8_t key_hash_type;
1302 uint32_t (*key_hash)(const char *str, int len);
1303 int key_fmt;
1304 int key_len;
1305 int fanout;
1306
1307 int min_io_size;
1308 int min_io_shift;
3e8e2e0c
AB
1309 int max_write_size;
1310 int max_write_shift;
1e51764a 1311 int leb_size;
ca2ec61d 1312 int leb_start;
1e51764a 1313 int half_leb_size;
fb1cd01a 1314 int idx_leb_size;
1e51764a
AB
1315 int leb_cnt;
1316 int max_leb_cnt;
1317 int old_leb_cnt;
2680d722 1318 unsigned int ro_media:1;
2ef13294 1319 unsigned int ro_mount:1;
2680d722 1320 unsigned int ro_error:1;
1e51764a
AB
1321
1322 atomic_long_t dirty_pg_cnt;
1323 atomic_long_t dirty_zn_cnt;
1324 atomic_long_t clean_zn_cnt;
1325
1e51764a 1326 spinlock_t space_lock;
1e51764a 1327 struct ubifs_lp_stats lst;
b137545c
AB
1328 struct ubifs_budg_info bi;
1329 unsigned long long calc_idx_sz;
1e51764a
AB
1330
1331 int ref_node_alsz;
1332 int mst_node_alsz;
1333 int min_idx_node_sz;
1334 int max_idx_node_sz;
1335 long long max_inode_sz;
1336 int max_znode_sz;
9bbb5726
AB
1337
1338 int leb_overhead;
1e51764a
AB
1339 int dead_wm;
1340 int dark_wm;
1341 int block_cnt;
1342
1343 struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
1344 struct ubi_volume_desc *ubi;
1345 struct ubi_device_info di;
1346 struct ubi_volume_info vi;
1347
1348 struct rb_root orph_tree;
1349 struct list_head orph_list;
1350 struct list_head orph_new;
1351 struct ubifs_orphan *orph_cnext;
1352 struct ubifs_orphan *orph_dnext;
1353 spinlock_t orphan_lock;
1354 void *orph_buf;
1355 int new_orphans;
1356 int cmt_orphans;
1357 int tot_orphans;
1358 int max_orphans;
1359 int ohead_lnum;
1360 int ohead_offs;
1361 int no_orphs;
1362
1363 struct task_struct *bgt;
1364 char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
1365 int need_bgt;
1366 int need_wbuf_sync;
1367
1368 int gc_lnum;
1369 void *sbuf;
1370 struct list_head idx_gc;
1371 int idx_gc_cnt;
f92b9826
AB
1372 int gc_seq;
1373 int gced_lnum;
1e51764a
AB
1374
1375 struct list_head infos_list;
1376 struct mutex umount_mutex;
1377 unsigned int shrinker_run_no;
1378
1379 int space_bits;
1380 int lpt_lnum_bits;
1381 int lpt_offs_bits;
1382 int lpt_spc_bits;
1383 int pcnt_bits;
1384 int lnum_bits;
1385 int nnode_sz;
1386 int pnode_sz;
1387 int ltab_sz;
1388 int lsave_sz;
1389 int pnode_cnt;
1390 int nnode_cnt;
1391 int lpt_hght;
1392 int pnodes_have;
1393
1394 struct mutex lp_mutex;
1395 int lpt_lnum;
1396 int lpt_offs;
1397 int nhead_lnum;
1398 int nhead_offs;
1399 int lpt_drty_flgs;
1400 int dirty_nn_cnt;
1401 int dirty_pn_cnt;
73944a6d 1402 int check_lpt_free;
1e51764a
AB
1403 long long lpt_sz;
1404 void *lpt_nod_buf;
1405 void *lpt_buf;
1406 struct ubifs_nnode *nroot;
1407 struct ubifs_cnode *lpt_cnext;
1408 struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
1409 struct ubifs_lpt_heap dirty_idx;
1410 struct list_head uncat_list;
1411 struct list_head empty_list;
1412 struct list_head freeable_list;
1413 struct list_head frdi_idx_list;
1414 int freeable_cnt;
98a1eebd 1415 int in_a_category_cnt;
1e51764a
AB
1416
1417 int ltab_lnum;
1418 int ltab_offs;
1419 struct ubifs_lpt_lprops *ltab;
1420 struct ubifs_lpt_lprops *ltab_cmt;
1421 int lsave_cnt;
1422 int lsave_lnum;
1423 int lsave_offs;
1424 int *lsave;
1425 int lscan_lnum;
1426
1427 long long rp_size;
1428 long long report_rp_size;
39241beb
EB
1429 kuid_t rp_uid;
1430 kgid_t rp_gid;
1e51764a
AB
1431
1432 /* The below fields are used only during mounting and re-mounting */
d8cdda3e
AB
1433 unsigned int empty:1;
1434 unsigned int need_recovery:1;
1435 unsigned int replaying:1;
18d1d7fb 1436 unsigned int mounting:1;
d8cdda3e 1437 unsigned int remounting_rw:1;
90bea5a3 1438 unsigned int probing:1;
1e51764a
AB
1439 struct list_head replay_list;
1440 struct list_head replay_buds;
1441 unsigned long long cs_sqnum;
1442 unsigned long long replay_sqnum;
1e51764a
AB
1443 struct list_head unclean_leb_list;
1444 struct ubifs_mst_node *rcvrd_mst_node;
1445 struct rb_root size_tree;
1e51764a
AB
1446 struct ubifs_mount_opts mount_opts;
1447
17c2f9f8 1448 struct ubifs_debug_info *dbg;
1e51764a
AB
1449};
1450
1451extern struct list_head ubifs_infos;
1452extern spinlock_t ubifs_infos_lock;
1453extern atomic_long_t ubifs_clean_zn_cnt;
e8b81566
AB
1454extern const struct super_operations ubifs_super_operations;
1455extern const struct address_space_operations ubifs_file_address_operations;
1456extern const struct file_operations ubifs_file_operations;
1457extern const struct inode_operations ubifs_file_inode_operations;
1458extern const struct file_operations ubifs_dir_operations;
1459extern const struct inode_operations ubifs_dir_inode_operations;
1460extern const struct inode_operations ubifs_symlink_inode_operations;
1e51764a
AB
1461extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
1462
1463/* io.c */
ff46d7b3 1464void ubifs_ro_mode(struct ubifs_info *c, int err);
83cef708
AB
1465int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs,
1466 int len, int even_ebadmsg);
1467int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
b36a261e
RW
1468 int len);
1469int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
83cef708 1470int ubifs_leb_unmap(struct ubifs_info *c, int lnum);
b36a261e 1471int ubifs_leb_map(struct ubifs_info *c, int lnum);
83cef708 1472int ubifs_is_mapped(const struct ubifs_info *c, int lnum);
1e51764a 1473int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
b36a261e 1474int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs);
1e51764a
AB
1475int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
1476int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
1477 int lnum, int offs);
1478int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
1479 int lnum, int offs);
1480int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
b36a261e 1481 int offs);
1e51764a 1482int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
6f7ab6d4 1483 int offs, int quiet, int must_chk_crc);
1e51764a
AB
1484void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
1485void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
1486int ubifs_io_init(struct ubifs_info *c);
1487void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
1488int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
1489int ubifs_bg_wbufs_sync(struct ubifs_info *c);
1490void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
1491int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
1492
1493/* scan.c */
1494struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
348709ba 1495 int offs, void *sbuf, int quiet);
1e51764a
AB
1496void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
1497int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
1498 int offs, int quiet);
1499struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
1500 int offs, void *sbuf);
1501void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1502 int lnum, int offs);
1503int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1504 void *buf, int offs);
1505void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
1506 void *buf);
1507
1508/* log.c */
1509void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
1510void ubifs_create_buds_lists(struct ubifs_info *c);
1511int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
1512struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
1513struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
1514int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
1515int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
1516int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
1517int ubifs_consolidate_log(struct ubifs_info *c);
1518
1519/* journal.c */
1520int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
f4f61d2c 1521 const struct fscrypt_name *nm, const struct inode *inode,
1e51764a
AB
1522 int deletion, int xent);
1523int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
1524 const union ubifs_key *key, const void *buf, int len);
1f28681a 1525int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
de94eb55 1526int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
9ec64962 1527int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,
f4f61d2c
RW
1528 const struct inode *fst_inode,
1529 const struct fscrypt_name *fst_nm,
9ec64962 1530 const struct inode *snd_dir,
f4f61d2c
RW
1531 const struct inode *snd_inode,
1532 const struct fscrypt_name *snd_nm, int sync);
1e51764a 1533int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
f4f61d2c
RW
1534 const struct inode *old_inode,
1535 const struct fscrypt_name *old_nm,
1e51764a 1536 const struct inode *new_dir,
f4f61d2c
RW
1537 const struct inode *new_inode,
1538 const struct fscrypt_name *new_nm,
9e0a1fff 1539 const struct inode *whiteout, int sync);
1e51764a
AB
1540int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
1541 loff_t old_size, loff_t new_size);
1542int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
f4f61d2c 1543 const struct inode *inode, const struct fscrypt_name *nm);
1e51764a
AB
1544int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
1545 const struct inode *inode2);
1546
1547/* budget.c */
1548int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
1549void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
1550void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
1551 struct ubifs_inode *ui);
1552int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
1553 struct ubifs_budget_req *req);
1554void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
1555 struct ubifs_budget_req *req);
1556void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
1557 struct ubifs_budget_req *req);
7dad181b 1558long long ubifs_get_free_space(struct ubifs_info *c);
84abf972 1559long long ubifs_get_free_space_nolock(struct ubifs_info *c);
1e51764a
AB
1560int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
1561void ubifs_convert_page_budget(struct ubifs_info *c);
4d61db4f 1562long long ubifs_reported_space(const struct ubifs_info *c, long long free);
1e51764a
AB
1563long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
1564
1565/* find.c */
3edaae7c 1566int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
1e51764a
AB
1567 int squeeze);
1568int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
1569int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
1570 int min_space, int pick_free);
1571int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
1572int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
1573
1574/* tnc.c */
1575int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
1576 struct ubifs_znode **zn, int *n);
1e51764a 1577int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
f4f61d2c 1578 void *node, const struct fscrypt_name *nm);
528e3d17
RW
1579int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key,
1580 void *node, uint32_t secondary_hash);
1e51764a
AB
1581int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
1582 void *node, int *lnum, int *offs);
1583int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
1584 int offs, int len);
1585int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
1586 int old_lnum, int old_offs, int lnum, int offs, int len);
1587int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
f4f61d2c 1588 int lnum, int offs, int len, const struct fscrypt_name *nm);
1e51764a
AB
1589int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
1590int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
f4f61d2c 1591 const struct fscrypt_name *nm);
781f675e
RW
1592int ubifs_tnc_remove_dh(struct ubifs_info *c, const union ubifs_key *key,
1593 uint32_t cookie);
1e51764a
AB
1594int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
1595 union ubifs_key *to_key);
1596int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
1597struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
1598 union ubifs_key *key,
f4f61d2c 1599 const struct fscrypt_name *nm);
1e51764a
AB
1600void ubifs_tnc_close(struct ubifs_info *c);
1601int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
1602 int lnum, int offs, int is_idx);
1603int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
1604 int lnum, int offs);
1605/* Shared by tnc.c for tnc_commit.c */
1606void destroy_old_idx(struct ubifs_info *c);
1607int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
1608 int lnum, int offs);
1609int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
4793e7c5
AH
1610int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
1611int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
1e51764a
AB
1612
1613/* tnc_misc.c */
1614struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr,
1615 struct ubifs_znode *znode);
1616int ubifs_search_zbranch(const struct ubifs_info *c,
1617 const struct ubifs_znode *znode,
1618 const union ubifs_key *key, int *n);
1619struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
1620struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode);
1621long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr);
1622struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
1623 struct ubifs_zbranch *zbr,
1624 struct ubifs_znode *parent, int iip);
1625int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
1626 void *node);
1627
1628/* tnc_commit.c */
1629int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
1630int ubifs_tnc_end_commit(struct ubifs_info *c);
1631
1632/* shrinker.c */
1ab6c499
DC
1633unsigned long ubifs_shrink_scan(struct shrinker *shrink,
1634 struct shrink_control *sc);
1635unsigned long ubifs_shrink_count(struct shrinker *shrink,
1636 struct shrink_control *sc);
1e51764a
AB
1637
1638/* commit.c */
1639int ubifs_bg_thread(void *info);
1640void ubifs_commit_required(struct ubifs_info *c);
1641void ubifs_request_bg_commit(struct ubifs_info *c);
1642int ubifs_run_commit(struct ubifs_info *c);
1643void ubifs_recovery_commit(struct ubifs_info *c);
1644int ubifs_gc_should_commit(struct ubifs_info *c);
1645void ubifs_wait_for_commit(struct ubifs_info *c);
1646
1647/* master.c */
1648int ubifs_read_master(struct ubifs_info *c);
1649int ubifs_write_master(struct ubifs_info *c);
1650
1651/* sb.c */
1652int ubifs_read_superblock(struct ubifs_info *c);
1653struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c);
1654int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
6554a657 1655int ubifs_fixup_free_space(struct ubifs_info *c);
e021986e 1656int ubifs_enable_encryption(struct ubifs_info *c);
1e51764a
AB
1657
1658/* replay.c */
1659int ubifs_validate_entry(struct ubifs_info *c,
1660 const struct ubifs_dent_node *dent);
1661int ubifs_replay_journal(struct ubifs_info *c);
1662
1663/* gc.c */
1664int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
1665int ubifs_gc_start_commit(struct ubifs_info *c);
1666int ubifs_gc_end_commit(struct ubifs_info *c);
b466f17d 1667void ubifs_destroy_idx_gc(struct ubifs_info *c);
1e51764a
AB
1668int ubifs_get_idx_gc_leb(struct ubifs_info *c);
1669int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
1670
1671/* orphan.c */
1672int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
1673void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
1674int ubifs_orphan_start_commit(struct ubifs_info *c);
1675int ubifs_orphan_end_commit(struct ubifs_info *c);
1676int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
49d128aa 1677int ubifs_clear_orphans(struct ubifs_info *c);
1e51764a
AB
1678
1679/* lpt.c */
1680int ubifs_calc_lpt_geom(struct ubifs_info *c);
1681int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
1682 int *lpt_lebs, int *big_lpt);
1683int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
1684struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
1685struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
1686int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
1687 ubifs_lpt_scan_callback scan_cb, void *data);
1688
1689/* Shared by lpt.c for lpt_commit.c */
1690void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
1691void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
1692 struct ubifs_lpt_lprops *ltab);
1693void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
1694 struct ubifs_pnode *pnode);
1695void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
1696 struct ubifs_nnode *nnode);
1697struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
1698 struct ubifs_nnode *parent, int iip);
1699struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
1700 struct ubifs_nnode *parent, int iip);
1701int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
1702void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
1703void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
1704uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits);
1705struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
2ba5f7ae
AB
1706/* Needed only in debugging code in lpt_commit.c */
1707int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
1708 struct ubifs_nnode *nnode);
1e51764a
AB
1709
1710/* lpt_commit.c */
1711int ubifs_lpt_start_commit(struct ubifs_info *c);
1712int ubifs_lpt_end_commit(struct ubifs_info *c);
1713int ubifs_lpt_post_commit(struct ubifs_info *c);
1714void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
1715
1716/* lprops.c */
1e51764a
AB
1717const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
1718 const struct ubifs_lprops *lp,
1719 int free, int dirty, int flags,
1720 int idx_gc_cnt);
84abf972 1721void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
1e51764a
AB
1722void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
1723 int cat);
1724void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
1725 struct ubifs_lprops *new_lprops);
1726void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
1727int ubifs_categorize_lprops(const struct ubifs_info *c,
1728 const struct ubifs_lprops *lprops);
1729int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1730 int flags_set, int flags_clean, int idx_gc_cnt);
1731int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1732 int flags_set, int flags_clean);
1733int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
1734const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
1735const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
1736const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
1737const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
be9e62a7 1738int ubifs_calc_dark(const struct ubifs_info *c, int spc);
1e51764a
AB
1739
1740/* file.c */
02c24a82 1741int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync);
1e51764a 1742int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
8c1c5f26
DY
1743#ifdef CONFIG_UBIFS_ATIME_SUPPORT
1744int ubifs_update_time(struct inode *inode, struct timespec *time, int flags);
1745#endif
1e51764a
AB
1746
1747/* dir.c */
d475a507 1748struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir,
ad44be5c 1749 umode_t mode);
a528d35e
DH
1750int ubifs_getattr(const struct path *path, struct kstat *stat,
1751 u32 request_mask, unsigned int flags);
f6337d84 1752int ubifs_check_dir_empty(struct inode *dir);
1e51764a
AB
1753
1754/* xattr.c */
2b88fc21 1755extern const struct xattr_handler *ubifs_xattr_handlers[];
1e51764a 1756ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
ade46c3a 1757int ubifs_xattr_set(struct inode *host, const char *name, const void *value,
d8db5b1c 1758 size_t size, int flags, bool check_lock);
ade46c3a
RW
1759ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf,
1760 size_t size);
272eda82 1761void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum);
1e51764a 1762
8326c1ee
HL
1763#ifdef CONFIG_UBIFS_FS_SECURITY
1764extern int ubifs_init_security(struct inode *dentry, struct inode *inode,
1765 const struct qstr *qstr);
1766#else
1767static inline int ubifs_init_security(struct inode *dentry,
1768 struct inode *inode, const struct qstr *qstr)
1769{
1770 return 0;
1771}
1772#endif
1773
1774
1e51764a
AB
1775/* super.c */
1776struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
1777
1778/* recovery.c */
1779int ubifs_recover_master_node(struct ubifs_info *c);
1780int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
1781struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
efcfde54 1782 int offs, void *sbuf, int jhead);
1e51764a
AB
1783struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
1784 int offs, void *sbuf);
83cef708
AB
1785int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf);
1786int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf);
1e51764a
AB
1787int ubifs_rcvry_gc_commit(struct ubifs_info *c);
1788int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
1789 int deletion, loff_t new_size);
1790int ubifs_recover_size(struct ubifs_info *c);
1791void ubifs_destroy_size_tree(struct ubifs_info *c);
1792
1793/* ioctl.c */
1794long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1795void ubifs_set_inode_flags(struct inode *inode);
1796#ifdef CONFIG_COMPAT
1797long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1798#endif
1799
1800/* compressor.c */
1801int __init ubifs_compressors_init(void);
995be045 1802void ubifs_compressors_exit(void);
235c362b
SY
1803void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len,
1804 void *out_buf, int *out_len, int *compr_type);
1805int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len,
1806 void *out, int *out_len, int compr_type);
1e51764a
AB
1807
1808#include "debug.h"
1809#include "misc.h"
1810#include "key.h"
1811
d475a507 1812#ifndef CONFIG_UBIFS_FS_ENCRYPTION
7799953b
RW
1813static inline int ubifs_encrypt(const struct inode *inode,
1814 struct ubifs_data_node *dn,
1815 unsigned int in_len, unsigned int *out_len,
1816 int block)
1817{
1818 ubifs_assert(0);
1819 return -EOPNOTSUPP;
1820}
1821static inline int ubifs_decrypt(const struct inode *inode,
1822 struct ubifs_data_node *dn,
1823 unsigned int *out_len, int block)
1824{
1825 ubifs_assert(0);
1826 return -EOPNOTSUPP;
1827}
1828#else
1829/* crypto.c */
1830int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn,
1831 unsigned int in_len, unsigned int *out_len, int block);
1832int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn,
1833 unsigned int *out_len, int block);
d475a507
RW
1834#endif
1835
6f69f0ed 1836extern const struct fscrypt_operations ubifs_crypt_operations;
7799953b 1837
1ee77870 1838static inline bool __ubifs_crypt_is_encrypted(struct inode *inode)
d475a507
RW
1839{
1840 struct ubifs_inode *ui = ubifs_inode(inode);
1841
1842 return ui->flags & UBIFS_CRYPT_FL;
1843}
1844
1ee77870
RW
1845static inline bool ubifs_crypt_is_encrypted(const struct inode *inode)
1846{
1847 return __ubifs_crypt_is_encrypted((struct inode *)inode);
1848}
1849
3e7f2c51
JP
1850/* Normal UBIFS messages */
1851__printf(2, 3)
1852void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...);
1853__printf(2, 3)
1854void ubifs_err(const struct ubifs_info *c, const char *fmt, ...);
1855__printf(2, 3)
1856void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...);
1857/*
380bc8b7
DG
1858 * A conditional variant of 'ubifs_err()' which doesn't output anything
1859 * if probing (ie. MS_SILENT set).
3e7f2c51
JP
1860 */
1861#define ubifs_errc(c, fmt, ...) \
1862do { \
1863 if (!(c)->probing) \
1864 ubifs_err(c, fmt, ##__VA_ARGS__); \
1865} while (0)
1866
1e51764a 1867#endif /* !__UBIFS_H__ */