lustre/llite/xattr_cache.c

   1 /* GPL HEADER START
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License version 2 for more details (a copy is included
  13  * in the LICENSE file that accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * version 2 along with this program; If not, see http://www.gnu.org/licenses
  17  *
  18  * Please  visit http://www.xyratex.com/contact if you need additional
  19  * information or have any questions.
  20  *
  21  * GPL HEADER END
  22  */
  23
  24 /*
  25  * Copyright 2012 Xyratex Technology Limited
  26  *
  27  * Author: Andrew Perepechko <Andrew_Perepechko@xyratex.com>
  28  *
  29  */
  30
  31 #define DEBUG_SUBSYSTEM S_LLITE
  32
  33 #include <linux/fs.h>
  34 #include <linux/sched.h>
  35 #include <linux/mm.h>
  36 #include <obd_support.h>
  37 #include <lustre_lite.h>
  38 #include <lustre_dlm.h>
  39 #include <lustre_ver.h>
  40 #include "llite_internal.h"
  41
  42 /* If we ever have hundreds of extended attributes, we might want to consider
  43  * using a hash or a tree structure instead of list for faster lookups.
  44  */
  45 struct ll_xattr_entry {
  46         struct list_head        xe_list;    /* protected with
  47                                              * lli_xattrs_list_rwsem */
  48         char                    *xe_name;   /* xattr name, \0-terminated */
  49         char                    *xe_value;  /* xattr value */
  50         unsigned                xe_namelen; /* strlen(xe_name) + 1 */
  51         unsigned                xe_vallen;  /* xattr value length */
  52 };
  53
  54 static struct kmem_cache *xattr_kmem;
  55 static struct lu_kmem_descr xattr_caches[] = {
  56         {
  57                 .ckd_cache = &xattr_kmem,
  58                 .ckd_name  = "xattr_kmem",
  59                 .ckd_size  = sizeof(struct ll_xattr_entry)
  60         },
  61         {
  62                 .ckd_cache = NULL
  63         }
  64 };
  65
  66 int ll_xattr_init(void)
  67 {
  68         return lu_kmem_init(xattr_caches);
  69 }
  70
  71 void ll_xattr_fini(void)
  72 {
  73         lu_kmem_fini(xattr_caches);
  74 }
  75
  76 /**
  77  * Initializes xattr cache for an inode.
  78  *
  79  * This initializes the xattr list and marks cache presence.
  80  */
  81 static void ll_xattr_cache_init(struct ll_inode_info *lli)
  82 {
  83         ENTRY;
  84
  85         LASSERT(lli != NULL);
  86
  87         INIT_LIST_HEAD(&lli->lli_xattrs);
  88         lli->lli_flags |= LLIF_XATTR_CACHE;
  89 }
  90
  91 /**
  92  *  This looks for a specific extended attribute.
  93  *
  94  *  Find in @cache and return @xattr_name attribute in @xattr,
  95  *  for the NULL @xattr_name return the first cached @xattr.
  96  *
  97  *  \retval 0        success
  98  *  \retval -ENODATA if not found
  99  */
 100 static int ll_xattr_cache_find(struct list_head *cache,
 101                                const char *xattr_name,
 102                                struct ll_xattr_entry **xattr)
 103 {
 104         struct ll_xattr_entry *entry;
 105
 106         ENTRY;
 107
 108         list_for_each_entry(entry, cache, xe_list) {
 109                 /* xattr_name == NULL means look for any entry */
 110                 if (xattr_name == NULL ||
 111                     strcmp(xattr_name, entry->xe_name) == 0) {
 112                         *xattr = entry;
 113                         CDEBUG(D_CACHE, "find: [%s]=%.*s\n",
 114                                entry->xe_name, entry->xe_vallen,
 115                                entry->xe_value);
 116                         RETURN(0);
 117                 }
 118         }
 119
 120         RETURN(-ENODATA);
 121 }
 122
 123 /**
 124  * This adds an xattr.
 125  *
 126  * Add @xattr_name attr with @xattr_val value and @xattr_val_len length,
 127  *
 128  * \retval 0       success
 129  * \retval -ENOMEM if no memory could be allocated for the cached attr
 130  * \retval -EPROTO if duplicate xattr is being added
 131  */
 132 static int ll_xattr_cache_add(struct list_head *cache,
 133                               const char *xattr_name,
 134                               const char *xattr_val,
 135                               unsigned xattr_val_len)
 136 {
 137         struct ll_xattr_entry *xattr;
 138
 139         ENTRY;
 140
 141         if (ll_xattr_cache_find(cache, xattr_name, &xattr) == 0) {
 142                 CDEBUG(D_CACHE, "duplicate xattr: [%s]\n", xattr_name);
 143                 RETURN(-EPROTO);
 144         }
 145
 146         OBD_SLAB_ALLOC_PTR_GFP(xattr, xattr_kmem, GFP_NOFS);
 147         if (xattr == NULL) {
 148                 CDEBUG(D_CACHE, "failed to allocate xattr\n");
 149                 RETURN(-ENOMEM);
 150         }
 151
 152         xattr->xe_namelen = strlen(xattr_name) + 1;
 153
 154         OBD_ALLOC(xattr->xe_name, xattr->xe_namelen);
 155         if (!xattr->xe_name) {
 156                 CDEBUG(D_CACHE, "failed to alloc xattr name %u\n",
 157                        xattr->xe_namelen);
 158                 goto err_name;
 159         }
 160         OBD_ALLOC(xattr->xe_value, xattr_val_len);
 161         if (!xattr->xe_value) {
 162                 CDEBUG(D_CACHE, "failed to alloc xattr value %d\n",
 163                        xattr_val_len);
 164                 goto err_value;
 165         }
 166
 167         memcpy(xattr->xe_name, xattr_name, xattr->xe_namelen);
 168         memcpy(xattr->xe_value, xattr_val, xattr_val_len);
 169         xattr->xe_vallen = xattr_val_len;
 170         list_add(&xattr->xe_list, cache);
 171
 172         CDEBUG(D_CACHE, "set: [%s]=%.*s\n", xattr_name,
 173                 xattr_val_len, xattr_val);
 174
 175         RETURN(0);
 176 err_value:
 177         OBD_FREE(xattr->xe_name, xattr->xe_namelen);
 178 err_name:
 179         OBD_SLAB_FREE_PTR(xattr, xattr_kmem);
 180
 181         RETURN(-ENOMEM);
 182 }
 183
 184 /**
 185  * This removes an extended attribute from cache.
 186  *
 187  * Remove @xattr_name attribute from @cache.
 188  *
 189  * \retval 0        success
 190  * \retval -ENODATA if @xattr_name is not cached
 191  */
 192 static int ll_xattr_cache_del(struct list_head *cache,
 193                               const char *xattr_name)
 194 {
 195         struct ll_xattr_entry *xattr;
 196
 197         ENTRY;
 198
 199         CDEBUG(D_CACHE, "del xattr: %s\n", xattr_name);
 200
 201         if (ll_xattr_cache_find(cache, xattr_name, &xattr) == 0) {
 202                 list_del(&xattr->xe_list);
 203                 OBD_FREE(xattr->xe_name, xattr->xe_namelen);
 204                 OBD_FREE(xattr->xe_value, xattr->xe_vallen);
 205                 OBD_SLAB_FREE_PTR(xattr, xattr_kmem);
 206
 207                 RETURN(0);
 208         }
 209
 210         RETURN(-ENODATA);
 211 }
 212
 213 /**
 214  * This iterates cached extended attributes.
 215  *
 216  * Walk over cached attributes in @cache and
 217  * fill in @xld_buffer or only calculate buffer
 218  * size if @xld_buffer is NULL.
 219  *
 220  * \retval >= 0     buffer list size
 221  * \retval -ENODATA if the list cannot fit @xld_size buffer
 222  */
 223 static int ll_xattr_cache_list(struct list_head *cache,
 224                                char *xld_buffer,
 225                                int xld_size)
 226 {
 227         struct ll_xattr_entry *xattr, *tmp;
 228         int xld_tail = 0;
 229
 230         ENTRY;
 231
 232         list_for_each_entry_safe(xattr, tmp, cache, xe_list) {
 233                 CDEBUG(D_CACHE, "list: buffer=%p[%d] name=%s\n",
 234                         xld_buffer, xld_tail, xattr->xe_name);
 235
 236                 if (xld_buffer) {
 237                         xld_size -= xattr->xe_namelen;
 238                         if (xld_size < 0)
 239                                 break;
 240                         memcpy(&xld_buffer[xld_tail],
 241                                xattr->xe_name, xattr->xe_namelen);
 242                 }
 243                 xld_tail += xattr->xe_namelen;
 244         }
 245
 246         if (xld_size < 0)
 247                 RETURN(-ERANGE);
 248
 249         RETURN(xld_tail);
 250 }
 251
 252 /**
 253  * Check if the xattr cache is initialized (filled).
 254  *
 255  * \retval 0 @cache is not initialized
 256  * \retval 1 @cache is initialized
 257  */
 258 static int ll_xattr_cache_valid(struct ll_inode_info *lli)
 259 {
 260         return !!(lli->lli_flags & LLIF_XATTR_CACHE);
 261 }
 262
 263 /**
 264  * This finalizes the xattr cache.
 265  *
 266  * Free all xattr memory. @lli is the inode info pointer.
 267  *
 268  * \retval 0 no error occured
 269  */
 270 static int ll_xattr_cache_destroy_locked(struct ll_inode_info *lli)
 271 {
 272         ENTRY;
 273
 274         if (!ll_xattr_cache_valid(lli))
 275                 RETURN(0);
 276
 277         while (ll_xattr_cache_del(&lli->lli_xattrs, NULL) == 0)
 278                 /* empty loop */ ;
 279         lli->lli_flags &= ~LLIF_XATTR_CACHE;
 280
 281         RETURN(0);
 282 }
 283
 284 int ll_xattr_cache_destroy(struct inode *inode)
 285 {
 286         struct ll_inode_info *lli = ll_i2info(inode);
 287         int rc;
 288
 289         ENTRY;
 290
 291         down_write(&lli->lli_xattrs_list_rwsem);
 292         rc = ll_xattr_cache_destroy_locked(lli);
 293         up_write(&lli->lli_xattrs_list_rwsem);
 294
 295         RETURN(rc);
 296 }
 297
 298 /**
 299  * Match or enqueue a PR lock.
 300  *
 301  * Find or request an LDLM lock with xattr data.
 302  * Since LDLM does not provide API for atomic match_or_enqueue,
 303  * the function handles it with a separate enq lock.
 304  * If successful, the function exits with the list lock held.
 305  *
 306  * \retval 0       no error occured
 307  * \retval -ENOMEM not enough memory
 308  */
 309 static int ll_xattr_find_get_lock(struct inode *inode,
 310                                   struct lookup_intent *oit,
 311                                   struct ptlrpc_request **req)
 312 {
 313         ldlm_mode_t mode;
 314         struct lustre_handle lockh = { 0 };
 315         struct md_op_data *op_data;
 316         struct ll_inode_info *lli = ll_i2info(inode);
 317         struct ldlm_enqueue_info einfo = {
 318                 .ei_type = LDLM_IBITS,
 319                 .ei_mode = it_to_lock_mode(oit),
 320                 .ei_cb_bl = &ll_md_blocking_ast,
 321                 .ei_cb_cp = &ldlm_completion_ast,
 322         };
 323         struct ll_sb_info *sbi = ll_i2sbi(inode);
 324         struct obd_export *exp = sbi->ll_md_exp;
 325         int rc;
 326
 327         ENTRY;
 328
 329         mutex_lock(&lli->lli_xattrs_enq_lock);
 330         /* Try matching first. */
 331         mode = ll_take_md_lock(inode, MDS_INODELOCK_XATTR, &lockh, 0, LCK_PR);
 332         if (mode != 0) {
 333                 /* fake oit in mdc_revalidate_lock() manner */
 334                 oit->d.lustre.it_lock_handle = lockh.cookie;
 335                 oit->d.lustre.it_lock_mode = mode;
 336                 goto out;
 337         }
 338
 339         /* Enqueue if the lock isn't cached locally. */
 340         op_data = ll_prep_md_op_data(NULL, inode, NULL, NULL, 0, 0,
 341                                      LUSTRE_OPC_ANY, NULL);
 342         if (IS_ERR(op_data)) {
 343                 mutex_unlock(&lli->lli_xattrs_enq_lock);
 344                 RETURN(PTR_ERR(op_data));
 345         }
 346
 347         op_data->op_valid = OBD_MD_FLXATTR | OBD_MD_FLXATTRLS;
 348
 349         rc = md_enqueue(exp, &einfo, NULL, oit, op_data, &lockh, 0);
 350         ll_finish_md_op_data(op_data);
 351
 352         if (rc < 0) {
 353                 CDEBUG(D_CACHE, "md_intent_lock failed with %d for fid "DFID"\n",
 354                        rc, PFID(ll_inode2fid(inode)));
 355                 mutex_unlock(&lli->lli_xattrs_enq_lock);
 356                 RETURN(rc);
 357         }
 358
 359         *req = (struct ptlrpc_request *)oit->d.lustre.it_data;
 360 out:
 361         down_write(&lli->lli_xattrs_list_rwsem);
 362         mutex_unlock(&lli->lli_xattrs_enq_lock);
 363
 364         RETURN(0);
 365 }
 366
 367 /**
 368  * Refill the xattr cache.
 369  *
 370  * Fetch and cache the whole of xattrs for @inode, acquiring
 371  * a read or a write xattr lock depending on operation in @oit.
 372  * Intent is dropped on exit unless the operation is setxattr.
 373  *
 374  * \retval 0       no error occured
 375  * \retval -EPROTO network protocol error
 376  * \retval -ENOMEM not enough memory for the cache
 377  */
 378 static int ll_xattr_cache_refill(struct inode *inode, struct lookup_intent *oit)
 379 {
 380         struct ll_sb_info *sbi = ll_i2sbi(inode);
 381         struct ptlrpc_request *req = NULL;
 382         const char *xdata, *xval, *xtail, *xvtail;
 383         struct ll_inode_info *lli = ll_i2info(inode);
 384         struct mdt_body *body;
 385         __u32 *xsizes;
 386         int rc = 0, i;
 387
 388         ENTRY;
 389
 390         rc = ll_xattr_find_get_lock(inode, oit, &req);
 391         if (rc)
 392                 GOTO(out_no_unlock, rc);
 393
 394         /* Do we have the data at this point? */
 395         if (ll_xattr_cache_valid(lli)) {
 396                 ll_stats_ops_tally(sbi, LPROC_LL_GETXATTR_HITS, 1);
 397                 GOTO(out_maybe_drop, rc = 0);
 398         }
 399
 400         /* Matched but no cache? Cancelled on error by a parallel refill. */
 401         if (unlikely(req == NULL)) {
 402                 CDEBUG(D_CACHE, "cancelled by a parallel getxattr\n");
 403                 GOTO(out_maybe_drop, rc = -EIO);
 404         }
 405
 406         if (oit->d.lustre.it_status < 0) {
 407                 CDEBUG(D_CACHE, "getxattr intent returned %d for fid "DFID"\n",
 408                        oit->d.lustre.it_status, PFID(ll_inode2fid(inode)));
 409                 rc = oit->d.lustre.it_status;
 410                 /* xattr data is so large that we don't want to cache it */
 411                 if (rc == -ERANGE)
 412                         rc = -EAGAIN;
 413                 GOTO(out_destroy, rc);
 414         }
 415
 416         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
 417         if (body == NULL) {
 418                 CERROR("no MDT BODY in the refill xattr reply\n");
 419                 GOTO(out_destroy, rc = -EPROTO);
 420         }
 421         /* do not need swab xattr data */
 422         xdata = req_capsule_server_sized_get(&req->rq_pill, &RMF_EADATA,
 423                                                 body->eadatasize);
 424         xval = req_capsule_server_sized_get(&req->rq_pill, &RMF_EAVALS,
 425                                                 body->aclsize);
 426         xsizes = req_capsule_server_sized_get(&req->rq_pill, &RMF_EAVALS_LENS,
 427                                               body->max_mdsize * sizeof(__u32));
 428         if (xdata == NULL || xval == NULL || xsizes == NULL) {
 429                 CERROR("wrong setxattr reply\n");
 430                 GOTO(out_destroy, rc = -EPROTO);
 431         }
 432
 433         xtail = xdata + body->eadatasize;
 434         xvtail = xval + body->aclsize;
 435
 436         CDEBUG(D_CACHE, "caching: xdata=%p xtail=%p\n", xdata, xtail);
 437
 438         ll_xattr_cache_init(lli);
 439
 440         for (i = 0; i < body->max_mdsize; i++) {
 441                 CDEBUG(D_CACHE, "caching [%s]=%.*s\n", xdata, *xsizes, xval);
 442                 /* Perform consistency checks: attr names and vals in pill */
 443                 if (memchr(xdata, 0, xtail - xdata) == NULL) {
 444                         CERROR("xattr protocol violation (names are broken)\n");
 445                         rc = -EPROTO;
 446                 } else if (xval + *xsizes > xvtail) {
 447                         CERROR("xattr protocol violation (vals are broken)\n");
 448                         rc = -EPROTO;
 449                 } else if (OBD_FAIL_CHECK(OBD_FAIL_LLITE_XATTR_ENOMEM)) {
 450                         rc = -ENOMEM;
 451                 } else if (!strcmp(xdata, XATTR_NAME_ACL_ACCESS)) {
 452                         /* Filter out ACL ACCESS since it's cached separately */
 453                         CDEBUG(D_CACHE, "not caching %s\n",
 454                                XATTR_NAME_ACL_ACCESS);
 455                         rc = 0;
 456                 } else {
 457                         rc = ll_xattr_cache_add(&lli->lli_xattrs, xdata, xval,
 458                                                 *xsizes);
 459                 }
 460                 if (rc < 0) {
 461                         ll_xattr_cache_destroy_locked(lli);
 462                         GOTO(out_destroy, rc);
 463                 }
 464                 xdata += strlen(xdata) + 1;
 465                 xval  += *xsizes;
 466                 xsizes++;
 467         }
 468
 469         if (xdata != xtail || xval != xvtail)
 470                 CERROR("a hole in xattr data\n");
 471
 472         ll_set_lock_data(sbi->ll_md_exp, inode, oit, NULL);
 473
 474         GOTO(out_maybe_drop, rc);
 475 out_maybe_drop:
 476
 477         ll_intent_drop_lock(oit);
 478
 479         if (rc != 0)
 480                 up_write(&lli->lli_xattrs_list_rwsem);
 481 out_no_unlock:
 482         ptlrpc_req_finished(req);
 483
 484         return rc;
 485
 486 out_destroy:
 487         up_write(&lli->lli_xattrs_list_rwsem);
 488
 489         ldlm_lock_decref_and_cancel((struct lustre_handle *)
 490                                         &oit->d.lustre.it_lock_handle,
 491                                         oit->d.lustre.it_lock_mode);
 492
 493         goto out_no_unlock;
 494 }
 495
 496 /**
 497  * Get an xattr value or list xattrs using the write-through cache.
 498  *
 499  * Get the xattr value (@valid has OBD_MD_FLXATTR set) of @name or
 500  * list xattr names (@valid has OBD_MD_FLXATTRLS set) for @inode.
 501  * The resulting value/list is stored in @buffer if the former
 502  * is not larger than @size.
 503  *
 504  * \retval 0        no error occured
 505  * \retval -EPROTO  network protocol error
 506  * \retval -ENOMEM  not enough memory for the cache
 507  * \retval -ERANGE  the buffer is not large enough
 508  * \retval -ENODATA no such attr or the list is empty
 509  */
 510 int ll_xattr_cache_get(struct inode *inode,
 511                         const char *name,
 512                         char *buffer,
 513                         size_t size,
 514                         __u64 valid)
 515 {
 516         struct lookup_intent oit = { .it_op = IT_GETXATTR };
 517         struct ll_inode_info *lli = ll_i2info(inode);
 518         int rc = 0;
 519
 520         ENTRY;
 521
 522         LASSERT(!!(valid & OBD_MD_FLXATTR) ^ !!(valid & OBD_MD_FLXATTRLS));
 523
 524         down_read(&lli->lli_xattrs_list_rwsem);
 525         if (!ll_xattr_cache_valid(lli)) {
 526                 up_read(&lli->lli_xattrs_list_rwsem);
 527                 rc = ll_xattr_cache_refill(inode, &oit);
 528                 if (rc)
 529                         RETURN(rc);
 530                 downgrade_write(&lli->lli_xattrs_list_rwsem);
 531         } else {
 532                 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_GETXATTR_HITS, 1);
 533         }
 534
 535         if (valid & OBD_MD_FLXATTR) {
 536                 struct ll_xattr_entry *xattr;
 537
 538                 rc = ll_xattr_cache_find(&lli->lli_xattrs, name, &xattr);
 539                 if (rc == 0) {
 540                         rc = xattr->xe_vallen;
 541                         /* zero size means we are only requested size in rc */
 542                         if (size != 0) {
 543                                 if (size >= xattr->xe_vallen)
 544                                         memcpy(buffer, xattr->xe_value,
 545                                                 xattr->xe_vallen);
 546                                 else
 547                                         rc = -ERANGE;
 548                         }
 549                 }
 550         } else if (valid & OBD_MD_FLXATTRLS) {
 551                 rc = ll_xattr_cache_list(&lli->lli_xattrs,
 552                                          size ? buffer : NULL, size);
 553         }
 554
 555         GOTO(out, rc);
 556 out:
 557         up_read(&lli->lli_xattrs_list_rwsem);
 558
 559         return rc;
 560 }
 561