blob: 5ee7af879cc41ab9242e110fbbc7fa8a274d56f1 [file] [log] [blame]
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001/*
2 * This file is part of UBIFS.
3 *
4 * Copyright (C) 2006-2008 Nokia Corporation
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors: Artem Bityutskiy (Битюцкий Артём)
20 * Adrian Hunter
21 */
22
Artem Bityutskiy1e517642008-07-14 19:08:37 +030023#ifndef __UBIFS_H__
24#define __UBIFS_H__
25
26#include <asm/div64.h>
27#include <linux/statfs.h>
28#include <linux/fs.h>
29#include <linux/err.h>
30#include <linux/sched.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090031#include <linux/slab.h>
Artem Bityutskiy1e517642008-07-14 19:08:37 +030032#include <linux/vmalloc.h>
33#include <linux/spinlock.h>
34#include <linux/mutex.h>
35#include <linux/rwsem.h>
36#include <linux/mtd/ubi.h>
37#include <linux/pagemap.h>
38#include <linux/backing-dev.h>
Subodh Nijsured7f0b702014-10-31 13:50:30 -050039#include <linux/security.h>
Andreas Gruenbacher2b88fc22016-04-22 19:14:00 +020040#include <linux/xattr.h>
Richard Weinbergercc41a532016-10-16 19:51:51 +020041#include <linux/random.h>
Dave Chinner734f0d22017-10-09 12:15:34 -070042
43#define __FS_HAS_ENCRYPTION IS_ENABLED(CONFIG_UBIFS_FS_ENCRYPTION)
44#include <linux/fscrypt.h>
45
Artem Bityutskiy1e517642008-07-14 19:08:37 +030046#include "ubifs-media.h"
47
48/* Version of this UBIFS implementation */
49#define UBIFS_VERSION 1
50
Artem Bityutskiy1e517642008-07-14 19:08:37 +030051/* UBIFS file system VFS magic number */
52#define UBIFS_SUPER_MAGIC 0x24051905
53
54/* Number of UBIFS blocks per VFS page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030055#define UBIFS_BLOCKS_PER_PAGE (PAGE_SIZE / UBIFS_BLOCK_SIZE)
56#define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_SHIFT - UBIFS_BLOCK_SHIFT)
Artem Bityutskiy1e517642008-07-14 19:08:37 +030057
58/* "File system end of life" sequence number watermark */
59#define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL
60#define SQNUM_WATERMARK 0xFFFFFFFFFF000000ULL
61
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +020062/*
63 * Minimum amount of LEBs reserved for the index. At present the index needs at
64 * least 2 LEBs: one for the index head and one for in-the-gaps method (which
65 * currently does not cater for the index head and so excludes it from
66 * consideration).
67 */
68#define MIN_INDEX_LEBS 2
69
Artem Bityutskiy1e517642008-07-14 19:08:37 +030070/* Minimum amount of data UBIFS writes to the flash */
71#define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
72
73/*
74 * Currently we do not support inode number overlapping and re-using, so this
75 * watermark defines dangerous inode number level. This should be fixed later,
76 * although it is difficult to exceed current limit. Another option is to use
77 * 64-bit inode numbers, but this means more overhead.
78 */
79#define INUM_WARN_WATERMARK 0xFFF00000
80#define INUM_WATERMARK 0xFFFFFF00
81
Artem Bityutskiy1e517642008-07-14 19:08:37 +030082/* Maximum number of entries in each LPT (LEB category) heap */
83#define LPT_HEAP_SZ 256
84
85/*
86 * Background thread name pattern. The numbers are UBI device and volume
87 * numbers.
88 */
89#define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
90
Artem Bityutskiy1e517642008-07-14 19:08:37 +030091/* Maximum possible inode number (only 32-bit inodes are supported now) */
92#define MAX_INUM 0xFFFFFFFF
93
94/* Number of non-data journal heads */
95#define NONDATA_JHEADS_CNT 2
96
Artem Bityutskiyd6d14002009-09-15 14:44:06 +030097/* Shorter names for journal head numbers for internal usage */
98#define GCHD UBIFS_GC_HEAD
99#define BASEHD UBIFS_BASE_HEAD
100#define DATAHD UBIFS_DATA_HEAD
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300101
102/* 'No change' value for 'ubifs_change_lp()' */
103#define LPROPS_NC 0x80000001
104
105/*
106 * There is no notion of truncation key because truncation nodes do not exist
107 * in TNC. However, when replaying, it is handy to introduce fake "truncation"
108 * keys for truncation nodes because the code becomes simpler. So we define
109 * %UBIFS_TRUN_KEY type.
Artem Bityutskiyba2f48f72010-08-22 07:10:12 +0300110 *
111 * But otherwise, out of the journal reply scope, the truncation keys are
112 * invalid.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300113 */
Artem Bityutskiyba2f48f72010-08-22 07:10:12 +0300114#define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT
115#define UBIFS_INVALID_KEY UBIFS_KEY_TYPES_CNT
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300116
117/*
118 * How much a directory entry/extended attribute entry adds to the parent/host
119 * inode.
120 */
121#define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
122
123/* How much an extended attribute adds to the host inode */
124#define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8)
125
126/*
127 * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered
128 * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are
129 * considered "young". This is used by shrinker when selecting znode to trim
130 * off.
131 */
132#define OLD_ZNODE_AGE 20
133#define YOUNG_ZNODE_AGE 5
134
135/*
136 * Some compressors, like LZO, may end up with more data then the input buffer.
137 * So UBIFS always allocates larger output buffer, to be sure the compressor
138 * will not corrupt memory in case of worst case compression.
139 */
140#define WORST_COMPR_FACTOR 2
141
Richard Weinberger77999532016-09-29 22:20:19 +0200142#ifdef CONFIG_UBIFS_FS_ENCRYPTION
143#define UBIFS_CIPHER_BLOCK_SIZE FS_CRYPTO_BLOCK_SIZE
144#else
145#define UBIFS_CIPHER_BLOCK_SIZE 0
146#endif
147
Matthew L. Creechd8829622011-03-04 17:55:02 -0500148/*
Yannick Guerrinid3f9db02015-03-06 23:14:39 +0100149 * How much memory is needed for a buffer where we compress a data node.
Matthew L. Creechd8829622011-03-04 17:55:02 -0500150 */
151#define COMPRESSED_DATA_NODE_BUF_SZ \
152 (UBIFS_DATA_NODE_SZ + UBIFS_BLOCK_SIZE * WORST_COMPR_FACTOR)
153
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300154/* Maximum expected tree height for use by bottom_up_buf */
155#define BOTTOM_UP_HEIGHT 64
156
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300157/* Maximum number of data nodes to bulk-read */
158#define UBIFS_MAX_BULK_READ 32
159
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300160/*
161 * Lockdep classes for UBIFS inode @ui_mutex.
162 */
163enum {
164 WB_MUTEX_1 = 0,
165 WB_MUTEX_2 = 1,
166 WB_MUTEX_3 = 2,
Richard Weinberger9e0a1ff2016-09-14 22:28:50 +0200167 WB_MUTEX_4 = 3,
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300168};
169
170/*
171 * Znode flags (actually, bit numbers which store the flags).
172 *
173 * DIRTY_ZNODE: znode is dirty
174 * COW_ZNODE: znode is being committed and a new instance of this znode has to
175 * be created before changing this znode
176 * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is
177 * still in the commit list and the ongoing commit operation
178 * will commit it, and delete this znode after it is done
179 */
180enum {
181 DIRTY_ZNODE = 0,
182 COW_ZNODE = 1,
183 OBSOLETE_ZNODE = 2,
184};
185
186/*
187 * Commit states.
188 *
189 * COMMIT_RESTING: commit is not wanted
190 * COMMIT_BACKGROUND: background commit has been requested
191 * COMMIT_REQUIRED: commit is required
192 * COMMIT_RUNNING_BACKGROUND: background commit is running
193 * COMMIT_RUNNING_REQUIRED: commit is running and it is required
194 * COMMIT_BROKEN: commit failed
195 */
196enum {
197 COMMIT_RESTING = 0,
198 COMMIT_BACKGROUND,
199 COMMIT_REQUIRED,
200 COMMIT_RUNNING_BACKGROUND,
201 COMMIT_RUNNING_REQUIRED,
202 COMMIT_BROKEN,
203};
204
205/*
206 * 'ubifs_scan_a_node()' return values.
207 *
208 * SCANNED_GARBAGE: scanned garbage
209 * SCANNED_EMPTY_SPACE: scanned empty space
210 * SCANNED_A_NODE: scanned a valid node
211 * SCANNED_A_CORRUPT_NODE: scanned a corrupted node
212 * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length
213 *
214 * Greater than zero means: 'scanned that number of padding bytes'
215 */
216enum {
217 SCANNED_GARBAGE = 0,
218 SCANNED_EMPTY_SPACE = -1,
219 SCANNED_A_NODE = -2,
220 SCANNED_A_CORRUPT_NODE = -3,
221 SCANNED_A_BAD_PAD_NODE = -4,
222};
223
224/*
225 * LPT cnode flag bits.
226 *
227 * DIRTY_CNODE: cnode is dirty
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300228 * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted),
Artem Bityutskiy37662442011-05-30 14:51:20 +0300229 * so it can (and must) be freed when the commit is finished
230 * COW_CNODE: cnode is being committed and must be copied before writing
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300231 */
232enum {
233 DIRTY_CNODE = 0,
Artem Bityutskiy37662442011-05-30 14:51:20 +0300234 OBSOLETE_CNODE = 1,
235 COW_CNODE = 2,
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300236};
237
238/*
239 * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
240 *
241 * LTAB_DIRTY: ltab node is dirty
242 * LSAVE_DIRTY: lsave node is dirty
243 */
244enum {
245 LTAB_DIRTY = 1,
246 LSAVE_DIRTY = 2,
247};
248
249/*
250 * Return codes used by the garbage collector.
251 * @LEB_FREED: the logical eraseblock was freed and is ready to use
252 * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit
253 * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes
254 */
255enum {
256 LEB_FREED,
257 LEB_FREED_IDX,
258 LEB_RETAINED,
259};
260
261/**
262 * struct ubifs_old_idx - index node obsoleted since last commit start.
263 * @rb: rb-tree node
264 * @lnum: LEB number of obsoleted index node
265 * @offs: offset of obsoleted index node
266 */
267struct ubifs_old_idx {
268 struct rb_node rb;
269 int lnum;
270 int offs;
271};
272
273/* The below union makes it easier to deal with keys */
274union ubifs_key {
Artem Bityutskiy7ca58ba2012-02-29 18:43:01 +0200275 uint8_t u8[UBIFS_SK_LEN];
276 uint32_t u32[UBIFS_SK_LEN/4];
277 uint64_t u64[UBIFS_SK_LEN/8];
278 __le32 j32[UBIFS_SK_LEN/4];
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300279};
280
281/**
282 * struct ubifs_scan_node - UBIFS scanned node information.
283 * @list: list of scanned nodes
284 * @key: key of node scanned (if it has one)
285 * @sqnum: sequence number
286 * @type: type of node scanned
287 * @offs: offset with LEB of node scanned
288 * @len: length of node scanned
289 * @node: raw node
290 */
291struct ubifs_scan_node {
292 struct list_head list;
293 union ubifs_key key;
294 unsigned long long sqnum;
295 int type;
296 int offs;
297 int len;
298 void *node;
299};
300
301/**
302 * struct ubifs_scan_leb - UBIFS scanned LEB information.
303 * @lnum: logical eraseblock number
304 * @nodes_cnt: number of nodes scanned
305 * @nodes: list of struct ubifs_scan_node
306 * @endpt: end point (and therefore the start of empty space)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300307 * @buf: buffer containing entire LEB scanned
308 */
309struct ubifs_scan_leb {
310 int lnum;
311 int nodes_cnt;
312 struct list_head nodes;
313 int endpt;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300314 void *buf;
315};
316
317/**
318 * struct ubifs_gced_idx_leb - garbage-collected indexing LEB.
319 * @list: list
320 * @lnum: LEB number
321 * @unmap: OK to unmap this LEB
322 *
323 * This data structure is used to temporary store garbage-collected indexing
324 * LEBs - they are not released immediately, but only after the next commit.
325 * This is needed to guarantee recoverability.
326 */
327struct ubifs_gced_idx_leb {
328 struct list_head list;
329 int lnum;
330 int unmap;
331};
332
333/**
334 * struct ubifs_inode - UBIFS in-memory inode description.
335 * @vfs_inode: VFS inode description object
336 * @creat_sqnum: sequence number at time of creation
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300337 * @del_cmtno: commit number corresponding to the time the inode was deleted,
338 * protected by @c->commit_sem;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300339 * @xattr_size: summarized size of all extended attributes in bytes
340 * @xattr_cnt: count of extended attributes this inode has
341 * @xattr_names: sum of lengths of all extended attribute names belonging to
342 * this inode
343 * @dirty: non-zero if the inode is dirty
344 * @xattr: non-zero if this is an extended attribute inode
Artem Bityutskiy625bf372008-09-08 16:13:38 +0300345 * @bulk_read: non-zero if bulk-read should be used
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300346 * @ui_mutex: serializes inode write-back with the rest of VFS operations,
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300347 * serializes "clean <-> dirty" state changes, serializes bulk-read,
Artem Bityutskiyba60eca2008-09-08 16:38:01 +0300348 * protects @dirty, @bulk_read, @ui_size, and @xattr_size
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300349 * @ui_lock: protects @synced_i_size
350 * @synced_i_size: synchronized size of inode, i.e. the value of inode size
351 * currently stored on the flash; used only for regular file
352 * inodes
353 * @ui_size: inode size used by UBIFS when writing to flash
354 * @flags: inode flags (@UBIFS_COMPR_FL, etc)
355 * @compr_type: default compression type used for this inode
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300356 * @last_page_read: page number of last page read (for bulk read)
357 * @read_in_a_row: number of consecutive pages read in a row (for bulk read)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300358 * @data_len: length of the data attached to the inode
359 * @data: inode's data
360 *
361 * @ui_mutex exists for two main reasons. At first it prevents inodes from
362 * being written back while UBIFS changing them, being in the middle of an VFS
363 * operation. This way UBIFS makes sure the inode fields are consistent. For
364 * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and
365 * write-back must not write any of them before we have finished.
366 *
367 * The second reason is budgeting - UBIFS has to budget all operations. If an
368 * operation is going to mark an inode dirty, it has to allocate budget for
369 * this. It cannot just mark it dirty because there is no guarantee there will
370 * be enough flash space to write the inode back later. This means UBIFS has
371 * to have full control over inode "clean <-> dirty" transitions (and pages
372 * actually). But unfortunately, VFS marks inodes dirty in many places, and it
373 * does not ask the file-system if it is allowed to do so (there is a notifier,
374 * but it is not enough), i.e., there is no mechanism to synchronize with this.
375 * So UBIFS has its own inode dirty flag and its own mutex to serialize
376 * "clean <-> dirty" transitions.
377 *
378 * The @synced_i_size field is used to make sure we never write pages which are
379 * beyond last synchronized inode size. See 'ubifs_writepage()' for more
380 * information.
381 *
382 * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses
383 * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot
384 * make sure @inode->i_size is always changed under @ui_mutex, because it
Artem Bityutskiyc4361572011-03-25 15:27:40 +0200385 * cannot call 'truncate_setsize()' with @ui_mutex locked, because it would
386 * deadlock with 'ubifs_writepage()' (see file.c). All the other inode fields
387 * are changed under @ui_mutex, so they do not need "shadow" fields. Note, one
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300388 * could consider to rework locking and base it on "shadow" fields.
389 */
390struct ubifs_inode {
391 struct inode vfs_inode;
Adrian Hunterbc8133552008-07-23 15:23:11 +0300392 unsigned long long creat_sqnum;
393 unsigned long long del_cmtno;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300394 unsigned int xattr_size;
395 unsigned int xattr_cnt;
396 unsigned int xattr_names;
397 unsigned int dirty:1;
398 unsigned int xattr:1;
Artem Bityutskiy625bf372008-09-08 16:13:38 +0300399 unsigned int bulk_read:1;
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +0200400 unsigned int compr_type:2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300401 struct mutex ui_mutex;
402 spinlock_t ui_lock;
403 loff_t synced_i_size;
404 loff_t ui_size;
405 int flags;
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300406 pgoff_t last_page_read;
407 pgoff_t read_in_a_row;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300408 int data_len;
409 void *data;
410};
411
412/**
413 * struct ubifs_unclean_leb - records a LEB recovered under read-only mode.
414 * @list: list
415 * @lnum: LEB number of recovered LEB
416 * @endpt: offset where recovery ended
417 *
418 * This structure records a LEB identified during recovery that needs to be
419 * cleaned but was not because UBIFS was mounted read-only. The information
420 * is used to clean the LEB when remounting to read-write mode.
421 */
422struct ubifs_unclean_leb {
423 struct list_head list;
424 int lnum;
425 int endpt;
426};
427
428/*
429 * LEB properties flags.
430 *
431 * LPROPS_UNCAT: not categorized
Artem Bityutskiy70782022009-01-19 19:57:27 +0200432 * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
Artem Bityutskiy21a60252008-12-12 11:13:17 -0500433 * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
Artem Bityutskiy70782022009-01-19 19:57:27 +0200434 * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300435 * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs
436 * LPROPS_EMPTY: LEB is empty, not taken
437 * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken
438 * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken
439 * LPROPS_CAT_MASK: mask for the LEB categories above
440 * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media)
441 * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash)
442 */
443enum {
444 LPROPS_UNCAT = 0,
445 LPROPS_DIRTY = 1,
446 LPROPS_DIRTY_IDX = 2,
447 LPROPS_FREE = 3,
448 LPROPS_HEAP_CNT = 3,
449 LPROPS_EMPTY = 4,
450 LPROPS_FREEABLE = 5,
451 LPROPS_FRDI_IDX = 6,
452 LPROPS_CAT_MASK = 15,
453 LPROPS_TAKEN = 16,
454 LPROPS_INDEX = 32,
455};
456
457/**
458 * struct ubifs_lprops - logical eraseblock properties.
459 * @free: amount of free space in bytes
460 * @dirty: amount of dirty space in bytes
461 * @flags: LEB properties flags (see above)
462 * @lnum: LEB number
463 * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE)
464 * @hpos: heap position in heap of same-category lprops (other categories)
465 */
466struct ubifs_lprops {
467 int free;
468 int dirty;
469 int flags;
470 int lnum;
471 union {
472 struct list_head list;
473 int hpos;
474 };
475};
476
477/**
478 * struct ubifs_lpt_lprops - LPT logical eraseblock properties.
479 * @free: amount of free space in bytes
480 * @dirty: amount of dirty space in bytes
481 * @tgc: trivial GC flag (1 => unmap after commit end)
482 * @cmt: commit flag (1 => reserved for commit)
483 */
484struct ubifs_lpt_lprops {
485 int free;
486 int dirty;
Artem Bityutskiyf92b9822008-12-28 11:34:26 +0200487 unsigned tgc:1;
488 unsigned cmt:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300489};
490
491/**
492 * struct ubifs_lp_stats - statistics of eraseblocks in the main area.
493 * @empty_lebs: number of empty LEBs
494 * @taken_empty_lebs: number of taken LEBs
495 * @idx_lebs: number of indexing LEBs
Artem Bityutskiyd3cf5022008-12-16 17:52:35 +0200496 * @total_free: total free space in bytes (includes all LEBs)
497 * @total_dirty: total dirty space in bytes (includes all LEBs)
498 * @total_used: total used space in bytes (does not include index LEBs)
499 * @total_dead: total dead space in bytes (does not include index LEBs)
500 * @total_dark: total dark space in bytes (does not include index LEBs)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300501 *
Artem Bityutskiyd3cf5022008-12-16 17:52:35 +0200502 * The @taken_empty_lebs field counts the LEBs that are in the transient state
503 * of having been "taken" for use but not yet written to. @taken_empty_lebs is
504 * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be
505 * used by itself (in which case 'unused_lebs' would be a better name). In the
506 * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained
507 * by GC, but unlike other empty LEBs that are "taken", it may not be written
508 * straight away (i.e. before the next commit start or unmount), so either
509 * @gc_lnum must be specially accounted for, or the current approach followed
510 * i.e. count it under @taken_empty_lebs.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300511 *
Artem Bityutskiyd3cf5022008-12-16 17:52:35 +0200512 * @empty_lebs includes @taken_empty_lebs.
513 *
514 * @total_used, @total_dead and @total_dark fields do not account indexing
515 * LEBs.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300516 */
517struct ubifs_lp_stats {
518 int empty_lebs;
519 int taken_empty_lebs;
520 int idx_lebs;
521 long long total_free;
522 long long total_dirty;
523 long long total_used;
524 long long total_dead;
525 long long total_dark;
526};
527
528struct ubifs_nnode;
529
530/**
531 * struct ubifs_cnode - LEB Properties Tree common node.
532 * @parent: parent nnode
533 * @cnext: next cnode to commit
534 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
535 * @iip: index in parent
536 * @level: level in the tree (zero for pnodes, greater than zero for nnodes)
537 * @num: node number
538 */
539struct ubifs_cnode {
540 struct ubifs_nnode *parent;
541 struct ubifs_cnode *cnext;
542 unsigned long flags;
543 int iip;
544 int level;
545 int num;
546};
547
548/**
549 * struct ubifs_pnode - LEB Properties Tree leaf node.
550 * @parent: parent nnode
551 * @cnext: next cnode to commit
552 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
553 * @iip: index in parent
554 * @level: level in the tree (always zero for pnodes)
555 * @num: node number
556 * @lprops: LEB properties array
557 */
558struct ubifs_pnode {
559 struct ubifs_nnode *parent;
560 struct ubifs_cnode *cnext;
561 unsigned long flags;
562 int iip;
563 int level;
564 int num;
565 struct ubifs_lprops lprops[UBIFS_LPT_FANOUT];
566};
567
568/**
569 * struct ubifs_nbranch - LEB Properties Tree internal node branch.
570 * @lnum: LEB number of child
571 * @offs: offset of child
572 * @nnode: nnode child
573 * @pnode: pnode child
574 * @cnode: cnode child
575 */
576struct ubifs_nbranch {
577 int lnum;
578 int offs;
579 union {
580 struct ubifs_nnode *nnode;
581 struct ubifs_pnode *pnode;
582 struct ubifs_cnode *cnode;
583 };
584};
585
586/**
587 * struct ubifs_nnode - LEB Properties Tree internal node.
588 * @parent: parent nnode
589 * @cnext: next cnode to commit
590 * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
591 * @iip: index in parent
592 * @level: level in the tree (always greater than zero for nnodes)
593 * @num: node number
594 * @nbranch: branches to child nodes
595 */
596struct ubifs_nnode {
597 struct ubifs_nnode *parent;
598 struct ubifs_cnode *cnext;
599 unsigned long flags;
600 int iip;
601 int level;
602 int num;
603 struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT];
604};
605
606/**
607 * struct ubifs_lpt_heap - heap of categorized lprops.
608 * @arr: heap array
609 * @cnt: number in heap
610 * @max_cnt: maximum number allowed in heap
611 *
612 * There are %LPROPS_HEAP_CNT heaps.
613 */
614struct ubifs_lpt_heap {
615 struct ubifs_lprops **arr;
616 int cnt;
617 int max_cnt;
618};
619
620/*
621 * Return codes for LPT scan callback function.
622 *
623 * LPT_SCAN_CONTINUE: continue scanning
624 * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory
625 * LPT_SCAN_STOP: stop scanning
626 */
627enum {
628 LPT_SCAN_CONTINUE = 0,
629 LPT_SCAN_ADD = 1,
630 LPT_SCAN_STOP = 2,
631};
632
633struct ubifs_info;
634
635/* Callback used by the 'ubifs_lpt_scan_nolock()' function */
636typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c,
637 const struct ubifs_lprops *lprops,
638 int in_tree, void *data);
639
640/**
641 * struct ubifs_wbuf - UBIFS write-buffer.
642 * @c: UBIFS file-system description object
643 * @buf: write-buffer (of min. flash I/O unit size)
644 * @lnum: logical eraseblock number the write-buffer points to
645 * @offs: write-buffer offset in this logical eraseblock
646 * @avail: number of bytes available in the write-buffer
647 * @used: number of used bytes in the write-buffer
Artem Bityutskiy3c89f392011-02-01 19:02:49 +0200648 * @size: write-buffer size (in [@c->min_io_size, @c->max_write_size] range)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300649 * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep
650 * up by 'mutex_lock_nested()).
651 * @sync_callback: write-buffer synchronization callback
652 * @io_mutex: serializes write-buffer I/O
653 * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes
654 * fields
655 * @timer: write-buffer timer
Adrian Hunter681947d2009-06-24 09:59:38 +0300656 * @no_timer: non-zero if this write-buffer does not have a timer
657 * @need_sync: non-zero if the timer expired and the wbuf needs sync'ing
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300658 * @next_ino: points to the next position of the following inode number
659 * @inodes: stores the inode numbers of the nodes which are in wbuf
660 *
661 * The write-buffer synchronization callback is called when the write-buffer is
662 * synchronized in order to notify how much space was wasted due to
663 * write-buffer padding and how much free space is left in the LEB.
664 *
665 * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under
666 * spin-lock or mutex because they are written under both mutex and spin-lock.
667 * @buf is appended to under mutex but overwritten under both mutex and
668 * spin-lock. Thus the data between @buf and @buf + @used can be read under
669 * spinlock.
670 */
671struct ubifs_wbuf {
672 struct ubifs_info *c;
673 void *buf;
674 int lnum;
675 int offs;
676 int avail;
677 int used;
Artem Bityutskiy3c89f392011-02-01 19:02:49 +0200678 int size;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300679 int jhead;
680 int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad);
681 struct mutex io_mutex;
682 spinlock_t lock;
Artem Bityutskiyf2c5dbd2009-05-28 16:24:15 +0300683 struct hrtimer timer;
Artem Bityutskiy0b335b92009-06-23 12:30:43 +0300684 unsigned int no_timer:1;
685 unsigned int need_sync:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300686 int next_ino;
687 ino_t *inodes;
688};
689
690/**
691 * struct ubifs_bud - bud logical eraseblock.
692 * @lnum: logical eraseblock number
693 * @start: where the (uncommitted) bud data starts
694 * @jhead: journal head number this bud belongs to
695 * @list: link in the list buds belonging to the same journal head
696 * @rb: link in the tree of all buds
697 */
698struct ubifs_bud {
699 int lnum;
700 int start;
701 int jhead;
702 struct list_head list;
703 struct rb_node rb;
704};
705
706/**
707 * struct ubifs_jhead - journal head.
708 * @wbuf: head's write-buffer
709 * @buds_list: list of bud LEBs belonging to this journal head
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300710 * @grouped: non-zero if UBIFS groups nodes when writing to this journal head
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300711 *
712 * Note, the @buds list is protected by the @c->buds_lock.
713 */
714struct ubifs_jhead {
715 struct ubifs_wbuf wbuf;
716 struct list_head buds_list;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300717 unsigned int grouped:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300718};
719
720/**
721 * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
722 * @key: key
723 * @znode: znode address in memory
Artem Bityutskiybe616782008-09-08 18:08:39 +0300724 * @lnum: LEB number of the target node (indexing node or data node)
725 * @offs: target node offset within @lnum
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300726 * @len: target node length
727 */
728struct ubifs_zbranch {
729 union ubifs_key key;
730 union {
731 struct ubifs_znode *znode;
732 void *leaf;
733 };
734 int lnum;
735 int offs;
736 int len;
737};
738
739/**
740 * struct ubifs_znode - in-memory representation of an indexing node.
741 * @parent: parent znode or NULL if it is the root
742 * @cnext: next znode to commit
743 * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE)
744 * @time: last access time (seconds)
745 * @level: level of the entry in the TNC tree
746 * @child_cnt: count of child znodes
747 * @iip: index in parent's zbranch array
748 * @alt: lower bound of key range has altered i.e. child inserted at slot 0
749 * @lnum: LEB number of the corresponding indexing node
750 * @offs: offset of the corresponding indexing node
751 * @len: length of the corresponding indexing node
752 * @zbranch: array of znode branches (@c->fanout elements)
Artem Bityutskiyf70b7e52012-05-16 19:53:46 +0300753 *
754 * Note! The @lnum, @offs, and @len fields are not really needed - we have them
755 * only for internal consistency check. They could be removed to save some RAM.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300756 */
757struct ubifs_znode {
758 struct ubifs_znode *parent;
759 struct ubifs_znode *cnext;
760 unsigned long flags;
761 unsigned long time;
762 int level;
763 int child_cnt;
764 int iip;
765 int alt;
Artem Bityutskiyf70b7e52012-05-16 19:53:46 +0300766 int lnum;
767 int offs;
768 int len;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300769 struct ubifs_zbranch zbranch[];
770};
771
772/**
Artem Bityutskiy39ce81c2008-11-18 18:09:49 +0200773 * struct bu_info - bulk-read information.
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300774 * @key: first data node key
775 * @zbranch: zbranches of data nodes to bulk read
776 * @buf: buffer to read into
777 * @buf_len: buffer length
778 * @gc_seq: GC sequence number to detect races with GC
779 * @cnt: number of data nodes for bulk read
780 * @blk_cnt: number of data blocks including holes
781 * @oef: end of file reached
782 */
783struct bu_info {
784 union ubifs_key key;
785 struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ];
786 void *buf;
787 int buf_len;
788 int gc_seq;
789 int cnt;
790 int blk_cnt;
791 int eof;
792};
793
794/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300795 * struct ubifs_node_range - node length range description data structure.
796 * @len: fixed node length
797 * @min_len: minimum possible node length
798 * @max_len: maximum possible node length
799 *
800 * If @max_len is %0, the node has fixed length @len.
801 */
802struct ubifs_node_range {
803 union {
804 int len;
805 int min_len;
806 };
807 int max_len;
808};
809
810/**
811 * struct ubifs_compressor - UBIFS compressor description structure.
812 * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc)
813 * @cc: cryptoapi compressor handle
814 * @comp_mutex: mutex used during compression
815 * @decomp_mutex: mutex used during decompression
816 * @name: compressor name
817 * @capi_name: cryptoapi compressor name
818 */
819struct ubifs_compressor {
820 int compr_type;
821 struct crypto_comp *cc;
822 struct mutex *comp_mutex;
823 struct mutex *decomp_mutex;
824 const char *name;
825 const char *capi_name;
826};
827
828/**
829 * struct ubifs_budget_req - budget requirements of an operation.
830 *
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300831 * @fast: non-zero if the budgeting should try to acquire budget quickly and
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300832 * should not try to call write-back
833 * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields
834 * have to be re-calculated
835 * @new_page: non-zero if the operation adds a new page
836 * @dirtied_page: non-zero if the operation makes a page dirty
837 * @new_dent: non-zero if the operation adds a new directory entry
838 * @mod_dent: non-zero if the operation removes or modifies an existing
839 * directory entry
840 * @new_ino: non-zero if the operation adds a new inode
Dongsheng Yang7d25b362015-07-30 13:48:09 +0800841 * @new_ino_d: how much data newly created inode contains
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300842 * @dirtied_ino: how many inodes the operation makes dirty
Dongsheng Yang7d25b362015-07-30 13:48:09 +0800843 * @dirtied_ino_d: how much data dirtied inode contains
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300844 * @idx_growth: how much the index will supposedly grow
845 * @data_growth: how much new data the operation will supposedly add
846 * @dd_growth: how much data that makes other data dirty the operation will
847 * supposedly add
848 *
849 * @idx_growth, @data_growth and @dd_growth are not used in budget request. The
850 * budgeting subsystem caches index and data growth values there to avoid
851 * re-calculating them when the budget is released. However, if @idx_growth is
852 * %-1, it is calculated by the release function using other fields.
853 *
854 * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d
855 * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made
856 * dirty by the re-name operation.
Artem Bityutskiydab4b4d2008-07-24 14:52:45 +0300857 *
858 * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to
859 * make sure the amount of inode data which contribute to @new_ino_d and
860 * @dirtied_ino_d fields are aligned.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300861 */
862struct ubifs_budget_req {
863 unsigned int fast:1;
864 unsigned int recalculate:1;
Artem Bityutskiy547000d2008-07-24 14:42:05 +0300865#ifndef UBIFS_DEBUG
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300866 unsigned int new_page:1;
867 unsigned int dirtied_page:1;
868 unsigned int new_dent:1;
869 unsigned int mod_dent:1;
870 unsigned int new_ino:1;
871 unsigned int new_ino_d:13;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300872 unsigned int dirtied_ino:4;
873 unsigned int dirtied_ino_d:15;
874#else
875 /* Not bit-fields to check for overflows */
Artem Bityutskiy547000d2008-07-24 14:42:05 +0300876 unsigned int new_page;
877 unsigned int dirtied_page;
878 unsigned int new_dent;
879 unsigned int mod_dent;
880 unsigned int new_ino;
881 unsigned int new_ino_d;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300882 unsigned int dirtied_ino;
883 unsigned int dirtied_ino_d;
884#endif
885 int idx_growth;
886 int data_growth;
887 int dd_growth;
888};
889
890/**
891 * struct ubifs_orphan - stores the inode number of an orphan.
892 * @rb: rb-tree node of rb-tree of orphans sorted by inode number
893 * @list: list head of list of orphans in order added
894 * @new_list: list head of list of orphans added since the last commit
895 * @cnext: next orphan to commit
896 * @dnext: next orphan to delete
897 * @inum: inode number
898 * @new: %1 => added since the last commit, otherwise %0
Adam Thomas2928f0d2013-02-02 22:32:31 +0000899 * @cmt: %1 => commit pending, otherwise %0
Adam Thomas8afd5002013-02-02 22:35:08 +0000900 * @del: %1 => delete pending, otherwise %0
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300901 */
902struct ubifs_orphan {
903 struct rb_node rb;
904 struct list_head list;
905 struct list_head new_list;
906 struct ubifs_orphan *cnext;
907 struct ubifs_orphan *dnext;
908 ino_t inum;
Adam Thomas2928f0d2013-02-02 22:32:31 +0000909 unsigned new:1;
910 unsigned cmt:1;
Adam Thomas8afd5002013-02-02 22:35:08 +0000911 unsigned del:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300912};
913
914/**
915 * struct ubifs_mount_opts - UBIFS-specific mount options information.
916 * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
Yannick Guerrinid3f9db02015-03-06 23:14:39 +0100917 * @bulk_read: enable/disable bulk-reads (%0 default, %1 disable, %2 enable)
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200918 * @chk_data_crc: enable/disable CRC data checking when reading data nodes
Yannick Guerrinid3f9db02015-03-06 23:14:39 +0100919 * (%0 default, %1 disable, %2 enable)
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200920 * @override_compr: override default compressor (%0 - do not override and use
921 * superblock compressor, %1 - override and use compressor
922 * specified in @compr_type)
923 * @compr_type: compressor type to override the superblock compressor with
924 * (%UBIFS_COMPR_NONE, etc)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300925 */
926struct ubifs_mount_opts {
927 unsigned int unmount_mode:2;
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300928 unsigned int bulk_read:2;
Adrian Hunter2953e732008-09-04 16:26:00 +0300929 unsigned int chk_data_crc:2;
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200930 unsigned int override_compr:1;
931 unsigned int compr_type:2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300932};
933
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300934/**
935 * struct ubifs_budg_info - UBIFS budgeting information.
936 * @idx_growth: amount of bytes budgeted for index growth
937 * @data_growth: amount of bytes budgeted for cached data
938 * @dd_growth: amount of bytes budgeted for cached data that will make
939 * other data dirty
940 * @uncommitted_idx: amount of bytes were budgeted for growth of the index, but
941 * which still have to be taken into account because the index
942 * has not been committed so far
943 * @old_idx_sz: size of index on flash
944 * @min_idx_lebs: minimum number of LEBs required for the index
945 * @nospace: non-zero if the file-system does not have flash space (used as
946 * optimization)
947 * @nospace_rp: the same as @nospace, but additionally means that even reserved
948 * pool is full
Yannick Guerrinid3f9db02015-03-06 23:14:39 +0100949 * @page_budget: budget for a page (constant, never changed after mount)
950 * @inode_budget: budget for an inode (constant, never changed after mount)
951 * @dent_budget: budget for a directory entry (constant, never changed after
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300952 * mount)
953 */
954struct ubifs_budg_info {
955 long long idx_growth;
956 long long data_growth;
957 long long dd_growth;
958 long long uncommitted_idx;
959 unsigned long long old_idx_sz;
960 int min_idx_lebs;
961 unsigned int nospace:1;
962 unsigned int nospace_rp:1;
963 int page_budget;
964 int inode_budget;
965 int dent_budget;
966};
967
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +0300968struct ubifs_debug_info;
969
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300970/**
971 * struct ubifs_info - UBIFS file-system description data structure
972 * (per-superblock).
973 * @vfs_sb: VFS @struct super_block object
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300974 *
975 * @highest_inum: highest used inode number
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300976 * @max_sqnum: current global sequence number
Artem Bityutskiy014eb042008-07-21 17:14:29 +0300977 * @cmt_no: commit number of the last successfully completed commit, protected
978 * by @commit_sem
Adrian Hunter81ffa382008-08-01 15:35:08 +0300979 * @cnt_lock: protects @highest_inum and @max_sqnum counters
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300980 * @fmt_version: UBIFS on-flash format version
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +0200981 * @ro_compat_version: R/O compatibility version
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300982 * @uuid: UUID from super block
983 *
984 * @lhead_lnum: log head logical eraseblock number
985 * @lhead_offs: log head offset
986 * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
987 * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
988 * @bud_bytes
989 * @min_log_bytes: minimum required number of bytes in the log
990 * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
991 * committed buds
992 *
993 * @buds: tree of all buds indexed by bud LEB number
994 * @bud_bytes: how many bytes of flash is used by buds
995 * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
996 * lists
997 * @jhead_cnt: count of journal heads
998 * @jheads: journal heads (head zero is base head)
999 * @max_bud_bytes: maximum number of bytes allowed in buds
1000 * @bg_bud_bytes: number of bud bytes when background commit is initiated
1001 * @old_buds: buds to be released after commit ends
1002 * @max_bud_cnt: maximum number of buds
1003 *
1004 * @commit_sem: synchronizes committer with other processes
1005 * @cmt_state: commit state
1006 * @cs_lock: commit state lock
1007 * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
Artem Bityutskiy625bf372008-09-08 16:13:38 +03001008 *
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001009 * @big_lpt: flag that LPT is too big to write whole during commit
Matthew L. Creech9f58d352011-05-05 16:33:20 -04001010 * @space_fixup: flag indicating that free space in LEBs needs to be cleaned up
Richard Weinbergerd63d61c2016-10-19 15:59:12 +02001011 * @double_hash: flag indicating that we can do lookups by hash
Richard Weinbergere0219862016-10-19 23:24:47 +02001012 * @encrypted: flag indicating that this file system contains encrypted files
Artem Bityutskiy625bf372008-09-08 16:13:38 +03001013 * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
1014 * recovery)
1015 * @bulk_read: enable bulk-reads
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02001016 * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001017 * @rw_incompat: the media is not R/W compatible
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001018 *
1019 * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
1020 * @calc_idx_sz
1021 * @zroot: zbranch which points to the root index node and znode
1022 * @cnext: next znode to commit
1023 * @enext: next znode to commit to empty space
1024 * @gap_lebs: array of LEBs used by the in-gaps commit method
1025 * @cbuf: commit buffer
1026 * @ileb_buf: buffer for commit in-the-gaps method
1027 * @ileb_len: length of data in ileb_buf
1028 * @ihead_lnum: LEB number of index head
1029 * @ihead_offs: offset of index head
1030 * @ilebs: pre-allocated index LEBs
1031 * @ileb_cnt: number of pre-allocated index LEBs
1032 * @ileb_nxt: next pre-allocated index LEBs
1033 * @old_idx: tree of index nodes obsoleted since the last commit start
1034 * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001035 *
1036 * @mst_node: master node
1037 * @mst_offs: offset of valid master node
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001038 *
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +02001039 * @max_bu_buf_len: maximum bulk-read buffer length
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001040 * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
1041 * @bu: pre-allocated bulk-read information
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001042 *
Matthew L. Creechd8829622011-03-04 17:55:02 -05001043 * @write_reserve_mutex: protects @write_reserve_buf
1044 * @write_reserve_buf: on the write path we allocate memory, which might
1045 * sometimes be unavailable, in which case we use this
1046 * write reserve buffer
1047 *
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001048 * @log_lebs: number of logical eraseblocks in the log
1049 * @log_bytes: log size in bytes
1050 * @log_last: last LEB of the log
1051 * @lpt_lebs: number of LEBs used for lprops table
1052 * @lpt_first: first LEB of the lprops table area
1053 * @lpt_last: last LEB of the lprops table area
1054 * @orph_lebs: number of LEBs used for the orphan area
1055 * @orph_first: first LEB of the orphan area
1056 * @orph_last: last LEB of the orphan area
1057 * @main_lebs: count of LEBs in the main area
1058 * @main_first: first LEB of the main area
1059 * @main_bytes: main area size in bytes
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001060 *
1061 * @key_hash_type: type of the key hash
1062 * @key_hash: direntry key hash function
1063 * @key_fmt: key format
1064 * @key_len: key length
1065 * @fanout: fanout of the index tree (number of links per indexing node)
1066 *
1067 * @min_io_size: minimal input/output unit size
1068 * @min_io_shift: number of bits in @min_io_size minus one
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +02001069 * @max_write_size: maximum amount of bytes the underlying flash can write at a
1070 * time (MTD write buffer size)
1071 * @max_write_shift: number of bits in @max_write_size minus one
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001072 * @leb_size: logical eraseblock size in bytes
Artem Bityutskiyca2ec612011-02-14 15:17:55 +02001073 * @leb_start: starting offset of logical eraseblocks within physical
1074 * eraseblocks
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001075 * @half_leb_size: half LEB size
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +02001076 * @idx_leb_size: how many bytes of an LEB are effectively available when it is
1077 * used to store indexing nodes (@leb_size - @max_idx_node_sz)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001078 * @leb_cnt: count of logical eraseblocks
1079 * @max_leb_cnt: maximum count of logical eraseblocks
1080 * @old_leb_cnt: count of logical eraseblocks before re-size
1081 * @ro_media: the underlying UBI volume is read-only
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001082 * @ro_mount: the file-system was mounted as read-only
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001083 * @ro_error: UBIFS switched to R/O mode because an error happened
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001084 *
1085 * @dirty_pg_cnt: number of dirty pages (not used)
1086 * @dirty_zn_cnt: number of dirty znodes
1087 * @clean_zn_cnt: number of clean znodes
1088 *
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001089 * @space_lock: protects @bi and @lst
1090 * @lst: lprops statistics
1091 * @bi: budgeting information
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001092 * @calc_idx_sz: temporary variable which is used to calculate new index size
1093 * (contains accurate new index size at end of TNC commit start)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001094 *
1095 * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001096 * I/O unit
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001097 * @mst_node_alsz: master node aligned size
1098 * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
1099 * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
1100 * @max_inode_sz: maximum possible inode size in bytes
1101 * @max_znode_sz: size of znode in bytes
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +03001102 *
1103 * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
1104 * data nodes of maximum size - used in free space reporting
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001105 * @dead_wm: LEB dead space watermark
1106 * @dark_wm: LEB dark space watermark
1107 * @block_cnt: count of 4KiB blocks on the FS
1108 *
1109 * @ranges: UBIFS node length ranges
1110 * @ubi: UBI volume descriptor
1111 * @di: UBI device information
1112 * @vi: UBI volume information
1113 *
1114 * @orph_tree: rb-tree of orphan inode numbers
1115 * @orph_list: list of orphan inode numbers in order added
1116 * @orph_new: list of orphan inode numbers added since last commit
1117 * @orph_cnext: next orphan to commit
1118 * @orph_dnext: next orphan to delete
1119 * @orphan_lock: lock for orph_tree and orph_new
1120 * @orph_buf: buffer for orphan nodes
1121 * @new_orphans: number of orphans since last commit
1122 * @cmt_orphans: number of orphans being committed
1123 * @tot_orphans: number of orphans in the rb_tree
1124 * @max_orphans: maximum number of orphans allowed
1125 * @ohead_lnum: orphan head LEB number
1126 * @ohead_offs: orphan head offset
1127 * @no_orphs: non-zero if there are no orphans
1128 *
1129 * @bgt: UBIFS background thread
1130 * @bgt_name: background thread name
1131 * @need_bgt: if background thread should run
1132 * @need_wbuf_sync: if write-buffers have to be synchronized
1133 *
1134 * @gc_lnum: LEB number used for garbage collection
1135 * @sbuf: a buffer of LEB size used by GC and replay for scanning
1136 * @idx_gc: list of index LEBs that have been garbage collected
1137 * @idx_gc_cnt: number of elements on the idx_gc list
Adrian Hunter601c0bc2008-08-22 14:23:35 +03001138 * @gc_seq: incremented for every non-index LEB garbage collected
1139 * @gced_lnum: last non-index LEB that was garbage collected
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001140 *
1141 * @infos_list: links all 'ubifs_info' objects
1142 * @umount_mutex: serializes shrinker and un-mount
1143 * @shrinker_run_no: shrinker run number
1144 *
1145 * @space_bits: number of bits needed to record free or dirty space
1146 * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
1147 * @lpt_offs_bits: number of bits needed to record an offset in the LPT
1148 * @lpt_spc_bits: number of bits needed to space in the LPT
1149 * @pcnt_bits: number of bits needed to record pnode or nnode number
1150 * @lnum_bits: number of bits needed to record LEB number
1151 * @nnode_sz: size of on-flash nnode
1152 * @pnode_sz: size of on-flash pnode
1153 * @ltab_sz: size of on-flash LPT lprops table
1154 * @lsave_sz: size of on-flash LPT save table
1155 * @pnode_cnt: number of pnodes
1156 * @nnode_cnt: number of nnodes
1157 * @lpt_hght: height of the LPT
1158 * @pnodes_have: number of pnodes in memory
1159 *
1160 * @lp_mutex: protects lprops table and all the other lprops-related fields
1161 * @lpt_lnum: LEB number of the root nnode of the LPT
1162 * @lpt_offs: offset of the root nnode of the LPT
1163 * @nhead_lnum: LEB number of LPT head
1164 * @nhead_offs: offset of LPT head
1165 * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
1166 * @dirty_nn_cnt: number of dirty nnodes
1167 * @dirty_pn_cnt: number of dirty pnodes
Adrian Hunter73944a62008-09-12 18:13:31 +03001168 * @check_lpt_free: flag that indicates LPT GC may be needed
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001169 * @lpt_sz: LPT size
1170 * @lpt_nod_buf: buffer for an on-flash nnode or pnode
1171 * @lpt_buf: buffer of LEB size used by LPT
1172 * @nroot: address in memory of the root nnode of the LPT
1173 * @lpt_cnext: next LPT node to commit
1174 * @lpt_heap: array of heaps of categorized lprops
1175 * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
1176 * previous commit start
1177 * @uncat_list: list of un-categorized LEBs
1178 * @empty_list: list of empty LEBs
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +02001179 * @freeable_list: list of freeable non-index LEBs (free + dirty == @leb_size)
1180 * @frdi_idx_list: list of freeable index LEBs (free + dirty == @leb_size)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001181 * @freeable_cnt: number of freeable LEBs in @freeable_list
Artem Bityutskiy98a1eeb2012-10-10 10:55:28 +03001182 * @in_a_category_cnt: count of lprops which are in a certain category, which
1183 * basically meants that they were loaded from the flash
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001184 *
1185 * @ltab_lnum: LEB number of LPT's own lprops table
1186 * @ltab_offs: offset of LPT's own lprops table
1187 * @ltab: LPT's own lprops table
1188 * @ltab_cmt: LPT's own lprops table (commit copy)
1189 * @lsave_cnt: number of LEB numbers in LPT's save table
1190 * @lsave_lnum: LEB number of LPT's save table
1191 * @lsave_offs: offset of LPT's save table
1192 * @lsave: LPT's save table
1193 * @lscan_lnum: LEB number of last LPT scan
1194 *
1195 * @rp_size: size of the reserved pool in bytes
1196 * @report_rp_size: size of the reserved pool reported to user-space
1197 * @rp_uid: reserved pool user ID
1198 * @rp_gid: reserved pool group ID
1199 *
Artem Bityutskiyd8cdda32011-01-17 20:27:45 +02001200 * @empty: %1 if the UBI device is empty
1201 * @need_recovery: %1 if the file-system needs recovery
1202 * @replaying: %1 during journal replay
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001203 * @mounting: %1 while mounting
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001204 * @probing: %1 while attempting to mount if SB_SILENT mount flag is set
Artem Bityutskiyd8cdda32011-01-17 20:27:45 +02001205 * @remounting_rw: %1 while re-mounting from R/O mode to R/W mode
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001206 * @replay_list: temporary list used during journal replay
1207 * @replay_buds: list of buds to replay
1208 * @cs_sqnum: sequence number of first node in the log (commit start node)
1209 * @replay_sqnum: sequence number of node currently being replayed
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001210 * @unclean_leb_list: LEBs to recover when re-mounting R/O mounted FS to R/W
1211 * mode
1212 * @rcvrd_mst_node: recovered master node to write when re-mounting R/O mounted
1213 * FS to R/W mode
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001214 * @size_tree: inode size information for recovery
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001215 * @mount_opts: UBIFS-specific mount options
1216 *
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001217 * @dbg: debugging-related information
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001218 */
1219struct ubifs_info {
1220 struct super_block *vfs_sb;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001221
1222 ino_t highest_inum;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001223 unsigned long long max_sqnum;
1224 unsigned long long cmt_no;
1225 spinlock_t cnt_lock;
1226 int fmt_version;
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001227 int ro_compat_version;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001228 unsigned char uuid[16];
1229
1230 int lhead_lnum;
1231 int lhead_offs;
1232 int ltail_lnum;
1233 struct mutex log_mutex;
1234 int min_log_bytes;
1235 long long cmt_bud_bytes;
1236
1237 struct rb_root buds;
1238 long long bud_bytes;
1239 spinlock_t buds_lock;
1240 int jhead_cnt;
1241 struct ubifs_jhead *jheads;
1242 long long max_bud_bytes;
1243 long long bg_bud_bytes;
1244 struct list_head old_buds;
1245 int max_bud_cnt;
1246
1247 struct rw_semaphore commit_sem;
1248 int cmt_state;
1249 spinlock_t cs_lock;
1250 wait_queue_head_t cmt_wq;
Artem Bityutskiy625bf372008-09-08 16:13:38 +03001251
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001252 unsigned int big_lpt:1;
Matthew L. Creech9f58d352011-05-05 16:33:20 -04001253 unsigned int space_fixup:1;
Richard Weinbergerd63d61c2016-10-19 15:59:12 +02001254 unsigned int double_hash:1;
Richard Weinbergere0219862016-10-19 23:24:47 +02001255 unsigned int encrypted:1;
Artem Bityutskiy625bf372008-09-08 16:13:38 +03001256 unsigned int no_chk_data_crc:1;
1257 unsigned int bulk_read:1;
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02001258 unsigned int default_compr:2;
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001259 unsigned int rw_incompat:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001260
1261 struct mutex tnc_mutex;
1262 struct ubifs_zbranch zroot;
1263 struct ubifs_znode *cnext;
1264 struct ubifs_znode *enext;
1265 int *gap_lebs;
1266 void *cbuf;
1267 void *ileb_buf;
1268 int ileb_len;
1269 int ihead_lnum;
1270 int ihead_offs;
1271 int *ilebs;
1272 int ileb_cnt;
1273 int ileb_nxt;
1274 struct rb_root old_idx;
1275 int *bottom_up_buf;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001276
1277 struct ubifs_mst_node *mst_node;
1278 int mst_offs;
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001279
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +02001280 int max_bu_buf_len;
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001281 struct mutex bu_mutex;
1282 struct bu_info bu;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001283
Matthew L. Creechd8829622011-03-04 17:55:02 -05001284 struct mutex write_reserve_mutex;
1285 void *write_reserve_buf;
1286
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001287 int log_lebs;
1288 long long log_bytes;
1289 int log_last;
1290 int lpt_lebs;
1291 int lpt_first;
1292 int lpt_last;
1293 int orph_lebs;
1294 int orph_first;
1295 int orph_last;
1296 int main_lebs;
1297 int main_first;
1298 long long main_bytes;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001299
1300 uint8_t key_hash_type;
1301 uint32_t (*key_hash)(const char *str, int len);
1302 int key_fmt;
1303 int key_len;
1304 int fanout;
1305
1306 int min_io_size;
1307 int min_io_shift;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +02001308 int max_write_size;
1309 int max_write_shift;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001310 int leb_size;
Artem Bityutskiyca2ec612011-02-14 15:17:55 +02001311 int leb_start;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001312 int half_leb_size;
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +02001313 int idx_leb_size;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001314 int leb_cnt;
1315 int max_leb_cnt;
1316 int old_leb_cnt;
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001317 unsigned int ro_media:1;
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001318 unsigned int ro_mount:1;
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001319 unsigned int ro_error:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001320
1321 atomic_long_t dirty_pg_cnt;
1322 atomic_long_t dirty_zn_cnt;
1323 atomic_long_t clean_zn_cnt;
1324
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001325 spinlock_t space_lock;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001326 struct ubifs_lp_stats lst;
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001327 struct ubifs_budg_info bi;
1328 unsigned long long calc_idx_sz;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001329
1330 int ref_node_alsz;
1331 int mst_node_alsz;
1332 int min_idx_node_sz;
1333 int max_idx_node_sz;
1334 long long max_inode_sz;
1335 int max_znode_sz;
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +03001336
1337 int leb_overhead;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001338 int dead_wm;
1339 int dark_wm;
1340 int block_cnt;
1341
1342 struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
1343 struct ubi_volume_desc *ubi;
1344 struct ubi_device_info di;
1345 struct ubi_volume_info vi;
1346
1347 struct rb_root orph_tree;
1348 struct list_head orph_list;
1349 struct list_head orph_new;
1350 struct ubifs_orphan *orph_cnext;
1351 struct ubifs_orphan *orph_dnext;
1352 spinlock_t orphan_lock;
1353 void *orph_buf;
1354 int new_orphans;
1355 int cmt_orphans;
1356 int tot_orphans;
1357 int max_orphans;
1358 int ohead_lnum;
1359 int ohead_offs;
1360 int no_orphs;
1361
1362 struct task_struct *bgt;
1363 char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
1364 int need_bgt;
1365 int need_wbuf_sync;
1366
1367 int gc_lnum;
1368 void *sbuf;
1369 struct list_head idx_gc;
1370 int idx_gc_cnt;
Artem Bityutskiyf92b9822008-12-28 11:34:26 +02001371 int gc_seq;
1372 int gced_lnum;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001373
1374 struct list_head infos_list;
1375 struct mutex umount_mutex;
1376 unsigned int shrinker_run_no;
1377
1378 int space_bits;
1379 int lpt_lnum_bits;
1380 int lpt_offs_bits;
1381 int lpt_spc_bits;
1382 int pcnt_bits;
1383 int lnum_bits;
1384 int nnode_sz;
1385 int pnode_sz;
1386 int ltab_sz;
1387 int lsave_sz;
1388 int pnode_cnt;
1389 int nnode_cnt;
1390 int lpt_hght;
1391 int pnodes_have;
1392
1393 struct mutex lp_mutex;
1394 int lpt_lnum;
1395 int lpt_offs;
1396 int nhead_lnum;
1397 int nhead_offs;
1398 int lpt_drty_flgs;
1399 int dirty_nn_cnt;
1400 int dirty_pn_cnt;
Adrian Hunter73944a62008-09-12 18:13:31 +03001401 int check_lpt_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001402 long long lpt_sz;
1403 void *lpt_nod_buf;
1404 void *lpt_buf;
1405 struct ubifs_nnode *nroot;
1406 struct ubifs_cnode *lpt_cnext;
1407 struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
1408 struct ubifs_lpt_heap dirty_idx;
1409 struct list_head uncat_list;
1410 struct list_head empty_list;
1411 struct list_head freeable_list;
1412 struct list_head frdi_idx_list;
1413 int freeable_cnt;
Artem Bityutskiy98a1eeb2012-10-10 10:55:28 +03001414 int in_a_category_cnt;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001415
1416 int ltab_lnum;
1417 int ltab_offs;
1418 struct ubifs_lpt_lprops *ltab;
1419 struct ubifs_lpt_lprops *ltab_cmt;
1420 int lsave_cnt;
1421 int lsave_lnum;
1422 int lsave_offs;
1423 int *lsave;
1424 int lscan_lnum;
1425
1426 long long rp_size;
1427 long long report_rp_size;
Eric W. Biederman39241be2012-02-07 15:50:56 -08001428 kuid_t rp_uid;
1429 kgid_t rp_gid;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001430
1431 /* The below fields are used only during mounting and re-mounting */
Artem Bityutskiyd8cdda32011-01-17 20:27:45 +02001432 unsigned int empty:1;
1433 unsigned int need_recovery:1;
1434 unsigned int replaying:1;
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001435 unsigned int mounting:1;
Artem Bityutskiyd8cdda32011-01-17 20:27:45 +02001436 unsigned int remounting_rw:1;
Daniel Golle90bea5a32014-06-02 15:51:10 +02001437 unsigned int probing:1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001438 struct list_head replay_list;
1439 struct list_head replay_buds;
1440 unsigned long long cs_sqnum;
1441 unsigned long long replay_sqnum;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001442 struct list_head unclean_leb_list;
1443 struct ubifs_mst_node *rcvrd_mst_node;
1444 struct rb_root size_tree;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001445 struct ubifs_mount_opts mount_opts;
1446
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001447 struct ubifs_debug_info *dbg;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001448};
1449
1450extern struct list_head ubifs_infos;
1451extern spinlock_t ubifs_infos_lock;
1452extern atomic_long_t ubifs_clean_zn_cnt;
Artem Bityutskiye8b81562009-01-15 17:43:23 +02001453extern const struct super_operations ubifs_super_operations;
1454extern const struct address_space_operations ubifs_file_address_operations;
1455extern const struct file_operations ubifs_file_operations;
1456extern const struct inode_operations ubifs_file_inode_operations;
1457extern const struct file_operations ubifs_dir_operations;
1458extern const struct inode_operations ubifs_dir_inode_operations;
1459extern const struct inode_operations ubifs_symlink_inode_operations;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001460extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
1461
1462/* io.c */
Adrian Hunterff46d7b2008-07-21 15:39:05 +03001463void ubifs_ro_mode(struct ubifs_info *c, int err);
Artem Bityutskiy83cef702011-06-03 13:45:09 +03001464int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs,
1465 int len, int even_ebadmsg);
1466int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001467 int len);
1468int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
Artem Bityutskiy83cef702011-06-03 13:45:09 +03001469int ubifs_leb_unmap(struct ubifs_info *c, int lnum);
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001470int ubifs_leb_map(struct ubifs_info *c, int lnum);
Artem Bityutskiy83cef702011-06-03 13:45:09 +03001471int ubifs_is_mapped(const struct ubifs_info *c, int lnum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001472int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001473int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001474int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
1475int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
1476 int lnum, int offs);
1477int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
1478 int lnum, int offs);
1479int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001480 int offs);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001481int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
Artem Bityutskiy6f7ab6d2009-01-27 16:12:31 +02001482 int offs, int quiet, int must_chk_crc);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001483void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
1484void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
1485int ubifs_io_init(struct ubifs_info *c);
1486void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
1487int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
1488int ubifs_bg_wbufs_sync(struct ubifs_info *c);
1489void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
1490int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
1491
1492/* scan.c */
1493struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
Artem Bityutskiy348709b2009-08-25 15:00:55 +03001494 int offs, void *sbuf, int quiet);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001495void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
1496int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
1497 int offs, int quiet);
1498struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
1499 int offs, void *sbuf);
1500void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1501 int lnum, int offs);
1502int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1503 void *buf, int offs);
1504void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
1505 void *buf);
1506
1507/* log.c */
1508void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
1509void ubifs_create_buds_lists(struct ubifs_info *c);
1510int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
1511struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
1512struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
1513int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
1514int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
1515int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
1516int ubifs_consolidate_log(struct ubifs_info *c);
1517
1518/* journal.c */
1519int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001520 const struct fscrypt_name *nm, const struct inode *inode,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001521 int deletion, int xent);
1522int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
1523 const union ubifs_key *key, const void *buf, int len);
Artem Bityutskiy1f286812008-07-22 12:06:13 +03001524int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
Artem Bityutskiyde94eb52008-07-22 13:06:20 +03001525int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
Richard Weinberger9ec64962016-09-14 22:28:51 +02001526int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001527 const struct inode *fst_inode,
1528 const struct fscrypt_name *fst_nm,
Richard Weinberger9ec64962016-09-14 22:28:51 +02001529 const struct inode *snd_dir,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001530 const struct inode *snd_inode,
1531 const struct fscrypt_name *snd_nm, int sync);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001532int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001533 const struct inode *old_inode,
1534 const struct fscrypt_name *old_nm,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001535 const struct inode *new_dir,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001536 const struct inode *new_inode,
1537 const struct fscrypt_name *new_nm,
Richard Weinberger9e0a1ff2016-09-14 22:28:50 +02001538 const struct inode *whiteout, int sync);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001539int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
1540 loff_t old_size, loff_t new_size);
1541int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001542 const struct inode *inode, const struct fscrypt_name *nm);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001543int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
1544 const struct inode *inode2);
1545
1546/* budget.c */
1547int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
1548void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
1549void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
1550 struct ubifs_inode *ui);
1551int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
1552 struct ubifs_budget_req *req);
1553void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
1554 struct ubifs_budget_req *req);
1555void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
1556 struct ubifs_budget_req *req);
Artem Bityutskiy7dad1812008-08-25 18:58:19 +03001557long long ubifs_get_free_space(struct ubifs_info *c);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001558long long ubifs_get_free_space_nolock(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001559int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
1560void ubifs_convert_page_budget(struct ubifs_info *c);
Artem Bityutskiy4d61db42008-12-18 14:06:51 +02001561long long ubifs_reported_space(const struct ubifs_info *c, long long free);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001562long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
1563
1564/* find.c */
Artem Bityutskiy3edaae72009-03-03 19:22:53 +02001565int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001566 int squeeze);
1567int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
1568int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
1569 int min_space, int pick_free);
1570int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
1571int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
1572
1573/* tnc.c */
1574int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
1575 struct ubifs_znode **zn, int *n);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001576int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001577 void *node, const struct fscrypt_name *nm);
Richard Weinberger528e3d12016-11-11 20:46:06 +01001578int ubifs_tnc_lookup_dh(struct ubifs_info *c, const union ubifs_key *key,
1579 void *node, uint32_t secondary_hash);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001580int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
1581 void *node, int *lnum, int *offs);
1582int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
1583 int offs, int len);
1584int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
1585 int old_lnum, int old_offs, int lnum, int offs, int len);
1586int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001587 int lnum, int offs, int len, const struct fscrypt_name *nm);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001588int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
1589int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001590 const struct fscrypt_name *nm);
Richard Weinberger781f6752017-05-17 10:36:46 +02001591int ubifs_tnc_remove_dh(struct ubifs_info *c, const union ubifs_key *key,
1592 uint32_t cookie);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001593int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
1594 union ubifs_key *to_key);
1595int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
1596struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
1597 union ubifs_key *key,
Richard Weinbergerf4f61d22016-11-11 22:50:29 +01001598 const struct fscrypt_name *nm);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001599void ubifs_tnc_close(struct ubifs_info *c);
1600int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
1601 int lnum, int offs, int is_idx);
1602int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
1603 int lnum, int offs);
1604/* Shared by tnc.c for tnc_commit.c */
1605void destroy_old_idx(struct ubifs_info *c);
1606int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
1607 int lnum, int offs);
1608int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
Adrian Hunter4793e7c2008-09-02 16:29:46 +03001609int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
1610int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001611
1612/* tnc_misc.c */
1613struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr,
1614 struct ubifs_znode *znode);
1615int ubifs_search_zbranch(const struct ubifs_info *c,
1616 const struct ubifs_znode *znode,
1617 const union ubifs_key *key, int *n);
1618struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
1619struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode);
1620long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr);
1621struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
1622 struct ubifs_zbranch *zbr,
1623 struct ubifs_znode *parent, int iip);
1624int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
1625 void *node);
1626
1627/* tnc_commit.c */
1628int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
1629int ubifs_tnc_end_commit(struct ubifs_info *c);
1630
1631/* shrinker.c */
Dave Chinner1ab6c492013-08-28 10:18:09 +10001632unsigned long ubifs_shrink_scan(struct shrinker *shrink,
1633 struct shrink_control *sc);
1634unsigned long ubifs_shrink_count(struct shrinker *shrink,
1635 struct shrink_control *sc);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001636
1637/* commit.c */
1638int ubifs_bg_thread(void *info);
1639void ubifs_commit_required(struct ubifs_info *c);
1640void ubifs_request_bg_commit(struct ubifs_info *c);
1641int ubifs_run_commit(struct ubifs_info *c);
1642void ubifs_recovery_commit(struct ubifs_info *c);
1643int ubifs_gc_should_commit(struct ubifs_info *c);
1644void ubifs_wait_for_commit(struct ubifs_info *c);
1645
1646/* master.c */
1647int ubifs_read_master(struct ubifs_info *c);
1648int ubifs_write_master(struct ubifs_info *c);
1649
1650/* sb.c */
1651int ubifs_read_superblock(struct ubifs_info *c);
1652struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c);
1653int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
Matthew L. Creech6554a652011-05-06 18:58:22 -04001654int ubifs_fixup_free_space(struct ubifs_info *c);
Richard Weinbergere0219862016-10-19 23:24:47 +02001655int ubifs_enable_encryption(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001656
1657/* replay.c */
1658int ubifs_validate_entry(struct ubifs_info *c,
1659 const struct ubifs_dent_node *dent);
1660int ubifs_replay_journal(struct ubifs_info *c);
1661
1662/* gc.c */
1663int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
1664int ubifs_gc_start_commit(struct ubifs_info *c);
1665int ubifs_gc_end_commit(struct ubifs_info *c);
Adrian Hunterb466f172009-01-29 12:59:33 +02001666void ubifs_destroy_idx_gc(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001667int ubifs_get_idx_gc_leb(struct ubifs_info *c);
1668int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
1669
1670/* orphan.c */
1671int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
1672void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
1673int ubifs_orphan_start_commit(struct ubifs_info *c);
1674int ubifs_orphan_end_commit(struct ubifs_info *c);
1675int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
Adrian Hunter49d128a2009-01-26 10:55:40 +02001676int ubifs_clear_orphans(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001677
1678/* lpt.c */
1679int ubifs_calc_lpt_geom(struct ubifs_info *c);
1680int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
1681 int *lpt_lebs, int *big_lpt);
1682int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
1683struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
1684struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
1685int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
1686 ubifs_lpt_scan_callback scan_cb, void *data);
1687
1688/* Shared by lpt.c for lpt_commit.c */
1689void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
1690void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
1691 struct ubifs_lpt_lprops *ltab);
1692void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
1693 struct ubifs_pnode *pnode);
1694void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
1695 struct ubifs_nnode *nnode);
1696struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
1697 struct ubifs_nnode *parent, int iip);
1698struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
1699 struct ubifs_nnode *parent, int iip);
1700int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
1701void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
1702void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
1703uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits);
1704struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
Artem Bityutskiy2ba5f7a2008-10-31 17:32:30 +02001705/* Needed only in debugging code in lpt_commit.c */
1706int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
1707 struct ubifs_nnode *nnode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001708
1709/* lpt_commit.c */
1710int ubifs_lpt_start_commit(struct ubifs_info *c);
1711int ubifs_lpt_end_commit(struct ubifs_info *c);
1712int ubifs_lpt_post_commit(struct ubifs_info *c);
1713void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
1714
1715/* lprops.c */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001716const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
1717 const struct ubifs_lprops *lp,
1718 int free, int dirty, int flags,
1719 int idx_gc_cnt);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001720void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001721void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
1722 int cat);
1723void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
1724 struct ubifs_lprops *new_lprops);
1725void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
1726int ubifs_categorize_lprops(const struct ubifs_info *c,
1727 const struct ubifs_lprops *lprops);
1728int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1729 int flags_set, int flags_clean, int idx_gc_cnt);
1730int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
1731 int flags_set, int flags_clean);
1732int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
1733const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
1734const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
1735const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
1736const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
Artem Bityutskiybe9e62a2008-12-28 10:17:23 +02001737int ubifs_calc_dark(const struct ubifs_info *c, int spc);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001738
1739/* file.c */
Josef Bacik02c24a82011-07-16 20:44:56 -04001740int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001741int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
Dongsheng Yang8c1c5f22015-11-07 12:46:11 +08001742#ifdef CONFIG_UBIFS_ATIME_SUPPORT
1743int ubifs_update_time(struct inode *inode, struct timespec *time, int flags);
1744#endif
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001745
1746/* dir.c */
Richard Weinbergerd475a502016-10-20 16:47:56 +02001747struct inode *ubifs_new_inode(struct ubifs_info *c, struct inode *dir,
Al Viroad44be52011-07-26 03:12:59 -04001748 umode_t mode);
David Howellsa528d352017-01-31 16:46:22 +00001749int ubifs_getattr(const struct path *path, struct kstat *stat,
1750 u32 request_mask, unsigned int flags);
Richard Weinbergerf6337d82016-09-19 20:54:19 +02001751int ubifs_check_dir_empty(struct inode *dir);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001752
1753/* xattr.c */
Andreas Gruenbacher2b88fc22016-04-22 19:14:00 +02001754extern const struct xattr_handler *ubifs_xattr_handlers[];
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001755ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
Richard Weinbergerade46c32016-09-19 21:42:06 +02001756int ubifs_xattr_set(struct inode *host, const char *name, const void *value,
Xiaolei Lid8db5b1c2017-06-23 10:37:23 +08001757 size_t size, int flags, bool check_lock);
Richard Weinbergerade46c32016-09-19 21:42:06 +02001758ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf,
1759 size_t size);
Richard Weinberger272eda82017-05-17 00:20:27 +02001760void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001761
Hyunchul Lee8326c1e2017-03-03 16:44:03 +09001762#ifdef CONFIG_UBIFS_FS_SECURITY
1763extern int ubifs_init_security(struct inode *dentry, struct inode *inode,
1764 const struct qstr *qstr);
1765#else
1766static inline int ubifs_init_security(struct inode *dentry,
1767 struct inode *inode, const struct qstr *qstr)
1768{
1769 return 0;
1770}
1771#endif
1772
1773
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001774/* super.c */
1775struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
1776
1777/* recovery.c */
1778int ubifs_recover_master_node(struct ubifs_info *c);
1779int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
1780struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
Artem Bityutskiyefcfde52011-05-26 08:36:52 +03001781 int offs, void *sbuf, int jhead);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001782struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
1783 int offs, void *sbuf);
Artem Bityutskiy83cef702011-06-03 13:45:09 +03001784int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf);
1785int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001786int ubifs_rcvry_gc_commit(struct ubifs_info *c);
1787int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
1788 int deletion, loff_t new_size);
1789int ubifs_recover_size(struct ubifs_info *c);
1790void ubifs_destroy_size_tree(struct ubifs_info *c);
1791
1792/* ioctl.c */
1793long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1794void ubifs_set_inode_flags(struct inode *inode);
1795#ifdef CONFIG_COMPAT
1796long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1797#endif
1798
1799/* compressor.c */
1800int __init ubifs_compressors_init(void);
Alexey Dobriyan995be042008-12-04 17:04:18 +03001801void ubifs_compressors_exit(void);
Sheng Yong235c3622015-03-20 10:39:42 +00001802void ubifs_compress(const struct ubifs_info *c, const void *in_buf, int in_len,
1803 void *out_buf, int *out_len, int *compr_type);
1804int ubifs_decompress(const struct ubifs_info *c, const void *buf, int len,
1805 void *out, int *out_len, int compr_type);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001806
1807#include "debug.h"
1808#include "misc.h"
1809#include "key.h"
1810
Richard Weinbergerd475a502016-10-20 16:47:56 +02001811#ifndef CONFIG_UBIFS_FS_ENCRYPTION
Richard Weinberger77999532016-09-29 22:20:19 +02001812static inline int ubifs_encrypt(const struct inode *inode,
1813 struct ubifs_data_node *dn,
1814 unsigned int in_len, unsigned int *out_len,
1815 int block)
1816{
1817 ubifs_assert(0);
1818 return -EOPNOTSUPP;
1819}
1820static inline int ubifs_decrypt(const struct inode *inode,
1821 struct ubifs_data_node *dn,
1822 unsigned int *out_len, int block)
1823{
1824 ubifs_assert(0);
1825 return -EOPNOTSUPP;
1826}
1827#else
1828/* crypto.c */
1829int ubifs_encrypt(const struct inode *inode, struct ubifs_data_node *dn,
1830 unsigned int in_len, unsigned int *out_len, int block);
1831int ubifs_decrypt(const struct inode *inode, struct ubifs_data_node *dn,
1832 unsigned int *out_len, int block);
Richard Weinbergerd475a502016-10-20 16:47:56 +02001833#endif
1834
Eric Biggers6f69f0e2017-02-07 12:42:10 -08001835extern const struct fscrypt_operations ubifs_crypt_operations;
Richard Weinberger77999532016-09-29 22:20:19 +02001836
Richard Weinberger1ee77872016-10-21 14:03:19 +02001837static inline bool ubifs_crypt_is_encrypted(const struct inode *inode)
1838{
Eric Biggersf7293e42017-10-09 12:15:37 -07001839 const struct ubifs_inode *ui = ubifs_inode(inode);
1840
1841 return ui->flags & UBIFS_CRYPT_FL;
Richard Weinberger1ee77872016-10-21 14:03:19 +02001842}
1843
Joe Perches3e7f2c52016-02-23 04:13:49 -08001844/* Normal UBIFS messages */
1845__printf(2, 3)
1846void ubifs_msg(const struct ubifs_info *c, const char *fmt, ...);
1847__printf(2, 3)
1848void ubifs_err(const struct ubifs_info *c, const char *fmt, ...);
1849__printf(2, 3)
1850void ubifs_warn(const struct ubifs_info *c, const char *fmt, ...);
1851/*
Daniel Golle380bc8b2016-07-25 13:44:50 +02001852 * A conditional variant of 'ubifs_err()' which doesn't output anything
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001853 * if probing (ie. SB_SILENT set).
Joe Perches3e7f2c52016-02-23 04:13:49 -08001854 */
1855#define ubifs_errc(c, fmt, ...) \
1856do { \
1857 if (!(c)->probing) \
1858 ubifs_err(c, fmt, ##__VA_ARGS__); \
1859} while (0)
1860
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001861#endif /* !__UBIFS_H__ */