/* SPDX-License-Identifier: GPL-2.0 */

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

/*
 * This file is part of Lustre, http://www.lustre.org/
 *
 * Lustre Metadata Target (mdt) request handler
 *
 * Author: Peter Braam <braam@clusterfs.com>
 * Author: Andreas Dilger <adilger@clusterfs.com>
 * Author: Phil Schwan <phil@clusterfs.com>
 * Author: Mike Shaver <shaver@clusterfs.com>
 * Author: Nikita Danilov <nikita@clusterfs.com>
 * Author: Huang Hua <huanghua@clusterfs.com>
 */

#ifndef _MDT_INTERNAL_H
#define _MDT_INTERNAL_H

#include <cfs_hash.h>
#include <upcall_cache.h>
#include <obd_class.h>
#include <lustre_disk.h>
#include <lu_target.h>
#include <md_object.h>
#include <lustre_fid.h>
#include <lustre_fld.h>
#include <lustre_req_layout.h>
#include <lustre_sec.h>
#include <lustre_idmap.h>
#include <lustre_quota.h>
#include <lustre_linkea.h>
#include <lustre_lmv.h>

struct mdt_object;

/* file data for open files on MDS */
struct mdt_file_data {
	/**  portals handle must be first */
	struct portals_handle	mfd_open_handle;
	/* export data of portals_handle */
	const struct mdt_export_data	*mfd_owner;
	/** open mode provided by client */
	enum mds_open_flags	mfd_open_flags;
	/** protected by med_open_lock */
	struct list_head	mfd_list;
	/** xid of the open request */
	__u64			mfd_xid;
	/** old handle in replay case */
	struct lustre_handle	mfd_open_handle_old;
	/** point to opened object */
	struct mdt_object	*mfd_object;
};

#define CDT_NONBLOCKING_RESTORE		(1ULL << 0)
#define CDT_NORETRY_ACTION		(1ULL << 1)
#define CDT_POLICY_LAST			CDT_NORETRY_ACTION
#define CDT_POLICY_SHIFT_COUNT		2
#define CDT_POLICY_ALL			(CDT_NONBLOCKING_RESTORE | \
					CDT_NORETRY_ACTION)

/* when adding a new policy, do not forget to update
 * lustre/mdt/mdt_coordinator.c::hsm_policy_names[]
 */
#define CDT_DEFAULT_POLICY		CDT_NORETRY_ACTION

/* Coordinator states. Keep the cdt_transition table in sync. */
enum cdt_states { CDT_STOPPED = 0,
		  CDT_INIT,
		  CDT_RUNNING,
		  CDT_DISABLE,
		  CDT_STOPPING,

		  CDT_STATES_COUNT
};

static inline char *cdt_mdt_state2str(int state)
{
	switch (state) {
	case CDT_INIT:
		return "init";
	case CDT_RUNNING:
		return "enabled";
	case CDT_STOPPING:
		return "stopping";
	case CDT_STOPPED:
		return "stopped";
	case CDT_DISABLE:
		return "disabled";
	default:
		return "unknown";
	}
}

/* when multiple lock are needed, the lock order is
 * cdt_agent_lock
 * cdt_counter_lock
 * cdt_request_lock
 */
struct coordinator {
	refcount_t		 cdt_ref;	     /**< cdt refcount */
	wait_queue_head_t	 cdt_waitq;	     /**< cdt wait queue */
	wait_queue_head_t	 cdt_cancel_all;     /**< cancel_all wait */
	bool			 cdt_event;	     /**< coordinator event */
	struct task_struct	*cdt_task;	     /**< cdt thread handle */
	struct lu_env		 cdt_env;	     /**< coordinator lustre
						      * env */
	struct lu_context	 cdt_session;	     /** session for lu_ucred */
	struct dentry		*cdt_debugfs_dir;	/**< cdt debugfs directory */
	struct completion	 cdt_kobj_unregister;
	struct kobject		 cdt_hsm_kobj;		/* hsm sysfs object */
	__u64			 cdt_policy;	     /**< policy flags */
	enum cdt_states		 cdt_state;	      /**< state */
	struct mutex		 cdt_state_lock;      /**< cdt_state lock */
	atomic64_t		 cdt_last_cookie;     /**< last cookie
						       * allocated */
	struct rw_semaphore	 cdt_agent_lock;      /**< protect agent list */
	struct rw_semaphore	 cdt_request_lock;    /**< protect request
						       * list */
	timeout_t		 cdt_loop_period;     /**< llog scan period */
	timeout_t		 cdt_grace_delay;     /**< request grace
						       * delay */
	timeout_t		 cdt_active_req_timeout; /**< request timeout */
	__u32			 cdt_default_archive_id; /**< archive id used
						       * when none are
						       * specified */
	u64			 cdt_max_requests;    /**< max count of started
						       * requests */
	/** Current count of active requests */
	atomic_t		 cdt_request_count;   /** total */
	atomic_t		 cdt_archive_count;
	atomic_t		 cdt_restore_count;
	atomic_t		 cdt_remove_count;

	/* started requests (struct cdt_agent_req:car_cookie_hash)
	 * indexed by cookie
	 */
	struct cfs_hash		*cdt_request_cookie_hash;
	/* started requests (struct cdt_agent_req:car_request_list) */
	struct list_head	 cdt_request_list;
	struct list_head	 cdt_agents;	      /**< list of register
						       * agents */
	struct rhashtable	 cdt_restore_hash;    /* rhashtable for
						       * restore requests
						       */

	/* Bitmasks indexed by the HSMA_XXX constants. */
	__u64			 cdt_user_request_mask;
	__u64			 cdt_group_request_mask;
	__u64			 cdt_other_request_mask;

	/* Remove archive on last unlink policy */
	bool			 cdt_remove_archive_on_last_unlink;

	bool			 cdt_wakeup_coordinator;
	bool			 cdt_idle;
};

/* mdt state flag bits */
#define MDT_FL_CFGLOG 0
#define MDT_FL_SYNCED 1

/* possible values for mo_dom_lock */
enum {
	NO_DOM_LOCK_ON_OPEN = 0,
	TRYLOCK_DOM_ON_OPEN = 1,
	/* not used anymore, left here for compatibility */
	ALWAYS_DOM_LOCK_ON_OPEN = 2,
	NUM_DOM_LOCK_ON_OPEN_MODES
};

struct mdt_statfs_cache {
	struct obd_statfs msf_osfs;
	__u64 msf_age;
};

enum mdt_rename_type {
	RENAME_SAMEDIR_SIZE = 0,
	RENAME_CROSSDIR_SRC_SIZE,
	RENAME_CROSSDIR_TGT_SIZE,
	RENAME_LAST
};

struct rename_stats {
	ktime_t			rs_init;
	struct obd_histogram	rs_hist[RENAME_LAST];
};

/* split directory automatically when sub file count exceeds 50k */
#define DIR_SPLIT_COUNT_DEFAULT	50000

/* directory auto-split allocate delta new stripes each time */
#define DIR_SPLIT_DELTA_DEFAULT	4

struct mdt_dir_restriper {
	struct lu_env		mdr_env;
	struct lu_context	mdr_session;
	struct task_struct     *mdr_task;
	/* lock for below fields */
	spinlock_t		mdr_lock;
	/* auto split when plain dir/shard sub files exceed threshold */
	u64			mdr_dir_split_count;
	/* auto split growth delta */
	u32			mdr_dir_split_delta;
	/* directories to split */
	struct list_head	mdr_auto_splitting;
	/* directories under which sub files are migrating */
	struct list_head	mdr_migrating;
	/* directories waiting to update layout after migration */
	struct list_head	mdr_updating;
	/* time to update directory layout after migration */
	time64_t		mdr_update_time;
	/* lum used in split/migrate/layout_change */
	union lmv_mds_md	mdr_lmv;
	/* page used in readdir */
	struct page	       *mdr_page;
};

struct mdt_device {
	/* super-class */
	struct lu_device	   mdt_lu_dev;
	struct seq_server_site	   mdt_seq_site;
	/* DLM name-space for meta-data locks maintained by this server */
	struct ldlm_namespace     *mdt_namespace;
	/* ptlrpc handle for MDS->client connections (for lock ASTs). */
	struct ptlrpc_client      *mdt_ldlm_client;
	/* underlying device */
	struct obd_export         *mdt_child_exp;
	struct md_device          *mdt_child;
	struct dt_device          *mdt_bottom;
	struct obd_export	  *mdt_bottom_exp;
	struct local_oid_storage  *mdt_los;
	/** target device */
	struct lu_target           mdt_lut;
	/* Options bit-fields. */
	struct {
		unsigned int       mo_user_xattr:1,
				   mo_acl:1,
				   mo_cos:1;
		unsigned int	   mo_dom_lock;
	} mdt_opts;
	/* mdt state flags */
	unsigned long		   mdt_state;

	/* transaction callbacks */
	struct dt_txn_callback	   mdt_txn_cb;

	/* these values should be updated from lov if necessary.
	 * or should be placed somewhere else.
	 */
	int			   mdt_max_mdsize;

	int			   mdt_max_ea_size;

	/* Max modify RPCs, replaces max_mod_rpcs_per_client module param */
	unsigned int			   mdt_max_mod_rpcs_in_flight;

	/* preferred BRW size, decided by storage type and capability */
	__u32			   mdt_brw_size;

	struct upcall_cache	  *mdt_identity_cache;
	struct upcall_cache	  *mdt_identity_cache_int;

	unsigned int		   mdt_evict_tgt_nids:1,
				   mdt_dom_read_open:1,
				   mdt_migrate_hsm_allowed:1,
				   mdt_enable_strict_som:1,
				   /* Enable remote dir on non-MDT0 */
				   mdt_enable_dir_migration:1,
				   mdt_enable_dir_restripe:1,
				   mdt_enable_dir_auto_split:1,
				   mdt_enable_parallel_rename_dir:1,
				   mdt_enable_parallel_rename_file:1,
				   mdt_enable_parallel_rename_crossdir:1,
				   mdt_enable_remote_dir:1,
				   mdt_enable_remote_rename:1,
				   mdt_enable_rename_trylock:1,
				   mdt_enable_striped_dir:1,
				   mdt_readonly:1,
				   mdt_skip_lfsck:1,
				   /* dir restripe migrate dirent only */
				   mdt_dir_restripe_nsonly:1,
				   /* this is enabled by default, but once an
				    * old client joins, disable this to handle
				    * inherited default LMV on server.
				    */
				   mdt_enable_dmv_implicit_inherit:1,
				   /* set dmv by setxattr, off by default */
				   mdt_enable_dmv_xattr:1;

				   /* user with gid can create remote/striped
				    * dir, and set default dir stripe
				    */
	gid_t			   mdt_enable_remote_dir_gid;
				   /* user with this gid can change projid */
	gid_t			   mdt_enable_chprojid_gid;
	kernel_cap_t		   mdt_enable_cap_mask;
				   /* user with this gid can pin/unpin file */
	gid_t			   mdt_enable_pin_gid;

	/* lock for osfs and md_root */
	spinlock_t		   mdt_lock;

	/* statfs optimization: we cache a bit  */
	struct mdt_statfs_cache	   mdt_sum_osfs;
	struct mdt_statfs_cache	   mdt_osfs;

	/* root squash */
	struct root_squash_info	   mdt_squash;

	struct rename_stats	   mdt_rename_stats;
	struct lu_fid		   mdt_md_root_fid;

	/* connection to quota master */
	struct obd_export	  *mdt_qmt_exp;
	/* quota master device associated with this MDT */
	struct lu_device	  *mdt_qmt_dev;

	struct coordinator	   mdt_coordinator;

	/* inter-MDT connection count */
	atomic_t		   mdt_mds_mds_conns;

	/* MDT device async commit count, used for debug and sanity test */
	atomic_t		   mdt_async_commit_count;

	struct mdt_object	  *mdt_md_root;

	struct mdt_dir_restriper   mdt_restriper;

	/* count of old clients that doesn't support DMV implicite inherit */
	atomic_t		   mdt_dmv_old_client_count;

	/* name of xattr used to store jobid in mdt inode */
	char			   mdt_job_xattr[XATTR_JOB_MAX_LEN];
};

#define MDT_SERVICE_WATCHDOG_FACTOR	(2)
#define MDT_COS_DEFAULT         (0)

#define ENOENT_VERSION 1	/** 'virtual' version of non-existent object */

struct mdt_object {
	struct lu_object_header	mot_header;
	struct lu_object	mot_obj;
	unsigned int		mot_lov_created:1,  /* lov object created */
				mot_cache_attr:1,   /* enable remote object
						     * attribute cache */
				mot_restriping:1,   /* dir restriping */
				/* dir auto-split disabled */
				mot_auto_split_disabled:1,
				mot_lsom_inited:1, /* lsom was inited */
				mot_discard_done:1; /* discard lock was sent */
	int			mot_write_count;
	spinlock_t		mot_write_lock;
	/* Lock to protect create_data */
	struct mutex		mot_lov_mutex;
	/* Lock to protect object's SOM update. */
	struct mutex		mot_som_mutex;
	__u64			mot_lsom_size;
	__u64			mot_lsom_blocks;
	/* lock to protect read/write stages for Data-on-MDT files */
	struct rw_semaphore	mot_dom_sem;
	/* Lock to protect lease open.
	 * Lease open acquires write lock; normal open acquires read lock
	 */
	struct rw_semaphore	mot_open_sem;
	atomic_t		mot_lease_count;
	atomic_t		mot_open_count;
	/* directory offset, used in sub file migration in dir restripe */
	loff_t			mot_restripe_offset;
	/* link to mdt_restriper auto_splitting/migrating/updating */
	struct list_head	mot_restripe_linkage;
};

struct mdt_lock_handle {
	/* Lock type, reg for cross-ref use or pdo lock. */
	mdl_type_t		mlh_type;

	/* Regular lock */
	struct lustre_handle	mlh_reg_lh;
	enum ldlm_mode		mlh_reg_mode;
	__u64			mlh_gid;

	/* Pdirops lock */
	struct lustre_handle	mlh_pdo_lh;
	enum ldlm_mode		mlh_pdo_mode;
	unsigned int		mlh_pdo_hash;
	unsigned int		mlh_pdo_remote:1;

	/* Remote regular lock */
	struct lustre_handle	mlh_rreg_lh;
	enum ldlm_mode		mlh_rreg_mode;
};

enum {
	MDT_LH_PARENT,	/* parent lockh */
	MDT_LH_CHILD,	/* child lockh */
	MDT_LH_OLD,	/* old lockh for rename */
	MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
	MDT_LH_NEW,	/* new lockh for rename */
	MDT_LH_RMT,	/* used for return lh to caller */
	MDT_LH_LOCAL,	/* local lock never return to client */
	MDT_LH_LOOKUP,	/* lookup lock for source object in rename/migrate if
			 * it's remote object */
	MDT_LH_NR
};

enum {
	MDT_LOCAL_LOCK,
	MDT_CROSS_LOCK
};

/* Special magical errno for communicaiton between mdt_reint_open()
 * and mdt_intent_reint() which means return the lock to the client
 * for subsequent cross ref open. Previously we used plain -EREMOTE
 * but other functions called in that path might return it too and
 * confuse us. This is not returned to the client. See LU-5370.
 */
#define MDT_EREMOTE_OPEN (EREMOTE + 1024)

struct mdt_reint_record {
	enum mds_reint_op		 rr_opcode;
	const struct lustre_handle	*rr_open_handle;
	const struct lustre_handle	*rr_lease_handle;
	const struct lu_fid		*rr_fid1;
	const struct lu_fid		*rr_fid2;
	struct lu_name			 rr_name;
	struct lu_name			 rr_tgt_name;
	void				*rr_eadata;
	int				 rr_eadatalen;
	__u32				 rr_flags;
	__u16				 rr_mirror_id;
};

enum mdt_reint_flag {
	MRF_OPEN_TRUNC = BIT(0),
	MRF_OPEN_RESEND = BIT(1),
};

/*
 * Common data shared by mdt-level handlers. This is allocated per-thread to
 * reduce stack consumption.
 */
struct mdt_thread_info {
	/*
	 * XXX: Part One:
	 * The following members will be filled explicitly
	 * with specific data in mdt_thread_info_init().
	 */
	/* TODO: move this into mdt_session_key(with LCT_SESSION), because
	 * request handling may migrate from one server thread to another.
	 */
	struct req_capsule        *mti_pill;

	/* SUB request pill in a batch request. */
	struct req_capsule	    mti_sub_pill;

	/* although we have export in req, there are cases when it is not
	 * available, e.g. closing files upon export destroy
	 */
	struct obd_export          *mti_exp;
	/* A couple of lock handles. */
	struct mdt_lock_handle     mti_lh[MDT_LH_NR];

	struct mdt_device         *mti_mdt;
	const struct lu_env       *mti_env;

	/* transaction number of current request */
	__u64                      mti_transno;

	/*
	 * XXX: Part Two:
	 * The following members will be filled expilictly
	 * with zero in mdt_thread_info_init(). These members may be used
	 * by all requests.
	 */

	/* Object attributes. */
	struct md_attr             mti_attr;
	struct md_attr             mti_attr2; /* mdt_lvb.c */
	/* Body for "habeo corpus" operations. */
	const struct mdt_body     *mti_body;
	/* Host object. This is released at the end of mdt_handler(). */
	struct mdt_object         *mti_object;
	/*
	 * Lock request for "habeo clavis" operations.
	 */
	const struct ldlm_request *mti_dlm_req;

	__u32                      mti_cross_ref:1,
	/* big_lmm buffer was used and must be used in reply */
				   mti_big_lov_used:1,
				   mti_big_lmv_used:1,
				   mti_big_acl_used:1,
				   mti_som_strict:1,
	/* Batch processing environment */
				   mti_batch_env:1,
				   mti_intent_lock:1;

	/* opdata for mdt_reint_open(), has the same as
	 * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
	 * value onto disk for recovery when mdt_trans_stop_cb() is called.
	 */
	__u64                      mti_opdata;

	/*
	 * XXX: Part Three:
	 * The following members will be filled explicitly
	 * with zero in mdt_reint_unpack(), because they are only used
	 * by reint requests (including mdt_reint_open()).
	 */

	/* reint record. contains information for reint operations. */
	struct mdt_reint_record    mti_rr;

	__u64                      mti_ver[PTLRPC_NUM_VERSIONS];
	/* Operation specification (currently create and lookup) */
	struct md_op_spec          mti_spec;

	/*
	 * XXX: Part Four:
	 * The following members will _NOT_ be initialized at all.
	 * DO NOT expect them to contain any valid value.
	 * They should be initialized explicitly by the user themselves.
	 */

	/* XXX: If something is in a union, make sure they do not conflict */
	struct lu_fid			mti_tmp_fid1;
	struct lu_fid			mti_tmp_fid2;
	union ldlm_policy_data		mti_policy; /* for mdt_object_lock() */
	struct ldlm_res_id		mti_res_id; /* and mdt_rename_lock() */
	union {
		struct obd_uuid		uuid[2];    /* for mdt_seq_init_cli() */
		char			ns_name[48];/* for mdt_init0()        */
		struct lustre_cfg_bufs	bufs;       /* for mdt_stack_fini()   */
		struct obd_statfs	osfs;       /* for mdt_statfs()       */
		struct {
			/* for mdt_readpage()      */
			struct lu_rdpg     mti_rdpg;
		} rdpg;
		struct {
			struct md_attr attr;
		} hsm;
		struct {
			struct md_attr attr;
		} som;
	} mti_u;

	struct lustre_handle	   mti_open_handle;
	loff_t			   mti_off;
	struct lu_buf		   mti_buf;
	struct lu_buf		   mti_big_buf;

	/* Ops object filename */
	struct lu_name             mti_name;
	char			   mti_filename[NAME_MAX + 1];
	/* per-thread values, can be re-used, may be vmalloc'd */
	void			  *mti_big_lov;  /* was _lmm */
	void			  *mti_big_lmv;
	void			  *mti_big_acl;
	int			   mti_big_lovsize;
	int			   mti_big_lmvsize;
	int			   mti_big_aclsize;
	/* should be enough to fit lustre_mdt_attrs */
	char			   mti_xattr_buf[128];
	struct ldlm_enqueue_info   mti_einfo;
	/* einfo used by mdt_remote_object_lock_try() */
	struct ldlm_enqueue_info   mti_remote_einfo;
	struct tg_reply_data	  *mti_reply_data;

	/* FLR: layout change API */
	struct md_layout_change	   mti_mlc;

	struct lu_seq_range	   mti_range;
};

extern struct lu_context_key mdt_thread_key;

static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
{
	return lu_env_info_get(env, &mdt_thread_key);
}

struct cdt_req_progress {
	spinlock_t		 crp_lock;	/**< protect tree */
	struct rb_root_cached	 crp_root;	/**< tree to track extent
						 *   moved */
	__u64			 crp_total;
};

struct cdt_agent_req {
	struct hlist_node	 car_cookie_hash;  /**< find req by cookie */
	struct list_head	 car_request_list; /**< to chain all the req. */
	struct list_head	 car_scan_list;    /**< list for scan process */
	struct kref		 car_refcount;     /**< reference counter */
	struct obd_uuid		 car_uuid;         /**< agent doing the req. */
	struct hsm_mem_req_rec	*car_hmm;	   /**< llog rec with cookies */
	struct cdt_req_progress	 car_progress;     /**< track data mvt
						    *   progress */
	struct cdt_agent_req *car_cancel;	   /**< corresponding cancel */
};
#define car_flags	car_hmm->mr_rec.arr_flags /**< request original flags */
#define car_archive_id	car_hmm->mr_rec.arr_archive_id /**< archive id */
#define car_req_update	car_hmm->mr_rec.arr_req_change /**< last update time */
#define car_hai		car_hmm->mr_rec.arr_hai /**< req. to the agent */

extern struct kmem_cache *mdt_hsm_car_kmem;

struct hsm_agent {
	struct list_head ha_list;		/* to chain the agents */
	struct obd_uuid	 ha_uuid;		/* agent uuid */
	__u32		*ha_archive_id;		/* archive id */
	int		 ha_archive_cnt;	/* number of archive entries
						 *   0 means any archive */
	atomic_t	 ha_requests;		/* current request count */
	atomic_t	 ha_success;		/* num of successful actions */
	atomic_t	 ha_failure;		/* number of failed actions */
};

struct cdt_restore_handle {
	struct rhash_head	crh_hash;	/**< link to cdt_restore_hash */
	struct lu_fid		crh_fid;	/**< fid of the object */
	struct ldlm_extent	crh_extent;	/**< extent of the restore */
	struct mdt_lock_handle	crh_lh;		/**< lock handle */
	atomic_t		crh_refc;	/**< crh ref counter */
	struct rcu_head		crh_rcu;	/**< crh rcu head */
};
extern struct kmem_cache *mdt_hsm_cdt_kmem;	/** restore handle slab cache */

struct hsm_record_update {
	__u64 cookie;
	enum agent_req_status status;
};

struct hsm_mem_req_rec {
	struct llog_logid mr_lid;
	u64 mr_offset;
	struct llog_agent_req_rec mr_rec;
};

/**
 * data passed to llog_cat_process() callback
 * to scan requests and take actions
 */
struct hsm_scan_request {
	struct list_head hsr_cars;
	char *hsr_fsname;
	int hsr_used_sz;
	u32 hsr_version;
	u32 hsr_count;
};

static inline u32 hsr_get_archive_id(struct hsm_scan_request *rq)
{
	struct cdt_agent_req *car;

	if (rq->hsr_count > 0) {
		car = list_first_entry(&rq->hsr_cars, struct cdt_agent_req,
				       car_scan_list);

		return car->car_archive_id;
	}
	return 0;
}

static inline
const struct md_device_operations *mdt_child_ops(struct mdt_device *m)
{
	LASSERT(m->mdt_child);
	return m->mdt_child->md_ops;
}

static inline struct md_object *mdt_object_child(struct mdt_object *o)
{
	LASSERT(o);
	return lu2md(lu_object_next(&o->mot_obj));
}

static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
{
	return info->mti_pill ? info->mti_pill->rc_req : NULL;
}

static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
{
	LASSERT(info->mti_exp);
	return exp_connect_flags(info->mti_exp);
}

static inline void mdt_object_get(const struct lu_env *env,
				  struct mdt_object *o)
{
	ENTRY;
	lu_object_get(&o->mot_obj);
	EXIT;
}

static inline void mdt_object_put(const struct lu_env *env,
				  struct mdt_object *o)
{
	ENTRY;
	lu_object_put(env, &o->mot_obj);
	EXIT;
}

static inline int mdt_object_exists(const struct mdt_object *o)
{
	return lu_object_exists(&o->mot_obj);
}

static inline int mdt_object_remote(const struct mdt_object *o)
{
	return lu_object_remote(&o->mot_obj);
}

int mdt_object_striped(struct mdt_thread_info *mti, struct mdt_object *obj);

static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
{
	return lu_object_fid(&o->mot_obj);
}

static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
{
	return mdt->mdt_lu_dev.ld_site;
}

static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
{
	return &mdt->mdt_seq_site;
}

static inline u32 mdt_node_id(const struct mdt_device *mdt)
{
	return mdt->mdt_seq_site.ss_node_id;
}

static inline void mdt_export_evict(struct obd_export *exp)
{
	class_fail_export(exp);
}

/* Here we use LVB_TYPE to check dne client, because it is
 * also landed on 2.4.
 */
static inline bool mdt_is_dne_client(struct obd_export *exp)
{
	return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
}

static inline bool mdt_is_striped_client(struct obd_export *exp)
{
	return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
}

__u32 mdt_lmm_dom_entry_check(struct lov_mds_md *lmm, int *dom_only);

static inline bool mdt_lmm_dom_only(struct lov_mds_md *lmm)
{
	int dom_only = 0;

	mdt_lmm_dom_entry_check(lmm, &dom_only);
	return dom_only;
}

static inline __u32 mdt_lmm_dom_stripesize(struct lov_mds_md *lmm)
{
	return mdt_lmm_dom_entry_check(lmm, NULL);
}

static inline bool mdt_lmm_is_flr(struct lov_mds_md *lmm)
{
	struct lov_comp_md_v1 *lcm = (typeof(lcm))lmm;

	return le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1 &&
	       le16_to_cpu(lcm->lcm_mirror_count) > 0;
}

static inline bool lmm_is_overstriping(struct lov_mds_md *lmm)
{
	if (le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_V1 ||
	    le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_V3)
		return le16_to_cpu(lmm->lmm_pattern) & LOV_PATTERN_OVERSTRIPING;

	return false;
}

static inline bool mdt_lmm_comp_overstriping(struct lov_mds_md *lmm)
{
	struct lov_comp_md_v1 *comp_v1;
	struct lov_mds_md *v1;
	__u32 off;
	int i;

	comp_v1 = (struct lov_comp_md_v1 *)lmm;

	for (i = 0; i < le16_to_cpu(comp_v1->lcm_entry_count); i++) {
		off = le32_to_cpu(comp_v1->lcm_entries[i].lcme_offset);
		v1 = (struct lov_mds_md *)((char *)comp_v1 + off);

		if (lmm_is_overstriping(v1))
			return true;
	}

	return false;
}

static inline bool mdt_lmm_is_overstriping(struct lov_mds_md *lmm)
{
	if (le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1)
		return mdt_lmm_comp_overstriping(lmm);

	return lmm_is_overstriping(lmm);
}

static inline bool mdt_is_sum_statfs_client(struct obd_export *exp)
{
	return exp_connect_flags(exp) & OBD_CONNECT_FLAGS2 &&
	       exp_connect_flags2(exp) & OBD_CONNECT2_SUM_STATFS;
}

__u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
void mdt_set_disposition(struct mdt_thread_info *info,
			 struct ldlm_reply *rep, __u64 op_flag);
void mdt_clear_disposition(struct mdt_thread_info *info,
			   struct ldlm_reply *rep, __u64 op_flag);

void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
		       const struct lu_name *lname);

void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
void mdt_lh_reg_init(struct mdt_lock_handle *lh, struct ldlm_lock *lock);

int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
		   struct mdt_lock_handle *lh);

int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
			  struct mdt_lock_handle *lhc);

int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *obj,
		    struct mdt_lock_handle *lh, enum mds_ibits_locks ibits,
		    enum ldlm_mode mode);
int mdt_parent_lock(struct mdt_thread_info *info, struct mdt_object *o,
		    struct mdt_lock_handle *lh, const struct lu_name *lname,
		    enum ldlm_mode mode);
int mdt_object_stripes_lock(struct mdt_thread_info *info,
			    struct mdt_object *pobj, struct mdt_object *o,
			    struct mdt_lock_handle *lh,
			    struct ldlm_enqueue_info *einfo,
			    enum mds_ibits_locks ibits,
			    enum ldlm_mode mode);
int mdt_object_check_lock(struct mdt_thread_info *info,
			  struct mdt_object *parent, struct mdt_object *child,
			  struct mdt_lock_handle *lh,
			  enum mds_ibits_locks ibits, enum ldlm_mode mode);
int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
			struct mdt_lock_handle *lh,
			enum mds_ibits_locks *ibits,
			enum mds_ibits_locks trybits, enum ldlm_mode mode);

/* below three lock functions are used internally */
int mdt_object_lock_internal(struct mdt_thread_info *info,
			     struct mdt_object *obj, const struct lu_fid *fid,
			     struct mdt_lock_handle *lh,
			     enum mds_ibits_locks *ibits,
			     enum mds_ibits_locks trybits,
			     bool cache);
int mdt_object_pdo_lock(struct mdt_thread_info *info, struct mdt_object *obj,
			struct mdt_lock_handle *lh, const struct lu_name *name,
			enum ldlm_mode mode, bool pdo_lock);
int mdt_object_lookup_lock(struct mdt_thread_info *info,
			   struct mdt_object *pobj, struct mdt_object *obj,
			   struct mdt_lock_handle *lh, enum ldlm_mode mode);

void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
		       struct mdt_lock_handle *lh, int decref);
void mdt_object_stripes_unlock(struct mdt_thread_info *info,
			       struct mdt_object *o, struct mdt_lock_handle *lh,
			       struct ldlm_enqueue_info *einfo, int decref);

struct mdt_object *mdt_object_new(const struct lu_env *env,
				  struct mdt_device *mdt,
				  const struct lu_fid *fid);
struct mdt_object *mdt_object_find(const struct lu_env *env,
				   struct mdt_device *mdt,
				   const struct lu_fid *fid);
struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *info,
					const struct lu_fid *f,
					struct mdt_lock_handle *lh,
					enum mds_ibits_locks ibits,
					enum ldlm_mode mode);
void mdt_object_unlock_put(struct mdt_thread_info *info,
			   struct mdt_object *o,
			   struct mdt_lock_handle *lh,
			   int decref);

void mdt_client_compatibility(struct mdt_thread_info *info);

enum mdt_name_flags {
	MNF_FIX_ANON = 1,
};

int mdt_name_unpack(struct req_capsule *pill,
		    const struct req_msg_field *field,
		    struct lu_name *ln,
		    enum mdt_name_flags flags);
int mdt_close_unpack(struct mdt_thread_info *info);
int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
int mdt_reint_rec(struct mdt_thread_info *info, struct mdt_lock_handle *lh);
#ifdef CONFIG_LUSTRE_FS_POSIX_ACL
int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
		      struct mdt_object *o, struct lu_nodemap *nodemap);
#endif
void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
			const struct lu_attr *attr, const struct lu_fid *fid);
int mdt_pack_size2body(struct mdt_thread_info *info,
			const struct lu_fid *fid,  struct lustre_handle *lh);
int mdt_getxattr(struct mdt_thread_info *info);
int mdt_reint_setxattr(struct mdt_thread_info *info,
		       struct mdt_lock_handle *lh);

void mdt_reconstruct(struct mdt_thread_info *info, struct mdt_lock_handle *lh);
void mdt_reconstruct_generic(struct mdt_thread_info *mti,
			     struct mdt_lock_handle *lhc);

int mdt_export_stats_init(struct obd_device *obd, struct obd_export *exp,
			  void *client_nid);

int mdt_lock_new_child(struct mdt_thread_info *info,
		       struct mdt_object *o,
		       struct mdt_lock_handle *child_lockh);
void mdt_mfd_set_mode(struct mdt_file_data *mfd, enum mds_open_flags o_flags);
int mdt_reint_open(struct mdt_thread_info *info, struct mdt_lock_handle *lhc);
struct mdt_file_data *mdt_open_handle2mfd(struct mdt_export_data *med,
					const struct lustre_handle *open_handle,
					bool is_replay);
int mdt_revoke_remote_lookup_lock(struct mdt_thread_info *info,
				  struct mdt_object *pobj,
				  struct mdt_object *obj);

int mdt_get_info(struct tgt_session_info *tsi);
int mdt_attr_get_complex(struct mdt_thread_info *info,
			 struct mdt_object *o, struct md_attr *ma);
int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
		      const char *name);
int __mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
		     struct md_attr *ma, const char *name);
int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
		   struct md_attr *ma, const char *name);
int mdt_attr_get_pfid(struct mdt_thread_info *info, struct mdt_object *o,
		      struct lu_fid *pfid);
int mdt_attr_get_pfid_name(struct mdt_thread_info *info, struct mdt_object *o,
			   struct lu_fid *pfid, struct lu_name *lname);
int mdt_write_get(struct mdt_object *o);
void mdt_write_put(struct mdt_object *o);
int mdt_write_read(struct mdt_object *o);
struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
void mdt_mfd_free(struct mdt_file_data *mfd);
int mdt_close(struct tgt_session_info *tsi);
int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
			struct md_attr *ma);
int mdt_fix_reply(struct mdt_thread_info *info);
int mdt_handle_last_unlink(struct mdt_thread_info *info, struct mdt_object *dir,
			   struct md_attr *attr);
void mdt_reconstruct_open(struct mdt_thread_info *info,
			  struct mdt_lock_handle *lh);
int mdt_layout_change(struct mdt_thread_info *info, struct mdt_object *obj,
		      struct mdt_lock_handle *lhc,
		      struct md_layout_change *spec);
int find_name_matching_hash(struct mdt_thread_info *info, struct lu_name *lname,
			   struct mdt_object *parent, struct mdt_object *child);
int mdt_device_sync(const struct lu_env *env, struct mdt_device *mdt);

void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);

bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
int mdt_check_ucred(struct mdt_thread_info *info);
int mdt_init_ucred(struct mdt_thread_info *info, struct mdt_body *body);
int mdt_init_ucred_reint(struct mdt_thread_info *info);
void mdt_exit_ucred(struct mdt_thread_info *info);
bool mdt_enable_gid_deny(struct lu_ucred *uc, unsigned int cap, gid_t need_gid);
int mdt_check_resource_ids(struct mdt_thread_info *info,
			   struct mdt_object *obj);
int mdt_version_get_check(struct mdt_thread_info *info, struct mdt_object *mto,
			  int idx);
void mdt_version_get_save(struct mdt_thread_info *info, struct mdt_object *mto,
			  int idx);
int mdt_version_get_check_save(struct mdt_thread_info *info,
			       struct mdt_object *mto, int index);
int mdt_lookup_version_check(struct mdt_thread_info *info,
			     struct mdt_object *p,
			     const struct lu_name *lname,
			     struct lu_fid *fid, int idx);
void mdt_thread_info_reset(struct mdt_thread_info *info);
void mdt_thread_info_init(struct ptlrpc_request *req,
			  struct mdt_thread_info *mti);
void mdt_thread_info_fini(struct mdt_thread_info *mti);
struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
void mdt_intent_fixup_resent(struct mdt_thread_info *info,
			     struct ldlm_lock *new_lock,
			     struct mdt_lock_handle *lh, __u64 flags);
int mdt_intent_lock_replace(struct mdt_thread_info *info,
			    struct ldlm_lock **lockp,
			    struct mdt_lock_handle *lh,
			    __u64 flags, int result);

int hsm_init_ucred(struct lu_ucred *uc);
int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
		     const struct md_hsm *mh);

int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
			    void *data, int flag);
int mdt_links_read(struct mdt_thread_info *info,
		   struct mdt_object *mdt_obj,
		   struct linkea_data *ldata);
int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
		       struct mdt_body *repbody);
int mdt_pack_secctx_in_reply(struct mdt_thread_info *info,
			     struct mdt_object *child);
int mdt_pack_encctx_in_reply(struct mdt_thread_info *info,
			     struct mdt_object *child);
void mdt_prep_ma_buf_from_rep(struct mdt_thread_info *info,
			      struct mdt_object *obj, struct md_attr *ma,
			      enum mds_open_flags open_flags);


static inline struct mdt_device *mdt_dev(struct lu_device *d)
{
	return container_of_safe(d, struct mdt_device, mdt_lu_dev);
}

static inline struct mdt_object *mdt_obj(struct lu_object *o)
{
	return container_of_safe(o, struct mdt_object, mot_obj);
}

static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
{
	struct lu_object	*lo;
	struct mdt_device	*mdt = mdt_dev(mo->mot_obj.lo_dev);

	lo = lu_object_locate(mo->mot_obj.lo_header,
			      mdt->mdt_bottom->dd_lu_dev.ld_type);

	return lu2dt(lo);
}

static inline bool agent_req_in_final_state(enum agent_req_status ars)
{
	return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
		(ars == ARS_CANCELED));
}

/* mdt/mdt_identity.c */
#define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
#define UC_IDCACHE_HASH_SIZE 128
extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;

struct md_identity *mdt_identity_get(struct upcall_cache *cache, __u32 uid,
				     struct mdt_thread_info *info);

void mdt_identity_put(struct upcall_cache *cache, struct md_identity *identity);

void mdt_flush_identity(struct upcall_cache *cache, int uid);

__u32 mdt_identity_get_perm(struct md_identity *identity, struct lnet_nid *nid);

/* mdt/mdt_recovery.c */
__u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);

/* mdt/mdt_batch.c */
int mdt_batch(struct tgt_session_info *tsi);

/* mdt/mdt_hsm.c */
int mdt_hsm_state_get(struct tgt_session_info *tsi);
int mdt_hsm_state_set(struct tgt_session_info *tsi);
int mdt_hsm_action(struct tgt_session_info *tsi);
int mdt_hsm_progress(struct tgt_session_info *tsi);
int mdt_hsm_ct_register(struct tgt_session_info *tsi);
int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
int mdt_hsm_request(struct tgt_session_info *tsi);
int mdt_hsm_data_version(struct tgt_session_info *tsi);

/* mdt/mdt_hsm_cdt_actions.c */
extern const struct file_operations mdt_hsm_actions_fops;
void dump_llog_agent_req_rec(const char *prefix,
			     const struct llog_agent_req_rec *larr);
int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
		     llog_cb_t cb, void *data, u32 start_cat_idx,
		     u32 start_rec_idx);
int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
			 __u32 archive_id, __u64 flags,
			 struct hsm_action_item *hai);
int mdt_hsm_agent_modify_record(const struct lu_env *env,
				struct mdt_device *mdt,
				struct hsm_mem_req_rec *hmm);
/* mdt/mdt_hsm_cdt_agent.c */
extern const struct file_operations mdt_hsm_agent_fops;
int mdt_hsm_agent_register(struct mdt_thread_info *info,
			   const struct obd_uuid *uuid,
			   int nr_archives, __u32 *archive_num);
int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
				const struct obd_uuid *uuid,
				__u32 archive_mask);
int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
			     const struct obd_uuid *uuid);
int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
				    int succ_rq, int fail_rq, int new_rq,
				    const struct obd_uuid *uuid);
int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
			    struct obd_uuid *uuid);
int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_scan_request *rq,
		       bool purge);
/* mdt/mdt_hsm_cdt_client.c */
int mdt_hsm_add_actions(struct mdt_thread_info *info,
			struct hsm_action_list *hal);
int mdt_hsm_get_action(struct mdt_thread_info *mti,
		       const struct lu_fid *fid,
		       enum hsm_copytool_action *action,
		       enum agent_req_status *status,
		       struct hsm_extent *extent);
bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
				const struct lu_fid *fid);
/* mdt/mdt_hsm_cdt_requests.c */
extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
extern const struct file_operations mdt_hsm_active_requests_fops;
void __maybe_unused dump_requests(char *prefix, struct coordinator *cdt);
struct cdt_agent_req *mdt_cdt_alloc_request(struct obd_uuid *uuid,
					    struct llog_agent_req_rec *rec);
void mdt_cdt_free_request(struct cdt_agent_req *car);
int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
void mdt_cdt_get_request(struct cdt_agent_req *car);
void mdt_cdt_put_request(struct cdt_agent_req *car);
struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
					 const struct hsm_progress_kernel *pgs);
int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
/* mdt/mdt_coordinator.c */
void mdt_hsm_dump_hal(int level, const char *prefix,
		      struct hsm_action_list *hal);
int cdt_restore_handle_add(struct mdt_thread_info *mti, struct coordinator *cdt,
			   const struct lu_fid *fid,
			   const struct hsm_extent *he);
bool cdt_restore_handle_exists(struct coordinator *cdt,
						   const struct lu_fid *fid);
void cdt_restore_handle_del(struct mdt_thread_info *mti,
			    struct coordinator *cdt, const struct lu_fid *fid);
int cdt_getref_try(struct coordinator *cdt);
void cdt_putref(struct coordinator *cdt);
/* coordinator management */
int mdt_hsm_cdt_init(struct mdt_device *mdt);
int mdt_hsm_cdt_stop(struct mdt_device *mdt);
int mdt_hsm_cdt_fini(struct mdt_device *mdt);

/*
 * Signal the coordinator has work to do
 * \param cdt [IN] coordinator
 */
static inline void mdt_hsm_cdt_event(struct coordinator *cdt)
{
	cdt->cdt_event = true;
}

/* coordinator control sysfs interface */
ssize_t hsm_control_show(struct kobject *kobj, struct attribute *attr,
			 char *buf);
ssize_t hsm_control_store(struct kobject *kobj, struct attribute *attr,
			  const char *buffer, size_t count);
int hsm_cdt_tunables_init(struct mdt_device *mdt);
void hsm_cdt_tunables_fini(struct mdt_device *mdt);
/* md_hsm helpers */
struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
				      const struct lu_fid *fid,
				      struct md_hsm *hsm);
/* actions/request helpers */
int mdt_hsm_add_hsr(struct mdt_thread_info *mti, struct hsm_scan_request *hsr,
		    struct obd_uuid *uuid);
bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
			      u32 archive_id, u64 rq_flags,
			      const struct md_hsm *hsm);
int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
				 struct hsm_progress_kernel *pgs);

extern struct lu_context_key       mdt_thread_key;

/* debug issues helper starts here*/
static inline int mdt_fail_write(const struct lu_env *env,
				 struct dt_device *dd, int id)
{
	if (CFS_FAIL_CHECK_ORSET(id, CFS_FAIL_ONCE)) {
		CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
		       id);
		return dt_ro(env, dd);
		/* We set FAIL_ONCE because we never "un-fail" a device */
	}

	return 0;
}

static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
{
	return &req->rq_export->exp_mdt_data;
}

static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
{
	return mdt_dev(exp->exp_obd->obd_lu_dev);
}

static inline bool mdt_rdonly(struct obd_export *exp)
{
	return (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
		mdt_exp2dev(exp)->mdt_bottom->dd_rdonly ||
		mdt_exp2dev(exp)->mdt_readonly);
}

typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
				  struct mdt_lock_handle *lhc);
static inline int mdt_check_resent(struct mdt_thread_info *info,
				   mdt_reconstruct_t reconstruct,
				   struct mdt_lock_handle *lhc)
{
	struct ptlrpc_request *req = mdt_info_req(info);
	int rc = 0;

	ENTRY;
	if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
		OBD_ALLOC_PTR(info->mti_reply_data);
		if (info->mti_reply_data == NULL)
			RETURN(-ENOMEM);

		rc = req_can_reconstruct(req, info->mti_reply_data);
		if (rc == 1) {
			reconstruct(info, lhc);
		} else {
			DEBUG_REQ(D_HA, req,
				  "no reply data found for RESENT req, rc = %d",
				  rc);
		}
		OBD_FREE_PTR(info->mti_reply_data);
		info->mti_reply_data = NULL;
	}
	RETURN(rc);
}

struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);

static inline int is_identity_get_disabled(struct upcall_cache *cache)
{
	return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
}

int mdt_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
		     void *data, int flag);

static int mdt_dom_glimpse_ast(struct ldlm_lock *lock, void *reqp)
{
	return -ELDLM_NO_LOCK_DATA;
}

/* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
static inline int mdt_fid_lock(const struct lu_env *env,
			       struct ldlm_namespace *ns,
			       struct lustre_handle *lh, enum ldlm_mode mode,
			       union ldlm_policy_data *policy,
			       const struct ldlm_res_id *res_id,
			       __u64 flags, const __u64 *client_cookie)
{
	int rc;
	bool glimpse = policy->l_inodebits.bits & MDS_INODELOCK_DOM;

	LASSERT(ns != NULL);
	LASSERT(lh != NULL);

	rc = ldlm_cli_enqueue_local(env, ns, res_id, LDLM_IBITS, policy,
				    mode, &flags, mdt_blocking_ast,
				    ldlm_completion_ast,
				    glimpse ? mdt_dom_glimpse_ast : NULL,
				    NULL, 0, LVB_T_NONE, client_cookie, lh);
	return rc == ELDLM_OK ? 0 : -EIO;
}

static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
{
	ldlm_lock_decref(lh, mode);
}

/* this is identical to say this is a DNE system */
static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
{
	return mdt->mdt_lut.lut_sync_lock_cancel == SYNC_LOCK_CANCEL_BLOCKING;
}

/* mdt_som.c */
int mdt_set_som(struct mdt_thread_info *info, struct mdt_object *obj,
		enum lustre_som_flags flag, __u64 size, __u64 blocks);
int mdt_get_som(struct mdt_thread_info *info, struct mdt_object *obj,
		struct md_attr *ma);
int mdt_lsom_downgrade(struct mdt_thread_info *info, struct mdt_object *obj);
int mdt_lsom_update(struct mdt_thread_info *info, struct mdt_object *obj,
		    bool truncate);

/* mdt_lvb.c */
extern struct ldlm_valblock_ops mdt_lvbo;
int mdt_dom_lvb_is_valid(struct ldlm_resource *res);
int mdt_dom_lvbo_update(struct ldlm_resource *res, struct ldlm_lock *lock,
			struct ptlrpc_request *req, bool increase_only);

void mdt_enable_cos(struct mdt_device *dev, bool enable);
int mdt_cos_is_enabled(struct mdt_device *mdt);

/* lprocfs stuff */
enum mdt_stat_idx {
	LPROC_MDT_OPEN,
	LPROC_MDT_CLOSE,
	LPROC_MDT_MKNOD,
	LPROC_MDT_LINK,
	LPROC_MDT_UNLINK,
	LPROC_MDT_MKDIR,
	LPROC_MDT_RMDIR,
	LPROC_MDT_RENAME,
	LPROC_MDT_GETATTR,
	LPROC_MDT_SETATTR,
	LPROC_MDT_GETXATTR,
	LPROC_MDT_SETXATTR,
	LPROC_MDT_STATFS,
	LPROC_MDT_SYNC,
	LPROC_MDT_RENAME_SAMEDIR,
	LPROC_MDT_RENAME_PAR_FILE,
	LPROC_MDT_RENAME_PAR_DIR,
	LPROC_MDT_RENAME_CROSSDIR,
	LPROC_MDT_RENAME_TRYLOCK,
	LPROC_MDT_IO_READ,
	LPROC_MDT_IO_WRITE,
	LPROC_MDT_IO_READ_BYTES,
	LPROC_MDT_IO_WRITE_BYTES,
	LPROC_MDT_IO_PUNCH,
	LPROC_MDT_MIGRATE,
	LPROC_MDT_FALLOCATE,
	LPROC_MDT_LAST,
};

void mdt_counter_incr(struct ptlrpc_request *req, int opcode, long amount);
void mdt_stats_counter_init(struct lprocfs_stats *stats, unsigned int offset,
			    enum lprocfs_counter_config cntr_umask);
int mdt_tunables_init(struct mdt_device *mdt, const char *name);
void mdt_tunables_fini(struct mdt_device *mdt);

/* lustre/mdt_mdt_lproc.c */
int ldebugfs_mdt_open_files_seq_open(struct inode *inode,
				     struct file *file);
void mdt_rename_counter_tally(struct mdt_thread_info *info,
			      struct mdt_device *mdt,
			      struct ptlrpc_request *req,
			      struct mdt_object *src, struct mdt_object *tgt,
			      enum mdt_stat_idx msi, s64 count);

static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
{
	return mdt->mdt_lu_dev.ld_obd;
}

extern const struct lu_device_operations mdt_lu_ops;

extern unsigned int mdt_enable_flr_ec;

static inline char *mdt_obd_name(struct mdt_device *mdt)
{
	return mdt->mdt_lu_dev.ld_obd->obd_name;
}

int mds_mod_init(void);
void mds_mod_exit(void);

static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
{
	struct obd_export	*exp = req->rq_export;
	char			*jobid = NULL;

	if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
		jobid = lustre_msg_get_jobid(req->rq_reqmsg);

	return jobid;
}

/* MDT IO */
#define VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
		     LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)

int mdt_obd_preprw(const struct lu_env *env, int cmd, struct obd_export *exp,
		   struct obdo *oa, int objcount, struct obd_ioobj *obj,
		   struct niobuf_remote *rnb, int *nr_local,
		   struct niobuf_local *lnb);

int mdt_obd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
		     struct obdo *oa, int objcount, struct obd_ioobj *obj,
		     struct niobuf_remote *rnb, int npages,
		     struct niobuf_local *lnb, int old_rc, int nob,
		     ktime_t kstart);
int mdt_punch_hdl(struct tgt_session_info *tsi);
int mdt_fallocate_hdl(struct tgt_session_info *tsi);
int mdt_fiemap_get(struct tgt_session_info *tsi);
int mdt_glimpse_enqueue(struct mdt_thread_info *mti, struct ldlm_namespace *ns,
			struct ldlm_lock **lockp, __u64 flags);
int mdt_brw_enqueue(struct mdt_thread_info *info, struct ldlm_namespace *ns,
		    struct ldlm_lock **lockp, __u64 flags);
int mdt_dom_read_on_open(struct mdt_thread_info *mti, struct mdt_device *mdt,
			 struct lustre_handle *lh);
void mdt_dom_discard_data(struct mdt_thread_info *info, struct mdt_object *mo);
int mdt_dom_disk_lvbo_update(const struct lu_env *env, struct mdt_object *mo,
			     struct ldlm_resource *res, bool increase_only);
void mdt_dom_obj_lvb_update(const struct lu_env *env, struct mdt_object *mo,
			    struct obdo *oa, bool increase_only);
int mdt_dom_lvb_alloc(struct ldlm_resource *res);

static inline bool mdt_dom_check_for_discard(struct mdt_thread_info *mti,
					     struct mdt_object *mo)
{
	return lu_object_is_dying(&mo->mot_header) &&
	       S_ISREG(lu_object_attr(&mo->mot_obj)) &&
	       !mo->mot_discard_done;
}

int mdt_dom_object_size(const struct lu_env *env, struct mdt_device *mdt,
			const struct lu_fid *fid, struct mdt_body *mb,
			bool dom_lock);
bool mdt_dom_client_has_lock(struct mdt_thread_info *info,
			     const struct lu_fid *fid);
void mdt_hp_brw(struct tgt_session_info *tsi);
void mdt_hp_punch(struct tgt_session_info *tsi);
int mdt_data_version_get(struct tgt_session_info *tsi);
int mdt_io_set_info(struct tgt_session_info *tsi);

/* grants */
long mdt_grant_connect(const struct lu_env *env, struct obd_export *exp,
		       u64 want, bool conservative);
extern struct kmem_cache *ldlm_glimpse_work_kmem;

static inline bool mdt_changelog_allow(struct mdt_thread_info *info,
				       struct obd_export *exp)
{
	struct lu_ucred *uc = NULL;
	bool is_admin;
	int rc;

	if (!info->mti_body)
#if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 2, 53, 0)
	{
		/* if client does not send mti_body, check nodemap directly */
		enum nodemap_rbac_roles rbac = NODEMAP_RBAC_ALL;
		struct lu_nodemap *nodemap;

		nodemap = nodemap_get_from_exp(exp);
		if (!IS_ERR_OR_NULL(nodemap)) {
			rbac = nodemap->nmf_rbac;
			nodemap_putref(nodemap);

		}
		return rbac & NODEMAP_RBAC_CHLG_OPS;
	}
#else
		return false;
#endif

	rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
	if (rc < 0)
		return false;

	uc = mdt_ucred(info);
	is_admin = (uc->uc_uid == 0 && uc->uc_gid == 0 &&
		    cap_raised(uc->uc_cap, CAP_SYS_ADMIN) &&
		    uc->uc_rbac_chlg_ops);

	mdt_exit_ucred(info);

	return is_admin;
}

/* We forbid operations from encryption-unaware clients if they try to
 * manipulate encrypted files/directories.
 */
static inline int mdt_check_enc(struct mdt_thread_info *info,
				struct mdt_object *obj)
{
	struct obd_export *exp;
	struct md_attr ma = { 0 };
	int rc = 0;

	if (!mdt_info_req(info))
		/* no req, so cannot tell about client connection flags:
		 * allow access
		 */
		return 0;
	exp = mdt_info_req(info)->rq_export;
	if (exp_connect_encrypt(exp))
		/* client is encryption aware: fine */
		return 0;

	ma.ma_need = MA_INODE;
	mdt_attr_get_complex(info, obj, &ma);
	if (ma.ma_attr.la_valid & LA_FLAGS &&
	    ma.ma_attr.la_flags & LUSTRE_ENCRYPT_FL)
		rc = -ENOKEY;

	if (rc)
		CDEBUG(D_SEC, "%s: operation on encrypted "DFID
		       " from encryption-unaware client %s: %d\n",
		       mdt_obd_name(info->mti_mdt),
		       PFID(lu_object_fid(&obj->mot_obj)),
		       libcfs_nidstr(&exp->exp_connection->c_peer.nid), rc);

	return rc;
}

int mdt_fids_different_target(struct mdt_thread_info *info,
			      const struct lu_fid *fid1,
			      const struct lu_fid *fid2);

int mdt_reint_migrate(struct mdt_thread_info *info,
		      struct mdt_lock_handle *unused);
int mdt_dir_layout_update(struct mdt_thread_info *info);

/* directory restripe */
int mdt_restripe_internal(struct mdt_thread_info *info,
			  struct mdt_object *parent,
			  struct mdt_object *child,
			  const struct lu_name *lname,
			  struct lu_fid *tfid,
			  struct md_op_spec *spec,
			  struct md_attr *ma);
int mdt_restriper_start(struct mdt_device *mdt);
void mdt_restriper_stop(struct mdt_device *mdt);
void mdt_auto_split_add(struct mdt_thread_info *info, struct mdt_object *o);
void mdt_restripe_migrate_add(struct mdt_thread_info *info,
			      struct mdt_object *o);
void mdt_restripe_update_add(struct mdt_thread_info *info,
			     struct mdt_object *o);
int mdt_is_remote_object(struct mdt_thread_info *info,
			 struct mdt_object *parent,
			 struct mdt_object *child);

static unsigned int max_mod_rpcs_per_client = OBD_MAX_RIF_DEFAULT;
#if OBD_OCD_VERSION(3, 0, 53, 0) > LUSTRE_VERSION_CODE
static inline bool mdt_max_mod_rpcs_changed(struct mdt_device *mdt)
{
	return max_mod_rpcs_per_client != OBD_MAX_RIF_DEFAULT &&
		mdt->mdt_max_mod_rpcs_in_flight == OBD_MAX_RIF_DEFAULT;
}
#else
#define mdt_max_mod_rpcs_changed(mdt) false
#endif

#endif /* _MDT_INTERNAL_H */
