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