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 * Macros to check inode numbers 111 */ 112 #define NILFS_MDT_INO_BITS \ 113 ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO | \ 114 1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO | \ 115 1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO)) 116 117 #define NILFS_SYS_INO_BITS \ 118 ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS) 119 120 #define NILFS_FIRST_INO(sb) (NILFS_SB(sb)->s_nilfs->ns_first_ino) 121 122 #define NILFS_MDT_INODE(sb, ino) \ 123 ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino)))) 124 #define NILFS_VALID_INODE(sb, ino) \ 125 ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino)))) 126 127 /** 128 * struct nilfs_transaction_info: context information for synchronization 129 * @ti_magic: Magic number 130 * @ti_save: Backup of journal_info field of task_struct 131 * @ti_flags: Flags 132 * @ti_count: Nest level 133 * @ti_garbage: List of inode to be put when releasing semaphore 134 */ 135 struct nilfs_transaction_info { 136 u32 ti_magic; 137 void *ti_save; 138 /* This should never used. If this happens, 139 one of other filesystems has a bug. */ 140 unsigned short ti_flags; 141 unsigned short ti_count; 142 struct list_head ti_garbage; 143 }; 144 145 /* ti_magic */ 146 #define NILFS_TI_MAGIC 0xd9e392fb 147 148 /* ti_flags */ 149 #define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */ 150 #define NILFS_TI_SYNC 0x0002 /* Force to construct segment at the 151 end of transaction. */ 152 #define NILFS_TI_GC 0x0004 /* GC context */ 153 #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */ 154 #define NILFS_TI_WRITER 0x0010 /* Constructor context */ 155 156 157 int nilfs_transaction_begin(struct super_block *, 158 struct nilfs_transaction_info *, int); 159 int nilfs_transaction_commit(struct super_block *); 160 void nilfs_transaction_abort(struct super_block *); 161 162 static inline void nilfs_set_transaction_flag(unsigned int flag) 163 { 164 struct nilfs_transaction_info *ti = current->journal_info; 165 166 ti->ti_flags |= flag; 167 } 168 169 static inline int nilfs_test_transaction_flag(unsigned int flag) 170 { 171 struct nilfs_transaction_info *ti = current->journal_info; 172 173 if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC) 174 return 0; 175 return !!(ti->ti_flags & flag); 176 } 177 178 static inline int nilfs_doing_gc(void) 179 { 180 return nilfs_test_transaction_flag(NILFS_TI_GC); 181 } 182 183 static inline int nilfs_doing_construction(void) 184 { 185 return nilfs_test_transaction_flag(NILFS_TI_WRITER); 186 } 187 188 static inline struct inode *nilfs_dat_inode(const struct the_nilfs *nilfs) 189 { 190 return nilfs_doing_gc() ? nilfs->ns_gc_dat : nilfs->ns_dat; 191 } 192 193 /* 194 * function prototype 195 */ 196 #ifdef CONFIG_NILFS_POSIX_ACL 197 #error "NILFS: not yet supported POSIX ACL" 198 extern int nilfs_permission(struct inode *, int, struct nameidata *); 199 extern int nilfs_acl_chmod(struct inode *); 200 extern int nilfs_init_acl(struct inode *, struct inode *); 201 #else 202 #define nilfs_permission NULL 203 204 static inline int nilfs_acl_chmod(struct inode *inode) 205 { 206 return 0; 207 } 208 209 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir) 210 { 211 inode->i_mode &= ~current_umask(); 212 return 0; 213 } 214 #endif 215 216 #define NILFS_ATIME_DISABLE 217 218 /* dir.c */ 219 extern int nilfs_add_link(struct dentry *, struct inode *); 220 extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *); 221 extern int nilfs_make_empty(struct inode *, struct inode *); 222 extern struct nilfs_dir_entry * 223 nilfs_find_entry(struct inode *, const struct qstr *, struct page **); 224 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *); 225 extern int nilfs_empty_dir(struct inode *); 226 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **); 227 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *, 228 struct page *, struct inode *); 229 230 /* file.c */ 231 extern int nilfs_sync_file(struct file *, struct dentry *, int); 232 233 /* ioctl.c */ 234 long nilfs_ioctl(struct file *, unsigned int, unsigned long); 235 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *, 236 void **); 237 238 /* inode.c */ 239 extern struct inode *nilfs_new_inode(struct inode *, int); 240 extern void nilfs_free_inode(struct inode *); 241 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int); 242 extern void nilfs_set_inode_flags(struct inode *); 243 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *); 244 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int); 245 extern struct inode *nilfs_iget(struct super_block *, unsigned long); 246 extern void nilfs_update_inode(struct inode *, struct buffer_head *); 247 extern void nilfs_truncate(struct inode *); 248 extern void nilfs_delete_inode(struct inode *); 249 extern int nilfs_setattr(struct dentry *, struct iattr *); 250 extern int nilfs_load_inode_block(struct nilfs_sb_info *, struct inode *, 251 struct buffer_head **); 252 extern int nilfs_inode_dirty(struct inode *); 253 extern int nilfs_set_file_dirty(struct nilfs_sb_info *, struct inode *, 254 unsigned); 255 extern int nilfs_mark_inode_dirty(struct inode *); 256 extern void nilfs_dirty_inode(struct inode *); 257 258 /* namei.c */ 259 extern struct dentry *nilfs_get_parent(struct dentry *); 260 261 /* super.c */ 262 extern struct inode *nilfs_alloc_inode_common(struct the_nilfs *); 263 extern struct inode *nilfs_alloc_inode(struct super_block *); 264 extern void nilfs_destroy_inode(struct inode *); 265 extern void nilfs_error(struct super_block *, const char *, const char *, ...) 266 __attribute__ ((format (printf, 3, 4))); 267 extern void nilfs_warning(struct super_block *, const char *, const char *, ...) 268 __attribute__ ((format (printf, 3, 4))); 269 extern struct nilfs_super_block * 270 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **); 271 extern int nilfs_store_magic_and_option(struct super_block *, 272 struct nilfs_super_block *, char *); 273 extern int nilfs_commit_super(struct nilfs_sb_info *, int); 274 extern int nilfs_attach_checkpoint(struct nilfs_sb_info *, __u64); 275 extern void nilfs_detach_checkpoint(struct nilfs_sb_info *); 276 277 /* gcinode.c */ 278 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64, 279 struct buffer_head **); 280 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64, 281 struct buffer_head **); 282 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *); 283 int nilfs_init_gccache(struct the_nilfs *); 284 void nilfs_destroy_gccache(struct the_nilfs *); 285 void nilfs_clear_gcinode(struct inode *); 286 struct inode *nilfs_gc_iget(struct the_nilfs *, ino_t, __u64); 287 void nilfs_remove_all_gcinode(struct the_nilfs *); 288 289 /* gcdat.c */ 290 int nilfs_init_gcdat_inode(struct the_nilfs *); 291 void nilfs_commit_gcdat_inode(struct the_nilfs *); 292 void nilfs_clear_gcdat_inode(struct the_nilfs *); 293 294 /* 295 * Inodes and files operations 296 */ 297 extern const struct file_operations nilfs_dir_operations; 298 extern const struct inode_operations nilfs_file_inode_operations; 299 extern const struct file_operations nilfs_file_operations; 300 extern const struct address_space_operations nilfs_aops; 301 extern const struct inode_operations nilfs_dir_inode_operations; 302 extern const struct inode_operations nilfs_special_inode_operations; 303 extern const struct inode_operations nilfs_symlink_inode_operations; 304 305 /* 306 * filesystem type 307 */ 308 extern struct file_system_type nilfs_fs_type; 309 310 311 #endif /* _NILFS_H */ 312