2 * (C) 2001 Clemson University and The University of Chicago
4 * See COPYING in top-level directory.
8 #include "pvfs2-kernel.h"
9 #include "pvfs2-bufmap.h"
11 struct readdir_handle_s {
13 struct pvfs2_readdir_response_s readdir_response;
18 * decode routine needed by kmod to make sense of the shared page for readdirs.
20 static long decode_dirents(char *ptr, struct pvfs2_readdir_response_s *readdir)
23 struct pvfs2_readdir_response_s *rd =
24 (struct pvfs2_readdir_response_s *) ptr;
28 readdir->token = rd->token;
29 readdir->pvfs_dirent_outcount = rd->pvfs_dirent_outcount;
30 readdir->dirent_array = kmalloc(readdir->pvfs_dirent_outcount *
31 sizeof(*readdir->dirent_array),
33 if (readdir->dirent_array == NULL)
35 *pptr += offsetof(struct pvfs2_readdir_response_s, dirent_array);
36 for (i = 0; i < readdir->pvfs_dirent_outcount; i++) {
37 dec_string(pptr, &readdir->dirent_array[i].d_name,
38 &readdir->dirent_array[i].d_length);
39 readdir->dirent_array[i].khandle =
40 *(struct pvfs2_khandle *) *pptr;
43 return (unsigned long)*pptr - (unsigned long)ptr;
46 static long readdir_handle_ctor(struct readdir_handle_s *rhandle, void *buf,
53 ("Invalid NULL buffer specified in readdir_handle_ctor\n");
56 if (buffer_index < 0) {
58 ("Invalid buffer index specified in readdir_handle_ctor\n");
61 rhandle->buffer_index = buffer_index;
62 rhandle->dents_buf = buf;
63 ret = decode_dirents(buf, &rhandle->readdir_response);
65 gossip_err("Could not decode readdir from buffer %ld\n", ret);
66 rhandle->buffer_index = -1;
67 gossip_debug(GOSSIP_DIR_DEBUG, "vfree %p\n", buf);
69 rhandle->dents_buf = NULL;
74 static void readdir_handle_dtor(struct pvfs2_bufmap *bufmap,
75 struct readdir_handle_s *rhandle)
80 /* kfree(NULL) is safe */
81 kfree(rhandle->readdir_response.dirent_array);
82 rhandle->readdir_response.dirent_array = NULL;
84 if (rhandle->buffer_index >= 0) {
85 readdir_index_put(bufmap, rhandle->buffer_index);
86 rhandle->buffer_index = -1;
88 if (rhandle->dents_buf) {
89 gossip_debug(GOSSIP_DIR_DEBUG, "vfree %p\n",
91 vfree(rhandle->dents_buf);
92 rhandle->dents_buf = NULL;
97 * Read directory entries from an instance of an open directory.
99 static int pvfs2_readdir(struct file *file, struct dir_context *ctx)
101 struct pvfs2_bufmap *bufmap = NULL;
105 * ptoken supports Orangefs' distributed directory logic, added
108 __u64 *ptoken = file->private_data;
111 struct dentry *dentry = file->f_path.dentry;
112 struct pvfs2_kernel_op_s *new_op = NULL;
113 struct pvfs2_inode_s *pvfs2_inode = PVFS2_I(dentry->d_inode);
115 struct readdir_handle_s rhandle;
118 ino_t current_ino = 0;
119 char *current_entry = NULL;
122 gossip_debug(GOSSIP_DIR_DEBUG,
123 "%s: ctx->pos:%lld, ptoken = %llu\n",
128 pos = (__u64) ctx->pos;
131 if (pos == PVFS_READDIR_END) {
132 gossip_debug(GOSSIP_DIR_DEBUG,
133 "Skipping to termination path\n");
137 gossip_debug(GOSSIP_DIR_DEBUG,
138 "pvfs2_readdir called on %s (pos=%llu)\n",
139 dentry->d_name.name, llu(pos));
141 rhandle.buffer_index = -1;
142 rhandle.dents_buf = NULL;
143 memset(&rhandle.readdir_response, 0, sizeof(rhandle.readdir_response));
145 new_op = op_alloc(PVFS2_VFS_OP_READDIR);
149 new_op->uses_shared_memory = 1;
150 new_op->upcall.req.readdir.refn = pvfs2_inode->refn;
151 new_op->upcall.req.readdir.max_dirent_count = MAX_DIRENT_COUNT_READDIR;
153 gossip_debug(GOSSIP_DIR_DEBUG,
154 "%s: upcall.req.readdir.refn.khandle: %pU\n",
156 &new_op->upcall.req.readdir.refn.khandle);
158 new_op->upcall.req.readdir.token = *ptoken;
160 get_new_buffer_index:
161 ret = readdir_index_get(&bufmap, &buffer_index);
163 gossip_lerr("pvfs2_readdir: readdir_index_get() failure (%d)\n",
167 new_op->upcall.req.readdir.buf_index = buffer_index;
169 ret = service_operation(new_op,
171 get_interruptible_flag(dentry->d_inode));
173 gossip_debug(GOSSIP_DIR_DEBUG,
174 "Readdir downcall status is %d. ret:%d\n",
175 new_op->downcall.status,
178 if (ret == -EAGAIN && op_state_purged(new_op)) {
180 * readdir shared memory aread has been wiped due to
181 * pvfs2-client-core restarting, so we must get a new
182 * index into the shared memory.
184 gossip_debug(GOSSIP_DIR_DEBUG,
185 "%s: Getting new buffer_index for retry of readdir..\n",
187 readdir_index_put(bufmap, buffer_index);
188 goto get_new_buffer_index;
191 if (ret == -EIO && op_state_purged(new_op)) {
192 gossip_err("%s: Client is down. Aborting readdir call.\n",
194 readdir_index_put(bufmap, buffer_index);
198 if (ret < 0 || new_op->downcall.status != 0) {
199 gossip_debug(GOSSIP_DIR_DEBUG,
200 "Readdir request failed. Status:%d\n",
201 new_op->downcall.status);
202 readdir_index_put(bufmap, buffer_index);
204 ret = new_op->downcall.status;
209 readdir_handle_ctor(&rhandle,
210 new_op->downcall.trailer_buf,
212 if (bytes_decoded < 0) {
213 gossip_err("pvfs2_readdir: Could not decode trailer buffer into a readdir response %d\n",
216 readdir_index_put(bufmap, buffer_index);
220 if (bytes_decoded != new_op->downcall.trailer_size) {
221 gossip_err("pvfs2_readdir: # bytes decoded (%ld) "
222 "!= trailer size (%ld)\n",
224 (long)new_op->downcall.trailer_size);
226 goto out_destroy_handle;
230 * pvfs2 doesn't actually store dot and dot-dot, but
231 * we need to have them represented.
234 ino = get_ino_from_khandle(dentry->d_inode);
235 gossip_debug(GOSSIP_DIR_DEBUG,
236 "%s: calling dir_emit of \".\" with pos = %llu\n",
239 ret = dir_emit(ctx, ".", 1, ino, DT_DIR);
244 ino = get_parent_ino_from_dentry(dentry);
245 gossip_debug(GOSSIP_DIR_DEBUG,
246 "%s: calling dir_emit of \"..\" with pos = %llu\n",
249 ret = dir_emit(ctx, "..", 2, ino, DT_DIR);
254 * we stored PVFS_ITERATE_NEXT in ctx->pos last time around
255 * to prevent "finding" dot and dot-dot on any iteration
256 * other than the first.
258 if (ctx->pos == PVFS_ITERATE_NEXT)
262 i < rhandle.readdir_response.pvfs_dirent_outcount;
264 len = rhandle.readdir_response.dirent_array[i].d_length;
265 current_entry = rhandle.readdir_response.dirent_array[i].d_name;
266 current_ino = pvfs2_khandle_to_ino(
267 &(rhandle.readdir_response.dirent_array[i].khandle));
269 gossip_debug(GOSSIP_DIR_DEBUG,
270 "calling dir_emit for %s with len %d"
274 (unsigned long)ctx->pos);
276 * type is unknown. We don't return object type
277 * in the dirent_array. This leaves getdents
278 * clueless about type.
281 dir_emit(ctx, current_entry, len, current_ino, DT_UNKNOWN);
285 gossip_debug(GOSSIP_DIR_DEBUG,
286 "%s: ctx->pos:%lld\n",
293 * we ran all the way through the last batch, set up for
294 * getting another batch...
297 *ptoken = rhandle.readdir_response.token;
298 ctx->pos = PVFS_ITERATE_NEXT;
302 * Did we hit the end of the directory?
304 if (rhandle.readdir_response.token == PVFS_READDIR_END &&
306 gossip_debug(GOSSIP_DIR_DEBUG,
307 "End of dir detected; setting ctx->pos to PVFS_READDIR_END.\n");
308 ctx->pos = PVFS_READDIR_END;
312 readdir_handle_dtor(bufmap, &rhandle);
315 gossip_debug(GOSSIP_DIR_DEBUG, "pvfs2_readdir returning %d\n", ret);
319 static int pvfs2_dir_open(struct inode *inode, struct file *file)
323 file->private_data = kmalloc(sizeof(__u64), GFP_KERNEL);
324 if (!file->private_data)
327 ptoken = file->private_data;
328 *ptoken = PVFS_READDIR_START;
332 static int pvfs2_dir_release(struct inode *inode, struct file *file)
334 pvfs2_flush_inode(inode);
335 kfree(file->private_data);
339 /** PVFS2 implementation of VFS directory operations */
340 const struct file_operations pvfs2_dir_operations = {
341 .read = generic_read_dir,
342 .iterate = pvfs2_readdir,
343 .open = pvfs2_dir_open,
344 .release = pvfs2_dir_release,