LXR linux/fs/nilfs2/nilfs.h

   1/* SPDX-License-Identifier: GPL-2.0+ */
   2/*
   3 * nilfs.h - NILFS local header file.
   4 *
   5 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
   6 *
   7 * Written by Koji Sato and Ryusuke Konishi.
   8 */
   9
  10#ifndef _NILFS_H
  11#define _NILFS_H
  12
  13#include <linux/kernel.h>
  14#include <linux/buffer_head.h>
  15#include <linux/spinlock.h>
  16#include <linux/blkdev.h>
  17#include <linux/nilfs2_api.h>
  18#include <linux/nilfs2_ondisk.h>
  19#include "the_nilfs.h"
  20#include "bmap.h"
  21
  22/**
  23 * struct nilfs_inode_info - nilfs inode data in memory
  24 * @i_flags: inode flags
  25 * @i_state: dynamic state flags
  26 * @i_bmap: pointer on i_bmap_data
  27 * @i_bmap_data: raw block mapping
  28 * @i_xattr: <TODO>
  29 * @i_dir_start_lookup: page index of last successful search
  30 * @i_cno: checkpoint number for GC inode
  31 * @i_btnode_cache: cached pages of b-tree nodes
  32 * @i_dirty: list for connecting dirty files
  33 * @xattr_sem: semaphore for extended attributes processing
  34 * @i_bh: buffer contains disk inode
  35 * @i_root: root object of the current filesystem tree
  36 * @vfs_inode: VFS inode object
  37 */
  38struct nilfs_inode_info {
  39        __u32 i_flags;
  40        unsigned long  i_state;         /* Dynamic state flags */
  41        struct nilfs_bmap *i_bmap;
  42        struct nilfs_bmap i_bmap_data;
  43        __u64 i_xattr;  /* sector_t ??? */
  44        __u32 i_dir_start_lookup;
  45        __u64 i_cno;            /* check point number for GC inode */
  46        struct address_space i_btnode_cache;
  47        struct list_head i_dirty;       /* List for connecting dirty files */
  48
  49#ifdef CONFIG_NILFS_XATTR
  50        /*
  51         * Extended attributes can be read independently of the main file
  52         * data. Taking i_sem even when reading would cause contention
  53         * between readers of EAs and writers of regular file data, so
  54         * instead we synchronize on xattr_sem when reading or changing
  55         * EAs.
  56         */
  57        struct rw_semaphore xattr_sem;
  58#endif
  59        struct buffer_head *i_bh;       /*
  60                                         * i_bh contains a new or dirty
  61                                         * disk inode.
  62                                         */
  63        struct nilfs_root *i_root;
  64        struct inode vfs_inode;
  65};
  66
  67static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
  68{
  69        return container_of(inode, struct nilfs_inode_info, vfs_inode);
  70}
  71
  72static inline struct nilfs_inode_info *
  73NILFS_BMAP_I(const struct nilfs_bmap *bmap)
  74{
  75        return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
  76}
  77
  78static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
  79{
  80        struct nilfs_inode_info *ii =
  81                container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
  82        return &ii->vfs_inode;
  83}
  84
  85/*
  86 * Dynamic state flags of NILFS on-memory inode (i_state)
  87 */
  88enum {
  89        NILFS_I_NEW = 0,                /* Inode is newly created */
  90        NILFS_I_DIRTY,                  /* The file is dirty */
  91        NILFS_I_QUEUED,                 /* inode is in dirty_files list */
  92        NILFS_I_BUSY,                   /*
  93                                         * Inode is grabbed by a segment
  94                                         * constructor
  95                                         */
  96        NILFS_I_COLLECTED,              /* All dirty blocks are collected */
  97        NILFS_I_UPDATED,                /* The file has been written back */
  98        NILFS_I_INODE_SYNC,             /* dsync is not allowed for inode */
  99        NILFS_I_BMAP,                   /* has bmap and btnode_cache */
 100        NILFS_I_GCINODE,                /* inode for GC, on memory only */
 101};
 102
 103/*
 104 * commit flags for nilfs_commit_super and nilfs_sync_super
 105 */
 106enum {
 107        NILFS_SB_COMMIT = 0,    /* Commit a super block alternately */
 108        NILFS_SB_COMMIT_ALL     /* Commit both super blocks */
 109};
 110
 111/*
 112 * Macros to check inode numbers
 113 */
 114#define NILFS_MDT_INO_BITS                                              \
 115        (BIT(NILFS_DAT_INO) | BIT(NILFS_CPFILE_INO) |                   \
 116         BIT(NILFS_SUFILE_INO) | BIT(NILFS_IFILE_INO) |                 \
 117         BIT(NILFS_ATIME_INO) | BIT(NILFS_SKETCH_INO))
 118
 119#define NILFS_SYS_INO_BITS (BIT(NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
 120
 121#define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
 122
 123#define NILFS_MDT_INODE(sb, ino) \
 124        ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & BIT(ino)))
 125#define NILFS_VALID_INODE(sb, ino) \
 126        ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & BIT(ino)))
 127
 128/**
 129 * struct nilfs_transaction_info: context information for synchronization
 130 * @ti_magic: Magic number
 131 * @ti_save: Backup of journal_info field of task_struct
 132 * @ti_flags: Flags
 133 * @ti_count: Nest level
 134 */
 135struct nilfs_transaction_info {
 136        u32                     ti_magic;
 137        void                   *ti_save;
 138                                /*
 139                                 * This should never be used.  If it happens,
 140                                 * one of other filesystems has a bug.
 141                                 */
 142        unsigned short          ti_flags;
 143        unsigned short          ti_count;
 144};
 145
 146/* ti_magic */
 147#define NILFS_TI_MAGIC          0xd9e392fb
 148
 149/* ti_flags */
 150#define NILFS_TI_DYNAMIC_ALLOC  0x0001  /* Allocated from slab */
 151#define NILFS_TI_SYNC           0x0002  /*
 152                                         * Force to construct segment at the
 153                                         * end of transaction.
 154                                         */
 155#define NILFS_TI_GC             0x0004  /* GC context */
 156#define NILFS_TI_COMMIT         0x0008  /* Change happened or not */
 157#define NILFS_TI_WRITER         0x0010  /* Constructor context */
 158
 159
 160int nilfs_transaction_begin(struct super_block *,
 161                            struct nilfs_transaction_info *, int);
 162int nilfs_transaction_commit(struct super_block *);
 163void nilfs_transaction_abort(struct super_block *);
 164
 165static inline void nilfs_set_transaction_flag(unsigned int flag)
 166{
 167        struct nilfs_transaction_info *ti = current->journal_info;
 168
 169        ti->ti_flags |= flag;
 170}
 171
 172static inline int nilfs_test_transaction_flag(unsigned int flag)
 173{
 174        struct nilfs_transaction_info *ti = current->journal_info;
 175
 176        if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
 177                return 0;
 178        return !!(ti->ti_flags & flag);
 179}
 180
 181static inline int nilfs_doing_gc(void)
 182{
 183        return nilfs_test_transaction_flag(NILFS_TI_GC);
 184}
 185
 186static inline int nilfs_doing_construction(void)
 187{
 188        return nilfs_test_transaction_flag(NILFS_TI_WRITER);
 189}
 190
 191/*
 192 * function prototype
 193 */
 194#ifdef CONFIG_NILFS_POSIX_ACL
 195#error "NILFS: not yet supported POSIX ACL"
 196extern int nilfs_acl_chmod(struct inode *);
 197extern int nilfs_init_acl(struct inode *, struct inode *);
 198#else
 199static inline int nilfs_acl_chmod(struct inode *inode)
 200{
 201        return 0;
 202}
 203
 204static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
 205{
 206        inode->i_mode &= ~current_umask();
 207        return 0;
 208}
 209#endif
 210
 211#define NILFS_ATIME_DISABLE
 212
 213/* Flags that should be inherited by new inodes from their parent. */
 214#define NILFS_FL_INHERITED                                              \
 215        (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL |          \
 216         FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
 217         FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
 218
 219/* Mask out flags that are inappropriate for the given type of inode. */
 220static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
 221{
 222        if (S_ISDIR(mode))
 223                return flags;
 224        else if (S_ISREG(mode))
 225                return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
 226        else
 227                return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
 228}
 229
 230/* dir.c */
 231extern int nilfs_add_link(struct dentry *, struct inode *);
 232extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
 233extern int nilfs_make_empty(struct inode *, struct inode *);
 234extern struct nilfs_dir_entry *
 235nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
 236extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
 237extern int nilfs_empty_dir(struct inode *);
 238extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
 239extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
 240                           struct page *, struct inode *);
 241
 242/* file.c */
 243extern int nilfs_sync_file(struct file *, loff_t, loff_t, int);
 244
 245/* ioctl.c */
 246int nilfs_fileattr_get(struct dentry *dentry, struct fileattr *m);
 247int nilfs_fileattr_set(struct user_namespace *mnt_userns,
 248                       struct dentry *dentry, struct fileattr *fa);
 249long nilfs_ioctl(struct file *, unsigned int, unsigned long);
 250long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
 251int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
 252                                       void **);
 253
 254/* inode.c */
 255void nilfs_inode_add_blocks(struct inode *inode, int n);
 256void nilfs_inode_sub_blocks(struct inode *inode, int n);
 257extern struct inode *nilfs_new_inode(struct inode *, umode_t);
 258extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
 259extern void nilfs_set_inode_flags(struct inode *);
 260extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
 261extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
 262struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
 263                            unsigned long ino);
 264struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
 265                                unsigned long ino);
 266struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
 267                         unsigned long ino);
 268extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
 269                                       unsigned long ino, __u64 cno);
 270extern void nilfs_update_inode(struct inode *, struct buffer_head *, int);
 271extern void nilfs_truncate(struct inode *);
 272extern void nilfs_evict_inode(struct inode *);
 273extern int nilfs_setattr(struct user_namespace *, struct dentry *,
 274                         struct iattr *);
 275extern void nilfs_write_failed(struct address_space *mapping, loff_t to);
 276int nilfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
 277                     int mask);
 278int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
 279extern int nilfs_inode_dirty(struct inode *);
 280int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty);
 281extern int __nilfs_mark_inode_dirty(struct inode *, int);
 282extern void nilfs_dirty_inode(struct inode *, int flags);
 283int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
 284                 __u64 start, __u64 len);
 285static inline int nilfs_mark_inode_dirty(struct inode *inode)
 286{
 287        return __nilfs_mark_inode_dirty(inode, I_DIRTY);
 288}
 289static inline int nilfs_mark_inode_dirty_sync(struct inode *inode)
 290{
 291        return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC);
 292}
 293
 294/* super.c */
 295extern struct inode *nilfs_alloc_inode(struct super_block *);
 296
 297__printf(2, 3)
 298void __nilfs_msg(struct super_block *sb, const char *fmt, ...);
 299extern __printf(3, 4)
 300void __nilfs_error(struct super_block *sb, const char *function,
 301                   const char *fmt, ...);
 302
 303#ifdef CONFIG_PRINTK
 304
 305#define nilfs_msg(sb, level, fmt, ...)                                  \
 306        __nilfs_msg(sb, level fmt, ##__VA_ARGS__)
 307#define nilfs_error(sb, fmt, ...)                                       \
 308        __nilfs_error(sb, __func__, fmt, ##__VA_ARGS__)
 309
 310#else
 311
 312#define nilfs_msg(sb, level, fmt, ...)                                  \
 313        do {                                                            \
 314                no_printk(level fmt, ##__VA_ARGS__);                    \
 315                (void)(sb);                                             \
 316        } while (0)
 317#define nilfs_error(sb, fmt, ...)                                       \
 318        do {                                                            \
 319                no_printk(fmt, ##__VA_ARGS__);                          \
 320                __nilfs_error(sb, "", " ");                             \
 321        } while (0)
 322
 323#endif /* CONFIG_PRINTK */
 324
 325#define nilfs_crit(sb, fmt, ...)                                        \
 326        nilfs_msg(sb, KERN_CRIT, fmt, ##__VA_ARGS__)
 327#define nilfs_err(sb, fmt, ...)                                         \
 328        nilfs_msg(sb, KERN_ERR, fmt, ##__VA_ARGS__)
 329#define nilfs_warn(sb, fmt, ...)                                        \
 330        nilfs_msg(sb, KERN_WARNING, fmt, ##__VA_ARGS__)
 331#define nilfs_info(sb, fmt, ...)                                        \
 332        nilfs_msg(sb, KERN_INFO, fmt, ##__VA_ARGS__)
 333
 334extern struct nilfs_super_block *
 335nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
 336extern int nilfs_store_magic_and_option(struct super_block *,
 337                                        struct nilfs_super_block *, char *);
 338extern int nilfs_check_feature_compatibility(struct super_block *,
 339                                             struct nilfs_super_block *);
 340extern void nilfs_set_log_cursor(struct nilfs_super_block *,
 341                                 struct the_nilfs *);
 342struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
 343                                               int flip);
 344int nilfs_commit_super(struct super_block *sb, int flag);
 345int nilfs_cleanup_super(struct super_block *sb);
 346int nilfs_resize_fs(struct super_block *sb, __u64 newsize);
 347int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
 348                            struct nilfs_root **root);
 349int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
 350
 351/* gcinode.c */
 352int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
 353                                   struct buffer_head **);
 354int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
 355                                   struct buffer_head **);
 356int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
 357int nilfs_init_gcinode(struct inode *inode);
 358void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
 359
 360/* sysfs.c */
 361int __init nilfs_sysfs_init(void);
 362void nilfs_sysfs_exit(void);
 363int nilfs_sysfs_create_device_group(struct super_block *);
 364void nilfs_sysfs_delete_device_group(struct the_nilfs *);
 365int nilfs_sysfs_create_snapshot_group(struct nilfs_root *);
 366void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *);
 367
 368/*
 369 * Inodes and files operations
 370 */
 371extern const struct file_operations nilfs_dir_operations;
 372extern const struct inode_operations nilfs_file_inode_operations;
 373extern const struct file_operations nilfs_file_operations;
 374extern const struct address_space_operations nilfs_aops;
 375extern const struct inode_operations nilfs_dir_inode_operations;
 376extern const struct inode_operations nilfs_special_inode_operations;
 377extern const struct inode_operations nilfs_symlink_inode_operations;
 378
 379/*
 380 * filesystem type
 381 */
 382extern struct file_system_type nilfs_fs_type;
 383
 384
 385#endif  /* _NILFS_H */
 386