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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
34 #include <linux/sched.h>
36 #include <linux/xattr.h>
37 #include <linux/selinux.h>
39 #define DEBUG_SUBSYSTEM S_LLITE
41 #include <obd_support.h>
42 #include <lustre_dlm.h>
43 #include <lustre_eacl.h>
45 #include "llite_internal.h"
47 #ifndef HAVE_XATTR_HANDLER_NAME
48 static inline const char *xattr_prefix(const struct xattr_handler *handler)
50 return handler->prefix;
54 const struct xattr_handler *get_xattr_type(const char *name)
58 for (i = 0; ll_xattr_handlers[i]; i++) {
59 const char *prefix = xattr_prefix(ll_xattr_handlers[i]);
60 size_t prefix_len = strlen(prefix);
62 if (!strncmp(prefix, name, prefix_len))
63 return ll_xattr_handlers[i];
69 static int xattr_type_filter(struct ll_sb_info *sbi,
70 const struct xattr_handler *handler)
72 /* No handler means XATTR_OTHER_T */
76 if ((handler->flags == XATTR_ACL_ACCESS_T ||
77 handler->flags == XATTR_ACL_DEFAULT_T) &&
78 !(sbi->ll_flags & LL_SBI_ACL))
81 if (handler->flags == XATTR_USER_T &&
82 !(sbi->ll_flags & LL_SBI_USER_XATTR))
85 if (handler->flags == XATTR_TRUSTED_T &&
86 !capable(CFS_CAP_SYS_ADMIN))
92 static int ll_xattr_set_common(const struct xattr_handler *handler,
93 struct dentry *dentry, struct inode *inode,
94 const char *name, const void *value, size_t size,
97 struct ll_sb_info *sbi = ll_i2sbi(inode);
98 struct ptlrpc_request *req = NULL;
99 const char *pv = value;
105 /* When setxattr() is called with a size of 0 the value is
106 * unconditionally replaced by "". When removexattr() is
107 * called we get a NULL value and XATTR_REPLACE for flags. */
108 if (!value && flags == XATTR_REPLACE) {
109 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_REMOVEXATTR, 1);
110 valid = OBD_MD_FLXATTRRM;
112 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_SETXATTR, 1);
113 valid = OBD_MD_FLXATTR;
116 /* FIXME: enable IMA when the conditions are ready */
117 if (handler->flags == XATTR_SECURITY_T &&
118 (!strcmp(name, "ima") || !strcmp(name, "evm")))
121 rc = xattr_type_filter(sbi, handler);
125 if ((handler->flags == XATTR_ACL_ACCESS_T ||
126 handler->flags == XATTR_ACL_DEFAULT_T) &&
127 #ifdef HAVE_INODE_OWNER_OR_CAPABLE
128 !inode_owner_or_capable(inode))
130 !is_owner_or_cap(inode))
134 /* b10667: ignore lustre special xattr for now */
135 if (!strcmp(name, "hsm") ||
136 ((handler->flags == XATTR_TRUSTED_T && !strcmp(name, "lov")) ||
137 (handler->flags == XATTR_LUSTRE_T && !strcmp(name, "lov"))))
140 /* LU-549: Disable security.selinux when selinux is disabled */
141 if (handler->flags == XATTR_SECURITY_T && !selinux_is_enabled() &&
142 strcmp(name, "selinux") == 0)
146 * In user.* namespace, only regular files and directories can have
147 * extended attributes.
149 if (handler->flags == XATTR_USER_T) {
150 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
154 fullname = kasprintf(GFP_KERNEL, "%s%s", xattr_prefix(handler), name);
158 rc = md_setxattr(sbi->ll_md_exp, ll_inode2fid(inode), valid, fullname,
159 pv, size, flags, ll_i2suppgid(inode), &req);
162 if (rc == -EOPNOTSUPP && handler->flags == XATTR_USER_T) {
163 LCONSOLE_INFO("Disabling user_xattr feature because it is not supported on the server\n");
164 sbi->ll_flags &= ~LL_SBI_USER_XATTR;
169 ptlrpc_req_finished(req);
173 static int get_hsm_state(struct inode *inode, u32 *hus_states)
175 struct md_op_data *op_data;
176 struct hsm_user_state *hus;
183 op_data = ll_prep_md_op_data(NULL, inode, NULL, NULL, 0, 0,
184 LUSTRE_OPC_ANY, hus);
185 if (!IS_ERR(op_data)) {
186 rc = obd_iocontrol(LL_IOC_HSM_STATE_GET, ll_i2mdexp(inode),
187 sizeof(*op_data), op_data, NULL);
189 *hus_states = hus->hus_states;
191 CDEBUG(D_VFSTRACE, "obd_iocontrol failed. rc = %d\n",
194 ll_finish_md_op_data(op_data);
196 rc = PTR_ERR(op_data);
197 CDEBUG(D_VFSTRACE, "Could not prepare the opdata. rc = %d\n",
204 static int ll_adjust_lum(struct inode *inode, struct lov_user_md *lump)
206 struct lov_comp_md_v1 *comp_v1 = (struct lov_comp_md_v1 *)lump;
207 struct lov_user_md *v1 = lump;
208 bool need_clear_release = false;
209 bool release_checked = false;
210 bool is_composite = false;
218 if (lump->lmm_magic == LOV_USER_MAGIC_COMP_V1) {
219 entry_count = comp_v1->lcm_entry_count;
223 for (i = 0; i < entry_count; i++) {
224 if (lump->lmm_magic == LOV_USER_MAGIC_COMP_V1) {
227 ptr += comp_v1->lcm_entries[i].lcme_offset;
228 v1 = (struct lov_user_md *)ptr;
232 * Attributes that are saved via getxattr will always
233 * have the stripe_offset as 0. Instead, the MDS
234 * should be allowed to pick the starting OST index.
237 if (!is_composite && v1->lmm_stripe_offset == 0)
238 v1->lmm_stripe_offset = -1;
240 /* Avoid anyone directly setting the RELEASED flag. */
241 if (v1->lmm_pattern & LOV_PATTERN_F_RELEASED) {
242 if (!release_checked) {
245 rc = get_hsm_state(inode, &state);
249 if (!(state & HS_ARCHIVED))
250 need_clear_release = true;
251 release_checked = true;
253 if (need_clear_release)
254 v1->lmm_pattern ^= LOV_PATTERN_F_RELEASED;
261 static int ll_setstripe_ea(struct dentry *dentry, struct lov_user_md *lump,
264 struct inode *inode = dentry->d_inode;
268 * It is possible to set an xattr to a "" value of zero size.
269 * For this case we are going to treat it as a removal.
274 rc = ll_adjust_lum(inode, lump);
278 if (lump && S_ISREG(inode->i_mode)) {
279 u64 it_flags = FMODE_WRITE;
282 lum_size = ll_lov_user_md_size(lump);
283 if (lum_size < 0 || size < lum_size)
286 rc = ll_lov_setstripe_ea_info(inode, dentry, it_flags, lump,
289 * b=10667: ignore -EEXIST.
290 * Silently eat error on setting trusted.lov/lustre.lov
291 * attribute for platforms that added the default option
292 * to copy all attributes in 'cp' command. Both rsync and
293 * tar --xattrs also will try to set LOVEA for existing
298 } else if (S_ISDIR(inode->i_mode)) {
299 if (size != 0 && size < sizeof(struct lov_user_md))
302 rc = ll_dir_setstripe(inode, lump, 0);
308 static int ll_xattr_set(const struct xattr_handler *handler,
309 struct dentry *dentry, struct inode *inode,
310 const char *name, const void *value, size_t size,
316 CDEBUG(D_VFSTRACE, "VFS Op:inode=" DFID "(%p), xattr %s\n",
317 PFID(ll_inode2fid(inode)), inode, name);
319 /* lustre/trusted.lov.xxx would be passed through xattr API */
320 if (!strcmp(name, "lov")) {
321 int op_type = flags == XATTR_REPLACE ? LPROC_LL_REMOVEXATTR :
324 ll_stats_ops_tally(ll_i2sbi(inode), op_type, 1);
326 return ll_setstripe_ea(dentry, (struct lov_user_md *)value,
328 } else if (!strcmp(name, "lma") || !strcmp(name, "link")) {
329 int op_type = flags == XATTR_REPLACE ? LPROC_LL_REMOVEXATTR :
332 ll_stats_ops_tally(ll_i2sbi(inode), op_type, 1);
336 return ll_xattr_set_common(handler, dentry, inode, name, value, size,
340 int ll_xattr_list(struct inode *inode, const char *name, int type, void *buffer,
341 size_t size, u64 valid)
343 struct ll_inode_info *lli = ll_i2info(inode);
344 struct ll_sb_info *sbi = ll_i2sbi(inode);
345 struct ptlrpc_request *req = NULL;
346 struct mdt_body *body;
351 if (sbi->ll_xattr_cache_enabled && type != XATTR_ACL_ACCESS_T &&
352 (type != XATTR_SECURITY_T || strcmp(name, "security.selinux"))) {
353 rc = ll_xattr_cache_get(inode, name, buffer, size, valid);
355 goto getxattr_nocache;
359 /* Add "system.posix_acl_access" to the list */
360 if (lli->lli_posix_acl && valid & OBD_MD_FLXATTRLS) {
362 rc += sizeof(XATTR_NAME_ACL_ACCESS);
363 } else if (size - rc >= sizeof(XATTR_NAME_ACL_ACCESS)) {
364 memcpy(buffer + rc, XATTR_NAME_ACL_ACCESS,
365 sizeof(XATTR_NAME_ACL_ACCESS));
366 rc += sizeof(XATTR_NAME_ACL_ACCESS);
368 GOTO(out_xattr, rc = -ERANGE);
373 rc = md_getxattr(sbi->ll_md_exp, ll_inode2fid(inode), valid,
378 body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
381 /* only detect the xattr size */
383 GOTO(out, rc = body->mbo_eadatasize);
385 if (size < body->mbo_eadatasize) {
386 CERROR("server bug: replied size %u > %u\n",
387 body->mbo_eadatasize, (int)size);
388 GOTO(out, rc = -ERANGE);
391 if (body->mbo_eadatasize == 0)
392 GOTO(out, rc = -ENODATA);
394 /* do not need swab xattr data */
395 xdata = req_capsule_server_sized_get(&req->rq_pill, &RMF_EADATA,
396 body->mbo_eadatasize);
398 GOTO(out, rc = -EFAULT);
400 memcpy(buffer, xdata, body->mbo_eadatasize);
401 rc = body->mbo_eadatasize;
407 if (rc == -EOPNOTSUPP && type == XATTR_USER_T) {
408 LCONSOLE_INFO("%s: disabling user_xattr feature because "
409 "it is not supported on the server: rc = %d\n",
410 ll_get_fsname(inode->i_sb, NULL, 0), rc);
411 sbi->ll_flags &= ~LL_SBI_USER_XATTR;
414 ptlrpc_req_finished(req);
418 static int ll_xattr_get_common(const struct xattr_handler *handler,
419 struct dentry *dentry,
421 const char *name, void *buffer, size_t size)
423 struct ll_sb_info *sbi = ll_i2sbi(inode);
429 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_GETXATTR, 1);
431 rc = xattr_type_filter(sbi, handler);
435 /* LU-549: Disable security.selinux when selinux is disabled */
436 if (handler->flags == XATTR_SECURITY_T && !selinux_is_enabled() &&
437 !strcmp(name, "selinux"))
440 #ifdef CONFIG_FS_POSIX_ACL
441 /* posix acl is under protection of LOOKUP lock. when calling to this,
442 * we just have path resolution to the target inode, so we have great
443 * chance that cached ACL is uptodate.
445 if (handler->flags == XATTR_ACL_ACCESS_T) {
446 struct ll_inode_info *lli = ll_i2info(inode);
447 struct posix_acl *acl;
449 spin_lock(&lli->lli_lock);
450 acl = posix_acl_dup(lli->lli_posix_acl);
451 spin_unlock(&lli->lli_lock);
456 rc = posix_acl_to_xattr(&init_user_ns, acl, buffer, size);
457 posix_acl_release(acl);
460 if (handler->flags == XATTR_ACL_DEFAULT_T && !S_ISDIR(inode->i_mode))
464 fullname = kasprintf(GFP_KERNEL, "%s%s", xattr_prefix(handler), name);
468 rc = ll_xattr_list(inode, fullname, handler->flags, buffer, size,
474 static ssize_t ll_getxattr_lov(struct inode *inode, void *buf, size_t buf_size)
478 if (S_ISREG(inode->i_mode)) {
479 struct cl_object *obj = ll_i2info(inode)->lli_clob;
480 struct cl_layout cl = {
481 .cl_buf.lb_buf = buf,
482 .cl_buf.lb_len = buf_size,
490 env = cl_env_get(&refcheck);
492 RETURN(PTR_ERR(env));
494 rc = cl_object_layout_get(env, obj, &cl);
499 GOTO(out_env, rc = -ENODATA);
506 LASSERT(buf && rc <= buf_size);
509 * Do not return layout gen for getxattr() since
510 * otherwise it would confuse tar --xattr by
511 * recognizing layout gen as stripe offset when the
512 * file is restored. See LU-2809.
514 if (((struct lov_mds_md *)buf)->lmm_magic == LOV_MAGIC_COMP_V1)
517 ((struct lov_mds_md *)buf)->lmm_layout_gen = 0;
519 cl_env_put(env, &refcheck);
522 } else if (S_ISDIR(inode->i_mode)) {
523 struct ptlrpc_request *req = NULL;
524 struct lov_mds_md *lmm = NULL;
527 rc = ll_dir_getstripe(inode, (void **)&lmm, &lmm_size,
533 GOTO(out_req, rc = lmm_size);
535 if (buf_size < lmm_size)
536 GOTO(out_req, rc = -ERANGE);
538 memcpy(buf, lmm, lmm_size);
539 GOTO(out_req, rc = lmm_size);
542 ptlrpc_req_finished(req);
550 static int ll_xattr_get(const struct xattr_handler *handler,
551 struct dentry *dentry, struct inode *inode,
552 const char *name, void *buffer, size_t size)
557 CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p), xattr %s\n",
558 PFID(ll_inode2fid(inode)), inode, name);
560 if (!strcmp(name, "lov")) {
561 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_GETXATTR, 1);
563 return ll_getxattr_lov(inode, buffer, size);
566 return ll_xattr_get_common(handler, dentry, inode, name, buffer, size);
569 ssize_t ll_listxattr(struct dentry *dentry, char *buffer, size_t size)
571 struct inode *inode = dentry->d_inode;
572 struct ll_sb_info *sbi = ll_i2sbi(inode);
579 CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p)\n",
580 PFID(ll_inode2fid(inode)), inode);
582 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_LISTXATTR, 1);
584 rc = ll_xattr_list(inode, NULL, XATTR_OTHER_T, buffer, size,
590 * If we're being called to get the size of the xattr list
591 * (size == 0) then just assume that a lustre.lov xattr
595 RETURN(rc + sizeof(XATTR_LUSTRE_LOV));
601 len = strnlen(xattr_name, rem - 1) + 1;
603 if (!xattr_type_filter(sbi, get_xattr_type(xattr_name))) {
604 /* Skip OK xattr type, leave it in buffer. */
610 * Move up remaining xattrs in buffer
611 * removing the xattr that is not OK.
613 memmove(xattr_name, xattr_name + len, rem);
617 rc2 = ll_getxattr_lov(inode, NULL, 0);
624 if (size < rc + sizeof(XATTR_LUSTRE_LOV))
627 memcpy(buffer + rc, XATTR_LUSTRE_LOV, sizeof(XATTR_LUSTRE_LOV));
629 RETURN(rc + sizeof(XATTR_LUSTRE_LOV));
632 #ifdef HAVE_XATTR_HANDLER_SIMPLIFIED
633 static int ll_xattr_get_common_4_3(const struct xattr_handler *handler,
634 struct dentry *dentry, const char *name,
635 void *buffer, size_t size)
637 return ll_xattr_get_common(handler, dentry, dentry->d_inode, name,
641 static int ll_xattr_get_4_3(const struct xattr_handler *handler,
642 struct dentry *dentry, const char *name,
643 void *buffer, size_t size)
645 return ll_xattr_get(handler, dentry, dentry->d_inode, name, buffer,
649 static int ll_xattr_set_common_4_3(const struct xattr_handler *handler,
650 struct dentry *dentry, const char *name,
651 const void *value, size_t size, int flags)
653 return ll_xattr_set_common(handler, dentry, dentry->d_inode, name,
657 static int ll_xattr_set_4_3(const struct xattr_handler *handler,
658 struct dentry *dentry, const char *name,
659 const void *value, size_t size, int flags)
661 return ll_xattr_set(handler, dentry, dentry->d_inode, name, value,
665 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
666 const struct xattr_handler *get_xattr_handler(int handler_flag)
670 while (ll_xattr_handlers[i]) {
671 if (ll_xattr_handlers[i]->flags == handler_flag)
672 return ll_xattr_handlers[i];
678 static int ll_xattr_get_common_3_11(struct dentry *dentry, const char *name,
679 void *buffer, size_t size, int handler_flags)
681 const struct xattr_handler *handler = get_xattr_handler(handler_flags);
686 return ll_xattr_get_common(handler, dentry, dentry->d_inode, name,
690 static int ll_xattr_get_3_11(struct dentry *dentry, const char *name,
691 void *buffer, size_t size, int handler_flags)
693 const struct xattr_handler *handler = get_xattr_handler(handler_flags);
698 return ll_xattr_get(handler, dentry, dentry->d_inode, name, buffer,
702 static int ll_xattr_set_common_3_11(struct dentry *dentry, const char *name,
703 const void *value, size_t size, int flags,
706 const struct xattr_handler *handler = get_xattr_handler(handler_flags);
711 return ll_xattr_set_common(handler, dentry, dentry->d_inode, name,
715 static int ll_xattr_set_3_11(struct dentry *dentry, const char *name,
716 const void *value, size_t size, int flags,
719 const struct xattr_handler *handler = get_xattr_handler(handler_flags);
724 return ll_xattr_set(handler, dentry, dentry->d_inode, name, value,
729 static const struct xattr_handler ll_user_xattr_handler = {
730 .prefix = XATTR_USER_PREFIX,
731 .flags = XATTR_USER_T,
732 #if defined(HAVE_XATTR_HANDLER_SIMPLIFIED)
733 .get = ll_xattr_get_common_4_3,
734 .set = ll_xattr_set_common_4_3,
735 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
736 .get = ll_xattr_get_common_3_11,
737 .set = ll_xattr_set_common_3_11,
739 .get = ll_xattr_get_common,
740 .set = ll_xattr_set_common,
744 static const struct xattr_handler ll_trusted_xattr_handler = {
745 .prefix = XATTR_TRUSTED_PREFIX,
746 .flags = XATTR_TRUSTED_T,
747 #if defined(HAVE_XATTR_HANDLER_SIMPLIFIED)
748 .get = ll_xattr_get_4_3,
749 .set = ll_xattr_set_4_3,
750 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
751 .get = ll_xattr_get_3_11,
752 .set = ll_xattr_set_3_11,
759 static const struct xattr_handler ll_security_xattr_handler = {
760 .prefix = XATTR_SECURITY_PREFIX,
761 .flags = XATTR_SECURITY_T,
762 #if defined(HAVE_XATTR_HANDLER_SIMPLIFIED)
763 .get = ll_xattr_get_common_4_3,
764 .set = ll_xattr_set_common_4_3,
765 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
766 .get = ll_xattr_get_common_3_11,
767 .set = ll_xattr_set_common_3_11,
769 .get = ll_xattr_get_common,
770 .set = ll_xattr_set_common,
774 static const struct xattr_handler ll_acl_access_xattr_handler = {
775 #ifdef HAVE_XATTR_HANDLER_NAME
776 .name = XATTR_NAME_POSIX_ACL_ACCESS,
778 .prefix = XATTR_NAME_POSIX_ACL_ACCESS,
780 .flags = XATTR_ACL_ACCESS_T,
781 #if defined(HAVE_XATTR_HANDLER_SIMPLIFIED)
782 .get = ll_xattr_get_common_4_3,
783 .set = ll_xattr_set_common_4_3,
784 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
785 .get = ll_xattr_get_common_3_11,
786 .set = ll_xattr_set_common_3_11,
788 .get = ll_xattr_get_common,
789 .set = ll_xattr_set_common,
793 static const struct xattr_handler ll_acl_default_xattr_handler = {
794 #ifdef HAVE_XATTR_HANDLER_NAME
795 .name = XATTR_NAME_POSIX_ACL_DEFAULT,
797 .prefix = XATTR_NAME_POSIX_ACL_DEFAULT,
799 .flags = XATTR_ACL_DEFAULT_T,
800 #if defined(HAVE_XATTR_HANDLER_SIMPLIFIED)
801 .get = ll_xattr_get_common_4_3,
802 .set = ll_xattr_set_common_4_3,
803 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
804 .get = ll_xattr_get_common_3_11,
805 .set = ll_xattr_set_common_3_11,
807 .get = ll_xattr_get_common,
808 .set = ll_xattr_set_common,
812 static const struct xattr_handler ll_lustre_xattr_handler = {
813 .prefix = XATTR_LUSTRE_PREFIX,
814 .flags = XATTR_LUSTRE_T,
815 #if defined(HAVE_XATTR_HANDLER_SIMPLIFIED)
816 .get = ll_xattr_get_4_3,
817 .set = ll_xattr_set_4_3,
818 #elif !defined(HAVE_XATTR_HANDLER_INODE_PARAM)
819 .get = ll_xattr_get_3_11,
820 .set = ll_xattr_set_3_11,
827 const struct xattr_handler *ll_xattr_handlers[] = {
828 &ll_user_xattr_handler,
829 &ll_trusted_xattr_handler,
830 &ll_security_xattr_handler,
831 #ifdef CONFIG_FS_POSIX_ACL
832 &ll_acl_access_xattr_handler,
833 &ll_acl_default_xattr_handler,
835 &ll_lustre_xattr_handler,