[mirror_ubuntu-hirsute-kernel.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 <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_LINK_MAX                 0x000000FF
#define ORANGEFS_PURGE_RETRY_COUNT     0x00000005
#define ORANGEFS_MAX_NUM_OPTIONS          0x00000004
#define ORANGEFS_MAX_MOUNT_OPT_LEN        0x00000080
#define ORANGEFS_MAX_FSKEY_LEN            64

#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);

/*
 * Redefine xtvec structure so that we could move helper functions out of
 * the define
 */
struct xtvec {
	__kernel_off_t xtv_off;		/* must be off_t */
	__kernel_size_t xtv_len;	/* must be size_t */
};

/*
 * 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];
	__s64 blksize;
	/*
	 * 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;
	u32 getattr_mask;
};

/* 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;
};

/*
 * structure that holds the state of any async I/O operation issued
 * through the VFS. Needed especially to handle cancellation requests
 * or even completion notification so that the VFS client-side daemon
 * can free up its vfs_request slots.
 */
struct orangefs_kiocb_s {
	/* the pointer to the task that initiated the AIO */
	struct task_struct *tsk;

	/* pointer to the kiocb that kicked this operation */
	struct kiocb *kiocb;

	/* buffer index that was used for the I/O */
	struct orangefs_bufmap *bufmap;
	int buffer_index;

	/* orangefs kernel operation type */
	struct orangefs_kernel_op_s *op;

	/* set to indicate the type of the operation */
	int rw;

	/* file offset */
	loff_t offset;

	/* and the count in bytes */
	size_t bytes_to_be_copied;

	ssize_t bytes_copied;
	int needs_cleanup;
};

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

extern struct orangefs_stats orangefs_stats;

/*
 * NOTE: See Documentation/filesystems/porting 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 ino_t get_ino_from_khandle(struct inode *inode)
{
	struct orangefs_khandle *khandle;
	ino_t ino;

	khandle = get_khandle_from_ino(inode);
	ino = orangefs_khandle_to_ino(khandle);
	return ino;
}

static inline ino_t get_parent_ino_from_dentry(struct dentry *dentry)
{
	return get_ino_from_khandle(dentry->d_parent->d_inode);
}

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
 */
__u32 convert_to_orangefs_mask(unsigned long lite_mask);
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 dentry *dentry, struct iattr *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 timespec *, int);

/*
 * defined in xattr.c
 */
int orangefs_setxattr(struct dentry *dentry,
		   const char *name,
		   const void *value,
		   size_t size,
		   int flags);

ssize_t orangefs_getxattr(struct dentry *dentry,
		       const char *name,
		       void *buffer,
		       size_t size);

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);

ssize_t orangefs_inode_read(struct inode *inode,
			    struct iov_iter *iter,
			    loff_t *offset,
			    loff_t readahead_size);

/*
 * 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 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);

int orangefs_inode_getattr(struct inode *inode, int new, int bypass,
    u32 request_mask);

int orangefs_inode_check_changed(struct inode *inode);

int orangefs_inode_setattr(struct inode *inode, struct iattr *iattr);

int orangefs_unmount_sb(struct super_block *sb);

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_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 address_space_operations orangefs_address_operations;
extern const struct inode_operations orangefs_file_inode_operations;
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;
extern const struct file_operations orangefs_devreq_file_operations;

extern wait_queue_head_t orangefs_bufmap_init_waitq;

/*
 * 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 */

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>
	54
	55	#include <asm/unaligned.h>
	56
575e9461	57	#include "orangefs-dev-proto.h"
f7ab093f	58
8bb8aefd	59	#define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 20
f7ab093f	60
8bb8aefd	61	#define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS 30
f7ab093f	62
8bb8aefd	63	#define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS 900 /* 15 minutes */
f7ab093f	64
8bb8aefd	65	#define ORANGEFS_REQDEVICE_NAME "pvfs2-req"
f7ab093f	66
8bb8aefd YL	67	#define ORANGEFS_DEVREQ_MAGIC 0x20030529
	68	#define ORANGEFS_LINK_MAX 0x000000FF
	69	#define ORANGEFS_PURGE_RETRY_COUNT 0x00000005
8bb8aefd YL	70	#define ORANGEFS_MAX_NUM_OPTIONS 0x00000004
	71	#define ORANGEFS_MAX_MOUNT_OPT_LEN 0x00000080
	72	#define ORANGEFS_MAX_FSKEY_LEN 64
f7ab093f	73
cf0c2771	74	#define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) + \
8bb8aefd	75	sizeof(__u64) + sizeof(struct orangefs_upcall_s))
cf0c2771	76	#define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
8bb8aefd	77	sizeof(__u64) + sizeof(struct orangefs_downcall_s))
f7ab093f	78
f7ab093f	79	/*
8bb8aefd	80	* valid orangefs kernel operation states
f7ab093f MM	81	*
	82	* unknown - op was just initialized
	83	* waiting - op is on request_list (upward bound)
	84	* inprogr - op is in progress (waiting for downcall)
	85	* serviced - op has matching downcall; ok
	86	* purged - op has to start a timer since client-core
	87	* exited uncleanly before servicing op
ed42fe05	88	* given up - submitter has given up waiting for it
f7ab093f	89	*/
8bb8aefd	90	enum orangefs_vfs_op_states {
f7ab093f MM	91	OP_VFS_STATE_UNKNOWN = 0,
	92	OP_VFS_STATE_WAITING = 1,
	93	OP_VFS_STATE_INPROGR = 2,
	94	OP_VFS_STATE_SERVICED = 4,
	95	OP_VFS_STATE_PURGED = 8,
ed42fe05	96	OP_VFS_STATE_GIVEN_UP = 16,
f7ab093f MM	97	};
f7ab093f MM	98
f7ab093f	99	/*
8bb8aefd	100	* orangefs kernel memory related flags
f7ab093f MM	101	*/
f7ab093f MM	102
538e3048	103	#if (defined CONFIG_DEBUG_SLAB)
8bb8aefd	104	#define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
f7ab093f	105	#else
8bb8aefd	106	#define ORANGEFS_CACHE_CREATE_FLAGS 0
538e3048	107	#endif
f7ab093f	108
8bb8aefd YL	109	extern int orangefs_init_acl(struct inode inode, struct inode dir);
8bb8aefd YL	110	extern const struct xattr_handler *orangefs_xattr_handlers[];
f7ab093f	111
8bb8aefd YL	112	extern struct posix_acl orangefs_get_acl(struct inode inode, int type);
8bb8aefd YL	113	extern int orangefs_set_acl(struct inode inode, struct posix_acl acl, int type);
f7ab093f	114
f7ab093f MM	115	/*
	116	* Redefine xtvec structure so that we could move helper functions out of
	117	* the define
	118	*/
	119	struct xtvec {
	120	__kernel_off_t xtv_off; /* must be off_t */
	121	__kernel_size_t xtv_len; /* must be size_t */
	122	};
	123
	124	/*
8bb8aefd	125	* orangefs data structures
f7ab093f	126	*/
8bb8aefd YL	127	struct orangefs_kernel_op_s {
8bb8aefd YL	128	enum orangefs_vfs_op_states op_state;
f7ab093f MM	129	__u64 tag;
	130
	131	/*
d37c0f30 MM	132	* Set uses_shared_memory to non zero if this operation uses
	133	* shared memory. If true, then a retry on the op must also
	134	* get a new shared memory buffer and re-populate it.
	135	* Cancels don't care - it only matters for service_operation()
	136	* retry logics and cancels don't go through it anymore. It
	137	* safely stays non-zero when we use it as slot_to_free.
f7ab093f	138	*/
78699e29 AV	139	union {
	140	int uses_shared_memory;
	141	int slot_to_free;
	142	};
f7ab093f	143
8bb8aefd YL	144	struct orangefs_upcall_s upcall;
8bb8aefd YL	145	struct orangefs_downcall_s downcall;
f7ab093f	146
d2d87a3b	147	struct completion waitq;
f7ab093f MM	148	spinlock_t lock;
f7ab093f MM	149
f7ab093f MM	150	int attempts;
	151
	152	struct list_head list;
	153	};
	154
60831949 AV	155	#define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING)
60831949 AV	156	#define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR)
2d4cae0d	157	#define set_op_state_given_up(op) ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
60831949 AV	158	static inline void set_op_state_serviced(struct orangefs_kernel_op_s *op)
	159	{
	160	op->op_state = OP_VFS_STATE_SERVICED;
d2d87a3b	161	complete(&op->waitq);
60831949	162	}
60831949 AV	163
	164	#define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING)
	165	#define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
	166	#define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED)
	167	#define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED)
ed42fe05	168	#define op_state_given_up(op) ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
78699e29	169	#define op_is_cancel(op) ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)
ed42fe05	170
c1223ca4	171	void op_release(struct orangefs_kernel_op_s *op);
60831949	172
78699e29 AV	173	extern void orangefs_bufmap_put(int);
	174	static inline void put_cancel(struct orangefs_kernel_op_s *op)
	175	{
	176	orangefs_bufmap_put(op->slot_to_free);
	177	op_release(op);
	178	}
	179
	180	static inline void set_op_state_purged(struct orangefs_kernel_op_s *op)
	181	{
	182	spin_lock(&op->lock);
	183	if (unlikely(op_is_cancel(op))) {
05a50a5b	184	list_del_init(&op->list);
78699e29 AV	185	spin_unlock(&op->lock);
	186	put_cancel(op);
	187	} else {
	188	op->op_state \|= OP_VFS_STATE_PURGED;
d2d87a3b	189	complete(&op->waitq);
78699e29 AV	190	spin_unlock(&op->lock);
	191	}
	192	}
	193
8bb8aefd YL	194	/* per inode private orangefs info */
	195	struct orangefs_inode_s {
	196	struct orangefs_object_kref refn;
	197	char link_target[ORANGEFS_NAME_MAX];
f7ab093f MM	198	__s64 blksize;
	199	/*
	200	* Reading/Writing Extended attributes need to acquire the appropriate
8bb8aefd	201	* reader/writer semaphore on the orangefs_inode_s structure.
f7ab093f MM	202	*/
	203	struct rw_semaphore xattr_sem;
	204
	205	struct inode vfs_inode;
	206	sector_t last_failed_block_index_read;
	207
71680c18	208	unsigned long getattr_time;
68a24a6c	209	u32 getattr_mask;
f7ab093f MM	210	};
f7ab093f MM	211
8bb8aefd YL	212	/* per superblock private orangefs info */
	213	struct orangefs_sb_info_s {
	214	struct orangefs_khandle root_khandle;
f7ab093f MM	215	__s32 fs_id;
	216	int id;
	217	int flags;
8bb8aefd YL	218	#define ORANGEFS_OPT_INTR 0x01
	219	#define ORANGEFS_OPT_LOCAL_LOCK 0x02
	220	char devname[ORANGEFS_MAX_SERVER_ADDR_LEN];
f7ab093f MM	221	struct super_block *sb;
f7ab093f MM	222	int mount_pending;
1ec1688c	223	int no_list;
f7ab093f MM	224	struct list_head list;
	225	};
	226
f7ab093f MM	227	/*
	228	* structure that holds the state of any async I/O operation issued
	229	* through the VFS. Needed especially to handle cancellation requests
	230	* or even completion notification so that the VFS client-side daemon
	231	* can free up its vfs_request slots.
	232	*/
8bb8aefd	233	struct orangefs_kiocb_s {
f7ab093f MM	234	/* the pointer to the task that initiated the AIO */
	235	struct task_struct *tsk;
	236
	237	/* pointer to the kiocb that kicked this operation */
	238	struct kiocb *kiocb;
	239
	240	/* buffer index that was used for the I/O */
8bb8aefd	241	struct orangefs_bufmap *bufmap;
f7ab093f MM	242	int buffer_index;
f7ab093f MM	243
8bb8aefd YL	244	/* orangefs kernel operation type */
8bb8aefd YL	245	struct orangefs_kernel_op_s *op;
f7ab093f	246
f7ab093f MM	247	/* set to indicate the type of the operation */
	248	int rw;
	249
	250	/* file offset */
	251	loff_t offset;
	252
	253	/* and the count in bytes */
	254	size_t bytes_to_be_copied;
	255
	256	ssize_t bytes_copied;
	257	int needs_cleanup;
	258	};
	259
8bb8aefd	260	struct orangefs_stats {
f7ab093f MM	261	unsigned long cache_hits;
	262	unsigned long cache_misses;
	263	unsigned long reads;
	264	unsigned long writes;
	265	};
	266
889d5f1b	267	extern struct orangefs_stats orangefs_stats;
f7ab093f MM	268
f7ab093f MM	269	/*
54804949 MM	270	* NOTE: See Documentation/filesystems/porting for information
	271	* on implementing FOO_I and properly accessing fs private data
	272	*/
8bb8aefd	273	static inline struct orangefs_inode_s ORANGEFS_I(struct inode inode)
f7ab093f	274	{
8bb8aefd	275	return container_of(inode, struct orangefs_inode_s, vfs_inode);
f7ab093f MM	276	}
f7ab093f MM	277
8bb8aefd	278	static inline struct orangefs_sb_info_s ORANGEFS_SB(struct super_block sb)
f7ab093f	279	{
8bb8aefd	280	return (struct orangefs_sb_info_s *) sb->s_fs_info;
f7ab093f MM	281	}
	282
	283	/* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
8bb8aefd	284	static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle)
f7ab093f MM	285	{
	286	union {
	287	unsigned char u[8];
	288	__u64 ino;
	289	} ihandle;
	290
	291	ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
	292	ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
	293	ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
	294	ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
	295	ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
	296	ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
	297	ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
	298	ihandle.u[7] = khandle->u[15] ^ khandle->u[11];
	299
	300	return ihandle.ino;
	301	}
	302
8bb8aefd	303	static inline struct orangefs_khandle get_khandle_from_ino(struct inode inode)
f7ab093f	304	{
8bb8aefd	305	return &(ORANGEFS_I(inode)->refn.khandle);
f7ab093f MM	306	}
f7ab093f MM	307
f7ab093f MM	308	static inline ino_t get_ino_from_khandle(struct inode *inode)
f7ab093f MM	309	{
8bb8aefd	310	struct orangefs_khandle *khandle;
f7ab093f MM	311	ino_t ino;
	312
	313	khandle = get_khandle_from_ino(inode);
8bb8aefd	314	ino = orangefs_khandle_to_ino(khandle);
f7ab093f MM	315	return ino;
	316	}
	317
	318	static inline ino_t get_parent_ino_from_dentry(struct dentry *dentry)
	319	{
	320	return get_ino_from_khandle(dentry->d_parent->d_inode);
	321	}
	322
	323	static inline int is_root_handle(struct inode *inode)
	324	{
	325	gossip_debug(GOSSIP_DCACHE_DEBUG,
	326	"%s: root handle: %pU, this handle: %pU:\n",
	327	__func__,
8bb8aefd	328	&ORANGEFS_SB(inode->i_sb)->root_khandle,
f7ab093f MM	329	get_khandle_from_ino(inode));
f7ab093f MM	330
8bb8aefd	331	if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle),
f7ab093f MM	332	get_khandle_from_ino(inode)))
	333	return 0;
	334	else
	335	return 1;
	336	}
	337
8bb8aefd	338	static inline int match_handle(struct orangefs_khandle resp_handle,
f7ab093f MM	339	struct inode *inode)
	340	{
	341	gossip_debug(GOSSIP_DCACHE_DEBUG,
	342	"%s: one handle: %pU, another handle:%pU:\n",
	343	__func__,
	344	&resp_handle,
	345	get_khandle_from_ino(inode));
	346
8bb8aefd	347	if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
f7ab093f MM	348	return 0;
	349	else
	350	return 1;
	351	}
	352
	353	/*
8bb8aefd	354	* defined in orangefs-cache.c
f7ab093f MM	355	*/
	356	int op_cache_initialize(void);
	357	int op_cache_finalize(void);
8bb8aefd	358	struct orangefs_kernel_op_s *op_alloc(__s32 type);
78699e29	359	void orangefs_new_tag(struct orangefs_kernel_op_s *op);
8bb8aefd	360	char get_opname_string(struct orangefs_kernel_op_s new_op);
f7ab093f	361
8bb8aefd YL	362	int orangefs_inode_cache_initialize(void);
8bb8aefd YL	363	int orangefs_inode_cache_finalize(void);
f7ab093f	364
f7ab093f	365	/*
8bb8aefd	366	* defined in orangefs-mod.c
f7ab093f MM	367	*/
	368	void purge_inprogress_ops(void);
	369
	370	/*
	371	* defined in waitqueue.c
	372	*/
f7ab093f MM	373	void purge_waiting_ops(void);
	374
	375	/*
	376	* defined in super.c
	377	*/
482664dd MB	378	extern uint64_t orangefs_features;
482664dd MB	379
8bb8aefd	380	struct dentry orangefs_mount(struct file_system_type fst,
f7ab093f MM	381	int flags,
	382	const char *devname,
	383	void *data);
	384
8bb8aefd	385	void orangefs_kill_sb(struct super_block *sb);
45996492	386	int orangefs_remount(struct orangefs_sb_info_s *);
f7ab093f MM	387
	388	int fsid_key_table_initialize(void);
	389	void fsid_key_table_finalize(void);
	390
	391	/*
	392	* defined in inode.c
	393	*/
8bb8aefd YL	394	__u32 convert_to_orangefs_mask(unsigned long lite_mask);
8bb8aefd YL	395	struct inode orangefs_new_inode(struct super_block sb,
f7ab093f MM	396	struct inode *dir,
	397	int mode,
	398	dev_t dev,
8bb8aefd	399	struct orangefs_object_kref *ref);
f7ab093f	400
8bb8aefd	401	int orangefs_setattr(struct dentry dentry, struct iattr iattr);
f7ab093f	402
a528d35e DH	403	int orangefs_getattr(const struct path path, struct kstat stat,
a528d35e DH	404	u32 request_mask, unsigned int flags);
f7ab093f	405
933287da MB	406	int orangefs_permission(struct inode *inode, int mask);
933287da MB	407
a55f2d86 MB	408	int orangefs_update_time(struct inode , struct timespec , int);
a55f2d86 MB	409
f7ab093f MM	410	/*
	411	* defined in xattr.c
	412	*/
8bb8aefd	413	int orangefs_setxattr(struct dentry *dentry,
f7ab093f MM	414	const char *name,
	415	const void *value,
	416	size_t size,
	417	int flags);
	418
8bb8aefd	419	ssize_t orangefs_getxattr(struct dentry *dentry,
f7ab093f MM	420	const char *name,
	421	void *buffer,
	422	size_t size);
	423
8bb8aefd	424	ssize_t orangefs_listxattr(struct dentry dentry, char buffer, size_t size);
f7ab093f MM	425
	426	/*
	427	* defined in namei.c
	428	*/
8bb8aefd YL	429	struct inode orangefs_iget(struct super_block sb,
8bb8aefd YL	430	struct orangefs_object_kref *ref);
f7ab093f	431
8bb8aefd YL	432	ssize_t orangefs_inode_read(struct inode *inode,
	433	struct iov_iter *iter,
	434	loff_t *offset,
	435	loff_t readahead_size);
f7ab093f MM	436
f7ab093f MM	437	/*
8bb8aefd	438	* defined in devorangefs-req.c
f7ab093f	439	*/
482664dd	440	extern uint32_t orangefs_userspace_version;
f2ee3b75	441
8bb8aefd YL	442	int orangefs_dev_init(void);
8bb8aefd YL	443	void orangefs_dev_cleanup(void);
f7ab093f	444	int is_daemon_in_service(void);
78699e29	445	bool __is_daemon_in_service(void);
f7ab093f MM	446
f7ab093f MM	447	/*
8bb8aefd	448	* defined in orangefs-utils.c
f7ab093f	449	*/
8bb8aefd	450	__s32 fsid_of_op(struct orangefs_kernel_op_s *op);
f7ab093f	451
8bb8aefd	452	ssize_t orangefs_inode_getxattr(struct inode *inode,
f7ab093f MM	453	const char *name,
	454	void *buffer,
	455	size_t size);
	456
8bb8aefd	457	int orangefs_inode_setxattr(struct inode *inode,
f7ab093f MM	458	const char *name,
	459	const void *value,
	460	size_t size,
	461	int flags);
	462
68a24a6c MB	463	int orangefs_inode_getattr(struct inode *inode, int new, int bypass,
68a24a6c MB	464	u32 request_mask);
f7ab093f	465
5859d77e MB	466	int orangefs_inode_check_changed(struct inode *inode);
5859d77e MB	467
8bb8aefd	468	int orangefs_inode_setattr(struct inode inode, struct iattr iattr);
f7ab093f	469
8bb8aefd	470	int orangefs_unmount_sb(struct super_block *sb);
f7ab093f	471
78699e29	472	bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op);
f7ab093f	473
8bb8aefd	474	int orangefs_normalize_to_errno(__s32 error_code);
f7ab093f	475
1d503617	476	extern struct mutex orangefs_request_mutex;
f7ab093f MM	477	extern int op_timeout_secs;
f7ab093f MM	478	extern int slot_timeout_secs;
1d503617 MB	479	extern int orangefs_dcache_timeout_msecs;
1d503617 MB	480	extern int orangefs_getattr_timeout_msecs;
8bb8aefd YL	481	extern struct list_head orangefs_superblocks;
	482	extern spinlock_t orangefs_superblocks_lock;
	483	extern struct list_head orangefs_request_list;
	484	extern spinlock_t orangefs_request_list_lock;
	485	extern wait_queue_head_t orangefs_request_list_waitq;
1d503617 MB	486	extern struct list_head *orangefs_htable_ops_in_progress;
1d503617 MB	487	extern spinlock_t orangefs_htable_ops_in_progress_lock;
f7ab093f MM	488	extern int hash_table_size;
f7ab093f MM	489
8bb8aefd	490	extern const struct address_space_operations orangefs_address_operations;
6f3fc107	491	extern const struct inode_operations orangefs_file_inode_operations;
8bb8aefd	492	extern const struct file_operations orangefs_file_operations;
6f3fc107 AV	493	extern const struct inode_operations orangefs_symlink_inode_operations;
6f3fc107 AV	494	extern const struct inode_operations orangefs_dir_inode_operations;
8bb8aefd YL	495	extern const struct file_operations orangefs_dir_operations;
	496	extern const struct dentry_operations orangefs_dentry_operations;
	497	extern const struct file_operations orangefs_devreq_file_operations;
f7ab093f	498
8bb8aefd	499	extern wait_queue_head_t orangefs_bufmap_init_waitq;
f7ab093f MM	500
	501	/*
	502	* misc convenience macros
	503	*/
f7ab093f	504
8bb8aefd YL	505	#define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */
	506	#define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */
	507	#define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */
adcf34a2	508	#define ORANGEFS_OP_NO_MUTEX 8 /* don't acquire request_mutex */
8bb8aefd	509	#define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */
f7ab093f	510
8bb8aefd	511	int service_operation(struct orangefs_kernel_op_s *op,
f7ab093f MM	512	const char *op_name,
	513	int flags);
	514
f7ab093f	515	#define get_interruptible_flag(inode) \
8bb8aefd YL	516	((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
8bb8aefd YL	517	ORANGEFS_OP_INTERRUPTIBLE : 0)
f7ab093f	518
f7ab093f MM	519	#define fill_default_sys_attrs(sys_attr, type, mode) \
f7ab093f MM	520	do { \
78fee0b6 JH	521	sys_attr.owner = from_kuid(&init_user_ns, current_fsuid()); \
78fee0b6 JH	522	sys_attr.group = from_kgid(&init_user_ns, current_fsgid()); \
8bb8aefd	523	sys_attr.perms = ORANGEFS_util_translate_mode(mode); \
69a23de2 MB	524	sys_attr.mtime = 0; \
	525	sys_attr.atime = 0; \
	526	sys_attr.ctime = 0; \
8bb8aefd	527	sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \
f7ab093f MM	528	} while (0)
f7ab093f MM	529
804b1737 MS	530	static inline void orangefs_set_timeout(struct dentry *dentry)
	531	{
	532	unsigned long time = jiffies + orangefs_dcache_timeout_msecs*HZ/1000;
	533
	534	dentry->d_fsdata = (void *) time;
	535	}
	536
8bb8aefd	537	#endif /* __ORANGEFSKERNEL_H */