[linux-2.6-block.git] / fs / orangefs / orangefs-kernel.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * (C) 2001 Clemson University and The University of Chicago
 *
 * See COPYING in top-level directory.
 */

/*
 *  The ORANGEFS Linux kernel support allows ORANGEFS volumes to be mounted and
 *  accessed through the Linux VFS (i.e. using standard I/O system calls).
 *  This support is only needed on clients that wish to mount the file system.
 *
 */

/*
 *  Declarations and macros for the ORANGEFS Linux kernel support.
 */

#ifndef __ORANGEFSKERNEL_H
#define __ORANGEFSKERNEL_H

#include <linux/kernel.h>
#include <linux/moduleparam.h>
#include <linux/statfs.h>
#include <linux/backing-dev.h>
#include <linux/device.h>
#include <linux/mpage.h>
#include <linux/namei.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/fs.h>
#include <linux/vmalloc.h>

#include <linux/aio.h>
#include <linux/posix_acl.h>
#include <linux/posix_acl_xattr.h>
#include <linux/compat.h>
#include <linux/mount.h>
#include <linux/uaccess.h>
#include <linux/atomic.h>
#include <linux/uio.h>
#include <linux/sched/signal.h>
#include <linux/mm.h>
#include <linux/wait.h>
#include <linux/dcache.h>
#include <linux/pagemap.h>
#include <linux/poll.h>
#include <linux/rwsem.h>
#include <linux/xattr.h>
#include <linux/exportfs.h>
#include <linux/hashtable.h>

#include <asm/unaligned.h>

#include "orangefs-dev-proto.h"

#define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS       20

#define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS   30

#define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS     900	/* 15 minutes */

#define ORANGEFS_REQDEVICE_NAME          "pvfs2-req"

#define ORANGEFS_DEVREQ_MAGIC             0x20030529
#define ORANGEFS_PURGE_RETRY_COUNT     0x00000005

#define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) +   \
sizeof(__u64) + sizeof(struct orangefs_upcall_s))
#define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
sizeof(__u64) + sizeof(struct orangefs_downcall_s))

/*
 * valid orangefs kernel operation states
 *
 * unknown  - op was just initialized
 * waiting  - op is on request_list (upward bound)
 * inprogr  - op is in progress (waiting for downcall)
 * serviced - op has matching downcall; ok
 * purged   - op has to start a timer since client-core
 *            exited uncleanly before servicing op
 * given up - submitter has given up waiting for it
 */
enum orangefs_vfs_op_states {
	OP_VFS_STATE_UNKNOWN = 0,
	OP_VFS_STATE_WAITING = 1,
	OP_VFS_STATE_INPROGR = 2,
	OP_VFS_STATE_SERVICED = 4,
	OP_VFS_STATE_PURGED = 8,
	OP_VFS_STATE_GIVEN_UP = 16,
};

/*
 * orangefs kernel memory related flags
 */

#if (defined CONFIG_DEBUG_SLAB)
#define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
#else
#define ORANGEFS_CACHE_CREATE_FLAGS 0
#endif

extern int orangefs_init_acl(struct inode *inode, struct inode *dir);
extern const struct xattr_handler *orangefs_xattr_handlers[];

extern struct posix_acl *orangefs_get_acl(struct inode *inode, int type);
extern int orangefs_set_acl(struct inode *inode, struct posix_acl *acl, int type);

/*
 * orangefs data structures
 */
struct orangefs_kernel_op_s {
	enum orangefs_vfs_op_states op_state;
	__u64 tag;

	/*
	 * Set uses_shared_memory to non zero if this operation uses
	 * shared memory. If true, then a retry on the op must also
	 * get a new shared memory buffer and re-populate it.
	 * Cancels don't care - it only matters for service_operation()
	 * retry logics and cancels don't go through it anymore. It
	 * safely stays non-zero when we use it as slot_to_free.
	 */
	union {
		int uses_shared_memory;
		int slot_to_free;
	};

	struct orangefs_upcall_s upcall;
	struct orangefs_downcall_s downcall;

	struct completion waitq;
	spinlock_t lock;

	int attempts;

	struct list_head list;
};

#define set_op_state_waiting(op)     ((op)->op_state = OP_VFS_STATE_WAITING)
#define set_op_state_inprogress(op)  ((op)->op_state = OP_VFS_STATE_INPROGR)
#define set_op_state_given_up(op)  ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
static inline void set_op_state_serviced(struct orangefs_kernel_op_s *op)
{
	op->op_state = OP_VFS_STATE_SERVICED;
	complete(&op->waitq);
}

#define op_state_waiting(op)     ((op)->op_state & OP_VFS_STATE_WAITING)
#define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
#define op_state_serviced(op)    ((op)->op_state & OP_VFS_STATE_SERVICED)
#define op_state_purged(op)      ((op)->op_state & OP_VFS_STATE_PURGED)
#define op_state_given_up(op)    ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
#define op_is_cancel(op)         ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)

void op_release(struct orangefs_kernel_op_s *op);

extern void orangefs_bufmap_put(int);
static inline void put_cancel(struct orangefs_kernel_op_s *op)
{
	orangefs_bufmap_put(op->slot_to_free);
	op_release(op);
}

static inline void set_op_state_purged(struct orangefs_kernel_op_s *op)
{
	spin_lock(&op->lock);
	if (unlikely(op_is_cancel(op))) {
		list_del_init(&op->list);
		spin_unlock(&op->lock);
		put_cancel(op);
	} else {
		op->op_state |= OP_VFS_STATE_PURGED;
		complete(&op->waitq);
		spin_unlock(&op->lock);
	}
}

/* per inode private orangefs info */
struct orangefs_inode_s {
	struct orangefs_object_kref refn;
	char link_target[ORANGEFS_NAME_MAX];
	/*
	 * Reading/Writing Extended attributes need to acquire the appropriate
	 * reader/writer semaphore on the orangefs_inode_s structure.
	 */
	struct rw_semaphore xattr_sem;

	struct inode vfs_inode;
	sector_t last_failed_block_index_read;

	unsigned long getattr_time;
	unsigned long mapping_time;
	int attr_valid;
	kuid_t attr_uid;
	kgid_t attr_gid;
	unsigned long bitlock;

	DECLARE_HASHTABLE(xattr_cache, 4);
};

/* per superblock private orangefs info */
struct orangefs_sb_info_s {
	struct orangefs_khandle root_khandle;
	__s32 fs_id;
	int id;
	int flags;
#define ORANGEFS_OPT_INTR	0x01
#define ORANGEFS_OPT_LOCAL_LOCK	0x02
	char devname[ORANGEFS_MAX_SERVER_ADDR_LEN];
	struct super_block *sb;
	int mount_pending;
	int no_list;
	struct list_head list;
};

struct orangefs_stats {
	unsigned long cache_hits;
	unsigned long cache_misses;
	unsigned long reads;
	unsigned long writes;
};

struct orangefs_cached_xattr {
	struct hlist_node node;
	char key[ORANGEFS_MAX_XATTR_NAMELEN];
	char val[ORANGEFS_MAX_XATTR_VALUELEN];
	ssize_t length;
	unsigned long timeout;
};

struct orangefs_write_range {
	loff_t pos;
	size_t len;
	kuid_t uid;
	kgid_t gid;
};

struct orangefs_read_options {
	ssize_t blksiz;
};

extern struct orangefs_stats orangefs_stats;

/*
 * NOTE: See Documentation/filesystems/porting.rst for information
 * on implementing FOO_I and properly accessing fs private data
 */
static inline struct orangefs_inode_s *ORANGEFS_I(struct inode *inode)
{
	return container_of(inode, struct orangefs_inode_s, vfs_inode);
}

static inline struct orangefs_sb_info_s *ORANGEFS_SB(struct super_block *sb)
{
	return (struct orangefs_sb_info_s *) sb->s_fs_info;
}

/* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle)
{
	union {
		unsigned char u[8];
		__u64 ino;
	} ihandle;

	ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
	ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
	ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
	ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
	ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
	ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
	ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
	ihandle.u[7] = khandle->u[15] ^ khandle->u[11];

	return ihandle.ino;
}

static inline struct orangefs_khandle *get_khandle_from_ino(struct inode *inode)
{
	return &(ORANGEFS_I(inode)->refn.khandle);
}

static inline int is_root_handle(struct inode *inode)
{
	gossip_debug(GOSSIP_DCACHE_DEBUG,
		     "%s: root handle: %pU, this handle: %pU:\n",
		     __func__,
		     &ORANGEFS_SB(inode->i_sb)->root_khandle,
		     get_khandle_from_ino(inode));

	if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle),
			     get_khandle_from_ino(inode)))
		return 0;
	else
		return 1;
}

static inline int match_handle(struct orangefs_khandle resp_handle,
			       struct inode *inode)
{
	gossip_debug(GOSSIP_DCACHE_DEBUG,
		     "%s: one handle: %pU, another handle:%pU:\n",
		     __func__,
		     &resp_handle,
		     get_khandle_from_ino(inode));

	if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
		return 0;
	else
		return 1;
}

/*
 * defined in orangefs-cache.c
 */
int op_cache_initialize(void);
int op_cache_finalize(void);
struct orangefs_kernel_op_s *op_alloc(__s32 type);
void orangefs_new_tag(struct orangefs_kernel_op_s *op);
char *get_opname_string(struct orangefs_kernel_op_s *new_op);

int orangefs_inode_cache_initialize(void);
int orangefs_inode_cache_finalize(void);

/*
 * defined in orangefs-mod.c
 */
void purge_inprogress_ops(void);

/*
 * defined in waitqueue.c
 */
void purge_waiting_ops(void);

/*
 * defined in super.c
 */
extern uint64_t orangefs_features;

struct dentry *orangefs_mount(struct file_system_type *fst,
			   int flags,
			   const char *devname,
			   void *data);

void orangefs_kill_sb(struct super_block *sb);
int orangefs_remount(struct orangefs_sb_info_s *);

int fsid_key_table_initialize(void);
void fsid_key_table_finalize(void);

/*
 * defined in inode.c
 */
vm_fault_t orangefs_page_mkwrite(struct vm_fault *);
struct inode *orangefs_new_inode(struct super_block *sb,
			      struct inode *dir,
			      int mode,
			      dev_t dev,
			      struct orangefs_object_kref *ref);

int __orangefs_setattr(struct inode *, struct iattr *);
int orangefs_setattr(struct dentry *, struct iattr *);

int orangefs_getattr(const struct path *path, struct kstat *stat,
		     u32 request_mask, unsigned int flags);

int orangefs_permission(struct inode *inode, int mask);

int orangefs_update_time(struct inode *, struct timespec64 *, int);

/*
 * defined in xattr.c
 */
ssize_t orangefs_listxattr(struct dentry *dentry, char *buffer, size_t size);

/*
 * defined in namei.c
 */
struct inode *orangefs_iget(struct super_block *sb,
			 struct orangefs_object_kref *ref);

/*
 * defined in devorangefs-req.c
 */
extern uint32_t orangefs_userspace_version;

int orangefs_dev_init(void);
void orangefs_dev_cleanup(void);
int is_daemon_in_service(void);
bool __is_daemon_in_service(void);

/*
 * defined in file.c
 */
int orangefs_revalidate_mapping(struct inode *);
ssize_t wait_for_direct_io(enum ORANGEFS_io_type, struct inode *, loff_t *,
    struct iov_iter *, size_t, loff_t, struct orangefs_write_range *, int *);
ssize_t do_readv_writev(enum ORANGEFS_io_type, struct file *, loff_t *,
    struct iov_iter *);

/*
 * defined in orangefs-utils.c
 */
__s32 fsid_of_op(struct orangefs_kernel_op_s *op);

ssize_t orangefs_inode_getxattr(struct inode *inode,
			     const char *name,
			     void *buffer,
			     size_t size);

int orangefs_inode_setxattr(struct inode *inode,
			 const char *name,
			 const void *value,
			 size_t size,
			 int flags);

#define ORANGEFS_GETATTR_NEW 1
#define ORANGEFS_GETATTR_SIZE 2

int orangefs_inode_getattr(struct inode *, int);

int orangefs_inode_check_changed(struct inode *inode);

int orangefs_inode_setattr(struct inode *inode);

bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op);

int orangefs_normalize_to_errno(__s32 error_code);

extern struct mutex orangefs_request_mutex;
extern int op_timeout_secs;
extern int slot_timeout_secs;
extern int orangefs_cache_timeout_msecs;
extern int orangefs_dcache_timeout_msecs;
extern int orangefs_getattr_timeout_msecs;
extern struct list_head orangefs_superblocks;
extern spinlock_t orangefs_superblocks_lock;
extern struct list_head orangefs_request_list;
extern spinlock_t orangefs_request_list_lock;
extern wait_queue_head_t orangefs_request_list_waitq;
extern struct list_head *orangefs_htable_ops_in_progress;
extern spinlock_t orangefs_htable_ops_in_progress_lock;
extern int hash_table_size;

extern const struct file_operations orangefs_file_operations;
extern const struct inode_operations orangefs_symlink_inode_operations;
extern const struct inode_operations orangefs_dir_inode_operations;
extern const struct file_operations orangefs_dir_operations;
extern const struct dentry_operations orangefs_dentry_operations;

/*
 * misc convenience macros
 */

#define ORANGEFS_OP_INTERRUPTIBLE 1   /* service_operation() is interruptible */
#define ORANGEFS_OP_PRIORITY      2   /* service_operation() is high priority */
#define ORANGEFS_OP_CANCELLATION  4   /* this is a cancellation */
#define ORANGEFS_OP_NO_MUTEX      8   /* don't acquire request_mutex */
#define ORANGEFS_OP_ASYNC         16  /* Queue it, but don't wait */
#define ORANGEFS_OP_WRITEBACK     32

int service_operation(struct orangefs_kernel_op_s *op,
		      const char *op_name,
		      int flags);

#define get_interruptible_flag(inode) \
	((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
		ORANGEFS_OP_INTERRUPTIBLE : 0)

#define fill_default_sys_attrs(sys_attr, type, mode)			\
do {									\
	sys_attr.owner = from_kuid(&init_user_ns, current_fsuid()); \
	sys_attr.group = from_kgid(&init_user_ns, current_fsgid()); \
	sys_attr.perms = ORANGEFS_util_translate_mode(mode);		\
	sys_attr.mtime = 0;						\
	sys_attr.atime = 0;						\
	sys_attr.ctime = 0;						\
	sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE;			\
} while (0)

static inline void orangefs_set_timeout(struct dentry *dentry)
{
	unsigned long time = jiffies + orangefs_dcache_timeout_msecs*HZ/1000;

	dentry->d_fsdata = (void *) time;
}

#endif /* __ORANGEFSKERNEL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
f7ab093f MM	2	/*
	3	* (C) 2001 Clemson University and The University of Chicago
	4	*
	5	* See COPYING in top-level directory.
	6	*/
	7
	8	/*
8bb8aefd	9	* The ORANGEFS Linux kernel support allows ORANGEFS volumes to be mounted and
f7ab093f MM	10	* accessed through the Linux VFS (i.e. using standard I/O system calls).
	11	* This support is only needed on clients that wish to mount the file system.
	12	*
	13	*/
	14
	15	/*
8bb8aefd	16	* Declarations and macros for the ORANGEFS Linux kernel support.
f7ab093f MM	17	*/
f7ab093f MM	18
8bb8aefd YL	19	#ifndef __ORANGEFSKERNEL_H
8bb8aefd YL	20	#define __ORANGEFSKERNEL_H
f7ab093f MM	21
	22	#include <linux/kernel.h>
	23	#include <linux/moduleparam.h>
	24	#include <linux/statfs.h>
	25	#include <linux/backing-dev.h>
	26	#include <linux/device.h>
	27	#include <linux/mpage.h>
	28	#include <linux/namei.h>
	29	#include <linux/errno.h>
	30	#include <linux/init.h>
	31	#include <linux/module.h>
	32	#include <linux/slab.h>
	33	#include <linux/types.h>
	34	#include <linux/fs.h>
	35	#include <linux/vmalloc.h>
	36
	37	#include <linux/aio.h>
	38	#include <linux/posix_acl.h>
	39	#include <linux/posix_acl_xattr.h>
	40	#include <linux/compat.h>
	41	#include <linux/mount.h>
	42	#include <linux/uaccess.h>
	43	#include <linux/atomic.h>
	44	#include <linux/uio.h>
174cd4b1	45	#include <linux/sched/signal.h>
f7ab093f MM	46	#include <linux/mm.h>
	47	#include <linux/wait.h>
	48	#include <linux/dcache.h>
	49	#include <linux/pagemap.h>
	50	#include <linux/poll.h>
	51	#include <linux/rwsem.h>
	52	#include <linux/xattr.h>
	53	#include <linux/exportfs.h>
fc2e2e9c	54	#include <linux/hashtable.h>
f7ab093f MM	55
	56	#include <asm/unaligned.h>
	57
575e9461	58	#include "orangefs-dev-proto.h"
f7ab093f	59
8bb8aefd	60	#define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 20
f7ab093f	61
8bb8aefd	62	#define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS 30
f7ab093f	63
8bb8aefd	64	#define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS 900 /* 15 minutes */
f7ab093f	65
8bb8aefd	66	#define ORANGEFS_REQDEVICE_NAME "pvfs2-req"
f7ab093f	67
8bb8aefd	68	#define ORANGEFS_DEVREQ_MAGIC 0x20030529
8bb8aefd	69	#define ORANGEFS_PURGE_RETRY_COUNT 0x00000005
f7ab093f	70
cf0c2771	71	#define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) + \
8bb8aefd	72	sizeof(__u64) + sizeof(struct orangefs_upcall_s))
cf0c2771	73	#define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
8bb8aefd	74	sizeof(__u64) + sizeof(struct orangefs_downcall_s))
f7ab093f	75
f7ab093f	76	/*
8bb8aefd	77	* valid orangefs kernel operation states
f7ab093f MM	78	*
	79	* unknown - op was just initialized
	80	* waiting - op is on request_list (upward bound)
	81	* inprogr - op is in progress (waiting for downcall)
	82	* serviced - op has matching downcall; ok
	83	* purged - op has to start a timer since client-core
	84	* exited uncleanly before servicing op
ed42fe05	85	* given up - submitter has given up waiting for it
f7ab093f	86	*/
8bb8aefd	87	enum orangefs_vfs_op_states {
f7ab093f MM	88	OP_VFS_STATE_UNKNOWN = 0,
	89	OP_VFS_STATE_WAITING = 1,
	90	OP_VFS_STATE_INPROGR = 2,
	91	OP_VFS_STATE_SERVICED = 4,
	92	OP_VFS_STATE_PURGED = 8,
ed42fe05	93	OP_VFS_STATE_GIVEN_UP = 16,
f7ab093f MM	94	};
f7ab093f MM	95
f7ab093f	96	/*
8bb8aefd	97	* orangefs kernel memory related flags
f7ab093f MM	98	*/
f7ab093f MM	99
538e3048	100	#if (defined CONFIG_DEBUG_SLAB)
8bb8aefd	101	#define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
f7ab093f	102	#else
8bb8aefd	103	#define ORANGEFS_CACHE_CREATE_FLAGS 0
538e3048	104	#endif
f7ab093f	105
8bb8aefd YL	106	extern int orangefs_init_acl(struct inode inode, struct inode dir);
8bb8aefd YL	107	extern const struct xattr_handler *orangefs_xattr_handlers[];
f7ab093f	108
8bb8aefd YL	109	extern struct posix_acl orangefs_get_acl(struct inode inode, int type);
8bb8aefd YL	110	extern int orangefs_set_acl(struct inode inode, struct posix_acl acl, int type);
f7ab093f	111
f7ab093f	112	/*
8bb8aefd	113	* orangefs data structures
f7ab093f	114	*/
8bb8aefd YL	115	struct orangefs_kernel_op_s {
8bb8aefd YL	116	enum orangefs_vfs_op_states op_state;
f7ab093f MM	117	__u64 tag;
	118
	119	/*
d37c0f30 MM	120	* Set uses_shared_memory to non zero if this operation uses
	121	* shared memory. If true, then a retry on the op must also
	122	* get a new shared memory buffer and re-populate it.
	123	* Cancels don't care - it only matters for service_operation()
	124	* retry logics and cancels don't go through it anymore. It
	125	* safely stays non-zero when we use it as slot_to_free.
f7ab093f	126	*/
78699e29 AV	127	union {
	128	int uses_shared_memory;
	129	int slot_to_free;
	130	};
f7ab093f	131
8bb8aefd YL	132	struct orangefs_upcall_s upcall;
8bb8aefd YL	133	struct orangefs_downcall_s downcall;
f7ab093f	134
d2d87a3b	135	struct completion waitq;
f7ab093f MM	136	spinlock_t lock;
f7ab093f MM	137
f7ab093f MM	138	int attempts;
	139
	140	struct list_head list;
	141	};
	142
60831949 AV	143	#define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING)
60831949 AV	144	#define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR)
2d4cae0d	145	#define set_op_state_given_up(op) ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
60831949 AV	146	static inline void set_op_state_serviced(struct orangefs_kernel_op_s *op)
	147	{
	148	op->op_state = OP_VFS_STATE_SERVICED;
d2d87a3b	149	complete(&op->waitq);
60831949	150	}
60831949 AV	151
	152	#define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING)
	153	#define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
	154	#define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED)
	155	#define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED)
ed42fe05	156	#define op_state_given_up(op) ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
78699e29	157	#define op_is_cancel(op) ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)
ed42fe05	158
c1223ca4	159	void op_release(struct orangefs_kernel_op_s *op);
60831949	160
78699e29 AV	161	extern void orangefs_bufmap_put(int);
	162	static inline void put_cancel(struct orangefs_kernel_op_s *op)
	163	{
	164	orangefs_bufmap_put(op->slot_to_free);
	165	op_release(op);
	166	}
	167
	168	static inline void set_op_state_purged(struct orangefs_kernel_op_s *op)
	169	{
	170	spin_lock(&op->lock);
	171	if (unlikely(op_is_cancel(op))) {
05a50a5b	172	list_del_init(&op->list);
78699e29 AV	173	spin_unlock(&op->lock);
	174	put_cancel(op);
	175	} else {
	176	op->op_state \|= OP_VFS_STATE_PURGED;
d2d87a3b	177	complete(&op->waitq);
78699e29 AV	178	spin_unlock(&op->lock);
	179	}
	180	}
	181
8bb8aefd YL	182	/* per inode private orangefs info */
	183	struct orangefs_inode_s {
	184	struct orangefs_object_kref refn;
	185	char link_target[ORANGEFS_NAME_MAX];
f7ab093f MM	186	/*
f7ab093f MM	187	* Reading/Writing Extended attributes need to acquire the appropriate
8bb8aefd	188	* reader/writer semaphore on the orangefs_inode_s structure.
f7ab093f MM	189	*/
	190	struct rw_semaphore xattr_sem;
	191
	192	struct inode vfs_inode;
	193	sector_t last_failed_block_index_read;
	194
71680c18	195	unsigned long getattr_time;
8f04e1be	196	unsigned long mapping_time;
afd9fb2a MB	197	int attr_valid;
	198	kuid_t attr_uid;
	199	kgid_t attr_gid;
8f04e1be	200	unsigned long bitlock;
fc2e2e9c MB	201
fc2e2e9c MB	202	DECLARE_HASHTABLE(xattr_cache, 4);
f7ab093f MM	203	};
f7ab093f MM	204
8bb8aefd YL	205	/* per superblock private orangefs info */
	206	struct orangefs_sb_info_s {
	207	struct orangefs_khandle root_khandle;
f7ab093f MM	208	__s32 fs_id;
	209	int id;
	210	int flags;
8bb8aefd YL	211	#define ORANGEFS_OPT_INTR 0x01
	212	#define ORANGEFS_OPT_LOCAL_LOCK 0x02
	213	char devname[ORANGEFS_MAX_SERVER_ADDR_LEN];
f7ab093f MM	214	struct super_block *sb;
f7ab093f MM	215	int mount_pending;
1ec1688c	216	int no_list;
f7ab093f MM	217	struct list_head list;
	218	};
	219
8bb8aefd	220	struct orangefs_stats {
f7ab093f MM	221	unsigned long cache_hits;
	222	unsigned long cache_misses;
	223	unsigned long reads;
	224	unsigned long writes;
	225	};
	226
fc2e2e9c MB	227	struct orangefs_cached_xattr {
	228	struct hlist_node node;
	229	char key[ORANGEFS_MAX_XATTR_NAMELEN];
	230	char val[ORANGEFS_MAX_XATTR_VALUELEN];
	231	ssize_t length;
	232	unsigned long timeout;
	233	};
	234
52e2d0a3 MB	235	struct orangefs_write_range {
	236	loff_t pos;
	237	size_t len;
	238	kuid_t uid;
	239	kgid_t gid;
	240	};
	241
c2549f8c MM	242	struct orangefs_read_options {
	243	ssize_t blksiz;
	244	};
	245
889d5f1b	246	extern struct orangefs_stats orangefs_stats;
f7ab093f MM	247
f7ab093f MM	248	/*
25b532ce	249	* NOTE: See Documentation/filesystems/porting.rst for information
54804949 MM	250	* on implementing FOO_I and properly accessing fs private data
54804949 MM	251	*/
8bb8aefd	252	static inline struct orangefs_inode_s ORANGEFS_I(struct inode inode)
f7ab093f	253	{
8bb8aefd	254	return container_of(inode, struct orangefs_inode_s, vfs_inode);
f7ab093f MM	255	}
f7ab093f MM	256
8bb8aefd	257	static inline struct orangefs_sb_info_s ORANGEFS_SB(struct super_block sb)
f7ab093f	258	{
8bb8aefd	259	return (struct orangefs_sb_info_s *) sb->s_fs_info;
f7ab093f MM	260	}
	261
	262	/* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
8bb8aefd	263	static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle)
f7ab093f MM	264	{
	265	union {
	266	unsigned char u[8];
	267	__u64 ino;
	268	} ihandle;
	269
	270	ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
	271	ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
	272	ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
	273	ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
	274	ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
	275	ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
	276	ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
	277	ihandle.u[7] = khandle->u[15] ^ khandle->u[11];
	278
	279	return ihandle.ino;
	280	}
	281
8bb8aefd	282	static inline struct orangefs_khandle get_khandle_from_ino(struct inode inode)
f7ab093f	283	{
8bb8aefd	284	return &(ORANGEFS_I(inode)->refn.khandle);
f7ab093f MM	285	}
f7ab093f MM	286
f7ab093f MM	287	static inline int is_root_handle(struct inode *inode)
	288	{
	289	gossip_debug(GOSSIP_DCACHE_DEBUG,
	290	"%s: root handle: %pU, this handle: %pU:\n",
	291	__func__,
8bb8aefd	292	&ORANGEFS_SB(inode->i_sb)->root_khandle,
f7ab093f MM	293	get_khandle_from_ino(inode));
f7ab093f MM	294
8bb8aefd	295	if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle),
f7ab093f MM	296	get_khandle_from_ino(inode)))
	297	return 0;
	298	else
	299	return 1;
	300	}
	301
8bb8aefd	302	static inline int match_handle(struct orangefs_khandle resp_handle,
f7ab093f MM	303	struct inode *inode)
	304	{
	305	gossip_debug(GOSSIP_DCACHE_DEBUG,
	306	"%s: one handle: %pU, another handle:%pU:\n",
	307	__func__,
	308	&resp_handle,
	309	get_khandle_from_ino(inode));
	310
8bb8aefd	311	if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
f7ab093f MM	312	return 0;
	313	else
	314	return 1;
	315	}
	316
	317	/*
8bb8aefd	318	* defined in orangefs-cache.c
f7ab093f MM	319	*/
	320	int op_cache_initialize(void);
	321	int op_cache_finalize(void);
8bb8aefd	322	struct orangefs_kernel_op_s *op_alloc(__s32 type);
78699e29	323	void orangefs_new_tag(struct orangefs_kernel_op_s *op);
8bb8aefd	324	char get_opname_string(struct orangefs_kernel_op_s new_op);
f7ab093f	325
8bb8aefd YL	326	int orangefs_inode_cache_initialize(void);
8bb8aefd YL	327	int orangefs_inode_cache_finalize(void);
f7ab093f	328
f7ab093f	329	/*
8bb8aefd	330	* defined in orangefs-mod.c
f7ab093f MM	331	*/
	332	void purge_inprogress_ops(void);
	333
	334	/*
	335	* defined in waitqueue.c
	336	*/
f7ab093f MM	337	void purge_waiting_ops(void);
	338
	339	/*
	340	* defined in super.c
	341	*/
482664dd MB	342	extern uint64_t orangefs_features;
482664dd MB	343
8bb8aefd	344	struct dentry orangefs_mount(struct file_system_type fst,
f7ab093f MM	345	int flags,
	346	const char *devname,
	347	void *data);
	348
8bb8aefd	349	void orangefs_kill_sb(struct super_block *sb);
45996492	350	int orangefs_remount(struct orangefs_sb_info_s *);
f7ab093f MM	351
	352	int fsid_key_table_initialize(void);
	353	void fsid_key_table_finalize(void);
	354
	355	/*
	356	* defined in inode.c
	357	*/
52e2d0a3	358	vm_fault_t orangefs_page_mkwrite(struct vm_fault *);
8bb8aefd	359	struct inode orangefs_new_inode(struct super_block sb,
f7ab093f MM	360	struct inode *dir,
	361	int mode,
	362	dev_t dev,
8bb8aefd	363	struct orangefs_object_kref *ref);
f7ab093f	364
afd9fb2a MB	365	int __orangefs_setattr(struct inode , struct iattr );
afd9fb2a MB	366	int orangefs_setattr(struct dentry , struct iattr );
f7ab093f	367
a528d35e DH	368	int orangefs_getattr(const struct path path, struct kstat stat,
a528d35e DH	369	u32 request_mask, unsigned int flags);
f7ab093f	370
933287da MB	371	int orangefs_permission(struct inode *inode, int mask);
933287da MB	372
95582b00	373	int orangefs_update_time(struct inode , struct timespec64 , int);
a55f2d86	374
f7ab093f MM	375	/*
	376	* defined in xattr.c
	377	*/
8bb8aefd	378	ssize_t orangefs_listxattr(struct dentry dentry, char buffer, size_t size);
f7ab093f MM	379
	380	/*
	381	* defined in namei.c
	382	*/
8bb8aefd YL	383	struct inode orangefs_iget(struct super_block sb,
8bb8aefd YL	384	struct orangefs_object_kref *ref);
f7ab093f	385
f7ab093f	386	/*
8bb8aefd	387	* defined in devorangefs-req.c
f7ab093f	388	*/
482664dd	389	extern uint32_t orangefs_userspace_version;
f2ee3b75	390
8bb8aefd YL	391	int orangefs_dev_init(void);
8bb8aefd YL	392	void orangefs_dev_cleanup(void);
f7ab093f	393	int is_daemon_in_service(void);
78699e29	394	bool __is_daemon_in_service(void);
f7ab093f	395
c453dcfc MB	396	/*
	397	* defined in file.c
	398	*/
8f04e1be	399	int orangefs_revalidate_mapping(struct inode *);
c453dcfc	400	ssize_t wait_for_direct_io(enum ORANGEFS_io_type, struct inode , loff_t ,
4077a0f2	401	struct iov_iter , size_t, loff_t, struct orangefs_write_range , int *);
c453dcfc MB	402	ssize_t do_readv_writev(enum ORANGEFS_io_type, struct file , loff_t ,
	403	struct iov_iter *);
	404
f7ab093f	405	/*
8bb8aefd	406	* defined in orangefs-utils.c
f7ab093f	407	*/
8bb8aefd	408	__s32 fsid_of_op(struct orangefs_kernel_op_s *op);
f7ab093f	409
8bb8aefd	410	ssize_t orangefs_inode_getxattr(struct inode *inode,
f7ab093f MM	411	const char *name,
	412	void *buffer,
	413	size_t size);
	414
8bb8aefd	415	int orangefs_inode_setxattr(struct inode *inode,
f7ab093f MM	416	const char *name,
	417	const void *value,
	418	size_t size,
	419	int flags);
	420
8b60785c MB	421	#define ORANGEFS_GETATTR_NEW 1
	422	#define ORANGEFS_GETATTR_SIZE 2
	423
	424	int orangefs_inode_getattr(struct inode *, int);
f7ab093f	425
5859d77e MB	426	int orangefs_inode_check_changed(struct inode *inode);
5859d77e MB	427
afd9fb2a	428	int orangefs_inode_setattr(struct inode *inode);
f7ab093f	429
78699e29	430	bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op);
f7ab093f	431
8bb8aefd	432	int orangefs_normalize_to_errno(__s32 error_code);
f7ab093f	433
1d503617	434	extern struct mutex orangefs_request_mutex;
f7ab093f MM	435	extern int op_timeout_secs;
f7ab093f MM	436	extern int slot_timeout_secs;
8f04e1be	437	extern int orangefs_cache_timeout_msecs;
1d503617 MB	438	extern int orangefs_dcache_timeout_msecs;
1d503617 MB	439	extern int orangefs_getattr_timeout_msecs;
8bb8aefd YL	440	extern struct list_head orangefs_superblocks;
	441	extern spinlock_t orangefs_superblocks_lock;
	442	extern struct list_head orangefs_request_list;
	443	extern spinlock_t orangefs_request_list_lock;
	444	extern wait_queue_head_t orangefs_request_list_waitq;
1d503617 MB	445	extern struct list_head *orangefs_htable_ops_in_progress;
1d503617 MB	446	extern spinlock_t orangefs_htable_ops_in_progress_lock;
f7ab093f MM	447	extern int hash_table_size;
f7ab093f MM	448
8bb8aefd	449	extern const struct file_operations orangefs_file_operations;
6f3fc107 AV	450	extern const struct inode_operations orangefs_symlink_inode_operations;
6f3fc107 AV	451	extern const struct inode_operations orangefs_dir_inode_operations;
8bb8aefd YL	452	extern const struct file_operations orangefs_dir_operations;
8bb8aefd YL	453	extern const struct dentry_operations orangefs_dentry_operations;
f7ab093f	454
f7ab093f MM	455	/*
	456	* misc convenience macros
	457	*/
f7ab093f	458
8bb8aefd YL	459	#define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */
	460	#define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */
	461	#define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */
adcf34a2	462	#define ORANGEFS_OP_NO_MUTEX 8 /* don't acquire request_mutex */
8bb8aefd	463	#define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */
0dcac0f7	464	#define ORANGEFS_OP_WRITEBACK 32
f7ab093f	465
8bb8aefd	466	int service_operation(struct orangefs_kernel_op_s *op,
f7ab093f MM	467	const char *op_name,
	468	int flags);
	469
f7ab093f	470	#define get_interruptible_flag(inode) \
8bb8aefd YL	471	((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
8bb8aefd YL	472	ORANGEFS_OP_INTERRUPTIBLE : 0)
f7ab093f	473
f7ab093f MM	474	#define fill_default_sys_attrs(sys_attr, type, mode) \
f7ab093f MM	475	do { \
78fee0b6 JH	476	sys_attr.owner = from_kuid(&init_user_ns, current_fsuid()); \
78fee0b6 JH	477	sys_attr.group = from_kgid(&init_user_ns, current_fsgid()); \
8bb8aefd	478	sys_attr.perms = ORANGEFS_util_translate_mode(mode); \
69a23de2 MB	479	sys_attr.mtime = 0; \
	480	sys_attr.atime = 0; \
	481	sys_attr.ctime = 0; \
8bb8aefd	482	sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \
f7ab093f MM	483	} while (0)
f7ab093f MM	484
804b1737 MS	485	static inline void orangefs_set_timeout(struct dentry *dentry)
	486	{
	487	unsigned long time = jiffies + orangefs_dcache_timeout_msecs*HZ/1000;
	488
	489	dentry->d_fsdata = (void *) time;
	490	}
	491
8bb8aefd	492	#endif /* __ORANGEFSKERNEL_H */