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