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