exofs: Move all operations to an io_engine
[safe/jmp/linux-2.6] / fs / exofs / exofs.h
1 /*
2  * Copyright (C) 2005, 2006
3  * Avishay Traeger (avishay@gmail.com)
4  * Copyright (C) 2008, 2009
5  * Boaz Harrosh <bharrosh@panasas.com>
6  *
7  * Copyrights for code taken from ext2:
8  *     Copyright (C) 1992, 1993, 1994, 1995
9  *     Remy Card (card@masi.ibp.fr)
10  *     Laboratoire MASI - Institut Blaise Pascal
11  *     Universite Pierre et Marie Curie (Paris VI)
12  *     from
13  *     linux/fs/minix/inode.c
14  *     Copyright (C) 1991, 1992  Linus Torvalds
15  *
16  * This file is part of exofs.
17  *
18  * exofs is free software; you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation.  Since it is based on ext2, and the only
21  * valid version of GPL for the Linux kernel is version 2, the only valid
22  * version of GPL for exofs is version 2.
23  *
24  * exofs is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License
30  * along with exofs; if not, write to the Free Software
31  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
32  */
33 #ifndef __EXOFS_H__
34 #define __EXOFS_H__
35
36 #include <linux/fs.h>
37 #include <linux/time.h>
38 #include "common.h"
39
40 #define EXOFS_ERR(fmt, a...) printk(KERN_ERR "exofs: " fmt, ##a)
41
42 #ifdef CONFIG_EXOFS_DEBUG
43 #define EXOFS_DBGMSG(fmt, a...) \
44         printk(KERN_NOTICE "exofs @%s:%d: " fmt, __func__, __LINE__, ##a)
45 #else
46 #define EXOFS_DBGMSG(fmt, a...) \
47         do { if (0) printk(fmt, ##a); } while (0)
48 #endif
49
50 /* u64 has problems with printk this will cast it to unsigned long long */
51 #define _LLU(x) (unsigned long long)(x)
52
53 /*
54  * our extension to the in-memory superblock
55  */
56 struct exofs_sb_info {
57         struct osd_dev  *s_dev;                 /* returned by get_osd_dev    */
58         struct exofs_fscb s_fscb;               /* Written often, pre-allocate*/
59         osd_id          s_pid;                  /* partition ID of file system*/
60         int             s_timeout;              /* timeout for OSD operations */
61         uint64_t        s_nextid;               /* highest object ID used     */
62         uint32_t        s_numfiles;             /* number of files on fs      */
63         spinlock_t      s_next_gen_lock;        /* spinlock for gen # update  */
64         u32             s_next_generation;      /* next gen # to use          */
65         atomic_t        s_curr_pending;         /* number of pending commands */
66         uint8_t         s_cred[OSD_CAP_LEN];    /* all-powerful credential    */
67 };
68
69 /*
70  * our extension to the in-memory inode
71  */
72 struct exofs_i_info {
73         unsigned long  i_flags;            /* various atomic flags            */
74         uint32_t       i_data[EXOFS_IDATA];/*short symlink names and device #s*/
75         uint32_t       i_dir_start_lookup; /* which page to start lookup      */
76         wait_queue_head_t i_wq;            /* wait queue for inode            */
77         uint64_t       i_commit_size;      /* the object's written length     */
78         uint8_t        i_cred[OSD_CAP_LEN];/* all-powerful credential         */
79         struct inode   vfs_inode;          /* normal in-memory inode          */
80 };
81
82 static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
83 {
84         return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
85 }
86
87 struct exofs_io_state;
88 typedef void (*exofs_io_done_fn)(struct exofs_io_state *or, void *private);
89
90 struct exofs_io_state {
91         struct kref             kref;
92
93         void                    *private;
94         exofs_io_done_fn        done;
95
96         struct exofs_sb_info    *sbi;
97         struct osd_obj_id       obj;
98         u8                      *cred;
99
100         /* Global read/write IO*/
101         loff_t                  offset;
102         unsigned long           length;
103         void                    *kern_buff;
104         struct bio              *bio;
105
106         /* Attributes */
107         unsigned                in_attr_len;
108         struct osd_attr         *in_attr;
109         unsigned                out_attr_len;
110         struct osd_attr         *out_attr;
111
112         /* Variable array of size numdevs */
113         unsigned numdevs;
114         struct exofs_per_dev_state {
115                 struct osd_request *or;
116                 struct bio *bio;
117         } per_dev[];
118 };
119
120 static inline unsigned exofs_io_state_size(unsigned numdevs)
121 {
122         return sizeof(struct exofs_io_state) +
123                 sizeof(struct exofs_per_dev_state) * numdevs;
124 }
125
126 /*
127  * our inode flags
128  */
129 #define OBJ_2BCREATED   0       /* object will be created soon*/
130 #define OBJ_CREATED     1       /* object has been created on the osd*/
131
132 static inline int obj_2bcreated(struct exofs_i_info *oi)
133 {
134         return test_bit(OBJ_2BCREATED, &oi->i_flags);
135 }
136
137 static inline void set_obj_2bcreated(struct exofs_i_info *oi)
138 {
139         set_bit(OBJ_2BCREATED, &oi->i_flags);
140 }
141
142 static inline int obj_created(struct exofs_i_info *oi)
143 {
144         return test_bit(OBJ_CREATED, &oi->i_flags);
145 }
146
147 static inline void set_obj_created(struct exofs_i_info *oi)
148 {
149         set_bit(OBJ_CREATED, &oi->i_flags);
150 }
151
152 int __exofs_wait_obj_created(struct exofs_i_info *oi);
153 static inline int wait_obj_created(struct exofs_i_info *oi)
154 {
155         if (likely(obj_created(oi)))
156                 return 0;
157
158         return __exofs_wait_obj_created(oi);
159 }
160
161 /*
162  * get to our inode from the vfs inode
163  */
164 static inline struct exofs_i_info *exofs_i(struct inode *inode)
165 {
166         return container_of(inode, struct exofs_i_info, vfs_inode);
167 }
168
169 /*
170  * Maximum count of links to a file
171  */
172 #define EXOFS_LINK_MAX           32000
173
174 /*************************
175  * function declarations *
176  *************************/
177
178 /* ios.c */
179 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
180                            const struct osd_obj_id *obj);
181 int exofs_read_kern(struct osd_dev *od, u8 *cred, struct osd_obj_id *obj,
182                     u64 offset, void *p, unsigned length);
183
184 int  exofs_get_io_state(struct exofs_sb_info *sbi, struct exofs_io_state** ios);
185 void exofs_put_io_state(struct exofs_io_state *ios);
186
187 int exofs_check_io(struct exofs_io_state *ios, u64 *resid);
188
189 int exofs_sbi_create(struct exofs_io_state *ios);
190 int exofs_sbi_remove(struct exofs_io_state *ios);
191 int exofs_sbi_write(struct exofs_io_state *ios);
192 int exofs_sbi_read(struct exofs_io_state *ios);
193
194 int extract_attr_from_ios(struct exofs_io_state *ios, struct osd_attr *attr);
195
196 int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
197 static inline int exofs_oi_write(struct exofs_i_info *oi,
198                                  struct exofs_io_state *ios)
199 {
200         ios->obj.id = exofs_oi_objno(oi);
201         ios->cred = oi->i_cred;
202         return exofs_sbi_write(ios);
203 }
204
205 static inline int exofs_oi_read(struct exofs_i_info *oi,
206                                 struct exofs_io_state *ios)
207 {
208         ios->obj.id = exofs_oi_objno(oi);
209         ios->cred = oi->i_cred;
210         return exofs_sbi_read(ios);
211 }
212
213 /* inode.c               */
214 void exofs_truncate(struct inode *inode);
215 int exofs_setattr(struct dentry *, struct iattr *);
216 int exofs_write_begin(struct file *file, struct address_space *mapping,
217                 loff_t pos, unsigned len, unsigned flags,
218                 struct page **pagep, void **fsdata);
219 extern struct inode *exofs_iget(struct super_block *, unsigned long);
220 struct inode *exofs_new_inode(struct inode *, int);
221 extern int exofs_write_inode(struct inode *, int);
222 extern void exofs_delete_inode(struct inode *);
223
224 /* dir.c:                */
225 int exofs_add_link(struct dentry *, struct inode *);
226 ino_t exofs_inode_by_name(struct inode *, struct dentry *);
227 int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
228 int exofs_make_empty(struct inode *, struct inode *);
229 struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
230                                          struct page **);
231 int exofs_empty_dir(struct inode *);
232 struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
233 ino_t exofs_parent_ino(struct dentry *child);
234 int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
235                     struct inode *);
236
237 /* super.c               */
238 int exofs_sync_fs(struct super_block *sb, int wait);
239
240 /*********************
241  * operation vectors *
242  *********************/
243 /* dir.c:            */
244 extern const struct file_operations exofs_dir_operations;
245
246 /* file.c            */
247 extern const struct inode_operations exofs_file_inode_operations;
248 extern const struct file_operations exofs_file_operations;
249
250 /* inode.c           */
251 extern const struct address_space_operations exofs_aops;
252 extern const struct osd_attr g_attr_logical_length;
253
254 /* namei.c           */
255 extern const struct inode_operations exofs_dir_inode_operations;
256 extern const struct inode_operations exofs_special_inode_operations;
257
258 /* symlink.c         */
259 extern const struct inode_operations exofs_symlink_inode_operations;
260 extern const struct inode_operations exofs_fast_symlink_inode_operations;
261
262 #endif