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, 2013, 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 <lustre_acl.h>
49 #include "mdt_internal.h"
52 /* return EADATA length to the caller. negative value means error */
53 static int mdt_getxattr_pack_reply(struct mdt_thread_info * info)
55 struct req_capsule *pill = info->mti_pill ;
56 struct ptlrpc_request *req = mdt_info_req(info);
59 static const char user_string[] = "user.";
63 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_GETXATTR_PACK))
66 valid = info->mti_body->valid & (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS);
68 /* Determine how many bytes we need */
69 if (valid == OBD_MD_FLXATTR) {
70 xattr_name = req_capsule_client_get(pill, &RMF_NAME);
74 if (!(exp_connect_flags(req->rq_export) & OBD_CONNECT_XATTR) &&
75 !strncmp(xattr_name, user_string, sizeof(user_string) - 1))
78 size = mo_xattr_get(info->mti_env,
79 mdt_object_child(info->mti_object),
80 &LU_BUF_NULL, xattr_name);
81 } else if (valid == OBD_MD_FLXATTRLS) {
82 size = mo_xattr_list(info->mti_env,
83 mdt_object_child(info->mti_object),
85 } else if (valid == OBD_MD_FLXATTRALL) {
86 /* N.B. eadatasize = 0 is not valid for FLXATTRALL */
87 /* We could calculate accurate sizes, but this would
88 * introduce a lot of overhead, let's do it later... */
89 size = info->mti_body->eadatasize;
90 req_capsule_set_size(pill, &RMF_EAVALS, RCL_SERVER, size);
91 req_capsule_set_size(pill, &RMF_EAVALS_LENS, RCL_SERVER, size);
93 CDEBUG(D_INFO, "Valid bits: "LPX64"\n", info->mti_body->valid);
97 if (size == -ENODATA) {
99 } else if (size < 0) {
100 CERROR("Error geting EA size: %d\n", size);
104 req_capsule_set_size(pill, &RMF_EADATA, RCL_SERVER,
105 info->mti_body->eadatasize == 0 ? 0 : size);
106 rc = req_capsule_server_pack(pill);
116 mdt_getxattr_one(struct mdt_thread_info *info,
117 char *xattr_name, struct md_object *next,
118 struct lu_buf *buf, struct mdt_export_data *med,
121 __u32 remote = exp_connect_rmtclient(info->mti_exp);
122 int flags = CFS_IC_NOTHING, rc;
126 CDEBUG(D_INODE, "getxattr %s\n", xattr_name);
128 rc = mo_xattr_get(info->mti_env, next, buf, xattr_name);
130 CERROR("getxattr failed: %d\n", rc);
134 if (info->mti_body->valid &
135 (OBD_MD_FLRMTLSETFACL | OBD_MD_FLRMTLGETFACL))
137 else if (info->mti_body->valid & OBD_MD_FLRMTRGETFACL)
138 flags = CFS_IC_MAPPED;
140 if (rc > 0 && flags != CFS_IC_NOTHING) {
143 if (unlikely(!remote))
144 GOTO(out, rc = -EINVAL);
146 rc1 = lustre_posix_acl_xattr_id2client(uc,
148 (posix_acl_xattr_header *)(buf->lb_buf),
150 if (unlikely(rc1 < 0))
158 static int mdt_getxattr_all(struct mdt_thread_info *info,
159 struct mdt_body *reqbody, struct mdt_body *repbody,
160 struct lu_buf *buf, struct md_object *next)
162 const struct lu_env *env = info->mti_env;
163 struct ptlrpc_request *req = mdt_info_req(info);
164 struct mdt_export_data *med = mdt_req2med(req);
165 struct lu_ucred *uc = mdt_ucred(info);
166 char *v, *b, *eadatahead, *eadatatail;
168 int eadatasize, eavallen = 0, eavallens = 0, rc;
173 * The format of the pill is the following:
174 * EADATA: attr1\0attr2\0...attrn\0
175 * EAVALS: val1val2...valn
176 * EAVALS_LENS: 4,4,...4
179 eadatahead = buf->lb_buf;
181 /* Fill out EADATA first */
182 eadatasize = mo_xattr_list(env, next, buf);
184 GOTO(out, rc = eadatasize);
186 eadatatail = eadatahead + eadatasize;
188 v = req_capsule_server_get(info->mti_pill, &RMF_EAVALS);
189 sizes = req_capsule_server_get(info->mti_pill, &RMF_EAVALS_LENS);
191 /* Fill out EAVALS and EAVALS_LENS */
192 for (b = eadatahead; b < eadatatail; b += strlen(b) + 1, v += rc) {
194 buf->lb_len = reqbody->eadatasize - eavallen;
195 rc = mdt_getxattr_one(info, b, next, buf, med, uc);
199 sizes[eavallens] = rc;
204 repbody->aclsize = eavallen;
205 repbody->max_mdsize = eavallens;
207 req_capsule_shrink(info->mti_pill, &RMF_EAVALS, eavallen, RCL_SERVER);
208 req_capsule_shrink(info->mti_pill, &RMF_EAVALS_LENS,
209 eavallens * sizeof(__u32), RCL_SERVER);
210 req_capsule_shrink(info->mti_pill, &RMF_EADATA, eadatasize, RCL_SERVER);
212 GOTO(out, rc = eadatasize);
217 int mdt_getxattr(struct mdt_thread_info *info)
219 struct ptlrpc_request *req = mdt_info_req(info);
220 struct mdt_export_data *med = mdt_req2med(req);
221 struct lu_ucred *uc = lu_ucred(info->mti_env);
222 struct mdt_body *reqbody;
223 struct mdt_body *repbody = NULL;
224 struct md_object *next;
226 __u32 remote = exp_connect_rmtclient(info->mti_exp);
232 LASSERT(info->mti_object != NULL);
233 LASSERT(lu_object_assert_exists(&info->mti_object->mot_obj));
235 CDEBUG(D_INODE, "getxattr "DFID"\n", PFID(&info->mti_body->fid1));
237 reqbody = req_capsule_client_get(info->mti_pill, &RMF_MDT_BODY);
239 RETURN(err_serious(-EFAULT));
241 rc = mdt_init_ucred(info, reqbody);
243 RETURN(err_serious(rc));
245 next = mdt_object_child(info->mti_object);
247 if (info->mti_body->valid & OBD_MD_FLRMTRGETFACL) {
248 if (unlikely(!remote))
249 GOTO(out, rc = err_serious(-EINVAL));
251 perm = mdt_identity_get_perm(uc->uc_identity, remote,
253 if (!(perm & CFS_RMTACL_PERM))
254 GOTO(out, rc = err_serious(-EPERM));
256 rc = mo_permission(info->mti_env, NULL, next, NULL,
259 GOTO(out, rc = err_serious(rc));
262 easize = mdt_getxattr_pack_reply(info);
264 GOTO(out, rc = err_serious(easize));
266 repbody = req_capsule_server_get(info->mti_pill, &RMF_MDT_BODY);
267 LASSERT(repbody != NULL);
269 /* No need further getxattr. */
270 if (easize == 0 || reqbody->eadatasize == 0)
271 GOTO(out, rc = easize);
273 buf = &info->mti_buf;
274 buf->lb_buf = req_capsule_server_get(info->mti_pill, &RMF_EADATA);
275 buf->lb_len = easize;
277 valid = info->mti_body->valid & (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS);
279 if (valid == OBD_MD_FLXATTR) {
280 char *xattr_name = req_capsule_client_get(info->mti_pill,
282 rc = mdt_getxattr_one(info, xattr_name, next, buf, med, uc);
283 } else if (valid == OBD_MD_FLXATTRLS) {
284 CDEBUG(D_INODE, "listxattr\n");
286 rc = mo_xattr_list(info->mti_env, next, buf);
288 CDEBUG(D_INFO, "listxattr failed: %d\n", rc);
289 } else if (valid == OBD_MD_FLXATTRALL) {
290 rc = mdt_getxattr_all(info, reqbody, repbody,
298 mdt_counter_incr(req, LPROC_MDT_GETXATTR);
299 repbody->eadatasize = rc;
302 mdt_exit_ucred(info);
306 static int mdt_rmtlsetfacl(struct mdt_thread_info *info,
307 struct md_object *next,
308 const char *xattr_name,
309 ext_acl_xattr_header *header,
310 posix_acl_xattr_header **out)
312 struct ptlrpc_request *req = mdt_info_req(info);
313 struct mdt_export_data *med = mdt_req2med(req);
314 struct lu_ucred *uc = mdt_ucred(info);
315 struct lu_buf *buf = &info->mti_buf;
319 rc = lustre_ext_acl_xattr_id2server(uc, med->med_idmap, header);
323 rc = mo_xattr_get(info->mti_env, next, &LU_BUF_NULL, xattr_name);
330 if (buf->lb_len > 0) {
331 OBD_ALLOC_LARGE(buf->lb_buf, buf->lb_len);
332 if (unlikely(buf->lb_buf == NULL))
335 rc = mo_xattr_get(info->mti_env, next, buf, xattr_name);
337 CERROR("getxattr failed: %d\n", rc);
343 rc = lustre_acl_xattr_merge2posix((posix_acl_xattr_header *)(buf->lb_buf),
344 buf->lb_len, header, out);
348 if (rc <= 0 && buf->lb_buf != NULL)
349 OBD_FREE_LARGE(buf->lb_buf, buf->lb_len);
353 int mdt_reint_setxattr(struct mdt_thread_info *info,
354 struct mdt_lock_handle *unused)
356 struct ptlrpc_request *req = mdt_info_req(info);
357 struct lu_ucred *uc = lu_ucred(info->mti_env);
358 struct mdt_lock_handle *lh;
359 const struct lu_env *env = info->mti_env;
360 struct lu_buf *buf = &info->mti_buf;
361 struct mdt_reint_record *rr = &info->mti_rr;
362 struct md_attr *ma = &info->mti_attr;
363 struct lu_attr *attr = &info->mti_attr.ma_attr;
364 struct mdt_object *obj;
365 struct md_object *child;
366 __u64 valid = attr->la_valid;
367 const char *xattr_name = rr->rr_name.ln_name;
368 int xattr_len = rr->rr_eadatalen;
371 posix_acl_xattr_header *new_xattr = NULL;
372 __u32 remote = exp_connect_rmtclient(info->mti_exp);
376 CDEBUG(D_INODE, "setxattr for "DFID"\n", PFID(rr->rr_fid1));
378 if (info->mti_dlm_req)
379 ldlm_request_cancel(req, info->mti_dlm_req, 0);
381 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_SETXATTR))
382 RETURN(err_serious(-ENOMEM));
384 CDEBUG(D_INODE, "%s xattr %s\n",
385 valid & OBD_MD_FLXATTR ? "set" : "remove", xattr_name);
387 rc = mdt_init_ucred_reint(info);
391 if (valid & OBD_MD_FLRMTRSETFACL) {
392 if (unlikely(!remote))
393 GOTO(out, rc = err_serious(-EINVAL));
395 perm = mdt_identity_get_perm(uc->uc_identity, remote,
397 if (!(perm & CFS_RMTACL_PERM))
398 GOTO(out, rc = err_serious(-EPERM));
401 if (strncmp(xattr_name, XATTR_USER_PREFIX,
402 sizeof(XATTR_USER_PREFIX) - 1) == 0) {
403 if (!(exp_connect_flags(req->rq_export) & OBD_CONNECT_XATTR))
404 GOTO(out, rc = -EOPNOTSUPP);
405 } else if (strncmp(xattr_name, XATTR_TRUSTED_PREFIX,
406 sizeof(XATTR_TRUSTED_PREFIX) - 1) == 0) {
408 if (!md_capable(mdt_ucred(info), CFS_CAP_SYS_ADMIN))
409 GOTO(out, rc = -EPERM);
411 if (strcmp(xattr_name, XATTR_NAME_LOV) == 0 ||
412 strcmp(xattr_name, XATTR_NAME_LMA) == 0 ||
413 strcmp(xattr_name, XATTR_NAME_LMV) == 0 ||
414 strcmp(xattr_name, XATTR_NAME_LINK) == 0 ||
415 strcmp(xattr_name, XATTR_NAME_FID) == 0 ||
416 strcmp(xattr_name, XATTR_NAME_VERSION) == 0 ||
417 strcmp(xattr_name, XATTR_NAME_SOM) == 0 ||
418 strcmp(xattr_name, XATTR_NAME_HSM) == 0 ||
419 strcmp(xattr_name, XATTR_NAME_LFSCK_NAMESPACE) == 0)
421 } else if ((valid & OBD_MD_FLXATTR) &&
422 (strcmp(xattr_name, XATTR_NAME_ACL_ACCESS) == 0 ||
423 strcmp(xattr_name, XATTR_NAME_ACL_DEFAULT) == 0)) {
424 /* currently lustre limit acl access size */
425 if (xattr_len > LUSTRE_POSIX_ACL_MAX_SIZE)
426 GOTO(out, rc = -ERANGE);
429 lockpart = MDS_INODELOCK_UPDATE;
430 /* Revoke all clients' lookup lock, since the access
431 * permissions for this inode is changed when ACL_ACCESS is
432 * set. This isn't needed for ACL_DEFAULT, since that does
433 * not change the access permissions of this inode, nor any
434 * other existing inodes. It is setting the ACLs inherited
435 * by new directories/files at create time. */
436 /* We need revoke both LOOKUP|PERM lock here, see mdt_attr_set. */
437 if (!strcmp(xattr_name, XATTR_NAME_ACL_ACCESS))
438 lockpart |= MDS_INODELOCK_PERM | MDS_INODELOCK_LOOKUP;
439 /* We need to take the lock on behalf of old clients so that newer
440 * clients flush their xattr caches */
442 lockpart |= MDS_INODELOCK_XATTR;
444 lh = &info->mti_lh[MDT_LH_PARENT];
445 /* ACLs were sent to clients under LCK_CR locks, so taking LCK_EX
447 mdt_lock_reg_init(lh, LCK_EX);
448 obj = mdt_object_find_lock(info, rr->rr_fid1, lh, lockpart);
450 GOTO(out, rc = PTR_ERR(obj));
452 tgt_vbr_obj_set(env, mdt_obj2dt(obj));
453 rc = mdt_version_get_check_save(info, obj, 0);
455 GOTO(out_unlock, rc);
457 if (unlikely(!(valid & OBD_MD_FLCTIME))) {
458 /* This isn't strictly an error, but all current clients
459 * should set OBD_MD_FLCTIME when setting attributes. */
460 CWARN("%s: client miss to set OBD_MD_FLCTIME when "
461 "setxattr %s: [object "DFID"] [valid "LPU64"]\n",
462 mdt_obd_name(info->mti_mdt), xattr_name,
463 PFID(rr->rr_fid1), valid);
464 attr->la_ctime = cfs_time_current_sec();
466 attr->la_valid = LA_CTIME;
467 child = mdt_object_child(obj);
468 if (valid & OBD_MD_FLXATTR) {
469 char *xattr = (void *)rr->rr_eadata;
474 if (valid & OBD_MD_FLRMTLSETFACL) {
475 if (unlikely(!remote))
476 GOTO(out_unlock, rc = -EINVAL);
478 xattr_len = mdt_rmtlsetfacl(info, child,
480 (ext_acl_xattr_header *)xattr,
483 GOTO(out_unlock, rc = xattr_len);
485 xattr = (char *)new_xattr;
488 if (attr->la_flags & XATTR_REPLACE)
489 flags |= LU_XATTR_REPLACE;
491 if (attr->la_flags & XATTR_CREATE)
492 flags |= LU_XATTR_CREATE;
494 mdt_fail_write(env, info->mti_mdt->mdt_bottom,
495 OBD_FAIL_MDS_SETXATTR_WRITE);
498 buf->lb_len = xattr_len;
499 rc = mo_xattr_set(env, child, buf, xattr_name, flags);
500 /* update ctime after xattr changed */
502 ma->ma_attr_flags |= MDS_PERM_BYPASS;
503 mo_attr_set(env, child, ma);
506 } else if (valid & OBD_MD_FLXATTRRM) {
507 rc = mo_xattr_del(env, child, xattr_name);
508 /* update ctime after xattr changed */
510 ma->ma_attr_flags |= MDS_PERM_BYPASS;
511 mo_attr_set(env, child, ma);
514 CDEBUG(D_INFO, "valid bits: "LPX64"\n", valid);
518 mdt_counter_incr(req, LPROC_MDT_SETXATTR);
522 mdt_object_unlock_put(info, obj, lh, rc);
523 if (unlikely(new_xattr != NULL))
524 lustre_posix_acl_xattr_free(new_xattr, xattr_len);
526 mdt_exit_ucred(info);