tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 * Written by Koji Sato and Ryusuke Konishi.
17 */
18
19#ifndef _NILFS_H
20#define _NILFS_H
21
22#include <linux/kernel.h>
23#include <linux/buffer_head.h>
24#include <linux/spinlock.h>
25#include <linux/blkdev.h>
26#include <linux/nilfs2_api.h>
27#include <linux/nilfs2_ondisk.h>
28#include "the_nilfs.h"
29#include "bmap.h"
30
31/**
32 * struct nilfs_inode_info - nilfs inode data in memory
33 * @i_flags: inode flags
34 * @i_state: dynamic state flags
35 * @i_bmap: pointer on i_bmap_data
36 * @i_bmap_data: raw block mapping
37 * @i_xattr: <TODO>
38 * @i_dir_start_lookup: page index of last successful search
39 * @i_cno: checkpoint number for GC inode
40 * @i_btnode_cache: cached pages of b-tree nodes
41 * @i_dirty: list for connecting dirty files
42 * @xattr_sem: semaphore for extended attributes processing
43 * @i_bh: buffer contains disk inode
44 * @i_root: root object of the current filesystem tree
45 * @vfs_inode: VFS inode object
46 */
47struct nilfs_inode_info {
48 __u32 i_flags;
49 unsigned long i_state; /* Dynamic state flags */
50 struct nilfs_bmap *i_bmap;
51 struct nilfs_bmap i_bmap_data;
52 __u64 i_xattr; /* sector_t ??? */
53 __u32 i_dir_start_lookup;
54 __u64 i_cno; /* check point number for GC inode */
55 struct address_space i_btnode_cache;
56 struct list_head i_dirty; /* List for connecting dirty files */
57
58#ifdef CONFIG_NILFS_XATTR
59 /*
60 * Extended attributes can be read independently of the main file
61 * data. Taking i_sem even when reading would cause contention
62 * between readers of EAs and writers of regular file data, so
63 * instead we synchronize on xattr_sem when reading or changing
64 * EAs.
65 */
66 struct rw_semaphore xattr_sem;
67#endif
68 struct buffer_head *i_bh; /*
69 * i_bh contains a new or dirty
70 * disk inode.
71 */
72 struct nilfs_root *i_root;
73 struct inode vfs_inode;
74};
75
76static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
77{
78 return container_of(inode, struct nilfs_inode_info, vfs_inode);
79}
80
81static inline struct nilfs_inode_info *
82NILFS_BMAP_I(const struct nilfs_bmap *bmap)
83{
84 return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
85}
86
87static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
88{
89 struct nilfs_inode_info *ii =
90 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
91 return &ii->vfs_inode;
92}
93
94/*
95 * Dynamic state flags of NILFS on-memory inode (i_state)
96 */
97enum {
98 NILFS_I_NEW = 0, /* Inode is newly created */
99 NILFS_I_DIRTY, /* The file is dirty */
100 NILFS_I_QUEUED, /* inode is in dirty_files list */
101 NILFS_I_BUSY, /*
102 * Inode is grabbed by a segment
103 * constructor
104 */
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 */
115enum {
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 (BIT(NILFS_DAT_INO) | BIT(NILFS_CPFILE_INO) | \
125 BIT(NILFS_SUFILE_INO) | BIT(NILFS_IFILE_INO) | \
126 BIT(NILFS_ATIME_INO) | BIT(NILFS_SKETCH_INO))
127
128#define NILFS_SYS_INO_BITS (BIT(NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
129
130#define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
131
132#define NILFS_MDT_INODE(sb, ino) \
133 ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & BIT(ino)))
134#define NILFS_VALID_INODE(sb, ino) \
135 ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & BIT(ino)))
136
137/**
138 * struct nilfs_transaction_info: context information for synchronization
139 * @ti_magic: Magic number
140 * @ti_save: Backup of journal_info field of task_struct
141 * @ti_flags: Flags
142 * @ti_count: Nest level
143 */
144struct nilfs_transaction_info {
145 u32 ti_magic;
146 void *ti_save;
147 /*
148 * This should never be used. If it happens,
149 * one of other filesystems has a bug.
150 */
151 unsigned short ti_flags;
152 unsigned short ti_count;
153};
154
155/* ti_magic */
156#define NILFS_TI_MAGIC 0xd9e392fb
157
158/* ti_flags */
159#define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */
160#define NILFS_TI_SYNC 0x0002 /*
161 * Force to construct segment at the
162 * end of transaction.
163 */
164#define NILFS_TI_GC 0x0004 /* GC context */
165#define NILFS_TI_COMMIT 0x0008 /* Change happened or not */
166#define NILFS_TI_WRITER 0x0010 /* Constructor context */
167
168
169int nilfs_transaction_begin(struct super_block *,
170 struct nilfs_transaction_info *, int);
171int nilfs_transaction_commit(struct super_block *);
172void nilfs_transaction_abort(struct super_block *);
173
174static inline void nilfs_set_transaction_flag(unsigned int flag)
175{
176 struct nilfs_transaction_info *ti = current->journal_info;
177
178 ti->ti_flags |= flag;
179}
180
181static inline int nilfs_test_transaction_flag(unsigned int flag)
182{
183 struct nilfs_transaction_info *ti = current->journal_info;
184
185 if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
186 return 0;
187 return !!(ti->ti_flags & flag);
188}
189
190static inline int nilfs_doing_gc(void)
191{
192 return nilfs_test_transaction_flag(NILFS_TI_GC);
193}
194
195static inline int nilfs_doing_construction(void)
196{
197 return nilfs_test_transaction_flag(NILFS_TI_WRITER);
198}
199
200/*
201 * function prototype
202 */
203#ifdef CONFIG_NILFS_POSIX_ACL
204#error "NILFS: not yet supported POSIX ACL"
205extern int nilfs_acl_chmod(struct inode *);
206extern int nilfs_init_acl(struct inode *, struct inode *);
207#else
208static inline int nilfs_acl_chmod(struct inode *inode)
209{
210 return 0;
211}
212
213static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
214{
215 inode->i_mode &= ~current_umask();
216 return 0;
217}
218#endif
219
220#define NILFS_ATIME_DISABLE
221
222/* Flags that should be inherited by new inodes from their parent. */
223#define NILFS_FL_INHERITED \
224 (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL | \
225 FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
226 FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
227
228/* Mask out flags that are inappropriate for the given type of inode. */
229static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
230{
231 if (S_ISDIR(mode))
232 return flags;
233 else if (S_ISREG(mode))
234 return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
235 else
236 return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
237}
238
239/* dir.c */
240extern int nilfs_add_link(struct dentry *, struct inode *);
241extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
242extern int nilfs_make_empty(struct inode *, struct inode *);
243extern struct nilfs_dir_entry *
244nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
245extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
246extern int nilfs_empty_dir(struct inode *);
247extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
248extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
249 struct page *, struct inode *);
250
251/* file.c */
252extern int nilfs_sync_file(struct file *, loff_t, loff_t, int);
253
254/* ioctl.c */
255long nilfs_ioctl(struct file *, unsigned int, unsigned long);
256long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
257int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
258 void **);
259
260/* inode.c */
261void nilfs_inode_add_blocks(struct inode *inode, int n);
262void nilfs_inode_sub_blocks(struct inode *inode, int n);
263extern struct inode *nilfs_new_inode(struct inode *, umode_t);
264extern void nilfs_free_inode(struct inode *);
265extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
266extern void nilfs_set_inode_flags(struct inode *);
267extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
268extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
269struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
270 unsigned long ino);
271struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
272 unsigned long ino);
273struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
274 unsigned long ino);
275extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
276 unsigned long ino, __u64 cno);
277extern void nilfs_update_inode(struct inode *, struct buffer_head *, int);
278extern void nilfs_truncate(struct inode *);
279extern void nilfs_evict_inode(struct inode *);
280extern int nilfs_setattr(struct dentry *, struct iattr *);
281extern void nilfs_write_failed(struct address_space *mapping, loff_t to);
282int nilfs_permission(struct inode *inode, int mask);
283int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
284extern int nilfs_inode_dirty(struct inode *);
285int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty);
286extern int __nilfs_mark_inode_dirty(struct inode *, int);
287extern void nilfs_dirty_inode(struct inode *, int flags);
288int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
289 __u64 start, __u64 len);
290static inline int nilfs_mark_inode_dirty(struct inode *inode)
291{
292 return __nilfs_mark_inode_dirty(inode, I_DIRTY);
293}
294static inline int nilfs_mark_inode_dirty_sync(struct inode *inode)
295{
296 return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC);
297}
298
299/* super.c */
300extern struct inode *nilfs_alloc_inode(struct super_block *);
301extern void nilfs_destroy_inode(struct inode *);
302
303extern __printf(3, 4)
304void __nilfs_msg(struct super_block *sb, const char *level,
305 const char *fmt, ...);
306extern __printf(3, 4)
307void __nilfs_error(struct super_block *sb, const char *function,
308 const char *fmt, ...);
309
310#ifdef CONFIG_PRINTK
311
312#define nilfs_msg(sb, level, fmt, ...) \
313 __nilfs_msg(sb, level, fmt, ##__VA_ARGS__)
314#define nilfs_error(sb, fmt, ...) \
315 __nilfs_error(sb, __func__, fmt, ##__VA_ARGS__)
316
317#else
318
319#define nilfs_msg(sb, level, fmt, ...) \
320 do { \
321 no_printk(fmt, ##__VA_ARGS__); \
322 (void)(sb); \
323 } while (0)
324#define nilfs_error(sb, fmt, ...) \
325 do { \
326 no_printk(fmt, ##__VA_ARGS__); \
327 __nilfs_error(sb, "", " "); \
328 } while (0)
329
330#endif /* CONFIG_PRINTK */
331
332extern struct nilfs_super_block *
333nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
334extern int nilfs_store_magic_and_option(struct super_block *,
335 struct nilfs_super_block *, char *);
336extern int nilfs_check_feature_compatibility(struct super_block *,
337 struct nilfs_super_block *);
338extern void nilfs_set_log_cursor(struct nilfs_super_block *,
339 struct the_nilfs *);
340struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
341 int flip);
342int nilfs_commit_super(struct super_block *sb, int flag);
343int nilfs_cleanup_super(struct super_block *sb);
344int nilfs_resize_fs(struct super_block *sb, __u64 newsize);
345int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
346 struct nilfs_root **root);
347int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
348
349/* gcinode.c */
350int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
351 struct buffer_head **);
352int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
353 struct buffer_head **);
354int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
355int nilfs_init_gcinode(struct inode *inode);
356void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
357
358/* sysfs.c */
359int __init nilfs_sysfs_init(void);
360void nilfs_sysfs_exit(void);
361int nilfs_sysfs_create_device_group(struct super_block *);
362void nilfs_sysfs_delete_device_group(struct the_nilfs *);
363int nilfs_sysfs_create_snapshot_group(struct nilfs_root *);
364void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *);
365
366/*
367 * Inodes and files operations
368 */
369extern const struct file_operations nilfs_dir_operations;
370extern const struct inode_operations nilfs_file_inode_operations;
371extern const struct file_operations nilfs_file_operations;
372extern const struct address_space_operations nilfs_aops;
373extern const struct inode_operations nilfs_dir_inode_operations;
374extern const struct inode_operations nilfs_special_inode_operations;
375extern const struct inode_operations nilfs_symlink_inode_operations;
376
377/*
378 * filesystem type
379 */
380extern struct file_system_type nilfs_fs_type;
381
382
383#endif /* _NILFS_H */