blob: efd54f0a4c468f9c7e7726b751df36c6f94d1d16 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Andy Adamson778be232011-01-25 15:38:01 +000010#include <linux/sunrpc/svc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
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,
Benny Halevy45377b92009-04-01 09:23:21 -040024/* 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,
Benny Halevy34bc47c92009-04-01 09:23:22 -040034 OP_CB_NOTIFY_DEVICEID = 14,
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 OP_CB_ILLEGAL = 10044,
36};
37
Andy Adamsonc36fca52011-01-06 02:04:32 +000038struct cb_process_state {
39 __be32 drc_status;
40 struct nfs_client *clp;
Trond Myklebust45d43c22012-02-06 19:38:51 -050041 u32 slotid;
Stanislav Kinsburskyc7add9a2012-01-26 15:11:49 +040042 struct net *net;
Andy Adamsonc36fca52011-01-06 02:04:32 +000043};
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045struct cb_compound_hdr_arg {
Trond Myklebust2e42c3e2007-05-14 17:20:41 -040046 unsigned int taglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 const char *tag;
Benny Halevyb8f2ef82009-04-01 09:23:19 -040048 unsigned int minorversion;
Andy Adamsonc36fca52011-01-06 02:04:32 +000049 unsigned int cb_ident; /* v4.0 callback identifier */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 unsigned nops;
51};
52
53struct cb_compound_hdr_res {
Al Viro5704fde2006-10-19 23:28:51 -070054 __be32 *status;
Trond Myklebust2e42c3e2007-05-14 17:20:41 -040055 unsigned int taglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 const char *tag;
Al Viro5704fde2006-10-19 23:28:51 -070057 __be32 *nops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058};
59
60struct cb_getattrargs {
Chuck Lever671beed2007-12-10 14:58:22 -050061 struct sockaddr *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 struct nfs_fh fh;
63 uint32_t bitmap[2];
64};
65
66struct cb_getattrres {
Al Viroe6f684f2006-10-19 23:28:50 -070067 __be32 status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 uint32_t bitmap[2];
69 uint64_t size;
70 uint64_t change_attr;
71 struct timespec ctime;
72 struct timespec mtime;
73};
74
75struct cb_recallargs {
Chuck Leverc1d35862007-12-10 14:58:29 -050076 struct sockaddr *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 struct nfs_fh fh;
78 nfs4_stateid stateid;
79 uint32_t truncate;
80};
81
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040082#if defined(CONFIG_NFS_V4_1)
83
84struct referring_call {
85 uint32_t rc_sequenceid;
86 uint32_t rc_slotid;
87};
88
89struct referring_call_list {
90 struct nfs4_sessionid rcl_sessionid;
91 uint32_t rcl_nrefcalls;
92 struct referring_call *rcl_refcalls;
93};
94
95struct cb_sequenceargs {
Ricardo Labiaga65fc64e2009-04-01 09:23:30 -040096 struct sockaddr *csa_addr;
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040097 struct nfs4_sessionid csa_sessionid;
98 uint32_t csa_sequenceid;
99 uint32_t csa_slotid;
100 uint32_t csa_highestslotid;
101 uint32_t csa_cachethis;
102 uint32_t csa_nrclists;
103 struct referring_call_list *csa_rclists;
104};
105
106struct cb_sequenceres {
Ricardo Labiaga65fc64e2009-04-01 09:23:30 -0400107 __be32 csr_status;
Benny Halevy2d9b9ec2009-04-01 09:23:24 -0400108 struct nfs4_sessionid csr_sessionid;
109 uint32_t csr_sequenceid;
110 uint32_t csr_slotid;
111 uint32_t csr_highestslotid;
112 uint32_t csr_target_highestslotid;
113};
114
Andy Adamsonc36fca52011-01-06 02:04:32 +0000115extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
116 struct cb_sequenceres *res,
117 struct cb_process_state *cps);
Benny Halevyd49433e2009-04-01 09:23:25 -0400118
Alexandros Batsakis25976412009-12-05 13:48:55 -0500119extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation,
120 const nfs4_stateid *stateid);
Alexandros Batsakis31f09602009-12-05 13:27:02 -0500121
122#define RCA4_TYPE_MASK_RDATA_DLG 0
123#define RCA4_TYPE_MASK_WDATA_DLG 1
Alexandros Batsakis36840372011-01-06 11:36:31 +0000124#define RCA4_TYPE_MASK_DIR_DLG 2
125#define RCA4_TYPE_MASK_FILE_LAYOUT 3
126#define RCA4_TYPE_MASK_BLK_LAYOUT 4
127#define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN 8
128#define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX 9
129#define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12
130#define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15
131#define RCA4_TYPE_MASK_ALL 0xf31f
Alexandros Batsakis31f09602009-12-05 13:27:02 -0500132
133struct cb_recallanyargs {
134 struct sockaddr *craa_addr;
135 uint32_t craa_objs_to_keep;
136 uint32_t craa_type_mask;
137};
138
Andy Adamsonc36fca52011-01-06 02:04:32 +0000139extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
140 void *dummy,
141 struct cb_process_state *cps);
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500142
143struct cb_recallslotargs {
144 struct sockaddr *crsa_addr;
Trond Myklebustd5fb4ce2012-11-20 20:24:02 -0500145 uint32_t crsa_target_highest_slotid;
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500146};
Andy Adamsonc36fca52011-01-06 02:04:32 +0000147extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
148 void *dummy,
149 struct cb_process_state *cps);
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500150
Fred Isamanf2a62562011-01-06 11:36:29 +0000151struct cb_layoutrecallargs {
152 struct sockaddr *cbl_addr;
153 uint32_t cbl_recall_type;
154 uint32_t cbl_layout_type;
155 uint32_t cbl_layoutchanged;
156 union {
157 struct {
158 struct nfs_fh cbl_fh;
159 struct pnfs_layout_range cbl_range;
160 nfs4_stateid cbl_stateid;
161 };
162 struct nfs_fsid cbl_fsid;
163 };
164};
165
Dan Carpenter0e0243d2012-01-12 10:06:05 +0300166extern __be32 nfs4_callback_layoutrecall(
Fred Isamanf2a62562011-01-06 11:36:29 +0000167 struct cb_layoutrecallargs *args,
168 void *dummy, struct cb_process_state *cps);
169
Marc Eshel1be56832011-05-22 19:47:09 +0300170struct cb_devicenotifyitem {
171 uint32_t cbd_notify_type;
172 uint32_t cbd_layout_type;
173 struct nfs4_deviceid cbd_dev_id;
174 uint32_t cbd_immediate;
175};
176
177struct cb_devicenotifyargs {
178 int ndevs;
179 struct cb_devicenotifyitem *devs;
180};
181
182extern __be32 nfs4_callback_devicenotify(
183 struct cb_devicenotifyargs *args,
184 void *dummy, struct cb_process_state *cps);
185
Benny Halevy2d9b9ec2009-04-01 09:23:24 -0400186#endif /* CONFIG_NFS_V4_1 */
Andy Adamson778be232011-01-25 15:38:01 +0000187extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
Andy Adamsonc36fca52011-01-06 02:04:32 +0000188extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
189 struct cb_getattrres *res,
190 struct cb_process_state *cps);
191extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
192 struct cb_process_state *cps);
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400193#if IS_ENABLED(CONFIG_NFS_V4)
Benny Halevy71468512009-04-01 09:22:56 -0400194extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
Stanislav Kinsburskyc8ceb412012-08-20 18:00:06 +0400195extern void nfs_callback_down(int minorversion, struct net *net);
Alexandros Batsakis25976412009-12-05 13:48:55 -0500196extern int nfs4_validate_delegation_stateid(struct nfs_delegation *delegation,
197 const nfs4_stateid *stateid);
Andy Adamson2c2618c2011-01-06 02:04:31 +0000198extern int nfs4_set_callback_sessionid(struct nfs_client *clp);
Andy Adamsone82dc222009-04-01 09:23:14 -0400199#endif /* CONFIG_NFS_V4 */
Ricardo Labiagaa43cde92009-04-01 09:23:08 -0400200/*
201 * nfs41: Callbacks are expected to not cause substantial latency,
202 * so we limit their concurrency to 1 by setting up the maximum number
203 * of slots for the backchannel.
204 */
205#define NFS41_BC_MIN_CALLBACKS 1
Benny Halevyd49433e2009-04-01 09:23:25 -0400206#define NFS41_BC_MAX_CALLBACKS 1
Ricardo Labiagaa43cde92009-04-01 09:23:08 -0400207
Trond Myklebusta72b4422006-01-03 09:55:41 +0100208extern unsigned int nfs_callback_set_tcpport;
Stanislav Kinsbursky0b37d202012-10-02 14:18:59 +0400209extern unsigned short nfs_callback_tcpport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211#endif /* __LINUX_FS_NFS_CALLBACK_H */