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 /* Callback operations new to NFSv4.2 */
37 OP_CB_ILLEGAL = 10044,
41 struct cb_process_state {
43 struct nfs_client *clp;
44 struct nfs4_slot *slot;
49 struct cb_compound_hdr_arg {
52 unsigned int minorversion;
53 unsigned int cb_ident; /* v4.0 callback identifier */
57 struct cb_compound_hdr_res {
64 struct cb_getattrargs {
69 struct cb_getattrres {
74 struct timespec ctime;
75 struct timespec mtime;
78 struct cb_recallargs {
84 #if defined(CONFIG_NFS_V4_1)
86 struct referring_call {
87 uint32_t rc_sequenceid;
91 struct referring_call_list {
92 struct nfs4_sessionid rcl_sessionid;
93 uint32_t rcl_nrefcalls;
94 struct referring_call *rcl_refcalls;
97 struct cb_sequenceargs {
98 struct sockaddr *csa_addr;
99 struct nfs4_sessionid csa_sessionid;
100 uint32_t csa_sequenceid;
102 uint32_t csa_highestslotid;
103 uint32_t csa_cachethis;
104 uint32_t csa_nrclists;
105 struct referring_call_list *csa_rclists;
108 struct cb_sequenceres {
110 struct nfs4_sessionid csr_sessionid;
111 uint32_t csr_sequenceid;
113 uint32_t csr_highestslotid;
114 uint32_t csr_target_highestslotid;
117 extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
118 struct cb_sequenceres *res,
119 struct cb_process_state *cps);
121 #define RCA4_TYPE_MASK_RDATA_DLG 0
122 #define RCA4_TYPE_MASK_WDATA_DLG 1
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
132 struct cb_recallanyargs {
133 uint32_t craa_objs_to_keep;
134 uint32_t craa_type_mask;
137 extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
139 struct cb_process_state *cps);
141 struct cb_recallslotargs {
142 uint32_t crsa_target_highest_slotid;
144 extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
146 struct cb_process_state *cps);
148 struct cb_layoutrecallargs {
149 uint32_t cbl_recall_type;
150 uint32_t cbl_layout_type;
151 uint32_t cbl_layoutchanged;
154 struct nfs_fh cbl_fh;
155 struct pnfs_layout_range cbl_range;
156 nfs4_stateid cbl_stateid;
158 struct nfs_fsid cbl_fsid;
162 extern __be32 nfs4_callback_layoutrecall(
163 struct cb_layoutrecallargs *args,
164 void *dummy, struct cb_process_state *cps);
166 struct cb_devicenotifyitem {
167 uint32_t cbd_notify_type;
168 uint32_t cbd_layout_type;
169 struct nfs4_deviceid cbd_dev_id;
170 uint32_t cbd_immediate;
173 struct cb_devicenotifyargs {
175 struct cb_devicenotifyitem *devs;
178 extern __be32 nfs4_callback_devicenotify(
179 struct cb_devicenotifyargs *args,
180 void *dummy, struct cb_process_state *cps);
182 #endif /* CONFIG_NFS_V4_1 */
183 extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
184 extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
185 struct cb_getattrres *res,
186 struct cb_process_state *cps);
187 extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
188 struct cb_process_state *cps);
189 #if IS_ENABLED(CONFIG_NFS_V4)
190 extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
191 extern void nfs_callback_down(int minorversion, struct net *net);
192 #endif /* CONFIG_NFS_V4 */
194 * nfs41: Callbacks are expected to not cause substantial latency,
195 * so we limit their concurrency to 1 by setting up the maximum number
196 * of slots for the backchannel.
198 #define NFS41_BC_MIN_CALLBACKS 1
199 #define NFS41_BC_MAX_CALLBACKS 1
201 extern unsigned int nfs_callback_set_tcpport;
203 #endif /* __LINUX_FS_NFS_CALLBACK_H */