[deliverable/linux.git] / fs / orangefs / protocol.h

#include <linux/types.h>
#include <linux/spinlock_types.h>
#include <linux/slab.h>
#include <linux/ioctl.h>

extern struct client_debug_mask *cdm_array;
extern char *debug_help_string;
extern int help_string_initialized;
extern struct dentry *debug_dir;
extern struct dentry *help_file_dentry;
extern struct dentry *client_debug_dentry;
extern const struct file_operations debug_help_fops;
extern int client_all_index;
extern int client_verbose_index;
extern int cdm_element_count;
#define DEBUG_HELP_STRING_SIZE 4096
#define HELP_STRING_UNINITIALIZED \
	"Client Debug Keywords are unknown until the first time\n" \
	"the client is started after boot.\n"
#define ORANGEFS_KMOD_DEBUG_HELP_FILE "debug-help"
#define ORANGEFS_KMOD_DEBUG_FILE "kernel-debug"
#define ORANGEFS_CLIENT_DEBUG_FILE "client-debug"
#define ORANGEFS_VERBOSE "verbose"
#define ORANGEFS_ALL "all"

/* pvfs2-config.h ***********************************************************/
#define ORANGEFS_VERSION_MAJOR 2
#define ORANGEFS_VERSION_MINOR 9
#define ORANGEFS_VERSION_SUB 0

/* khandle stuff  ***********************************************************/

/*
 * The 2.9 core will put 64 bit handles in here like this:
 *    1234 0000 0000 5678
 * The 3.0 and beyond cores will put 128 bit handles in here like this:
 *    1234 5678 90AB CDEF
 * The kernel module will always use the first four bytes and
 * the last four bytes as an inum.
 */
struct orangefs_khandle {
	unsigned char u[16];
}  __aligned(8);

/*
 * kernel version of an object ref.
 */
struct orangefs_object_kref {
	struct orangefs_khandle khandle;
	__s32 fs_id;
	__s32 __pad1;
};

/*
 * compare 2 khandles assumes little endian thus from large address to
 * small address
 */
static inline int ORANGEFS_khandle_cmp(const struct orangefs_khandle *kh1,
				   const struct orangefs_khandle *kh2)
{
	int i;

	for (i = 15; i >= 0; i--) {
		if (kh1->u[i] > kh2->u[i])
			return 1;
		if (kh1->u[i] < kh2->u[i])
			return -1;
	}

	return 0;
}

static inline void ORANGEFS_khandle_to(const struct orangefs_khandle *kh,
				   void *p, int size)
{

	memset(p, 0, size);
	memcpy(p, kh->u, 16);

}

static inline void ORANGEFS_khandle_from(struct orangefs_khandle *kh,
				     void *p, int size)
{
	memset(kh, 0, 16);
	memcpy(kh->u, p, 16);

}

/* pvfs2-types.h ************************************************************/
typedef __u32 ORANGEFS_uid;
typedef __u32 ORANGEFS_gid;
typedef __s32 ORANGEFS_fs_id;
typedef __u32 ORANGEFS_permissions;
typedef __u64 ORANGEFS_time;
typedef __s64 ORANGEFS_size;
typedef __u64 ORANGEFS_flags;
typedef __u64 ORANGEFS_ds_position;
typedef __s32 ORANGEFS_error;
typedef __s64 ORANGEFS_offset;

#define ORANGEFS_SUPER_MAGIC 0x20030528

/*
 * ORANGEFS error codes are a signed 32-bit integer. Error codes are negative, but
 * the sign is stripped before decoding.
 */

/* Bit 31 is not used since it is the sign. */

/*
 * Bit 30 specifies that this is a ORANGEFS error. A ORANGEFS error is either an
 * encoded errno value or a ORANGEFS protocol error.
 */
#define ORANGEFS_ERROR_BIT (1 << 30)

/*
 * Bit 29 specifies that this is a ORANGEFS protocol error and not an encoded
 * errno value.
 */
#define ORANGEFS_NON_ERRNO_ERROR_BIT (1 << 29)

/*
 * Bits 9, 8, and 7 specify the error class, which encodes the section of
 * server code the error originated in for logging purposes. It is not used
 * in the kernel except to be masked out.
 */
#define ORANGEFS_ERROR_CLASS_BITS 0x380

/* Bits 6 - 0 are reserved for the actual error code. */
#define ORANGEFS_ERROR_NUMBER_BITS 0x7f

/* Encoded errno values decoded by PINT_errno_mapping in orangefs-utils.c. */

/* Our own ORANGEFS protocol error codes. */
#define ORANGEFS_ECANCEL    (1|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_EDEVINIT   (2|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_EDETAIL    (3|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_EHOSTNTFD  (4|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_EADDRNTFD  (5|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_ENORECVR   (6|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_ETRYAGAIN  (7|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_ENOTPVFS   (8|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
#define ORANGEFS_ESECURITY  (9|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)

/* permission bits */
#define ORANGEFS_O_EXECUTE (1 << 0)
#define ORANGEFS_O_WRITE   (1 << 1)
#define ORANGEFS_O_READ    (1 << 2)
#define ORANGEFS_G_EXECUTE (1 << 3)
#define ORANGEFS_G_WRITE   (1 << 4)
#define ORANGEFS_G_READ    (1 << 5)
#define ORANGEFS_U_EXECUTE (1 << 6)
#define ORANGEFS_U_WRITE   (1 << 7)
#define ORANGEFS_U_READ    (1 << 8)
/* no ORANGEFS_U_VTX (sticky bit) */
#define ORANGEFS_G_SGID    (1 << 10)
#define ORANGEFS_U_SUID    (1 << 11)

/* definition taken from stdint.h */
#define INT32_MAX (2147483647)
#define ORANGEFS_ITERATE_START    (INT32_MAX - 1)
#define ORANGEFS_ITERATE_END      (INT32_MAX - 2)
#define ORANGEFS_ITERATE_NEXT     (INT32_MAX - 3)
#define ORANGEFS_READDIR_START ORANGEFS_ITERATE_START
#define ORANGEFS_READDIR_END   ORANGEFS_ITERATE_END
#define ORANGEFS_IMMUTABLE_FL FS_IMMUTABLE_FL
#define ORANGEFS_APPEND_FL    FS_APPEND_FL
#define ORANGEFS_NOATIME_FL   FS_NOATIME_FL
#define ORANGEFS_MIRROR_FL    0x01000000ULL
#define ORANGEFS_O_EXECUTE (1 << 0)
#define ORANGEFS_FS_ID_NULL       ((__s32)0)
#define ORANGEFS_ATTR_SYS_UID                   (1 << 0)
#define ORANGEFS_ATTR_SYS_GID                   (1 << 1)
#define ORANGEFS_ATTR_SYS_PERM                  (1 << 2)
#define ORANGEFS_ATTR_SYS_ATIME                 (1 << 3)
#define ORANGEFS_ATTR_SYS_CTIME                 (1 << 4)
#define ORANGEFS_ATTR_SYS_MTIME                 (1 << 5)
#define ORANGEFS_ATTR_SYS_TYPE                  (1 << 6)
#define ORANGEFS_ATTR_SYS_ATIME_SET             (1 << 7)
#define ORANGEFS_ATTR_SYS_MTIME_SET             (1 << 8)
#define ORANGEFS_ATTR_SYS_SIZE                  (1 << 20)
#define ORANGEFS_ATTR_SYS_LNK_TARGET            (1 << 24)
#define ORANGEFS_ATTR_SYS_DFILE_COUNT           (1 << 25)
#define ORANGEFS_ATTR_SYS_DIRENT_COUNT          (1 << 26)
#define ORANGEFS_ATTR_SYS_BLKSIZE               (1 << 28)
#define ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT   (1 << 29)
#define ORANGEFS_ATTR_SYS_COMMON_ALL	\
	(ORANGEFS_ATTR_SYS_UID	|	\
	 ORANGEFS_ATTR_SYS_GID	|	\
	 ORANGEFS_ATTR_SYS_PERM	|	\
	 ORANGEFS_ATTR_SYS_ATIME	|	\
	 ORANGEFS_ATTR_SYS_CTIME	|	\
	 ORANGEFS_ATTR_SYS_MTIME	|	\
	 ORANGEFS_ATTR_SYS_TYPE)

#define ORANGEFS_ATTR_SYS_ALL_SETABLE		\
(ORANGEFS_ATTR_SYS_COMMON_ALL-ORANGEFS_ATTR_SYS_TYPE)

#define ORANGEFS_ATTR_SYS_ALL_NOHINT			\
	(ORANGEFS_ATTR_SYS_COMMON_ALL		|	\
	 ORANGEFS_ATTR_SYS_SIZE			|	\
	 ORANGEFS_ATTR_SYS_LNK_TARGET		|	\
	 ORANGEFS_ATTR_SYS_DFILE_COUNT		|	\
	 ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT	|	\
	 ORANGEFS_ATTR_SYS_DIRENT_COUNT		|	\
	 ORANGEFS_ATTR_SYS_BLKSIZE)

#define ORANGEFS_ATTR_SYS_ALL_NOHINT_NOSIZE		\
	(ORANGEFS_ATTR_SYS_COMMON_ALL		|	\
	 ORANGEFS_ATTR_SYS_LNK_TARGET		|	\
	 ORANGEFS_ATTR_SYS_DFILE_COUNT		|	\
	 ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT	|	\
	 ORANGEFS_ATTR_SYS_DIRENT_COUNT		|	\
	 ORANGEFS_ATTR_SYS_BLKSIZE)

#define ORANGEFS_XATTR_REPLACE 0x2
#define ORANGEFS_XATTR_CREATE  0x1
#define ORANGEFS_MAX_SERVER_ADDR_LEN 256
#define ORANGEFS_NAME_MAX                256
/*
 * max extended attribute name len as imposed by the VFS and exploited for the
 * upcall request types.
 * NOTE: Please retain them as multiples of 8 even if you wish to change them
 * This is *NECESSARY* for supporting 32 bit user-space binaries on a 64-bit
 * kernel. Due to implementation within DBPF, this really needs to be
 * ORANGEFS_NAME_MAX, which it was the same value as, but no reason to let it
 * break if that changes in the future.
 */
#define ORANGEFS_MAX_XATTR_NAMELEN   ORANGEFS_NAME_MAX	/* Not the same as
						 * XATTR_NAME_MAX defined
						 * by <linux/xattr.h>
						 */
#define ORANGEFS_MAX_XATTR_VALUELEN  8192	/* Not the same as XATTR_SIZE_MAX
					 * defined by <linux/xattr.h>
					 */
#define ORANGEFS_MAX_XATTR_LISTLEN   16	/* Not the same as XATTR_LIST_MAX
					 * defined by <linux/xattr.h>
					 */
/*
 * ORANGEFS I/O operation types, used in both system and server interfaces.
 */
enum ORANGEFS_io_type {
	ORANGEFS_IO_READ = 1,
	ORANGEFS_IO_WRITE = 2
};

/*
 * If this enum is modified the server parameters related to the precreate pool
 * batch and low threshold sizes may need to be modified  to reflect this
 * change.
 */
enum orangefs_ds_type {
	ORANGEFS_TYPE_NONE = 0,
	ORANGEFS_TYPE_METAFILE = (1 << 0),
	ORANGEFS_TYPE_DATAFILE = (1 << 1),
	ORANGEFS_TYPE_DIRECTORY = (1 << 2),
	ORANGEFS_TYPE_SYMLINK = (1 << 3),
	ORANGEFS_TYPE_DIRDATA = (1 << 4),
	ORANGEFS_TYPE_INTERNAL = (1 << 5)	/* for the server's private use */
};

/*
 * ORANGEFS_certificate simply stores a buffer with the buffer size.
 * The buffer can be converted to an OpenSSL X509 struct for use.
 */
struct ORANGEFS_certificate {
	__u32 buf_size;
	unsigned char *buf;
};

/*
 * A credential identifies a user and is signed by the client/user
 * private key.
 */
struct ORANGEFS_credential {
	__u32 userid;	/* user id */
	__u32 num_groups;	/* length of group_array */
	__u32 *group_array;	/* groups for which the user is a member */
	char *issuer;		/* alias of the issuing server */
	__u64 timeout;	/* seconds after epoch to time out */
	__u32 sig_size;	/* length of the signature in bytes */
	unsigned char *signature;	/* digital signature */
	struct ORANGEFS_certificate certificate;	/* user certificate buffer */
};
#define extra_size_ORANGEFS_credential (ORANGEFS_REQ_LIMIT_GROUPS	*	\
				    sizeof(__u32)		+	\
				    ORANGEFS_REQ_LIMIT_ISSUER	+	\
				    ORANGEFS_REQ_LIMIT_SIGNATURE	+	\
				    extra_size_ORANGEFS_certificate)

/* This structure is used by the VFS-client interaction alone */
struct ORANGEFS_keyval_pair {
	char key[ORANGEFS_MAX_XATTR_NAMELEN];
	__s32 key_sz;	/* __s32 for portable, fixed-size structures */
	__s32 val_sz;
	char val[ORANGEFS_MAX_XATTR_VALUELEN];
};

/* pvfs2-sysint.h ***********************************************************/
/* Describes attributes for a file, directory, or symlink. */
struct ORANGEFS_sys_attr_s {
	__u32 owner;
	__u32 group;
	__u32 perms;
	__u64 atime;
	__u64 mtime;
	__u64 ctime;
	__s64 size;

	/* NOTE: caller must free if valid */
	char *link_target;

	/* Changed to __s32 so that size of structure does not change */
	__s32 dfile_count;

	/* Changed to __s32 so that size of structure does not change */
	__s32 distr_dir_servers_initial;

	/* Changed to __s32 so that size of structure does not change */
	__s32 distr_dir_servers_max;

	/* Changed to __s32 so that size of structure does not change */
	__s32 distr_dir_split_size;

	__u32 mirror_copies_count;

	/* NOTE: caller must free if valid */
	char *dist_name;

	/* NOTE: caller must free if valid */
	char *dist_params;

	__s64 dirent_count;
	enum orangefs_ds_type objtype;
	__u64 flags;
	__u32 mask;
	__s64 blksize;
};

#define ORANGEFS_LOOKUP_LINK_NO_FOLLOW 0
#define ORANGEFS_LOOKUP_LINK_FOLLOW    1

/* pint-dev.h ***************************************************************/

/* parameter structure used in ORANGEFS_DEV_DEBUG ioctl command */
struct dev_mask_info_s {
	enum {
		KERNEL_MASK,
		CLIENT_MASK,
	} mask_type;
	__u64 mask_value;
};

struct dev_mask2_info_s {
	__u64 mask1_value;
	__u64 mask2_value;
};

/* pvfs2-util.h *************************************************************/
__s32 ORANGEFS_util_translate_mode(int mode);

/* pvfs2-debug.h ************************************************************/
#include "orangefs-debug.h"

/* pvfs2-internal.h *********************************************************/
#define llu(x) (unsigned long long)(x)
#define lld(x) (long long)(x)

/* pint-dev-shared.h ********************************************************/
#define ORANGEFS_DEV_MAGIC 'k'

#define ORANGEFS_READDIR_DEFAULT_DESC_COUNT  5

#define DEV_GET_MAGIC           0x1
#define DEV_GET_MAX_UPSIZE      0x2
#define DEV_GET_MAX_DOWNSIZE    0x3
#define DEV_MAP                 0x4
#define DEV_REMOUNT_ALL         0x5
#define DEV_DEBUG               0x6
#define DEV_UPSTREAM            0x7
#define DEV_CLIENT_MASK         0x8
#define DEV_CLIENT_STRING       0x9
#define DEV_MAX_NR              0xa

/* supported ioctls, codes are with respect to user-space */
enum {
	ORANGEFS_DEV_GET_MAGIC = _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAGIC, __s32),
	ORANGEFS_DEV_GET_MAX_UPSIZE =
	    _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_UPSIZE, __s32),
	ORANGEFS_DEV_GET_MAX_DOWNSIZE =
	    _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_DOWNSIZE, __s32),
	ORANGEFS_DEV_MAP = _IO(ORANGEFS_DEV_MAGIC, DEV_MAP),
	ORANGEFS_DEV_REMOUNT_ALL = _IO(ORANGEFS_DEV_MAGIC, DEV_REMOUNT_ALL),
	ORANGEFS_DEV_DEBUG = _IOR(ORANGEFS_DEV_MAGIC, DEV_DEBUG, __s32),
	ORANGEFS_DEV_UPSTREAM = _IOW(ORANGEFS_DEV_MAGIC, DEV_UPSTREAM, int),
	ORANGEFS_DEV_CLIENT_MASK = _IOW(ORANGEFS_DEV_MAGIC,
				    DEV_CLIENT_MASK,
				    struct dev_mask2_info_s),
	ORANGEFS_DEV_CLIENT_STRING = _IOW(ORANGEFS_DEV_MAGIC,
				      DEV_CLIENT_STRING,
				      char *),
	ORANGEFS_DEV_MAXNR = DEV_MAX_NR,
};

/*
 * version number for use in communicating between kernel space and user
 * space. Zero signifies the upstream version of the kernel module.
 */
#define ORANGEFS_KERNEL_PROTO_VERSION 0
#define ORANGEFS_MINIMUM_USERSPACE_VERSION 20904

/*
 * describes memory regions to map in the ORANGEFS_DEV_MAP ioctl.
 * NOTE: See devorangefs-req.c for 32 bit compat structure.
 * Since this structure has a variable-sized layout that is different
 * on 32 and 64 bit platforms, we need to normalize to a 64 bit layout
 * on such systems before servicing ioctl calls from user-space binaries
 * that may be 32 bit!
 */
struct ORANGEFS_dev_map_desc {
	void *ptr;
	__s32 total_size;
	__s32 size;
	__s32 count;
};

/* gossip.h *****************************************************************/

#ifdef GOSSIP_DISABLE_DEBUG
#define gossip_debug(mask, format, f...) do {} while (0)
#else
extern __u64 gossip_debug_mask;
extern struct client_debug_mask client_debug_mask;

/* try to avoid function call overhead by checking masks in macro */
#define gossip_debug(mask, format, f...)			\
do {								\
	if (gossip_debug_mask & mask)				\
		printk(format, ##f);				\
} while (0)
#endif /* GOSSIP_DISABLE_DEBUG */

/* do file and line number printouts w/ the GNU preprocessor */
#define gossip_ldebug(mask, format, f...)				\
		gossip_debug(mask, "%s: " format, __func__, ##f)

#define gossip_err printk
#define gossip_lerr(format, f...)					\
		gossip_err("%s line %d: " format,			\
			   __FILE__,					\
			   __LINE__,					\
			   ##f)
Commit	Line	Data
f7ab093f	1	#include <linux/types.h>
81b784b1	2	#include <linux/spinlock_types.h>
f7ab093f	3	#include <linux/slab.h>
2c590d5f	4	#include <linux/ioctl.h>
f7ab093f MM	5
	6	extern struct client_debug_mask *cdm_array;
	7	extern char *debug_help_string;
	8	extern int help_string_initialized;
	9	extern struct dentry *debug_dir;
	10	extern struct dentry *help_file_dentry;
	11	extern struct dentry *client_debug_dentry;
	12	extern const struct file_operations debug_help_fops;
	13	extern int client_all_index;
	14	extern int client_verbose_index;
	15	extern int cdm_element_count;
	16	#define DEBUG_HELP_STRING_SIZE 4096
	17	#define HELP_STRING_UNINITIALIZED \
	18	"Client Debug Keywords are unknown until the first time\n" \
	19	"the client is started after boot.\n"
	20	#define ORANGEFS_KMOD_DEBUG_HELP_FILE "debug-help"
	21	#define ORANGEFS_KMOD_DEBUG_FILE "kernel-debug"
	22	#define ORANGEFS_CLIENT_DEBUG_FILE "client-debug"
8bb8aefd YL	23	#define ORANGEFS_VERBOSE "verbose"
8bb8aefd YL	24	#define ORANGEFS_ALL "all"
f7ab093f MM	25
f7ab093f MM	26	/* pvfs2-config.h ***********************************************************/
8bb8aefd YL	27	#define ORANGEFS_VERSION_MAJOR 2
	28	#define ORANGEFS_VERSION_MINOR 9
	29	#define ORANGEFS_VERSION_SUB 0
f7ab093f MM	30
	31	/* khandle stuff ***********************************************************/
	32
	33	/*
	34	* The 2.9 core will put 64 bit handles in here like this:
	35	* 1234 0000 0000 5678
	36	* The 3.0 and beyond cores will put 128 bit handles in here like this:
	37	* 1234 5678 90AB CDEF
	38	* The kernel module will always use the first four bytes and
	39	* the last four bytes as an inum.
	40	*/
8bb8aefd	41	struct orangefs_khandle {
f7ab093f MM	42	unsigned char u[16];
	43	} __aligned(8);
	44
	45	/*
	46	* kernel version of an object ref.
	47	*/
8bb8aefd YL	48	struct orangefs_object_kref {
8bb8aefd YL	49	struct orangefs_khandle khandle;
f7ab093f MM	50	__s32 fs_id;
	51	__s32 __pad1;
	52	};
	53
	54	/*
	55	* compare 2 khandles assumes little endian thus from large address to
	56	* small address
	57	*/
8bb8aefd YL	58	static inline int ORANGEFS_khandle_cmp(const struct orangefs_khandle *kh1,
8bb8aefd YL	59	const struct orangefs_khandle *kh2)
f7ab093f MM	60	{
	61	int i;
	62
	63	for (i = 15; i >= 0; i--) {
	64	if (kh1->u[i] > kh2->u[i])
	65	return 1;
	66	if (kh1->u[i] < kh2->u[i])
	67	return -1;
	68	}
	69
	70	return 0;
	71	}
	72
8bb8aefd	73	static inline void ORANGEFS_khandle_to(const struct orangefs_khandle *kh,
f7ab093f MM	74	void *p, int size)
f7ab093f MM	75	{
f7ab093f MM	76
f7ab093f MM	77	memset(p, 0, size);
50e01586	78	memcpy(p, kh->u, 16);
f7ab093f	79
f7ab093f MM	80	}
f7ab093f MM	81
8bb8aefd	82	static inline void ORANGEFS_khandle_from(struct orangefs_khandle *kh,
f7ab093f MM	83	void *p, int size)
f7ab093f MM	84	{
f7ab093f	85	memset(kh, 0, 16);
50e01586	86	memcpy(kh->u, p, 16);
f7ab093f	87
f7ab093f MM	88	}
	89
	90	/* pvfs2-types.h ************************************************************/
8bb8aefd YL	91	typedef __u32 ORANGEFS_uid;
	92	typedef __u32 ORANGEFS_gid;
	93	typedef __s32 ORANGEFS_fs_id;
	94	typedef __u32 ORANGEFS_permissions;
	95	typedef __u64 ORANGEFS_time;
	96	typedef __s64 ORANGEFS_size;
	97	typedef __u64 ORANGEFS_flags;
	98	typedef __u64 ORANGEFS_ds_position;
	99	typedef __s32 ORANGEFS_error;
	100	typedef __s64 ORANGEFS_offset;
	101
	102	#define ORANGEFS_SUPER_MAGIC 0x20030528
f7ab093f	103
54804949	104	/*
8bb8aefd	105	* ORANGEFS error codes are a signed 32-bit integer. Error codes are negative, but
54804949 MM	106	* the sign is stripped before decoding.
54804949 MM	107	*/
f7ab093f	108
894ac432	109	/* Bit 31 is not used since it is the sign. */
f7ab093f	110
54804949	111	/*
8bb8aefd YL	112	* Bit 30 specifies that this is a ORANGEFS error. A ORANGEFS error is either an
8bb8aefd YL	113	* encoded errno value or a ORANGEFS protocol error.
54804949	114	*/
8bb8aefd	115	#define ORANGEFS_ERROR_BIT (1 << 30)
f7ab093f	116
54804949	117	/*
8bb8aefd	118	* Bit 29 specifies that this is a ORANGEFS protocol error and not an encoded
54804949 MM	119	* errno value.
54804949 MM	120	*/
8bb8aefd	121	#define ORANGEFS_NON_ERRNO_ERROR_BIT (1 << 29)
f7ab093f	122
54804949 MM	123	/*
54804949 MM	124	* Bits 9, 8, and 7 specify the error class, which encodes the section of
894ac432	125	* server code the error originated in for logging purposes. It is not used
54804949 MM	126	* in the kernel except to be masked out.
54804949 MM	127	*/
8bb8aefd	128	#define ORANGEFS_ERROR_CLASS_BITS 0x380
894ac432 MB	129
894ac432 MB	130	/* Bits 6 - 0 are reserved for the actual error code. */
8bb8aefd	131	#define ORANGEFS_ERROR_NUMBER_BITS 0x7f
894ac432	132
575e9461	133	/* Encoded errno values decoded by PINT_errno_mapping in orangefs-utils.c. */
894ac432	134
8bb8aefd YL	135	/* Our own ORANGEFS protocol error codes. */
	136	#define ORANGEFS_ECANCEL (1\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	137	#define ORANGEFS_EDEVINIT (2\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	138	#define ORANGEFS_EDETAIL (3\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	139	#define ORANGEFS_EHOSTNTFD (4\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	140	#define ORANGEFS_EADDRNTFD (5\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	141	#define ORANGEFS_ENORECVR (6\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	142	#define ORANGEFS_ETRYAGAIN (7\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	143	#define ORANGEFS_ENOTPVFS (8\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
	144	#define ORANGEFS_ESECURITY (9\|ORANGEFS_NON_ERRNO_ERROR_BIT\|ORANGEFS_ERROR_BIT)
f7ab093f MM	145
f7ab093f MM	146	/* permission bits */
8bb8aefd YL	147	#define ORANGEFS_O_EXECUTE (1 << 0)
	148	#define ORANGEFS_O_WRITE (1 << 1)
	149	#define ORANGEFS_O_READ (1 << 2)
	150	#define ORANGEFS_G_EXECUTE (1 << 3)
	151	#define ORANGEFS_G_WRITE (1 << 4)
	152	#define ORANGEFS_G_READ (1 << 5)
	153	#define ORANGEFS_U_EXECUTE (1 << 6)
	154	#define ORANGEFS_U_WRITE (1 << 7)
	155	#define ORANGEFS_U_READ (1 << 8)
	156	/* no ORANGEFS_U_VTX (sticky bit) */
	157	#define ORANGEFS_G_SGID (1 << 10)
	158	#define ORANGEFS_U_SUID (1 << 11)
f7ab093f MM	159
	160	/* definition taken from stdint.h */
	161	#define INT32_MAX (2147483647)
8bb8aefd YL	162	#define ORANGEFS_ITERATE_START (INT32_MAX - 1)
	163	#define ORANGEFS_ITERATE_END (INT32_MAX - 2)
	164	#define ORANGEFS_ITERATE_NEXT (INT32_MAX - 3)
	165	#define ORANGEFS_READDIR_START ORANGEFS_ITERATE_START
	166	#define ORANGEFS_READDIR_END ORANGEFS_ITERATE_END
	167	#define ORANGEFS_IMMUTABLE_FL FS_IMMUTABLE_FL
	168	#define ORANGEFS_APPEND_FL FS_APPEND_FL
	169	#define ORANGEFS_NOATIME_FL FS_NOATIME_FL
	170	#define ORANGEFS_MIRROR_FL 0x01000000ULL
	171	#define ORANGEFS_O_EXECUTE (1 << 0)
	172	#define ORANGEFS_FS_ID_NULL ((__s32)0)
	173	#define ORANGEFS_ATTR_SYS_UID (1 << 0)
	174	#define ORANGEFS_ATTR_SYS_GID (1 << 1)
	175	#define ORANGEFS_ATTR_SYS_PERM (1 << 2)
	176	#define ORANGEFS_ATTR_SYS_ATIME (1 << 3)
	177	#define ORANGEFS_ATTR_SYS_CTIME (1 << 4)
	178	#define ORANGEFS_ATTR_SYS_MTIME (1 << 5)
	179	#define ORANGEFS_ATTR_SYS_TYPE (1 << 6)
	180	#define ORANGEFS_ATTR_SYS_ATIME_SET (1 << 7)
	181	#define ORANGEFS_ATTR_SYS_MTIME_SET (1 << 8)
	182	#define ORANGEFS_ATTR_SYS_SIZE (1 << 20)
	183	#define ORANGEFS_ATTR_SYS_LNK_TARGET (1 << 24)
	184	#define ORANGEFS_ATTR_SYS_DFILE_COUNT (1 << 25)
	185	#define ORANGEFS_ATTR_SYS_DIRENT_COUNT (1 << 26)
	186	#define ORANGEFS_ATTR_SYS_BLKSIZE (1 << 28)
	187	#define ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT (1 << 29)
	188	#define ORANGEFS_ATTR_SYS_COMMON_ALL \
	189	(ORANGEFS_ATTR_SYS_UID \| \
	190	ORANGEFS_ATTR_SYS_GID \| \
	191	ORANGEFS_ATTR_SYS_PERM \| \
	192	ORANGEFS_ATTR_SYS_ATIME \| \
	193	ORANGEFS_ATTR_SYS_CTIME \| \
	194	ORANGEFS_ATTR_SYS_MTIME \| \
	195	ORANGEFS_ATTR_SYS_TYPE)
	196
	197	#define ORANGEFS_ATTR_SYS_ALL_SETABLE \
	198	(ORANGEFS_ATTR_SYS_COMMON_ALL-ORANGEFS_ATTR_SYS_TYPE)
	199
	200	#define ORANGEFS_ATTR_SYS_ALL_NOHINT \
	201	(ORANGEFS_ATTR_SYS_COMMON_ALL \| \
	202	ORANGEFS_ATTR_SYS_SIZE \| \
	203	ORANGEFS_ATTR_SYS_LNK_TARGET \| \
	204	ORANGEFS_ATTR_SYS_DFILE_COUNT \| \
	205	ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT \| \
	206	ORANGEFS_ATTR_SYS_DIRENT_COUNT \| \
	207	ORANGEFS_ATTR_SYS_BLKSIZE)
933287da MB	208
	209	#define ORANGEFS_ATTR_SYS_ALL_NOHINT_NOSIZE \
	210	(ORANGEFS_ATTR_SYS_COMMON_ALL \| \
	211	ORANGEFS_ATTR_SYS_LNK_TARGET \| \
	212	ORANGEFS_ATTR_SYS_DFILE_COUNT \| \
	213	ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT \| \
	214	ORANGEFS_ATTR_SYS_DIRENT_COUNT \| \
	215	ORANGEFS_ATTR_SYS_BLKSIZE)
	216
8bb8aefd YL	217	#define ORANGEFS_XATTR_REPLACE 0x2
	218	#define ORANGEFS_XATTR_CREATE 0x1
	219	#define ORANGEFS_MAX_SERVER_ADDR_LEN 256
	220	#define ORANGEFS_NAME_MAX 256
f7ab093f MM	221	/*
	222	* max extended attribute name len as imposed by the VFS and exploited for the
	223	* upcall request types.
	224	* NOTE: Please retain them as multiples of 8 even if you wish to change them
	225	* This is NECESSARY for supporting 32 bit user-space binaries on a 64-bit
	226	* kernel. Due to implementation within DBPF, this really needs to be
8bb8aefd	227	* ORANGEFS_NAME_MAX, which it was the same value as, but no reason to let it
f7ab093f MM	228	* break if that changes in the future.
f7ab093f MM	229	*/
8bb8aefd	230	#define ORANGEFS_MAX_XATTR_NAMELEN ORANGEFS_NAME_MAX /* Not the same as
f7ab093f MM	231	* XATTR_NAME_MAX defined
	232	* by <linux/xattr.h>
	233	*/
8bb8aefd	234	#define ORANGEFS_MAX_XATTR_VALUELEN 8192 /* Not the same as XATTR_SIZE_MAX
f7ab093f MM	235	* defined by <linux/xattr.h>
f7ab093f MM	236	*/
8bb8aefd	237	#define ORANGEFS_MAX_XATTR_LISTLEN 16 /* Not the same as XATTR_LIST_MAX
f7ab093f MM	238	* defined by <linux/xattr.h>
	239	*/
	240	/*
8bb8aefd	241	* ORANGEFS I/O operation types, used in both system and server interfaces.
f7ab093f	242	*/
8bb8aefd YL	243	enum ORANGEFS_io_type {
	244	ORANGEFS_IO_READ = 1,
	245	ORANGEFS_IO_WRITE = 2
f7ab093f MM	246	};
	247
	248	/*
	249	* If this enum is modified the server parameters related to the precreate pool
	250	* batch and low threshold sizes may need to be modified to reflect this
	251	* change.
	252	*/
8bb8aefd YL	253	enum orangefs_ds_type {
	254	ORANGEFS_TYPE_NONE = 0,
	255	ORANGEFS_TYPE_METAFILE = (1 << 0),
	256	ORANGEFS_TYPE_DATAFILE = (1 << 1),
	257	ORANGEFS_TYPE_DIRECTORY = (1 << 2),
	258	ORANGEFS_TYPE_SYMLINK = (1 << 3),
	259	ORANGEFS_TYPE_DIRDATA = (1 << 4),
	260	ORANGEFS_TYPE_INTERNAL = (1 << 5) /* for the server's private use */
f7ab093f MM	261	};
	262
	263	/*
8bb8aefd	264	* ORANGEFS_certificate simply stores a buffer with the buffer size.
f7ab093f MM	265	* The buffer can be converted to an OpenSSL X509 struct for use.
f7ab093f MM	266	*/
8bb8aefd	267	struct ORANGEFS_certificate {
f7ab093f MM	268	__u32 buf_size;
	269	unsigned char *buf;
	270	};
	271
	272	/*
	273	* A credential identifies a user and is signed by the client/user
	274	* private key.
	275	*/
8bb8aefd	276	struct ORANGEFS_credential {
f7ab093f MM	277	__u32 userid; /* user id */
	278	__u32 num_groups; /* length of group_array */
	279	__u32 group_array; / groups for which the user is a member */
	280	char issuer; / alias of the issuing server */
	281	__u64 timeout; /* seconds after epoch to time out */
	282	__u32 sig_size; /* length of the signature in bytes */
	283	unsigned char signature; / digital signature */
8bb8aefd	284	struct ORANGEFS_certificate certificate; /* user certificate buffer */
f7ab093f	285	};
8bb8aefd	286	#define extra_size_ORANGEFS_credential (ORANGEFS_REQ_LIMIT_GROUPS * \
f7ab093f	287	sizeof(__u32) + \
8bb8aefd YL	288	ORANGEFS_REQ_LIMIT_ISSUER + \
	289	ORANGEFS_REQ_LIMIT_SIGNATURE + \
	290	extra_size_ORANGEFS_certificate)
f7ab093f MM	291
f7ab093f MM	292	/* This structure is used by the VFS-client interaction alone */
8bb8aefd YL	293	struct ORANGEFS_keyval_pair {
8bb8aefd YL	294	char key[ORANGEFS_MAX_XATTR_NAMELEN];
f7ab093f MM	295	__s32 key_sz; /* __s32 for portable, fixed-size structures */
f7ab093f MM	296	__s32 val_sz;
8bb8aefd	297	char val[ORANGEFS_MAX_XATTR_VALUELEN];
f7ab093f MM	298	};
	299
	300	/* pvfs2-sysint.h ***********************************************************/
	301	/* Describes attributes for a file, directory, or symlink. */
8bb8aefd	302	struct ORANGEFS_sys_attr_s {
f7ab093f MM	303	__u32 owner;
	304	__u32 group;
	305	__u32 perms;
	306	__u64 atime;
	307	__u64 mtime;
	308	__u64 ctime;
	309	__s64 size;
	310
	311	/* NOTE: caller must free if valid */
	312	char *link_target;
	313
	314	/* Changed to __s32 so that size of structure does not change */
	315	__s32 dfile_count;
	316
	317	/* Changed to __s32 so that size of structure does not change */
	318	__s32 distr_dir_servers_initial;
	319
	320	/* Changed to __s32 so that size of structure does not change */
	321	__s32 distr_dir_servers_max;
	322
	323	/* Changed to __s32 so that size of structure does not change */
	324	__s32 distr_dir_split_size;
	325
	326	__u32 mirror_copies_count;
	327
	328	/* NOTE: caller must free if valid */
	329	char *dist_name;
	330
	331	/* NOTE: caller must free if valid */
	332	char *dist_params;
	333
	334	__s64 dirent_count;
8bb8aefd	335	enum orangefs_ds_type objtype;
f7ab093f MM	336	__u64 flags;
	337	__u32 mask;
	338	__s64 blksize;
	339	};
	340
8bb8aefd YL	341	#define ORANGEFS_LOOKUP_LINK_NO_FOLLOW 0
8bb8aefd YL	342	#define ORANGEFS_LOOKUP_LINK_FOLLOW 1
f7ab093f MM	343
	344	/* pint-dev.h ***************************************************************/
	345
8bb8aefd	346	/* parameter structure used in ORANGEFS_DEV_DEBUG ioctl command */
f7ab093f MM	347	struct dev_mask_info_s {
	348	enum {
	349	KERNEL_MASK,
	350	CLIENT_MASK,
	351	} mask_type;
	352	__u64 mask_value;
	353	};
	354
	355	struct dev_mask2_info_s {
	356	__u64 mask1_value;
	357	__u64 mask2_value;
	358	};
	359
	360	/* pvfs2-util.h *************************************************************/
8bb8aefd	361	__s32 ORANGEFS_util_translate_mode(int mode);
f7ab093f MM	362
f7ab093f MM	363	/* pvfs2-debug.h ************************************************************/
575e9461	364	#include "orangefs-debug.h"
f7ab093f MM	365
	366	/* pvfs2-internal.h *********************************************************/
	367	#define llu(x) (unsigned long long)(x)
	368	#define lld(x) (long long)(x)
	369
	370	/* pint-dev-shared.h ********************************************************/
8bb8aefd	371	#define ORANGEFS_DEV_MAGIC 'k'
f7ab093f	372
8bb8aefd	373	#define ORANGEFS_READDIR_DEFAULT_DESC_COUNT 5
f7ab093f MM	374
	375	#define DEV_GET_MAGIC 0x1
	376	#define DEV_GET_MAX_UPSIZE 0x2
	377	#define DEV_GET_MAX_DOWNSIZE 0x3
	378	#define DEV_MAP 0x4
	379	#define DEV_REMOUNT_ALL 0x5
	380	#define DEV_DEBUG 0x6
	381	#define DEV_UPSTREAM 0x7
	382	#define DEV_CLIENT_MASK 0x8
	383	#define DEV_CLIENT_STRING 0x9
	384	#define DEV_MAX_NR 0xa
	385
	386	/* supported ioctls, codes are with respect to user-space */
	387	enum {
8bb8aefd YL	388	ORANGEFS_DEV_GET_MAGIC = _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAGIC, __s32),
	389	ORANGEFS_DEV_GET_MAX_UPSIZE =
	390	_IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_UPSIZE, __s32),
	391	ORANGEFS_DEV_GET_MAX_DOWNSIZE =
	392	_IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_DOWNSIZE, __s32),
	393	ORANGEFS_DEV_MAP = _IO(ORANGEFS_DEV_MAGIC, DEV_MAP),
	394	ORANGEFS_DEV_REMOUNT_ALL = _IO(ORANGEFS_DEV_MAGIC, DEV_REMOUNT_ALL),
	395	ORANGEFS_DEV_DEBUG = _IOR(ORANGEFS_DEV_MAGIC, DEV_DEBUG, __s32),
	396	ORANGEFS_DEV_UPSTREAM = _IOW(ORANGEFS_DEV_MAGIC, DEV_UPSTREAM, int),
	397	ORANGEFS_DEV_CLIENT_MASK = _IOW(ORANGEFS_DEV_MAGIC,
f7ab093f MM	398	DEV_CLIENT_MASK,
f7ab093f MM	399	struct dev_mask2_info_s),
8bb8aefd	400	ORANGEFS_DEV_CLIENT_STRING = _IOW(ORANGEFS_DEV_MAGIC,
f7ab093f MM	401	DEV_CLIENT_STRING,
f7ab093f MM	402	char *),
8bb8aefd	403	ORANGEFS_DEV_MAXNR = DEV_MAX_NR,
f7ab093f MM	404	};
	405
	406	/*
	407	* version number for use in communicating between kernel space and user
54804949	408	* space. Zero signifies the upstream version of the kernel module.
f7ab093f	409	*/
8bb8aefd	410	#define ORANGEFS_KERNEL_PROTO_VERSION 0
569dbfc6	411	#define ORANGEFS_MINIMUM_USERSPACE_VERSION 20904
f7ab093f MM	412
f7ab093f MM	413	/*
8bb8aefd	414	* describes memory regions to map in the ORANGEFS_DEV_MAP ioctl.
575e9461	415	* NOTE: See devorangefs-req.c for 32 bit compat structure.
f7ab093f MM	416	* Since this structure has a variable-sized layout that is different
	417	* on 32 and 64 bit platforms, we need to normalize to a 64 bit layout
	418	* on such systems before servicing ioctl calls from user-space binaries
	419	* that may be 32 bit!
	420	*/
8bb8aefd	421	struct ORANGEFS_dev_map_desc {
f7ab093f MM	422	void *ptr;
	423	__s32 total_size;
	424	__s32 size;
	425	__s32 count;
	426	};
	427
	428	/* gossip.h *****************************************************************/
	429
	430	#ifdef GOSSIP_DISABLE_DEBUG
	431	#define gossip_debug(mask, format, f...) do {} while (0)
	432	#else
	433	extern __u64 gossip_debug_mask;
	434	extern struct client_debug_mask client_debug_mask;
	435
	436	/* try to avoid function call overhead by checking masks in macro */
	437	#define gossip_debug(mask, format, f...) \
	438	do { \
	439	if (gossip_debug_mask & mask) \
	440	printk(format, ##f); \
	441	} while (0)
	442	#endif /* GOSSIP_DISABLE_DEBUG */
	443
	444	/* do file and line number printouts w/ the GNU preprocessor */
	445	#define gossip_ldebug(mask, format, f...) \
	446	gossip_debug(mask, "%s: " format, __func__, ##f)
	447
	448	#define gossip_err printk
	449	#define gossip_lerr(format, f...) \
	450	gossip_err("%s line %d: " format, \
	451	__FILE__, \
	452	__LINE__, \
	453	##f)