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 */ 39struct 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 inode vfs_inode; 63}; 64 65static 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 70static inline struct nilfs_inode_info * 71NILFS_BMAP_I(const struct nilfs_bmap *bmap) 72{ 73 return container_of(bmap, struct nilfs_inode_info, i_bmap_data); 74} 75 76static 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 83static inline struct inode *NILFS_AS_I(struct address_space *mapping) 84{ 85 return (mapping->host) ? : 86 container_of(mapping, struct inode, i_data); 87} 88 89/* 90 * Dynamic state flags of NILFS on-memory inode (i_state) 91 */ 92enum { 93 NILFS_I_NEW = 0, /* Inode is newly created */ 94 NILFS_I_DIRTY, /* The file is dirty */ 95 NILFS_I_QUEUED, /* inode is in dirty_files list */ 96 NILFS_I_BUSY, /* inode is grabbed by a segment 97 constructor */ 98 NILFS_I_COLLECTED, /* All dirty blocks are collected */ 99 NILFS_I_UPDATED, /* The file has been written back */ 100 NILFS_I_INODE_DIRTY, /* write_inode is requested */ 101 NILFS_I_BMAP, /* has bmap and btnode_cache */ 102 NILFS_I_GCINODE, /* inode for GC, on memory only */ 103 NILFS_I_GCDAT, /* shadow DAT, on memory only */ 104}; 105 106/* 107 * commit flags for nilfs_commit_super and nilfs_sync_super 108 */ 109enum { 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 */ 140struct 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 162int nilfs_transaction_begin(struct super_block *, 163 struct nilfs_transaction_info *, int); 164int nilfs_transaction_commit(struct super_block *); 165void nilfs_transaction_abort(struct super_block *); 166 167static 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 174static 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 183static inline int nilfs_doing_gc(void) 184{ 185 return nilfs_test_transaction_flag(NILFS_TI_GC); 186} 187 188static inline int nilfs_doing_construction(void) 189{ 190 return nilfs_test_transaction_flag(NILFS_TI_WRITER); 191} 192 193static inline struct inode *nilfs_dat_inode(const struct the_nilfs *nilfs) 194{ 195 return nilfs_doing_gc() ? nilfs->ns_gc_dat : nilfs->ns_dat; 196} 197 198/* 199 * function prototype 200 */ 201#ifdef CONFIG_NILFS_POSIX_ACL 202#error "NILFS: not yet supported POSIX ACL" 203extern int nilfs_permission(struct inode *, int, struct nameidata *); 204extern int nilfs_acl_chmod(struct inode *); 205extern int nilfs_init_acl(struct inode *, struct inode *); 206#else 207#define nilfs_permission NULL 208 209static inline int nilfs_acl_chmod(struct inode *inode) 210{ 211 return 0; 212} 213 214static inline int nilfs_init_acl(struct inode *inode, struct inode *dir) 215{ 216 inode->i_mode &= ~current_umask(); 217 return 0; 218} 219#endif 220 221#define NILFS_ATIME_DISABLE 222 223/* dir.c */ 224extern int nilfs_add_link(struct dentry *, struct inode *); 225extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *); 226extern int nilfs_make_empty(struct inode *, struct inode *); 227extern struct nilfs_dir_entry * 228nilfs_find_entry(struct inode *, const struct qstr *, struct page **); 229extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *); 230extern int nilfs_empty_dir(struct inode *); 231extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **); 232extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *, 233 struct page *, struct inode *); 234 235/* file.c */ 236extern int nilfs_sync_file(struct file *, int); 237 238/* ioctl.c */ 239long nilfs_ioctl(struct file *, unsigned int, unsigned long); 240int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *, 241 void **); 242 243/* inode.c */ 244extern struct inode *nilfs_new_inode(struct inode *, int); 245extern void nilfs_free_inode(struct inode *); 246extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int); 247extern void nilfs_set_inode_flags(struct inode *); 248extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *); 249extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int); 250extern struct inode *nilfs_iget(struct super_block *, unsigned long); 251extern void nilfs_update_inode(struct inode *, struct buffer_head *); 252extern void nilfs_truncate(struct inode *); 253extern void nilfs_evict_inode(struct inode *); 254extern int nilfs_setattr(struct dentry *, struct iattr *); 255extern int nilfs_load_inode_block(struct nilfs_sb_info *, struct inode *, 256 struct buffer_head **); 257extern int nilfs_inode_dirty(struct inode *); 258extern int nilfs_set_file_dirty(struct nilfs_sb_info *, struct inode *, 259 unsigned); 260extern int nilfs_mark_inode_dirty(struct inode *); 261extern void nilfs_dirty_inode(struct inode *); 262 263/* namei.c */ 264extern struct dentry *nilfs_get_parent(struct dentry *); 265 266/* super.c */ 267extern struct inode *nilfs_alloc_inode_common(struct the_nilfs *); 268extern struct inode *nilfs_alloc_inode(struct super_block *); 269extern void nilfs_destroy_inode(struct inode *); 270extern void nilfs_error(struct super_block *, const char *, const char *, ...) 271 __attribute__ ((format (printf, 3, 4))); 272extern void nilfs_warning(struct super_block *, const char *, const char *, ...) 273 __attribute__ ((format (printf, 3, 4))); 274extern struct nilfs_super_block * 275nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **); 276extern int nilfs_store_magic_and_option(struct super_block *, 277 struct nilfs_super_block *, char *); 278extern int nilfs_check_feature_compatibility(struct super_block *, 279 struct nilfs_super_block *); 280extern void nilfs_set_log_cursor(struct nilfs_super_block *, 281 struct the_nilfs *); 282extern struct nilfs_super_block **nilfs_prepare_super(struct nilfs_sb_info *, 283 int flip); 284extern int nilfs_commit_super(struct nilfs_sb_info *, int); 285extern int nilfs_cleanup_super(struct nilfs_sb_info *); 286extern int nilfs_attach_checkpoint(struct nilfs_sb_info *, __u64); 287extern void nilfs_detach_checkpoint(struct nilfs_sb_info *); 288 289/* gcinode.c */ 290int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64, 291 struct buffer_head **); 292int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64, 293 struct buffer_head **); 294int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *); 295int nilfs_init_gccache(struct the_nilfs *); 296void nilfs_destroy_gccache(struct the_nilfs *); 297void nilfs_clear_gcinode(struct inode *); 298struct inode *nilfs_gc_iget(struct the_nilfs *, ino_t, __u64); 299void nilfs_remove_all_gcinode(struct the_nilfs *); 300 301/* gcdat.c */ 302int nilfs_init_gcdat_inode(struct the_nilfs *); 303void nilfs_commit_gcdat_inode(struct the_nilfs *); 304void nilfs_clear_gcdat_inode(struct the_nilfs *); 305 306/* 307 * Inodes and files operations 308 */ 309extern const struct file_operations nilfs_dir_operations; 310extern const struct inode_operations nilfs_file_inode_operations; 311extern const struct file_operations nilfs_file_operations; 312extern const struct address_space_operations nilfs_aops; 313extern const struct inode_operations nilfs_dir_inode_operations; 314extern const struct inode_operations nilfs_special_inode_operations; 315extern const struct inode_operations nilfs_symlink_inode_operations; 316 317/* 318 * filesystem type 319 */ 320extern struct file_system_type nilfs_fs_type; 321 322 323#endif /* _NILFS_H */ 324