~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/fs/nilfs2/nilfs.h

Version: ~ [ linux-5.15-rc5 ] ~ [ linux-5.14.11 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.72 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.152 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.210 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.250 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.286 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.288 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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 "bmap.h"
 34 
 35 /**
 36  * struct nilfs_inode_info - nilfs inode data in memory
 37  * @i_flags: inode flags
 38  * @i_state: dynamic state flags
 39  * @i_bmap: pointer on i_bmap_data
 40  * @i_bmap_data: raw block mapping
 41  * @i_xattr: <TODO>
 42  * @i_dir_start_lookup: page index of last successful search
 43  * @i_cno: checkpoint number for GC inode
 44  * @i_btnode_cache: cached pages of b-tree nodes
 45  * @i_dirty: list for connecting dirty files
 46  * @xattr_sem: semaphore for extended attributes processing
 47  * @i_bh: buffer contains disk inode
 48  * @i_root: root object of the current filesystem tree
 49  * @vfs_inode: VFS inode object
 50  */
 51 struct nilfs_inode_info {
 52         __u32 i_flags;
 53         unsigned long  i_state;         /* Dynamic state flags */
 54         struct nilfs_bmap *i_bmap;
 55         struct nilfs_bmap i_bmap_data;
 56         __u64 i_xattr;  /* sector_t ??? */
 57         __u32 i_dir_start_lookup;
 58         __u64 i_cno;            /* check point number for GC inode */
 59         struct address_space i_btnode_cache;
 60         struct list_head i_dirty;       /* List for connecting dirty files */
 61 
 62 #ifdef CONFIG_NILFS_XATTR
 63         /*
 64          * Extended attributes can be read independently of the main file
 65          * data. Taking i_sem even when reading would cause contention
 66          * between readers of EAs and writers of regular file data, so
 67          * instead we synchronize on xattr_sem when reading or changing
 68          * EAs.
 69          */
 70         struct rw_semaphore xattr_sem;
 71 #endif
 72         struct buffer_head *i_bh;       /* i_bh contains a new or dirty
 73                                            disk inode */
 74         struct nilfs_root *i_root;
 75         struct inode vfs_inode;
 76 };
 77 
 78 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
 79 {
 80         return container_of(inode, struct nilfs_inode_info, vfs_inode);
 81 }
 82 
 83 static inline struct nilfs_inode_info *
 84 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
 85 {
 86         return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
 87 }
 88 
 89 static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
 90 {
 91         struct nilfs_inode_info *ii =
 92                 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
 93         return &ii->vfs_inode;
 94 }
 95 
 96 /*
 97  * Dynamic state flags of NILFS on-memory inode (i_state)
 98  */
 99 enum {
100         NILFS_I_NEW = 0,                /* Inode is newly created */
101         NILFS_I_DIRTY,                  /* The file is dirty */
102         NILFS_I_QUEUED,                 /* inode is in dirty_files list */
103         NILFS_I_BUSY,                   /* inode is grabbed by a segment
104                                            constructor */
105         NILFS_I_COLLECTED,              /* All dirty blocks are collected */
106         NILFS_I_UPDATED,                /* The file has been written back */
107         NILFS_I_INODE_SYNC,             /* dsync is not allowed for inode */
108         NILFS_I_BMAP,                   /* has bmap and btnode_cache */
109         NILFS_I_GCINODE,                /* inode for GC, on memory only */
110 };
111 
112 /*
113  * commit flags for nilfs_commit_super and nilfs_sync_super
114  */
115 enum {
116         NILFS_SB_COMMIT = 0,    /* Commit a super block alternately */
117         NILFS_SB_COMMIT_ALL     /* Commit both super blocks */
118 };
119 
120 /*
121  * Macros to check inode numbers
122  */
123 #define NILFS_MDT_INO_BITS   \
124         ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO |    \
125                         1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO |  \
126                         1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO))
127 
128 #define NILFS_SYS_INO_BITS   \
129         ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
130 
131 #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
132 
133 #define NILFS_MDT_INODE(sb, ino) \
134         ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino))))
135 #define NILFS_VALID_INODE(sb, ino) \
136         ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino))))
137 
138 /**
139  * struct nilfs_transaction_info: context information for synchronization
140  * @ti_magic: Magic number
141  * @ti_save: Backup of journal_info field of task_struct
142  * @ti_flags: Flags
143  * @ti_count: Nest level
144  */
145 struct nilfs_transaction_info {
146         u32                     ti_magic;
147         void                   *ti_save;
148                                 /* This should never used. If this happens,
149                                    one of other filesystems has a bug. */
150         unsigned short          ti_flags;
151         unsigned short          ti_count;
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 /*
198  * function prototype
199  */
200 #ifdef CONFIG_NILFS_POSIX_ACL
201 #error "NILFS: not yet supported POSIX ACL"
202 extern int nilfs_acl_chmod(struct inode *);
203 extern int nilfs_init_acl(struct inode *, struct inode *);
204 #else
205 static inline int nilfs_acl_chmod(struct inode *inode)
206 {
207         return 0;
208 }
209 
210 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
211 {
212         inode->i_mode &= ~current_umask();
213         return 0;
214 }
215 #endif
216 
217 #define NILFS_ATIME_DISABLE
218 
219 /* Flags that should be inherited by new inodes from their parent. */
220 #define NILFS_FL_INHERITED                                              \
221         (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL |          \
222          FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
223          FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
224 
225 /* Mask out flags that are inappropriate for the given type of inode. */
226 static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
227 {
228         if (S_ISDIR(mode))
229                 return flags;
230         else if (S_ISREG(mode))
231                 return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
232         else
233                 return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
234 }
235 
236 /* dir.c */
237 extern int nilfs_add_link(struct dentry *, struct inode *);
238 extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
239 extern int nilfs_make_empty(struct inode *, struct inode *);
240 extern struct nilfs_dir_entry *
241 nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
242 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
243 extern int nilfs_empty_dir(struct inode *);
244 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
245 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
246                            struct page *, struct inode *);
247 
248 /* file.c */
249 extern int nilfs_sync_file(struct file *, loff_t, loff_t, int);
250 
251 /* ioctl.c */
252 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
253 long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
254 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
255                                        void **);
256 
257 /* inode.c */
258 void nilfs_inode_add_blocks(struct inode *inode, int n);
259 void nilfs_inode_sub_blocks(struct inode *inode, int n);
260 extern struct inode *nilfs_new_inode(struct inode *, umode_t);
261 extern void nilfs_free_inode(struct inode *);
262 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
263 extern void nilfs_set_inode_flags(struct inode *);
264 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
265 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
266 struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
267                             unsigned long ino);
268 struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
269                                 unsigned long ino);
270 struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
271                          unsigned long ino);
272 extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
273                                        unsigned long ino, __u64 cno);
274 extern void nilfs_update_inode(struct inode *, struct buffer_head *, int);
275 extern void nilfs_truncate(struct inode *);
276 extern void nilfs_evict_inode(struct inode *);
277 extern int nilfs_setattr(struct dentry *, struct iattr *);
278 extern void nilfs_write_failed(struct address_space *mapping, loff_t to);
279 int nilfs_permission(struct inode *inode, int mask);
280 int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
281 extern int nilfs_inode_dirty(struct inode *);
282 int nilfs_set_file_dirty(struct inode *inode, unsigned nr_dirty);
283 extern int __nilfs_mark_inode_dirty(struct inode *, int);
284 extern void nilfs_dirty_inode(struct inode *, int flags);
285 int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
286                  __u64 start, __u64 len);
287 static inline int nilfs_mark_inode_dirty(struct inode *inode)
288 {
289         return __nilfs_mark_inode_dirty(inode, I_DIRTY);
290 }
291 static inline int nilfs_mark_inode_dirty_sync(struct inode *inode)
292 {
293         return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC);
294 }
295 
296 /* super.c */
297 extern struct inode *nilfs_alloc_inode(struct super_block *);
298 extern void nilfs_destroy_inode(struct inode *);
299 extern __printf(3, 4)
300 void nilfs_error(struct super_block *, const char *, const char *, ...);
301 extern __printf(3, 4)
302 void nilfs_warning(struct super_block *, const char *, const char *, ...);
303 extern struct nilfs_super_block *
304 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
305 extern int nilfs_store_magic_and_option(struct super_block *,
306                                         struct nilfs_super_block *, char *);
307 extern int nilfs_check_feature_compatibility(struct super_block *,
308                                              struct nilfs_super_block *);
309 extern void nilfs_set_log_cursor(struct nilfs_super_block *,
310                                  struct the_nilfs *);
311 struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
312                                                int flip);
313 int nilfs_commit_super(struct super_block *sb, int flag);
314 int nilfs_cleanup_super(struct super_block *sb);
315 int nilfs_resize_fs(struct super_block *sb, __u64 newsize);
316 int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
317                             struct nilfs_root **root);
318 int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
319 
320 /* gcinode.c */
321 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
322                                    struct buffer_head **);
323 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
324                                    struct buffer_head **);
325 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
326 int nilfs_init_gcinode(struct inode *inode);
327 void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
328 
329 /* sysfs.c */
330 int __init nilfs_sysfs_init(void);
331 void nilfs_sysfs_exit(void);
332 int nilfs_sysfs_create_device_group(struct super_block *);
333 void nilfs_sysfs_delete_device_group(struct the_nilfs *);
334 int nilfs_sysfs_create_snapshot_group(struct nilfs_root *);
335 void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *);
336 
337 /*
338  * Inodes and files operations
339  */
340 extern const struct file_operations nilfs_dir_operations;
341 extern const struct inode_operations nilfs_file_inode_operations;
342 extern const struct file_operations nilfs_file_operations;
343 extern const struct address_space_operations nilfs_aops;
344 extern const struct inode_operations nilfs_dir_inode_operations;
345 extern const struct inode_operations nilfs_special_inode_operations;
346 extern const struct inode_operations nilfs_symlink_inode_operations;
347 
348 /*
349  * filesystem type
350  */
351 extern struct file_system_type nilfs_fs_type;
352 
353 
354 #endif  /* _NILFS_H */
355 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp