4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/mdt/mdt_xattr.c
38 * Lustre Metadata Target (mdt) extended attributes management.
40 * Author: Peter Braam <braam@clusterfs.com>
41 * Author: Andreas Dilger <adilger@clusterfs.com>
42 * Author: Phil Schwan <phil@clusterfs.com>
43 * Author: Huang Hua <huanghua@clusterfs.com>
46 #define DEBUG_SUBSYSTEM S_MDS
48 #include <linux/xattr.h>
49 #include <obd_class.h>
50 #include <lustre_nodemap.h>
51 #include <lustre_acl.h>
52 #include "mdt_internal.h"
55 /* return EADATA length to the caller. negative value means error */
56 static int mdt_getxattr_pack_reply(struct mdt_thread_info * info)
58 struct req_capsule *pill = info->mti_pill ;
59 struct ptlrpc_request *req = mdt_info_req(info);
62 static const char user_string[] = "user.";
66 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_GETXATTR_PACK))
69 valid = info->mti_body->mbo_valid & (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS);
71 /* Determine how many bytes we need */
72 if (valid == OBD_MD_FLXATTR) {
73 xattr_name = req_capsule_client_get(pill, &RMF_NAME);
77 if (!(exp_connect_flags(req->rq_export) & OBD_CONNECT_XATTR) &&
78 !strncmp(xattr_name, user_string, sizeof(user_string) - 1))
81 size = mo_xattr_get(info->mti_env,
82 mdt_object_child(info->mti_object),
83 &LU_BUF_NULL, xattr_name);
84 } else if (valid == OBD_MD_FLXATTRLS) {
85 size = mo_xattr_list(info->mti_env,
86 mdt_object_child(info->mti_object),
88 } else if (valid == OBD_MD_FLXATTRALL) {
89 /* N.B. eadatasize = 0 is not valid for FLXATTRALL */
90 /* We could calculate accurate sizes, but this would
91 * introduce a lot of overhead, let's do it later... */
92 size = info->mti_body->mbo_eadatasize;
93 req_capsule_set_size(pill, &RMF_EAVALS, RCL_SERVER, size);
94 req_capsule_set_size(pill, &RMF_EAVALS_LENS, RCL_SERVER, size);
96 CDEBUG(D_INFO, "Valid bits: "LPX64"\n",
97 info->mti_body->mbo_valid);
101 if (size == -ENODATA) {
103 } else if (size < 0) {
104 if (size != -EOPNOTSUPP)
105 CERROR("Error geting EA size: %d\n", size);
109 req_capsule_set_size(pill, &RMF_EADATA, RCL_SERVER,
110 info->mti_body->mbo_eadatasize == 0 ? 0 : size);
111 rc = req_capsule_server_pack(pill);
121 mdt_getxattr_one(struct mdt_thread_info *info,
122 char *xattr_name, struct md_object *next,
123 struct lu_buf *buf, struct mdt_export_data *med,
126 __u32 remote = exp_connect_rmtclient(info->mti_exp);
127 int flags = CFS_IC_NOTHING, rc;
131 CDEBUG(D_INODE, "getxattr %s\n", xattr_name);
133 rc = mo_xattr_get(info->mti_env, next, buf, xattr_name);
137 if (info->mti_body->mbo_valid &
138 (OBD_MD_FLRMTLSETFACL | OBD_MD_FLRMTLGETFACL))
140 else if (info->mti_body->mbo_valid & OBD_MD_FLRMTRGETFACL)
141 flags = CFS_IC_MAPPED;
143 if (rc > 0 && flags != CFS_IC_NOTHING) {
146 if (unlikely(!remote))
147 GOTO(out, rc = -EINVAL);
149 rc1 = lustre_posix_acl_xattr_id2client(uc,
151 (posix_acl_xattr_header *)(buf->lb_buf),
153 if (unlikely(rc1 < 0))
161 static int mdt_getxattr_all(struct mdt_thread_info *info,
162 struct mdt_body *reqbody, struct mdt_body *repbody,
163 struct lu_buf *buf, struct md_object *next)
165 const struct lu_env *env = info->mti_env;
166 struct ptlrpc_request *req = mdt_info_req(info);
167 struct mdt_export_data *med = mdt_req2med(req);
168 struct lu_ucred *uc = mdt_ucred(info);
169 char *v, *b, *eadatahead, *eadatatail;
171 int eadatasize, eavallen = 0, eavallens = 0, rc;
176 * The format of the pill is the following:
177 * EADATA: attr1\0attr2\0...attrn\0
178 * EAVALS: val1val2...valn
179 * EAVALS_LENS: 4,4,...4
182 eadatahead = buf->lb_buf;
184 /* Fill out EADATA first */
185 rc = mo_xattr_list(env, next, buf);
187 GOTO(out_shrink, rc);
190 eadatatail = eadatahead + eadatasize;
192 v = req_capsule_server_get(info->mti_pill, &RMF_EAVALS);
193 sizes = req_capsule_server_get(info->mti_pill, &RMF_EAVALS_LENS);
195 /* Fill out EAVALS and EAVALS_LENS */
196 for (b = eadatahead; b < eadatatail; b += strlen(b) + 1, v += rc) {
198 buf->lb_len = reqbody->mbo_eadatasize - eavallen;
199 rc = mdt_getxattr_one(info, b, next, buf, med, uc);
201 GOTO(out_shrink, rc);
203 sizes[eavallens] = rc;
214 repbody->mbo_aclsize = eavallen;
215 repbody->mbo_max_mdsize = eavallens;
217 req_capsule_shrink(info->mti_pill, &RMF_EAVALS, eavallen, RCL_SERVER);
218 req_capsule_shrink(info->mti_pill, &RMF_EAVALS_LENS,
219 eavallens * sizeof(__u32), RCL_SERVER);
220 req_capsule_shrink(info->mti_pill, &RMF_EADATA, eadatasize, RCL_SERVER);
227 int mdt_getxattr(struct mdt_thread_info *info)
229 struct ptlrpc_request *req = mdt_info_req(info);
230 struct mdt_export_data *med = mdt_req2med(req);
231 struct lu_ucred *uc = lu_ucred(info->mti_env);
232 struct mdt_body *reqbody;
233 struct mdt_body *repbody = NULL;
234 struct md_object *next;
236 __u32 remote = exp_connect_rmtclient(info->mti_exp);
242 LASSERT(info->mti_object != NULL);
243 LASSERT(lu_object_assert_exists(&info->mti_object->mot_obj));
245 CDEBUG(D_INODE, "getxattr "DFID"\n", PFID(&info->mti_body->mbo_fid1));
247 reqbody = req_capsule_client_get(info->mti_pill, &RMF_MDT_BODY);
249 RETURN(err_serious(-EFAULT));
251 rc = mdt_init_ucred(info, reqbody);
253 RETURN(err_serious(rc));
255 next = mdt_object_child(info->mti_object);
257 if (info->mti_body->mbo_valid & OBD_MD_FLRMTRGETFACL) {
258 if (unlikely(!remote))
259 GOTO(out, rc = err_serious(-EINVAL));
261 perm = mdt_identity_get_perm(uc->uc_identity, remote,
263 if (!(perm & CFS_RMTACL_PERM))
264 GOTO(out, rc = err_serious(-EPERM));
266 rc = mo_permission(info->mti_env, NULL, next, NULL,
269 GOTO(out, rc = err_serious(rc));
272 easize = mdt_getxattr_pack_reply(info);
274 GOTO(out, rc = err_serious(easize));
276 repbody = req_capsule_server_get(info->mti_pill, &RMF_MDT_BODY);
277 LASSERT(repbody != NULL);
279 /* No need further getxattr. */
280 if (easize == 0 || reqbody->mbo_eadatasize == 0)
281 GOTO(out, rc = easize);
283 buf = &info->mti_buf;
284 buf->lb_buf = req_capsule_server_get(info->mti_pill, &RMF_EADATA);
285 buf->lb_len = easize;
287 valid = info->mti_body->mbo_valid & (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS);
289 if (valid == OBD_MD_FLXATTR) {
290 char *xattr_name = req_capsule_client_get(info->mti_pill,
292 rc = mdt_getxattr_one(info, xattr_name, next, buf, med, uc);
293 } else if (valid == OBD_MD_FLXATTRLS) {
294 CDEBUG(D_INODE, "listxattr\n");
296 rc = mo_xattr_list(info->mti_env, next, buf);
298 CDEBUG(D_INFO, "listxattr failed: %d\n", rc);
299 } else if (valid == OBD_MD_FLXATTRALL) {
300 rc = mdt_getxattr_all(info, reqbody, repbody,
308 mdt_counter_incr(req, LPROC_MDT_GETXATTR);
309 repbody->mbo_eadatasize = rc;
312 mdt_exit_ucred(info);
316 static int mdt_rmtlsetfacl(struct mdt_thread_info *info,
317 struct md_object *next,
318 const char *xattr_name,
319 ext_acl_xattr_header *header,
320 posix_acl_xattr_header **out)
322 struct ptlrpc_request *req = mdt_info_req(info);
323 struct mdt_export_data *med = mdt_req2med(req);
324 struct lu_ucred *uc = mdt_ucred(info);
325 struct lu_buf *buf = &info->mti_buf;
329 rc = lustre_ext_acl_xattr_id2server(uc, med->med_idmap, header);
333 rc = mo_xattr_get(info->mti_env, next, &LU_BUF_NULL, xattr_name);
340 if (buf->lb_len > 0) {
341 OBD_ALLOC_LARGE(buf->lb_buf, buf->lb_len);
342 if (unlikely(buf->lb_buf == NULL))
345 rc = mo_xattr_get(info->mti_env, next, buf, xattr_name);
347 CERROR("getxattr failed: %d\n", rc);
353 rc = lustre_acl_xattr_merge2posix((posix_acl_xattr_header *)(buf->lb_buf),
354 buf->lb_len, header, out);
358 if (rc <= 0 && buf->lb_buf != NULL)
359 OBD_FREE_LARGE(buf->lb_buf, buf->lb_len);
363 int mdt_reint_setxattr(struct mdt_thread_info *info,
364 struct mdt_lock_handle *unused)
366 struct ptlrpc_request *req = mdt_info_req(info);
367 struct lu_ucred *uc = lu_ucred(info->mti_env);
368 struct mdt_lock_handle *lh;
369 const struct lu_env *env = info->mti_env;
370 struct lu_buf *buf = &info->mti_buf;
371 struct mdt_reint_record *rr = &info->mti_rr;
372 struct md_attr *ma = &info->mti_attr;
373 struct lu_attr *attr = &info->mti_attr.ma_attr;
374 struct mdt_object *obj;
375 struct md_object *child;
376 struct obd_export *exp = info->mti_exp;
377 __u64 valid = attr->la_valid;
378 const char *xattr_name = rr->rr_name.ln_name;
379 int xattr_len = rr->rr_eadatalen;
382 posix_acl_xattr_header *new_xattr = NULL;
383 __u32 remote = exp_connect_rmtclient(info->mti_exp);
387 CDEBUG(D_INODE, "setxattr for "DFID": %s %s\n", PFID(rr->rr_fid1),
388 valid & OBD_MD_FLXATTR ? "set" : "remove", xattr_name);
390 if (info->mti_dlm_req)
391 ldlm_request_cancel(req, info->mti_dlm_req, 0, LATF_SKIP);
393 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_SETXATTR))
394 RETURN(err_serious(-ENOMEM));
396 rc = mdt_init_ucred_reint(info);
400 if (valid & OBD_MD_FLRMTRSETFACL) {
401 if (unlikely(!remote))
402 GOTO(out, rc = err_serious(-EINVAL));
404 perm = mdt_identity_get_perm(uc->uc_identity, remote,
406 if (!(perm & CFS_RMTACL_PERM))
407 GOTO(out, rc = err_serious(-EPERM));
410 if (strncmp(xattr_name, XATTR_USER_PREFIX,
411 sizeof(XATTR_USER_PREFIX) - 1) == 0) {
412 if (!(exp_connect_flags(req->rq_export) & OBD_CONNECT_XATTR))
413 GOTO(out, rc = -EOPNOTSUPP);
414 } else if (strncmp(xattr_name, XATTR_TRUSTED_PREFIX,
415 sizeof(XATTR_TRUSTED_PREFIX) - 1) == 0) {
417 if (!md_capable(mdt_ucred(info), CFS_CAP_SYS_ADMIN))
418 GOTO(out, rc = -EPERM);
420 if (strcmp(xattr_name, XATTR_NAME_LOV) == 0 ||
421 strcmp(xattr_name, XATTR_NAME_LMA) == 0 ||
422 strcmp(xattr_name, XATTR_NAME_LMV) == 0 ||
423 strcmp(xattr_name, XATTR_NAME_LINK) == 0 ||
424 strcmp(xattr_name, XATTR_NAME_FID) == 0 ||
425 strcmp(xattr_name, XATTR_NAME_VERSION) == 0 ||
426 strcmp(xattr_name, XATTR_NAME_SOM) == 0 ||
427 strcmp(xattr_name, XATTR_NAME_HSM) == 0 ||
428 strcmp(xattr_name, XATTR_NAME_LFSCK_NAMESPACE) == 0)
430 } else if ((valid & OBD_MD_FLXATTR) &&
431 (strcmp(xattr_name, XATTR_NAME_ACL_ACCESS) == 0 ||
432 strcmp(xattr_name, XATTR_NAME_ACL_DEFAULT) == 0)) {
433 struct lu_nodemap *nodemap;
435 /* currently lustre limit acl access size */
436 if (xattr_len > LUSTRE_POSIX_ACL_MAX_SIZE)
437 GOTO(out, rc = -ERANGE);
439 nodemap = nodemap_get_from_exp(exp);
441 GOTO(out, rc = PTR_ERR(nodemap));
443 rc = nodemap_map_acl(nodemap, rr->rr_eadata, xattr_len,
444 NODEMAP_CLIENT_TO_FS);
445 nodemap_putref(nodemap);
449 /* ACLs were mapped out, return an error so the user knows */
451 GOTO(out, rc = -EPERM);
454 lockpart = MDS_INODELOCK_UPDATE;
455 /* Revoke all clients' lookup lock, since the access
456 * permissions for this inode is changed when ACL_ACCESS is
457 * set. This isn't needed for ACL_DEFAULT, since that does
458 * not change the access permissions of this inode, nor any
459 * other existing inodes. It is setting the ACLs inherited
460 * by new directories/files at create time. */
461 /* We need revoke both LOOKUP|PERM lock here, see mdt_attr_set. */
462 if (!strcmp(xattr_name, XATTR_NAME_ACL_ACCESS))
463 lockpart |= MDS_INODELOCK_PERM | MDS_INODELOCK_LOOKUP;
464 /* We need to take the lock on behalf of old clients so that newer
465 * clients flush their xattr caches */
467 lockpart |= MDS_INODELOCK_XATTR;
469 lh = &info->mti_lh[MDT_LH_PARENT];
470 /* ACLs were sent to clients under LCK_CR locks, so taking LCK_EX
472 mdt_lock_reg_init(lh, LCK_EX);
473 obj = mdt_object_find_lock(info, rr->rr_fid1, lh, lockpart);
475 GOTO(out, rc = PTR_ERR(obj));
477 tgt_vbr_obj_set(env, mdt_obj2dt(obj));
478 rc = mdt_version_get_check_save(info, obj, 0);
480 GOTO(out_unlock, rc);
482 if (unlikely(!(valid & OBD_MD_FLCTIME))) {
483 /* This isn't strictly an error, but all current clients
484 * should set OBD_MD_FLCTIME when setting attributes. */
485 CWARN("%s: client miss to set OBD_MD_FLCTIME when "
486 "setxattr %s: [object "DFID"] [valid "LPU64"]\n",
487 mdt_obd_name(info->mti_mdt), xattr_name,
488 PFID(rr->rr_fid1), valid);
489 attr->la_ctime = cfs_time_current_sec();
491 attr->la_valid = LA_CTIME;
492 child = mdt_object_child(obj);
493 if (valid & OBD_MD_FLXATTR) {
494 void *xattr = rr->rr_eadata;
497 if (valid & OBD_MD_FLRMTLSETFACL) {
498 if (unlikely(!remote))
499 GOTO(out_unlock, rc = -EINVAL);
501 xattr_len = mdt_rmtlsetfacl(info, child, xattr_name,
504 GOTO(out_unlock, rc = xattr_len);
509 if (attr->la_flags & XATTR_REPLACE)
510 flags |= LU_XATTR_REPLACE;
512 if (attr->la_flags & XATTR_CREATE)
513 flags |= LU_XATTR_CREATE;
515 mdt_fail_write(env, info->mti_mdt->mdt_bottom,
516 OBD_FAIL_MDS_SETXATTR_WRITE);
519 buf->lb_len = xattr_len;
520 rc = mo_xattr_set(env, child, buf, xattr_name, flags);
521 /* update ctime after xattr changed */
523 ma->ma_attr_flags |= MDS_PERM_BYPASS;
524 mo_attr_set(env, child, ma);
526 } else if (valid & OBD_MD_FLXATTRRM) {
527 rc = mo_xattr_del(env, child, xattr_name);
528 /* update ctime after xattr changed */
530 ma->ma_attr_flags |= MDS_PERM_BYPASS;
531 mo_attr_set(env, child, ma);
534 CDEBUG(D_INFO, "valid bits: "LPX64"\n", valid);
538 mdt_counter_incr(req, LPROC_MDT_SETXATTR);
542 mdt_object_unlock_put(info, obj, lh, rc);
543 if (unlikely(new_xattr != NULL))
544 lustre_posix_acl_xattr_free(new_xattr, xattr_len);
546 mdt_exit_ucred(info);