fs/lockd/svc.c

   1 /*
   2  * linux/fs/lockd/svc.c
   3  *
   4  * This is the central lockd service.
   5  *
   6  * FIXME: Separate the lockd NFS server functionality from the lockd NFS
   7  *        client functionality. Oh why didn't Sun create two separate
   8  *        services in the first place?
   9  *
  10  * Authors:     Olaf Kirch (okir@monad.swb.de)
  11  *
  12  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/init.h>
  17 #include <linux/sysctl.h>
  18 #include <linux/moduleparam.h>
  19
  20 #include <linux/sched.h>
  21 #include <linux/errno.h>
  22 #include <linux/in.h>
  23 #include <linux/uio.h>
  24 #include <linux/slab.h>
  25 #include <linux/smp.h>
  26 #include <linux/smp_lock.h>
  27 #include <linux/mutex.h>
  28 #include <linux/kthread.h>
  29 #include <linux/freezer.h>
  30
  31 #include <linux/sunrpc/types.h>
  32 #include <linux/sunrpc/stats.h>
  33 #include <linux/sunrpc/clnt.h>
  34 #include <linux/sunrpc/svc.h>
  35 #include <linux/sunrpc/svcsock.h>
  36 #include <net/ip.h>
  37 #include <linux/lockd/lockd.h>
  38 #include <linux/nfs.h>
  39
  40 #define NLMDBG_FACILITY         NLMDBG_SVC
  41 #define LOCKD_BUFSIZE           (1024 + NLMSVC_XDRSIZE)
  42 #define ALLOWED_SIGS            (sigmask(SIGKILL))
  43
  44 static struct svc_program       nlmsvc_program;
  45
  46 struct nlmsvc_binding *         nlmsvc_ops;
  47 EXPORT_SYMBOL_GPL(nlmsvc_ops);
  48
  49 static DEFINE_MUTEX(nlmsvc_mutex);
  50 static unsigned int             nlmsvc_users;
  51 static struct task_struct       *nlmsvc_task;
  52 static struct svc_rqst          *nlmsvc_rqst;
  53 unsigned long                   nlmsvc_timeout;
  54
  55 /*
  56  * If the kernel has IPv6 support available, always listen for
  57  * both AF_INET and AF_INET6 requests.
  58  */
  59 #if (defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)) && \
  60         defined(CONFIG_SUNRPC_REGISTER_V4)
  61 static const sa_family_t        nlmsvc_family = AF_INET6;
  62 #else   /* (CONFIG_IPV6 || CONFIG_IPV6_MODULE) && CONFIG_SUNRPC_REGISTER_V4 */
  63 static const sa_family_t        nlmsvc_family = AF_INET;
  64 #endif  /* (CONFIG_IPV6 || CONFIG_IPV6_MODULE) && CONFIG_SUNRPC_REGISTER_V4 */
  65
  66 /*
  67  * These can be set at insmod time (useful for NFS as root filesystem),
  68  * and also changed through the sysctl interface.  -- Jamie Lokier, Aug 2003
  69  */
  70 static unsigned long            nlm_grace_period;
  71 static unsigned long            nlm_timeout = LOCKD_DFLT_TIMEO;
  72 static int                      nlm_udpport, nlm_tcpport;
  73
  74 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
  75 static unsigned int             nlm_max_connections = 1024;
  76
  77 /*
  78  * Constants needed for the sysctl interface.
  79  */
  80 static const unsigned long      nlm_grace_period_min = 0;
  81 static const unsigned long      nlm_grace_period_max = 240;
  82 static const unsigned long      nlm_timeout_min = 3;
  83 static const unsigned long      nlm_timeout_max = 20;
  84 static const int                nlm_port_min = 0, nlm_port_max = 65535;
  85
  86 #ifdef CONFIG_SYSCTL
  87 static struct ctl_table_header * nlm_sysctl_table;
  88 #endif
  89
  90 static unsigned long get_lockd_grace_period(void)
  91 {
  92         /* Note: nlm_timeout should always be nonzero */
  93         if (nlm_grace_period)
  94                 return roundup(nlm_grace_period, nlm_timeout) * HZ;
  95         else
  96                 return nlm_timeout * 5 * HZ;
  97 }
  98
  99 static struct lock_manager lockd_manager = {
 100 };
 101
 102 static void grace_ender(struct work_struct *not_used)
 103 {
 104         locks_end_grace(&lockd_manager);
 105 }
 106
 107 static DECLARE_DELAYED_WORK(grace_period_end, grace_ender);
 108
 109 static void set_grace_period(void)
 110 {
 111         unsigned long grace_period = get_lockd_grace_period();
 112
 113         locks_start_grace(&lockd_manager);
 114         cancel_delayed_work_sync(&grace_period_end);
 115         schedule_delayed_work(&grace_period_end, grace_period);
 116 }
 117
 118 /*
 119  * This is the lockd kernel thread
 120  */
 121 static int
 122 lockd(void *vrqstp)
 123 {
 124         int             err = 0, preverr = 0;
 125         struct svc_rqst *rqstp = vrqstp;
 126
 127         /* try_to_freeze() is called from svc_recv() */
 128         set_freezable();
 129
 130         /* Allow SIGKILL to tell lockd to drop all of its locks */
 131         allow_signal(SIGKILL);
 132
 133         dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
 134
 135         /*
 136          * FIXME: it would be nice if lockd didn't spend its entire life
 137          * running under the BKL. At the very least, it would be good to
 138          * have someone clarify what it's intended to protect here. I've
 139          * seen some handwavy posts about posix locking needing to be
 140          * done under the BKL, but it's far from clear.
 141          */
 142         lock_kernel();
 143
 144         if (!nlm_timeout)
 145                 nlm_timeout = LOCKD_DFLT_TIMEO;
 146         nlmsvc_timeout = nlm_timeout * HZ;
 147
 148         set_grace_period();
 149
 150         /*
 151          * The main request loop. We don't terminate until the last
 152          * NFS mount or NFS daemon has gone away.
 153          */
 154         while (!kthread_should_stop()) {
 155                 long timeout = MAX_SCHEDULE_TIMEOUT;
 156                 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
 157
 158                 /* update sv_maxconn if it has changed */
 159                 rqstp->rq_server->sv_maxconn = nlm_max_connections;
 160
 161                 if (signalled()) {
 162                         flush_signals(current);
 163                         if (nlmsvc_ops) {
 164                                 nlmsvc_invalidate_all();
 165                                 set_grace_period();
 166                         }
 167                         continue;
 168                 }
 169
 170                 timeout = nlmsvc_retry_blocked();
 171
 172                 /*
 173                  * Find a socket with data available and call its
 174                  * recvfrom routine.
 175                  */
 176                 err = svc_recv(rqstp, timeout);
 177                 if (err == -EAGAIN || err == -EINTR) {
 178                         preverr = err;
 179                         continue;
 180                 }
 181                 if (err < 0) {
 182                         if (err != preverr) {
 183                                 printk(KERN_WARNING "%s: unexpected error "
 184                                         "from svc_recv (%d)\n", __func__, err);
 185                                 preverr = err;
 186                         }
 187                         schedule_timeout_interruptible(HZ);
 188                         continue;
 189                 }
 190                 preverr = err;
 191
 192                 dprintk("lockd: request from %s\n",
 193                                 svc_print_addr(rqstp, buf, sizeof(buf)));
 194
 195                 svc_process(rqstp);
 196         }
 197         flush_signals(current);
 198         cancel_delayed_work_sync(&grace_period_end);
 199         locks_end_grace(&lockd_manager);
 200         if (nlmsvc_ops)
 201                 nlmsvc_invalidate_all();
 202         nlm_shutdown_hosts();
 203         unlock_kernel();
 204         return 0;
 205 }
 206
 207 static int create_lockd_listener(struct svc_serv *serv, char *name,
 208                                  unsigned short port)
 209 {
 210         struct svc_xprt *xprt;
 211
 212         xprt = svc_find_xprt(serv, name, 0, 0);
 213         if (xprt == NULL)
 214                 return svc_create_xprt(serv, name, nlmsvc_family,
 215                                         port, SVC_SOCK_DEFAULTS);
 216
 217         svc_xprt_put(xprt);
 218         return 0;
 219 }
 220
 221 /*
 222  * Ensure there are active UDP and TCP listeners for lockd.
 223  *
 224  * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
 225  * local services (such as rpc.statd) still require UDP, and
 226  * some NFS servers do not yet support NLM over TCP.
 227  *
 228  * Returns zero if all listeners are available; otherwise a
 229  * negative errno value is returned.
 230  */
 231 static int make_socks(struct svc_serv *serv)
 232 {
 233         static int warned;
 234         int err;
 235
 236         err = create_lockd_listener(serv, "udp", nlm_udpport);
 237         if (err < 0)
 238                 goto out_err;
 239
 240         err = create_lockd_listener(serv, "tcp", nlm_tcpport);
 241         if (err < 0)
 242                 goto out_err;
 243
 244         warned = 0;
 245         return 0;
 246
 247 out_err:
 248         if (warned++ == 0)
 249                 printk(KERN_WARNING
 250                         "lockd_up: makesock failed, error=%d\n", err);
 251         return err;
 252 }
 253
 254 /*
 255  * Bring up the lockd process if it's not already up.
 256  */
 257 int lockd_up(void)
 258 {
 259         struct svc_serv *serv;
 260         int             error = 0;
 261
 262         mutex_lock(&nlmsvc_mutex);
 263         /*
 264          * Check whether we're already up and running.
 265          */
 266         if (nlmsvc_rqst)
 267                 goto out;
 268
 269         /*
 270          * Sanity check: if there's no pid,
 271          * we should be the first user ...
 272          */
 273         if (nlmsvc_users)
 274                 printk(KERN_WARNING
 275                         "lockd_up: no pid, %d users??\n", nlmsvc_users);
 276
 277         error = -ENOMEM;
 278         serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
 279         if (!serv) {
 280                 printk(KERN_WARNING "lockd_up: create service failed\n");
 281                 goto out;
 282         }
 283
 284         error = make_socks(serv);
 285         if (error < 0)
 286                 goto destroy_and_out;
 287
 288         /*
 289          * Create the kernel thread and wait for it to start.
 290          */
 291         nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0]);
 292         if (IS_ERR(nlmsvc_rqst)) {
 293                 error = PTR_ERR(nlmsvc_rqst);
 294                 nlmsvc_rqst = NULL;
 295                 printk(KERN_WARNING
 296                         "lockd_up: svc_rqst allocation failed, error=%d\n",
 297                         error);
 298                 goto destroy_and_out;
 299         }
 300
 301         svc_sock_update_bufs(serv);
 302         serv->sv_maxconn = nlm_max_connections;
 303
 304         nlmsvc_task = kthread_run(lockd, nlmsvc_rqst, serv->sv_name);
 305         if (IS_ERR(nlmsvc_task)) {
 306                 error = PTR_ERR(nlmsvc_task);
 307                 svc_exit_thread(nlmsvc_rqst);
 308                 nlmsvc_task = NULL;
 309                 nlmsvc_rqst = NULL;
 310                 printk(KERN_WARNING
 311                         "lockd_up: kthread_run failed, error=%d\n", error);
 312                 goto destroy_and_out;
 313         }
 314
 315         /*
 316          * Note: svc_serv structures have an initial use count of 1,
 317          * so we exit through here on both success and failure.
 318          */
 319 destroy_and_out:
 320         svc_destroy(serv);
 321 out:
 322         if (!error)
 323                 nlmsvc_users++;
 324         mutex_unlock(&nlmsvc_mutex);
 325         return error;
 326 }
 327 EXPORT_SYMBOL_GPL(lockd_up);
 328
 329 /*
 330  * Decrement the user count and bring down lockd if we're the last.
 331  */
 332 void
 333 lockd_down(void)
 334 {
 335         mutex_lock(&nlmsvc_mutex);
 336         if (nlmsvc_users) {
 337                 if (--nlmsvc_users)
 338                         goto out;
 339         } else {
 340                 printk(KERN_ERR "lockd_down: no users! task=%p\n",
 341                         nlmsvc_task);
 342                 BUG();
 343         }
 344
 345         if (!nlmsvc_task) {
 346                 printk(KERN_ERR "lockd_down: no lockd running.\n");
 347                 BUG();
 348         }
 349         kthread_stop(nlmsvc_task);
 350         svc_exit_thread(nlmsvc_rqst);
 351         nlmsvc_task = NULL;
 352         nlmsvc_rqst = NULL;
 353 out:
 354         mutex_unlock(&nlmsvc_mutex);
 355 }
 356 EXPORT_SYMBOL_GPL(lockd_down);
 357
 358 #ifdef CONFIG_SYSCTL
 359
 360 /*
 361  * Sysctl parameters (same as module parameters, different interface).
 362  */
 363
 364 static ctl_table nlm_sysctls[] = {
 365         {
 366                 .ctl_name       = CTL_UNNUMBERED,
 367                 .procname       = "nlm_grace_period",
 368                 .data           = &nlm_grace_period,
 369                 .maxlen         = sizeof(unsigned long),
 370                 .mode           = 0644,
 371                 .proc_handler   = &proc_doulongvec_minmax,
 372                 .extra1         = (unsigned long *) &nlm_grace_period_min,
 373                 .extra2         = (unsigned long *) &nlm_grace_period_max,
 374         },
 375         {
 376                 .ctl_name       = CTL_UNNUMBERED,
 377                 .procname       = "nlm_timeout",
 378                 .data           = &nlm_timeout,
 379                 .maxlen         = sizeof(unsigned long),
 380                 .mode           = 0644,
 381                 .proc_handler   = &proc_doulongvec_minmax,
 382                 .extra1         = (unsigned long *) &nlm_timeout_min,
 383                 .extra2         = (unsigned long *) &nlm_timeout_max,
 384         },
 385         {
 386                 .ctl_name       = CTL_UNNUMBERED,
 387                 .procname       = "nlm_udpport",
 388                 .data           = &nlm_udpport,
 389                 .maxlen         = sizeof(int),
 390                 .mode           = 0644,
 391                 .proc_handler   = &proc_dointvec_minmax,
 392                 .extra1         = (int *) &nlm_port_min,
 393                 .extra2         = (int *) &nlm_port_max,
 394         },
 395         {
 396                 .ctl_name       = CTL_UNNUMBERED,
 397                 .procname       = "nlm_tcpport",
 398                 .data           = &nlm_tcpport,
 399                 .maxlen         = sizeof(int),
 400                 .mode           = 0644,
 401                 .proc_handler   = &proc_dointvec_minmax,
 402                 .extra1         = (int *) &nlm_port_min,
 403                 .extra2         = (int *) &nlm_port_max,
 404         },
 405         {
 406                 .ctl_name       = CTL_UNNUMBERED,
 407                 .procname       = "nsm_use_hostnames",
 408                 .data           = &nsm_use_hostnames,
 409                 .maxlen         = sizeof(int),
 410                 .mode           = 0644,
 411                 .proc_handler   = &proc_dointvec,
 412         },
 413         {
 414                 .ctl_name       = CTL_UNNUMBERED,
 415                 .procname       = "nsm_local_state",
 416                 .data           = &nsm_local_state,
 417                 .maxlen         = sizeof(int),
 418                 .mode           = 0644,
 419                 .proc_handler   = &proc_dointvec,
 420         },
 421         { .ctl_name = 0 }
 422 };
 423
 424 static ctl_table nlm_sysctl_dir[] = {
 425         {
 426                 .ctl_name       = CTL_UNNUMBERED,
 427                 .procname       = "nfs",
 428                 .mode           = 0555,
 429                 .child          = nlm_sysctls,
 430         },
 431         { .ctl_name = 0 }
 432 };
 433
 434 static ctl_table nlm_sysctl_root[] = {
 435         {
 436                 .ctl_name       = CTL_FS,
 437                 .procname       = "fs",
 438                 .mode           = 0555,
 439                 .child          = nlm_sysctl_dir,
 440         },
 441         { .ctl_name = 0 }
 442 };
 443
 444 #endif  /* CONFIG_SYSCTL */
 445
 446 /*
 447  * Module (and sysfs) parameters.
 448  */
 449
 450 #define param_set_min_max(name, type, which_strtol, min, max)           \
 451 static int param_set_##name(const char *val, struct kernel_param *kp)   \
 452 {                                                                       \
 453         char *endp;                                                     \
 454         __typeof__(type) num = which_strtol(val, &endp, 0);             \
 455         if (endp == val || *endp || num < (min) || num > (max))         \
 456                 return -EINVAL;                                         \
 457         *((int *) kp->arg) = num;                                       \
 458         return 0;                                                       \
 459 }
 460
 461 static inline int is_callback(u32 proc)
 462 {
 463         return proc == NLMPROC_GRANTED
 464                 || proc == NLMPROC_GRANTED_MSG
 465                 || proc == NLMPROC_TEST_RES
 466                 || proc == NLMPROC_LOCK_RES
 467                 || proc == NLMPROC_CANCEL_RES
 468                 || proc == NLMPROC_UNLOCK_RES
 469                 || proc == NLMPROC_NSM_NOTIFY;
 470 }
 471
 472
 473 static int lockd_authenticate(struct svc_rqst *rqstp)
 474 {
 475         rqstp->rq_client = NULL;
 476         switch (rqstp->rq_authop->flavour) {
 477                 case RPC_AUTH_NULL:
 478                 case RPC_AUTH_UNIX:
 479                         if (rqstp->rq_proc == 0)
 480                                 return SVC_OK;
 481                         if (is_callback(rqstp->rq_proc)) {
 482                                 /* Leave it to individual procedures to
 483                                  * call nlmsvc_lookup_host(rqstp)
 484                                  */
 485                                 return SVC_OK;
 486                         }
 487                         return svc_set_client(rqstp);
 488         }
 489         return SVC_DENIED;
 490 }
 491
 492
 493 param_set_min_max(port, int, simple_strtol, 0, 65535)
 494 param_set_min_max(grace_period, unsigned long, simple_strtoul,
 495                   nlm_grace_period_min, nlm_grace_period_max)
 496 param_set_min_max(timeout, unsigned long, simple_strtoul,
 497                   nlm_timeout_min, nlm_timeout_max)
 498
 499 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
 500 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
 501 MODULE_LICENSE("GPL");
 502
 503 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
 504                   &nlm_grace_period, 0644);
 505 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
 506                   &nlm_timeout, 0644);
 507 module_param_call(nlm_udpport, param_set_port, param_get_int,
 508                   &nlm_udpport, 0644);
 509 module_param_call(nlm_tcpport, param_set_port, param_get_int,
 510                   &nlm_tcpport, 0644);
 511 module_param(nsm_use_hostnames, bool, 0644);
 512 module_param(nlm_max_connections, uint, 0644);
 513
 514 /*
 515  * Initialising and terminating the module.
 516  */
 517
 518 static int __init init_nlm(void)
 519 {
 520 #ifdef CONFIG_SYSCTL
 521         nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
 522         return nlm_sysctl_table ? 0 : -ENOMEM;
 523 #else
 524         return 0;
 525 #endif
 526 }
 527
 528 static void __exit exit_nlm(void)
 529 {
 530         /* FIXME: delete all NLM clients */
 531         nlm_shutdown_hosts();
 532 #ifdef CONFIG_SYSCTL
 533         unregister_sysctl_table(nlm_sysctl_table);
 534 #endif
 535 }
 536
 537 module_init(init_nlm);
 538 module_exit(exit_nlm);
 539
 540 /*
 541  * Define NLM program and procedures
 542  */
 543 static struct svc_version       nlmsvc_version1 = {
 544                 .vs_vers        = 1,
 545                 .vs_nproc       = 17,
 546                 .vs_proc        = nlmsvc_procedures,
 547                 .vs_xdrsize     = NLMSVC_XDRSIZE,
 548 };
 549 static struct svc_version       nlmsvc_version3 = {
 550                 .vs_vers        = 3,
 551                 .vs_nproc       = 24,
 552                 .vs_proc        = nlmsvc_procedures,
 553                 .vs_xdrsize     = NLMSVC_XDRSIZE,
 554 };
 555 #ifdef CONFIG_LOCKD_V4
 556 static struct svc_version       nlmsvc_version4 = {
 557                 .vs_vers        = 4,
 558                 .vs_nproc       = 24,
 559                 .vs_proc        = nlmsvc_procedures4,
 560                 .vs_xdrsize     = NLMSVC_XDRSIZE,
 561 };
 562 #endif
 563 static struct svc_version *     nlmsvc_version[] = {
 564         [1] = &nlmsvc_version1,
 565         [3] = &nlmsvc_version3,
 566 #ifdef CONFIG_LOCKD_V4
 567         [4] = &nlmsvc_version4,
 568 #endif
 569 };
 570
 571 static struct svc_stat          nlmsvc_stats;
 572
 573 #define NLM_NRVERS      ARRAY_SIZE(nlmsvc_version)
 574 static struct svc_program       nlmsvc_program = {
 575         .pg_prog                = NLM_PROGRAM,          /* program number */
 576         .pg_nvers               = NLM_NRVERS,           /* number of entries in nlmsvc_version */
 577         .pg_vers                = nlmsvc_version,       /* version table */
 578         .pg_name                = "lockd",              /* service name */
 579         .pg_class               = "nfsd",               /* share authentication with nfsd */
 580         .pg_stats               = &nlmsvc_stats,        /* stats table */
 581         .pg_authenticate = &lockd_authenticate  /* export authentication */
 582 };