[NET]: Document some simple rules for actions
[linux-2.6] / fs / nfsd / nfs4callback.c
1 /*
2  *  linux/fs/nfsd/nfs4callback.c
3  *
4  *  Copyright (c) 2001 The Regents of the University of Michigan.
5  *  All rights reserved.
6  *
7  *  Kendrick Smith <kmsmith@umich.edu>
8  *  Andy Adamson <andros@umich.edu>
9  *
10  *  Redistribution and use in source and binary forms, with or without
11  *  modification, are permitted provided that the following conditions
12  *  are met:
13  *
14  *  1. Redistributions of source code must retain the above copyright
15  *     notice, this list of conditions and the following disclaimer.
16  *  2. Redistributions in binary form must reproduce the above copyright
17  *     notice, this list of conditions and the following disclaimer in the
18  *     documentation and/or other materials provided with the distribution.
19  *  3. Neither the name of the University nor the names of its
20  *     contributors may be used to endorse or promote products derived
21  *     from this software without specific prior written permission.
22  *
23  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
24  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35
36 #include <linux/module.h>
37 #include <linux/list.h>
38 #include <linux/inet.h>
39 #include <linux/errno.h>
40 #include <linux/delay.h>
41 #include <linux/sched.h>
42 #include <linux/kthread.h>
43 #include <linux/sunrpc/xdr.h>
44 #include <linux/sunrpc/svc.h>
45 #include <linux/sunrpc/clnt.h>
46 #include <linux/nfsd/nfsd.h>
47 #include <linux/nfsd/state.h>
48 #include <linux/sunrpc/sched.h>
49 #include <linux/nfs4.h>
50
51 #define NFSDDBG_FACILITY                NFSDDBG_PROC
52
53 #define NFSPROC4_CB_NULL 0
54 #define NFSPROC4_CB_COMPOUND 1
55
56 /* declarations */
57 static const struct rpc_call_ops nfs4_cb_null_ops;
58
59 /* Index of predefined Linux callback client operations */
60
61 enum {
62         NFSPROC4_CLNT_CB_NULL = 0,
63         NFSPROC4_CLNT_CB_RECALL,
64 };
65
66 enum nfs_cb_opnum4 {
67         OP_CB_RECALL            = 4,
68 };
69
70 #define NFS4_MAXTAGLEN          20
71
72 #define NFS4_enc_cb_null_sz             0
73 #define NFS4_dec_cb_null_sz             0
74 #define cb_compound_enc_hdr_sz          4
75 #define cb_compound_dec_hdr_sz          (3 + (NFS4_MAXTAGLEN >> 2))
76 #define op_enc_sz                       1
77 #define op_dec_sz                       2
78 #define enc_nfs4_fh_sz                  (1 + (NFS4_FHSIZE >> 2))
79 #define enc_stateid_sz                  (NFS4_STATEID_SIZE >> 2)
80 #define NFS4_enc_cb_recall_sz           (cb_compound_enc_hdr_sz +       \
81                                         1 + enc_stateid_sz +            \
82                                         enc_nfs4_fh_sz)
83
84 #define NFS4_dec_cb_recall_sz           (cb_compound_dec_hdr_sz  +      \
85                                         op_dec_sz)
86
87 /*
88 * Generic encode routines from fs/nfs/nfs4xdr.c
89 */
90 static inline __be32 *
91 xdr_writemem(__be32 *p, const void *ptr, int nbytes)
92 {
93         int tmp = XDR_QUADLEN(nbytes);
94         if (!tmp)
95                 return p;
96         p[tmp-1] = 0;
97         memcpy(p, ptr, nbytes);
98         return p + tmp;
99 }
100
101 #define WRITE32(n)               *p++ = htonl(n)
102 #define WRITEMEM(ptr,nbytes)     do {                           \
103         p = xdr_writemem(p, ptr, nbytes);                       \
104 } while (0)
105 #define RESERVE_SPACE(nbytes)   do {                            \
106         p = xdr_reserve_space(xdr, nbytes);                     \
107         if (!p) dprintk("NFSD: RESERVE_SPACE(%d) failed in function %s\n", (int) (nbytes), __FUNCTION__); \
108         BUG_ON(!p);                                             \
109 } while (0)
110
111 /*
112  * Generic decode routines from fs/nfs/nfs4xdr.c
113  */
114 #define DECODE_TAIL                             \
115         status = 0;                             \
116 out:                                            \
117         return status;                          \
118 xdr_error:                                      \
119         dprintk("NFSD: xdr error! (%s:%d)\n", __FILE__, __LINE__); \
120         status = -EIO;                          \
121         goto out
122
123 #define READ32(x)         (x) = ntohl(*p++)
124 #define READ64(x)         do {                  \
125         (x) = (u64)ntohl(*p++) << 32;           \
126         (x) |= ntohl(*p++);                     \
127 } while (0)
128 #define READTIME(x)       do {                  \
129         p++;                                    \
130         (x.tv_sec) = ntohl(*p++);               \
131         (x.tv_nsec) = ntohl(*p++);              \
132 } while (0)
133 #define READ_BUF(nbytes)  do { \
134         p = xdr_inline_decode(xdr, nbytes); \
135         if (!p) { \
136                 dprintk("NFSD: %s: reply buffer overflowed in line %d.\n", \
137                         __FUNCTION__, __LINE__); \
138                 return -EIO; \
139         } \
140 } while (0)
141
142 struct nfs4_cb_compound_hdr {
143         int             status;
144         u32             ident;
145         u32             nops;
146         u32             taglen;
147         char *          tag;
148 };
149
150 static struct {
151 int stat;
152 int errno;
153 } nfs_cb_errtbl[] = {
154         { NFS4_OK,              0               },
155         { NFS4ERR_PERM,         EPERM           },
156         { NFS4ERR_NOENT,        ENOENT          },
157         { NFS4ERR_IO,           EIO             },
158         { NFS4ERR_NXIO,         ENXIO           },
159         { NFS4ERR_ACCESS,       EACCES          },
160         { NFS4ERR_EXIST,        EEXIST          },
161         { NFS4ERR_XDEV,         EXDEV           },
162         { NFS4ERR_NOTDIR,       ENOTDIR         },
163         { NFS4ERR_ISDIR,        EISDIR          },
164         { NFS4ERR_INVAL,        EINVAL          },
165         { NFS4ERR_FBIG,         EFBIG           },
166         { NFS4ERR_NOSPC,        ENOSPC          },
167         { NFS4ERR_ROFS,         EROFS           },
168         { NFS4ERR_MLINK,        EMLINK          },
169         { NFS4ERR_NAMETOOLONG,  ENAMETOOLONG    },
170         { NFS4ERR_NOTEMPTY,     ENOTEMPTY       },
171         { NFS4ERR_DQUOT,        EDQUOT          },
172         { NFS4ERR_STALE,        ESTALE          },
173         { NFS4ERR_BADHANDLE,    EBADHANDLE      },
174         { NFS4ERR_BAD_COOKIE,   EBADCOOKIE      },
175         { NFS4ERR_NOTSUPP,      ENOTSUPP        },
176         { NFS4ERR_TOOSMALL,     ETOOSMALL       },
177         { NFS4ERR_SERVERFAULT,  ESERVERFAULT    },
178         { NFS4ERR_BADTYPE,      EBADTYPE        },
179         { NFS4ERR_LOCKED,       EAGAIN          },
180         { NFS4ERR_RESOURCE,     EREMOTEIO       },
181         { NFS4ERR_SYMLINK,      ELOOP           },
182         { NFS4ERR_OP_ILLEGAL,   EOPNOTSUPP      },
183         { NFS4ERR_DEADLOCK,     EDEADLK         },
184         { -1,                   EIO             }
185 };
186
187 static int
188 nfs_cb_stat_to_errno(int stat)
189 {
190         int i;
191         for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
192                 if (nfs_cb_errtbl[i].stat == stat)
193                         return nfs_cb_errtbl[i].errno;
194         }
195         /* If we cannot translate the error, the recovery routines should
196         * handle it.
197         * Note: remaining NFSv4 error codes have values > 10000, so should
198         * not conflict with native Linux error codes.
199         */
200         return stat;
201 }
202
203 /*
204  * XDR encode
205  */
206
207 static int
208 encode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr)
209 {
210         __be32 * p;
211
212         RESERVE_SPACE(16);
213         WRITE32(0);            /* tag length is always 0 */
214         WRITE32(NFS4_MINOR_VERSION);
215         WRITE32(hdr->ident);
216         WRITE32(hdr->nops);
217         return 0;
218 }
219
220 static int
221 encode_cb_recall(struct xdr_stream *xdr, struct nfs4_cb_recall *cb_rec)
222 {
223         __be32 *p;
224         int len = cb_rec->cbr_fhlen;
225
226         RESERVE_SPACE(12+sizeof(cb_rec->cbr_stateid) + len);
227         WRITE32(OP_CB_RECALL);
228         WRITEMEM(&cb_rec->cbr_stateid, sizeof(stateid_t));
229         WRITE32(cb_rec->cbr_trunc);
230         WRITE32(len);
231         WRITEMEM(cb_rec->cbr_fhval, len);
232         return 0;
233 }
234
235 static int
236 nfs4_xdr_enc_cb_null(struct rpc_rqst *req, __be32 *p)
237 {
238         struct xdr_stream xdrs, *xdr = &xdrs;
239
240         xdr_init_encode(&xdrs, &req->rq_snd_buf, p);
241         RESERVE_SPACE(0);
242         return 0;
243 }
244
245 static int
246 nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, __be32 *p, struct nfs4_cb_recall *args)
247 {
248         struct xdr_stream xdr;
249         struct nfs4_cb_compound_hdr hdr = {
250                 .ident = args->cbr_ident,
251                 .nops   = 1,
252         };
253
254         xdr_init_encode(&xdr, &req->rq_snd_buf, p);
255         encode_cb_compound_hdr(&xdr, &hdr);
256         return (encode_cb_recall(&xdr, args));
257 }
258
259
260 static int
261 decode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr){
262         __be32 *p;
263
264         READ_BUF(8);
265         READ32(hdr->status);
266         READ32(hdr->taglen);
267         READ_BUF(hdr->taglen + 4);
268         hdr->tag = (char *)p;
269         p += XDR_QUADLEN(hdr->taglen);
270         READ32(hdr->nops);
271         return 0;
272 }
273
274 static int
275 decode_cb_op_hdr(struct xdr_stream *xdr, enum nfs_opnum4 expected)
276 {
277         __be32 *p;
278         u32 op;
279         int32_t nfserr;
280
281         READ_BUF(8);
282         READ32(op);
283         if (op != expected) {
284                 dprintk("NFSD: decode_cb_op_hdr: Callback server returned "
285                          " operation %d but we issued a request for %d\n",
286                          op, expected);
287                 return -EIO;
288         }
289         READ32(nfserr);
290         if (nfserr != NFS_OK)
291                 return -nfs_cb_stat_to_errno(nfserr);
292         return 0;
293 }
294
295 static int
296 nfs4_xdr_dec_cb_null(struct rpc_rqst *req, __be32 *p)
297 {
298         return 0;
299 }
300
301 static int
302 nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp, __be32 *p)
303 {
304         struct xdr_stream xdr;
305         struct nfs4_cb_compound_hdr hdr;
306         int status;
307
308         xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
309         status = decode_cb_compound_hdr(&xdr, &hdr);
310         if (status)
311                 goto out;
312         status = decode_cb_op_hdr(&xdr, OP_CB_RECALL);
313 out:
314         return status;
315 }
316
317 /*
318  * RPC procedure tables
319  */
320 #define PROC(proc, call, argtype, restype)                              \
321 [NFSPROC4_CLNT_##proc] = {                                              \
322         .p_proc   = NFSPROC4_CB_##call,                                 \
323         .p_encode = (kxdrproc_t) nfs4_xdr_##argtype,                    \
324         .p_decode = (kxdrproc_t) nfs4_xdr_##restype,                    \
325         .p_arglen = NFS4_##argtype##_sz,                                \
326         .p_replen = NFS4_##restype##_sz,                                \
327         .p_statidx = NFSPROC4_CB_##call,                                \
328         .p_name   = #proc,                                              \
329 }
330
331 static struct rpc_procinfo     nfs4_cb_procedures[] = {
332     PROC(CB_NULL,      NULL,     enc_cb_null,     dec_cb_null),
333     PROC(CB_RECALL,    COMPOUND,   enc_cb_recall,      dec_cb_recall),
334 };
335
336 static struct rpc_version       nfs_cb_version4 = {
337         .number                 = 1,
338         .nrprocs                = ARRAY_SIZE(nfs4_cb_procedures),
339         .procs                  = nfs4_cb_procedures
340 };
341
342 static struct rpc_version *     nfs_cb_version[] = {
343         NULL,
344         &nfs_cb_version4,
345 };
346
347 /* Reference counting, callback cleanup, etc., all look racy as heck.
348  * And why is cb_set an atomic? */
349
350 static int do_probe_callback(void *data)
351 {
352         struct nfs4_client *clp = data;
353         struct nfs4_callback *cb = &clp->cl_callback;
354         struct rpc_message msg = {
355                 .rpc_proc       = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL],
356                 .rpc_argp       = clp,
357         };
358         int status;
359
360         status = rpc_call_sync(cb->cb_client, &msg, RPC_TASK_SOFT);
361
362         if (status) {
363                 rpc_shutdown_client(cb->cb_client);
364                 cb->cb_client = NULL;
365         } else
366                 atomic_set(&cb->cb_set, 1);
367         put_nfs4_client(clp);
368         return 0;
369 }
370
371 /*
372  * Set up the callback client and put a NFSPROC4_CB_NULL on the wire...
373  */
374 void
375 nfsd4_probe_callback(struct nfs4_client *clp)
376 {
377         struct sockaddr_in      addr;
378         struct nfs4_callback    *cb = &clp->cl_callback;
379         struct rpc_timeout      timeparms = {
380                 .to_initval     = (NFSD_LEASE_TIME/4) * HZ,
381                 .to_retries     = 5,
382                 .to_maxval      = (NFSD_LEASE_TIME/2) * HZ,
383                 .to_exponential = 1,
384         };
385         struct rpc_program *    program = &cb->cb_program;
386         struct rpc_create_args args = {
387                 .protocol       = IPPROTO_TCP,
388                 .address        = (struct sockaddr *)&addr,
389                 .addrsize       = sizeof(addr),
390                 .timeout        = &timeparms,
391                 .program        = program,
392                 .version        = nfs_cb_version[1]->number,
393                 .authflavor     = RPC_AUTH_UNIX,        /* XXX: need AUTH_GSS... */
394                 .flags          = (RPC_CLNT_CREATE_NOPING),
395         };
396         struct task_struct *t;
397
398         if (atomic_read(&cb->cb_set))
399                 return;
400
401         /* Initialize address */
402         memset(&addr, 0, sizeof(addr));
403         addr.sin_family = AF_INET;
404         addr.sin_port = htons(cb->cb_port);
405         addr.sin_addr.s_addr = htonl(cb->cb_addr);
406
407         /* Initialize rpc_program */
408         program->name = "nfs4_cb";
409         program->number = cb->cb_prog;
410         program->nrvers = ARRAY_SIZE(nfs_cb_version);
411         program->version = nfs_cb_version;
412         program->stats = &cb->cb_stat;
413
414         /* Initialize rpc_stat */
415         memset(program->stats, 0, sizeof(cb->cb_stat));
416         program->stats->program = program;
417
418         /* Create RPC client */
419         cb->cb_client = rpc_create(&args);
420         if (IS_ERR(cb->cb_client)) {
421                 dprintk("NFSD: couldn't create callback client\n");
422                 goto out_err;
423         }
424
425         /* the task holds a reference to the nfs4_client struct */
426         atomic_inc(&clp->cl_count);
427
428         t = kthread_run(do_probe_callback, clp, "nfs4_cb_probe");
429
430         if (IS_ERR(t))
431                 goto out_release_clp;
432
433         return;
434
435 out_release_clp:
436         atomic_dec(&clp->cl_count);
437         rpc_shutdown_client(cb->cb_client);
438 out_err:
439         cb->cb_client = NULL;
440         dprintk("NFSD: warning: no callback path to client %.*s\n",
441                 (int)clp->cl_name.len, clp->cl_name.data);
442 }
443
444 /*
445  * called with dp->dl_count inc'ed.
446  * nfs4_lock_state() may or may not have been called.
447  */
448 void
449 nfsd4_cb_recall(struct nfs4_delegation *dp)
450 {
451         struct nfs4_client *clp = dp->dl_client;
452         struct rpc_clnt *clnt = clp->cl_callback.cb_client;
453         struct nfs4_cb_recall *cbr = &dp->dl_recall;
454         struct rpc_message msg = {
455                 .rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL],
456                 .rpc_argp = cbr,
457         };
458         int retries = 1;
459         int status = 0;
460
461         if ((!atomic_read(&clp->cl_callback.cb_set)) || !clnt)
462                 return;
463
464         cbr->cbr_trunc = 0; /* XXX need to implement truncate optimization */
465         cbr->cbr_dp = dp;
466
467         status = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT);
468         while (retries--) {
469                 switch (status) {
470                         case -EIO:
471                                 /* Network partition? */
472                         case -EBADHANDLE:
473                         case -NFS4ERR_BAD_STATEID:
474                                 /* Race: client probably got cb_recall
475                                  * before open reply granting delegation */
476                                 break;
477                         default:
478                                 goto out_put_cred;
479                 }
480                 ssleep(2);
481                 status = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT);
482         }
483 out_put_cred:
484         if (status == -EIO)
485                 atomic_set(&clp->cl_callback.cb_set, 0);
486         /* Success or failure, now we're either waiting for lease expiration
487          * or deleg_return. */
488         dprintk("NFSD: nfs4_cb_recall: dp %p dl_flock %p dl_count %d\n",dp, dp->dl_flock, atomic_read(&dp->dl_count));
489         put_nfs4_client(clp);
490         nfs4_put_delegation(dp);
491         return;
492 }