orangefs: Don't pollute global namespace
[linux-2.6-block.git] / fs / orangefs / dir.c
CommitLineData
5db11c21
MM
1/*
2 * (C) 2001 Clemson University and The University of Chicago
3 *
4 * See COPYING in top-level directory.
5 */
6
7#include "protocol.h"
575e9461
MM
8#include "orangefs-kernel.h"
9#include "orangefs-bufmap.h"
5db11c21
MM
10
11struct readdir_handle_s {
12 int buffer_index;
8bb8aefd 13 struct orangefs_readdir_response_s readdir_response;
5db11c21
MM
14 void *dents_buf;
15};
16
17/*
18 * decode routine needed by kmod to make sense of the shared page for readdirs.
19 */
8092895f 20static long decode_dirents(char *ptr, size_t size,
8bb8aefd 21 struct orangefs_readdir_response_s *readdir)
5db11c21
MM
22{
23 int i;
8bb8aefd
YL
24 struct orangefs_readdir_response_s *rd =
25 (struct orangefs_readdir_response_s *) ptr;
5db11c21 26 char *buf = ptr;
5db11c21 27
8bb8aefd 28 if (size < offsetof(struct orangefs_readdir_response_s, dirent_array))
8092895f
AV
29 return -EINVAL;
30
5db11c21 31 readdir->token = rd->token;
8bb8aefd
YL
32 readdir->orangefs_dirent_outcount = rd->orangefs_dirent_outcount;
33 readdir->dirent_array = kcalloc(readdir->orangefs_dirent_outcount,
5db11c21
MM
34 sizeof(*readdir->dirent_array),
35 GFP_KERNEL);
36 if (readdir->dirent_array == NULL)
37 return -ENOMEM;
8092895f 38
8bb8aefd
YL
39 buf += offsetof(struct orangefs_readdir_response_s, dirent_array);
40 size -= offsetof(struct orangefs_readdir_response_s, dirent_array);
8092895f 41
8bb8aefd 42 for (i = 0; i < readdir->orangefs_dirent_outcount; i++) {
8092895f
AV
43 __u32 len;
44
45 if (size < 4)
46 goto Einval;
47
48 len = *(__u32 *)buf;
49 if (len >= (unsigned)-24)
50 goto Einval;
51
9be68b08 52 readdir->dirent_array[i].d_name = buf + 4;
9be68b08 53 readdir->dirent_array[i].d_length = len;
8092895f
AV
54
55 len = roundup8(4 + len + 1);
56 if (size < len + 16)
57 goto Einval;
58 size -= len + 16;
59
60 buf += len;
61
5db11c21 62 readdir->dirent_array[i].khandle =
8bb8aefd 63 *(struct orangefs_khandle *) buf;
9be68b08 64 buf += 16;
5db11c21 65 }
9be68b08 66 return buf - ptr;
8092895f
AV
67Einval:
68 kfree(readdir->dirent_array);
69 readdir->dirent_array = NULL;
70 return -EINVAL;
5db11c21
MM
71}
72
73static long readdir_handle_ctor(struct readdir_handle_s *rhandle, void *buf,
8092895f 74 size_t size, int buffer_index)
5db11c21
MM
75{
76 long ret;
77
78 if (buf == NULL) {
79 gossip_err
80 ("Invalid NULL buffer specified in readdir_handle_ctor\n");
81 return -ENOMEM;
82 }
83 if (buffer_index < 0) {
84 gossip_err
85 ("Invalid buffer index specified in readdir_handle_ctor\n");
86 return -EINVAL;
87 }
88 rhandle->buffer_index = buffer_index;
89 rhandle->dents_buf = buf;
8092895f 90 ret = decode_dirents(buf, size, &rhandle->readdir_response);
5db11c21
MM
91 if (ret < 0) {
92 gossip_err("Could not decode readdir from buffer %ld\n", ret);
93 rhandle->buffer_index = -1;
94 gossip_debug(GOSSIP_DIR_DEBUG, "vfree %p\n", buf);
95 vfree(buf);
96 rhandle->dents_buf = NULL;
97 }
98 return ret;
99}
100
8bb8aefd 101static void readdir_handle_dtor(struct orangefs_bufmap *bufmap,
5db11c21
MM
102 struct readdir_handle_s *rhandle)
103{
104 if (rhandle == NULL)
105 return;
106
107 /* kfree(NULL) is safe */
108 kfree(rhandle->readdir_response.dirent_array);
109 rhandle->readdir_response.dirent_array = NULL;
110
111 if (rhandle->buffer_index >= 0) {
112 readdir_index_put(bufmap, rhandle->buffer_index);
113 rhandle->buffer_index = -1;
114 }
115 if (rhandle->dents_buf) {
116 gossip_debug(GOSSIP_DIR_DEBUG, "vfree %p\n",
117 rhandle->dents_buf);
118 vfree(rhandle->dents_buf);
119 rhandle->dents_buf = NULL;
120 }
121}
122
123/*
124 * Read directory entries from an instance of an open directory.
5db11c21 125 */
8bb8aefd 126static int orangefs_readdir(struct file *file, struct dir_context *ctx)
5db11c21 127{
8bb8aefd 128 struct orangefs_bufmap *bufmap = NULL;
5db11c21
MM
129 int ret = 0;
130 int buffer_index;
88309aae
MM
131 /*
132 * ptoken supports Orangefs' distributed directory logic, added
133 * in 2.9.2.
134 */
5db11c21
MM
135 __u64 *ptoken = file->private_data;
136 __u64 pos = 0;
137 ino_t ino = 0;
138 struct dentry *dentry = file->f_path.dentry;
8bb8aefd
YL
139 struct orangefs_kernel_op_s *new_op = NULL;
140 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(dentry->d_inode);
5db11c21
MM
141 int buffer_full = 0;
142 struct readdir_handle_s rhandle;
143 int i = 0;
144 int len = 0;
145 ino_t current_ino = 0;
146 char *current_entry = NULL;
147 long bytes_decoded;
148
88309aae
MM
149 gossip_debug(GOSSIP_DIR_DEBUG,
150 "%s: ctx->pos:%lld, ptoken = %llu\n",
151 __func__,
152 lld(ctx->pos),
153 llu(*ptoken));
5db11c21
MM
154
155 pos = (__u64) ctx->pos;
156
157 /* are we done? */
8bb8aefd 158 if (pos == ORANGEFS_READDIR_END) {
5db11c21
MM
159 gossip_debug(GOSSIP_DIR_DEBUG,
160 "Skipping to termination path\n");
161 return 0;
162 }
163
164 gossip_debug(GOSSIP_DIR_DEBUG,
8bb8aefd 165 "orangefs_readdir called on %s (pos=%llu)\n",
5db11c21
MM
166 dentry->d_name.name, llu(pos));
167
168 rhandle.buffer_index = -1;
169 rhandle.dents_buf = NULL;
170 memset(&rhandle.readdir_response, 0, sizeof(rhandle.readdir_response));
171
8bb8aefd 172 new_op = op_alloc(ORANGEFS_VFS_OP_READDIR);
5db11c21
MM
173 if (!new_op)
174 return -ENOMEM;
175
176 new_op->uses_shared_memory = 1;
8bb8aefd 177 new_op->upcall.req.readdir.refn = orangefs_inode->refn;
5db11c21
MM
178 new_op->upcall.req.readdir.max_dirent_count = MAX_DIRENT_COUNT_READDIR;
179
180 gossip_debug(GOSSIP_DIR_DEBUG,
181 "%s: upcall.req.readdir.refn.khandle: %pU\n",
182 __func__,
183 &new_op->upcall.req.readdir.refn.khandle);
184
5db11c21
MM
185 new_op->upcall.req.readdir.token = *ptoken;
186
187get_new_buffer_index:
188 ret = readdir_index_get(&bufmap, &buffer_index);
189 if (ret < 0) {
8bb8aefd 190 gossip_lerr("orangefs_readdir: readdir_index_get() failure (%d)\n",
5db11c21
MM
191 ret);
192 goto out_free_op;
193 }
194 new_op->upcall.req.readdir.buf_index = buffer_index;
195
196 ret = service_operation(new_op,
8bb8aefd 197 "orangefs_readdir",
5db11c21
MM
198 get_interruptible_flag(dentry->d_inode));
199
200 gossip_debug(GOSSIP_DIR_DEBUG,
201 "Readdir downcall status is %d. ret:%d\n",
202 new_op->downcall.status,
203 ret);
204
205 if (ret == -EAGAIN && op_state_purged(new_op)) {
206 /*
207 * readdir shared memory aread has been wiped due to
208 * pvfs2-client-core restarting, so we must get a new
209 * index into the shared memory.
210 */
211 gossip_debug(GOSSIP_DIR_DEBUG,
212 "%s: Getting new buffer_index for retry of readdir..\n",
213 __func__);
214 readdir_index_put(bufmap, buffer_index);
215 goto get_new_buffer_index;
216 }
217
218 if (ret == -EIO && op_state_purged(new_op)) {
219 gossip_err("%s: Client is down. Aborting readdir call.\n",
220 __func__);
221 readdir_index_put(bufmap, buffer_index);
222 goto out_free_op;
223 }
224
225 if (ret < 0 || new_op->downcall.status != 0) {
226 gossip_debug(GOSSIP_DIR_DEBUG,
227 "Readdir request failed. Status:%d\n",
228 new_op->downcall.status);
229 readdir_index_put(bufmap, buffer_index);
230 if (ret >= 0)
231 ret = new_op->downcall.status;
232 goto out_free_op;
233 }
234
235 bytes_decoded =
236 readdir_handle_ctor(&rhandle,
237 new_op->downcall.trailer_buf,
8092895f 238 new_op->downcall.trailer_size,
5db11c21
MM
239 buffer_index);
240 if (bytes_decoded < 0) {
8bb8aefd 241 gossip_err("orangefs_readdir: Could not decode trailer buffer into a readdir response %d\n",
5db11c21
MM
242 ret);
243 ret = bytes_decoded;
244 readdir_index_put(bufmap, buffer_index);
245 goto out_free_op;
246 }
247
248 if (bytes_decoded != new_op->downcall.trailer_size) {
8bb8aefd 249 gossip_err("orangefs_readdir: # bytes decoded (%ld) "
88309aae
MM
250 "!= trailer size (%ld)\n",
251 bytes_decoded,
252 (long)new_op->downcall.trailer_size);
5db11c21
MM
253 ret = -EINVAL;
254 goto out_destroy_handle;
255 }
256
88309aae 257 /*
8bb8aefd 258 * orangefs doesn't actually store dot and dot-dot, but
88309aae
MM
259 * we need to have them represented.
260 */
5db11c21
MM
261 if (pos == 0) {
262 ino = get_ino_from_khandle(dentry->d_inode);
263 gossip_debug(GOSSIP_DIR_DEBUG,
264 "%s: calling dir_emit of \".\" with pos = %llu\n",
265 __func__,
266 llu(pos));
267 ret = dir_emit(ctx, ".", 1, ino, DT_DIR);
88309aae 268 pos += 1;
5db11c21
MM
269 }
270
271 if (pos == 1) {
272 ino = get_parent_ino_from_dentry(dentry);
273 gossip_debug(GOSSIP_DIR_DEBUG,
274 "%s: calling dir_emit of \"..\" with pos = %llu\n",
275 __func__,
276 llu(pos));
277 ret = dir_emit(ctx, "..", 2, ino, DT_DIR);
88309aae 278 pos += 1;
5db11c21
MM
279 }
280
88309aae 281 /*
8bb8aefd 282 * we stored ORANGEFS_ITERATE_NEXT in ctx->pos last time around
88309aae
MM
283 * to prevent "finding" dot and dot-dot on any iteration
284 * other than the first.
285 */
8bb8aefd 286 if (ctx->pos == ORANGEFS_ITERATE_NEXT)
88309aae
MM
287 ctx->pos = 0;
288
289 for (i = ctx->pos;
8bb8aefd 290 i < rhandle.readdir_response.orangefs_dirent_outcount;
88309aae 291 i++) {
5db11c21
MM
292 len = rhandle.readdir_response.dirent_array[i].d_length;
293 current_entry = rhandle.readdir_response.dirent_array[i].d_name;
8bb8aefd 294 current_ino = orangefs_khandle_to_ino(
5db11c21
MM
295 &(rhandle.readdir_response.dirent_array[i].khandle));
296
297 gossip_debug(GOSSIP_DIR_DEBUG,
88309aae
MM
298 "calling dir_emit for %s with len %d"
299 ", ctx->pos %ld\n",
5db11c21
MM
300 current_entry,
301 len,
88309aae
MM
302 (unsigned long)ctx->pos);
303 /*
304 * type is unknown. We don't return object type
305 * in the dirent_array. This leaves getdents
306 * clueless about type.
307 */
5db11c21
MM
308 ret =
309 dir_emit(ctx, current_entry, len, current_ino, DT_UNKNOWN);
88309aae
MM
310 if (!ret)
311 break;
5db11c21 312 ctx->pos++;
88309aae 313 gossip_debug(GOSSIP_DIR_DEBUG,
5db11c21
MM
314 "%s: ctx->pos:%lld\n",
315 __func__,
316 lld(ctx->pos));
317
5db11c21
MM
318 }
319
54804949 320 /*
88309aae
MM
321 * we ran all the way through the last batch, set up for
322 * getting another batch...
323 */
324 if (ret) {
5db11c21 325 *ptoken = rhandle.readdir_response.token;
8bb8aefd 326 ctx->pos = ORANGEFS_ITERATE_NEXT;
5db11c21
MM
327 }
328
329 /*
330 * Did we hit the end of the directory?
331 */
8bb8aefd 332 if (rhandle.readdir_response.token == ORANGEFS_READDIR_END &&
5db11c21 333 !buffer_full) {
88309aae 334 gossip_debug(GOSSIP_DIR_DEBUG,
8bb8aefd
YL
335 "End of dir detected; setting ctx->pos to ORANGEFS_READDIR_END.\n");
336 ctx->pos = ORANGEFS_READDIR_END;
5db11c21
MM
337 }
338
5db11c21
MM
339out_destroy_handle:
340 readdir_handle_dtor(bufmap, &rhandle);
341out_free_op:
342 op_release(new_op);
8bb8aefd 343 gossip_debug(GOSSIP_DIR_DEBUG, "orangefs_readdir returning %d\n", ret);
5db11c21
MM
344 return ret;
345}
346
8bb8aefd 347static int orangefs_dir_open(struct inode *inode, struct file *file)
5db11c21
MM
348{
349 __u64 *ptoken;
350
351 file->private_data = kmalloc(sizeof(__u64), GFP_KERNEL);
352 if (!file->private_data)
353 return -ENOMEM;
354
355 ptoken = file->private_data;
8bb8aefd 356 *ptoken = ORANGEFS_READDIR_START;
5db11c21
MM
357 return 0;
358}
359
8bb8aefd 360static int orangefs_dir_release(struct inode *inode, struct file *file)
5db11c21 361{
8bb8aefd 362 orangefs_flush_inode(inode);
5db11c21
MM
363 kfree(file->private_data);
364 return 0;
365}
366
8bb8aefd
YL
367/** ORANGEFS implementation of VFS directory operations */
368const struct file_operations orangefs_dir_operations = {
5db11c21 369 .read = generic_read_dir,
8bb8aefd
YL
370 .iterate = orangefs_readdir,
371 .open = orangefs_dir_open,
372 .release = orangefs_dir_release,
5db11c21 373};