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 "sb.h"
  34 #include "bmap.h"
  35 #include "bmap_union.h"
  36
  37 /*
  38  * NILFS filesystem version
  39  */
  40 #define NILFS_VERSION           "2.0.5"
  41
  42 /*
  43  * nilfs inode data in memory
  44  */
  45 struct nilfs_inode_info {
  46         __u32 i_flags;
  47         unsigned long  i_state;         /* Dynamic state flags */
  48         struct nilfs_bmap *i_bmap;
  49         union nilfs_bmap_union i_bmap_union;
  50         __u64 i_xattr;  /* sector_t ??? */
  51         __u32 i_dir_start_lookup;
  52         __u64 i_cno;            /* check point number for GC inode */
  53         struct address_space i_btnode_cache;
  54         struct list_head i_dirty;       /* List for connecting dirty files */
  55
  56 #ifdef CONFIG_NILFS_XATTR
  57         /*
  58          * Extended attributes can be read independently of the main file
  59          * data. Taking i_sem even when reading would cause contention
  60          * between readers of EAs and writers of regular file data, so
  61          * instead we synchronize on xattr_sem when reading or changing
  62          * EAs.
  63          */
  64         struct rw_semaphore xattr_sem;
  65 #endif
  66 #ifdef CONFIG_NILFS_POSIX_ACL
  67         struct posix_acl *i_acl;
  68         struct posix_acl *i_default_acl;
  69 #endif
  70         struct buffer_head *i_bh;       /* i_bh contains a new or dirty
  71                                            disk inode */
  72         struct inode vfs_inode;
  73 };
  74
  75 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
  76 {
  77         return container_of(inode, struct nilfs_inode_info, vfs_inode);
  78 }
  79
  80 static inline struct nilfs_inode_info *
  81 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
  82 {
  83         return container_of((union nilfs_bmap_union *)bmap,
  84                             struct nilfs_inode_info,
  85                             i_bmap_union);
  86 }
  87
  88 static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
  89 {
  90         struct nilfs_inode_info *ii =
  91                 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
  92         return &ii->vfs_inode;
  93 }
  94
  95 static inline struct inode *NILFS_AS_I(struct address_space *mapping)
  96 {
  97         return (mapping->host) ? :
  98                 container_of(mapping, struct inode, i_data);
  99 }
 100
 101 /*
 102  * Dynamic state flags of NILFS on-memory inode (i_state)
 103  */
 104 enum {
 105         NILFS_I_NEW = 0,                /* Inode is newly created */
 106         NILFS_I_DIRTY,                  /* The file is dirty */
 107         NILFS_I_QUEUED,                 /* inode is in dirty_files list */
 108         NILFS_I_BUSY,                   /* inode is grabbed by a segment
 109                                            constructor */
 110         NILFS_I_COLLECTED,              /* All dirty blocks are collected */
 111         NILFS_I_UPDATED,                /* The file has been written back */
 112         NILFS_I_INODE_DIRTY,            /* write_inode is requested */
 113         NILFS_I_BMAP,                   /* has bmap and btnode_cache */
 114         NILFS_I_GCINODE,                /* inode for GC, on memory only */
 115         NILFS_I_GCDAT,                  /* shadow DAT, on memory only */
 116 };
 117
 118 /*
 119  * Macros to check inode numbers
 120  */
 121 #define NILFS_MDT_INO_BITS   \
 122   ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO |          \
 123                   1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO |        \
 124                   1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO))
 125
 126 #define NILFS_SYS_INO_BITS   \
 127   ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
 128
 129 #define NILFS_FIRST_INO(sb)  (NILFS_SB(sb)->s_nilfs->ns_first_ino)
 130
 131 #define NILFS_MDT_INODE(sb, ino) \
 132   ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino))))
 133 #define NILFS_VALID_INODE(sb, ino) \
 134   ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino))))
 135
 136 /**
 137  * struct nilfs_transaction_info: context information for synchronization
 138  * @ti_magic: Magic number
 139  * @ti_save: Backup of journal_info field of task_struct
 140  * @ti_flags: Flags
 141  * @ti_count: Nest level
 142  * @ti_garbage: List of inode to be put when releasing semaphore
 143  */
 144 struct nilfs_transaction_info {
 145         u32                     ti_magic;
 146         void                   *ti_save;
 147                                 /* This should never used. If this happens,
 148                                    one of other filesystems has a bug. */
 149         unsigned short          ti_flags;
 150         unsigned short          ti_count;
 151         struct list_head        ti_garbage;
 152 };
 153
 154 /* ti_magic */
 155 #define NILFS_TI_MAGIC          0xd9e392fb
 156
 157 /* ti_flags */
 158 #define NILFS_TI_DYNAMIC_ALLOC  0x0001  /* Allocated from slab */
 159 #define NILFS_TI_SYNC           0x0002  /* Force to construct segment at the
 160                                            end of transaction. */
 161 #define NILFS_TI_GC             0x0004  /* GC context */
 162 #define NILFS_TI_COMMIT         0x0008  /* Change happened or not */
 163 #define NILFS_TI_WRITER         0x0010  /* Constructor context */
 164
 165
 166 int nilfs_transaction_begin(struct super_block *,
 167                             struct nilfs_transaction_info *, int);
 168 int nilfs_transaction_commit(struct super_block *);
 169 void nilfs_transaction_abort(struct super_block *);
 170
 171 static inline void nilfs_set_transaction_flag(unsigned int flag)
 172 {
 173         struct nilfs_transaction_info *ti = current->journal_info;
 174
 175         ti->ti_flags |= flag;
 176 }
 177
 178 static inline int nilfs_test_transaction_flag(unsigned int flag)
 179 {
 180         struct nilfs_transaction_info *ti = current->journal_info;
 181
 182         if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
 183                 return 0;
 184         return !!(ti->ti_flags & flag);
 185 }
 186
 187 static inline int nilfs_doing_gc(void)
 188 {
 189         return nilfs_test_transaction_flag(NILFS_TI_GC);
 190 }
 191
 192 static inline int nilfs_doing_construction(void)
 193 {
 194         return nilfs_test_transaction_flag(NILFS_TI_WRITER);
 195 }
 196
 197 static inline struct inode *nilfs_dat_inode(const struct the_nilfs *nilfs)
 198 {
 199         return nilfs_doing_gc() ? nilfs->ns_gc_dat : nilfs->ns_dat;
 200 }
 201
 202 /*
 203  * function prototype
 204  */
 205 #ifdef CONFIG_NILFS_POSIX_ACL
 206 #error "NILFS: not yet supported POSIX ACL"
 207 extern int nilfs_permission(struct inode *, int, struct nameidata *);
 208 extern int nilfs_acl_chmod(struct inode *);
 209 extern int nilfs_init_acl(struct inode *, struct inode *);
 210 #else
 211 #define nilfs_permission   NULL
 212
 213 static inline int nilfs_acl_chmod(struct inode *inode)
 214 {
 215         return 0;
 216 }
 217
 218 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
 219 {
 220         inode->i_mode &= ~current_umask();
 221         return 0;
 222 }
 223 #endif
 224
 225 #define NILFS_ATIME_DISABLE
 226
 227 /* dir.c */
 228 extern int nilfs_add_link(struct dentry *, struct inode *);
 229 extern ino_t nilfs_inode_by_name(struct inode *, struct dentry *);
 230 extern int nilfs_make_empty(struct inode *, struct inode *);
 231 extern struct nilfs_dir_entry *
 232 nilfs_find_entry(struct inode *, struct dentry *, struct page **);
 233 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
 234 extern int nilfs_empty_dir(struct inode *);
 235 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
 236 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
 237                            struct page *, struct inode *);
 238
 239 /* file.c */
 240 extern int nilfs_sync_file(struct file *, struct dentry *, int);
 241
 242 /* ioctl.c */
 243 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
 244 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, void __user *);
 245
 246 /* inode.c */
 247 extern struct inode *nilfs_new_inode(struct inode *, int);
 248 extern void nilfs_free_inode(struct inode *);
 249 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
 250 extern void nilfs_set_inode_flags(struct inode *);
 251 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
 252 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
 253 extern struct inode *nilfs_iget(struct super_block *, unsigned long);
 254 extern void nilfs_update_inode(struct inode *, struct buffer_head *);
 255 extern void nilfs_truncate(struct inode *);
 256 extern void nilfs_delete_inode(struct inode *);
 257 extern int nilfs_setattr(struct dentry *, struct iattr *);
 258 extern int nilfs_load_inode_block(struct nilfs_sb_info *, struct inode *,
 259                                   struct buffer_head **);
 260 extern int nilfs_inode_dirty(struct inode *);
 261 extern int nilfs_set_file_dirty(struct nilfs_sb_info *, struct inode *,
 262                                 unsigned);
 263 extern int nilfs_mark_inode_dirty(struct inode *);
 264 extern void nilfs_dirty_inode(struct inode *);
 265
 266 /* namei.c */
 267 extern struct dentry *nilfs_get_parent(struct dentry *);
 268
 269 /* super.c */
 270 extern struct inode *nilfs_alloc_inode(struct super_block *);
 271 extern void nilfs_destroy_inode(struct inode *);
 272 extern void nilfs_error(struct super_block *, const char *, const char *, ...)
 273         __attribute__ ((format (printf, 3, 4)));
 274 extern void nilfs_warning(struct super_block *, const char *, const char *, ...)
 275        __attribute__ ((format (printf, 3, 4)));
 276 extern struct nilfs_super_block *
 277 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
 278 extern int nilfs_store_magic_and_option(struct super_block *,
 279                                         struct nilfs_super_block *, char *);
 280 extern int nilfs_commit_super(struct nilfs_sb_info *, int);
 281 extern int nilfs_attach_checkpoint(struct nilfs_sb_info *, __u64);
 282 extern void nilfs_detach_checkpoint(struct nilfs_sb_info *);
 283
 284 /* gcinode.c */
 285 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
 286                                    struct buffer_head **);
 287 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
 288                                    struct buffer_head **);
 289 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
 290 int nilfs_init_gccache(struct the_nilfs *);
 291 void nilfs_destroy_gccache(struct the_nilfs *);
 292 void nilfs_clear_gcinode(struct inode *);
 293 struct inode *nilfs_gc_iget(struct the_nilfs *, ino_t, __u64);
 294 void nilfs_remove_all_gcinode(struct the_nilfs *);
 295
 296 /* gcdat.c */
 297 int nilfs_init_gcdat_inode(struct the_nilfs *);
 298 void nilfs_commit_gcdat_inode(struct the_nilfs *);
 299 void nilfs_clear_gcdat_inode(struct the_nilfs *);
 300
 301 /*
 302  * Inodes and files operations
 303  */
 304 extern struct file_operations nilfs_dir_operations;
 305 extern struct inode_operations nilfs_file_inode_operations;
 306 extern struct file_operations nilfs_file_operations;
 307 extern struct address_space_operations nilfs_aops;
 308 extern struct inode_operations nilfs_dir_inode_operations;
 309 extern struct inode_operations nilfs_special_inode_operations;
 310 extern struct inode_operations nilfs_symlink_inode_operations;
 311
 312 /*
 313  * filesystem type
 314  */
 315 extern struct file_system_type nilfs_fs_type;
 316
 317
 318 #endif  /* _NILFS_H */