Whamcloud - gitweb
c0bc3341a62036370f6d6557928bcecea7c0a62d
[fs/lustre-release.git] / 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 = { .ei_type = LDLM_IBITS,
318                                            .ei_mode = it_to_lock_mode(oit),
319                                            .ei_cb_bl = ll_md_blocking_ast,
320                                            .ei_cb_cp = ldlm_completion_ast };
321         struct ll_sb_info *sbi = ll_i2sbi(inode);
322         struct obd_export *exp = sbi->ll_md_exp;
323         int rc;
324
325         ENTRY;
326
327         mutex_lock(&lli->lli_xattrs_enq_lock);
328         /* Try matching first. */
329         mode = ll_take_md_lock(inode, MDS_INODELOCK_XATTR, &lockh, 0, LCK_PR);
330         if (mode != 0) {
331                 /* fake oit in mdc_revalidate_lock() manner */
332                 oit->d.lustre.it_lock_handle = lockh.cookie;
333                 oit->d.lustre.it_lock_mode = mode;
334                 goto out;
335         }
336
337         /* Enqueue if the lock isn't cached locally. */
338         op_data = ll_prep_md_op_data(NULL, inode, NULL, NULL, 0, 0,
339                                      LUSTRE_OPC_ANY, NULL);
340         if (IS_ERR(op_data)) {
341                 mutex_unlock(&lli->lli_xattrs_enq_lock);
342                 RETURN(PTR_ERR(op_data));
343         }
344
345         op_data->op_valid = OBD_MD_FLXATTR | OBD_MD_FLXATTRLS;
346
347         rc = md_enqueue(exp, &einfo, oit, op_data, &lockh, NULL, 0, NULL, 0);
348         ll_finish_md_op_data(op_data);
349
350         if (rc < 0) {
351                 CDEBUG(D_CACHE, "md_intent_lock failed with %d for fid "DFID"\n",
352                        rc, PFID(ll_inode2fid(inode)));
353                 mutex_unlock(&lli->lli_xattrs_enq_lock);
354                 RETURN(rc);
355         }
356
357         *req = (struct ptlrpc_request *)oit->d.lustre.it_data;
358 out:
359         down_write(&lli->lli_xattrs_list_rwsem);
360         mutex_unlock(&lli->lli_xattrs_enq_lock);
361
362         RETURN(0);
363 }
364
365 /**
366  * Refill the xattr cache.
367  *
368  * Fetch and cache the whole of xattrs for @inode, acquiring
369  * a read or a write xattr lock depending on operation in @oit.
370  * Intent is dropped on exit unless the operation is setxattr.
371  *
372  * \retval 0       no error occured
373  * \retval -EPROTO network protocol error
374  * \retval -ENOMEM not enough memory for the cache
375  */
376 static int ll_xattr_cache_refill(struct inode *inode, struct lookup_intent *oit)
377 {
378         struct ll_sb_info *sbi = ll_i2sbi(inode);
379         struct ptlrpc_request *req = NULL;
380         const char *xdata, *xval, *xtail, *xvtail;
381         struct ll_inode_info *lli = ll_i2info(inode);
382         struct mdt_body *body;
383         __u32 *xsizes;
384         int rc = 0, i;
385
386         ENTRY;
387
388         rc = ll_xattr_find_get_lock(inode, oit, &req);
389         if (rc)
390                 GOTO(out_no_unlock, rc);
391
392         /* Do we have the data at this point? */
393         if (ll_xattr_cache_valid(lli)) {
394                 ll_stats_ops_tally(sbi, LPROC_LL_GETXATTR_HITS, 1);
395                 GOTO(out_maybe_drop, rc = 0);
396         }
397
398         /* Matched but no cache? Cancelled on error by a parallel refill. */
399         if (unlikely(req == NULL)) {
400                 CDEBUG(D_CACHE, "cancelled by a parallel getxattr\n");
401                 GOTO(out_maybe_drop, rc = -EIO);
402         }
403
404         if (oit->d.lustre.it_status < 0) {
405                 CDEBUG(D_CACHE, "getxattr intent returned %d for fid "DFID"\n",
406                        oit->d.lustre.it_status, PFID(ll_inode2fid(inode)));
407                 rc = oit->d.lustre.it_status;
408                 /* xattr data is so large that we don't want to cache it */
409                 if (rc == -ERANGE)
410                         rc = -EAGAIN;
411                 GOTO(out_destroy, rc);
412         }
413
414         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
415         if (body == NULL) {
416                 CERROR("no MDT BODY in the refill xattr reply\n");
417                 GOTO(out_destroy, rc = -EPROTO);
418         }
419         /* do not need swab xattr data */
420         xdata = req_capsule_server_sized_get(&req->rq_pill, &RMF_EADATA,
421                                                 body->eadatasize);
422         xval = req_capsule_server_sized_get(&req->rq_pill, &RMF_EAVALS,
423                                                 body->aclsize);
424         xsizes = req_capsule_server_sized_get(&req->rq_pill, &RMF_EAVALS_LENS,
425                                               body->max_mdsize * sizeof(__u32));
426         if (xdata == NULL || xval == NULL || xsizes == NULL) {
427                 CERROR("wrong setxattr reply\n");
428                 GOTO(out_destroy, rc = -EPROTO);
429         }
430
431         xtail = xdata + body->eadatasize;
432         xvtail = xval + body->aclsize;
433
434         CDEBUG(D_CACHE, "caching: xdata=%p xtail=%p\n", xdata, xtail);
435
436         ll_xattr_cache_init(lli);
437
438         for (i = 0; i < body->max_mdsize; i++) {
439                 CDEBUG(D_CACHE, "caching [%s]=%.*s\n", xdata, *xsizes, xval);
440                 /* Perform consistency checks: attr names and vals in pill */
441                 if (memchr(xdata, 0, xtail - xdata) == NULL) {
442                         CERROR("xattr protocol violation (names are broken)\n");
443                         rc = -EPROTO;
444                 } else if (xval + *xsizes > xvtail) {
445                         CERROR("xattr protocol violation (vals are broken)\n");
446                         rc = -EPROTO;
447                 } else if (OBD_FAIL_CHECK(OBD_FAIL_LLITE_XATTR_ENOMEM)) {
448                         rc = -ENOMEM;
449                 } else if (!strcmp(xdata, XATTR_NAME_ACL_ACCESS)) {
450                         /* Filter out ACL ACCESS since it's cached separately */
451                         CDEBUG(D_CACHE, "not caching %s\n",
452                                XATTR_NAME_ACL_ACCESS);
453                         rc = 0;
454                 } else {
455                         rc = ll_xattr_cache_add(&lli->lli_xattrs, xdata, xval,
456                                                 *xsizes);
457                 }
458                 if (rc < 0) {
459                         ll_xattr_cache_destroy_locked(lli);
460                         GOTO(out_destroy, rc);
461                 }
462                 xdata += strlen(xdata) + 1;
463                 xval  += *xsizes;
464                 xsizes++;
465         }
466
467         if (xdata != xtail || xval != xvtail)
468                 CERROR("a hole in xattr data\n");
469
470         ll_set_lock_data(sbi->ll_md_exp, inode, oit, NULL);
471
472         GOTO(out_maybe_drop, rc);
473 out_maybe_drop:
474
475         ll_intent_drop_lock(oit);
476
477         if (rc != 0)
478                 up_write(&lli->lli_xattrs_list_rwsem);
479 out_no_unlock:
480         ptlrpc_req_finished(req);
481
482         return rc;
483
484 out_destroy:
485         up_write(&lli->lli_xattrs_list_rwsem);
486
487         ldlm_lock_decref_and_cancel((struct lustre_handle *)
488                                         &oit->d.lustre.it_lock_handle,
489                                         oit->d.lustre.it_lock_mode);
490
491         goto out_no_unlock;
492 }
493
494 /**
495  * Get an xattr value or list xattrs using the write-through cache.
496  *
497  * Get the xattr value (@valid has OBD_MD_FLXATTR set) of @name or
498  * list xattr names (@valid has OBD_MD_FLXATTRLS set) for @inode.
499  * The resulting value/list is stored in @buffer if the former
500  * is not larger than @size.
501  *
502  * \retval 0        no error occured
503  * \retval -EPROTO  network protocol error
504  * \retval -ENOMEM  not enough memory for the cache
505  * \retval -ERANGE  the buffer is not large enough
506  * \retval -ENODATA no such attr or the list is empty
507  */
508 int ll_xattr_cache_get(struct inode *inode,
509                         const char *name,
510                         char *buffer,
511                         size_t size,
512                         __u64 valid)
513 {
514         struct lookup_intent oit = { .it_op = IT_GETXATTR };
515         struct ll_inode_info *lli = ll_i2info(inode);
516         int rc = 0;
517
518         ENTRY;
519
520         LASSERT(!!(valid & OBD_MD_FLXATTR) ^ !!(valid & OBD_MD_FLXATTRLS));
521
522         down_read(&lli->lli_xattrs_list_rwsem);
523         if (!ll_xattr_cache_valid(lli)) {
524                 up_read(&lli->lli_xattrs_list_rwsem);
525                 rc = ll_xattr_cache_refill(inode, &oit);
526                 if (rc)
527                         RETURN(rc);
528                 downgrade_write(&lli->lli_xattrs_list_rwsem);
529         } else {
530                 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_GETXATTR_HITS, 1);
531         }
532
533         if (valid & OBD_MD_FLXATTR) {
534                 struct ll_xattr_entry *xattr;
535
536                 rc = ll_xattr_cache_find(&lli->lli_xattrs, name, &xattr);
537                 if (rc == 0) {
538                         rc = xattr->xe_vallen;
539                         /* zero size means we are only requested size in rc */
540                         if (size != 0) {
541                                 if (size >= xattr->xe_vallen)
542                                         memcpy(buffer, xattr->xe_value,
543                                                 xattr->xe_vallen);
544                                 else
545                                         rc = -ERANGE;
546                         }
547                 }
548         } else if (valid & OBD_MD_FLXATTRLS) {
549                 rc = ll_xattr_cache_list(&lli->lli_xattrs,
550                                          size ? buffer : NULL, size);
551         }
552
553         GOTO(out, rc);
554 out:
555         up_read(&lli->lli_xattrs_list_rwsem);
556
557         return rc;
558 }
559