lustre/liblustre/dir.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * Copyright (c) 2011 Whamcloud, Inc.
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  *
  39  * lustre/liblustre/dir.c
  40  *
  41  * Lustre Light directory handling
  42  */
  43
  44 #define DEBUG_SUBSYSTEM S_LLITE
  45
  46 #include <unistd.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49 #include <assert.h>
  50 #include <time.h>
  51 #include <sys/types.h>
  52 #include <sys/stat.h>
  53 #include <fcntl.h>
  54 #include <sys/queue.h>
  55
  56 #ifdef HAVE_LINUX_UNISTD_H
  57 #include <linux/unistd.h>
  58 #elif defined(HAVE_UNISTD_H)
  59 #include <unistd.h>
  60 #endif
  61
  62
  63 #include "llite_lib.h"
  64 #include <dirent.h>
  65
  66 /* (new) readdir implementation overview can be found in lustre/llite/dir.c */
  67
  68 static int llu_dir_do_readpage(struct inode *inode, struct page *page)
  69 {
  70         struct llu_inode_info *lli = llu_i2info(inode);
  71         struct intnl_stat     *st = llu_i2stat(inode);
  72         struct llu_sb_info    *sbi = llu_i2sbi(inode);
  73         struct ptlrpc_request *request;
  74         struct lustre_handle   lockh;
  75         struct mdt_body       *body;
  76         struct lookup_intent   it = { .it_op = IT_READDIR };
  77         struct md_op_data      op_data = {{ 0 }};
  78         ldlm_policy_data_t policy = { .l_inodebits = { MDS_INODELOCK_UPDATE } };
  79         __u64 offset;
  80         int rc = 0;
  81         ENTRY;
  82
  83         rc = md_lock_match(sbi->ll_md_exp, LDLM_FL_BLOCK_GRANTED,
  84                            &lli->lli_fid, LDLM_IBITS, &policy, LCK_CR, &lockh);
  85         if (!rc) {
  86                 struct ldlm_enqueue_info einfo = {LDLM_IBITS, LCK_CR,
  87                         llu_md_blocking_ast, ldlm_completion_ast, NULL, NULL,
  88                         inode};
  89
  90                 llu_prep_md_op_data(&op_data, inode, NULL, NULL, 0, 0,
  91                                     LUSTRE_OPC_ANY);
  92
  93                 rc = md_enqueue(sbi->ll_md_exp, &einfo, &it,
  94                                 &op_data, &lockh, NULL, 0, NULL,
  95                                 LDLM_FL_CANCEL_ON_BLOCK);
  96                 request = (struct ptlrpc_request *)it.d.lustre.it_data;
  97                 if (request)
  98                         ptlrpc_req_finished(request);
  99                 if (rc < 0) {
 100                         CERROR("lock enqueue: err: %d\n", rc);
 101                         RETURN(rc);
 102                 }
 103         }
 104         ldlm_lock_dump_handle(D_OTHER, &lockh);
 105
 106         offset = (__u64)hash_x_index(page->index, 0);
 107         rc = md_readpage(sbi->ll_md_exp, &lli->lli_fid, NULL,
 108                          offset, &page, 1, &request);
 109         if (!rc) {
 110                 body = req_capsule_server_get(&request->rq_pill, &RMF_MDT_BODY);
 111                 LASSERT(body != NULL);         /* checked by md_readpage() */
 112
 113                 if (body->valid & OBD_MD_FLSIZE)
 114                         st->st_size = body->size;
 115         } else {
 116                 CERROR("read_dir_page(%ld) error %d\n", page->index, rc);
 117         }
 118         ptlrpc_req_finished(request);
 119         EXIT;
 120
 121         ldlm_lock_decref(&lockh, LCK_CR);
 122         return rc;
 123 }
 124
 125 static cfs_page_t *llu_dir_read_page(struct inode *ino, __u64 hash,
 126                                      int exact, struct ll_dir_chain *chain)
 127 {
 128         cfs_page_t *page;
 129         int rc;
 130         ENTRY;
 131
 132         OBD_PAGE_ALLOC(page, 0);
 133         if (!page)
 134                 RETURN(ERR_PTR(-ENOMEM));
 135         page->index = hash_x_index(hash, 0);
 136
 137         rc = llu_dir_do_readpage(ino, page);
 138         if (rc) {
 139                 OBD_PAGE_FREE(page);
 140                 RETURN(ERR_PTR(rc));
 141         }
 142
 143         return page;
 144 }
 145
 146 void *(*memmover)(void *, const void *, size_t) = memmove;
 147
 148 #define NAME_OFFSET(de) ((int) ((de)->d_name - (char *) (de)))
 149 #define ROUND_UP64(x)   (((x)+sizeof(__u64)-1) & ~(sizeof(__u64)-1))
 150 static int filldir(char *buf, int buflen,
 151                    const char *name, int namelen, loff_t offset,
 152                    ino_t ino, unsigned int d_type, int *filled)
 153 {
 154         cfs_dirent_t *dirent = (cfs_dirent_t *) (buf + *filled);
 155         cfs_dirent_t  holder;
 156         int reclen = ROUND_UP64(NAME_OFFSET(dirent) + namelen + 1);
 157
 158         /*
 159          * @buf is not guaranteed to be properly aligned. To work around,
 160          * first fill stack-allocated @holder, then copy @holder into @buf by
 161          * memmove().
 162          */
 163
 164         /* check overflow */
 165         if ((*filled + reclen) > buflen)
 166                 return 1;
 167
 168         holder.d_ino = ino;
 169 #ifdef _DIRENT_HAVE_D_OFF
 170         holder.d_off = offset;
 171 #endif
 172         holder.d_reclen = reclen;
 173 #ifdef _DIRENT_HAVE_D_TYPE
 174         holder.d_type = (unsigned short) d_type;
 175 #endif
 176         /* gcc unrolls memcpy() of structs into field-wise assignments,
 177          * assuming proper alignment. Humor it. */
 178         (*memmover)(dirent, &holder, NAME_OFFSET(dirent));
 179         memcpy(dirent->d_name, name, namelen);
 180         dirent->d_name[namelen] = 0;
 181
 182         *filled += reclen;
 183
 184         return 0;
 185 }
 186
 187 /*
 188  * TODO: much of the code here is similar/identical to llite ll_readdir().
 189  * These code can be factored out and shared in a common module.
 190  */
 191
 192 ssize_t llu_iop_filldirentries(struct inode *dir, _SYSIO_OFF_T *basep,
 193                                char *buf, size_t nbytes)
 194 {
 195         struct llu_inode_info *lli = llu_i2info(dir);
 196         struct intnl_stat     *st = llu_i2stat(dir);
 197         loff_t                 pos = *basep;
 198         struct ll_dir_chain    chain;
 199         cfs_page_t            *page;
 200         int filled = 0;
 201         int rc;
 202         int done;
 203         int shift;
 204         __u16 type;
 205         ENTRY;
 206
 207         liblustre_wait_event(0);
 208
 209         if (st->st_size == 0) {
 210                 CWARN("dir size is 0?\n");
 211                 RETURN(0);
 212         }
 213
 214         if (pos == MDS_DIR_END_OFF)
 215                 /*
 216                  * end-of-file.
 217                  */
 218                 RETURN(0);
 219
 220         rc    = 0;
 221         done  = 0;
 222         shift = 0;
 223         ll_dir_chain_init(&chain);
 224
 225         page = llu_dir_read_page(dir, pos, 0, &chain);
 226         while (rc == 0 && !done) {
 227                 struct lu_dirpage *dp;
 228                 struct lu_dirent  *ent;
 229
 230                 if (!IS_ERR(page)) {
 231                         /*
 232                          * If page is empty (end of directoryis reached),
 233                          * use this value.
 234                          */
 235                         __u64 hash = MDS_DIR_END_OFF;
 236                         __u64 next;
 237
 238                         dp = page->addr;
 239                         for (ent = lu_dirent_start(dp); ent != NULL && !done;
 240                              ent = lu_dirent_next(ent)) {
 241                                 char          *name;
 242                                 int            namelen;
 243                                 struct lu_fid  fid;
 244                                 __u64          ino;
 245
 246                                 hash    = le64_to_cpu(ent->lde_hash);
 247                                 namelen = le16_to_cpu(ent->lde_namelen);
 248
 249                                 if (hash < pos)
 250                                         /*
 251                                          * Skip until we find target hash
 252                                          * value.
 253                                          */
 254                                         continue;
 255
 256                                 if (namelen == 0)
 257                                         /*
 258                                          * Skip dummy record.
 259                                          */
 260                                         continue;
 261
 262                                 fid  = ent->lde_fid;
 263                                 name = ent->lde_name;
 264                                 fid_le_to_cpu(&fid, &fid);
 265                                 ino  = cl_fid_build_ino(&fid, 0);
 266                                 type = ll_dirent_type_get(ent);
 267                                 done = filldir(buf, nbytes, name, namelen,
 268                                                (loff_t)hash, ino, type,
 269                                                &filled);
 270                         }
 271                         next = le64_to_cpu(dp->ldp_hash_end);
 272                         OBD_PAGE_FREE(page);
 273                         if (!done) {
 274                                 pos = next;
 275                                 if (pos == MDS_DIR_END_OFF)
 276                                         /*
 277                                          * End of directory reached.
 278                                          */
 279                                         done = 1;
 280                                 else if (1 /* chain is exhausted*/)
 281                                         /*
 282                                          * Normal case: continue to the next
 283                                          * page.
 284                                          */
 285                                         page = llu_dir_read_page(dir, pos, 1,
 286                                                                &chain);
 287                                 else {
 288                                         /*
 289                                          * go into overflow page.
 290                                          */
 291                                 }
 292                         } else {
 293                                 pos = hash;
 294                                 if (filled == 0)
 295                                         GOTO(out, filled = -EINVAL);
 296                         }
 297                 } else {
 298                         rc = PTR_ERR(page);
 299                         CERROR("error reading dir "DFID" at %lu: rc %d\n",
 300                                PFID(&lli->lli_fid), (unsigned long)pos, rc);
 301                 }
 302         }
 303         lli->lli_dir_pos = (loff_t)pos;
 304         *basep = lli->lli_dir_pos;
 305 out:
 306         ll_dir_chain_fini(&chain);
 307         liblustre_wait_event(0);
 308         RETURN(filled);
 309 }