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