NFSv4: Fix lock recovery when CREATE_SESSION/SETCLIENTID_CONFIRM fails
[linux-3.10.git] / fs / nfs / callback.h
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
16 enum nfs4_callback_procnum {
17         CB_NULL = 0,
18         CB_COMPOUND = 1,
19 };
20
21 enum 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         OP_CB_ILLEGAL = 10044,
36 };
37
38 struct cb_process_state {
39         __be32                  drc_status;
40         struct nfs_client       *clp;
41         u32                     slotid;
42         struct net              *net;
43 };
44
45 struct cb_compound_hdr_arg {
46         unsigned int taglen;
47         const char *tag;
48         unsigned int minorversion;
49         unsigned int cb_ident; /* v4.0 callback identifier */
50         unsigned nops;
51 };
52
53 struct cb_compound_hdr_res {
54         __be32 *status;
55         unsigned int taglen;
56         const char *tag;
57         __be32 *nops;
58 };
59
60 struct cb_getattrargs {
61         struct sockaddr *addr;
62         struct nfs_fh fh;
63         uint32_t bitmap[2];
64 };
65
66 struct cb_getattrres {
67         __be32 status;
68         uint32_t bitmap[2];
69         uint64_t size;
70         uint64_t change_attr;
71         struct timespec ctime;
72         struct timespec mtime;
73 };
74
75 struct cb_recallargs {
76         struct sockaddr *addr;
77         struct nfs_fh fh;
78         nfs4_stateid stateid;
79         uint32_t truncate;
80 };
81
82 #if defined(CONFIG_NFS_V4_1)
83
84 struct referring_call {
85         uint32_t                        rc_sequenceid;
86         uint32_t                        rc_slotid;
87 };
88
89 struct referring_call_list {
90         struct nfs4_sessionid           rcl_sessionid;
91         uint32_t                        rcl_nrefcalls;
92         struct referring_call           *rcl_refcalls;
93 };
94
95 struct cb_sequenceargs {
96         struct sockaddr                 *csa_addr;
97         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
106 struct cb_sequenceres {
107         __be32                          csr_status;
108         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
115 extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
116                                        struct cb_sequenceres *res,
117                                        struct cb_process_state *cps);
118
119 extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation,
120                                              const nfs4_stateid *stateid);
121
122 #define RCA4_TYPE_MASK_RDATA_DLG        0
123 #define RCA4_TYPE_MASK_WDATA_DLG        1
124 #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
132
133 struct cb_recallanyargs {
134         struct sockaddr *craa_addr;
135         uint32_t        craa_objs_to_keep;
136         uint32_t        craa_type_mask;
137 };
138
139 extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
140                                         void *dummy,
141                                         struct cb_process_state *cps);
142
143 struct cb_recallslotargs {
144         struct sockaddr *crsa_addr;
145         uint32_t        crsa_target_highest_slotid;
146 };
147 extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
148                                          void *dummy,
149                                          struct cb_process_state *cps);
150
151 struct 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
166 extern __be32 nfs4_callback_layoutrecall(
167         struct cb_layoutrecallargs *args,
168         void *dummy, struct cb_process_state *cps);
169
170 struct 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
177 struct cb_devicenotifyargs {
178         int                              ndevs;
179         struct cb_devicenotifyitem       *devs;
180 };
181
182 extern __be32 nfs4_callback_devicenotify(
183         struct cb_devicenotifyargs *args,
184         void *dummy, struct cb_process_state *cps);
185
186 #endif /* CONFIG_NFS_V4_1 */
187 extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
188 extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
189                                     struct cb_getattrres *res,
190                                     struct cb_process_state *cps);
191 extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
192                                    struct cb_process_state *cps);
193 #if IS_ENABLED(CONFIG_NFS_V4)
194 extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
195 extern void nfs_callback_down(int minorversion, struct net *net);
196 extern int nfs4_validate_delegation_stateid(struct nfs_delegation *delegation,
197                                             const nfs4_stateid *stateid);
198 extern int nfs4_set_callback_sessionid(struct nfs_client *clp);
199 #endif /* CONFIG_NFS_V4 */
200 /*
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
206 #define NFS41_BC_MAX_CALLBACKS 1
207
208 extern unsigned int nfs_callback_set_tcpport;
209 extern unsigned short nfs_callback_tcpport;
210
211 #endif /* __LINUX_FS_NFS_CALLBACK_H */