fs/nfsd/nfs4callback.c

   1 /*
   2  *  Copyright (c) 2001 The Regents of the University of Michigan.
   3  *  All rights reserved.
   4  *
   5  *  Kendrick Smith <kmsmith@umich.edu>
   6  *  Andy Adamson <andros@umich.edu>
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions
  10  *  are met:
  11  *
  12  *  1. Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *  2. Redistributions in binary form must reproduce the above copyright
  15  *     notice, this list of conditions and the following disclaimer in the
  16  *     documentation and/or other materials provided with the distribution.
  17  *  3. Neither the name of the University nor the names of its
  18  *     contributors may be used to endorse or promote products derived
  19  *     from this software without specific prior written permission.
  20  *
  21  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  22  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  23  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  28  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  29  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  30  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  31  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <linux/sunrpc/clnt.h>
  35 #include <linux/sunrpc/svc_xprt.h>
  36 #include <linux/slab.h>
  37 #include "nfsd.h"
  38 #include "state.h"
  39
  40 #define NFSDDBG_FACILITY                NFSDDBG_PROC
  41
  42 #define NFSPROC4_CB_NULL 0
  43 #define NFSPROC4_CB_COMPOUND 1
  44
  45 /* Index of predefined Linux callback client operations */
  46
  47 enum {
  48         NFSPROC4_CLNT_CB_NULL = 0,
  49         NFSPROC4_CLNT_CB_RECALL,
  50         NFSPROC4_CLNT_CB_SEQUENCE,
  51 };
  52
  53 enum nfs_cb_opnum4 {
  54         OP_CB_RECALL            = 4,
  55         OP_CB_SEQUENCE          = 11,
  56 };
  57
  58 #define NFS4_MAXTAGLEN          20
  59
  60 #define NFS4_enc_cb_null_sz             0
  61 #define NFS4_dec_cb_null_sz             0
  62 #define cb_compound_enc_hdr_sz          4
  63 #define cb_compound_dec_hdr_sz          (3 + (NFS4_MAXTAGLEN >> 2))
  64 #define sessionid_sz                    (NFS4_MAX_SESSIONID_LEN >> 2)
  65 #define cb_sequence_enc_sz              (sessionid_sz + 4 +             \
  66                                         1 /* no referring calls list yet */)
  67 #define cb_sequence_dec_sz              (op_dec_sz + sessionid_sz + 4)
  68
  69 #define op_enc_sz                       1
  70 #define op_dec_sz                       2
  71 #define enc_nfs4_fh_sz                  (1 + (NFS4_FHSIZE >> 2))
  72 #define enc_stateid_sz                  (NFS4_STATEID_SIZE >> 2)
  73 #define NFS4_enc_cb_recall_sz           (cb_compound_enc_hdr_sz +       \
  74                                         cb_sequence_enc_sz +            \
  75                                         1 + enc_stateid_sz +            \
  76                                         enc_nfs4_fh_sz)
  77
  78 #define NFS4_dec_cb_recall_sz           (cb_compound_dec_hdr_sz  +      \
  79                                         cb_sequence_dec_sz +            \
  80                                         op_dec_sz)
  81
  82 /*
  83 * Generic encode routines from fs/nfs/nfs4xdr.c
  84 */
  85 static inline __be32 *
  86 xdr_writemem(__be32 *p, const void *ptr, int nbytes)
  87 {
  88         int tmp = XDR_QUADLEN(nbytes);
  89         if (!tmp)
  90                 return p;
  91         p[tmp-1] = 0;
  92         memcpy(p, ptr, nbytes);
  93         return p + tmp;
  94 }
  95
  96 #define WRITE32(n)               *p++ = htonl(n)
  97 #define WRITEMEM(ptr,nbytes)     do {                           \
  98         p = xdr_writemem(p, ptr, nbytes);                       \
  99 } while (0)
 100 #define RESERVE_SPACE(nbytes)   do {                            \
 101         p = xdr_reserve_space(xdr, nbytes);                     \
 102         if (!p) dprintk("NFSD: RESERVE_SPACE(%d) failed in function %s\n", (int) (nbytes), __func__); \
 103         BUG_ON(!p);                                             \
 104 } while (0)
 105
 106 /*
 107  * Generic decode routines from fs/nfs/nfs4xdr.c
 108  */
 109 #define DECODE_TAIL                             \
 110         status = 0;                             \
 111 out:                                            \
 112         return status;                          \
 113 xdr_error:                                      \
 114         dprintk("NFSD: xdr error! (%s:%d)\n", __FILE__, __LINE__); \
 115         status = -EIO;                          \
 116         goto out
 117
 118 #define READ32(x)         (x) = ntohl(*p++)
 119 #define READ64(x)         do {                  \
 120         (x) = (u64)ntohl(*p++) << 32;           \
 121         (x) |= ntohl(*p++);                     \
 122 } while (0)
 123 #define READTIME(x)       do {                  \
 124         p++;                                    \
 125         (x.tv_sec) = ntohl(*p++);               \
 126         (x.tv_nsec) = ntohl(*p++);              \
 127 } while (0)
 128 #define READ_BUF(nbytes)  do { \
 129         p = xdr_inline_decode(xdr, nbytes); \
 130         if (!p) { \
 131                 dprintk("NFSD: %s: reply buffer overflowed in line %d.\n", \
 132                         __func__, __LINE__); \
 133                 return -EIO; \
 134         } \
 135 } while (0)
 136
 137 struct nfs4_cb_compound_hdr {
 138         /* args */
 139         u32             ident;  /* minorversion 0 only */
 140         u32             nops;
 141         __be32          *nops_p;
 142         u32             minorversion;
 143         /* res */
 144         int             status;
 145 };
 146
 147 static struct {
 148 int stat;
 149 int errno;
 150 } nfs_cb_errtbl[] = {
 151         { NFS4_OK,              0               },
 152         { NFS4ERR_PERM,         EPERM           },
 153         { NFS4ERR_NOENT,        ENOENT          },
 154         { NFS4ERR_IO,           EIO             },
 155         { NFS4ERR_NXIO,         ENXIO           },
 156         { NFS4ERR_ACCESS,       EACCES          },
 157         { NFS4ERR_EXIST,        EEXIST          },
 158         { NFS4ERR_XDEV,         EXDEV           },
 159         { NFS4ERR_NOTDIR,       ENOTDIR         },
 160         { NFS4ERR_ISDIR,        EISDIR          },
 161         { NFS4ERR_INVAL,        EINVAL          },
 162         { NFS4ERR_FBIG,         EFBIG           },
 163         { NFS4ERR_NOSPC,        ENOSPC          },
 164         { NFS4ERR_ROFS,         EROFS           },
 165         { NFS4ERR_MLINK,        EMLINK          },
 166         { NFS4ERR_NAMETOOLONG,  ENAMETOOLONG    },
 167         { NFS4ERR_NOTEMPTY,     ENOTEMPTY       },
 168         { NFS4ERR_DQUOT,        EDQUOT          },
 169         { NFS4ERR_STALE,        ESTALE          },
 170         { NFS4ERR_BADHANDLE,    EBADHANDLE      },
 171         { NFS4ERR_BAD_COOKIE,   EBADCOOKIE      },
 172         { NFS4ERR_NOTSUPP,      ENOTSUPP        },
 173         { NFS4ERR_TOOSMALL,     ETOOSMALL       },
 174         { NFS4ERR_SERVERFAULT,  ESERVERFAULT    },
 175         { NFS4ERR_BADTYPE,      EBADTYPE        },
 176         { NFS4ERR_LOCKED,       EAGAIN          },
 177         { NFS4ERR_RESOURCE,     EREMOTEIO       },
 178         { NFS4ERR_SYMLINK,      ELOOP           },
 179         { NFS4ERR_OP_ILLEGAL,   EOPNOTSUPP      },
 180         { NFS4ERR_DEADLOCK,     EDEADLK         },
 181         { -1,                   EIO             }
 182 };
 183
 184 static int
 185 nfs_cb_stat_to_errno(int stat)
 186 {
 187         int i;
 188         for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
 189                 if (nfs_cb_errtbl[i].stat == stat)
 190                         return nfs_cb_errtbl[i].errno;
 191         }
 192         /* If we cannot translate the error, the recovery routines should
 193         * handle it.
 194         * Note: remaining NFSv4 error codes have values > 10000, so should
 195         * not conflict with native Linux error codes.
 196         */
 197         return stat;
 198 }
 199
 200 /*
 201  * XDR encode
 202  */
 203
 204 static void
 205 encode_stateid(struct xdr_stream *xdr, stateid_t *sid)
 206 {
 207         __be32 *p;
 208
 209         RESERVE_SPACE(sizeof(stateid_t));
 210         WRITE32(sid->si_generation);
 211         WRITEMEM(&sid->si_opaque, sizeof(stateid_opaque_t));
 212 }
 213
 214 static void
 215 encode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr)
 216 {
 217         __be32 * p;
 218
 219         RESERVE_SPACE(16);
 220         WRITE32(0);            /* tag length is always 0 */
 221         WRITE32(hdr->minorversion);
 222         WRITE32(hdr->ident);
 223         hdr->nops_p = p;
 224         WRITE32(hdr->nops);
 225 }
 226
 227 static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
 228 {
 229         *hdr->nops_p = htonl(hdr->nops);
 230 }
 231
 232 static void
 233 encode_cb_recall(struct xdr_stream *xdr, struct nfs4_delegation *dp,
 234                 struct nfs4_cb_compound_hdr *hdr)
 235 {
 236         __be32 *p;
 237         int len = dp->dl_fh.fh_size;
 238
 239         RESERVE_SPACE(4);
 240         WRITE32(OP_CB_RECALL);
 241         encode_stateid(xdr, &dp->dl_stateid);
 242         RESERVE_SPACE(8 + (XDR_QUADLEN(len) << 2));
 243         WRITE32(0); /* truncate optimization not implemented */
 244         WRITE32(len);
 245         WRITEMEM(&dp->dl_fh.fh_base, len);
 246         hdr->nops++;
 247 }
 248
 249 static void
 250 encode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_callback *cb,
 251                    struct nfs4_cb_compound_hdr *hdr)
 252 {
 253         __be32 *p;
 254
 255         if (hdr->minorversion == 0)
 256                 return;
 257
 258         RESERVE_SPACE(1 + NFS4_MAX_SESSIONID_LEN + 20);
 259
 260         WRITE32(OP_CB_SEQUENCE);
 261         WRITEMEM(cb->cb_clp->cl_sessionid.data, NFS4_MAX_SESSIONID_LEN);
 262         WRITE32(cb->cb_clp->cl_cb_seq_nr);
 263         WRITE32(0);             /* slotid, always 0 */
 264         WRITE32(0);             /* highest slotid always 0 */
 265         WRITE32(0);             /* cachethis always 0 */
 266         WRITE32(0); /* FIXME: support referring_call_lists */
 267         hdr->nops++;
 268 }
 269
 270 static int
 271 nfs4_xdr_enc_cb_null(struct rpc_rqst *req, __be32 *p)
 272 {
 273         struct xdr_stream xdrs, *xdr = &xdrs;
 274
 275         xdr_init_encode(&xdrs, &req->rq_snd_buf, p);
 276         RESERVE_SPACE(0);
 277         return 0;
 278 }
 279
 280 static int
 281 nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, __be32 *p,
 282                 struct nfsd4_callback *cb)
 283 {
 284         struct xdr_stream xdr;
 285         struct nfs4_delegation *args = cb->cb_op;
 286         struct nfs4_cb_compound_hdr hdr = {
 287                 .ident = cb->cb_clp->cl_cb_ident,
 288                 .minorversion = cb->cb_minorversion,
 289         };
 290
 291         xdr_init_encode(&xdr, &req->rq_snd_buf, p);
 292         encode_cb_compound_hdr(&xdr, &hdr);
 293         encode_cb_sequence(&xdr, cb, &hdr);
 294         encode_cb_recall(&xdr, args, &hdr);
 295         encode_cb_nops(&hdr);
 296         return 0;
 297 }
 298
 299
 300 static int
 301 decode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr){
 302         __be32 *p;
 303         u32 taglen;
 304
 305         READ_BUF(8);
 306         READ32(hdr->status);
 307         /* We've got no use for the tag; ignore it: */
 308         READ32(taglen);
 309         READ_BUF(taglen + 4);
 310         p += XDR_QUADLEN(taglen);
 311         READ32(hdr->nops);
 312         return 0;
 313 }
 314
 315 static int
 316 decode_cb_op_hdr(struct xdr_stream *xdr, enum nfs_opnum4 expected)
 317 {
 318         __be32 *p;
 319         u32 op;
 320         int32_t nfserr;
 321
 322         READ_BUF(8);
 323         READ32(op);
 324         if (op != expected) {
 325                 dprintk("NFSD: decode_cb_op_hdr: Callback server returned "
 326                          " operation %d but we issued a request for %d\n",
 327                          op, expected);
 328                 return -EIO;
 329         }
 330         READ32(nfserr);
 331         if (nfserr != NFS_OK)
 332                 return -nfs_cb_stat_to_errno(nfserr);
 333         return 0;
 334 }
 335
 336 /*
 337  * Our current back channel implmentation supports a single backchannel
 338  * with a single slot.
 339  */
 340 static int
 341 decode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_callback *cb,
 342                    struct rpc_rqst *rqstp)
 343 {
 344         struct nfs4_sessionid id;
 345         int status;
 346         u32 dummy;
 347         __be32 *p;
 348
 349         if (cb->cb_minorversion == 0)
 350                 return 0;
 351
 352         status = decode_cb_op_hdr(xdr, OP_CB_SEQUENCE);
 353         if (status)
 354                 return status;
 355
 356         /*
 357          * If the server returns different values for sessionID, slotID or
 358          * sequence number, the server is looney tunes.
 359          */
 360         status = -ESERVERFAULT;
 361
 362         READ_BUF(NFS4_MAX_SESSIONID_LEN + 16);
 363         memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
 364         p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
 365         if (memcmp(id.data, cb->cb_clp->cl_sessionid.data,
 366                    NFS4_MAX_SESSIONID_LEN)) {
 367                 dprintk("%s Invalid session id\n", __func__);
 368                 goto out;
 369         }
 370         READ32(dummy);
 371         if (dummy != cb->cb_clp->cl_cb_seq_nr) {
 372                 dprintk("%s Invalid sequence number\n", __func__);
 373                 goto out;
 374         }
 375         READ32(dummy);  /* slotid must be 0 */
 376         if (dummy != 0) {
 377                 dprintk("%s Invalid slotid\n", __func__);
 378                 goto out;
 379         }
 380         /* FIXME: process highest slotid and target highest slotid */
 381         status = 0;
 382 out:
 383         return status;
 384 }
 385
 386
 387 static int
 388 nfs4_xdr_dec_cb_null(struct rpc_rqst *req, __be32 *p)
 389 {
 390         return 0;
 391 }
 392
 393 static int
 394 nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp, __be32 *p,
 395                 struct nfsd4_callback *cb)
 396 {
 397         struct xdr_stream xdr;
 398         struct nfs4_cb_compound_hdr hdr;
 399         int status;
 400
 401         xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
 402         status = decode_cb_compound_hdr(&xdr, &hdr);
 403         if (status)
 404                 goto out;
 405         if (cb) {
 406                 status = decode_cb_sequence(&xdr, cb, rqstp);
 407                 if (status)
 408                         goto out;
 409         }
 410         status = decode_cb_op_hdr(&xdr, OP_CB_RECALL);
 411 out:
 412         return status;
 413 }
 414
 415 /*
 416  * RPC procedure tables
 417  */
 418 #define PROC(proc, call, argtype, restype)                              \
 419 [NFSPROC4_CLNT_##proc] = {                                              \
 420         .p_proc   = NFSPROC4_CB_##call,                                 \
 421         .p_encode = (kxdrproc_t) nfs4_xdr_##argtype,                    \
 422         .p_decode = (kxdrproc_t) nfs4_xdr_##restype,                    \
 423         .p_arglen = NFS4_##argtype##_sz,                                \
 424         .p_replen = NFS4_##restype##_sz,                                \
 425         .p_statidx = NFSPROC4_CB_##call,                                \
 426         .p_name   = #proc,                                              \
 427 }
 428
 429 static struct rpc_procinfo     nfs4_cb_procedures[] = {
 430     PROC(CB_NULL,      NULL,     enc_cb_null,     dec_cb_null),
 431     PROC(CB_RECALL,    COMPOUND,   enc_cb_recall,      dec_cb_recall),
 432 };
 433
 434 static struct rpc_version       nfs_cb_version4 = {
 435 /*
 436  * Note on the callback rpc program version number: despite language in rfc
 437  * 5661 section 18.36.3 requiring servers to use 4 in this field, the
 438  * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
 439  * in practice that appears to be what implementations use.  The section
 440  * 18.36.3 language is expected to be fixed in an erratum.
 441  */
 442         .number                 = 1,
 443         .nrprocs                = ARRAY_SIZE(nfs4_cb_procedures),
 444         .procs                  = nfs4_cb_procedures
 445 };
 446
 447 static struct rpc_version *     nfs_cb_version[] = {
 448         &nfs_cb_version4,
 449 };
 450
 451 static struct rpc_program cb_program;
 452
 453 static struct rpc_stat cb_stats = {
 454                 .program        = &cb_program
 455 };
 456
 457 #define NFS4_CALLBACK 0x40000000
 458 static struct rpc_program cb_program = {
 459                 .name           = "nfs4_cb",
 460                 .number         = NFS4_CALLBACK,
 461                 .nrvers         = ARRAY_SIZE(nfs_cb_version),
 462                 .version        = nfs_cb_version,
 463                 .stats          = &cb_stats,
 464                 .pipe_dir_name  = "/nfsd4_cb",
 465 };
 466
 467 static int max_cb_time(void)
 468 {
 469         return max(nfsd4_lease/10, (time_t)1) * HZ;
 470 }
 471
 472 /* Reference counting, callback cleanup, etc., all look racy as heck.
 473  * And why is cl_cb_set an atomic? */
 474
 475 int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
 476 {
 477         struct rpc_timeout      timeparms = {
 478                 .to_initval     = max_cb_time(),
 479                 .to_retries     = 0,
 480         };
 481         struct rpc_create_args args = {
 482                 .net            = &init_net,
 483                 .protocol       = XPRT_TRANSPORT_TCP,
 484                 .address        = (struct sockaddr *) &conn->cb_addr,
 485                 .addrsize       = conn->cb_addrlen,
 486                 .timeout        = &timeparms,
 487                 .program        = &cb_program,
 488                 .prognumber     = conn->cb_prog,
 489                 .version        = 0,
 490                 .authflavor     = clp->cl_flavor,
 491                 .flags          = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
 492                 .client_name    = clp->cl_principal,
 493         };
 494         struct rpc_clnt *client;
 495
 496         if (!clp->cl_principal && (clp->cl_flavor >= RPC_AUTH_GSS_KRB5))
 497                 return -EINVAL;
 498         if (conn->cb_minorversion) {
 499                 args.bc_xprt = conn->cb_xprt;
 500                 args.protocol = XPRT_TRANSPORT_BC_TCP;
 501         }
 502         /* Create RPC client */
 503         client = rpc_create(&args);
 504         if (IS_ERR(client)) {
 505                 dprintk("NFSD: couldn't create callback client: %ld\n",
 506                         PTR_ERR(client));
 507                 return PTR_ERR(client);
 508         }
 509         clp->cl_cb_ident = conn->cb_ident;
 510         clp->cl_cb_client = client;
 511         return 0;
 512
 513 }
 514
 515 static void warn_no_callback_path(struct nfs4_client *clp, int reason)
 516 {
 517         dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
 518                 (int)clp->cl_name.len, clp->cl_name.data, reason);
 519 }
 520
 521 static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
 522 {
 523         struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
 524
 525         if (task->tk_status)
 526                 warn_no_callback_path(clp, task->tk_status);
 527         else
 528                 atomic_set(&clp->cl_cb_set, 1);
 529 }
 530
 531 static const struct rpc_call_ops nfsd4_cb_probe_ops = {
 532         /* XXX: release method to ensure we set the cb channel down if
 533          * necessary on early failure? */
 534         .rpc_call_done = nfsd4_cb_probe_done,
 535 };
 536
 537 static struct rpc_cred *callback_cred;
 538
 539 int set_callback_cred(void)
 540 {
 541         if (callback_cred)
 542                 return 0;
 543         callback_cred = rpc_lookup_machine_cred();
 544         if (!callback_cred)
 545                 return -ENOMEM;
 546         return 0;
 547 }
 548
 549 static struct workqueue_struct *callback_wq;
 550
 551 void do_probe_callback(struct nfs4_client *clp)
 552 {
 553         struct nfsd4_callback *cb = &clp->cl_cb_null;
 554
 555         cb->cb_op = NULL;
 556         cb->cb_clp = clp;
 557
 558         cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL];
 559         cb->cb_msg.rpc_argp = NULL;
 560         cb->cb_msg.rpc_resp = NULL;
 561         cb->cb_msg.rpc_cred = callback_cred;
 562
 563         cb->cb_ops = &nfsd4_cb_probe_ops;
 564
 565         queue_work(callback_wq, &cb->cb_work);
 566 }
 567
 568 /*
 569  * Set up the callback client and put a NFSPROC4_CB_NULL on the wire...
 570  */
 571 void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
 572 {
 573         BUG_ON(atomic_read(&clp->cl_cb_set));
 574
 575         spin_lock(&clp->cl_lock);
 576         memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
 577         set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags);
 578         spin_unlock(&clp->cl_lock);
 579         do_probe_callback(clp);
 580 }
 581
 582 /*
 583  * There's currently a single callback channel slot.
 584  * If the slot is available, then mark it busy.  Otherwise, set the
 585  * thread for sleeping on the callback RPC wait queue.
 586  */
 587 static int nfsd41_cb_setup_sequence(struct nfs4_client *clp,
 588                 struct rpc_task *task)
 589 {
 590         u32 *ptr = (u32 *)clp->cl_sessionid.data;
 591         int status = 0;
 592
 593         dprintk("%s: %u:%u:%u:%u\n", __func__,
 594                 ptr[0], ptr[1], ptr[2], ptr[3]);
 595
 596         if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
 597                 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
 598                 dprintk("%s slot is busy\n", __func__);
 599                 status = -EAGAIN;
 600                 goto out;
 601         }
 602 out:
 603         dprintk("%s status=%d\n", __func__, status);
 604         return status;
 605 }
 606
 607 /*
 608  * TODO: cb_sequence should support referring call lists, cachethis, multiple
 609  * slots, and mark callback channel down on communication errors.
 610  */
 611 static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
 612 {
 613         struct nfsd4_callback *cb = calldata;
 614         struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
 615         struct nfs4_client *clp = dp->dl_client;
 616         u32 minorversion = clp->cl_cb_conn.cb_minorversion;
 617         int status = 0;
 618
 619         cb->cb_minorversion = minorversion;
 620         if (minorversion) {
 621                 status = nfsd41_cb_setup_sequence(clp, task);
 622                 if (status) {
 623                         if (status != -EAGAIN) {
 624                                 /* terminate rpc task */
 625                                 task->tk_status = status;
 626                                 task->tk_action = NULL;
 627                         }
 628                         return;
 629                 }
 630         }
 631         rpc_call_start(task);
 632 }
 633
 634 static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
 635 {
 636         struct nfsd4_callback *cb = calldata;
 637         struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
 638         struct nfs4_client *clp = dp->dl_client;
 639
 640         dprintk("%s: minorversion=%d\n", __func__,
 641                 clp->cl_cb_conn.cb_minorversion);
 642
 643         if (clp->cl_cb_conn.cb_minorversion) {
 644                 /* No need for lock, access serialized in nfsd4_cb_prepare */
 645                 ++clp->cl_cb_seq_nr;
 646                 clear_bit(0, &clp->cl_cb_slot_busy);
 647                 rpc_wake_up_next(&clp->cl_cb_waitq);
 648                 dprintk("%s: freed slot, new seqid=%d\n", __func__,
 649                         clp->cl_cb_seq_nr);
 650
 651                 /* We're done looking into the sequence information */
 652                 task->tk_msg.rpc_resp = NULL;
 653         }
 654 }
 655
 656
 657 static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
 658 {
 659         struct nfsd4_callback *cb = calldata;
 660         struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
 661         struct nfs4_client *clp = dp->dl_client;
 662         struct rpc_clnt *current_rpc_client = clp->cl_cb_client;
 663
 664         nfsd4_cb_done(task, calldata);
 665
 666         if (current_rpc_client == NULL) {
 667                 /* We're shutting down; give up. */
 668                 /* XXX: err, or is it ok just to fall through
 669                  * and rpc_restart_call? */
 670                 return;
 671         }
 672
 673         switch (task->tk_status) {
 674         case 0:
 675                 return;
 676         case -EBADHANDLE:
 677         case -NFS4ERR_BAD_STATEID:
 678                 /* Race: client probably got cb_recall
 679                  * before open reply granting delegation */
 680                 break;
 681         default:
 682                 /* Network partition? */
 683                 atomic_set(&clp->cl_cb_set, 0);
 684                 warn_no_callback_path(clp, task->tk_status);
 685                 if (current_rpc_client != task->tk_client) {
 686                         /* queue a callback on the new connection: */
 687                         atomic_inc(&dp->dl_count);
 688                         nfsd4_cb_recall(dp);
 689                         return;
 690                 }
 691         }
 692         if (dp->dl_retries--) {
 693                 rpc_delay(task, 2*HZ);
 694                 task->tk_status = 0;
 695                 rpc_restart_call_prepare(task);
 696                 return;
 697         } else {
 698                 atomic_set(&clp->cl_cb_set, 0);
 699                 warn_no_callback_path(clp, task->tk_status);
 700         }
 701 }
 702
 703 static void nfsd4_cb_recall_release(void *calldata)
 704 {
 705         struct nfsd4_callback *cb = calldata;
 706         struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
 707
 708         nfs4_put_delegation(dp);
 709 }
 710
 711 static const struct rpc_call_ops nfsd4_cb_recall_ops = {
 712         .rpc_call_prepare = nfsd4_cb_prepare,
 713         .rpc_call_done = nfsd4_cb_recall_done,
 714         .rpc_release = nfsd4_cb_recall_release,
 715 };
 716
 717 int nfsd4_create_callback_queue(void)
 718 {
 719         callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
 720         if (!callback_wq)
 721                 return -ENOMEM;
 722         return 0;
 723 }
 724
 725 void nfsd4_destroy_callback_queue(void)
 726 {
 727         destroy_workqueue(callback_wq);
 728 }
 729
 730 /* must be called under the state lock */
 731 void nfsd4_shutdown_callback(struct nfs4_client *clp)
 732 {
 733         set_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags);
 734         /*
 735          * Note this won't actually result in a null callback;
 736          * instead, nfsd4_do_callback_rpc() will detect the killed
 737          * client, destroy the rpc client, and stop:
 738          */
 739         do_probe_callback(clp);
 740         flush_workqueue(callback_wq);
 741 }
 742
 743 void nfsd4_release_cb(struct nfsd4_callback *cb)
 744 {
 745         if (cb->cb_ops->rpc_release)
 746                 cb->cb_ops->rpc_release(cb);
 747 }
 748
 749 void nfsd4_process_cb_update(struct nfsd4_callback *cb)
 750 {
 751         struct nfs4_cb_conn conn;
 752         struct nfs4_client *clp = cb->cb_clp;
 753         int err;
 754
 755         /*
 756          * This is either an update, or the client dying; in either case,
 757          * kill the old client:
 758          */
 759         if (clp->cl_cb_client) {
 760                 rpc_shutdown_client(clp->cl_cb_client);
 761                 clp->cl_cb_client = NULL;
 762         }
 763         if (test_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags))
 764                 return;
 765         spin_lock(&clp->cl_lock);
 766         /*
 767          * Only serialized callback code is allowed to clear these
 768          * flags; main nfsd code can only set them:
 769          */
 770         BUG_ON(!clp->cl_cb_flags);
 771         clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags);
 772         memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
 773         spin_unlock(&clp->cl_lock);
 774
 775         err = setup_callback_client(clp, &conn);
 776         if (err)
 777                 warn_no_callback_path(clp, err);
 778 }
 779
 780 void nfsd4_do_callback_rpc(struct work_struct *w)
 781 {
 782         struct nfsd4_callback *cb = container_of(w, struct nfsd4_callback, cb_work);
 783         struct nfs4_client *clp = cb->cb_clp;
 784         struct rpc_clnt *clnt;
 785
 786         if (clp->cl_cb_flags)
 787                 nfsd4_process_cb_update(cb);
 788
 789         clnt = clp->cl_cb_client;
 790         if (!clnt) {
 791                 /* Callback channel broken, or client killed; give up: */
 792                 nfsd4_release_cb(cb);
 793                 return;
 794         }
 795         rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
 796                         cb->cb_ops, cb);
 797 }
 798
 799 void nfsd4_cb_recall(struct nfs4_delegation *dp)
 800 {
 801         struct nfsd4_callback *cb = &dp->dl_recall;
 802
 803         dp->dl_retries = 1;
 804         cb->cb_op = dp;
 805         cb->cb_clp = dp->dl_client;
 806         cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL];
 807         cb->cb_msg.rpc_argp = cb;
 808         cb->cb_msg.rpc_resp = cb;
 809         cb->cb_msg.rpc_cred = callback_cred;
 810
 811         cb->cb_ops = &nfsd4_cb_recall_ops;
 812         dp->dl_retries = 1;
 813
 814         queue_work(callback_wq, &dp->dl_recall.cb_work);
 815 }