err.no Git - 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
  29 #include <linux/sunrpc/types.h>
  30 #include <linux/sunrpc/stats.h>
  31 #include <linux/sunrpc/clnt.h>
  32 #include <linux/sunrpc/svc.h>
  33 #include <linux/sunrpc/svcsock.h>
  34 #include <net/ip.h>
  35 #include <linux/lockd/lockd.h>
  36 #include <linux/nfs.h>
  37
  38 #define NLMDBG_FACILITY         NLMDBG_SVC
  39 #define LOCKD_BUFSIZE           (1024 + NLMSVC_XDRSIZE)
  40 #define ALLOWED_SIGS            (sigmask(SIGKILL))
  41
  42 static struct svc_program       nlmsvc_program;
  43
  44 struct nlmsvc_binding *         nlmsvc_ops;
  45 EXPORT_SYMBOL(nlmsvc_ops);
  46
  47 static DEFINE_MUTEX(nlmsvc_mutex);
  48 static unsigned int             nlmsvc_users;
  49 static pid_t                    nlmsvc_pid;
  50 static struct svc_serv          *nlmsvc_serv;
  51 int                             nlmsvc_grace_period;
  52 unsigned long                   nlmsvc_timeout;
  53
  54 static DECLARE_COMPLETION(lockd_start_done);
  55 static DECLARE_WAIT_QUEUE_HEAD(lockd_exit);
  56
  57 /*
  58  * These can be set at insmod time (useful for NFS as root filesystem),
  59  * and also changed through the sysctl interface.  -- Jamie Lokier, Aug 2003
  60  */
  61 static unsigned long            nlm_grace_period;
  62 static unsigned long            nlm_timeout = LOCKD_DFLT_TIMEO;
  63 static int                      nlm_udpport, nlm_tcpport;
  64 int                             nsm_use_hostnames = 0;
  65
  66 /*
  67  * Constants needed for the sysctl interface.
  68  */
  69 static const unsigned long      nlm_grace_period_min = 0;
  70 static const unsigned long      nlm_grace_period_max = 240;
  71 static const unsigned long      nlm_timeout_min = 3;
  72 static const unsigned long      nlm_timeout_max = 20;
  73 static const int                nlm_port_min = 0, nlm_port_max = 65535;
  74
  75 static struct ctl_table_header * nlm_sysctl_table;
  76
  77 static unsigned long set_grace_period(void)
  78 {
  79         unsigned long grace_period;
  80
  81         /* Note: nlm_timeout should always be nonzero */
  82         if (nlm_grace_period)
  83                 grace_period = ((nlm_grace_period + nlm_timeout - 1)
  84                                 / nlm_timeout) * nlm_timeout * HZ;
  85         else
  86                 grace_period = nlm_timeout * 5 * HZ;
  87         nlmsvc_grace_period = 1;
  88         return grace_period + jiffies;
  89 }
  90
  91 static inline void clear_grace_period(void)
  92 {
  93         nlmsvc_grace_period = 0;
  94 }
  95
  96 /*
  97  * This is the lockd kernel thread
  98  */
  99 static void
 100 lockd(struct svc_rqst *rqstp)
 101 {
 102         int             err = 0;
 103         unsigned long grace_period_expire;
 104
 105         /* Lock module and set up kernel thread */
 106         /* lockd_up is waiting for us to startup, so will
 107          * be holding a reference to this module, so it
 108          * is safe to just claim another reference
 109          */
 110         __module_get(THIS_MODULE);
 111         lock_kernel();
 112
 113         /*
 114          * Let our maker know we're running.
 115          */
 116         nlmsvc_pid = current->pid;
 117         nlmsvc_serv = rqstp->rq_server;
 118         complete(&lockd_start_done);
 119
 120         daemonize("lockd");
 121
 122         /* Process request with signals blocked, but allow SIGKILL.  */
 123         allow_signal(SIGKILL);
 124
 125         /* kick rpciod */
 126         rpciod_up();
 127
 128         dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
 129
 130         if (!nlm_timeout)
 131                 nlm_timeout = LOCKD_DFLT_TIMEO;
 132         nlmsvc_timeout = nlm_timeout * HZ;
 133
 134         grace_period_expire = set_grace_period();
 135
 136         /*
 137          * The main request loop. We don't terminate until the last
 138          * NFS mount or NFS daemon has gone away, and we've been sent a
 139          * signal, or else another process has taken over our job.
 140          */
 141         while ((nlmsvc_users || !signalled()) && nlmsvc_pid == current->pid) {
 142                 long timeout = MAX_SCHEDULE_TIMEOUT;
 143
 144                 if (signalled()) {
 145                         flush_signals(current);
 146                         if (nlmsvc_ops) {
 147                                 nlmsvc_invalidate_all();
 148                                 grace_period_expire = set_grace_period();
 149                         }
 150                 }
 151
 152                 /*
 153                  * Retry any blocked locks that have been notified by
 154                  * the VFS. Don't do this during grace period.
 155                  * (Theoretically, there shouldn't even be blocked locks
 156                  * during grace period).
 157                  */
 158                 if (!nlmsvc_grace_period) {
 159                         timeout = nlmsvc_retry_blocked();
 160                 } else if (time_before(grace_period_expire, jiffies))
 161                         clear_grace_period();
 162
 163                 /*
 164                  * Find a socket with data available and call its
 165                  * recvfrom routine.
 166                  */
 167                 err = svc_recv(rqstp, timeout);
 168                 if (err == -EAGAIN || err == -EINTR)
 169                         continue;
 170                 if (err < 0) {
 171                         printk(KERN_WARNING
 172                                "lockd: terminating on error %d\n",
 173                                -err);
 174                         break;
 175                 }
 176
 177                 dprintk("lockd: request from %08x\n",
 178                         (unsigned)ntohl(rqstp->rq_addr.sin_addr.s_addr));
 179
 180                 svc_process(rqstp);
 181
 182         }
 183
 184         flush_signals(current);
 185
 186         /*
 187          * Check whether there's a new lockd process before
 188          * shutting down the hosts and clearing the slot.
 189          */
 190         if (!nlmsvc_pid || current->pid == nlmsvc_pid) {
 191                 if (nlmsvc_ops)
 192                         nlmsvc_invalidate_all();
 193                 nlm_shutdown_hosts();
 194                 nlmsvc_pid = 0;
 195                 nlmsvc_serv = NULL;
 196         } else
 197                 printk(KERN_DEBUG
 198                         "lockd: new process, skipping host shutdown\n");
 199         wake_up(&lockd_exit);
 200
 201         /* Exit the RPC thread */
 202         svc_exit_thread(rqstp);
 203
 204         /* release rpciod */
 205         rpciod_down();
 206
 207         /* Release module */
 208         unlock_kernel();
 209         module_put_and_exit(0);
 210 }
 211
 212
 213 static int find_socket(struct svc_serv *serv, int proto)
 214 {
 215         struct svc_sock *svsk;
 216         int found = 0;
 217         list_for_each_entry(svsk, &serv->sv_permsocks, sk_list)
 218                 if (svsk->sk_sk->sk_protocol == proto) {
 219                         found = 1;
 220                         break;
 221                 }
 222         return found;
 223 }
 224
 225 static int make_socks(struct svc_serv *serv, int proto)
 226 {
 227         /* Make any sockets that are needed but not present.
 228          * If nlm_udpport or nlm_tcpport were set as module
 229          * options, make those sockets unconditionally
 230          */
 231         static int              warned;
 232         int err = 0;
 233         if (proto == IPPROTO_UDP || nlm_udpport)
 234                 if (!find_socket(serv, IPPROTO_UDP))
 235                         err = svc_makesock(serv, IPPROTO_UDP, nlm_udpport);
 236         if (err == 0 && (proto == IPPROTO_TCP || nlm_tcpport))
 237                 if (!find_socket(serv, IPPROTO_TCP))
 238                         err= svc_makesock(serv, IPPROTO_TCP, nlm_tcpport);
 239         if (!err)
 240                 warned = 0;
 241         else if (warned++ == 0)
 242                 printk(KERN_WARNING
 243                        "lockd_up: makesock failed, error=%d\n", err);
 244         return err;
 245 }
 246
 247 /*
 248  * Bring up the lockd process if it's not already up.
 249  */
 250 int
 251 lockd_up(int proto) /* Maybe add a 'family' option when IPv6 is supported ?? */
 252 {
 253         struct svc_serv *       serv;
 254         int                     error = 0;
 255
 256         mutex_lock(&nlmsvc_mutex);
 257         /*
 258          * Check whether we're already up and running.
 259          */
 260         if (nlmsvc_pid) {
 261                 if (proto)
 262                         error = make_socks(nlmsvc_serv, proto);
 263                 goto out;
 264         }
 265
 266         /*
 267          * Sanity check: if there's no pid,
 268          * we should be the first user ...
 269          */
 270         if (nlmsvc_users)
 271                 printk(KERN_WARNING
 272                         "lockd_up: no pid, %d users??\n", nlmsvc_users);
 273
 274         error = -ENOMEM;
 275         serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
 276         if (!serv) {
 277                 printk(KERN_WARNING "lockd_up: create service failed\n");
 278                 goto out;
 279         }
 280
 281         if ((error = make_socks(serv, proto)) < 0)
 282                 goto destroy_and_out;
 283
 284         /*
 285          * Create the kernel thread and wait for it to start.
 286          */
 287         error = svc_create_thread(lockd, serv);
 288         if (error) {
 289                 printk(KERN_WARNING
 290                         "lockd_up: create thread failed, error=%d\n", error);
 291                 goto destroy_and_out;
 292         }
 293         wait_for_completion(&lockd_start_done);
 294
 295         /*
 296          * Note: svc_serv structures have an initial use count of 1,
 297          * so we exit through here on both success and failure.
 298          */
 299 destroy_and_out:
 300         svc_destroy(serv);
 301 out:
 302         if (!error)
 303                 nlmsvc_users++;
 304         mutex_unlock(&nlmsvc_mutex);
 305         return error;
 306 }
 307 EXPORT_SYMBOL(lockd_up);
 308
 309 /*
 310  * Decrement the user count and bring down lockd if we're the last.
 311  */
 312 void
 313 lockd_down(void)
 314 {
 315         static int warned;
 316
 317         mutex_lock(&nlmsvc_mutex);
 318         if (nlmsvc_users) {
 319                 if (--nlmsvc_users)
 320                         goto out;
 321         } else
 322                 printk(KERN_WARNING "lockd_down: no users! pid=%d\n", nlmsvc_pid);
 323
 324         if (!nlmsvc_pid) {
 325                 if (warned++ == 0)
 326                         printk(KERN_WARNING "lockd_down: no lockd running.\n");
 327                 goto out;
 328         }
 329         warned = 0;
 330
 331         kill_proc(nlmsvc_pid, SIGKILL, 1);
 332         /*
 333          * Wait for the lockd process to exit, but since we're holding
 334          * the lockd semaphore, we can't wait around forever ...
 335          */
 336         clear_thread_flag(TIF_SIGPENDING);
 337         interruptible_sleep_on_timeout(&lockd_exit, HZ);
 338         if (nlmsvc_pid) {
 339                 printk(KERN_WARNING
 340                         "lockd_down: lockd failed to exit, clearing pid\n");
 341                 nlmsvc_pid = 0;
 342         }
 343         spin_lock_irq(&current->sighand->siglock);
 344         recalc_sigpending();
 345         spin_unlock_irq(&current->sighand->siglock);
 346 out:
 347         mutex_unlock(&nlmsvc_mutex);
 348 }
 349 EXPORT_SYMBOL(lockd_down);
 350
 351 /*
 352  * Sysctl parameters (same as module parameters, different interface).
 353  */
 354
 355 /* Something that isn't CTL_ANY, CTL_NONE or a value that may clash. */
 356 #define CTL_UNNUMBERED          -2
 357
 358 static ctl_table nlm_sysctls[] = {
 359         {
 360                 .ctl_name       = CTL_UNNUMBERED,
 361                 .procname       = "nlm_grace_period",
 362                 .data           = &nlm_grace_period,
 363                 .maxlen         = sizeof(unsigned long),
 364                 .mode           = 0644,
 365                 .proc_handler   = &proc_doulongvec_minmax,
 366                 .extra1         = (unsigned long *) &nlm_grace_period_min,
 367                 .extra2         = (unsigned long *) &nlm_grace_period_max,
 368         },
 369         {
 370                 .ctl_name       = CTL_UNNUMBERED,
 371                 .procname       = "nlm_timeout",
 372                 .data           = &nlm_timeout,
 373                 .maxlen         = sizeof(unsigned long),
 374                 .mode           = 0644,
 375                 .proc_handler   = &proc_doulongvec_minmax,
 376                 .extra1         = (unsigned long *) &nlm_timeout_min,
 377                 .extra2         = (unsigned long *) &nlm_timeout_max,
 378         },
 379         {
 380                 .ctl_name       = CTL_UNNUMBERED,
 381                 .procname       = "nlm_udpport",
 382                 .data           = &nlm_udpport,
 383                 .maxlen         = sizeof(int),
 384                 .mode           = 0644,
 385                 .proc_handler   = &proc_dointvec_minmax,
 386                 .extra1         = (int *) &nlm_port_min,
 387                 .extra2         = (int *) &nlm_port_max,
 388         },
 389         {
 390                 .ctl_name       = CTL_UNNUMBERED,
 391                 .procname       = "nlm_tcpport",
 392                 .data           = &nlm_tcpport,
 393                 .maxlen         = sizeof(int),
 394                 .mode           = 0644,
 395                 .proc_handler   = &proc_dointvec_minmax,
 396                 .extra1         = (int *) &nlm_port_min,
 397                 .extra2         = (int *) &nlm_port_max,
 398         },
 399         {
 400                 .ctl_name       = CTL_UNNUMBERED,
 401                 .procname       = "nsm_use_hostnames",
 402                 .data           = &nsm_use_hostnames,
 403                 .maxlen         = sizeof(int),
 404                 .mode           = 0644,
 405                 .proc_handler   = &proc_dointvec,
 406         },
 407         { .ctl_name = 0 }
 408 };
 409
 410 static ctl_table nlm_sysctl_dir[] = {
 411         {
 412                 .ctl_name       = CTL_UNNUMBERED,
 413                 .procname       = "nfs",
 414                 .mode           = 0555,
 415                 .child          = nlm_sysctls,
 416         },
 417         { .ctl_name = 0 }
 418 };
 419
 420 static ctl_table nlm_sysctl_root[] = {
 421         {
 422                 .ctl_name       = CTL_FS,
 423                 .procname       = "fs",
 424                 .mode           = 0555,
 425                 .child          = nlm_sysctl_dir,
 426         },
 427         { .ctl_name = 0 }
 428 };
 429
 430 /*
 431  * Module (and driverfs) parameters.
 432  */
 433
 434 #define param_set_min_max(name, type, which_strtol, min, max)           \
 435 static int param_set_##name(const char *val, struct kernel_param *kp)   \
 436 {                                                                       \
 437         char *endp;                                                     \
 438         __typeof__(type) num = which_strtol(val, &endp, 0);             \
 439         if (endp == val || *endp || num < (min) || num > (max))         \
 440                 return -EINVAL;                                         \
 441         *((int *) kp->arg) = num;                                       \
 442         return 0;                                                       \
 443 }
 444
 445 static inline int is_callback(u32 proc)
 446 {
 447         return proc == NLMPROC_GRANTED
 448                 || proc == NLMPROC_GRANTED_MSG
 449                 || proc == NLMPROC_TEST_RES
 450                 || proc == NLMPROC_LOCK_RES
 451                 || proc == NLMPROC_CANCEL_RES
 452                 || proc == NLMPROC_UNLOCK_RES
 453                 || proc == NLMPROC_NSM_NOTIFY;
 454 }
 455
 456
 457 static int lockd_authenticate(struct svc_rqst *rqstp)
 458 {
 459         rqstp->rq_client = NULL;
 460         switch (rqstp->rq_authop->flavour) {
 461                 case RPC_AUTH_NULL:
 462                 case RPC_AUTH_UNIX:
 463                         if (rqstp->rq_proc == 0)
 464                                 return SVC_OK;
 465                         if (is_callback(rqstp->rq_proc)) {
 466                                 /* Leave it to individual procedures to
 467                                  * call nlmsvc_lookup_host(rqstp)
 468                                  */
 469                                 return SVC_OK;
 470                         }
 471                         return svc_set_client(rqstp);
 472         }
 473         return SVC_DENIED;
 474 }
 475
 476
 477 param_set_min_max(port, int, simple_strtol, 0, 65535)
 478 param_set_min_max(grace_period, unsigned long, simple_strtoul,
 479                   nlm_grace_period_min, nlm_grace_period_max)
 480 param_set_min_max(timeout, unsigned long, simple_strtoul,
 481                   nlm_timeout_min, nlm_timeout_max)
 482
 483 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
 484 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
 485 MODULE_LICENSE("GPL");
 486
 487 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
 488                   &nlm_grace_period, 0644);
 489 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
 490                   &nlm_timeout, 0644);
 491 module_param_call(nlm_udpport, param_set_port, param_get_int,
 492                   &nlm_udpport, 0644);
 493 module_param_call(nlm_tcpport, param_set_port, param_get_int,
 494                   &nlm_tcpport, 0644);
 495 module_param(nsm_use_hostnames, bool, 0644);
 496
 497 /*
 498  * Initialising and terminating the module.
 499  */
 500
 501 static int __init init_nlm(void)
 502 {
 503         nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root, 0);
 504         return nlm_sysctl_table ? 0 : -ENOMEM;
 505 }
 506
 507 static void __exit exit_nlm(void)
 508 {
 509         /* FIXME: delete all NLM clients */
 510         nlm_shutdown_hosts();
 511         unregister_sysctl_table(nlm_sysctl_table);
 512 }
 513
 514 module_init(init_nlm);
 515 module_exit(exit_nlm);
 516
 517 /*
 518  * Define NLM program and procedures
 519  */
 520 static struct svc_version       nlmsvc_version1 = {
 521                 .vs_vers        = 1,
 522                 .vs_nproc       = 17,
 523                 .vs_proc        = nlmsvc_procedures,
 524                 .vs_xdrsize     = NLMSVC_XDRSIZE,
 525 };
 526 static struct svc_version       nlmsvc_version3 = {
 527                 .vs_vers        = 3,
 528                 .vs_nproc       = 24,
 529                 .vs_proc        = nlmsvc_procedures,
 530                 .vs_xdrsize     = NLMSVC_XDRSIZE,
 531 };
 532 #ifdef CONFIG_LOCKD_V4
 533 static struct svc_version       nlmsvc_version4 = {
 534                 .vs_vers        = 4,
 535                 .vs_nproc       = 24,
 536                 .vs_proc        = nlmsvc_procedures4,
 537                 .vs_xdrsize     = NLMSVC_XDRSIZE,
 538 };
 539 #endif
 540 static struct svc_version *     nlmsvc_version[] = {
 541         [1] = &nlmsvc_version1,
 542         [3] = &nlmsvc_version3,
 543 #ifdef CONFIG_LOCKD_V4
 544         [4] = &nlmsvc_version4,
 545 #endif
 546 };
 547
 548 static struct svc_stat          nlmsvc_stats;
 549
 550 #define NLM_NRVERS      ARRAY_SIZE(nlmsvc_version)
 551 static struct svc_program       nlmsvc_program = {
 552         .pg_prog                = NLM_PROGRAM,          /* program number */
 553         .pg_nvers               = NLM_NRVERS,           /* number of entries in nlmsvc_version */
 554         .pg_vers                = nlmsvc_version,       /* version table */
 555         .pg_name                = "lockd",              /* service name */
 556         .pg_class               = "nfsd",               /* share authentication with nfsd */
 557         .pg_stats               = &nlmsvc_stats,        /* stats table */
 558         .pg_authenticate = &lockd_authenticate  /* export authentication */
 559 };