[mirror_ubuntu-artful-kernel.git] / fs / nfs / callback.h

/*
 * linux/fs/nfs/callback.h
 *
 * Copyright (C) 2004 Trond Myklebust
 *
 * NFSv4 callback definitions
 */
#ifndef __LINUX_FS_NFS_CALLBACK_H
#define __LINUX_FS_NFS_CALLBACK_H
#include <linux/sunrpc/svc.h>

#define NFS4_CALLBACK 0x40000000
#define NFS4_CALLBACK_XDRSIZE 2048
#define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)

enum nfs4_callback_procnum {
	CB_NULL = 0,
	CB_COMPOUND = 1,
};

enum nfs4_callback_opnum {
	OP_CB_GETATTR = 3,
	OP_CB_RECALL  = 4,
/* Callback operations new to NFSv4.1 */
	OP_CB_LAYOUTRECALL  = 5,
	OP_CB_NOTIFY        = 6,
	OP_CB_PUSH_DELEG    = 7,
	OP_CB_RECALL_ANY    = 8,
	OP_CB_RECALLABLE_OBJ_AVAIL = 9,
	OP_CB_RECALL_SLOT   = 10,
	OP_CB_SEQUENCE      = 11,
	OP_CB_WANTS_CANCELLED = 12,
	OP_CB_NOTIFY_LOCK   = 13,
	OP_CB_NOTIFY_DEVICEID = 14,
/* Callback operations new to NFSv4.2 */
	OP_CB_OFFLOAD = 15,
	OP_CB_ILLEGAL = 10044,
};

struct nfs4_slot;
struct cb_process_state {
	__be32			drc_status;
	struct nfs_client	*clp;
	struct nfs4_slot	*slot;
	u32			minorversion;
	struct net		*net;
};

struct cb_compound_hdr_arg {
	unsigned int taglen;
	const char *tag;
	unsigned int minorversion;
	unsigned int cb_ident; /* v4.0 callback identifier */
	unsigned nops;
};

struct cb_compound_hdr_res {
	__be32 *status;
	unsigned int taglen;
	const char *tag;
	__be32 *nops;
};

struct cb_getattrargs {
	struct nfs_fh fh;
	uint32_t bitmap[2];
};

struct cb_getattrres {
	__be32 status;
	uint32_t bitmap[2];
	uint64_t size;
	uint64_t change_attr;
	struct timespec ctime;
	struct timespec mtime;
};

struct cb_recallargs {
	struct nfs_fh fh;
	nfs4_stateid stateid;
	uint32_t truncate;
};

#if defined(CONFIG_NFS_V4_1)

struct referring_call {
	uint32_t			rc_sequenceid;
	uint32_t			rc_slotid;
};

struct referring_call_list {
	struct nfs4_sessionid		rcl_sessionid;
	uint32_t			rcl_nrefcalls;
	struct referring_call 		*rcl_refcalls;
};

struct cb_sequenceargs {
	struct sockaddr			*csa_addr;
	struct nfs4_sessionid		csa_sessionid;
	uint32_t			csa_sequenceid;
	uint32_t			csa_slotid;
	uint32_t			csa_highestslotid;
	uint32_t			csa_cachethis;
	uint32_t			csa_nrclists;
	struct referring_call_list	*csa_rclists;
};

struct cb_sequenceres {
	__be32				csr_status;
	struct nfs4_sessionid		csr_sessionid;
	uint32_t			csr_sequenceid;
	uint32_t			csr_slotid;
	uint32_t			csr_highestslotid;
	uint32_t			csr_target_highestslotid;
};

extern __be32 nfs4_callback_sequence(void *argp, void *resp,
				       struct cb_process_state *cps);

#define RCA4_TYPE_MASK_RDATA_DLG	0
#define RCA4_TYPE_MASK_WDATA_DLG	1
#define RCA4_TYPE_MASK_DIR_DLG         2
#define RCA4_TYPE_MASK_FILE_LAYOUT     3
#define RCA4_TYPE_MASK_BLK_LAYOUT      4
#define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN  8
#define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX  9
#define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12
#define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15
#define RCA4_TYPE_MASK_ALL 0xf31f

struct cb_recallanyargs {
	uint32_t	craa_objs_to_keep;
	uint32_t	craa_type_mask;
};

extern __be32 nfs4_callback_recallany(void *argp, void *resp,
					struct cb_process_state *cps);

struct cb_recallslotargs {
	uint32_t	crsa_target_highest_slotid;
};
extern __be32 nfs4_callback_recallslot(void *argp, void *resp,
					 struct cb_process_state *cps);

struct cb_layoutrecallargs {
	uint32_t		cbl_recall_type;
	uint32_t		cbl_layout_type;
	uint32_t		cbl_layoutchanged;
	union {
		struct {
			struct nfs_fh		cbl_fh;
			struct pnfs_layout_range cbl_range;
			nfs4_stateid		cbl_stateid;
		};
		struct nfs_fsid		cbl_fsid;
	};
};

extern __be32 nfs4_callback_layoutrecall(void *argp, void *resp,
		struct cb_process_state *cps);

struct cb_devicenotifyitem {
	uint32_t		cbd_notify_type;
	uint32_t		cbd_layout_type;
	struct nfs4_deviceid	cbd_dev_id;
	uint32_t		cbd_immediate;
};

struct cb_devicenotifyargs {
	int				 ndevs;
	struct cb_devicenotifyitem	 *devs;
};

extern __be32 nfs4_callback_devicenotify(void *argp, void *resp,
		struct cb_process_state *cps);

struct cb_notify_lock_args {
	struct nfs_fh			cbnl_fh;
	struct nfs_lowner		cbnl_owner;
	bool				cbnl_valid;
};

extern __be32 nfs4_callback_notify_lock(void *argp, void *resp,
					 struct cb_process_state *cps);
#endif /* CONFIG_NFS_V4_1 */
extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
extern __be32 nfs4_callback_getattr(void *argp, void *resp,
				    struct cb_process_state *cps);
extern __be32 nfs4_callback_recall(void *argp, void *resp,
				   struct cb_process_state *cps);
#if IS_ENABLED(CONFIG_NFS_V4)
extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
extern void nfs_callback_down(int minorversion, struct net *net);
#endif /* CONFIG_NFS_V4 */
/*
 * nfs41: Callbacks are expected to not cause substantial latency,
 * so we limit their concurrency to 1 by setting up the maximum number
 * of slots for the backchannel.
 */
#define NFS41_BC_MIN_CALLBACKS 1
#define NFS41_BC_MAX_CALLBACKS 1

#define NFS4_MIN_NR_CALLBACK_THREADS 1

extern unsigned int nfs_callback_set_tcpport;
extern unsigned short nfs_callback_nr_threads;

#endif /* __LINUX_FS_NFS_CALLBACK_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/fs/nfs/callback.h
	3	*
	4	* Copyright (C) 2004 Trond Myklebust
	5	*
	6	* NFSv4 callback definitions
	7	*/
	8	#ifndef __LINUX_FS_NFS_CALLBACK_H
	9	#define __LINUX_FS_NFS_CALLBACK_H
778be232	10	#include <linux/sunrpc/svc.h>
1da177e4 LT	11
	12	#define NFS4_CALLBACK 0x40000000
	13	#define NFS4_CALLBACK_XDRSIZE 2048
	14	#define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)
	15
	16	enum nfs4_callback_procnum {
	17	CB_NULL = 0,
	18	CB_COMPOUND = 1,
	19	};
	20
	21	enum nfs4_callback_opnum {
	22	OP_CB_GETATTR = 3,
	23	OP_CB_RECALL = 4,
45377b94 BH	24	/* Callback operations new to NFSv4.1 */
	25	OP_CB_LAYOUTRECALL = 5,
	26	OP_CB_NOTIFY = 6,
	27	OP_CB_PUSH_DELEG = 7,
	28	OP_CB_RECALL_ANY = 8,
	29	OP_CB_RECALLABLE_OBJ_AVAIL = 9,
	30	OP_CB_RECALL_SLOT = 10,
	31	OP_CB_SEQUENCE = 11,
	32	OP_CB_WANTS_CANCELLED = 12,
	33	OP_CB_NOTIFY_LOCK = 13,
34bc47c9	34	OP_CB_NOTIFY_DEVICEID = 14,
6b140b85 BS	35	/* Callback operations new to NFSv4.2 */
6b140b85 BS	36	OP_CB_OFFLOAD = 15,
1da177e4 LT	37	OP_CB_ILLEGAL = 10044,
	38	};
	39
810d82e6	40	struct nfs4_slot;
c36fca52 AA	41	struct cb_process_state {
	42	__be32 drc_status;
	43	struct nfs_client *clp;
810d82e6	44	struct nfs4_slot *slot;
459de2ed	45	u32 minorversion;
c7add9a9	46	struct net *net;
c36fca52 AA	47	};
c36fca52 AA	48
1da177e4	49	struct cb_compound_hdr_arg {
2e42c3e2	50	unsigned int taglen;
1da177e4	51	const char *tag;
b8f2ef84	52	unsigned int minorversion;
c36fca52	53	unsigned int cb_ident; /* v4.0 callback identifier */
1da177e4 LT	54	unsigned nops;
	55	};
	56
	57	struct cb_compound_hdr_res {
5704fdeb	58	__be32 *status;
2e42c3e2	59	unsigned int taglen;
1da177e4	60	const char *tag;
5704fdeb	61	__be32 *nops;
1da177e4 LT	62	};
	63
	64	struct cb_getattrargs {
1da177e4 LT	65	struct nfs_fh fh;
	66	uint32_t bitmap[2];
	67	};
	68
	69	struct cb_getattrres {
e6f684f6	70	__be32 status;
1da177e4 LT	71	uint32_t bitmap[2];
	72	uint64_t size;
	73	uint64_t change_attr;
	74	struct timespec ctime;
	75	struct timespec mtime;
	76	};
	77
	78	struct cb_recallargs {
1da177e4 LT	79	struct nfs_fh fh;
	80	nfs4_stateid stateid;
	81	uint32_t truncate;
	82	};
	83
2d9b9ec3 BH	84	#if defined(CONFIG_NFS_V4_1)
	85
	86	struct referring_call {
	87	uint32_t rc_sequenceid;
	88	uint32_t rc_slotid;
	89	};
	90
	91	struct referring_call_list {
	92	struct nfs4_sessionid rcl_sessionid;
	93	uint32_t rcl_nrefcalls;
	94	struct referring_call *rcl_refcalls;
	95	};
	96
	97	struct cb_sequenceargs {
65fc64e5	98	struct sockaddr *csa_addr;
2d9b9ec3 BH	99	struct nfs4_sessionid csa_sessionid;
	100	uint32_t csa_sequenceid;
	101	uint32_t csa_slotid;
	102	uint32_t csa_highestslotid;
	103	uint32_t csa_cachethis;
	104	uint32_t csa_nrclists;
	105	struct referring_call_list *csa_rclists;
	106	};
	107
	108	struct cb_sequenceres {
65fc64e5	109	__be32 csr_status;
2d9b9ec3 BH	110	struct nfs4_sessionid csr_sessionid;
	111	uint32_t csr_sequenceid;
	112	uint32_t csr_slotid;
	113	uint32_t csr_highestslotid;
	114	uint32_t csr_target_highestslotid;
	115	};
	116
f4dac4ad	117	extern __be32 nfs4_callback_sequence(void argp, void resp,
c36fca52	118	struct cb_process_state *cps);
d49433e1	119
31f09607 AB	120	#define RCA4_TYPE_MASK_RDATA_DLG 0
31f09607 AB	121	#define RCA4_TYPE_MASK_WDATA_DLG 1
36840370 AB	122	#define RCA4_TYPE_MASK_DIR_DLG 2
	123	#define RCA4_TYPE_MASK_FILE_LAYOUT 3
	124	#define RCA4_TYPE_MASK_BLK_LAYOUT 4
	125	#define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN 8
	126	#define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX 9
	127	#define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12
	128	#define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15
	129	#define RCA4_TYPE_MASK_ALL 0xf31f
31f09607 AB	130
31f09607 AB	131	struct cb_recallanyargs {
31f09607 AB	132	uint32_t craa_objs_to_keep;
	133	uint32_t craa_type_mask;
	134	};
	135
f4dac4ad	136	extern __be32 nfs4_callback_recallany(void argp, void resp,
c36fca52	137	struct cb_process_state *cps);
b9efa1b2 AA	138
b9efa1b2 AA	139	struct cb_recallslotargs {
d5fb4ce3	140	uint32_t crsa_target_highest_slotid;
b9efa1b2	141	};
f4dac4ad	142	extern __be32 nfs4_callback_recallslot(void argp, void resp,
c36fca52	143	struct cb_process_state *cps);
b9efa1b2	144
f2a62561	145	struct cb_layoutrecallargs {
f2a62561 FI	146	uint32_t cbl_recall_type;
	147	uint32_t cbl_layout_type;
	148	uint32_t cbl_layoutchanged;
	149	union {
	150	struct {
	151	struct nfs_fh cbl_fh;
	152	struct pnfs_layout_range cbl_range;
	153	nfs4_stateid cbl_stateid;
	154	};
	155	struct nfs_fsid cbl_fsid;
	156	};
	157	};
	158
f4dac4ad CH	159	extern __be32 nfs4_callback_layoutrecall(void argp, void resp,
f4dac4ad CH	160	struct cb_process_state *cps);
f2a62561	161
1be5683b ME	162	struct cb_devicenotifyitem {
	163	uint32_t cbd_notify_type;
	164	uint32_t cbd_layout_type;
	165	struct nfs4_deviceid cbd_dev_id;
	166	uint32_t cbd_immediate;
	167	};
	168
	169	struct cb_devicenotifyargs {
	170	int ndevs;
	171	struct cb_devicenotifyitem *devs;
	172	};
	173
f4dac4ad CH	174	extern __be32 nfs4_callback_devicenotify(void argp, void resp,
f4dac4ad CH	175	struct cb_process_state *cps);
1be5683b	176
db783688 JL	177	struct cb_notify_lock_args {
	178	struct nfs_fh cbnl_fh;
	179	struct nfs_lowner cbnl_owner;
	180	bool cbnl_valid;
	181	};
	182
f4dac4ad	183	extern __be32 nfs4_callback_notify_lock(void argp, void resp,
db783688	184	struct cb_process_state *cps);
2d9b9ec3	185	#endif /* CONFIG_NFS_V4_1 */
778be232	186	extern int check_gss_callback_principal(struct nfs_client , struct svc_rqst );
f4dac4ad	187	extern __be32 nfs4_callback_getattr(void argp, void resp,
c36fca52	188	struct cb_process_state *cps);
f4dac4ad	189	extern __be32 nfs4_callback_recall(void argp, void resp,
c36fca52	190	struct cb_process_state *cps);
89d77c8f	191	#if IS_ENABLED(CONFIG_NFS_V4)
71468513	192	extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
c8ceb412	193	extern void nfs_callback_down(int minorversion, struct net *net);
e82dc22d	194	#endif /* CONFIG_NFS_V4 */
a43cde94 RL	195	/*
	196	* nfs41: Callbacks are expected to not cause substantial latency,
	197	* so we limit their concurrency to 1 by setting up the maximum number
	198	* of slots for the backchannel.
	199	*/
	200	#define NFS41_BC_MIN_CALLBACKS 1
d49433e1	201	#define NFS41_BC_MAX_CALLBACKS 1
a43cde94	202
5405fc44	203	#define NFS4_MIN_NR_CALLBACK_THREADS 1
bb6aeba7	204
a72b4422	205	extern unsigned int nfs_callback_set_tcpport;
5405fc44	206	extern unsigned short nfs_callback_nr_threads;
1da177e4 LT	207
1da177e4 LT	208	#endif /* __LINUX_FS_NFS_CALLBACK_H */