/*
 * GPL HEADER START
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License version 2 for more details (a copy is included
 * in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; If not, see
 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 *
 * GPL HEADER END
 */
/*
 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2011, 2014, Intel Corporation.
 */
/*
 * This file is part of Lustre, http://www.lustre.org/
 * Lustre is a trademark of Sun Microsystems, Inc.
 *
 * lustre/mdd/mdd_internal.h
 *
 * Author: Wang Di <wangdi@clusterfs.com>
 */

#ifndef _MDD_INTERNAL_H
#define _MDD_INTERNAL_H

#include <lustre_acl.h>
#include <lustre_eacl.h>
#include <md_object.h>
#include <dt_object.h>
#include <lustre_lfsck.h>
#include <lustre_fid.h>
#include <lprocfs_status.h>
#include <lustre_log.h>
#include <lustre_linkea.h>

/* Changelog flags */
/** changelog is recording */
#define CLM_ON    0x00001
/** internal error prevented changelogs from starting */
#define CLM_ERR   0x00002
/* Marker flags */
/** changelogs turned on */
#define CLM_START 0x10000
/** changelogs turned off */
#define CLM_FINI  0x20000
/** some changelog records purged */
#define CLM_PURGE 0x40000

struct mdd_changelog {
	spinlock_t		mc_lock;	/* for index */
	int			mc_flags;
	int			mc_mask;
	__u64			mc_index;
	__u64			mc_starttime;
	spinlock_t		mc_user_lock;
	int			mc_lastuser;
};

static inline __u64 cl_time(void) {
	cfs_fs_time_t time;

	cfs_fs_time_current(&time);
	return (((__u64)time.tv_sec) << 30) + time.tv_nsec;
}

/** Objects in .lustre dir */
struct mdd_dot_lustre_objs {
	struct mdd_object *mdd_obf;
	struct mdd_object *mdd_lpf;
};

struct mdd_generic_thread {
	struct completion	mgt_started;
	struct completion	mgt_finished;
	void		       *mgt_data;
	bool			mgt_abort;
	bool			mgt_init;
};

struct mdd_device {
        struct md_device                 mdd_md_dev;
	struct obd_export               *mdd_child_exp;
        struct dt_device                *mdd_child;
	struct dt_device		*mdd_bottom;
	struct lu_fid                    mdd_root_fid; /* /ROOT */
	struct lu_fid			 mdd_local_root_fid;
        struct dt_device_param           mdd_dt_conf;
        struct dt_object                *mdd_orphans; /* PENDING directory */
	struct proc_dir_entry            *mdd_proc_entry;
        struct mdd_changelog             mdd_cl;
        unsigned long                    mdd_atime_diff;
        struct mdd_object               *mdd_dot_lustre;
        struct mdd_dot_lustre_objs       mdd_dot_lustre_objs;
	unsigned int			 mdd_sync_permission;
	int				 mdd_connects;
	struct local_oid_storage	*mdd_los;
	struct mdd_generic_thread	 mdd_orph_cleanup_thread;
};

enum mod_flags {
	/* The dir object has been unlinked */
	DEAD_OBJ   = 1 << 0,
	ORPHAN_OBJ = 1 << 1,
};

struct mdd_object {
        struct md_object   mod_obj;
        /* open count */
        __u32             mod_count;
        __u32             mod_valid;
        __u64             mod_cltime;
        unsigned long     mod_flags;
};

struct mdd_thread_info {
	struct lu_fid             mti_fid;
	struct lu_fid             mti_fid2; /* used for be & cpu converting */
	/**
	* only be used by MDD interfaces, can be passed into local MDD APIs.
	*/
	struct lu_attr            mti_pattr;
	struct lu_attr            mti_cattr;
	struct lu_attr            mti_tpattr;
	struct lu_attr            mti_tattr;
	/** used to set c/mtime */
	struct lu_attr            mti_la_for_fix;
	/* Only used in mdd_object_start */
	struct lu_attr		  mti_la_for_start;
	/* mti_ent and mti_key must be conjoint,
	* then mti_ent::lde_name will be mti_key. */
	struct lu_dirent	  mti_ent;
	char			  mti_key[NAME_MAX + 16];
	struct lu_buf             mti_buf[4];
	struct lu_buf             mti_big_buf; /* biggish persistent buf */
	struct lu_buf		  mti_link_buf; /* buf for link ea */
	struct obdo               mti_oa;
	char                      mti_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
	struct dt_allocation_hint mti_hint;
	struct dt_object_format   mti_dof;
	struct linkea_data	  mti_link_data;
	struct md_op_spec	  mti_spec;
	struct dt_insert_rec	  mti_dt_rec;
	struct lfsck_request	  mti_lr;
	struct lu_seq_range	  mti_range;
};

enum mdd_links_add_overflow {
	MLAO_IGNORE	= false,
	MLAO_CHECK	= true,
};

extern const char orph_index_name[];

int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
	       struct lu_attr *la);
int mdd_attr_get(const struct lu_env *env, struct md_object *obj,
		 struct md_attr *ma);
int mdd_attr_set(const struct lu_env *env, struct md_object *obj,
		 const struct md_attr *ma);
int mdd_attr_set_internal(const struct lu_env *env,
			  struct mdd_object *obj,
			  const struct lu_attr *attr,
			  struct thandle *handle,
			  int needacl);
int mdd_update_time(const struct lu_env *env, struct mdd_object *obj,
		    const struct lu_attr *oattr, struct lu_attr *attr,
		    struct thandle *handle);
int mdd_object_create_internal(const struct lu_env *env, struct mdd_object *p,
			       struct mdd_object *c, struct lu_attr *attr,
			       struct thandle *handle,
			       const struct md_op_spec *spec,
			       struct dt_allocation_hint *hint);

/* mdd_lock.c */
void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj,
                    enum mdd_object_role role);
void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj,
                   enum mdd_object_role role);
void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
int mdd_write_locked(const struct lu_env *env, struct mdd_object *obj);

/* mdd_dir.c */
int mdd_is_subdir(const struct lu_env *env, struct md_object *mo,
                  const struct lu_fid *fid, struct lu_fid *sfid);
int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
		   const struct lu_attr *pattr, struct mdd_object *cobj,
		   bool check_perm);
int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
		   const struct lu_attr *pattr, const struct lu_attr *attr);
int mdd_may_delete(const struct lu_env *env, struct mdd_object *tpobj,
		   const struct lu_attr *tpattr, struct mdd_object *tobj,
		   const struct lu_attr *tattr, const struct lu_attr *cattr,
		   int check_perm, int check_empty);
int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
			    const struct lu_attr *pattr,
			    struct mdd_object *cobj,
			    const struct lu_attr *cattr);
int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
		      struct md_attr *ma, const struct mdd_object *pobj,
		      const struct lu_name *lname, struct thandle *th);

int mdd_is_root(struct mdd_device *mdd, const struct lu_fid *fid);
int mdd_lookup(const struct lu_env *env,
               struct md_object *pobj, const struct lu_name *lname,
               struct lu_fid* fid, struct md_op_spec *spec);
int mdd_links_read(const struct lu_env *env, struct mdd_object *mdd_obj,
		   struct linkea_data *ldata);
int mdd_declare_links_add(const struct lu_env *env, struct mdd_object *mdd_obj,
			  struct thandle *handle, struct linkea_data *ldata,
			  enum mdd_links_add_overflow overflow);
int mdd_links_write(const struct lu_env *env, struct mdd_object *mdd_obj,
		    struct linkea_data *ldata, struct thandle *handle);
struct lu_buf *mdd_links_get(const struct lu_env *env,
                             struct mdd_object *mdd_obj);
int mdd_links_rename(const struct lu_env *env,
		     struct mdd_object *mdd_obj,
		     const struct lu_fid *oldpfid,
		     const struct lu_name *oldlname,
		     const struct lu_fid *newpfid,
		     const struct lu_name *newlname,
		     struct thandle *handle,
		     struct linkea_data *ldata,
		     int first, int check);

struct mdd_thread_info *mdd_env_info(const struct lu_env *env);

#define MDD_ENV_VAR(env, var) (&mdd_env_info(env)->mti_##var)

struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
                                       const void *area, ssize_t len);

int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
int __mdd_orphan_add(const struct lu_env *, struct mdd_object *,
                     struct thandle *);
int __mdd_orphan_del(const struct lu_env *, struct mdd_object *,
                     struct thandle *);
int orph_index_init(const struct lu_env *env, struct mdd_device *mdd);
void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd);
int orph_declare_index_insert(const struct lu_env *, struct mdd_object *,
			      umode_t mode, struct thandle *);
int orph_declare_index_delete(const struct lu_env *, struct mdd_object *,
                              struct thandle *);

/* mdd_lproc.c */
int mdd_procfs_init(struct mdd_device *mdd, const char *name);
void mdd_procfs_fini(struct mdd_device *mdd);

/* mdd_object.c */
extern struct kmem_cache *mdd_object_kmem;
extern const struct md_dir_operations    mdd_dir_ops;
extern const struct md_object_operations mdd_obj_ops;
int mdd_readlink(const struct lu_env *env, struct md_object *obj,
		 struct lu_buf *buf);
int accmode(const struct lu_env *env, const struct lu_attr *la, int flags);
extern struct lu_context_key mdd_thread_key;
extern const struct lu_device_operations mdd_lu_ops;

struct mdd_object *mdd_object_find(const struct lu_env *env,
                                   struct mdd_device *d,
                                   const struct lu_fid *f);
int mdd_readpage(const struct lu_env *env, struct md_object *obj,
                 const struct lu_rdpg *rdpg);
int mdd_declare_changelog_store(const struct lu_env *env,
				       struct mdd_device *mdd,
				       const struct lu_name *tname,
				       const struct lu_name *sname,
				       struct thandle *handle);
void mdd_changelog_rec_ext_jobid(struct changelog_rec *rec, const char *jobid);
int mdd_changelog_store(const struct lu_env *env, struct mdd_device *mdd,
			struct llog_changelog_rec *rec, struct thandle *th);
int mdd_changelog_data_store(const struct lu_env *env, struct mdd_device *mdd,
			     enum changelog_rec_type type, int flags,
			     struct mdd_object *mdd_obj,
			     struct thandle *handle);
int mdd_changelog_ns_store(const struct lu_env *env, struct mdd_device *mdd,
			   enum changelog_rec_type type,
			   enum changelog_rec_flags crf,
			   struct mdd_object *target,
			   const struct lu_fid *tpfid,
			   const struct lu_fid *sfid,
			   const struct lu_fid *spfid,
			   const struct lu_name *tname,
			   const struct lu_name *sname,
			   struct thandle *handle);
int mdd_declare_object_create_internal(const struct lu_env *env,
				       struct mdd_object *p,
				       struct mdd_object *c,
				       struct lu_attr *attr,
				       struct thandle *handle,
				       const struct md_op_spec *spec,
				       struct dt_allocation_hint *hint);
int mdd_get_lov_ea(const struct lu_env *env, struct mdd_object *obj,
		   struct lu_buf *lmm_buf);

/* mdd_trans.c */
void mdd_object_make_hint(const struct lu_env *env, struct mdd_object *parent,
			  struct mdd_object *child, const struct lu_attr *attr,
			  const struct md_op_spec *spec,
			  struct dt_allocation_hint *hint);

static inline void mdd_object_get(struct mdd_object *o)
{
	lu_object_get(&o->mod_obj.mo_lu);
}

static inline void mdd_object_put(const struct lu_env *env,
                                  struct mdd_object *o)
{
        lu_object_put(env, &o->mod_obj.mo_lu);
}

struct thandle *mdd_trans_create(const struct lu_env *env,
                                 struct mdd_device *mdd);
int mdd_trans_start(const struct lu_env *env, struct mdd_device *mdd,
                    struct thandle *th);
int mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
		   int rc, struct thandle *handle);

/* mdd_device.c */
struct lu_object *mdd_object_alloc(const struct lu_env *env,
                                   const struct lu_object_header *hdr,
                                   struct lu_device *d);
int mdd_local_file_create(const struct lu_env *env, struct mdd_device *mdd,
			  const struct lu_fid *pfid, const char *name,
			  __u32 mode, struct lu_fid *fid);

int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
                  struct thandle *handle);
int mdd_acl_set(const struct lu_env *env, struct mdd_object *obj,
		struct lu_attr *attr, const struct lu_buf *buf, int fl);
int __mdd_fix_mode_acl(const struct lu_env *env, struct lu_buf *buf,
		       __u32 *mode);
int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
			      const struct lu_attr *la, int mask, int role);
int mdd_permission(const struct lu_env *env,
                   struct md_object *pobj, struct md_object *cobj,
                   struct md_attr *ma, int mask);
int mdd_generic_thread_start(struct mdd_generic_thread *thread,
			     int (*func)(void *), void *data, char *name);
void mdd_generic_thread_stop(struct mdd_generic_thread *thread);

/* mdd_prepare.c */
int mdd_compat_fixes(const struct lu_env *env, struct mdd_device *mdd);

/* inline functions */
static inline int lu_device_is_mdd(struct lu_device *d)
{
        return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
}

static inline struct mdd_device* lu2mdd_dev(struct lu_device *d)
{
        LASSERT(lu_device_is_mdd(d));
        return container_of0(d, struct mdd_device, mdd_md_dev.md_lu_dev);
}

static inline struct lu_device *mdd2lu_dev(struct mdd_device *d)
{
        return (&d->mdd_md_dev.md_lu_dev);
}

static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
{
        LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
        return container_of0(o, struct mdd_object, mod_obj.mo_lu);
}

static inline struct mdd_device* mdo2mdd(struct md_object *mdo)
{
        return lu2mdd_dev(mdo->mo_lu.lo_dev);
}

static inline struct mdd_object* md2mdd_obj(struct md_object *mdo)
{
        return container_of0(mdo, struct mdd_object, mod_obj);
}

static inline const struct dt_device_operations *
mdd_child_ops(struct mdd_device *d)
{
        return d->mdd_child->dd_ops;
}

static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
{
        return &obj->mod_obj.mo_lu;
}

static inline struct dt_object* mdd_object_child(struct mdd_object *o)
{
        return container_of0(lu_object_next(mdd2lu_obj(o)),
                             struct dt_object, do_lu);
}

static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
{
	return (mdd->mdd_md_dev.md_lu_dev.ld_obd);
}

static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
{
        return mdo2mdd(&obj->mod_obj);
}

static inline const struct lu_fid *mdo2fid(const struct mdd_object *obj)
{
        return lu_object_fid(&obj->mod_obj.mo_lu);
}

static inline umode_t mdd_object_type(const struct mdd_object *obj)
{
        return lu_object_attr(&obj->mod_obj.mo_lu);
}

static inline int mdd_is_dead_obj(struct mdd_object *obj)
{
        return obj && obj->mod_flags & DEAD_OBJ;
}

static inline int mdd_object_exists(struct mdd_object *obj)
{
        return lu_object_exists(mdd2lu_obj(obj));
}

static inline int mdd_object_remote(struct mdd_object *obj)
{
	return lu_object_remote(mdd2lu_obj(obj));
}

static inline const struct lu_fid *mdd_object_fid(struct mdd_object *obj)
{
        return lu_object_fid(mdd2lu_obj(obj));
}

static inline struct seq_server_site *mdd_seq_site(struct mdd_device *mdd)
{
	return mdd2lu_dev(mdd)->ld_site->ld_seq_site;
}

static inline const char *mdd_obj_dev_name(const struct mdd_object *obj)
{
        return lu_dev_name(obj->mod_obj.mo_lu.lo_dev);
}

#define MAX_ATIME_DIFF 60

static inline int mdd_permission_internal(const struct lu_env *env,
					  struct mdd_object *obj,
					  const struct lu_attr *la, int mask)
{
	return __mdd_permission_internal(env, obj, la, mask, -1);
}

static inline int mdd_permission_internal_locked(const struct lu_env *env,
						struct mdd_object *obj,
						const struct lu_attr *la,
						int mask,
						enum mdd_object_role role)
{
	return __mdd_permission_internal(env, obj, la, mask, role);
}

/* mdd inline func for calling osd_dt_object ops */
static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
			       struct lu_attr *la)
{
	struct dt_object *next = mdd_object_child(obj);
	return dt_attr_get(env, next, la);
}

static inline int mdo_declare_attr_set(const struct lu_env *env,
                                       struct mdd_object *obj,
                                       const struct lu_attr *la,
                                       struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(obj);
        return dt_declare_attr_set(env, next, la, handle);
}

static inline int mdo_attr_set(const struct lu_env *env,
			       struct mdd_object *obj,
			       const struct lu_attr *la,
			       struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(obj);

	if (!mdd_object_exists(obj))
		return -ENOENT;

	return dt_attr_set(env, next, la, handle);
}

static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
				struct lu_buf *buf, const char *name)
{
	struct dt_object *next = mdd_object_child(obj);
	return dt_xattr_get(env, next, buf, name);
}

static inline int mdo_declare_xattr_set(const struct lu_env *env,
                                        struct mdd_object *obj,
                                        const struct lu_buf *buf,
                                        const char *name,
                                        int fl, struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(obj);
        return dt_declare_xattr_set(env, next, buf, name, fl, handle);
}

static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
				const struct lu_buf *buf, const char *name,
				int fl, struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(obj);

	if (!mdd_object_exists(obj))
		return -ENOENT;

	return dt_xattr_set(env, next, buf, name, fl, handle);
}

static inline int mdo_declare_xattr_del(const struct lu_env *env,
                                        struct mdd_object *obj,
                                        const char *name,
                                        struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(obj);
        return dt_declare_xattr_del(env, next, name, handle);
}

static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
				const char *name, struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(obj);

	if (!mdd_object_exists(obj))
		return -ENOENT;

	return dt_xattr_del(env, next, name, handle);
}

static inline int
mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
	       struct lu_buf *buf)
{
	struct dt_object *next = mdd_object_child(obj);

	if (!mdd_object_exists(obj))
		return -ENOENT;

	return dt_xattr_list(env, next, buf);
}

static inline
int mdo_declare_index_insert(const struct lu_env *env, struct mdd_object *obj,
			     const struct lu_fid *fid, __u32 type,
			     const char *name, struct thandle *handle)
{
	struct dt_object *next	= mdd_object_child(obj);
	int		  rc;

	/*
	 * if the object doesn't exist yet, then it's supposed to be created
	 * and declaration of the creation should be enough to insert ./..
	 */

	rc = -ENOTDIR;
	if (dt_try_as_dir(env, next)) {
		struct dt_insert_rec *rec = &mdd_env_info(env)->mti_dt_rec;

		rec->rec_fid = fid;
		rec->rec_type = type;
		rc = dt_declare_insert(env, next, (const struct dt_rec *)rec,
				       (const struct dt_key *)name, handle);
	}

	 return rc;
}

static inline
int mdo_declare_index_delete(const struct lu_env *env, struct mdd_object *obj,
                             const char *name, struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(obj);

        if (!dt_try_as_dir(env, next))
                return -ENOTDIR;

        return dt_declare_delete(env, next, (const struct dt_key *)name,
                                 handle);
}

static inline int mdo_declare_ref_add(const struct lu_env *env,
                                      struct mdd_object *obj,
                                      struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(obj);
        return dt_declare_ref_add(env, next, handle);
}

static inline int mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
			      struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(obj);

	if (!mdd_object_exists(obj))
		return -ENOENT;

	return dt_ref_add(env, next, handle);
}

static inline int mdo_declare_ref_del(const struct lu_env *env,
                                      struct mdd_object *obj,
                                      struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(obj);
        return dt_declare_ref_del(env, next, handle);
}

static inline int mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
			      struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(obj);

	if (!mdd_object_exists(obj))
		return -ENOENT;

	return dt_ref_del(env, next, handle);
}

static inline int
mdo_declare_create_obj(const struct lu_env *env, struct mdd_object *o,
		       struct lu_attr *attr,
		       struct dt_allocation_hint *hint,
		       struct dt_object_format *dof,
		       struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(o);
	return dt_declare_create(env, next, attr, hint, dof, handle);
}

static inline int
mdo_create_obj(const struct lu_env *env, struct mdd_object *o,
	       struct lu_attr *attr,
	       struct dt_allocation_hint *hint,
	       struct dt_object_format *dof,
	       struct thandle *handle)
{
	struct dt_object *next = mdd_object_child(o);
	return dt_create(env, next, attr, hint, dof, handle);
}

static inline
int mdo_declare_destroy(const struct lu_env *env, struct mdd_object *o,
                        struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(o);
        return dt_declare_destroy(env, next, handle);
}

static inline
int mdo_destroy(const struct lu_env *env, struct mdd_object *o,
                struct thandle *handle)
{
        struct dt_object *next = mdd_object_child(o);
        return dt_destroy(env, next, handle);
}

#endif