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

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