09e33193551401a25784adf4c5d529526a9d8c25
[linux-3.10.git] / 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 /* FIXME: Remove once pnfs hits mainline
41  * #include <linux/exportfs/pnfs_osd_xdr.h>
42  */
43 #include "pnfs.h"
44
45 #define EXOFS_ERR(fmt, a...) printk(KERN_ERR "exofs: " fmt, ##a)
46
47 #ifdef CONFIG_EXOFS_DEBUG
48 #define EXOFS_DBGMSG(fmt, a...) \
49         printk(KERN_NOTICE "exofs @%s:%d: " fmt, __func__, __LINE__, ##a)
50 #else
51 #define EXOFS_DBGMSG(fmt, a...) \
52         do { if (0) printk(fmt, ##a); } while (0)
53 #endif
54
55 /* u64 has problems with printk this will cast it to unsigned long long */
56 #define _LLU(x) (unsigned long long)(x)
57
58 struct exofs_layout {
59         osd_id          s_pid;                  /* partition ID of file system*/
60
61         unsigned        s_numdevs;              /* Num of devices in array    */
62         struct osd_dev  *s_ods[0];              /* Variable length            */
63 };
64
65 /*
66  * our extension to the in-memory superblock
67  */
68 struct exofs_sb_info {
69         struct exofs_fscb s_fscb;               /* Written often, pre-allocate*/
70         int             s_timeout;              /* timeout for OSD operations */
71         uint64_t        s_nextid;               /* highest object ID used     */
72         uint32_t        s_numfiles;             /* number of files on fs      */
73         spinlock_t      s_next_gen_lock;        /* spinlock for gen # update  */
74         u32             s_next_generation;      /* next gen # to use          */
75         atomic_t        s_curr_pending;         /* number of pending commands */
76         uint8_t         s_cred[OSD_CAP_LEN];    /* credential for the fscb    */
77
78         struct pnfs_osd_data_map data_map;      /* Default raid to use
79                                                  * FIXME: Needed ?
80                                                  */
81 /*      struct exofs_layout     dir_layout;*/   /* Default dir layout */
82         struct exofs_layout     layout;         /* Default files layout,
83                                                  * contains the variable osd_dev
84                                                  * array. Keep last */
85         struct osd_dev  *_min_one_dev[1];       /* Place holder for one dev   */
86 };
87
88 /*
89  * our extension to the in-memory inode
90  */
91 struct exofs_i_info {
92         struct inode   vfs_inode;          /* normal in-memory inode          */
93         wait_queue_head_t i_wq;            /* wait queue for inode            */
94         unsigned long  i_flags;            /* various atomic flags            */
95         uint32_t       i_data[EXOFS_IDATA];/*short symlink names and device #s*/
96         uint32_t       i_dir_start_lookup; /* which page to start lookup      */
97         uint64_t       i_commit_size;      /* the object's written length     */
98         uint8_t        i_cred[OSD_CAP_LEN];/* all-powerful credential         */
99 };
100
101 static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
102 {
103         return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
104 }
105
106 struct exofs_io_state;
107 typedef void (*exofs_io_done_fn)(struct exofs_io_state *or, void *private);
108
109 struct exofs_io_state {
110         struct kref             kref;
111
112         void                    *private;
113         exofs_io_done_fn        done;
114
115         struct exofs_layout     *layout;
116         struct osd_obj_id       obj;
117         u8                      *cred;
118
119         /* Global read/write IO*/
120         loff_t                  offset;
121         unsigned long           length;
122         void                    *kern_buff;
123         struct bio              *bio;
124
125         /* Attributes */
126         unsigned                in_attr_len;
127         struct osd_attr         *in_attr;
128         unsigned                out_attr_len;
129         struct osd_attr         *out_attr;
130
131         /* Variable array of size numdevs */
132         unsigned numdevs;
133         struct exofs_per_dev_state {
134                 struct osd_request *or;
135                 struct bio *bio;
136         } per_dev[];
137 };
138
139 static inline unsigned exofs_io_state_size(unsigned numdevs)
140 {
141         return sizeof(struct exofs_io_state) +
142                 sizeof(struct exofs_per_dev_state) * numdevs;
143 }
144
145 /*
146  * our inode flags
147  */
148 #define OBJ_2BCREATED   0       /* object will be created soon*/
149 #define OBJ_CREATED     1       /* object has been created on the osd*/
150
151 static inline int obj_2bcreated(struct exofs_i_info *oi)
152 {
153         return test_bit(OBJ_2BCREATED, &oi->i_flags);
154 }
155
156 static inline void set_obj_2bcreated(struct exofs_i_info *oi)
157 {
158         set_bit(OBJ_2BCREATED, &oi->i_flags);
159 }
160
161 static inline int obj_created(struct exofs_i_info *oi)
162 {
163         return test_bit(OBJ_CREATED, &oi->i_flags);
164 }
165
166 static inline void set_obj_created(struct exofs_i_info *oi)
167 {
168         set_bit(OBJ_CREATED, &oi->i_flags);
169 }
170
171 int __exofs_wait_obj_created(struct exofs_i_info *oi);
172 static inline int wait_obj_created(struct exofs_i_info *oi)
173 {
174         if (likely(obj_created(oi)))
175                 return 0;
176
177         return __exofs_wait_obj_created(oi);
178 }
179
180 /*
181  * get to our inode from the vfs inode
182  */
183 static inline struct exofs_i_info *exofs_i(struct inode *inode)
184 {
185         return container_of(inode, struct exofs_i_info, vfs_inode);
186 }
187
188 /*
189  * Given a layout, object_number and stripe_index return the associated global
190  * dev_index
191  */
192 unsigned exofs_layout_od_id(struct exofs_layout *layout,
193                             osd_id obj_no, unsigned layout_index);
194 /*
195  * Maximum count of links to a file
196  */
197 #define EXOFS_LINK_MAX           32000
198
199 /*************************
200  * function declarations *
201  *************************/
202
203 /* ios.c */
204 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
205                            const struct osd_obj_id *obj);
206 int exofs_read_kern(struct osd_dev *od, u8 *cred, struct osd_obj_id *obj,
207                     u64 offset, void *p, unsigned length);
208
209 int  exofs_get_io_state(struct exofs_layout *layout,
210                         struct exofs_io_state **ios);
211 void exofs_put_io_state(struct exofs_io_state *ios);
212
213 int exofs_check_io(struct exofs_io_state *ios, u64 *resid);
214
215 int exofs_sbi_create(struct exofs_io_state *ios);
216 int exofs_sbi_remove(struct exofs_io_state *ios);
217 int exofs_sbi_write(struct exofs_io_state *ios);
218 int exofs_sbi_read(struct exofs_io_state *ios);
219
220 int extract_attr_from_ios(struct exofs_io_state *ios, struct osd_attr *attr);
221
222 int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
223 static inline int exofs_oi_write(struct exofs_i_info *oi,
224                                  struct exofs_io_state *ios)
225 {
226         ios->obj.id = exofs_oi_objno(oi);
227         ios->cred = oi->i_cred;
228         return exofs_sbi_write(ios);
229 }
230
231 static inline int exofs_oi_read(struct exofs_i_info *oi,
232                                 struct exofs_io_state *ios)
233 {
234         ios->obj.id = exofs_oi_objno(oi);
235         ios->cred = oi->i_cred;
236         return exofs_sbi_read(ios);
237 }
238
239 /* inode.c               */
240 void exofs_truncate(struct inode *inode);
241 int exofs_setattr(struct dentry *, struct iattr *);
242 int exofs_write_begin(struct file *file, struct address_space *mapping,
243                 loff_t pos, unsigned len, unsigned flags,
244                 struct page **pagep, void **fsdata);
245 extern struct inode *exofs_iget(struct super_block *, unsigned long);
246 struct inode *exofs_new_inode(struct inode *, int);
247 extern int exofs_write_inode(struct inode *, int);
248 extern void exofs_delete_inode(struct inode *);
249
250 /* dir.c:                */
251 int exofs_add_link(struct dentry *, struct inode *);
252 ino_t exofs_inode_by_name(struct inode *, struct dentry *);
253 int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
254 int exofs_make_empty(struct inode *, struct inode *);
255 struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
256                                          struct page **);
257 int exofs_empty_dir(struct inode *);
258 struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
259 ino_t exofs_parent_ino(struct dentry *child);
260 int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
261                     struct inode *);
262
263 /* super.c               */
264 int exofs_sync_fs(struct super_block *sb, int wait);
265
266 /*********************
267  * operation vectors *
268  *********************/
269 /* dir.c:            */
270 extern const struct file_operations exofs_dir_operations;
271
272 /* file.c            */
273 extern const struct inode_operations exofs_file_inode_operations;
274 extern const struct file_operations exofs_file_operations;
275
276 /* inode.c           */
277 extern const struct address_space_operations exofs_aops;
278 extern const struct osd_attr g_attr_logical_length;
279
280 /* namei.c           */
281 extern const struct inode_operations exofs_dir_inode_operations;
282 extern const struct inode_operations exofs_special_inode_operations;
283
284 /* symlink.c         */
285 extern const struct inode_operations exofs_symlink_inode_operations;
286 extern const struct inode_operations exofs_fast_symlink_inode_operations;
287
288 #endif