2 * linux/fs/nfsd/nfs4callback.c
4 * Copyright (c) 2001 The Regents of the University of Michigan.
7 * Kendrick Smith <kmsmith@umich.edu>
8 * Andy Adamson <andros@umich.edu>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
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/sunrpc/xdr.h>
42 #include <linux/sunrpc/svc.h>
43 #include <linux/sunrpc/clnt.h>
44 #include <linux/nfsd/nfsd.h>
45 #include <linux/nfsd/state.h>
46 #include <linux/sunrpc/sched.h>
47 #include <linux/nfs4.h>
49 #define NFSDDBG_FACILITY NFSDDBG_PROC
51 #define NFSPROC4_CB_NULL 0
52 #define NFSPROC4_CB_COMPOUND 1
55 static const struct rpc_call_ops nfs4_cb_null_ops
;
57 /* Index of predefined Linux callback client operations */
60 NFSPROC4_CLNT_CB_NULL
= 0,
61 NFSPROC4_CLNT_CB_RECALL
,
68 #define NFS4_MAXTAGLEN 20
70 #define NFS4_enc_cb_null_sz 0
71 #define NFS4_dec_cb_null_sz 0
72 #define cb_compound_enc_hdr_sz 4
73 #define cb_compound_dec_hdr_sz (3 + (NFS4_MAXTAGLEN >> 2))
76 #define enc_nfs4_fh_sz (1 + (NFS4_FHSIZE >> 2))
77 #define enc_stateid_sz 16
78 #define NFS4_enc_cb_recall_sz (cb_compound_enc_hdr_sz + \
79 1 + enc_stateid_sz + \
82 #define NFS4_dec_cb_recall_sz (cb_compound_dec_hdr_sz + \
86 * Generic encode routines from fs/nfs/nfs4xdr.c
88 static inline __be32
*
89 xdr_writemem(__be32
*p
, const void *ptr
, int nbytes
)
91 int tmp
= XDR_QUADLEN(nbytes
);
95 memcpy(p
, ptr
, nbytes
);
99 #define WRITE32(n) *p++ = htonl(n)
100 #define WRITEMEM(ptr,nbytes) do { \
101 p = xdr_writemem(p, ptr, nbytes); \
103 #define RESERVE_SPACE(nbytes) do { \
104 p = xdr_reserve_space(xdr, nbytes); \
105 if (!p) dprintk("NFSD: RESERVE_SPACE(%d) failed in function %s\n", (int) (nbytes), __FUNCTION__); \
110 * Generic decode routines from fs/nfs/nfs4xdr.c
112 #define DECODE_TAIL \
117 dprintk("NFSD: xdr error! (%s:%d)\n", __FILE__, __LINE__); \
121 #define READ32(x) (x) = ntohl(*p++)
122 #define READ64(x) do { \
123 (x) = (u64)ntohl(*p++) << 32; \
124 (x) |= ntohl(*p++); \
126 #define READTIME(x) do { \
128 (x.tv_sec) = ntohl(*p++); \
129 (x.tv_nsec) = ntohl(*p++); \
131 #define READ_BUF(nbytes) do { \
132 p = xdr_inline_decode(xdr, nbytes); \
134 dprintk("NFSD: %s: reply buffer overflowed in line %d.\n", \
135 __FUNCTION__, __LINE__); \
140 struct nfs4_cb_compound_hdr
{
151 } nfs_cb_errtbl
[] = {
153 { NFS4ERR_PERM
, EPERM
},
154 { NFS4ERR_NOENT
, ENOENT
},
156 { NFS4ERR_NXIO
, ENXIO
},
157 { NFS4ERR_ACCESS
, EACCES
},
158 { NFS4ERR_EXIST
, EEXIST
},
159 { NFS4ERR_XDEV
, EXDEV
},
160 { NFS4ERR_NOTDIR
, ENOTDIR
},
161 { NFS4ERR_ISDIR
, EISDIR
},
162 { NFS4ERR_INVAL
, EINVAL
},
163 { NFS4ERR_FBIG
, EFBIG
},
164 { NFS4ERR_NOSPC
, ENOSPC
},
165 { NFS4ERR_ROFS
, EROFS
},
166 { NFS4ERR_MLINK
, EMLINK
},
167 { NFS4ERR_NAMETOOLONG
, ENAMETOOLONG
},
168 { NFS4ERR_NOTEMPTY
, ENOTEMPTY
},
169 { NFS4ERR_DQUOT
, EDQUOT
},
170 { NFS4ERR_STALE
, ESTALE
},
171 { NFS4ERR_BADHANDLE
, EBADHANDLE
},
172 { NFS4ERR_BAD_COOKIE
, EBADCOOKIE
},
173 { NFS4ERR_NOTSUPP
, ENOTSUPP
},
174 { NFS4ERR_TOOSMALL
, ETOOSMALL
},
175 { NFS4ERR_SERVERFAULT
, ESERVERFAULT
},
176 { NFS4ERR_BADTYPE
, EBADTYPE
},
177 { NFS4ERR_LOCKED
, EAGAIN
},
178 { NFS4ERR_RESOURCE
, EREMOTEIO
},
179 { NFS4ERR_SYMLINK
, ELOOP
},
180 { NFS4ERR_OP_ILLEGAL
, EOPNOTSUPP
},
181 { NFS4ERR_DEADLOCK
, EDEADLK
},
186 nfs_cb_stat_to_errno(int stat
)
189 for (i
= 0; nfs_cb_errtbl
[i
].stat
!= -1; i
++) {
190 if (nfs_cb_errtbl
[i
].stat
== stat
)
191 return nfs_cb_errtbl
[i
].errno
;
193 /* If we cannot translate the error, the recovery routines should
195 * Note: remaining NFSv4 error codes have values > 10000, so should
196 * not conflict with native Linux error codes.
206 encode_cb_compound_hdr(struct xdr_stream
*xdr
, struct nfs4_cb_compound_hdr
*hdr
)
211 WRITE32(0); /* tag length is always 0 */
212 WRITE32(NFS4_MINOR_VERSION
);
219 encode_cb_recall(struct xdr_stream
*xdr
, struct nfs4_cb_recall
*cb_rec
)
222 int len
= cb_rec
->cbr_fhlen
;
224 RESERVE_SPACE(12+sizeof(cb_rec
->cbr_stateid
) + len
);
225 WRITE32(OP_CB_RECALL
);
226 WRITEMEM(&cb_rec
->cbr_stateid
, sizeof(stateid_t
));
227 WRITE32(cb_rec
->cbr_trunc
);
229 WRITEMEM(cb_rec
->cbr_fhval
, len
);
234 nfs4_xdr_enc_cb_null(struct rpc_rqst
*req
, __be32
*p
)
236 struct xdr_stream xdrs
, *xdr
= &xdrs
;
238 xdr_init_encode(&xdrs
, &req
->rq_snd_buf
, p
);
244 nfs4_xdr_enc_cb_recall(struct rpc_rqst
*req
, __be32
*p
, struct nfs4_cb_recall
*args
)
246 struct xdr_stream xdr
;
247 struct nfs4_cb_compound_hdr hdr
= {
248 .ident
= args
->cbr_ident
,
252 xdr_init_encode(&xdr
, &req
->rq_snd_buf
, p
);
253 encode_cb_compound_hdr(&xdr
, &hdr
);
254 return (encode_cb_recall(&xdr
, args
));
259 decode_cb_compound_hdr(struct xdr_stream
*xdr
, struct nfs4_cb_compound_hdr
*hdr
){
265 READ_BUF(hdr
->taglen
+ 4);
266 hdr
->tag
= (char *)p
;
267 p
+= XDR_QUADLEN(hdr
->taglen
);
273 decode_cb_op_hdr(struct xdr_stream
*xdr
, enum nfs_opnum4 expected
)
281 if (op
!= expected
) {
282 dprintk("NFSD: decode_cb_op_hdr: Callback server returned "
283 " operation %d but we issued a request for %d\n",
288 if (nfserr
!= NFS_OK
)
289 return -nfs_cb_stat_to_errno(nfserr
);
294 nfs4_xdr_dec_cb_null(struct rpc_rqst
*req
, __be32
*p
)
300 nfs4_xdr_dec_cb_recall(struct rpc_rqst
*rqstp
, __be32
*p
)
302 struct xdr_stream xdr
;
303 struct nfs4_cb_compound_hdr hdr
;
306 xdr_init_decode(&xdr
, &rqstp
->rq_rcv_buf
, p
);
307 status
= decode_cb_compound_hdr(&xdr
, &hdr
);
310 status
= decode_cb_op_hdr(&xdr
, OP_CB_RECALL
);
316 * RPC procedure tables
319 # define MAX(a, b) (((a) > (b))? (a) : (b))
322 #define PROC(proc, call, argtype, restype) \
323 [NFSPROC4_CLNT_##proc] = { \
324 .p_proc = NFSPROC4_CB_##call, \
325 .p_encode = (kxdrproc_t) nfs4_xdr_##argtype, \
326 .p_decode = (kxdrproc_t) nfs4_xdr_##restype, \
327 .p_bufsiz = MAX(NFS4_##argtype##_sz,NFS4_##restype##_sz) << 2, \
328 .p_statidx = NFSPROC4_CB_##call, \
332 static struct rpc_procinfo nfs4_cb_procedures
[] = {
333 PROC(CB_NULL
, NULL
, enc_cb_null
, dec_cb_null
),
334 PROC(CB_RECALL
, COMPOUND
, enc_cb_recall
, dec_cb_recall
),
337 static struct rpc_version nfs_cb_version4
= {
339 .nrprocs
= ARRAY_SIZE(nfs4_cb_procedures
),
340 .procs
= nfs4_cb_procedures
343 static struct rpc_version
* nfs_cb_version
[] = {
349 * Use the SETCLIENTID credential
351 static struct rpc_cred
*
352 nfsd4_lookupcred(struct nfs4_client
*clp
, int taskflags
)
354 struct auth_cred acred
;
355 struct rpc_clnt
*clnt
= clp
->cl_callback
.cb_client
;
356 struct rpc_cred
*ret
;
358 get_group_info(clp
->cl_cred
.cr_group_info
);
359 acred
.uid
= clp
->cl_cred
.cr_uid
;
360 acred
.gid
= clp
->cl_cred
.cr_gid
;
361 acred
.group_info
= clp
->cl_cred
.cr_group_info
;
363 dprintk("NFSD: looking up %s cred\n",
364 clnt
->cl_auth
->au_ops
->au_name
);
365 ret
= rpcauth_lookup_credcache(clnt
->cl_auth
, &acred
, taskflags
);
366 put_group_info(clp
->cl_cred
.cr_group_info
);
371 * Set up the callback client and put a NFSPROC4_CB_NULL on the wire...
374 nfsd4_probe_callback(struct nfs4_client
*clp
)
376 struct sockaddr_in addr
;
377 struct nfs4_callback
*cb
= &clp
->cl_callback
;
378 struct rpc_timeout timeparms
= {
379 .to_initval
= (NFSD_LEASE_TIME
/4) * HZ
,
381 .to_maxval
= (NFSD_LEASE_TIME
/2) * HZ
,
384 struct rpc_program
* program
= &cb
->cb_program
;
385 struct rpc_create_args args
= {
386 .protocol
= IPPROTO_TCP
,
387 .address
= (struct sockaddr
*)&addr
,
388 .addrsize
= sizeof(addr
),
389 .timeout
= &timeparms
,
390 .servername
= clp
->cl_name
.data
,
392 .version
= nfs_cb_version
[1]->number
,
393 .authflavor
= RPC_AUTH_UNIX
, /* XXX: need AUTH_GSS... */
394 .flags
= (RPC_CLNT_CREATE_NOPING
),
396 struct rpc_message msg
= {
397 .rpc_proc
= &nfs4_cb_procedures
[NFSPROC4_CLNT_CB_NULL
],
402 if (atomic_read(&cb
->cb_set
))
405 /* Initialize address */
406 memset(&addr
, 0, sizeof(addr
));
407 addr
.sin_family
= AF_INET
;
408 addr
.sin_port
= htons(cb
->cb_port
);
409 addr
.sin_addr
.s_addr
= htonl(cb
->cb_addr
);
411 /* Initialize rpc_program */
412 program
->name
= "nfs4_cb";
413 program
->number
= cb
->cb_prog
;
414 program
->nrvers
= ARRAY_SIZE(nfs_cb_version
);
415 program
->version
= nfs_cb_version
;
416 program
->stats
= &cb
->cb_stat
;
418 /* Initialize rpc_stat */
419 memset(program
->stats
, 0, sizeof(cb
->cb_stat
));
420 program
->stats
->program
= program
;
422 /* Create RPC client */
423 cb
->cb_client
= rpc_create(&args
);
424 if (IS_ERR(cb
->cb_client
)) {
425 dprintk("NFSD: couldn't create callback client\n");
429 /* Kick rpciod, put the call on the wire. */
430 if (rpciod_up() != 0)
433 /* the task holds a reference to the nfs4_client struct */
434 atomic_inc(&clp
->cl_count
);
436 msg
.rpc_cred
= nfsd4_lookupcred(clp
,0);
437 if (IS_ERR(msg
.rpc_cred
))
439 status
= rpc_call_async(cb
->cb_client
, &msg
, RPC_TASK_ASYNC
, &nfs4_cb_null_ops
, NULL
);
440 put_rpccred(msg
.rpc_cred
);
443 dprintk("NFSD: asynchronous NFSPROC4_CB_NULL failed!\n");
449 atomic_dec(&clp
->cl_count
);
452 rpc_shutdown_client(cb
->cb_client
);
454 cb
->cb_client
= NULL
;
455 dprintk("NFSD: warning: no callback path to client %.*s\n",
456 (int)clp
->cl_name
.len
, clp
->cl_name
.data
);
460 nfs4_cb_null(struct rpc_task
*task
, void *dummy
)
462 struct nfs4_client
*clp
= (struct nfs4_client
*)task
->tk_msg
.rpc_argp
;
463 struct nfs4_callback
*cb
= &clp
->cl_callback
;
464 __be32 addr
= htonl(cb
->cb_addr
);
466 dprintk("NFSD: nfs4_cb_null task->tk_status %d\n", task
->tk_status
);
468 if (task
->tk_status
< 0) {
469 dprintk("NFSD: callback establishment to client %.*s failed\n",
470 (int)clp
->cl_name
.len
, clp
->cl_name
.data
);
473 atomic_set(&cb
->cb_set
, 1);
474 dprintk("NFSD: callback set to client %u.%u.%u.%u\n", NIPQUAD(addr
));
476 put_nfs4_client(clp
);
479 static const struct rpc_call_ops nfs4_cb_null_ops
= {
480 .rpc_call_done
= nfs4_cb_null
,
484 * called with dp->dl_count inc'ed.
485 * nfs4_lock_state() may or may not have been called.
488 nfsd4_cb_recall(struct nfs4_delegation
*dp
)
490 struct nfs4_client
*clp
= dp
->dl_client
;
491 struct rpc_clnt
*clnt
= clp
->cl_callback
.cb_client
;
492 struct nfs4_cb_recall
*cbr
= &dp
->dl_recall
;
493 struct rpc_message msg
= {
494 .rpc_proc
= &nfs4_cb_procedures
[NFSPROC4_CLNT_CB_RECALL
],
500 if ((!atomic_read(&clp
->cl_callback
.cb_set
)) || !clnt
)
503 msg
.rpc_cred
= nfsd4_lookupcred(clp
, 0);
504 if (IS_ERR(msg
.rpc_cred
))
507 cbr
->cbr_trunc
= 0; /* XXX need to implement truncate optimization */
510 status
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
);
514 /* Network partition? */
516 case -NFS4ERR_BAD_STATEID
:
517 /* Race: client probably got cb_recall
518 * before open reply granting delegation */
524 status
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
);
527 put_rpccred(msg
.rpc_cred
);
530 atomic_set(&clp
->cl_callback
.cb_set
, 0);
531 /* Success or failure, now we're either waiting for lease expiration
532 * or deleg_return. */
533 dprintk("NFSD: nfs4_cb_recall: dp %p dl_flock %p dl_count %d\n",dp
, dp
->dl_flock
, atomic_read(&dp
->dl_count
));
534 nfs4_put_delegation(dp
);