fs/ubifs/ubifs.h

   1 /*
   2  * This file is part of UBIFS.
   3  *
   4  * Copyright (C) 2006-2008 Nokia Corporation
   5  *
   6  * (C) Copyright 2008-2009
   7  * Stefan Roese, DENX Software Engineering, sr@denx.de.
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License version 2 as published by
  11  * the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  16  * more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along with
  19  * this program; if not, write to the Free Software Foundation, Inc., 51
  20  * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  *
  22  * Authors: Artem Bityutskiy (Битюцкий Артём)
  23  *          Adrian Hunter
  24  */
  25
  26 #ifndef __UBIFS_H__
  27 #define __UBIFS_H__
  28
  29 #if 0   /* Enable for debugging output */
  30 #define CONFIG_UBIFS_FS_DEBUG
  31 #define CONFIG_UBIFS_FS_DEBUG_MSG_LVL   3
  32 #endif
  33
  34 #include <ubi_uboot.h>
  35 #include <linux/ctype.h>
  36 #include <linux/time.h>
  37 #include <linux/math64.h>
  38 #include "ubifs-media.h"
  39
  40 struct dentry;
  41 struct file;
  42 struct iattr;
  43 struct kstat;
  44 struct vfsmount;
  45
  46 extern struct super_block *ubifs_sb;
  47
  48 extern unsigned int ubifs_msg_flags;
  49 extern unsigned int ubifs_chk_flags;
  50 extern unsigned int ubifs_tst_flags;
  51
  52 #define pgoff_t         unsigned long
  53
  54 /*
  55  * We "simulate" the Linux page struct much simpler here
  56  */
  57 struct page {
  58         pgoff_t index;
  59         void *addr;
  60         struct inode *inode;
  61 };
  62
  63 void iput(struct inode *inode);
  64
  65 /*
  66  * The atomic operations are used for budgeting etc which is not
  67  * needed for the read-only U-Boot implementation:
  68  */
  69 #define atomic_long_inc(a)
  70 #define atomic_long_dec(a)
  71 #define atomic_long_sub(a, b)
  72
  73 /* linux/include/time.h */
  74
  75 struct timespec {
  76         time_t  tv_sec;         /* seconds */
  77         long    tv_nsec;        /* nanoseconds */
  78 };
  79
  80 /* linux/include/dcache.h */
  81
  82 /*
  83  * "quick string" -- eases parameter passing, but more importantly
  84  * saves "metadata" about the string (ie length and the hash).
  85  *
  86  * hash comes first so it snuggles against d_parent in the
  87  * dentry.
  88  */
  89 struct qstr {
  90         unsigned int hash;
  91         unsigned int len;
  92         const char *name;
  93 };
  94
  95 struct inode {
  96         struct hlist_node       i_hash;
  97         struct list_head        i_list;
  98         struct list_head        i_sb_list;
  99         struct list_head        i_dentry;
 100         unsigned long           i_ino;
 101         unsigned int            i_nlink;
 102         uid_t                   i_uid;
 103         gid_t                   i_gid;
 104         dev_t                   i_rdev;
 105         u64                     i_version;
 106         loff_t                  i_size;
 107 #ifdef __NEED_I_SIZE_ORDERED
 108         seqcount_t              i_size_seqcount;
 109 #endif
 110         struct timespec         i_atime;
 111         struct timespec         i_mtime;
 112         struct timespec         i_ctime;
 113         unsigned int            i_blkbits;
 114         unsigned short          i_bytes;
 115         umode_t                 i_mode;
 116         spinlock_t              i_lock; /* i_blocks, i_bytes, maybe i_size */
 117         struct mutex            i_mutex;
 118         struct rw_semaphore     i_alloc_sem;
 119         const struct inode_operations   *i_op;
 120         const struct file_operations    *i_fop; /* former ->i_op->default_file_ops */
 121         struct super_block      *i_sb;
 122         struct file_lock        *i_flock;
 123 #ifdef CONFIG_QUOTA
 124         struct dquot            *i_dquot[MAXQUOTAS];
 125 #endif
 126         struct list_head        i_devices;
 127         int                     i_cindex;
 128
 129         __u32                   i_generation;
 130
 131 #ifdef CONFIG_DNOTIFY
 132         unsigned long           i_dnotify_mask; /* Directory notify events */
 133         struct dnotify_struct   *i_dnotify; /* for directory notifications */
 134 #endif
 135
 136 #ifdef CONFIG_INOTIFY
 137         struct list_head        inotify_watches; /* watches on this inode */
 138         struct mutex            inotify_mutex;  /* protects the watches list */
 139 #endif
 140
 141         unsigned long           i_state;
 142         unsigned long           dirtied_when;   /* jiffies of first dirtying */
 143
 144         unsigned int            i_flags;
 145
 146 #ifdef CONFIG_SECURITY
 147         void                    *i_security;
 148 #endif
 149         void                    *i_private; /* fs or device private pointer */
 150 };
 151
 152 struct super_block {
 153         struct list_head        s_list;         /* Keep this first */
 154         dev_t                   s_dev;          /* search index; _not_ kdev_t */
 155         unsigned long           s_blocksize;
 156         unsigned char           s_blocksize_bits;
 157         unsigned char           s_dirt;
 158         unsigned long long      s_maxbytes;     /* Max file size */
 159         struct file_system_type *s_type;
 160         const struct super_operations   *s_op;
 161         struct dquot_operations *dq_op;
 162         struct quotactl_ops     *s_qcop;
 163         const struct export_operations *s_export_op;
 164         unsigned long           s_flags;
 165         unsigned long           s_magic;
 166         struct dentry           *s_root;
 167         struct rw_semaphore     s_umount;
 168         struct mutex            s_lock;
 169         int                     s_count;
 170         int                     s_syncing;
 171         int                     s_need_sync_fs;
 172 #ifdef CONFIG_SECURITY
 173         void                    *s_security;
 174 #endif
 175         struct xattr_handler    **s_xattr;
 176
 177         struct list_head        s_inodes;       /* all inodes */
 178         struct list_head        s_dirty;        /* dirty inodes */
 179         struct list_head        s_io;           /* parked for writeback */
 180         struct list_head        s_more_io;      /* parked for more writeback */
 181         struct hlist_head       s_anon;         /* anonymous dentries for (nfs) exporting */
 182         struct list_head        s_files;
 183         /* s_dentry_lru and s_nr_dentry_unused are protected by dcache_lock */
 184         struct list_head        s_dentry_lru;   /* unused dentry lru */
 185         int                     s_nr_dentry_unused;     /* # of dentry on lru */
 186
 187         struct block_device     *s_bdev;
 188         struct mtd_info         *s_mtd;
 189         struct list_head        s_instances;
 190
 191         int                     s_frozen;
 192         wait_queue_head_t       s_wait_unfrozen;
 193
 194         char s_id[32];                          /* Informational name */
 195
 196         void                    *s_fs_info;     /* Filesystem private info */
 197
 198         /*
 199          * The next field is for VFS *only*. No filesystems have any business
 200          * even looking at it. You had been warned.
 201          */
 202         struct mutex s_vfs_rename_mutex;        /* Kludge */
 203
 204         /* Granularity of c/m/atime in ns.
 205            Cannot be worse than a second */
 206         u32                s_time_gran;
 207
 208         /*
 209          * Filesystem subtype.  If non-empty the filesystem type field
 210          * in /proc/mounts will be "type.subtype"
 211          */
 212         char *s_subtype;
 213
 214         /*
 215          * Saved mount options for lazy filesystems using
 216          * generic_show_options()
 217          */
 218         char *s_options;
 219 };
 220
 221 struct file_system_type {
 222         const char *name;
 223         int fs_flags;
 224         int (*get_sb) (struct file_system_type *, int,
 225                        const char *, void *, struct vfsmount *);
 226         void (*kill_sb) (struct super_block *);
 227         struct module *owner;
 228         struct file_system_type * next;
 229         struct list_head fs_supers;
 230 };
 231
 232 struct vfsmount {
 233         struct list_head mnt_hash;
 234         struct vfsmount *mnt_parent;    /* fs we are mounted on */
 235         struct dentry *mnt_mountpoint;  /* dentry of mountpoint */
 236         struct dentry *mnt_root;        /* root of the mounted tree */
 237         struct super_block *mnt_sb;     /* pointer to superblock */
 238         struct list_head mnt_mounts;    /* list of children, anchored here */
 239         struct list_head mnt_child;     /* and going through their mnt_child */
 240         int mnt_flags;
 241         /* 4 bytes hole on 64bits arches */
 242         const char *mnt_devname;        /* Name of device e.g. /dev/dsk/hda1 */
 243         struct list_head mnt_list;
 244         struct list_head mnt_expire;    /* link in fs-specific expiry list */
 245         struct list_head mnt_share;     /* circular list of shared mounts */
 246         struct list_head mnt_slave_list;/* list of slave mounts */
 247         struct list_head mnt_slave;     /* slave list entry */
 248         struct vfsmount *mnt_master;    /* slave is on master->mnt_slave_list */
 249         struct mnt_namespace *mnt_ns;   /* containing namespace */
 250         int mnt_id;                     /* mount identifier */
 251         int mnt_group_id;               /* peer group identifier */
 252         /*
 253          * We put mnt_count & mnt_expiry_mark at the end of struct vfsmount
 254          * to let these frequently modified fields in a separate cache line
 255          * (so that reads of mnt_flags wont ping-pong on SMP machines)
 256          */
 257         int mnt_expiry_mark;            /* true if marked for expiry */
 258         int mnt_pinned;
 259         int mnt_ghosts;
 260         /*
 261          * This value is not stable unless all of the mnt_writers[] spinlocks
 262          * are held, and all mnt_writer[]s on this mount have 0 as their ->count
 263          */
 264 };
 265
 266 struct path {
 267         struct vfsmount *mnt;
 268         struct dentry *dentry;
 269 };
 270
 271 struct file {
 272         struct path             f_path;
 273 #define f_dentry        f_path.dentry
 274 #define f_vfsmnt        f_path.mnt
 275         const struct file_operations    *f_op;
 276         unsigned int            f_flags;
 277         loff_t                  f_pos;
 278         unsigned int            f_uid, f_gid;
 279
 280         u64                     f_version;
 281 #ifdef CONFIG_SECURITY
 282         void                    *f_security;
 283 #endif
 284         /* needed for tty driver, and maybe others */
 285         void                    *private_data;
 286
 287 #ifdef CONFIG_EPOLL
 288         /* Used by fs/eventpoll.c to link all the hooks to this file */
 289         struct list_head        f_ep_links;
 290         spinlock_t              f_ep_lock;
 291 #endif /* #ifdef CONFIG_EPOLL */
 292 #ifdef CONFIG_DEBUG_WRITECOUNT
 293         unsigned long f_mnt_write_state;
 294 #endif
 295 };
 296
 297 /*
 298  * get_seconds() not really needed in the read-only implmentation
 299  */
 300 #define get_seconds()           0
 301
 302 /* 4k page size */
 303 #define PAGE_CACHE_SHIFT        12
 304 #define PAGE_CACHE_SIZE         (1 << PAGE_CACHE_SHIFT)
 305
 306 /* Page cache limit. The filesystems should put that into their s_maxbytes
 307    limits, otherwise bad things can happen in VM. */
 308 #if BITS_PER_LONG==32
 309 #define MAX_LFS_FILESIZE        (((u64)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1)
 310 #elif BITS_PER_LONG==64
 311 #define MAX_LFS_FILESIZE        0x7fffffffffffffffUL
 312 #endif
 313
 314 #define INT_MAX         ((int)(~0U>>1))
 315 #define INT_MIN         (-INT_MAX - 1)
 316 #define LLONG_MAX       ((long long)(~0ULL>>1))
 317
 318 /*
 319  * These are the fs-independent mount-flags: up to 32 flags are supported
 320  */
 321 #define MS_RDONLY        1      /* Mount read-only */
 322 #define MS_NOSUID        2      /* Ignore suid and sgid bits */
 323 #define MS_NODEV         4      /* Disallow access to device special files */
 324 #define MS_NOEXEC        8      /* Disallow program execution */
 325 #define MS_SYNCHRONOUS  16      /* Writes are synced at once */
 326 #define MS_REMOUNT      32      /* Alter flags of a mounted FS */
 327 #define MS_MANDLOCK     64      /* Allow mandatory locks on an FS */
 328 #define MS_DIRSYNC      128     /* Directory modifications are synchronous */
 329 #define MS_NOATIME      1024    /* Do not update access times. */
 330 #define MS_NODIRATIME   2048    /* Do not update directory access times */
 331 #define MS_BIND         4096
 332 #define MS_MOVE         8192
 333 #define MS_REC          16384
 334 #define MS_VERBOSE      32768   /* War is peace. Verbosity is silence.
 335                                    MS_VERBOSE is deprecated. */
 336 #define MS_SILENT       32768
 337 #define MS_POSIXACL     (1<<16) /* VFS does not apply the umask */
 338 #define MS_UNBINDABLE   (1<<17) /* change to unbindable */
 339 #define MS_PRIVATE      (1<<18) /* change to private */
 340 #define MS_SLAVE        (1<<19) /* change to slave */
 341 #define MS_SHARED       (1<<20) /* change to shared */
 342 #define MS_RELATIME     (1<<21) /* Update atime relative to mtime/ctime. */
 343 #define MS_KERNMOUNT    (1<<22) /* this is a kern_mount call */
 344 #define MS_I_VERSION    (1<<23) /* Update inode I_version field */
 345 #define MS_ACTIVE       (1<<30)
 346 #define MS_NOUSER       (1<<31)
 347
 348 #define I_NEW                   8
 349
 350 /* Inode flags - they have nothing to superblock flags now */
 351
 352 #define S_SYNC          1       /* Writes are synced at once */
 353 #define S_NOATIME       2       /* Do not update access times */
 354 #define S_APPEND        4       /* Append-only file */
 355 #define S_IMMUTABLE     8       /* Immutable file */
 356 #define S_DEAD          16      /* removed, but still open directory */
 357 #define S_NOQUOTA       32      /* Inode is not counted to quota */
 358 #define S_DIRSYNC       64      /* Directory modifications are synchronous */
 359 #define S_NOCMTIME      128     /* Do not update file c/mtime */
 360 #define S_SWAPFILE      256     /* Do not truncate: swapon got its bmaps */
 361 #define S_PRIVATE       512     /* Inode is fs-internal */
 362
 363 /* include/linux/stat.h */
 364
 365 #define S_IFMT  00170000
 366 #define S_IFSOCK 0140000
 367 #define S_IFLNK  0120000
 368 #define S_IFREG  0100000
 369 #define S_IFBLK  0060000
 370 #define S_IFDIR  0040000
 371 #define S_IFCHR  0020000
 372 #define S_IFIFO  0010000
 373 #define S_ISUID  0004000
 374 #define S_ISGID  0002000
 375 #define S_ISVTX  0001000
 376
 377 /* include/linux/fs.h */
 378
 379 /*
 380  * File types
 381  *
 382  * NOTE! These match bits 12..15 of stat.st_mode
 383  * (ie "(i_mode >> 12) & 15").
 384  */
 385 #define DT_UNKNOWN      0
 386 #define DT_FIFO         1
 387 #define DT_CHR          2
 388 #define DT_DIR          4
 389 #define DT_BLK          6
 390 #define DT_REG          8
 391 #define DT_LNK          10
 392 #define DT_SOCK         12
 393 #define DT_WHT          14
 394
 395 #define I_DIRTY_SYNC            1
 396 #define I_DIRTY_DATASYNC        2
 397 #define I_DIRTY_PAGES           4
 398 #define I_NEW                   8
 399 #define I_WILL_FREE             16
 400 #define I_FREEING               32
 401 #define I_CLEAR                 64
 402 #define __I_LOCK                7
 403 #define I_LOCK                  (1 << __I_LOCK)
 404 #define __I_SYNC                8
 405 #define I_SYNC                  (1 << __I_SYNC)
 406
 407 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
 408
 409 /* linux/include/dcache.h */
 410
 411 #define DNAME_INLINE_LEN_MIN 36
 412
 413 struct dentry {
 414         unsigned int d_flags;           /* protected by d_lock */
 415         spinlock_t d_lock;              /* per dentry lock */
 416         struct inode *d_inode;          /* Where the name belongs to - NULL is
 417                                          * negative */
 418         /*
 419          * The next three fields are touched by __d_lookup.  Place them here
 420          * so they all fit in a cache line.
 421          */
 422         struct hlist_node d_hash;       /* lookup hash list */
 423         struct dentry *d_parent;        /* parent directory */
 424         struct qstr d_name;
 425
 426         struct list_head d_lru;         /* LRU list */
 427         /*
 428          * d_child and d_rcu can share memory
 429          */
 430         struct list_head d_subdirs;     /* our children */
 431         struct list_head d_alias;       /* inode alias list */
 432         unsigned long d_time;           /* used by d_revalidate */
 433         struct super_block *d_sb;       /* The root of the dentry tree */
 434         void *d_fsdata;                 /* fs-specific data */
 435 #ifdef CONFIG_PROFILING
 436         struct dcookie_struct *d_cookie; /* cookie, if any */
 437 #endif
 438         int d_mounted;
 439         unsigned char d_iname[DNAME_INLINE_LEN_MIN];    /* small names */
 440 };
 441
 442 static inline ino_t parent_ino(struct dentry *dentry)
 443 {
 444         ino_t res;
 445
 446         spin_lock(&dentry->d_lock);
 447         res = dentry->d_parent->d_inode->i_ino;
 448         spin_unlock(&dentry->d_lock);
 449         return res;
 450 }
 451
 452 /* debug.c */
 453
 454 #define DEFINE_SPINLOCK(...)
 455 #define module_param_named(...)
 456
 457 /* misc.h */
 458 #define mutex_lock_nested(...)
 459 #define mutex_unlock_nested(...)
 460 #define mutex_is_locked(...)    0
 461
 462 /* Version of this UBIFS implementation */
 463 #define UBIFS_VERSION 1
 464
 465 /* Normal UBIFS messages */
 466 #define ubifs_msg(fmt, ...) \
 467                 printk(KERN_NOTICE "UBIFS: " fmt "\n", ##__VA_ARGS__)
 468 /* UBIFS error messages */
 469 #define ubifs_err(fmt, ...)                                                  \
 470         printk(KERN_ERR "UBIFS error (pid %d): %s: " fmt "\n", 0, \
 471                __func__, ##__VA_ARGS__)
 472 /* UBIFS warning messages */
 473 #define ubifs_warn(fmt, ...)                                         \
 474         printk(KERN_WARNING "UBIFS warning (pid %d): %s: " fmt "\n", \
 475                0, __func__, ##__VA_ARGS__)
 476
 477 /* UBIFS file system VFS magic number */
 478 #define UBIFS_SUPER_MAGIC 0x24051905
 479
 480 /* Number of UBIFS blocks per VFS page */
 481 #define UBIFS_BLOCKS_PER_PAGE (PAGE_CACHE_SIZE / UBIFS_BLOCK_SIZE)
 482 #define UBIFS_BLOCKS_PER_PAGE_SHIFT (PAGE_CACHE_SHIFT - UBIFS_BLOCK_SHIFT)
 483
 484 /* "File system end of life" sequence number watermark */
 485 #define SQNUM_WARN_WATERMARK 0xFFFFFFFF00000000ULL
 486 #define SQNUM_WATERMARK      0xFFFFFFFFFF000000ULL
 487
 488 /*
 489  * Minimum amount of LEBs reserved for the index. At present the index needs at
 490  * least 2 LEBs: one for the index head and one for in-the-gaps method (which
 491  * currently does not cater for the index head and so excludes it from
 492  * consideration).
 493  */
 494 #define MIN_INDEX_LEBS 2
 495
 496 /* Minimum amount of data UBIFS writes to the flash */
 497 #define MIN_WRITE_SZ (UBIFS_DATA_NODE_SZ + 8)
 498
 499 /*
 500  * Currently we do not support inode number overlapping and re-using, so this
 501  * watermark defines dangerous inode number level. This should be fixed later,
 502  * although it is difficult to exceed current limit. Another option is to use
 503  * 64-bit inode numbers, but this means more overhead.
 504  */
 505 #define INUM_WARN_WATERMARK 0xFFF00000
 506 #define INUM_WATERMARK      0xFFFFFF00
 507
 508 /* Largest key size supported in this implementation */
 509 #define CUR_MAX_KEY_LEN UBIFS_SK_LEN
 510
 511 /* Maximum number of entries in each LPT (LEB category) heap */
 512 #define LPT_HEAP_SZ 256
 513
 514 /*
 515  * Background thread name pattern. The numbers are UBI device and volume
 516  * numbers.
 517  */
 518 #define BGT_NAME_PATTERN "ubifs_bgt%d_%d"
 519
 520 /* Default write-buffer synchronization timeout (5 secs) */
 521 #define DEFAULT_WBUF_TIMEOUT (5 * HZ)
 522
 523 /* Maximum possible inode number (only 32-bit inodes are supported now) */
 524 #define MAX_INUM 0xFFFFFFFF
 525
 526 /* Number of non-data journal heads */
 527 #define NONDATA_JHEADS_CNT 2
 528
 529 /* Garbage collector head */
 530 #define GCHD   0
 531 /* Base journal head number */
 532 #define BASEHD 1
 533 /* First "general purpose" journal head */
 534 #define DATAHD 2
 535
 536 /* 'No change' value for 'ubifs_change_lp()' */
 537 #define LPROPS_NC 0x80000001
 538
 539 /*
 540  * There is no notion of truncation key because truncation nodes do not exist
 541  * in TNC. However, when replaying, it is handy to introduce fake "truncation"
 542  * keys for truncation nodes because the code becomes simpler. So we define
 543  * %UBIFS_TRUN_KEY type.
 544  */
 545 #define UBIFS_TRUN_KEY UBIFS_KEY_TYPES_CNT
 546
 547 /*
 548  * How much a directory entry/extended attribute entry adds to the parent/host
 549  * inode.
 550  */
 551 #define CALC_DENT_SIZE(name_len) ALIGN(UBIFS_DENT_NODE_SZ + (name_len) + 1, 8)
 552
 553 /* How much an extended attribute adds to the host inode */
 554 #define CALC_XATTR_BYTES(data_len) ALIGN(UBIFS_INO_NODE_SZ + (data_len) + 1, 8)
 555
 556 /*
 557  * Znodes which were not touched for 'OLD_ZNODE_AGE' seconds are considered
 558  * "old", and znode which were touched last 'YOUNG_ZNODE_AGE' seconds ago are
 559  * considered "young". This is used by shrinker when selecting znode to trim
 560  * off.
 561  */
 562 #define OLD_ZNODE_AGE 20
 563 #define YOUNG_ZNODE_AGE 5
 564
 565 /*
 566  * Some compressors, like LZO, may end up with more data then the input buffer.
 567  * So UBIFS always allocates larger output buffer, to be sure the compressor
 568  * will not corrupt memory in case of worst case compression.
 569  */
 570 #define WORST_COMPR_FACTOR 2
 571
 572 /* Maximum expected tree height for use by bottom_up_buf */
 573 #define BOTTOM_UP_HEIGHT 64
 574
 575 /* Maximum number of data nodes to bulk-read */
 576 #define UBIFS_MAX_BULK_READ 32
 577
 578 /*
 579  * Lockdep classes for UBIFS inode @ui_mutex.
 580  */
 581 enum {
 582         WB_MUTEX_1 = 0,
 583         WB_MUTEX_2 = 1,
 584         WB_MUTEX_3 = 2,
 585 };
 586
 587 /*
 588  * Znode flags (actually, bit numbers which store the flags).
 589  *
 590  * DIRTY_ZNODE: znode is dirty
 591  * COW_ZNODE: znode is being committed and a new instance of this znode has to
 592  *            be created before changing this znode
 593  * OBSOLETE_ZNODE: znode is obsolete, which means it was deleted, but it is
 594  *                 still in the commit list and the ongoing commit operation
 595  *                 will commit it, and delete this znode after it is done
 596  */
 597 enum {
 598         DIRTY_ZNODE    = 0,
 599         COW_ZNODE      = 1,
 600         OBSOLETE_ZNODE = 2,
 601 };
 602
 603 /*
 604  * Commit states.
 605  *
 606  * COMMIT_RESTING: commit is not wanted
 607  * COMMIT_BACKGROUND: background commit has been requested
 608  * COMMIT_REQUIRED: commit is required
 609  * COMMIT_RUNNING_BACKGROUND: background commit is running
 610  * COMMIT_RUNNING_REQUIRED: commit is running and it is required
 611  * COMMIT_BROKEN: commit failed
 612  */
 613 enum {
 614         COMMIT_RESTING = 0,
 615         COMMIT_BACKGROUND,
 616         COMMIT_REQUIRED,
 617         COMMIT_RUNNING_BACKGROUND,
 618         COMMIT_RUNNING_REQUIRED,
 619         COMMIT_BROKEN,
 620 };
 621
 622 /*
 623  * 'ubifs_scan_a_node()' return values.
 624  *
 625  * SCANNED_GARBAGE:  scanned garbage
 626  * SCANNED_EMPTY_SPACE: scanned empty space
 627  * SCANNED_A_NODE: scanned a valid node
 628  * SCANNED_A_CORRUPT_NODE: scanned a corrupted node
 629  * SCANNED_A_BAD_PAD_NODE: scanned a padding node with invalid pad length
 630  *
 631  * Greater than zero means: 'scanned that number of padding bytes'
 632  */
 633 enum {
 634         SCANNED_GARBAGE        = 0,
 635         SCANNED_EMPTY_SPACE    = -1,
 636         SCANNED_A_NODE         = -2,
 637         SCANNED_A_CORRUPT_NODE = -3,
 638         SCANNED_A_BAD_PAD_NODE = -4,
 639 };
 640
 641 /*
 642  * LPT cnode flag bits.
 643  *
 644  * DIRTY_CNODE: cnode is dirty
 645  * COW_CNODE: cnode is being committed and must be copied before writing
 646  * OBSOLETE_CNODE: cnode is being committed and has been copied (or deleted),
 647  * so it can (and must) be freed when the commit is finished
 648  */
 649 enum {
 650         DIRTY_CNODE    = 0,
 651         COW_CNODE      = 1,
 652         OBSOLETE_CNODE = 2,
 653 };
 654
 655 /*
 656  * Dirty flag bits (lpt_drty_flgs) for LPT special nodes.
 657  *
 658  * LTAB_DIRTY: ltab node is dirty
 659  * LSAVE_DIRTY: lsave node is dirty
 660  */
 661 enum {
 662         LTAB_DIRTY  = 1,
 663         LSAVE_DIRTY = 2,
 664 };
 665
 666 /*
 667  * Return codes used by the garbage collector.
 668  * @LEB_FREED: the logical eraseblock was freed and is ready to use
 669  * @LEB_FREED_IDX: indexing LEB was freed and can be used only after the commit
 670  * @LEB_RETAINED: the logical eraseblock was freed and retained for GC purposes
 671  */
 672 enum {
 673         LEB_FREED,
 674         LEB_FREED_IDX,
 675         LEB_RETAINED,
 676 };
 677
 678 /**
 679  * struct ubifs_old_idx - index node obsoleted since last commit start.
 680  * @rb: rb-tree node
 681  * @lnum: LEB number of obsoleted index node
 682  * @offs: offset of obsoleted index node
 683  */
 684 struct ubifs_old_idx {
 685         struct rb_node rb;
 686         int lnum;
 687         int offs;
 688 };
 689
 690 /* The below union makes it easier to deal with keys */
 691 union ubifs_key {
 692         uint8_t u8[CUR_MAX_KEY_LEN];
 693         uint32_t u32[CUR_MAX_KEY_LEN/4];
 694         uint64_t u64[CUR_MAX_KEY_LEN/8];
 695         __le32 j32[CUR_MAX_KEY_LEN/4];
 696 };
 697
 698 /**
 699  * struct ubifs_scan_node - UBIFS scanned node information.
 700  * @list: list of scanned nodes
 701  * @key: key of node scanned (if it has one)
 702  * @sqnum: sequence number
 703  * @type: type of node scanned
 704  * @offs: offset with LEB of node scanned
 705  * @len: length of node scanned
 706  * @node: raw node
 707  */
 708 struct ubifs_scan_node {
 709         struct list_head list;
 710         union ubifs_key key;
 711         unsigned long long sqnum;
 712         int type;
 713         int offs;
 714         int len;
 715         void *node;
 716 };
 717
 718 /**
 719  * struct ubifs_scan_leb - UBIFS scanned LEB information.
 720  * @lnum: logical eraseblock number
 721  * @nodes_cnt: number of nodes scanned
 722  * @nodes: list of struct ubifs_scan_node
 723  * @endpt: end point (and therefore the start of empty space)
 724  * @ecc: read returned -EBADMSG
 725  * @buf: buffer containing entire LEB scanned
 726  */
 727 struct ubifs_scan_leb {
 728         int lnum;
 729         int nodes_cnt;
 730         struct list_head nodes;
 731         int endpt;
 732         int ecc;
 733         void *buf;
 734 };
 735
 736 /**
 737  * struct ubifs_gced_idx_leb - garbage-collected indexing LEB.
 738  * @list: list
 739  * @lnum: LEB number
 740  * @unmap: OK to unmap this LEB
 741  *
 742  * This data structure is used to temporary store garbage-collected indexing
 743  * LEBs - they are not released immediately, but only after the next commit.
 744  * This is needed to guarantee recoverability.
 745  */
 746 struct ubifs_gced_idx_leb {
 747         struct list_head list;
 748         int lnum;
 749         int unmap;
 750 };
 751
 752 /**
 753  * struct ubifs_inode - UBIFS in-memory inode description.
 754  * @vfs_inode: VFS inode description object
 755  * @creat_sqnum: sequence number at time of creation
 756  * @del_cmtno: commit number corresponding to the time the inode was deleted,
 757  *             protected by @c->commit_sem;
 758  * @xattr_size: summarized size of all extended attributes in bytes
 759  * @xattr_cnt: count of extended attributes this inode has
 760  * @xattr_names: sum of lengths of all extended attribute names belonging to
 761  *               this inode
 762  * @dirty: non-zero if the inode is dirty
 763  * @xattr: non-zero if this is an extended attribute inode
 764  * @bulk_read: non-zero if bulk-read should be used
 765  * @ui_mutex: serializes inode write-back with the rest of VFS operations,
 766  *            serializes "clean <-> dirty" state changes, serializes bulk-read,
 767  *            protects @dirty, @bulk_read, @ui_size, and @xattr_size
 768  * @ui_lock: protects @synced_i_size
 769  * @synced_i_size: synchronized size of inode, i.e. the value of inode size
 770  *                 currently stored on the flash; used only for regular file
 771  *                 inodes
 772  * @ui_size: inode size used by UBIFS when writing to flash
 773  * @flags: inode flags (@UBIFS_COMPR_FL, etc)
 774  * @compr_type: default compression type used for this inode
 775  * @last_page_read: page number of last page read (for bulk read)
 776  * @read_in_a_row: number of consecutive pages read in a row (for bulk read)
 777  * @data_len: length of the data attached to the inode
 778  * @data: inode's data
 779  *
 780  * @ui_mutex exists for two main reasons. At first it prevents inodes from
 781  * being written back while UBIFS changing them, being in the middle of an VFS
 782  * operation. This way UBIFS makes sure the inode fields are consistent. For
 783  * example, in 'ubifs_rename()' we change 3 inodes simultaneously, and
 784  * write-back must not write any of them before we have finished.
 785  *
 786  * The second reason is budgeting - UBIFS has to budget all operations. If an
 787  * operation is going to mark an inode dirty, it has to allocate budget for
 788  * this. It cannot just mark it dirty because there is no guarantee there will
 789  * be enough flash space to write the inode back later. This means UBIFS has
 790  * to have full control over inode "clean <-> dirty" transitions (and pages
 791  * actually). But unfortunately, VFS marks inodes dirty in many places, and it
 792  * does not ask the file-system if it is allowed to do so (there is a notifier,
 793  * but it is not enough), i.e., there is no mechanism to synchronize with this.
 794  * So UBIFS has its own inode dirty flag and its own mutex to serialize
 795  * "clean <-> dirty" transitions.
 796  *
 797  * The @synced_i_size field is used to make sure we never write pages which are
 798  * beyond last synchronized inode size. See 'ubifs_writepage()' for more
 799  * information.
 800  *
 801  * The @ui_size is a "shadow" variable for @inode->i_size and UBIFS uses
 802  * @ui_size instead of @inode->i_size. The reason for this is that UBIFS cannot
 803  * make sure @inode->i_size is always changed under @ui_mutex, because it
 804  * cannot call 'vmtruncate()' with @ui_mutex locked, because it would deadlock
 805  * with 'ubifs_writepage()' (see file.c). All the other inode fields are
 806  * changed under @ui_mutex, so they do not need "shadow" fields. Note, one
 807  * could consider to rework locking and base it on "shadow" fields.
 808  */
 809 struct ubifs_inode {
 810         struct inode vfs_inode;
 811         unsigned long long creat_sqnum;
 812         unsigned long long del_cmtno;
 813         unsigned int xattr_size;
 814         unsigned int xattr_cnt;
 815         unsigned int xattr_names;
 816         unsigned int dirty:1;
 817         unsigned int xattr:1;
 818         unsigned int bulk_read:1;
 819         unsigned int compr_type:2;
 820         struct mutex ui_mutex;
 821         spinlock_t ui_lock;
 822         loff_t synced_i_size;
 823         loff_t ui_size;
 824         int flags;
 825         pgoff_t last_page_read;
 826         pgoff_t read_in_a_row;
 827         int data_len;
 828         void *data;
 829 };
 830
 831 /**
 832  * struct ubifs_unclean_leb - records a LEB recovered under read-only mode.
 833  * @list: list
 834  * @lnum: LEB number of recovered LEB
 835  * @endpt: offset where recovery ended
 836  *
 837  * This structure records a LEB identified during recovery that needs to be
 838  * cleaned but was not because UBIFS was mounted read-only. The information
 839  * is used to clean the LEB when remounting to read-write mode.
 840  */
 841 struct ubifs_unclean_leb {
 842         struct list_head list;
 843         int lnum;
 844         int endpt;
 845 };
 846
 847 /*
 848  * LEB properties flags.
 849  *
 850  * LPROPS_UNCAT: not categorized
 851  * LPROPS_DIRTY: dirty > free, dirty >= @c->dead_wm, not index
 852  * LPROPS_DIRTY_IDX: dirty + free > @c->min_idx_node_sze and index
 853  * LPROPS_FREE: free > 0, dirty < @c->dead_wm, not empty, not index
 854  * LPROPS_HEAP_CNT: number of heaps used for storing categorized LEBs
 855  * LPROPS_EMPTY: LEB is empty, not taken
 856  * LPROPS_FREEABLE: free + dirty == leb_size, not index, not taken
 857  * LPROPS_FRDI_IDX: free + dirty == leb_size and index, may be taken
 858  * LPROPS_CAT_MASK: mask for the LEB categories above
 859  * LPROPS_TAKEN: LEB was taken (this flag is not saved on the media)
 860  * LPROPS_INDEX: LEB contains indexing nodes (this flag also exists on flash)
 861  */
 862 enum {
 863         LPROPS_UNCAT     =  0,
 864         LPROPS_DIRTY     =  1,
 865         LPROPS_DIRTY_IDX =  2,
 866         LPROPS_FREE      =  3,
 867         LPROPS_HEAP_CNT  =  3,
 868         LPROPS_EMPTY     =  4,
 869         LPROPS_FREEABLE  =  5,
 870         LPROPS_FRDI_IDX  =  6,
 871         LPROPS_CAT_MASK  = 15,
 872         LPROPS_TAKEN     = 16,
 873         LPROPS_INDEX     = 32,
 874 };
 875
 876 /**
 877  * struct ubifs_lprops - logical eraseblock properties.
 878  * @free: amount of free space in bytes
 879  * @dirty: amount of dirty space in bytes
 880  * @flags: LEB properties flags (see above)
 881  * @lnum: LEB number
 882  * @list: list of same-category lprops (for LPROPS_EMPTY and LPROPS_FREEABLE)
 883  * @hpos: heap position in heap of same-category lprops (other categories)
 884  */
 885 struct ubifs_lprops {
 886         int free;
 887         int dirty;
 888         int flags;
 889         int lnum;
 890         union {
 891                 struct list_head list;
 892                 int hpos;
 893         };
 894 };
 895
 896 /**
 897  * struct ubifs_lpt_lprops - LPT logical eraseblock properties.
 898  * @free: amount of free space in bytes
 899  * @dirty: amount of dirty space in bytes
 900  * @tgc: trivial GC flag (1 => unmap after commit end)
 901  * @cmt: commit flag (1 => reserved for commit)
 902  */
 903 struct ubifs_lpt_lprops {
 904         int free;
 905         int dirty;
 906         unsigned tgc:1;
 907         unsigned cmt:1;
 908 };
 909
 910 /**
 911  * struct ubifs_lp_stats - statistics of eraseblocks in the main area.
 912  * @empty_lebs: number of empty LEBs
 913  * @taken_empty_lebs: number of taken LEBs
 914  * @idx_lebs: number of indexing LEBs
 915  * @total_free: total free space in bytes (includes all LEBs)
 916  * @total_dirty: total dirty space in bytes (includes all LEBs)
 917  * @total_used: total used space in bytes (does not include index LEBs)
 918  * @total_dead: total dead space in bytes (does not include index LEBs)
 919  * @total_dark: total dark space in bytes (does not include index LEBs)
 920  *
 921  * The @taken_empty_lebs field counts the LEBs that are in the transient state
 922  * of having been "taken" for use but not yet written to. @taken_empty_lebs is
 923  * needed to account correctly for @gc_lnum, otherwise @empty_lebs could be
 924  * used by itself (in which case 'unused_lebs' would be a better name). In the
 925  * case of @gc_lnum, it is "taken" at mount time or whenever a LEB is retained
 926  * by GC, but unlike other empty LEBs that are "taken", it may not be written
 927  * straight away (i.e. before the next commit start or unmount), so either
 928  * @gc_lnum must be specially accounted for, or the current approach followed
 929  * i.e. count it under @taken_empty_lebs.
 930  *
 931  * @empty_lebs includes @taken_empty_lebs.
 932  *
 933  * @total_used, @total_dead and @total_dark fields do not account indexing
 934  * LEBs.
 935  */
 936 struct ubifs_lp_stats {
 937         int empty_lebs;
 938         int taken_empty_lebs;
 939         int idx_lebs;
 940         long long total_free;
 941         long long total_dirty;
 942         long long total_used;
 943         long long total_dead;
 944         long long total_dark;
 945 };
 946
 947 struct ubifs_nnode;
 948
 949 /**
 950  * struct ubifs_cnode - LEB Properties Tree common node.
 951  * @parent: parent nnode
 952  * @cnext: next cnode to commit
 953  * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
 954  * @iip: index in parent
 955  * @level: level in the tree (zero for pnodes, greater than zero for nnodes)
 956  * @num: node number
 957  */
 958 struct ubifs_cnode {
 959         struct ubifs_nnode *parent;
 960         struct ubifs_cnode *cnext;
 961         unsigned long flags;
 962         int iip;
 963         int level;
 964         int num;
 965 };
 966
 967 /**
 968  * struct ubifs_pnode - LEB Properties Tree leaf node.
 969  * @parent: parent nnode
 970  * @cnext: next cnode to commit
 971  * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
 972  * @iip: index in parent
 973  * @level: level in the tree (always zero for pnodes)
 974  * @num: node number
 975  * @lprops: LEB properties array
 976  */
 977 struct ubifs_pnode {
 978         struct ubifs_nnode *parent;
 979         struct ubifs_cnode *cnext;
 980         unsigned long flags;
 981         int iip;
 982         int level;
 983         int num;
 984         struct ubifs_lprops lprops[UBIFS_LPT_FANOUT];
 985 };
 986
 987 /**
 988  * struct ubifs_nbranch - LEB Properties Tree internal node branch.
 989  * @lnum: LEB number of child
 990  * @offs: offset of child
 991  * @nnode: nnode child
 992  * @pnode: pnode child
 993  * @cnode: cnode child
 994  */
 995 struct ubifs_nbranch {
 996         int lnum;
 997         int offs;
 998         union {
 999                 struct ubifs_nnode *nnode;
1000                 struct ubifs_pnode *pnode;
1001                 struct ubifs_cnode *cnode;
1002         };
1003 };
1004
1005 /**
1006  * struct ubifs_nnode - LEB Properties Tree internal node.
1007  * @parent: parent nnode
1008  * @cnext: next cnode to commit
1009  * @flags: flags (%DIRTY_LPT_NODE or %OBSOLETE_LPT_NODE)
1010  * @iip: index in parent
1011  * @level: level in the tree (always greater than zero for nnodes)
1012  * @num: node number
1013  * @nbranch: branches to child nodes
1014  */
1015 struct ubifs_nnode {
1016         struct ubifs_nnode *parent;
1017         struct ubifs_cnode *cnext;
1018         unsigned long flags;
1019         int iip;
1020         int level;
1021         int num;
1022         struct ubifs_nbranch nbranch[UBIFS_LPT_FANOUT];
1023 };
1024
1025 /**
1026  * struct ubifs_lpt_heap - heap of categorized lprops.
1027  * @arr: heap array
1028  * @cnt: number in heap
1029  * @max_cnt: maximum number allowed in heap
1030  *
1031  * There are %LPROPS_HEAP_CNT heaps.
1032  */
1033 struct ubifs_lpt_heap {
1034         struct ubifs_lprops **arr;
1035         int cnt;
1036         int max_cnt;
1037 };
1038
1039 /*
1040  * Return codes for LPT scan callback function.
1041  *
1042  * LPT_SCAN_CONTINUE: continue scanning
1043  * LPT_SCAN_ADD: add the LEB properties scanned to the tree in memory
1044  * LPT_SCAN_STOP: stop scanning
1045  */
1046 enum {
1047         LPT_SCAN_CONTINUE = 0,
1048         LPT_SCAN_ADD = 1,
1049         LPT_SCAN_STOP = 2,
1050 };
1051
1052 struct ubifs_info;
1053
1054 /* Callback used by the 'ubifs_lpt_scan_nolock()' function */
1055 typedef int (*ubifs_lpt_scan_callback)(struct ubifs_info *c,
1056                                        const struct ubifs_lprops *lprops,
1057                                        int in_tree, void *data);
1058
1059 /**
1060  * struct ubifs_wbuf - UBIFS write-buffer.
1061  * @c: UBIFS file-system description object
1062  * @buf: write-buffer (of min. flash I/O unit size)
1063  * @lnum: logical eraseblock number the write-buffer points to
1064  * @offs: write-buffer offset in this logical eraseblock
1065  * @avail: number of bytes available in the write-buffer
1066  * @used:  number of used bytes in the write-buffer
1067  * @dtype: type of data stored in this LEB (%UBI_LONGTERM, %UBI_SHORTTERM,
1068  * %UBI_UNKNOWN)
1069  * @jhead: journal head the mutex belongs to (note, needed only to shut lockdep
1070  *         up by 'mutex_lock_nested()).
1071  * @sync_callback: write-buffer synchronization callback
1072  * @io_mutex: serializes write-buffer I/O
1073  * @lock: serializes @buf, @lnum, @offs, @avail, @used, @next_ino and @inodes
1074  *        fields
1075  * @timer: write-buffer timer
1076  * @timeout: timer expire interval in jiffies
1077  * @need_sync: it is set if its timer expired and needs sync
1078  * @next_ino: points to the next position of the following inode number
1079  * @inodes: stores the inode numbers of the nodes which are in wbuf
1080  *
1081  * The write-buffer synchronization callback is called when the write-buffer is
1082  * synchronized in order to notify how much space was wasted due to
1083  * write-buffer padding and how much free space is left in the LEB.
1084  *
1085  * Note: the fields @buf, @lnum, @offs, @avail and @used can be read under
1086  * spin-lock or mutex because they are written under both mutex and spin-lock.
1087  * @buf is appended to under mutex but overwritten under both mutex and
1088  * spin-lock. Thus the data between @buf and @buf + @used can be read under
1089  * spinlock.
1090  */
1091 struct ubifs_wbuf {
1092         struct ubifs_info *c;
1093         void *buf;
1094         int lnum;
1095         int offs;
1096         int avail;
1097         int used;
1098         int dtype;
1099         int jhead;
1100         int (*sync_callback)(struct ubifs_info *c, int lnum, int free, int pad);
1101         struct mutex io_mutex;
1102         spinlock_t lock;
1103         int timeout;
1104         int need_sync;
1105         int next_ino;
1106         ino_t *inodes;
1107 };
1108
1109 /**
1110  * struct ubifs_bud - bud logical eraseblock.
1111  * @lnum: logical eraseblock number
1112  * @start: where the (uncommitted) bud data starts
1113  * @jhead: journal head number this bud belongs to
1114  * @list: link in the list buds belonging to the same journal head
1115  * @rb: link in the tree of all buds
1116  */
1117 struct ubifs_bud {
1118         int lnum;
1119         int start;
1120         int jhead;
1121         struct list_head list;
1122         struct rb_node rb;
1123 };
1124
1125 /**
1126  * struct ubifs_jhead - journal head.
1127  * @wbuf: head's write-buffer
1128  * @buds_list: list of bud LEBs belonging to this journal head
1129  *
1130  * Note, the @buds list is protected by the @c->buds_lock.
1131  */
1132 struct ubifs_jhead {
1133         struct ubifs_wbuf wbuf;
1134         struct list_head buds_list;
1135 };
1136
1137 /**
1138  * struct ubifs_zbranch - key/coordinate/length branch stored in znodes.
1139  * @key: key
1140  * @znode: znode address in memory
1141  * @lnum: LEB number of the target node (indexing node or data node)
1142  * @offs: target node offset within @lnum
1143  * @len: target node length
1144  */
1145 struct ubifs_zbranch {
1146         union ubifs_key key;
1147         union {
1148                 struct ubifs_znode *znode;
1149                 void *leaf;
1150         };
1151         int lnum;
1152         int offs;
1153         int len;
1154 };
1155
1156 /**
1157  * struct ubifs_znode - in-memory representation of an indexing node.
1158  * @parent: parent znode or NULL if it is the root
1159  * @cnext: next znode to commit
1160  * @flags: znode flags (%DIRTY_ZNODE, %COW_ZNODE or %OBSOLETE_ZNODE)
1161  * @time: last access time (seconds)
1162  * @level: level of the entry in the TNC tree
1163  * @child_cnt: count of child znodes
1164  * @iip: index in parent's zbranch array
1165  * @alt: lower bound of key range has altered i.e. child inserted at slot 0
1166  * @lnum: LEB number of the corresponding indexing node
1167  * @offs: offset of the corresponding indexing node
1168  * @len: length  of the corresponding indexing node
1169  * @zbranch: array of znode branches (@c->fanout elements)
1170  */
1171 struct ubifs_znode {
1172         struct ubifs_znode *parent;
1173         struct ubifs_znode *cnext;
1174         unsigned long flags;
1175         unsigned long time;
1176         int level;
1177         int child_cnt;
1178         int iip;
1179         int alt;
1180 #ifdef CONFIG_UBIFS_FS_DEBUG
1181         int lnum, offs, len;
1182 #endif
1183         struct ubifs_zbranch zbranch[];
1184 };
1185
1186 /**
1187  * struct bu_info - bulk-read information.
1188  * @key: first data node key
1189  * @zbranch: zbranches of data nodes to bulk read
1190  * @buf: buffer to read into
1191  * @buf_len: buffer length
1192  * @gc_seq: GC sequence number to detect races with GC
1193  * @cnt: number of data nodes for bulk read
1194  * @blk_cnt: number of data blocks including holes
1195  * @oef: end of file reached
1196  */
1197 struct bu_info {
1198         union ubifs_key key;
1199         struct ubifs_zbranch zbranch[UBIFS_MAX_BULK_READ];
1200         void *buf;
1201         int buf_len;
1202         int gc_seq;
1203         int cnt;
1204         int blk_cnt;
1205         int eof;
1206 };
1207
1208 /**
1209  * struct ubifs_node_range - node length range description data structure.
1210  * @len: fixed node length
1211  * @min_len: minimum possible node length
1212  * @max_len: maximum possible node length
1213  *
1214  * If @max_len is %0, the node has fixed length @len.
1215  */
1216 struct ubifs_node_range {
1217         union {
1218                 int len;
1219                 int min_len;
1220         };
1221         int max_len;
1222 };
1223
1224 /**
1225  * struct ubifs_compressor - UBIFS compressor description structure.
1226  * @compr_type: compressor type (%UBIFS_COMPR_LZO, etc)
1227  * @cc: cryptoapi compressor handle
1228  * @comp_mutex: mutex used during compression
1229  * @decomp_mutex: mutex used during decompression
1230  * @name: compressor name
1231  * @capi_name: cryptoapi compressor name
1232  */
1233 struct ubifs_compressor {
1234         int compr_type;
1235         char *name;
1236         char *capi_name;
1237         int (*decompress)(const unsigned char *in, size_t in_len,
1238                           unsigned char *out, size_t *out_len);
1239 };
1240
1241 /**
1242  * struct ubifs_budget_req - budget requirements of an operation.
1243  *
1244  * @fast: non-zero if the budgeting should try to acquire budget quickly and
1245  *        should not try to call write-back
1246  * @recalculate: non-zero if @idx_growth, @data_growth, and @dd_growth fields
1247  *               have to be re-calculated
1248  * @new_page: non-zero if the operation adds a new page
1249  * @dirtied_page: non-zero if the operation makes a page dirty
1250  * @new_dent: non-zero if the operation adds a new directory entry
1251  * @mod_dent: non-zero if the operation removes or modifies an existing
1252  *            directory entry
1253  * @new_ino: non-zero if the operation adds a new inode
1254  * @new_ino_d: now much data newly created inode contains
1255  * @dirtied_ino: how many inodes the operation makes dirty
1256  * @dirtied_ino_d: now much data dirtied inode contains
1257  * @idx_growth: how much the index will supposedly grow
1258  * @data_growth: how much new data the operation will supposedly add
1259  * @dd_growth: how much data that makes other data dirty the operation will
1260  *             supposedly add
1261  *
1262  * @idx_growth, @data_growth and @dd_growth are not used in budget request. The
1263  * budgeting subsystem caches index and data growth values there to avoid
1264  * re-calculating them when the budget is released. However, if @idx_growth is
1265  * %-1, it is calculated by the release function using other fields.
1266  *
1267  * An inode may contain 4KiB of data at max., thus the widths of @new_ino_d
1268  * is 13 bits, and @dirtied_ino_d - 15, because up to 4 inodes may be made
1269  * dirty by the re-name operation.
1270  *
1271  * Note, UBIFS aligns node lengths to 8-bytes boundary, so the requester has to
1272  * make sure the amount of inode data which contribute to @new_ino_d and
1273  * @dirtied_ino_d fields are aligned.
1274  */
1275 struct ubifs_budget_req {
1276         unsigned int fast:1;
1277         unsigned int recalculate:1;
1278 #ifndef UBIFS_DEBUG
1279         unsigned int new_page:1;
1280         unsigned int dirtied_page:1;
1281         unsigned int new_dent:1;
1282         unsigned int mod_dent:1;
1283         unsigned int new_ino:1;
1284         unsigned int new_ino_d:13;
1285         unsigned int dirtied_ino:4;
1286         unsigned int dirtied_ino_d:15;
1287 #else
1288         /* Not bit-fields to check for overflows */
1289         unsigned int new_page;
1290         unsigned int dirtied_page;
1291         unsigned int new_dent;
1292         unsigned int mod_dent;
1293         unsigned int new_ino;
1294         unsigned int new_ino_d;
1295         unsigned int dirtied_ino;
1296         unsigned int dirtied_ino_d;
1297 #endif
1298         int idx_growth;
1299         int data_growth;
1300         int dd_growth;
1301 };
1302
1303 /**
1304  * struct ubifs_orphan - stores the inode number of an orphan.
1305  * @rb: rb-tree node of rb-tree of orphans sorted by inode number
1306  * @list: list head of list of orphans in order added
1307  * @new_list: list head of list of orphans added since the last commit
1308  * @cnext: next orphan to commit
1309  * @dnext: next orphan to delete
1310  * @inum: inode number
1311  * @new: %1 => added since the last commit, otherwise %0
1312  */
1313 struct ubifs_orphan {
1314         struct rb_node rb;
1315         struct list_head list;
1316         struct list_head new_list;
1317         struct ubifs_orphan *cnext;
1318         struct ubifs_orphan *dnext;
1319         ino_t inum;
1320         int new;
1321 };
1322
1323 /**
1324  * struct ubifs_mount_opts - UBIFS-specific mount options information.
1325  * @unmount_mode: selected unmount mode (%0 default, %1 normal, %2 fast)
1326  * @bulk_read: enable/disable bulk-reads (%0 default, %1 disabe, %2 enable)
1327  * @chk_data_crc: enable/disable CRC data checking when reading data nodes
1328  *                (%0 default, %1 disabe, %2 enable)
1329  * @override_compr: override default compressor (%0 - do not override and use
1330  *                  superblock compressor, %1 - override and use compressor
1331  *                  specified in @compr_type)
1332  * @compr_type: compressor type to override the superblock compressor with
1333  *              (%UBIFS_COMPR_NONE, etc)
1334  */
1335 struct ubifs_mount_opts {
1336         unsigned int unmount_mode:2;
1337         unsigned int bulk_read:2;
1338         unsigned int chk_data_crc:2;
1339         unsigned int override_compr:1;
1340         unsigned int compr_type:2;
1341 };
1342
1343 struct ubifs_debug_info;
1344
1345 /**
1346  * struct ubifs_info - UBIFS file-system description data structure
1347  * (per-superblock).
1348  * @vfs_sb: VFS @struct super_block object
1349  * @bdi: backing device info object to make VFS happy and disable read-ahead
1350  *
1351  * @highest_inum: highest used inode number
1352  * @max_sqnum: current global sequence number
1353  * @cmt_no: commit number of the last successfully completed commit, protected
1354  *          by @commit_sem
1355  * @cnt_lock: protects @highest_inum and @max_sqnum counters
1356  * @fmt_version: UBIFS on-flash format version
1357  * @ro_compat_version: R/O compatibility version
1358  * @uuid: UUID from super block
1359  *
1360  * @lhead_lnum: log head logical eraseblock number
1361  * @lhead_offs: log head offset
1362  * @ltail_lnum: log tail logical eraseblock number (offset is always 0)
1363  * @log_mutex: protects the log, @lhead_lnum, @lhead_offs, @ltail_lnum, and
1364  *             @bud_bytes
1365  * @min_log_bytes: minimum required number of bytes in the log
1366  * @cmt_bud_bytes: used during commit to temporarily amount of bytes in
1367  *                 committed buds
1368  *
1369  * @buds: tree of all buds indexed by bud LEB number
1370  * @bud_bytes: how many bytes of flash is used by buds
1371  * @buds_lock: protects the @buds tree, @bud_bytes, and per-journal head bud
1372  *             lists
1373  * @jhead_cnt: count of journal heads
1374  * @jheads: journal heads (head zero is base head)
1375  * @max_bud_bytes: maximum number of bytes allowed in buds
1376  * @bg_bud_bytes: number of bud bytes when background commit is initiated
1377  * @old_buds: buds to be released after commit ends
1378  * @max_bud_cnt: maximum number of buds
1379  *
1380  * @commit_sem: synchronizes committer with other processes
1381  * @cmt_state: commit state
1382  * @cs_lock: commit state lock
1383  * @cmt_wq: wait queue to sleep on if the log is full and a commit is running
1384  *
1385  * @big_lpt: flag that LPT is too big to write whole during commit
1386  * @no_chk_data_crc: do not check CRCs when reading data nodes (except during
1387  *                   recovery)
1388  * @bulk_read: enable bulk-reads
1389  * @default_compr: default compression algorithm (%UBIFS_COMPR_LZO, etc)
1390  * @rw_incompat: the media is not R/W compatible
1391  *
1392  * @tnc_mutex: protects the Tree Node Cache (TNC), @zroot, @cnext, @enext, and
1393  *             @calc_idx_sz
1394  * @zroot: zbranch which points to the root index node and znode
1395  * @cnext: next znode to commit
1396  * @enext: next znode to commit to empty space
1397  * @gap_lebs: array of LEBs used by the in-gaps commit method
1398  * @cbuf: commit buffer
1399  * @ileb_buf: buffer for commit in-the-gaps method
1400  * @ileb_len: length of data in ileb_buf
1401  * @ihead_lnum: LEB number of index head
1402  * @ihead_offs: offset of index head
1403  * @ilebs: pre-allocated index LEBs
1404  * @ileb_cnt: number of pre-allocated index LEBs
1405  * @ileb_nxt: next pre-allocated index LEBs
1406  * @old_idx: tree of index nodes obsoleted since the last commit start
1407  * @bottom_up_buf: a buffer which is used by 'dirty_cow_bottom_up()' in tnc.c
1408  *
1409  * @mst_node: master node
1410  * @mst_offs: offset of valid master node
1411  * @mst_mutex: protects the master node area, @mst_node, and @mst_offs
1412  *
1413  * @max_bu_buf_len: maximum bulk-read buffer length
1414  * @bu_mutex: protects the pre-allocated bulk-read buffer and @c->bu
1415  * @bu: pre-allocated bulk-read information
1416  *
1417  * @log_lebs: number of logical eraseblocks in the log
1418  * @log_bytes: log size in bytes
1419  * @log_last: last LEB of the log
1420  * @lpt_lebs: number of LEBs used for lprops table
1421  * @lpt_first: first LEB of the lprops table area
1422  * @lpt_last: last LEB of the lprops table area
1423  * @orph_lebs: number of LEBs used for the orphan area
1424  * @orph_first: first LEB of the orphan area
1425  * @orph_last: last LEB of the orphan area
1426  * @main_lebs: count of LEBs in the main area
1427  * @main_first: first LEB of the main area
1428  * @main_bytes: main area size in bytes
1429  *
1430  * @key_hash_type: type of the key hash
1431  * @key_hash: direntry key hash function
1432  * @key_fmt: key format
1433  * @key_len: key length
1434  * @fanout: fanout of the index tree (number of links per indexing node)
1435  *
1436  * @min_io_size: minimal input/output unit size
1437  * @min_io_shift: number of bits in @min_io_size minus one
1438  * @leb_size: logical eraseblock size in bytes
1439  * @half_leb_size: half LEB size
1440  * @leb_cnt: count of logical eraseblocks
1441  * @max_leb_cnt: maximum count of logical eraseblocks
1442  * @old_leb_cnt: count of logical eraseblocks before re-size
1443  * @ro_media: the underlying UBI volume is read-only
1444  *
1445  * @dirty_pg_cnt: number of dirty pages (not used)
1446  * @dirty_zn_cnt: number of dirty znodes
1447  * @clean_zn_cnt: number of clean znodes
1448  *
1449  * @budg_idx_growth: amount of bytes budgeted for index growth
1450  * @budg_data_growth: amount of bytes budgeted for cached data
1451  * @budg_dd_growth: amount of bytes budgeted for cached data that will make
1452  *                  other data dirty
1453  * @budg_uncommitted_idx: amount of bytes were budgeted for growth of the index,
1454  *                        but which still have to be taken into account because
1455  *                        the index has not been committed so far
1456  * @space_lock: protects @budg_idx_growth, @budg_data_growth, @budg_dd_growth,
1457  *              @budg_uncommited_idx, @min_idx_lebs, @old_idx_sz, @lst,
1458  *              @nospace, and @nospace_rp;
1459  * @min_idx_lebs: minimum number of LEBs required for the index
1460  * @old_idx_sz: size of index on flash
1461  * @calc_idx_sz: temporary variable which is used to calculate new index size
1462  *               (contains accurate new index size at end of TNC commit start)
1463  * @lst: lprops statistics
1464  * @nospace: non-zero if the file-system does not have flash space (used as
1465  *           optimization)
1466  * @nospace_rp: the same as @nospace, but additionally means that even reserved
1467  *              pool is full
1468  *
1469  * @page_budget: budget for a page
1470  * @inode_budget: budget for an inode
1471  * @dent_budget: budget for a directory entry
1472  *
1473  * @ref_node_alsz: size of the LEB reference node aligned to the min. flash
1474  * I/O unit
1475  * @mst_node_alsz: master node aligned size
1476  * @min_idx_node_sz: minimum indexing node aligned on 8-bytes boundary
1477  * @max_idx_node_sz: maximum indexing node aligned on 8-bytes boundary
1478  * @max_inode_sz: maximum possible inode size in bytes
1479  * @max_znode_sz: size of znode in bytes
1480  *
1481  * @leb_overhead: how many bytes are wasted in an LEB when it is filled with
1482  *                data nodes of maximum size - used in free space reporting
1483  * @dead_wm: LEB dead space watermark
1484  * @dark_wm: LEB dark space watermark
1485  * @block_cnt: count of 4KiB blocks on the FS
1486  *
1487  * @ranges: UBIFS node length ranges
1488  * @ubi: UBI volume descriptor
1489  * @di: UBI device information
1490  * @vi: UBI volume information
1491  *
1492  * @orph_tree: rb-tree of orphan inode numbers
1493  * @orph_list: list of orphan inode numbers in order added
1494  * @orph_new: list of orphan inode numbers added since last commit
1495  * @orph_cnext: next orphan to commit
1496  * @orph_dnext: next orphan to delete
1497  * @orphan_lock: lock for orph_tree and orph_new
1498  * @orph_buf: buffer for orphan nodes
1499  * @new_orphans: number of orphans since last commit
1500  * @cmt_orphans: number of orphans being committed
1501  * @tot_orphans: number of orphans in the rb_tree
1502  * @max_orphans: maximum number of orphans allowed
1503  * @ohead_lnum: orphan head LEB number
1504  * @ohead_offs: orphan head offset
1505  * @no_orphs: non-zero if there are no orphans
1506  *
1507  * @bgt: UBIFS background thread
1508  * @bgt_name: background thread name
1509  * @need_bgt: if background thread should run
1510  * @need_wbuf_sync: if write-buffers have to be synchronized
1511  *
1512  * @gc_lnum: LEB number used for garbage collection
1513  * @sbuf: a buffer of LEB size used by GC and replay for scanning
1514  * @idx_gc: list of index LEBs that have been garbage collected
1515  * @idx_gc_cnt: number of elements on the idx_gc list
1516  * @gc_seq: incremented for every non-index LEB garbage collected
1517  * @gced_lnum: last non-index LEB that was garbage collected
1518  *
1519  * @infos_list: links all 'ubifs_info' objects
1520  * @umount_mutex: serializes shrinker and un-mount
1521  * @shrinker_run_no: shrinker run number
1522  *
1523  * @space_bits: number of bits needed to record free or dirty space
1524  * @lpt_lnum_bits: number of bits needed to record a LEB number in the LPT
1525  * @lpt_offs_bits: number of bits needed to record an offset in the LPT
1526  * @lpt_spc_bits: number of bits needed to space in the LPT
1527  * @pcnt_bits: number of bits needed to record pnode or nnode number
1528  * @lnum_bits: number of bits needed to record LEB number
1529  * @nnode_sz: size of on-flash nnode
1530  * @pnode_sz: size of on-flash pnode
1531  * @ltab_sz: size of on-flash LPT lprops table
1532  * @lsave_sz: size of on-flash LPT save table
1533  * @pnode_cnt: number of pnodes
1534  * @nnode_cnt: number of nnodes
1535  * @lpt_hght: height of the LPT
1536  * @pnodes_have: number of pnodes in memory
1537  *
1538  * @lp_mutex: protects lprops table and all the other lprops-related fields
1539  * @lpt_lnum: LEB number of the root nnode of the LPT
1540  * @lpt_offs: offset of the root nnode of the LPT
1541  * @nhead_lnum: LEB number of LPT head
1542  * @nhead_offs: offset of LPT head
1543  * @lpt_drty_flgs: dirty flags for LPT special nodes e.g. ltab
1544  * @dirty_nn_cnt: number of dirty nnodes
1545  * @dirty_pn_cnt: number of dirty pnodes
1546  * @check_lpt_free: flag that indicates LPT GC may be needed
1547  * @lpt_sz: LPT size
1548  * @lpt_nod_buf: buffer for an on-flash nnode or pnode
1549  * @lpt_buf: buffer of LEB size used by LPT
1550  * @nroot: address in memory of the root nnode of the LPT
1551  * @lpt_cnext: next LPT node to commit
1552  * @lpt_heap: array of heaps of categorized lprops
1553  * @dirty_idx: a (reverse sorted) copy of the LPROPS_DIRTY_IDX heap as at
1554  *             previous commit start
1555  * @uncat_list: list of un-categorized LEBs
1556  * @empty_list: list of empty LEBs
1557  * @freeable_list: list of freeable non-index LEBs (free + dirty == leb_size)
1558  * @frdi_idx_list: list of freeable index LEBs (free + dirty == leb_size)
1559  * @freeable_cnt: number of freeable LEBs in @freeable_list
1560  *
1561  * @ltab_lnum: LEB number of LPT's own lprops table
1562  * @ltab_offs: offset of LPT's own lprops table
1563  * @ltab: LPT's own lprops table
1564  * @ltab_cmt: LPT's own lprops table (commit copy)
1565  * @lsave_cnt: number of LEB numbers in LPT's save table
1566  * @lsave_lnum: LEB number of LPT's save table
1567  * @lsave_offs: offset of LPT's save table
1568  * @lsave: LPT's save table
1569  * @lscan_lnum: LEB number of last LPT scan
1570  *
1571  * @rp_size: size of the reserved pool in bytes
1572  * @report_rp_size: size of the reserved pool reported to user-space
1573  * @rp_uid: reserved pool user ID
1574  * @rp_gid: reserved pool group ID
1575  *
1576  * @empty: if the UBI device is empty
1577  * @replay_tree: temporary tree used during journal replay
1578  * @replay_list: temporary list used during journal replay
1579  * @replay_buds: list of buds to replay
1580  * @cs_sqnum: sequence number of first node in the log (commit start node)
1581  * @replay_sqnum: sequence number of node currently being replayed
1582  * @need_recovery: file-system needs recovery
1583  * @replaying: set to %1 during journal replay
1584  * @unclean_leb_list: LEBs to recover when mounting ro to rw
1585  * @rcvrd_mst_node: recovered master node to write when mounting ro to rw
1586  * @size_tree: inode size information for recovery
1587  * @remounting_rw: set while remounting from ro to rw (sb flags have MS_RDONLY)
1588  * @always_chk_crc: always check CRCs (while mounting and remounting rw)
1589  * @mount_opts: UBIFS-specific mount options
1590  *
1591  * @dbg: debugging-related information
1592  */
1593 struct ubifs_info {
1594         struct super_block *vfs_sb;
1595
1596         ino_t highest_inum;
1597         unsigned long long max_sqnum;
1598         unsigned long long cmt_no;
1599         spinlock_t cnt_lock;
1600         int fmt_version;
1601         int ro_compat_version;
1602         unsigned char uuid[16];
1603
1604         int lhead_lnum;
1605         int lhead_offs;
1606         int ltail_lnum;
1607         struct mutex log_mutex;
1608         int min_log_bytes;
1609         long long cmt_bud_bytes;
1610
1611         struct rb_root buds;
1612         long long bud_bytes;
1613         spinlock_t buds_lock;
1614         int jhead_cnt;
1615         struct ubifs_jhead *jheads;
1616         long long max_bud_bytes;
1617         long long bg_bud_bytes;
1618         struct list_head old_buds;
1619         int max_bud_cnt;
1620
1621         struct rw_semaphore commit_sem;
1622         int cmt_state;
1623         spinlock_t cs_lock;
1624         wait_queue_head_t cmt_wq;
1625
1626         unsigned int big_lpt:1;
1627         unsigned int no_chk_data_crc:1;
1628         unsigned int bulk_read:1;
1629         unsigned int default_compr:2;
1630         unsigned int rw_incompat:1;
1631
1632         struct mutex tnc_mutex;
1633         struct ubifs_zbranch zroot;
1634         struct ubifs_znode *cnext;
1635         struct ubifs_znode *enext;
1636         int *gap_lebs;
1637         void *cbuf;
1638         void *ileb_buf;
1639         int ileb_len;
1640         int ihead_lnum;
1641         int ihead_offs;
1642         int *ilebs;
1643         int ileb_cnt;
1644         int ileb_nxt;
1645         struct rb_root old_idx;
1646         int *bottom_up_buf;
1647
1648         struct ubifs_mst_node *mst_node;
1649         int mst_offs;
1650         struct mutex mst_mutex;
1651
1652         int max_bu_buf_len;
1653         struct mutex bu_mutex;
1654         struct bu_info bu;
1655
1656         int log_lebs;
1657         long long log_bytes;
1658         int log_last;
1659         int lpt_lebs;
1660         int lpt_first;
1661         int lpt_last;
1662         int orph_lebs;
1663         int orph_first;
1664         int orph_last;
1665         int main_lebs;
1666         int main_first;
1667         long long main_bytes;
1668
1669         uint8_t key_hash_type;
1670         uint32_t (*key_hash)(const char *str, int len);
1671         int key_fmt;
1672         int key_len;
1673         int fanout;
1674
1675         int min_io_size;
1676         int min_io_shift;
1677         int leb_size;
1678         int half_leb_size;
1679         int leb_cnt;
1680         int max_leb_cnt;
1681         int old_leb_cnt;
1682         int ro_media;
1683
1684         long long budg_idx_growth;
1685         long long budg_data_growth;
1686         long long budg_dd_growth;
1687         long long budg_uncommitted_idx;
1688         spinlock_t space_lock;
1689         int min_idx_lebs;
1690         unsigned long long old_idx_sz;
1691         unsigned long long calc_idx_sz;
1692         struct ubifs_lp_stats lst;
1693         unsigned int nospace:1;
1694         unsigned int nospace_rp:1;
1695
1696         int page_budget;
1697         int inode_budget;
1698         int dent_budget;
1699
1700         int ref_node_alsz;
1701         int mst_node_alsz;
1702         int min_idx_node_sz;
1703         int max_idx_node_sz;
1704         long long max_inode_sz;
1705         int max_znode_sz;
1706
1707         int leb_overhead;
1708         int dead_wm;
1709         int dark_wm;
1710         int block_cnt;
1711
1712         struct ubifs_node_range ranges[UBIFS_NODE_TYPES_CNT];
1713         struct ubi_volume_desc *ubi;
1714         struct ubi_device_info di;
1715         struct ubi_volume_info vi;
1716
1717         struct rb_root orph_tree;
1718         struct list_head orph_list;
1719         struct list_head orph_new;
1720         struct ubifs_orphan *orph_cnext;
1721         struct ubifs_orphan *orph_dnext;
1722         spinlock_t orphan_lock;
1723         void *orph_buf;
1724         int new_orphans;
1725         int cmt_orphans;
1726         int tot_orphans;
1727         int max_orphans;
1728         int ohead_lnum;
1729         int ohead_offs;
1730         int no_orphs;
1731
1732         struct task_struct *bgt;
1733         char bgt_name[sizeof(BGT_NAME_PATTERN) + 9];
1734         int need_bgt;
1735         int need_wbuf_sync;
1736
1737         int gc_lnum;
1738         void *sbuf;
1739         struct list_head idx_gc;
1740         int idx_gc_cnt;
1741         int gc_seq;
1742         int gced_lnum;
1743
1744         struct list_head infos_list;
1745         struct mutex umount_mutex;
1746         unsigned int shrinker_run_no;
1747
1748         int space_bits;
1749         int lpt_lnum_bits;
1750         int lpt_offs_bits;
1751         int lpt_spc_bits;
1752         int pcnt_bits;
1753         int lnum_bits;
1754         int nnode_sz;
1755         int pnode_sz;
1756         int ltab_sz;
1757         int lsave_sz;
1758         int pnode_cnt;
1759         int nnode_cnt;
1760         int lpt_hght;
1761         int pnodes_have;
1762
1763         struct mutex lp_mutex;
1764         int lpt_lnum;
1765         int lpt_offs;
1766         int nhead_lnum;
1767         int nhead_offs;
1768         int lpt_drty_flgs;
1769         int dirty_nn_cnt;
1770         int dirty_pn_cnt;
1771         int check_lpt_free;
1772         long long lpt_sz;
1773         void *lpt_nod_buf;
1774         void *lpt_buf;
1775         struct ubifs_nnode *nroot;
1776         struct ubifs_cnode *lpt_cnext;
1777         struct ubifs_lpt_heap lpt_heap[LPROPS_HEAP_CNT];
1778         struct ubifs_lpt_heap dirty_idx;
1779         struct list_head uncat_list;
1780         struct list_head empty_list;
1781         struct list_head freeable_list;
1782         struct list_head frdi_idx_list;
1783         int freeable_cnt;
1784
1785         int ltab_lnum;
1786         int ltab_offs;
1787         struct ubifs_lpt_lprops *ltab;
1788         struct ubifs_lpt_lprops *ltab_cmt;
1789         int lsave_cnt;
1790         int lsave_lnum;
1791         int lsave_offs;
1792         int *lsave;
1793         int lscan_lnum;
1794
1795         long long rp_size;
1796         long long report_rp_size;
1797         uid_t rp_uid;
1798         gid_t rp_gid;
1799
1800         /* The below fields are used only during mounting and re-mounting */
1801         int empty;
1802         struct rb_root replay_tree;
1803         struct list_head replay_list;
1804         struct list_head replay_buds;
1805         unsigned long long cs_sqnum;
1806         unsigned long long replay_sqnum;
1807         int need_recovery;
1808         int replaying;
1809         struct list_head unclean_leb_list;
1810         struct ubifs_mst_node *rcvrd_mst_node;
1811         struct rb_root size_tree;
1812         int remounting_rw;
1813         int always_chk_crc;
1814         struct ubifs_mount_opts mount_opts;
1815
1816 #ifdef CONFIG_UBIFS_FS_DEBUG
1817         struct ubifs_debug_info *dbg;
1818 #endif
1819 };
1820
1821 extern spinlock_t ubifs_infos_lock;
1822 extern struct kmem_cache *ubifs_inode_slab;
1823 extern const struct super_operations ubifs_super_operations;
1824 extern const struct address_space_operations ubifs_file_address_operations;
1825 extern const struct file_operations ubifs_file_operations;
1826 extern const struct inode_operations ubifs_file_inode_operations;
1827 extern const struct file_operations ubifs_dir_operations;
1828 extern const struct inode_operations ubifs_dir_inode_operations;
1829 extern const struct inode_operations ubifs_symlink_inode_operations;
1830 extern struct backing_dev_info ubifs_backing_dev_info;
1831 extern struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
1832
1833 /* io.c */
1834 void ubifs_ro_mode(struct ubifs_info *c, int err);
1835 int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len);
1836 int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs,
1837                            int dtype);
1838 int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf);
1839 int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
1840                     int lnum, int offs);
1841 int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
1842                          int lnum, int offs);
1843 int ubifs_write_node(struct ubifs_info *c, void *node, int len, int lnum,
1844                      int offs, int dtype);
1845 int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
1846                      int offs, int quiet, int must_chk_crc);
1847 void ubifs_prepare_node(struct ubifs_info *c, void *buf, int len, int pad);
1848 void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last);
1849 int ubifs_io_init(struct ubifs_info *c);
1850 void ubifs_pad(const struct ubifs_info *c, void *buf, int pad);
1851 int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf);
1852 int ubifs_bg_wbufs_sync(struct ubifs_info *c);
1853 void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum);
1854 int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode);
1855
1856 /* scan.c */
1857 struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,
1858                                   int offs, void *sbuf);
1859 void ubifs_scan_destroy(struct ubifs_scan_leb *sleb);
1860 int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,
1861                       int offs, int quiet);
1862 struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,
1863                                         int offs, void *sbuf);
1864 void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1865                     int lnum, int offs);
1866 int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,
1867                    void *buf, int offs);
1868 void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,
1869                               void *buf);
1870
1871 /* log.c */
1872 void ubifs_add_bud(struct ubifs_info *c, struct ubifs_bud *bud);
1873 void ubifs_create_buds_lists(struct ubifs_info *c);
1874 int ubifs_add_bud_to_log(struct ubifs_info *c, int jhead, int lnum, int offs);
1875 struct ubifs_bud *ubifs_search_bud(struct ubifs_info *c, int lnum);
1876 struct ubifs_wbuf *ubifs_get_wbuf(struct ubifs_info *c, int lnum);
1877 int ubifs_log_start_commit(struct ubifs_info *c, int *ltail_lnum);
1878 int ubifs_log_end_commit(struct ubifs_info *c, int new_ltail_lnum);
1879 int ubifs_log_post_commit(struct ubifs_info *c, int old_ltail_lnum);
1880 int ubifs_consolidate_log(struct ubifs_info *c);
1881
1882 /* journal.c */
1883 int ubifs_jnl_update(struct ubifs_info *c, const struct inode *dir,
1884                      const struct qstr *nm, const struct inode *inode,
1885                      int deletion, int xent);
1886 int ubifs_jnl_write_data(struct ubifs_info *c, const struct inode *inode,
1887                          const union ubifs_key *key, const void *buf, int len);
1888 int ubifs_jnl_write_inode(struct ubifs_info *c, const struct inode *inode);
1889 int ubifs_jnl_delete_inode(struct ubifs_info *c, const struct inode *inode);
1890 int ubifs_jnl_rename(struct ubifs_info *c, const struct inode *old_dir,
1891                      const struct dentry *old_dentry,
1892                      const struct inode *new_dir,
1893                      const struct dentry *new_dentry, int sync);
1894 int ubifs_jnl_truncate(struct ubifs_info *c, const struct inode *inode,
1895                        loff_t old_size, loff_t new_size);
1896 int ubifs_jnl_delete_xattr(struct ubifs_info *c, const struct inode *host,
1897                            const struct inode *inode, const struct qstr *nm);
1898 int ubifs_jnl_change_xattr(struct ubifs_info *c, const struct inode *inode1,
1899                            const struct inode *inode2);
1900
1901 /* budget.c */
1902 int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req);
1903 void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req);
1904 void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
1905                                       struct ubifs_inode *ui);
1906 int ubifs_budget_inode_op(struct ubifs_info *c, struct inode *inode,
1907                           struct ubifs_budget_req *req);
1908 void ubifs_release_ino_dirty(struct ubifs_info *c, struct inode *inode,
1909                                 struct ubifs_budget_req *req);
1910 void ubifs_cancel_ino_op(struct ubifs_info *c, struct inode *inode,
1911                          struct ubifs_budget_req *req);
1912 long long ubifs_get_free_space(struct ubifs_info *c);
1913 long long ubifs_get_free_space_nolock(struct ubifs_info *c);
1914 int ubifs_calc_min_idx_lebs(struct ubifs_info *c);
1915 void ubifs_convert_page_budget(struct ubifs_info *c);
1916 long long ubifs_reported_space(const struct ubifs_info *c, long long free);
1917 long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs);
1918
1919 /* find.c */
1920 int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *free,
1921                           int squeeze);
1922 int ubifs_find_free_leb_for_idx(struct ubifs_info *c);
1923 int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
1924                          int min_space, int pick_free);
1925 int ubifs_find_dirty_idx_leb(struct ubifs_info *c);
1926 int ubifs_save_dirty_idx_lnums(struct ubifs_info *c);
1927
1928 /* tnc.c */
1929 int ubifs_lookup_level0(struct ubifs_info *c, const union ubifs_key *key,
1930                         struct ubifs_znode **zn, int *n);
1931 int ubifs_tnc_lookup_nm(struct ubifs_info *c, const union ubifs_key *key,
1932                         void *node, const struct qstr *nm);
1933 int ubifs_tnc_locate(struct ubifs_info *c, const union ubifs_key *key,
1934                      void *node, int *lnum, int *offs);
1935 int ubifs_tnc_add(struct ubifs_info *c, const union ubifs_key *key, int lnum,
1936                   int offs, int len);
1937 int ubifs_tnc_replace(struct ubifs_info *c, const union ubifs_key *key,
1938                       int old_lnum, int old_offs, int lnum, int offs, int len);
1939 int ubifs_tnc_add_nm(struct ubifs_info *c, const union ubifs_key *key,
1940                      int lnum, int offs, int len, const struct qstr *nm);
1941 int ubifs_tnc_remove(struct ubifs_info *c, const union ubifs_key *key);
1942 int ubifs_tnc_remove_nm(struct ubifs_info *c, const union ubifs_key *key,
1943                         const struct qstr *nm);
1944 int ubifs_tnc_remove_range(struct ubifs_info *c, union ubifs_key *from_key,
1945                            union ubifs_key *to_key);
1946 int ubifs_tnc_remove_ino(struct ubifs_info *c, ino_t inum);
1947 struct ubifs_dent_node *ubifs_tnc_next_ent(struct ubifs_info *c,
1948                                            union ubifs_key *key,
1949                                            const struct qstr *nm);
1950 void ubifs_tnc_close(struct ubifs_info *c);
1951 int ubifs_tnc_has_node(struct ubifs_info *c, union ubifs_key *key, int level,
1952                        int lnum, int offs, int is_idx);
1953 int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
1954                          int lnum, int offs);
1955 /* Shared by tnc.c for tnc_commit.c */
1956 void destroy_old_idx(struct ubifs_info *c);
1957 int is_idx_node_in_tnc(struct ubifs_info *c, union ubifs_key *key, int level,
1958                        int lnum, int offs);
1959 int insert_old_idx_znode(struct ubifs_info *c, struct ubifs_znode *znode);
1960 int ubifs_tnc_get_bu_keys(struct ubifs_info *c, struct bu_info *bu);
1961 int ubifs_tnc_bulk_read(struct ubifs_info *c, struct bu_info *bu);
1962
1963 /* tnc_misc.c */
1964 struct ubifs_znode *ubifs_tnc_levelorder_next(struct ubifs_znode *zr,
1965                                               struct ubifs_znode *znode);
1966 int ubifs_search_zbranch(const struct ubifs_info *c,
1967                          const struct ubifs_znode *znode,
1968                          const union ubifs_key *key, int *n);
1969 struct ubifs_znode *ubifs_tnc_postorder_first(struct ubifs_znode *znode);
1970 struct ubifs_znode *ubifs_tnc_postorder_next(struct ubifs_znode *znode);
1971 long ubifs_destroy_tnc_subtree(struct ubifs_znode *zr);
1972 struct ubifs_znode *ubifs_load_znode(struct ubifs_info *c,
1973                                      struct ubifs_zbranch *zbr,
1974                                      struct ubifs_znode *parent, int iip);
1975 int ubifs_tnc_read_node(struct ubifs_info *c, struct ubifs_zbranch *zbr,
1976                         void *node);
1977
1978 /* tnc_commit.c */
1979 int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot);
1980 int ubifs_tnc_end_commit(struct ubifs_info *c);
1981
1982 /* shrinker.c */
1983 int ubifs_shrinker(int nr_to_scan, gfp_t gfp_mask);
1984
1985 /* commit.c */
1986 int ubifs_bg_thread(void *info);
1987 void ubifs_commit_required(struct ubifs_info *c);
1988 void ubifs_request_bg_commit(struct ubifs_info *c);
1989 int ubifs_run_commit(struct ubifs_info *c);
1990 void ubifs_recovery_commit(struct ubifs_info *c);
1991 int ubifs_gc_should_commit(struct ubifs_info *c);
1992 void ubifs_wait_for_commit(struct ubifs_info *c);
1993
1994 /* master.c */
1995 int ubifs_read_master(struct ubifs_info *c);
1996 int ubifs_write_master(struct ubifs_info *c);
1997
1998 /* sb.c */
1999 int ubifs_read_superblock(struct ubifs_info *c);
2000 struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c);
2001 int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup);
2002
2003 /* replay.c */
2004 int ubifs_validate_entry(struct ubifs_info *c,
2005                          const struct ubifs_dent_node *dent);
2006 int ubifs_replay_journal(struct ubifs_info *c);
2007
2008 /* gc.c */
2009 int ubifs_garbage_collect(struct ubifs_info *c, int anyway);
2010 int ubifs_gc_start_commit(struct ubifs_info *c);
2011 int ubifs_gc_end_commit(struct ubifs_info *c);
2012 void ubifs_destroy_idx_gc(struct ubifs_info *c);
2013 int ubifs_get_idx_gc_leb(struct ubifs_info *c);
2014 int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp);
2015
2016 /* orphan.c */
2017 int ubifs_add_orphan(struct ubifs_info *c, ino_t inum);
2018 void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum);
2019 int ubifs_orphan_start_commit(struct ubifs_info *c);
2020 int ubifs_orphan_end_commit(struct ubifs_info *c);
2021 int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only);
2022 int ubifs_clear_orphans(struct ubifs_info *c);
2023
2024 /* lpt.c */
2025 int ubifs_calc_lpt_geom(struct ubifs_info *c);
2026 int ubifs_create_dflt_lpt(struct ubifs_info *c, int *main_lebs, int lpt_first,
2027                           int *lpt_lebs, int *big_lpt);
2028 int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr);
2029 struct ubifs_lprops *ubifs_lpt_lookup(struct ubifs_info *c, int lnum);
2030 struct ubifs_lprops *ubifs_lpt_lookup_dirty(struct ubifs_info *c, int lnum);
2031 int ubifs_lpt_scan_nolock(struct ubifs_info *c, int start_lnum, int end_lnum,
2032                           ubifs_lpt_scan_callback scan_cb, void *data);
2033
2034 /* Shared by lpt.c for lpt_commit.c */
2035 void ubifs_pack_lsave(struct ubifs_info *c, void *buf, int *lsave);
2036 void ubifs_pack_ltab(struct ubifs_info *c, void *buf,
2037                      struct ubifs_lpt_lprops *ltab);
2038 void ubifs_pack_pnode(struct ubifs_info *c, void *buf,
2039                       struct ubifs_pnode *pnode);
2040 void ubifs_pack_nnode(struct ubifs_info *c, void *buf,
2041                       struct ubifs_nnode *nnode);
2042 struct ubifs_pnode *ubifs_get_pnode(struct ubifs_info *c,
2043                                     struct ubifs_nnode *parent, int iip);
2044 struct ubifs_nnode *ubifs_get_nnode(struct ubifs_info *c,
2045                                     struct ubifs_nnode *parent, int iip);
2046 int ubifs_read_nnode(struct ubifs_info *c, struct ubifs_nnode *parent, int iip);
2047 void ubifs_add_lpt_dirt(struct ubifs_info *c, int lnum, int dirty);
2048 void ubifs_add_nnode_dirt(struct ubifs_info *c, struct ubifs_nnode *nnode);
2049 uint32_t ubifs_unpack_bits(uint8_t **addr, int *pos, int nrbits);
2050 struct ubifs_nnode *ubifs_first_nnode(struct ubifs_info *c, int *hght);
2051 /* Needed only in debugging code in lpt_commit.c */
2052 int ubifs_unpack_nnode(const struct ubifs_info *c, void *buf,
2053                        struct ubifs_nnode *nnode);
2054
2055 /* lpt_commit.c */
2056 int ubifs_lpt_start_commit(struct ubifs_info *c);
2057 int ubifs_lpt_end_commit(struct ubifs_info *c);
2058 int ubifs_lpt_post_commit(struct ubifs_info *c);
2059 void ubifs_lpt_free(struct ubifs_info *c, int wr_only);
2060
2061 /* lprops.c */
2062 const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c,
2063                                            const struct ubifs_lprops *lp,
2064                                            int free, int dirty, int flags,
2065                                            int idx_gc_cnt);
2066 void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst);
2067 void ubifs_add_to_cat(struct ubifs_info *c, struct ubifs_lprops *lprops,
2068                       int cat);
2069 void ubifs_replace_cat(struct ubifs_info *c, struct ubifs_lprops *old_lprops,
2070                        struct ubifs_lprops *new_lprops);
2071 void ubifs_ensure_cat(struct ubifs_info *c, struct ubifs_lprops *lprops);
2072 int ubifs_categorize_lprops(const struct ubifs_info *c,
2073                             const struct ubifs_lprops *lprops);
2074 int ubifs_change_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
2075                         int flags_set, int flags_clean, int idx_gc_cnt);
2076 int ubifs_update_one_lp(struct ubifs_info *c, int lnum, int free, int dirty,
2077                         int flags_set, int flags_clean);
2078 int ubifs_read_one_lp(struct ubifs_info *c, int lnum, struct ubifs_lprops *lp);
2079 const struct ubifs_lprops *ubifs_fast_find_free(struct ubifs_info *c);
2080 const struct ubifs_lprops *ubifs_fast_find_empty(struct ubifs_info *c);
2081 const struct ubifs_lprops *ubifs_fast_find_freeable(struct ubifs_info *c);
2082 const struct ubifs_lprops *ubifs_fast_find_frdi_idx(struct ubifs_info *c);
2083
2084 /* file.c */
2085 int ubifs_fsync(struct file *file, struct dentry *dentry, int datasync);
2086 int ubifs_setattr(struct dentry *dentry, struct iattr *attr);
2087
2088 /* dir.c */
2089 struct inode *ubifs_new_inode(struct ubifs_info *c, const struct inode *dir,
2090                               int mode);
2091 int ubifs_getattr(struct vfsmount *mnt, struct dentry *dentry,
2092                   struct kstat *stat);
2093
2094 /* xattr.c */
2095 int ubifs_setxattr(struct dentry *dentry, const char *name,
2096                    const void *value, size_t size, int flags);
2097 ssize_t ubifs_getxattr(struct dentry *dentry, const char *name, void *buf,
2098                        size_t size);
2099 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size);
2100 int ubifs_removexattr(struct dentry *dentry, const char *name);
2101
2102 /* super.c */
2103 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum);
2104 int ubifs_iput(struct inode *inode);
2105
2106 /* recovery.c */
2107 int ubifs_recover_master_node(struct ubifs_info *c);
2108 int ubifs_write_rcvrd_mst_node(struct ubifs_info *c);
2109 struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
2110                                          int offs, void *sbuf, int grouped);
2111 struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
2112                                              int offs, void *sbuf);
2113 int ubifs_recover_inl_heads(const struct ubifs_info *c, void *sbuf);
2114 int ubifs_clean_lebs(const struct ubifs_info *c, void *sbuf);
2115 int ubifs_rcvry_gc_commit(struct ubifs_info *c);
2116 int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
2117                              int deletion, loff_t new_size);
2118 int ubifs_recover_size(struct ubifs_info *c);
2119 void ubifs_destroy_size_tree(struct ubifs_info *c);
2120
2121 /* ioctl.c */
2122 long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
2123 void ubifs_set_inode_flags(struct inode *inode);
2124 #ifdef CONFIG_COMPAT
2125 long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
2126 #endif
2127
2128 /* compressor.c */
2129 int __init ubifs_compressors_init(void);
2130 void __exit ubifs_compressors_exit(void);
2131 void ubifs_compress(const void *in_buf, int in_len, void *out_buf, int *out_len,
2132                     int *compr_type);
2133 int ubifs_decompress(const void *buf, int len, void *out, int *out_len,
2134                      int compr_type);
2135
2136 #include "debug.h"
2137 #include "misc.h"
2138 #include "key.h"
2139
2140 /* todo: Move these to a common U-Boot header */
2141 int lzo1x_decompress_safe(const unsigned char *in, size_t in_len,
2142                           unsigned char *out, size_t *out_len);
2143 #endif /* !__UBIFS_H__ */