1 /*
2 * Copyright (C) 2005, 2006
3 * Avishay Traeger (avishay@gmail.com)
4 * Copyright (C) 2008, 2009
5 * Boaz Harrosh <ooo@electrozaur.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 <linux/backing-dev.h>
39 #include <scsi/osd_ore.h>
40
41 #include "common.h"
42
43 #define EXOFS_ERR(fmt, a...) printk(KERN_ERR "exofs: " fmt, ##a)
44
45 #ifdef CONFIG_EXOFS_DEBUG
46 #define EXOFS_DBGMSG(fmt, a...) \
47 printk(KERN_NOTICE "exofs @%s:%d: " fmt, __func__, __LINE__, ##a)
48 #else
49 #define EXOFS_DBGMSG(fmt, a...) \
50 do { if (0) printk(fmt, ##a); } while (0)
51 #endif
52
53 /* u64 has problems with printk this will cast it to unsigned long long */
54 #define _LLU(x) (unsigned long long)(x)
55
56 struct exofs_dev {
57 struct ore_dev ored;
58 unsigned did;
59 unsigned urilen;
60 uint8_t *uri;
61 struct kobject ed_kobj;
62 };
63 /*
64 * our extension to the in-memory superblock
65 */
66 struct exofs_sb_info {
67 struct exofs_sb_stats s_ess; /* Written often, pre-allocate*/
68 int s_timeout; /* timeout for OSD operations */
69 uint64_t s_nextid; /* highest object ID used */
70 uint32_t s_numfiles; /* number of files on fs */
71 spinlock_t s_next_gen_lock; /* spinlock for gen # update */
72 u32 s_next_generation; /* next gen # to use */
73 atomic_t s_curr_pending; /* number of pending commands */
74
75 struct ore_layout layout; /* Default files layout */
76 struct ore_comp one_comp; /* id & cred of partition id=0*/
77 struct ore_components oc; /* comps for the partition */
78 struct kobject s_kobj; /* holds per-sbi kobject */
79 };
80
81 /*
82 * our extension to the in-memory inode
83 */
84 struct exofs_i_info {
85 struct inode vfs_inode; /* normal in-memory inode */
86 wait_queue_head_t i_wq; /* wait queue for inode */
87 unsigned long i_flags; /* various atomic flags */
88 uint32_t i_data[EXOFS_IDATA];/*short symlink names and device #s*/
89 uint32_t i_dir_start_lookup; /* which page to start lookup */
90 uint64_t i_commit_size; /* the object's written length */
91 struct ore_comp one_comp; /* same component for all devices */
92 struct ore_components oc; /* inode view of the device table */
93 };
94
exofs_oi_objno(struct exofs_i_info * oi)95 static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
96 {
97 return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
98 }
99
100 /*
101 * our inode flags
102 */
103 #define OBJ_2BCREATED 0 /* object will be created soon*/
104 #define OBJ_CREATED 1 /* object has been created on the osd*/
105
obj_2bcreated(struct exofs_i_info * oi)106 static inline int obj_2bcreated(struct exofs_i_info *oi)
107 {
108 return test_bit(OBJ_2BCREATED, &oi->i_flags);
109 }
110
set_obj_2bcreated(struct exofs_i_info * oi)111 static inline void set_obj_2bcreated(struct exofs_i_info *oi)
112 {
113 set_bit(OBJ_2BCREATED, &oi->i_flags);
114 }
115
obj_created(struct exofs_i_info * oi)116 static inline int obj_created(struct exofs_i_info *oi)
117 {
118 return test_bit(OBJ_CREATED, &oi->i_flags);
119 }
120
set_obj_created(struct exofs_i_info * oi)121 static inline void set_obj_created(struct exofs_i_info *oi)
122 {
123 set_bit(OBJ_CREATED, &oi->i_flags);
124 }
125
126 int __exofs_wait_obj_created(struct exofs_i_info *oi);
wait_obj_created(struct exofs_i_info * oi)127 static inline int wait_obj_created(struct exofs_i_info *oi)
128 {
129 if (likely(obj_created(oi)))
130 return 0;
131
132 return __exofs_wait_obj_created(oi);
133 }
134
135 /*
136 * get to our inode from the vfs inode
137 */
exofs_i(struct inode * inode)138 static inline struct exofs_i_info *exofs_i(struct inode *inode)
139 {
140 return container_of(inode, struct exofs_i_info, vfs_inode);
141 }
142
143 /*
144 * Maximum count of links to a file
145 */
146 #define EXOFS_LINK_MAX 32000
147
148 /*************************
149 * function declarations *
150 *************************/
151
152 /* inode.c */
153 unsigned exofs_max_io_pages(struct ore_layout *layout,
154 unsigned expected_pages);
155 int exofs_setattr(struct dentry *, struct iattr *);
156 int exofs_write_begin(struct file *file, struct address_space *mapping,
157 loff_t pos, unsigned len, unsigned flags,
158 struct page **pagep, void **fsdata);
159 extern struct inode *exofs_iget(struct super_block *, unsigned long);
160 struct inode *exofs_new_inode(struct inode *, umode_t);
161 extern int exofs_write_inode(struct inode *, struct writeback_control *wbc);
162 extern void exofs_evict_inode(struct inode *);
163
164 /* dir.c: */
165 int exofs_add_link(struct dentry *, struct inode *);
166 ino_t exofs_inode_by_name(struct inode *, struct dentry *);
167 int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
168 int exofs_make_empty(struct inode *, struct inode *);
169 struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
170 struct page **);
171 int exofs_empty_dir(struct inode *);
172 struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
173 ino_t exofs_parent_ino(struct dentry *child);
174 int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
175 struct inode *);
176
177 /* super.c */
178 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
179 const struct osd_obj_id *obj);
180 int exofs_sbi_write_stats(struct exofs_sb_info *sbi);
181
182 /* sys.c */
183 int exofs_sysfs_init(void);
184 void exofs_sysfs_uninit(void);
185 int exofs_sysfs_sb_add(struct exofs_sb_info *sbi,
186 struct exofs_dt_device_info *dt_dev);
187 void exofs_sysfs_sb_del(struct exofs_sb_info *sbi);
188 int exofs_sysfs_odev_add(struct exofs_dev *edev,
189 struct exofs_sb_info *sbi);
190 void exofs_sysfs_dbg_print(void);
191
192 /*********************
193 * operation vectors *
194 *********************/
195 /* dir.c: */
196 extern const struct file_operations exofs_dir_operations;
197
198 /* file.c */
199 extern const struct inode_operations exofs_file_inode_operations;
200 extern const struct file_operations exofs_file_operations;
201
202 /* inode.c */
203 extern const struct address_space_operations exofs_aops;
204
205 /* namei.c */
206 extern const struct inode_operations exofs_dir_inode_operations;
207 extern const struct inode_operations exofs_special_inode_operations;
208
209 /* exofs_init_comps will initialize an ore_components device array
210 * pointing to a single ore_comp struct, and a round-robin view
211 * of the device table.
212 * The first device of each inode is the [inode->ino % num_devices]
213 * and the rest of the devices sequentially following where the
214 * first device is after the last device.
215 * It is assumed that the global device array at @sbi is twice
216 * bigger and that the device table repeats twice.
217 * See: exofs_read_lookup_dev_table()
218 */
exofs_init_comps(struct ore_components * oc,struct ore_comp * one_comp,struct exofs_sb_info * sbi,osd_id oid)219 static inline void exofs_init_comps(struct ore_components *oc,
220 struct ore_comp *one_comp,
221 struct exofs_sb_info *sbi, osd_id oid)
222 {
223 unsigned dev_mod = (unsigned)oid, first_dev;
224
225 one_comp->obj.partition = sbi->one_comp.obj.partition;
226 one_comp->obj.id = oid;
227 exofs_make_credential(one_comp->cred, &one_comp->obj);
228
229 oc->first_dev = 0;
230 oc->numdevs = sbi->layout.group_width * sbi->layout.mirrors_p1 *
231 sbi->layout.group_count;
232 oc->single_comp = EC_SINGLE_COMP;
233 oc->comps = one_comp;
234
235 /* Round robin device view of the table */
236 first_dev = (dev_mod * sbi->layout.mirrors_p1) % sbi->oc.numdevs;
237 oc->ods = &sbi->oc.ods[first_dev];
238 }
239
240 #endif
241