fs/nilfs2/nilfs.h

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