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;
44 struct cb_compound_hdr_arg {
47 unsigned int minorversion;
48 unsigned int cb_ident; /* v4.0 callback identifier */
52 struct cb_compound_hdr_res {
59 struct cb_getattrargs {
60 struct sockaddr *addr;
65 struct cb_getattrres {
70 struct timespec ctime;
71 struct timespec mtime;
74 struct cb_recallargs {
75 struct sockaddr *addr;
81 #if defined(CONFIG_NFS_V4_1)
83 struct referring_call {
84 uint32_t rc_sequenceid;
88 struct referring_call_list {
89 struct nfs4_sessionid rcl_sessionid;
90 uint32_t rcl_nrefcalls;
91 struct referring_call *rcl_refcalls;
94 struct cb_sequenceargs {
95 struct sockaddr *csa_addr;
96 struct nfs4_sessionid csa_sessionid;
97 uint32_t csa_sequenceid;
99 uint32_t csa_highestslotid;
100 uint32_t csa_cachethis;
101 uint32_t csa_nrclists;
102 struct referring_call_list *csa_rclists;
105 struct cb_sequenceres {
107 struct nfs4_sessionid csr_sessionid;
108 uint32_t csr_sequenceid;
110 uint32_t csr_highestslotid;
111 uint32_t csr_target_highestslotid;
114 extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
115 struct cb_sequenceres *res,
116 struct cb_process_state *cps);
118 extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation,
119 const nfs4_stateid *stateid);
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 struct sockaddr *craa_addr;
134 uint32_t craa_objs_to_keep;
135 uint32_t craa_type_mask;
138 extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
140 struct cb_process_state *cps);
142 struct cb_recallslotargs {
143 struct sockaddr *crsa_addr;
144 uint32_t crsa_target_max_slots;
146 extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
148 struct cb_process_state *cps);
150 struct cb_layoutrecallargs {
151 struct sockaddr *cbl_addr;
152 uint32_t cbl_recall_type;
153 uint32_t cbl_layout_type;
154 uint32_t cbl_layoutchanged;
157 struct nfs_fh cbl_fh;
158 struct pnfs_layout_range cbl_range;
159 nfs4_stateid cbl_stateid;
161 struct nfs_fsid cbl_fsid;
165 extern unsigned nfs4_callback_layoutrecall(
166 struct cb_layoutrecallargs *args,
167 void *dummy, struct cb_process_state *cps);
169 extern void nfs4_check_drain_bc_complete(struct nfs4_session *ses);
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);
195 extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
196 extern void nfs_callback_down(int minorversion);
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;
211 extern unsigned short nfs_callback_tcpport6;
213 #endif /* __LINUX_FS_NFS_CALLBACK_H */