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  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * Written by Koji Sato <koji@osrg.net>
  21  *            Ryusuke Konishi <ryusuke@osrg.net>
  22  */
  23
  24 #ifndef _NILFS_H
  25 #define _NILFS_H
  26
  27 #include <linux/kernel.h>
  28 #include <linux/buffer_head.h>
  29 #include <linux/spinlock.h>
  30 #include <linux/blkdev.h>
  31 #include <linux/nilfs2_fs.h>
  32 #include "the_nilfs.h"
  33 #include "bmap.h"
  34
  35 /*
  36  * nilfs inode data in memory
  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 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;       /* i_bh contains a new or dirty
  60                                            disk inode */
  61         struct nilfs_root *i_root;
  62         struct inode vfs_inode;
  63 };
  64
  65 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
  66 {
  67         return container_of(inode, struct nilfs_inode_info, vfs_inode);
  68 }
  69
  70 static inline struct nilfs_inode_info *
  71 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
  72 {
  73         return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
  74 }
  75
  76 static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
  77 {
  78         struct nilfs_inode_info *ii =
  79                 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
  80         return &ii->vfs_inode;
  81 }
  82
  83 /*
  84  * Dynamic state flags of NILFS on-memory inode (i_state)
  85  */
  86 enum {
  87         NILFS_I_NEW = 0,                /* Inode is newly created */
  88         NILFS_I_DIRTY,                  /* The file is dirty */
  89         NILFS_I_QUEUED,                 /* inode is in dirty_files list */
  90         NILFS_I_BUSY,                   /* inode is grabbed by a segment
  91                                            constructor */
  92         NILFS_I_COLLECTED,              /* All dirty blocks are collected */
  93         NILFS_I_UPDATED,                /* The file has been written back */
  94         NILFS_I_INODE_DIRTY,            /* write_inode is requested */
  95         NILFS_I_BMAP,                   /* has bmap and btnode_cache */
  96         NILFS_I_GCINODE,                /* inode for GC, on memory only */
  97 };
  98
  99 /*
 100  * commit flags for nilfs_commit_super and nilfs_sync_super
 101  */
 102 enum {
 103         NILFS_SB_COMMIT = 0,    /* Commit a super block alternately */
 104         NILFS_SB_COMMIT_ALL     /* Commit both super blocks */
 105 };
 106
 107 /*
 108  * Macros to check inode numbers
 109  */
 110 #define NILFS_MDT_INO_BITS   \
 111         ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO |    \
 112                         1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO |  \
 113                         1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO))
 114
 115 #define NILFS_SYS_INO_BITS   \
 116         ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
 117
 118 #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
 119
 120 #define NILFS_MDT_INODE(sb, ino) \
 121         ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino))))
 122 #define NILFS_VALID_INODE(sb, ino) \
 123         ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino))))
 124
 125 /**
 126  * struct nilfs_transaction_info: context information for synchronization
 127  * @ti_magic: Magic number
 128  * @ti_save: Backup of journal_info field of task_struct
 129  * @ti_flags: Flags
 130  * @ti_count: Nest level
 131  * @ti_garbage: List of inode to be put when releasing semaphore
 132  */
 133 struct nilfs_transaction_info {
 134         u32                     ti_magic;
 135         void                   *ti_save;
 136                                 /* This should never used. If this happens,
 137                                    one of other filesystems has a bug. */
 138         unsigned short          ti_flags;
 139         unsigned short          ti_count;
 140         struct list_head        ti_garbage;
 141 };
 142
 143 /* ti_magic */
 144 #define NILFS_TI_MAGIC          0xd9e392fb
 145
 146 /* ti_flags */
 147 #define NILFS_TI_DYNAMIC_ALLOC  0x0001  /* Allocated from slab */
 148 #define NILFS_TI_SYNC           0x0002  /* Force to construct segment at the
 149                                            end of transaction. */
 150 #define NILFS_TI_GC             0x0004  /* GC context */
 151 #define NILFS_TI_COMMIT         0x0008  /* Change happened or not */
 152 #define NILFS_TI_WRITER         0x0010  /* Constructor context */
 153
 154
 155 int nilfs_transaction_begin(struct super_block *,
 156                             struct nilfs_transaction_info *, int);
 157 int nilfs_transaction_commit(struct super_block *);
 158 void nilfs_transaction_abort(struct super_block *);
 159
 160 static inline void nilfs_set_transaction_flag(unsigned int flag)
 161 {
 162         struct nilfs_transaction_info *ti = current->journal_info;
 163
 164         ti->ti_flags |= flag;
 165 }
 166
 167 static inline int nilfs_test_transaction_flag(unsigned int flag)
 168 {
 169         struct nilfs_transaction_info *ti = current->journal_info;
 170
 171         if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
 172                 return 0;
 173         return !!(ti->ti_flags & flag);
 174 }
 175
 176 static inline int nilfs_doing_gc(void)
 177 {
 178         return nilfs_test_transaction_flag(NILFS_TI_GC);
 179 }
 180
 181 static inline int nilfs_doing_construction(void)
 182 {
 183         return nilfs_test_transaction_flag(NILFS_TI_WRITER);
 184 }
 185
 186 /*
 187  * function prototype
 188  */
 189 #ifdef CONFIG_NILFS_POSIX_ACL
 190 #error "NILFS: not yet supported POSIX ACL"
 191 extern int nilfs_acl_chmod(struct inode *);
 192 extern int nilfs_init_acl(struct inode *, struct inode *);
 193 #else
 194 static inline int nilfs_acl_chmod(struct inode *inode)
 195 {
 196         return 0;
 197 }
 198
 199 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
 200 {
 201         inode->i_mode &= ~current_umask();
 202         return 0;
 203 }
 204 #endif
 205
 206 #define NILFS_ATIME_DISABLE
 207
 208 /* Flags that should be inherited by new inodes from their parent. */
 209 #define NILFS_FL_INHERITED                                              \
 210         (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL |          \
 211          FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
 212          FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
 213
 214 /* Mask out flags that are inappropriate for the given type of inode. */
 215 static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
 216 {
 217         if (S_ISDIR(mode))
 218                 return flags;
 219         else if (S_ISREG(mode))
 220                 return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
 221         else
 222                 return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
 223 }
 224
 225 /* dir.c */
 226 extern int nilfs_add_link(struct dentry *, struct inode *);
 227 extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
 228 extern int nilfs_make_empty(struct inode *, struct inode *);
 229 extern struct nilfs_dir_entry *
 230 nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
 231 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
 232 extern int nilfs_empty_dir(struct inode *);
 233 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
 234 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
 235                            struct page *, struct inode *);
 236
 237 /* file.c */
 238 extern int nilfs_sync_file(struct file *, loff_t, loff_t, int);
 239
 240 /* ioctl.c */
 241 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
 242 long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
 243 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
 244                                        void **);
 245
 246 /* inode.c */
 247 void nilfs_inode_add_blocks(struct inode *inode, int n);
 248 void nilfs_inode_sub_blocks(struct inode *inode, int n);
 249 extern struct inode *nilfs_new_inode(struct inode *, int);
 250 extern void nilfs_free_inode(struct inode *);
 251 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
 252 extern void nilfs_set_inode_flags(struct inode *);
 253 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
 254 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
 255 struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
 256                             unsigned long ino);
 257 struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
 258                                 unsigned long ino);
 259 struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
 260                          unsigned long ino);
 261 extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
 262                                        unsigned long ino, __u64 cno);
 263 extern void nilfs_update_inode(struct inode *, struct buffer_head *);
 264 extern void nilfs_truncate(struct inode *);
 265 extern void nilfs_evict_inode(struct inode *);
 266 extern int nilfs_setattr(struct dentry *, struct iattr *);
 267 int nilfs_permission(struct inode *inode, int mask);
 268 int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
 269 extern int nilfs_inode_dirty(struct inode *);
 270 int nilfs_set_file_dirty(struct inode *inode, unsigned nr_dirty);
 271 extern int nilfs_mark_inode_dirty(struct inode *);
 272 extern void nilfs_dirty_inode(struct inode *, int flags);
 273 int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
 274                  __u64 start, __u64 len);
 275
 276 /* super.c */
 277 extern struct inode *nilfs_alloc_inode(struct super_block *);
 278 extern void nilfs_destroy_inode(struct inode *);
 279 extern __printf(3, 4)
 280 void nilfs_error(struct super_block *, const char *, const char *, ...);
 281 extern __printf(3, 4)
 282 void nilfs_warning(struct super_block *, const char *, const char *, ...);
 283 extern struct nilfs_super_block *
 284 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
 285 extern int nilfs_store_magic_and_option(struct super_block *,
 286                                         struct nilfs_super_block *, char *);
 287 extern int nilfs_check_feature_compatibility(struct super_block *,
 288                                              struct nilfs_super_block *);
 289 extern void nilfs_set_log_cursor(struct nilfs_super_block *,
 290                                  struct the_nilfs *);
 291 struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
 292                                                int flip);
 293 int nilfs_commit_super(struct super_block *sb, int flag);
 294 int nilfs_cleanup_super(struct super_block *sb);
 295 int nilfs_resize_fs(struct super_block *sb, __u64 newsize);
 296 int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
 297                             struct nilfs_root **root);
 298 int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
 299
 300 /* gcinode.c */
 301 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
 302                                    struct buffer_head **);
 303 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
 304                                    struct buffer_head **);
 305 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
 306 int nilfs_init_gcinode(struct inode *inode);
 307 void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
 308
 309 /*
 310  * Inodes and files operations
 311  */
 312 extern const struct file_operations nilfs_dir_operations;
 313 extern const struct inode_operations nilfs_file_inode_operations;
 314 extern const struct file_operations nilfs_file_operations;
 315 extern const struct address_space_operations nilfs_aops;
 316 extern const struct inode_operations nilfs_dir_inode_operations;
 317 extern const struct inode_operations nilfs_special_inode_operations;
 318 extern const struct inode_operations nilfs_symlink_inode_operations;
 319
 320 /*
 321  * filesystem type
 322  */
 323 extern struct file_system_type nilfs_fs_type;
 324
 325
 326 #endif  /* _NILFS_H */