fs/nfs/callback.c

   1 /*
   2  * linux/fs/nfs/callback.c
   3  *
   4  * Copyright (C) 2004 Trond Myklebust
   5  *
   6  * NFSv4 callback handling
   7  */
   8
   9 #include <linux/completion.h>
  10 #include <linux/ip.h>
  11 #include <linux/module.h>
  12 #include <linux/sunrpc/svc.h>
  13 #include <linux/sunrpc/svcsock.h>
  14 #include <linux/nfs_fs.h>
  15 #include <linux/mutex.h>
  16 #include <linux/freezer.h>
  17 #include <linux/kthread.h>
  18 #include <linux/sunrpc/svcauth_gss.h>
  19 #include <linux/sunrpc/bc_xprt.h>
  20
  21 #include <net/inet_sock.h>
  22
  23 #include "nfs4_fs.h"
  24 #include "callback.h"
  25 #include "internal.h"
  26
  27 #define NFSDBG_FACILITY NFSDBG_CALLBACK
  28
  29 struct nfs_callback_data {
  30         unsigned int users;
  31         struct svc_serv *serv;
  32         struct svc_rqst *rqst;
  33         struct task_struct *task;
  34 };
  35
  36 static struct nfs_callback_data nfs_callback_info[NFS4_MAX_MINOR_VERSION + 1];
  37 static DEFINE_MUTEX(nfs_callback_mutex);
  38 static struct svc_program nfs4_callback_program;
  39
  40 unsigned short nfs_callback_tcpport6;
  41
  42 static int nfs4_callback_up_net(struct svc_serv *serv, struct net *net)
  43 {
  44         int ret;
  45
  46         ret = svc_create_xprt(serv, "tcp", net, PF_INET,
  47                                 nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
  48         if (ret <= 0)
  49                 goto out_err;
  50         nfs_callback_tcpport = ret;
  51         dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
  52                         nfs_callback_tcpport, PF_INET, net);
  53
  54         ret = svc_create_xprt(serv, "tcp", net, PF_INET6,
  55                                 nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
  56         if (ret > 0) {
  57                 nfs_callback_tcpport6 = ret;
  58                 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
  59                                 nfs_callback_tcpport6, PF_INET6, net);
  60         } else if (ret != -EAFNOSUPPORT)
  61                 goto out_err;
  62         return 0;
  63
  64 out_err:
  65         return (ret) ? ret : -ENOMEM;
  66 }
  67
  68 /*
  69  * This is the NFSv4 callback kernel thread.
  70  */
  71 static int
  72 nfs4_callback_svc(void *vrqstp)
  73 {
  74         int err, preverr = 0;
  75         struct svc_rqst *rqstp = vrqstp;
  76
  77         set_freezable();
  78
  79         while (!kthread_should_stop()) {
  80                 /*
  81                  * Listen for a request on the socket
  82                  */
  83                 err = svc_recv(rqstp, MAX_SCHEDULE_TIMEOUT);
  84                 if (err == -EAGAIN || err == -EINTR) {
  85                         preverr = err;
  86                         continue;
  87                 }
  88                 if (err < 0) {
  89                         if (err != preverr) {
  90                                 printk(KERN_WARNING "NFS: %s: unexpected error "
  91                                         "from svc_recv (%d)\n", __func__, err);
  92                                 preverr = err;
  93                         }
  94                         schedule_timeout_uninterruptible(HZ);
  95                         continue;
  96                 }
  97                 preverr = err;
  98                 svc_process(rqstp);
  99         }
 100         return 0;
 101 }
 102
 103 /*
 104  * Prepare to bring up the NFSv4 callback service
 105  */
 106 static struct svc_rqst *
 107 nfs4_callback_up(struct svc_serv *serv, struct rpc_xprt *xprt)
 108 {
 109         return svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
 110 }
 111
 112 #if defined(CONFIG_NFS_V4_1)
 113 static int nfs41_callback_up_net(struct svc_serv *serv, struct net *net)
 114 {
 115         /*
 116          * Create an svc_sock for the back channel service that shares the
 117          * fore channel connection.
 118          * Returns the input port (0) and sets the svc_serv bc_xprt on success
 119          */
 120         return svc_create_xprt(serv, "tcp-bc", net, PF_INET, 0,
 121                               SVC_SOCK_ANONYMOUS);
 122 }
 123
 124 /*
 125  * The callback service for NFSv4.1 callbacks
 126  */
 127 static int
 128 nfs41_callback_svc(void *vrqstp)
 129 {
 130         struct svc_rqst *rqstp = vrqstp;
 131         struct svc_serv *serv = rqstp->rq_server;
 132         struct rpc_rqst *req;
 133         int error;
 134         DEFINE_WAIT(wq);
 135
 136         set_freezable();
 137
 138         while (!kthread_should_stop()) {
 139                 prepare_to_wait(&serv->sv_cb_waitq, &wq, TASK_INTERRUPTIBLE);
 140                 spin_lock_bh(&serv->sv_cb_lock);
 141                 if (!list_empty(&serv->sv_cb_list)) {
 142                         req = list_first_entry(&serv->sv_cb_list,
 143                                         struct rpc_rqst, rq_bc_list);
 144                         list_del(&req->rq_bc_list);
 145                         spin_unlock_bh(&serv->sv_cb_lock);
 146                         dprintk("Invoking bc_svc_process()\n");
 147                         error = bc_svc_process(serv, req, rqstp);
 148                         dprintk("bc_svc_process() returned w/ error code= %d\n",
 149                                 error);
 150                 } else {
 151                         spin_unlock_bh(&serv->sv_cb_lock);
 152                         schedule();
 153                 }
 154                 finish_wait(&serv->sv_cb_waitq, &wq);
 155         }
 156         return 0;
 157 }
 158
 159 /*
 160  * Bring up the NFSv4.1 callback service
 161  */
 162 static struct svc_rqst *
 163 nfs41_callback_up(struct svc_serv *serv, struct rpc_xprt *xprt)
 164 {
 165         struct svc_rqst *rqstp;
 166
 167         /*
 168          * Save the svc_serv in the transport so that it can
 169          * be referenced when the session backchannel is initialized
 170          */
 171         xprt->bc_serv = serv;
 172
 173         INIT_LIST_HEAD(&serv->sv_cb_list);
 174         spin_lock_init(&serv->sv_cb_lock);
 175         init_waitqueue_head(&serv->sv_cb_waitq);
 176         rqstp = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
 177         if (IS_ERR(rqstp)) {
 178                 svc_xprt_put(serv->sv_bc_xprt);
 179                 serv->sv_bc_xprt = NULL;
 180         }
 181         dprintk("--> %s return %ld\n", __func__,
 182                 IS_ERR(rqstp) ? PTR_ERR(rqstp) : 0);
 183         return rqstp;
 184 }
 185
 186 static inline int nfs_minorversion_callback_svc_setup(u32 minorversion,
 187                 struct svc_serv *serv, struct rpc_xprt *xprt,
 188                 struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
 189 {
 190         if (minorversion) {
 191                 *rqstpp = nfs41_callback_up(serv, xprt);
 192                 *callback_svc = nfs41_callback_svc;
 193         }
 194         return minorversion;
 195 }
 196
 197 static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
 198                 struct nfs_callback_data *cb_info)
 199 {
 200         if (minorversion)
 201                 xprt->bc_serv = cb_info->serv;
 202 }
 203 #else
 204 static int nfs41_callback_up_net(struct svc_serv *serv, struct net *net)
 205 {
 206         return 0;
 207 }
 208
 209 static inline int nfs_minorversion_callback_svc_setup(u32 minorversion,
 210                 struct svc_serv *serv, struct rpc_xprt *xprt,
 211                 struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
 212 {
 213         return 0;
 214 }
 215
 216 static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
 217                 struct nfs_callback_data *cb_info)
 218 {
 219 }
 220 #endif /* CONFIG_NFS_V4_1 */
 221
 222 static int nfs_callback_up_net(int minorversion, struct svc_serv *serv, struct net *net)
 223 {
 224         int ret;
 225
 226         dprintk("NFS: create per-net callback data; net=%p\n", net);
 227
 228         ret = svc_bind(serv, net);
 229         if (ret < 0) {
 230                 printk(KERN_WARNING "NFS: bind callback service failed\n");
 231                 goto err_bind;
 232         }
 233
 234         switch (minorversion) {
 235                 case 0:
 236                         ret = nfs4_callback_up_net(serv, net);
 237                         break;
 238                 case 1:
 239                         ret = nfs41_callback_up_net(serv, net);
 240                         break;
 241                 default:
 242                         printk(KERN_ERR "NFS: unknown callback version: %d\n",
 243                                         minorversion);
 244                         ret = -EINVAL;
 245                         break;
 246         }
 247
 248         if (ret < 0) {
 249                 printk(KERN_ERR "NFS: callback service start failed\n");
 250                 goto err_socks;
 251         }
 252         return 0;
 253
 254 err_socks:
 255         svc_rpcb_cleanup(serv, net);
 256 err_bind:
 257         return ret;
 258 }
 259
 260 static struct svc_serv *nfs_callback_create_svc(int minorversion)
 261 {
 262         struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
 263         struct svc_serv *serv;
 264
 265         /*
 266          * Check whether we're already up and running.
 267          */
 268         if (cb_info->task) {
 269                 /*
 270                  * Note: increase service usage, because later in case of error
 271                  * svc_destroy() will be called.
 272                  */
 273                 svc_get(cb_info->serv);
 274                 return cb_info->serv;
 275         }
 276
 277         /*
 278          * Sanity check: if there's no task,
 279          * we should be the first user ...
 280          */
 281         if (cb_info->users)
 282                 printk(KERN_WARNING "nfs_callback_create_svc: no kthread, %d users??\n",
 283                         cb_info->users);
 284
 285         serv = svc_create(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE, NULL);
 286         if (!serv) {
 287                 printk(KERN_ERR "nfs_callback_create_svc: create service failed\n");
 288                 return ERR_PTR(-ENOMEM);
 289         }
 290         /* As there is only one thread we need to over-ride the
 291          * default maximum of 80 connections
 292          */
 293         serv->sv_maxconn = 1024;
 294         dprintk("nfs_callback_create_svc: service created\n");
 295         return serv;
 296 }
 297
 298 /*
 299  * Bring up the callback thread if it is not already up.
 300  */
 301 int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt)
 302 {
 303         struct svc_serv *serv;
 304         struct svc_rqst *rqstp;
 305         int (*callback_svc)(void *vrqstp);
 306         struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
 307         char svc_name[12];
 308         int ret = 0;
 309         int minorversion_setup;
 310         struct net *net = xprt->xprt_net;
 311
 312         mutex_lock(&nfs_callback_mutex);
 313
 314         serv = nfs_callback_create_svc(minorversion);
 315         if (IS_ERR(serv)) {
 316                 ret = PTR_ERR(serv);
 317                 goto err_create;
 318         }
 319
 320         if (cb_info->users++ || cb_info->task != NULL) {
 321                 nfs_callback_bc_serv(minorversion, xprt, cb_info);
 322                 goto out;
 323         }
 324
 325         ret = nfs_callback_up_net(minorversion, serv, net);
 326         if (ret < 0)
 327                 goto err_net;
 328
 329         minorversion_setup =  nfs_minorversion_callback_svc_setup(minorversion,
 330                                         serv, xprt, &rqstp, &callback_svc);
 331         if (!minorversion_setup) {
 332                 /* v4.0 callback setup */
 333                 rqstp = nfs4_callback_up(serv, xprt);
 334                 callback_svc = nfs4_callback_svc;
 335         }
 336
 337         if (IS_ERR(rqstp)) {
 338                 ret = PTR_ERR(rqstp);
 339                 goto out_err;
 340         }
 341
 342         svc_sock_update_bufs(serv);
 343
 344         sprintf(svc_name, "nfsv4.%u-svc", minorversion);
 345         cb_info->serv = serv;
 346         cb_info->rqst = rqstp;
 347         cb_info->task = kthread_run(callback_svc, cb_info->rqst, svc_name);
 348         if (IS_ERR(cb_info->task)) {
 349                 ret = PTR_ERR(cb_info->task);
 350                 svc_exit_thread(cb_info->rqst);
 351                 cb_info->rqst = NULL;
 352                 cb_info->task = NULL;
 353                 goto out_err;
 354         }
 355 out:
 356         /*
 357          * svc_create creates the svc_serv with sv_nrthreads == 1, and then
 358          * svc_prepare_thread increments that. So we need to call svc_destroy
 359          * on both success and failure so that the refcount is 1 when the
 360          * thread exits.
 361          */
 362         svc_destroy(serv);
 363 err_create:
 364         mutex_unlock(&nfs_callback_mutex);
 365         return ret;
 366 out_err:
 367         svc_shutdown_net(serv, net);
 368 err_net:
 369         dprintk("NFS: Couldn't create callback socket or server thread; "
 370                 "err = %d\n", ret);
 371         cb_info->users--;
 372         goto out;
 373 }
 374
 375 /*
 376  * Kill the callback thread if it's no longer being used.
 377  */
 378 void nfs_callback_down(int minorversion, struct net *net)
 379 {
 380         struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
 381
 382         mutex_lock(&nfs_callback_mutex);
 383         cb_info->users--;
 384         if (cb_info->users == 0 && cb_info->task != NULL) {
 385                 kthread_stop(cb_info->task);
 386                 svc_shutdown_net(cb_info->serv, net);
 387                 svc_exit_thread(cb_info->rqst);
 388                 cb_info->serv = NULL;
 389                 cb_info->rqst = NULL;
 390                 cb_info->task = NULL;
 391         }
 392         mutex_unlock(&nfs_callback_mutex);
 393 }
 394
 395 /* Boolean check of RPC_AUTH_GSS principal */
 396 int
 397 check_gss_callback_principal(struct nfs_client *clp, struct svc_rqst *rqstp)
 398 {
 399         char *p = rqstp->rq_cred.cr_principal;
 400
 401         if (rqstp->rq_authop->flavour != RPC_AUTH_GSS)
 402                 return 1;
 403
 404         /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
 405         if (clp->cl_minorversion != 0)
 406                 return 0;
 407         /*
 408          * It might just be a normal user principal, in which case
 409          * userspace won't bother to tell us the name at all.
 410          */
 411         if (p == NULL)
 412                 return 0;
 413
 414         /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
 415
 416         if (memcmp(p, "nfs@", 4) != 0)
 417                 return 0;
 418         p += 4;
 419         if (strcmp(p, clp->cl_hostname) != 0)
 420                 return 0;
 421         return 1;
 422 }
 423
 424 /*
 425  * pg_authenticate method for nfsv4 callback threads.
 426  *
 427  * The authflavor has been negotiated, so an incorrect flavor is a server
 428  * bug. Drop packets with incorrect authflavor.
 429  *
 430  * All other checking done after NFS decoding where the nfs_client can be
 431  * found in nfs4_callback_compound
 432  */
 433 static int nfs_callback_authenticate(struct svc_rqst *rqstp)
 434 {
 435         switch (rqstp->rq_authop->flavour) {
 436         case RPC_AUTH_NULL:
 437                 if (rqstp->rq_proc != CB_NULL)
 438                         return SVC_DROP;
 439                 break;
 440         case RPC_AUTH_GSS:
 441                 /* No RPC_AUTH_GSS support yet in NFSv4.1 */
 442                  if (svc_is_backchannel(rqstp))
 443                         return SVC_DROP;
 444         }
 445         return SVC_OK;
 446 }
 447
 448 /*
 449  * Define NFS4 callback program
 450  */
 451 static struct svc_version *nfs4_callback_version[] = {
 452         [1] = &nfs4_callback_version1,
 453         [4] = &nfs4_callback_version4,
 454 };
 455
 456 static struct svc_stat nfs4_callback_stats;
 457
 458 static struct svc_program nfs4_callback_program = {
 459         .pg_prog = NFS4_CALLBACK,                       /* RPC service number */
 460         .pg_nvers = ARRAY_SIZE(nfs4_callback_version),  /* Number of entries */
 461         .pg_vers = nfs4_callback_version,               /* version table */
 462         .pg_name = "NFSv4 callback",                    /* service name */
 463         .pg_class = "nfs",                              /* authentication class */
 464         .pg_stats = &nfs4_callback_stats,
 465         .pg_authenticate = nfs_callback_authenticate,
 466 };