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
10#include <linux/sunrpc/svc.h>
11
12#define NFS4_CALLBACK 0x40000000
13#define NFS4_CALLBACK_XDRSIZE 2048
14#define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)
15
16enum nfs4_callback_procnum {
17	CB_NULL = 0,
18	CB_COMPOUND = 1,
19};
20
21enum nfs4_callback_opnum {
22	OP_CB_GETATTR = 3,
23	OP_CB_RECALL  = 4,
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,
34	OP_CB_NOTIFY_DEVICEID = 14,
35/* Callback operations new to NFSv4.2 */
36	OP_CB_OFFLOAD = 15,
37	OP_CB_ILLEGAL = 10044,
38};
39
40struct cb_process_state {
41	__be32			drc_status;
42	struct nfs_client	*clp;
43	u32			slotid;
44	u32			minorversion;
45	struct net		*net;
46};
47
48struct cb_compound_hdr_arg {
49	unsigned int taglen;
50	const char *tag;
51	unsigned int minorversion;
52	unsigned int cb_ident; /* v4.0 callback identifier */
53	unsigned nops;
54};
55
56struct cb_compound_hdr_res {
57	__be32 *status;
58	unsigned int taglen;
59	const char *tag;
60	__be32 *nops;
61};
62
63struct cb_getattrargs {
64	struct nfs_fh fh;
65	uint32_t bitmap[2];
66};
67
68struct cb_getattrres {
69	__be32 status;
70	uint32_t bitmap[2];
71	uint64_t size;
72	uint64_t change_attr;
73	struct timespec ctime;
74	struct timespec mtime;
75};
76
77struct cb_recallargs {
78	struct nfs_fh fh;
79	nfs4_stateid stateid;
80	uint32_t truncate;
81};
82
83#if defined(CONFIG_NFS_V4_1)
84
85struct referring_call {
86	uint32_t			rc_sequenceid;
87	uint32_t			rc_slotid;
88};
89
90struct referring_call_list {
91	struct nfs4_sessionid		rcl_sessionid;
92	uint32_t			rcl_nrefcalls;
93	struct referring_call 		*rcl_refcalls;
94};
95
96struct cb_sequenceargs {
97	struct sockaddr			*csa_addr;
98	struct nfs4_sessionid		csa_sessionid;
99	uint32_t			csa_sequenceid;
100	uint32_t			csa_slotid;
101	uint32_t			csa_highestslotid;
102	uint32_t			csa_cachethis;
103	uint32_t			csa_nrclists;
104	struct referring_call_list	*csa_rclists;
105};
106
107struct cb_sequenceres {
108	__be32				csr_status;
109	struct nfs4_sessionid		csr_sessionid;
110	uint32_t			csr_sequenceid;
111	uint32_t			csr_slotid;
112	uint32_t			csr_highestslotid;
113	uint32_t			csr_target_highestslotid;
114};
115
116extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
117				       struct cb_sequenceres *res,
118				       struct cb_process_state *cps);
119
120#define RCA4_TYPE_MASK_RDATA_DLG	0
121#define RCA4_TYPE_MASK_WDATA_DLG	1
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
130
131struct cb_recallanyargs {
132	uint32_t	craa_objs_to_keep;
133	uint32_t	craa_type_mask;
134};
135
136extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
137					void *dummy,
138					struct cb_process_state *cps);
139
140struct cb_recallslotargs {
141	uint32_t	crsa_target_highest_slotid;
142};
143extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
144					 void *dummy,
145					 struct cb_process_state *cps);
146
147struct cb_layoutrecallargs {
148	uint32_t		cbl_recall_type;
149	uint32_t		cbl_layout_type;
150	uint32_t		cbl_layoutchanged;
151	union {
152		struct {
153			struct nfs_fh		cbl_fh;
154			struct pnfs_layout_range cbl_range;
155			nfs4_stateid		cbl_stateid;
156		};
157		struct nfs_fsid		cbl_fsid;
158	};
159};
160
161extern __be32 nfs4_callback_layoutrecall(
162	struct cb_layoutrecallargs *args,
163	void *dummy, struct cb_process_state *cps);
164
165struct cb_devicenotifyitem {
166	uint32_t		cbd_notify_type;
167	uint32_t		cbd_layout_type;
168	struct nfs4_deviceid	cbd_dev_id;
169	uint32_t		cbd_immediate;
170};
171
172struct cb_devicenotifyargs {
173	int				 ndevs;
174	struct cb_devicenotifyitem	 *devs;
175};
176
177extern __be32 nfs4_callback_devicenotify(
178	struct cb_devicenotifyargs *args,
179	void *dummy, struct cb_process_state *cps);
180
181#endif /* CONFIG_NFS_V4_1 */
182extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
183extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
184				    struct cb_getattrres *res,
185				    struct cb_process_state *cps);
186extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
187				   struct cb_process_state *cps);
188#if IS_ENABLED(CONFIG_NFS_V4)
189extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
190extern void nfs_callback_down(int minorversion, struct net *net);
191#endif /* CONFIG_NFS_V4 */
192/*
193 * nfs41: Callbacks are expected to not cause substantial latency,
194 * so we limit their concurrency to 1 by setting up the maximum number
195 * of slots for the backchannel.
196 */
197#define NFS41_BC_MIN_CALLBACKS 1
198#define NFS41_BC_MAX_CALLBACKS 1
199
200extern unsigned int nfs_callback_set_tcpport;
201
202#endif /* __LINUX_FS_NFS_CALLBACK_H */
203