fs/nilfs2/nilfs.h

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