2 * linux/fs/nfs/callback.h
4 * Copyright (C) 2004 Trond Myklebust
6 * NFSv4 callback definitions
8 #ifndef __LINUX_FS_NFS_CALLBACK_H
9 #define __LINUX_FS_NFS_CALLBACK_H
10 #include <linux/sunrpc/svc.h>
12 #define NFS4_CALLBACK 0x40000000
13 #define NFS4_CALLBACK_XDRSIZE 2048
14 #define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)
16 enum nfs4_callback_procnum {
21 enum nfs4_callback_opnum {
24 /* Callback operations new to NFSv4.1 */
25 OP_CB_LAYOUTRECALL = 5,
29 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
30 OP_CB_RECALL_SLOT = 10,
32 OP_CB_WANTS_CANCELLED = 12,
33 OP_CB_NOTIFY_LOCK = 13,
34 OP_CB_NOTIFY_DEVICEID = 14,
35 OP_CB_ILLEGAL = 10044,
38 struct cb_process_state {
40 struct nfs_client *clp;
46 struct cb_compound_hdr_arg {
49 unsigned int minorversion;
50 unsigned int cb_ident; /* v4.0 callback identifier */
54 struct cb_compound_hdr_res {
61 struct cb_getattrargs {
62 struct sockaddr *addr;
67 struct cb_getattrres {
72 struct timespec ctime;
73 struct timespec mtime;
76 struct cb_recallargs {
77 struct sockaddr *addr;
83 #if defined(CONFIG_NFS_V4_1)
85 struct referring_call {
86 uint32_t rc_sequenceid;
90 struct referring_call_list {
91 struct nfs4_sessionid rcl_sessionid;
92 uint32_t rcl_nrefcalls;
93 struct referring_call *rcl_refcalls;
96 struct cb_sequenceargs {
97 struct sockaddr *csa_addr;
98 struct nfs4_sessionid csa_sessionid;
99 uint32_t csa_sequenceid;
101 uint32_t csa_highestslotid;
102 uint32_t csa_cachethis;
103 uint32_t csa_nrclists;
104 struct referring_call_list *csa_rclists;
107 struct cb_sequenceres {
109 struct nfs4_sessionid csr_sessionid;
110 uint32_t csr_sequenceid;
112 uint32_t csr_highestslotid;
113 uint32_t csr_target_highestslotid;
116 extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
117 struct cb_sequenceres *res,
118 struct cb_process_state *cps);
120 extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation,
121 const nfs4_stateid *stateid);
123 #define RCA4_TYPE_MASK_RDATA_DLG 0
124 #define RCA4_TYPE_MASK_WDATA_DLG 1
125 #define RCA4_TYPE_MASK_DIR_DLG 2
126 #define RCA4_TYPE_MASK_FILE_LAYOUT 3
127 #define RCA4_TYPE_MASK_BLK_LAYOUT 4
128 #define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN 8
129 #define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX 9
130 #define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12
131 #define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15
132 #define RCA4_TYPE_MASK_ALL 0xf31f
134 struct cb_recallanyargs {
135 struct sockaddr *craa_addr;
136 uint32_t craa_objs_to_keep;
137 uint32_t craa_type_mask;
140 extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
142 struct cb_process_state *cps);
144 struct cb_recallslotargs {
145 struct sockaddr *crsa_addr;
146 uint32_t crsa_target_highest_slotid;
148 extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
150 struct cb_process_state *cps);
152 struct cb_layoutrecallargs {
153 struct sockaddr *cbl_addr;
154 uint32_t cbl_recall_type;
155 uint32_t cbl_layout_type;
156 uint32_t cbl_layoutchanged;
159 struct nfs_fh cbl_fh;
160 struct pnfs_layout_range cbl_range;
161 nfs4_stateid cbl_stateid;
163 struct nfs_fsid cbl_fsid;
167 extern __be32 nfs4_callback_layoutrecall(
168 struct cb_layoutrecallargs *args,
169 void *dummy, struct cb_process_state *cps);
171 struct cb_devicenotifyitem {
172 uint32_t cbd_notify_type;
173 uint32_t cbd_layout_type;
174 struct nfs4_deviceid cbd_dev_id;
175 uint32_t cbd_immediate;
178 struct cb_devicenotifyargs {
180 struct cb_devicenotifyitem *devs;
183 extern __be32 nfs4_callback_devicenotify(
184 struct cb_devicenotifyargs *args,
185 void *dummy, struct cb_process_state *cps);
187 #endif /* CONFIG_NFS_V4_1 */
188 extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
189 extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
190 struct cb_getattrres *res,
191 struct cb_process_state *cps);
192 extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
193 struct cb_process_state *cps);
194 #if IS_ENABLED(CONFIG_NFS_V4)
195 extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
196 extern void nfs_callback_down(int minorversion, struct net *net);
197 extern int nfs4_validate_delegation_stateid(struct nfs_delegation *delegation,
198 const nfs4_stateid *stateid);
199 extern int nfs4_set_callback_sessionid(struct nfs_client *clp);
200 #endif /* CONFIG_NFS_V4 */
202 * nfs41: Callbacks are expected to not cause substantial latency,
203 * so we limit their concurrency to 1 by setting up the maximum number
204 * of slots for the backchannel.
206 #define NFS41_BC_MIN_CALLBACKS 1
207 #define NFS41_BC_MAX_CALLBACKS 1
209 extern unsigned int nfs_callback_set_tcpport;
210 extern unsigned short nfs_callback_tcpport;
212 #endif /* __LINUX_FS_NFS_CALLBACK_H */