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