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