Viewing: osd_xattr.c

// SPDX-License-Identifier: GPL-2.0

/*
 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2012, 2017, Intel Corporation.
 */

/*
 * This file is part of Lustre, http://www.lustre.org/
 *
 * Functions to manipulate extended attributes and system attributes
 *
 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
 * Author: Mike Pershin <tappro@whamcloud.com>
 */

#define DEBUG_SUBSYSTEM S_OSD

#include <obd_support.h>
#include <lustre_net.h>
#include <obd.h>
#include <obd_class.h>
#include <lustre_disk.h>
#include <lustre_fid.h>
#include <lustre_linkea.h>

#include "osd_internal.h"

#include <sys/dnode.h>
#include <sys/dbuf.h>
#include <sys/spa.h>
#include <sys/stat.h>
#include <sys/zap.h>
#include <sys/spa_impl.h>
#include <sys/zfs_znode.h>
#include <sys/dmu_tx.h>
#include <sys/dmu_objset.h>
#include <sys/dsl_prop.h>
#include <sys/sa_impl.h>
#include <sys/txg.h>

#include <linux/posix_acl_xattr.h>
#include <lustre_scrub.h>

int __osd_xattr_load(struct osd_device *osd, sa_handle_t *hdl, nvlist_t **sa)
{
	char *buf;
	int rc, size;

	rc = -sa_size(hdl, SA_ZPL_DXATTR(osd), &size);
	if (rc) {
		if (rc == -ENOENT)
			rc = -nvlist_alloc(sa, NV_UNIQUE_NAME, KM_SLEEP);
		goto out_sa;
	}

	buf = zio_buf_alloc(size);
	if (buf == NULL) {
		rc = -ENOMEM;
		goto out_sa;
	}
	rc = -sa_lookup(hdl, SA_ZPL_DXATTR(osd), buf, size);
	if (rc == 0)
		rc = -nvlist_unpack(buf, size, sa, KM_SLEEP);
	zio_buf_free(buf, size);
out_sa:

	return rc;
}

static inline int __osd_xattr_cache(struct osd_object *obj)
{
	LASSERT(obj->oo_sa_hdl);
	if (obj->oo_sa_xattr != NULL)
		return 0;
	return __osd_xattr_load(osd_obj2dev(obj),
				obj->oo_sa_hdl, &obj->oo_sa_xattr);
}

static int
__osd_sa_xattr_get(const struct lu_env *env, struct osd_object *obj,
		   const struct lu_buf *buf, const char *name, int *sizep)
{
	uchar_t *nv_value;
	int rc = 0;

	rc = __osd_xattr_cache(obj);
	if (rc)
		return rc;

	LASSERT(obj->oo_sa_xattr);
	rc = -nvlist_lookup_byte_array(obj->oo_sa_xattr, name,
				       &nv_value, sizep);
	if (rc)
		return rc;

	if (buf == NULL || buf->lb_buf == NULL) {
		/* return the required size by *sizep */
		return 0;
	}

	if (*sizep > buf->lb_len)
		return -ERANGE; /* match ldiskfs error */

	memcpy(buf->lb_buf, nv_value, *sizep);
	return 0;
}

int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
			  uint64_t xattr, struct lu_buf *buf,
			  const char *name, int *sizep)
{
	dnode_t *xa_data_dn;
	sa_handle_t *sa_hdl = NULL;
	uint64_t xa_data_obj, size;
	int rc;

	/* are there any extended attributes? */
	if (xattr == ZFS_NO_OBJECT)
		return -ENOENT;

	/* Lookup the object number containing the xattr data */
	rc = -zap_lookup(osd->od_os, xattr, name, sizeof(uint64_t), 1,
			&xa_data_obj);
	if (rc)
		return rc;

	rc = __osd_obj2dnode(osd->od_os, xa_data_obj, &xa_data_dn);
	if (rc)
		return rc;

	rc = -sa_handle_get(osd->od_os, xa_data_obj, NULL, SA_HDL_PRIVATE,
			&sa_hdl);
	if (rc)
		goto out_rele;

	/* Get the xattr value length / object size */
	rc = -sa_lookup(sa_hdl, SA_ZPL_SIZE(osd), &size, 8);
	if (rc)
		goto out;

	if (size > INT_MAX) {
		rc = -EOVERFLOW;
		goto out;
	}

	*sizep = (int)size;

	if (buf == NULL || buf->lb_buf == NULL) {
		/* We only need to return the required size */
		goto out;
	}
	if (*sizep > buf->lb_len) {
		rc = -ERANGE; /* match ldiskfs error */
		goto out;
	}

	rc = -dmu_read(osd->od_os, xa_data_dn->dn_object, 0,
			size, buf->lb_buf, DMU_READ_PREFETCH);

out:
	sa_handle_destroy(sa_hdl);
out_rele:
	osd_dnode_rele(xa_data_dn);

	return rc;
}

/**
 * Copy an extended attribute into the buffer provided, or compute
 * the required buffer size if \a buf is NULL.
 *
 * On success, the number of bytes used or required is stored in \a sizep.
 *
 * Note that no locking is done here.
 *
 * \param[in] env      execution environment
 * \param[in] obj      object for which to retrieve xattr
 * \param[out] buf     buffer to store xattr value in
 * \param[in] name     name of xattr to copy
 * \param[out] sizep   bytes used or required to store xattr
 *
 * \retval 0           on success
 * \retval negative    negated errno on failure
 */
int osd_xattr_get_internal(const struct lu_env *env, struct osd_object *obj,
			   struct lu_buf *buf, const char *name, int *sizep)
{
	int rc;

	if (unlikely(!dt_object_exists(&obj->oo_dt) || obj->oo_destroyed))
		return -ENOENT;

	/* check SA_ZPL_DXATTR first then fallback to directory xattr */
	rc = __osd_sa_xattr_get(env, obj, buf, name, sizep);
	if (rc != -ENOENT)
		return rc;

	return __osd_xattr_get_large(env, osd_obj2dev(obj), obj->oo_xattr,
				     buf, name, sizep);
}

/**
 * Copy LMA extended attribute into provided buffer
 *
 * Note that no locking is done here.
 *
 * \param[in] env      execution environment
 * \param[in] obj      object for which to retrieve xattr
 * \param[out] buf     buffer to store xattr value in
 *
 * \retval 0           on success
 * \retval negative    negated errno on failure
 */
int osd_xattr_get_lma(const struct lu_env *env, struct osd_object *obj,
		      struct lu_buf *buf)
{
	int size = 0;
	int rc = -ENOENT;

	if (!buf)
		return 0;

	if (unlikely(obj->oo_destroyed))
		goto out_lma;

	/* check SA_ZPL_DXATTR first then fallback to directory xattr */
	rc = __osd_sa_xattr_get(env, obj, buf, XATTR_NAME_LMA, &size);
	if (!rc && unlikely(size < sizeof(struct lustre_mdt_attrs)))
		rc = -EINVAL;
	if (rc != -ENOENT)
		goto out_lma;

	rc = __osd_xattr_get_large(env, osd_obj2dev(obj), obj->oo_xattr,
				     buf, XATTR_NAME_LMA, &size);
	if (!rc && unlikely(size < sizeof(struct lustre_mdt_attrs)))
		rc = -EINVAL;

out_lma:
	return rc;
}

static int osd_get_pfid_from_lma(const struct lu_env *env,
				 struct osd_object *obj,
				 struct lu_buf *buf, int *sizep)
{
	struct osd_thread_info *info = osd_oti_get(env);
	struct lustre_ost_attrs *loa =
		(struct lustre_ost_attrs *)&info->oti_buf;
	struct lustre_mdt_attrs *lma = &loa->loa_lma;
	struct filter_fid *ff;
	struct ost_layout *ol;
	struct lu_buf tbuf = {
		.lb_buf = loa,
		.lb_len = sizeof(info->oti_buf),
	};
	int rc;

	ENTRY;
	BUILD_BUG_ON(sizeof(info->oti_buf) < sizeof(*loa));
	rc = osd_xattr_get_internal(env, obj, &tbuf,
				    XATTR_NAME_LMA, sizep);
	if (rc)
		RETURN(rc);

	lustre_loa_swab(loa, true);
	LASSERT(lma->lma_compat & LMAC_STRIPE_INFO);

	*sizep = sizeof(*ff);
	if (buf->lb_len == 0 || !buf->lb_buf)
		RETURN(0);

	if (buf->lb_len < *sizep)
		RETURN(-ERANGE);

	ff = buf->lb_buf;
	ol = &ff->ff_layout;
	ol->ol_stripe_count = cpu_to_le32(loa->loa_parent_fid.f_ver >>
					  PFID_STRIPE_IDX_BITS);
	ol->ol_stripe_size = cpu_to_le32(loa->loa_stripe_size);
	loa->loa_parent_fid.f_ver &= PFID_STRIPE_COUNT_MASK;
	fid_cpu_to_le(&ff->ff_parent, &loa->loa_parent_fid);
	if (lma->lma_compat & LMAC_COMP_INFO) {
		ol->ol_comp_start = cpu_to_le64(loa->loa_comp_start);
		ol->ol_comp_end = cpu_to_le64(loa->loa_comp_end);
		ol->ol_comp_id = cpu_to_le32(loa->loa_comp_id);
	} else {
		ol->ol_comp_start = 0;
		ol->ol_comp_end = 0;
		ol->ol_comp_id = 0;
	}

	RETURN(0);
}

int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
		  struct lu_buf *buf, const char *name)
{
	struct osd_object *obj = osd_dt_obj(dt);
	int rc, size = 0;

	ENTRY;
	if (!osd_obj2dev(obj)->od_posix_acl &&
	    (strcmp(name, XATTR_NAME_POSIX_ACL_ACCESS) == 0 ||
	     strcmp(name, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
		RETURN(-EOPNOTSUPP);

	down_read(&obj->oo_guard);
	if (unlikely(!dt_object_exists(dt) || obj->oo_destroyed))
		GOTO(out, rc = -ENOENT);
	LASSERT(obj->oo_dn != NULL);

	/* For the OST migrated from ldiskfs, the PFID EA may
	 * be stored in LMA because of ldiskfs inode size.
	 */
	if (strcmp(name, XATTR_NAME_FID) == 0 && obj->oo_pfid_in_lma)
		rc = osd_get_pfid_from_lma(env, obj, buf, &size);
	else
		rc = osd_xattr_get_internal(env, obj, buf, name, &size);

	if (rc == -ENOENT)
		rc = -ENODATA;
	else if (rc == 0)
		rc = size;
out:
	up_read(&obj->oo_guard);
	RETURN(rc);
}

/* the function is used to declare EAs when SA is not supported */
static void __osd_xattr_declare_legacy(const struct lu_env *env,
				       struct osd_object *obj,
				       int vallen, const char *name,
				       struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	dmu_tx_t *tx = oh->ot_tx;
	uint64_t xa_data_obj;
	int rc;

	if (obj->oo_xattr == ZFS_NO_OBJECT) {
		/* xattr zap + entry */
		dmu_tx_hold_zap(tx, DMU_NEW_OBJECT, TRUE, (char *) name);
		/* xattr value obj */
		dmu_tx_hold_sa_create(tx, ZFS_SA_BASE_ATTR_SIZE);
		dmu_tx_hold_write(tx, DMU_NEW_OBJECT, 0, vallen);
		return;
	}

	rc = -zap_lookup(osd->od_os, obj->oo_xattr, name, sizeof(uint64_t), 1,
			&xa_data_obj);
	if (rc == 0) {
		/*
		 * Entry already exists.
		 * We'll truncate the existing object.
		 */
		dmu_tx_hold_bonus(tx, xa_data_obj);
		dmu_tx_hold_free(tx, xa_data_obj, vallen, DMU_OBJECT_END);
		dmu_tx_hold_write(tx, xa_data_obj, 0, vallen);
	} else if (rc == -ENOENT) {
		/*
		 * Entry doesn't exist, we need to create a new one and a new
		 * object to store the value.
		 */
		dmu_tx_hold_bonus(tx, obj->oo_xattr);
		dmu_tx_hold_zap(tx, obj->oo_xattr, TRUE, (char *) name);
		dmu_tx_hold_sa_create(tx, ZFS_SA_BASE_ATTR_SIZE);
		dmu_tx_hold_write(tx, DMU_NEW_OBJECT, 0, vallen);
	}
}

void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
			     int vallen, const char *name,
			     struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	dmu_tx_t *tx = oh->ot_tx;
	int bonuslen;

	if (unlikely(obj->oo_destroyed))
		return;

	if (strcmp(name, XATTR_NAME_LINK) == 0 &&
	    osd->od_remote_parent_dir != ZFS_NO_OBJECT) {
		/* If some name entry resides on remote MDT, then will create
		 * agent entry under remote parent. On the other hand, if the
		 * remote entry will be removed, then related agent entry may
		 * need to be removed from the remote parent. So there may be
		 * kinds of cases, let's declare enough credits. The credits
		 * for create agent entry is enough for remove case.
		 */
		osd_tx_hold_zap(tx, osd->od_remote_parent_dir,
				NULL, TRUE, NULL);
	}

	if (unlikely(!osd_obj2dev(obj)->od_xattr_in_sa)) {
		__osd_xattr_declare_legacy(env, obj, vallen, name, oh);
		return;
	}

	/* declare EA in SA */
	if (dt_object_exists(&obj->oo_dt)) {
		LASSERT(obj->oo_sa_hdl);
		/* XXX: it should be possible to skip spill declaration if
		 * specific EA is part of bonus and doesn't grow
		 */
		dmu_tx_hold_spill(tx, obj->oo_dn->dn_object);
		return;
	}

	bonuslen = osd_obj_bonuslen(obj);

	/* the object doesn't exist, but we've declared bonus
	 * in osd_declare_object_create() yet
	 */
	if (obj->oo_ea_in_bonus > bonuslen) {
		/* spill has been declared already */
	} else if (obj->oo_ea_in_bonus + vallen > bonuslen) {
		/* we're about to exceed bonus, let's declare spill */
		dmu_tx_hold_spill(tx, DMU_NEW_OBJECT);
	}
	obj->oo_ea_in_bonus += vallen;
}

int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
			  const struct lu_attr *attr,
			  const struct lu_buf *buf, const char *name,
			  int fl, struct thandle *handle)
{
	struct osd_object *obj = osd_dt_obj(dt);
	struct osd_thandle *oh;

	ENTRY;
	LASSERT(handle != NULL);
	oh = container_of(handle, struct osd_thandle, ot_super);

	down_read(&obj->oo_guard);
	__osd_xattr_declare_set(env, obj, buf->lb_len, name, oh);
	up_read(&obj->oo_guard);

	RETURN(0);
}

int __osd_sa_attr_init(const struct lu_env *env, struct osd_object *obj,
		       struct osd_thandle *oh)
{
	sa_bulk_attr_t *bulk = osd_oti_get(env)->oti_attr_bulk;
	struct osa_attr *osa = &osd_oti_get(env)->oti_osa;
	struct lu_buf *lb = &osd_oti_get(env)->oti_xattr_lbuf;
	struct osd_device *osd = osd_obj2dev(obj);
	uint64_t gen;
	inode_timespec_t now;
	size_t size;
	int rc, cnt;

	obj->oo_late_xattr = 0;
	obj->oo_late_attr_set = 0;

	gen = dmu_tx_get_txg(oh->ot_tx);
	gethrestime(&now);
	ZFS_TIME_ENCODE(&now, osa->btime);

	obj->oo_attr.la_valid |= LA_BTIME;
	obj->oo_attr.la_btime = osa->btime[0];
	osa->atime[0] = obj->oo_attr.la_atime;
	osa->ctime[0] = obj->oo_attr.la_ctime;
	osa->mtime[0] = obj->oo_attr.la_mtime;
	osa->mode = obj->oo_attr.la_mode;
	osa->uid = obj->oo_attr.la_uid;
	osa->gid = obj->oo_attr.la_gid;
	osa->rdev = obj->oo_attr.la_rdev;
	osa->nlink = obj->oo_attr.la_nlink;
	osa->flags = attrs_fs2zfs(obj->oo_attr.la_flags);
	osa->size  = obj->oo_attr.la_size;
#ifdef ZFS_PROJINHERIT
	if (osd->od_projectused_dn) {
		if (obj->oo_attr.la_valid & LA_PROJID)
			osa->projid = obj->oo_attr.la_projid;
		else
			osa->projid = ZFS_DEFAULT_PROJID;
		osa->flags |= ZFS_PROJID;
		obj->oo_with_projid = 1;
	}
#endif

	cnt = 0;
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_MODE(osd), NULL, &osa->mode, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_SIZE(osd), NULL, &osa->size, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_GEN(osd), NULL, &gen, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_UID(osd), NULL, &osa->uid, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_GID(osd), NULL, &osa->gid, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_PARENT(osd), NULL,
			 &obj->oo_parent, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_FLAGS(osd), NULL, &osa->flags, 8);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_ATIME(osd), NULL, osa->atime, 16);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_MTIME(osd), NULL, osa->mtime, 16);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_CTIME(osd), NULL, osa->ctime, 16);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_CRTIME(osd), NULL, osa->btime, 16);
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_LINKS(osd), NULL, &osa->nlink, 8);
#ifdef ZFS_PROJINHERIT
	if (osd->od_projectused_dn)
		SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_PROJID(osd), NULL,
				 &osa->projid, 8);
#endif
	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_RDEV(osd), NULL, &osa->rdev, 8);
	LASSERT(cnt <= ARRAY_SIZE(osd_oti_get(env)->oti_attr_bulk));

	/* Update the SA for additions, modifications, and removals. */
	rc = -nvlist_size(obj->oo_sa_xattr, &size, NV_ENCODE_XDR);
	if (rc)
		return rc;

	lu_buf_check_and_alloc(lb, size);
	if (lb->lb_buf == NULL) {
		rc = -ENOMEM;
		CERROR("%s: can't allocate buffer for xattr update: rc = %d\n",
		       osd->od_svname, rc);
		return rc;
	}

	rc = -nvlist_pack(obj->oo_sa_xattr, (char **)&lb->lb_buf, &size,
			  NV_ENCODE_XDR, KM_SLEEP);
	if (rc)
		return rc;

	SA_ADD_BULK_ATTR(bulk, cnt, SA_ZPL_DXATTR(osd), NULL, lb->lb_buf, size);

	rc = -sa_replace_all_by_template(obj->oo_sa_hdl, bulk, cnt, oh->ot_tx);

	return rc;
}

int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
			   struct osd_thandle *oh)
{
	struct lu_buf *lb = &osd_oti_get(env)->oti_xattr_lbuf;
	struct osd_device *osd = osd_obj2dev(obj);
	char *dxattr;
	size_t size;
	int rc;

	obj->oo_late_xattr = 0;

	/* Update the SA for additions, modifications, and removals. */
	rc = -nvlist_size(obj->oo_sa_xattr, &size, NV_ENCODE_XDR);
	if (rc)
		return rc;

	lu_buf_check_and_alloc(lb, size);
	if (lb->lb_buf == NULL) {
		rc = -ENOMEM;
		CERROR("%s: can't allocate buffer for xattr update: rc = %d\n",
		       osd->od_svname, rc);
		return rc;
	}

	dxattr = lb->lb_buf;
	rc = -nvlist_pack(obj->oo_sa_xattr, &dxattr, &size,
			NV_ENCODE_XDR, KM_SLEEP);
	if (rc)
		return rc;
	LASSERT(dxattr == lb->lb_buf);

	sa_update(obj->oo_sa_hdl, SA_ZPL_DXATTR(osd), dxattr, size, oh->ot_tx);

	return 0;
}

/*
 * Set an extended attribute.
 * This transaction must have called udmu_xattr_declare_set() first.
 *
 * Returns 0 on success or a negative error number on failure.
 *
 * No locking is done here.
 */
int __osd_sa_xattr_schedule_update(const struct lu_env *env,
				   struct osd_object *obj,
				   struct osd_thandle *oh)
{
	ENTRY;
	LASSERT(obj->oo_sa_hdl);
	LASSERT(obj->oo_sa_xattr);

	/* schedule batched SA update in osd_object_sa_dirty_rele() */
	obj->oo_late_xattr = 1;
	osd_object_sa_dirty_add(obj, oh);

	RETURN(0);

}

int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
		       const struct lu_buf *buf, const char *name, int fl,
		       struct osd_thandle *oh)
{
	uchar_t *nv_value;
	size_t size;
	int nv_size;
	int rc;
	int too_big = 0;

	rc = __osd_xattr_cache(obj);
	if (rc)
		return rc;

	LASSERT(obj->oo_sa_xattr);
	if (buf->lb_len > OBD_MAX_EA_SIZE) {
		too_big = 1;
	} else {
		/* Prevent the DXATTR SA from consuming the entire SA region */
		rc = -nvlist_size(obj->oo_sa_xattr, &size, NV_ENCODE_XDR);
		if (rc)
			return rc;

		if (size + buf->lb_len > DXATTR_MAX_SA_SIZE)
			too_big = 1;
	}

	/* even in case of -EFBIG we must lookup xattr and check can we
	 * rewrite it then delete from SA
	 */
	rc = -nvlist_lookup_byte_array(obj->oo_sa_xattr, name, &nv_value,
					&nv_size);
	if (rc == 0) {
		if (fl & LU_XATTR_CREATE) {
			return -EEXIST;
		} else if (too_big) {
			rc = -nvlist_remove(obj->oo_sa_xattr, name,
						DATA_TYPE_BYTE_ARRAY);
			if (rc < 0)
				return rc;
			rc = __osd_sa_xattr_schedule_update(env, obj, oh);
			return rc == 0 ? -EFBIG : rc;
		}
	} else if (rc == -ENOENT) {
		if (fl & LU_XATTR_REPLACE)
			return -ENODATA;
		else if (too_big)
			return -EFBIG;
	} else {
		return rc;
	}

	/* Ensure xattr doesn't exist in ZAP */
	if (obj->oo_xattr != ZFS_NO_OBJECT) {
		struct osd_device *osd = osd_obj2dev(obj);
		uint64_t           objid;

		rc = -zap_lookup(osd->od_os, obj->oo_xattr,
				 name, 8, 1, &objid);
		if (rc == 0) {
			rc = -dmu_object_free(osd->od_os, objid, oh->ot_tx);
			if (rc == 0)
				zap_remove(osd->od_os, obj->oo_xattr,
					   name, oh->ot_tx);
		}
	}

	rc = -nvlist_add_byte_array(obj->oo_sa_xattr, name,
				    (uchar_t *)buf->lb_buf, buf->lb_len);
	if (rc)
		return rc;

	/* batch updates only for just created dnodes where we
	 * used to set number of EAs in a single transaction
	 */
	if (obj->oo_dn->dn_allocated_txg == oh->ot_tx->tx_txg)
		rc = __osd_sa_xattr_schedule_update(env, obj, oh);
	else
		rc = __osd_sa_xattr_update(env, obj, oh);

	return rc;
}

int
__osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
		const struct lu_buf *buf, const char *name, int fl,
		struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	dnode_t *xa_zap_dn = NULL;
	dnode_t *xa_data_dn = NULL;
	uint64_t xa_data_obj;
	sa_handle_t *sa_hdl = NULL;
	dmu_tx_t *tx = oh->ot_tx;
	uint64_t size;
	int rc;

	LASSERT(obj->oo_sa_hdl);

	if (obj->oo_xattr == ZFS_NO_OBJECT) {
		struct lu_attr *la = &osd_oti_get(env)->oti_la;

		la->la_valid = LA_MODE;
		la->la_mode = S_IFDIR | 0755;
		rc = __osd_zap_create(env, osd, &xa_zap_dn, tx, la, 0, 0);
		if (rc)
			return rc;

		obj->oo_xattr = xa_zap_dn->dn_object;
		rc = osd_object_sa_update(obj, SA_ZPL_XATTR(osd),
				&obj->oo_xattr, 8, oh);
		if (rc)
			goto out;
	}

	rc = -zap_lookup(osd->od_os, obj->oo_xattr, name, sizeof(uint64_t), 1,
			 &xa_data_obj);
	if (rc == 0) {
		if (fl & LU_XATTR_CREATE) {
			rc = -EEXIST;
			goto out;
		}
		/* Entry already exists. We'll truncate the existing object. */
		rc = __osd_obj2dnode(osd->od_os, xa_data_obj, &xa_data_dn);
		if (rc)
			goto out;

		rc = -sa_handle_get(osd->od_os, xa_data_obj, NULL,
					SA_HDL_PRIVATE, &sa_hdl);
		if (rc)
			goto out;

		rc = -sa_lookup(sa_hdl, SA_ZPL_SIZE(osd), &size, 8);
		if (rc)
			goto out_sa;

		rc = -dmu_free_range(osd->od_os, xa_data_dn->dn_object,
				     0, DMU_OBJECT_END, tx);
		if (rc)
			goto out_sa;
	} else if (rc == -ENOENT) {
		struct lu_attr *la = &osd_oti_get(env)->oti_la;
		/*
		 * Entry doesn't exist, we need to create a new one and a new
		 * object to store the value.
		 */
		if (fl & LU_XATTR_REPLACE) {
			/* should be ENOATTR according to the
			 * man, but that is undefined here
			 */
			rc = -ENODATA;
			goto out;
		}

		la->la_valid = LA_MODE;
		la->la_mode = S_IFREG | 0644;
		rc = __osd_object_create(env, osd, obj,
					 lu_object_fid(&obj->oo_dt.do_lu),
					 &xa_data_dn, tx, la);
		if (rc)
			goto out;
		xa_data_obj = xa_data_dn->dn_object;

		rc = -sa_handle_get(osd->od_os, xa_data_obj, NULL,
					SA_HDL_PRIVATE, &sa_hdl);
		if (rc)
			goto out;

		rc = -zap_add(osd->od_os, obj->oo_xattr, name, sizeof(uint64_t),
				1, &xa_data_obj, tx);
		if (rc)
			goto out_sa;
	} else {
		/* There was an error looking up the xattr name */
		goto out;
	}

	/* Finally write the xattr value */
	osd_dmu_write(osd, xa_data_dn, 0, buf->lb_len, buf->lb_buf, tx);

	size = buf->lb_len;
	rc = -sa_update(sa_hdl, SA_ZPL_SIZE(osd), &size, 8, tx);

out_sa:
	sa_handle_destroy(sa_hdl);
out:
	if (xa_data_dn != NULL)
		osd_dnode_rele(xa_data_dn);
	if (xa_zap_dn != NULL)
		osd_dnode_rele(xa_zap_dn);

	return rc;
}

static int osd_xattr_split_pfid(const struct lu_env *env,
				struct osd_object *obj, struct osd_thandle *oh)
{
	struct osd_thread_info *info = osd_oti_get(env);
	struct lustre_ost_attrs *loa =
		(struct lustre_ost_attrs *)&info->oti_buf;
	struct lustre_mdt_attrs *lma = &loa->loa_lma;
	struct lu_buf buf = {
		.lb_buf = loa,
		.lb_len = sizeof(info->oti_buf),
	};
	int size;
	int rc;

	ENTRY;
	BUILD_BUG_ON(sizeof(info->oti_buf) < sizeof(*loa));
	rc = osd_xattr_get_internal(env, obj, &buf, XATTR_NAME_LMA, &size);
	if (rc)
		RETURN(rc);

	lustre_loa_swab(loa, true);
	LASSERT(lma->lma_compat & LMAC_STRIPE_INFO);

	lma->lma_compat &= ~(LMAC_STRIPE_INFO | LMAC_COMP_INFO);
	lustre_lma_swab(lma);
	buf.lb_buf = lma;
	buf.lb_len = sizeof(*lma);
	rc = osd_xattr_set_internal(env, obj, &buf, XATTR_NAME_LMA,
				    LU_XATTR_REPLACE, oh);
	if (!rc)
		obj->oo_pfid_in_lma = 0;

	RETURN(rc);
}

/*
 * In DNE environment, the object (in spite of regular file or directory)
 * and its name entry may reside on different MDTs. Under such case, we will
 * create an agent entry on the MDT where the object resides. The agent entry
 * references the object locally, that makes the object to be visible to the
 * userspace when mounted as 'zfs' directly. Then the userspace tools, such
 * as 'tar' can handle the object properly.
 *
 * We handle the agent entry during set linkEA that is the common interface
 * for both regular file and directroy, can handle kinds of cases, such as
 * create/link/unlink/rename, and so on.
 *
 * NOTE: we need to do that for both directory and regular file, so we can NOT
 *	 do that when ea_{insert,delete} that are directory based operations.
 */
static int osd_xattr_handle_linkea(const struct lu_env *env,
				   struct osd_device *osd,
				   struct osd_object *obj,
				   const struct lu_buf *buf,
				   struct osd_thandle *oh)
{
	const struct lu_fid *fid = lu_object_fid(&obj->oo_dt.do_lu);
	struct lu_fid *tfid = &osd_oti_get(env)->oti_fid;
	struct linkea_data ldata = { .ld_buf = (struct lu_buf *)buf };
	struct lu_name tmpname;
	int rc;
	bool remote = false;

	ENTRY;
	rc = linkea_init_with_rec(&ldata);
	if (!rc) {
		linkea_first_entry(&ldata);
		while (ldata.ld_lee != NULL && !remote) {
			linkea_entry_unpack(ldata.ld_lee, &ldata.ld_reclen,
					    &tmpname, tfid);
			if (osd_remote_fid(env, osd, tfid) > 0)
				remote = true;
			else
				linkea_next_entry(&ldata);
		}
	} else if (rc == -ENODATA) {
		rc = 0;
	} else {
		RETURN(rc);
	}

	if (lu_object_has_agent_entry(&obj->oo_dt.do_lu) && !remote) {
		rc = osd_delete_from_remote_parent(env, osd, obj, oh, false);
		if (rc)
			CERROR("%s: failed to remove agent entry for "DFID": rc = %d\n",
			       osd_name(osd), PFID(fid), rc);
	} else if (!lu_object_has_agent_entry(&obj->oo_dt.do_lu) && remote) {
		rc = osd_add_to_remote_parent(env, osd, obj, oh);
		if (rc)
			CWARN("%s: failed to create agent entry for "DFID": rc = %d\n",
			      osd_name(osd), PFID(fid), rc);
	}

	RETURN(rc);
}

int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
		  const struct lu_buf *buf, const char *name, int fl,
		  struct thandle *handle)
{
	struct osd_object *obj = osd_dt_obj(dt);
	struct osd_device *osd = osd_obj2dev(obj);
	struct osd_thandle *oh;
	int rc = 0;

	ENTRY;
	LASSERT(handle != NULL);
	LASSERT(osd_invariant(obj));

	if (!osd_obj2dev(obj)->od_posix_acl &&
	    (strcmp(name, XATTR_NAME_POSIX_ACL_ACCESS) == 0 ||
	     strcmp(name, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
		RETURN(-EOPNOTSUPP);

	oh = container_of(handle, struct osd_thandle, ot_super);

	down_write(&obj->oo_guard);
	CDEBUG(D_INODE, "Setting xattr %s with size %d\n",
		name, (int)buf->lb_len);

	/* For the OST migrated from ldiskfs, the PFID EA may
	 * be stored in LMA because of ldiskfs inode size.
	 */
	if (unlikely(strcmp(name, XATTR_NAME_FID) == 0 &&
		     obj->oo_pfid_in_lma)) {
		rc = osd_xattr_split_pfid(env, obj, oh);
		if (!rc)
			fl = LU_XATTR_CREATE;
	} else if (strcmp(name, XATTR_NAME_LINK) == 0 &&
		   osd->od_remote_parent_dir != ZFS_NO_OBJECT) {
		rc = osd_xattr_handle_linkea(env, osd, obj, buf, oh);
	}

	if (!rc) {
		rc = osd_xattr_set_internal(env, obj, buf, name, fl, oh);
		if (unlikely(!strcmp(name, XATTR_NAME_LMV)) && !rc)
			obj->oo_lmv_updated = 1;
	}
	up_write(&obj->oo_guard);

	RETURN(rc);
}

static void
__osd_xattr_declare_del(const struct lu_env *env, struct osd_object *obj,
			const char *name, struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	dmu_tx_t *tx = oh->ot_tx;
	uint64_t xa_data_obj;
	int rc;

	/* update SA_ZPL_DXATTR if xattr was in SA */
	dmu_tx_hold_sa(tx, obj->oo_sa_hdl, 0);

	if (obj->oo_xattr == ZFS_NO_OBJECT)
		return;

	rc = -zap_lookup(osd->od_os, obj->oo_xattr, name, 8, 1, &xa_data_obj);
	if (rc == 0) {
		/* Entry exists. Will delete the existing obj and ZAP entry */
		dmu_tx_hold_bonus(tx, xa_data_obj);
		dmu_tx_hold_free(tx, xa_data_obj, 0, DMU_OBJECT_END);
		dmu_tx_hold_zap(tx, obj->oo_xattr, FALSE, (char *) name);
		return;
	} else if (rc == -ENOENT) {
		/*
		 * Entry doesn't exist, nothing to be changed.
		 */
		return;
	}

	/* An error happened */
	tx->tx_err = -rc;
}

int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
			  const char *name, struct thandle *handle)
{
	struct osd_object *obj = osd_dt_obj(dt);
	struct osd_thandle *oh;

	ENTRY;
	LASSERT(handle != NULL);
	LASSERT(osd_invariant(obj));

	oh = container_of(handle, struct osd_thandle, ot_super);
	LASSERT(oh->ot_tx != NULL);

	down_read(&obj->oo_guard);
	if (likely(dt_object_exists(&obj->oo_dt) && !obj->oo_destroyed)) {
		LASSERT(obj->oo_dn != NULL);
		__osd_xattr_declare_del(env, obj, name, oh);
	}
	up_read(&obj->oo_guard);

	RETURN(0);
}

static int __osd_sa_xattr_del(const struct lu_env *env, struct osd_object *obj,
			      const char *name, struct osd_thandle *oh)
{
	int rc;

	rc = __osd_xattr_cache(obj);
	if (rc)
		return rc;

	rc = -nvlist_remove(obj->oo_sa_xattr, name, DATA_TYPE_BYTE_ARRAY);
	if (rc)
		return rc;

	/*
	 * only migrate delete LMV, and it needs to be done immediately, because
	 * it's used in deleting sub stripes, and if this is delayed, later when
	 * destroying the master object, it will delete sub stripes again.
	 */
	if (!strcmp(name, XATTR_NAME_LMV))
		rc = __osd_sa_xattr_update(env, obj, oh);
	else
		rc = __osd_sa_xattr_schedule_update(env, obj, oh);
	return rc;
}

static int __osd_xattr_del(const struct lu_env *env, struct osd_object *obj,
			   const char *name, struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	uint64_t xa_data_obj;
	int rc;

	if (unlikely(!dt_object_exists(&obj->oo_dt) || obj->oo_destroyed))
		return -ENOENT;

	/* try remove xattr from SA at first */
	rc = __osd_sa_xattr_del(env, obj, name, oh);
	if (rc != -ENOENT)
		return rc;

	if (obj->oo_xattr == ZFS_NO_OBJECT)
		return 0;

	rc = -zap_lookup(osd->od_os, obj->oo_xattr, name, sizeof(uint64_t), 1,
			&xa_data_obj);
	if (rc == -ENOENT) {
		rc = 0;
	} else if (rc == 0) {
		/* Entry exists. We'll delete the existing obj and ZAP entry */
		rc = -dmu_object_free(osd->od_os, xa_data_obj, oh->ot_tx);
		if (rc)
			return rc;

		rc = -zap_remove(osd->od_os, obj->oo_xattr, name, oh->ot_tx);
	}

	return rc;
}

int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
		  const char *name, struct thandle *handle)
{
	struct osd_object  *obj = osd_dt_obj(dt);
	struct osd_thandle *oh;
	int rc;

	ENTRY;
	LASSERT(handle != NULL);
	oh = container_of(handle, struct osd_thandle, ot_super);
	LASSERT(oh->ot_tx != NULL);

	if (!osd_obj2dev(obj)->od_posix_acl &&
	    (strcmp(name, XATTR_NAME_POSIX_ACL_ACCESS) == 0 ||
	     strcmp(name, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
		RETURN(-EOPNOTSUPP);

	down_write(&obj->oo_guard);
	if (unlikely(!dt_object_exists(dt) || obj->oo_destroyed))
		GOTO(out, rc = -ENOENT);
	LASSERT(obj->oo_dn != NULL);
	/* For the OST migrated from ldiskfs, the PFID EA may
	 * be stored in LMA because of ldiskfs inode size.
	 */
	if (unlikely(strcmp(name, XATTR_NAME_FID) == 0 && obj->oo_pfid_in_lma))
		rc = osd_xattr_split_pfid(env, obj, oh);
	else
		rc = __osd_xattr_del(env, obj, name, oh);

out:
	up_write(&obj->oo_guard);
	RETURN(rc);
}

void osd_declare_xattrs_destroy(const struct lu_env *env,
				struct osd_object *obj, struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	zap_attribute_t *za = &osd_oti_get(env)->oti_za;
	uint64_t oid = obj->oo_xattr, xid;
	dmu_tx_t *tx = oh->ot_tx;
	zap_cursor_t *zc;
	int rc;

	if (oid == ZFS_NO_OBJECT)
		return; /* Nothing to do for SA xattrs */

	/* Declare to free the ZAP holding xattrs */
	dmu_tx_hold_free(tx, oid, 0, DMU_OBJECT_END);

	rc = osd_zap_cursor_init(&zc, osd->od_os, oid, 0);
	if (rc)
		goto out;

	while (zap_cursor_retrieve(zc, za) == 0) {
		LASSERT(za->za_num_integers == 1);
		LASSERT(za->za_integer_length == sizeof(uint64_t));

		rc = -zap_lookup(osd->od_os, oid, za->za_name,
				 sizeof(uint64_t), 1, &xid);
		if (rc) {
			CERROR("%s: xattr %s lookup failed: rc = %d\n",
			       osd->od_svname, za->za_name, rc);
			break;
		}
		dmu_tx_hold_free(tx, xid, 0, DMU_OBJECT_END);

		zap_cursor_advance(zc);
	}

	osd_zap_cursor_fini(zc);
out:
	if (rc && tx->tx_err == 0)
		tx->tx_err = -rc;
}

int osd_xattrs_destroy(const struct lu_env *env,
		       struct osd_object *obj, struct osd_thandle *oh)
{
	struct osd_device *osd = osd_obj2dev(obj);
	dmu_tx_t *tx = oh->ot_tx;
	zap_attribute_t *za = &osd_oti_get(env)->oti_za;
	zap_cursor_t *zc;
	uint64_t xid;
	int rc;

	/* The transaction must have been assigned to a transaction group. */
	LASSERT(tx->tx_txg != 0);

	if (obj->oo_xattr == ZFS_NO_OBJECT)
		return 0; /* Nothing to do for SA xattrs */

	/* Free the ZAP holding the xattrs */
	rc = osd_zap_cursor_init(&zc, osd->od_os, obj->oo_xattr, 0);
	if (rc)
		return rc;

	while (zap_cursor_retrieve(zc, za) == 0) {
		LASSERT(za->za_num_integers == 1);
		LASSERT(za->za_integer_length == sizeof(uint64_t));

		rc = -zap_lookup(osd->od_os, obj->oo_xattr, za->za_name,
				 sizeof(uint64_t), 1, &xid);
		if (rc) {
			CERROR("%s: lookup xattr %s failed: rc = %d\n",
			       osd->od_svname, za->za_name, rc);
		} else {
			rc = -dmu_object_free(osd->od_os, xid, tx);
			if (rc)
				CERROR("%s: free xattr %s failed: rc = %d\n",
				       osd->od_svname, za->za_name, rc);
		}
		zap_cursor_advance(zc);
	}
	osd_zap_cursor_fini(zc);

	rc = -dmu_object_free(osd->od_os, obj->oo_xattr, tx);
	if (rc)
		CERROR("%s: free xattr %llu failed: rc = %d\n",
		       osd->od_svname, obj->oo_xattr, rc);

	return rc;
}

static int
osd_sa_xattr_list(const struct lu_env *env, struct osd_object *obj,
		  const struct lu_buf *lb)
{
	nvpair_t *nvp = NULL;
	int len, counted = 0;
	int rc = 0;

	rc = __osd_xattr_cache(obj);
	if (rc)
		return rc;

	while ((nvp = nvlist_next_nvpair(obj->oo_sa_xattr, nvp)) != NULL) {
		const char *name = nvpair_name(nvp);

		if (!osd_obj2dev(obj)->od_posix_acl &&
		    (strcmp(name, XATTR_NAME_POSIX_ACL_ACCESS) == 0 ||
		     strcmp(name, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
			continue;

		len = strlen(name);
		if (lb->lb_buf != NULL) {
			if (counted + len + 1 > lb->lb_len)
				return -ERANGE;

			memcpy(lb->lb_buf + counted, name, len + 1);
		}
		counted += len + 1;
	}
	return counted;
}

int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
		   const struct lu_buf *lb)
{
	struct osd_object *obj = osd_dt_obj(dt);
	struct osd_device *osd = osd_obj2dev(obj);
	zap_attribute_t *za = &osd_oti_get(env)->oti_za;
	zap_cursor_t *zc;
	int rc, counted;

	ENTRY;
	down_read(&obj->oo_guard);
	if (unlikely(!dt_object_exists(dt) || obj->oo_destroyed))
		GOTO(out, rc = -ENOENT);
	LASSERT(obj->oo_dn != NULL);

	rc = osd_sa_xattr_list(env, obj, lb);
	if (rc < 0)
		GOTO(out, rc);

	counted = rc;

	/* continue with dnode xattr if any */
	if (obj->oo_xattr == ZFS_NO_OBJECT)
		GOTO(out, rc = counted);

	rc = osd_zap_cursor_init(&zc, osd->od_os, obj->oo_xattr, 0);
	if (rc)
		GOTO(out, rc);

	while ((rc = -zap_cursor_retrieve(zc, za)) == 0) {
		if (!osd_obj2dev(obj)->od_posix_acl &&
		    (strcmp(za->za_name, XATTR_NAME_POSIX_ACL_ACCESS) == 0 ||
		     strcmp(za->za_name, XATTR_NAME_POSIX_ACL_DEFAULT) == 0)) {
			zap_cursor_advance(zc);
			continue;
		}

		rc = strlen(za->za_name);
		if (lb->lb_buf != NULL) {
			if (counted + rc + 1 > lb->lb_len)
				GOTO(out_fini, rc = -ERANGE);

			memcpy(lb->lb_buf + counted, za->za_name, rc + 1);
		}
		counted += rc + 1;

		zap_cursor_advance(zc);
	}
	if (rc == -ENOENT) /* no more kes in the index */
		rc = 0;
	else if (unlikely(rc < 0))
		GOTO(out_fini, rc);
	rc = counted;

out_fini:
	osd_zap_cursor_fini(zc);
out:
	up_read(&obj->oo_guard);
	RETURN(rc);

}