fs/nfsd/nfssvc.c

   1 /*
   2  * linux/fs/nfsd/nfssvc.c
   3  *
   4  * Central processing for nfsd.
   5  *
   6  * Authors:     Olaf Kirch (okir@monad.swb.de)
   7  *
   8  * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
   9  */
  10
  11 #include <linux/module.h>
  12 #include <linux/sched.h>
  13 #include <linux/time.h>
  14 #include <linux/errno.h>
  15 #include <linux/nfs.h>
  16 #include <linux/in.h>
  17 #include <linux/uio.h>
  18 #include <linux/unistd.h>
  19 #include <linux/slab.h>
  20 #include <linux/smp.h>
  21 #include <linux/smp_lock.h>
  22 #include <linux/freezer.h>
  23 #include <linux/fs_struct.h>
  24 #include <linux/kthread.h>
  25
  26 #include <linux/sunrpc/types.h>
  27 #include <linux/sunrpc/stats.h>
  28 #include <linux/sunrpc/svc.h>
  29 #include <linux/sunrpc/svcsock.h>
  30 #include <linux/sunrpc/cache.h>
  31 #include <linux/nfsd/nfsd.h>
  32 #include <linux/nfsd/stats.h>
  33 #include <linux/nfsd/cache.h>
  34 #include <linux/nfsd/syscall.h>
  35 #include <linux/lockd/bind.h>
  36 #include <linux/nfsacl.h>
  37
  38 #define NFSDDBG_FACILITY        NFSDDBG_SVC
  39
  40 extern struct svc_program       nfsd_program;
  41 static int                      nfsd(void *vrqstp);
  42 struct timeval                  nfssvc_boot;
  43 static atomic_t                 nfsd_busy;
  44 static unsigned long            nfsd_last_call;
  45 static DEFINE_SPINLOCK(nfsd_call_lock);
  46
  47 /*
  48  * nfsd_mutex protects nfsd_serv -- both the pointer itself and the members
  49  * of the svc_serv struct. In particular, ->sv_nrthreads but also to some
  50  * extent ->sv_temp_socks and ->sv_permsocks. It also protects nfsdstats.th_cnt
  51  *
  52  * If (out side the lock) nfsd_serv is non-NULL, then it must point to a
  53  * properly initialised 'struct svc_serv' with ->sv_nrthreads > 0. That number
  54  * of nfsd threads must exist and each must listed in ->sp_all_threads in each
  55  * entry of ->sv_pools[].
  56  *
  57  * Transitions of the thread count between zero and non-zero are of particular
  58  * interest since the svc_serv needs to be created and initialized at that
  59  * point, or freed.
  60  *
  61  * Finally, the nfsd_mutex also protects some of the global variables that are
  62  * accessed when nfsd starts and that are settable via the write_* routines in
  63  * nfsctl.c. In particular:
  64  *
  65  *      user_recovery_dirname
  66  *      user_lease_time
  67  *      nfsd_versions
  68  */
  69 DEFINE_MUTEX(nfsd_mutex);
  70 struct svc_serv                 *nfsd_serv;
  71
  72 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
  73 static struct svc_stat  nfsd_acl_svcstats;
  74 static struct svc_version *     nfsd_acl_version[] = {
  75         [2] = &nfsd_acl_version2,
  76         [3] = &nfsd_acl_version3,
  77 };
  78
  79 #define NFSD_ACL_MINVERS            2
  80 #define NFSD_ACL_NRVERS         ARRAY_SIZE(nfsd_acl_version)
  81 static struct svc_version *nfsd_acl_versions[NFSD_ACL_NRVERS];
  82
  83 static struct svc_program       nfsd_acl_program = {
  84         .pg_prog                = NFS_ACL_PROGRAM,
  85         .pg_nvers               = NFSD_ACL_NRVERS,
  86         .pg_vers                = nfsd_acl_versions,
  87         .pg_name                = "nfsacl",
  88         .pg_class               = "nfsd",
  89         .pg_stats               = &nfsd_acl_svcstats,
  90         .pg_authenticate        = &svc_set_client,
  91 };
  92
  93 static struct svc_stat  nfsd_acl_svcstats = {
  94         .program        = &nfsd_acl_program,
  95 };
  96 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
  97
  98 static struct svc_version *     nfsd_version[] = {
  99         [2] = &nfsd_version2,
 100 #if defined(CONFIG_NFSD_V3)
 101         [3] = &nfsd_version3,
 102 #endif
 103 #if defined(CONFIG_NFSD_V4)
 104         [4] = &nfsd_version4,
 105 #endif
 106 };
 107
 108 #define NFSD_MINVERS            2
 109 #define NFSD_NRVERS             ARRAY_SIZE(nfsd_version)
 110 static struct svc_version *nfsd_versions[NFSD_NRVERS];
 111
 112 struct svc_program              nfsd_program = {
 113 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
 114         .pg_next                = &nfsd_acl_program,
 115 #endif
 116         .pg_prog                = NFS_PROGRAM,          /* program number */
 117         .pg_nvers               = NFSD_NRVERS,          /* nr of entries in nfsd_version */
 118         .pg_vers                = nfsd_versions,        /* version table */
 119         .pg_name                = "nfsd",               /* program name */
 120         .pg_class               = "nfsd",               /* authentication class */
 121         .pg_stats               = &nfsd_svcstats,       /* version table */
 122         .pg_authenticate        = &svc_set_client,      /* export authentication */
 123
 124 };
 125
 126 int nfsd_vers(int vers, enum vers_op change)
 127 {
 128         if (vers < NFSD_MINVERS || vers >= NFSD_NRVERS)
 129                 return -1;
 130         switch(change) {
 131         case NFSD_SET:
 132                 nfsd_versions[vers] = nfsd_version[vers];
 133 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
 134                 if (vers < NFSD_ACL_NRVERS)
 135                         nfsd_acl_versions[vers] = nfsd_acl_version[vers];
 136 #endif
 137                 break;
 138         case NFSD_CLEAR:
 139                 nfsd_versions[vers] = NULL;
 140 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
 141                 if (vers < NFSD_ACL_NRVERS)
 142                         nfsd_acl_versions[vers] = NULL;
 143 #endif
 144                 break;
 145         case NFSD_TEST:
 146                 return nfsd_versions[vers] != NULL;
 147         case NFSD_AVAIL:
 148                 return nfsd_version[vers] != NULL;
 149         }
 150         return 0;
 151 }
 152 /*
 153  * Maximum number of nfsd processes
 154  */
 155 #define NFSD_MAXSERVS           8192
 156
 157 int nfsd_nrthreads(void)
 158 {
 159         int rv = 0;
 160         mutex_lock(&nfsd_mutex);
 161         if (nfsd_serv)
 162                 rv = nfsd_serv->sv_nrthreads;
 163         mutex_unlock(&nfsd_mutex);
 164         return rv;
 165 }
 166
 167 static void nfsd_last_thread(struct svc_serv *serv)
 168 {
 169         /* When last nfsd thread exits we need to do some clean-up */
 170         struct svc_xprt *xprt;
 171         list_for_each_entry(xprt, &serv->sv_permsocks, xpt_list)
 172                 lockd_down();
 173         nfsd_serv = NULL;
 174         nfsd_racache_shutdown();
 175         nfs4_state_shutdown();
 176
 177         printk(KERN_WARNING "nfsd: last server has exited, flushing export "
 178                             "cache\n");
 179         nfsd_export_flush();
 180 }
 181
 182 void nfsd_reset_versions(void)
 183 {
 184         int found_one = 0;
 185         int i;
 186
 187         for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++) {
 188                 if (nfsd_program.pg_vers[i])
 189                         found_one = 1;
 190         }
 191
 192         if (!found_one) {
 193                 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++)
 194                         nfsd_program.pg_vers[i] = nfsd_version[i];
 195 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
 196                 for (i = NFSD_ACL_MINVERS; i < NFSD_ACL_NRVERS; i++)
 197                         nfsd_acl_program.pg_vers[i] =
 198                                 nfsd_acl_version[i];
 199 #endif
 200         }
 201 }
 202
 203
 204 int nfsd_create_serv(void)
 205 {
 206         int err = 0;
 207
 208         WARN_ON(!mutex_is_locked(&nfsd_mutex));
 209         if (nfsd_serv) {
 210                 svc_get(nfsd_serv);
 211                 return 0;
 212         }
 213         if (nfsd_max_blksize == 0) {
 214                 /* choose a suitable default */
 215                 struct sysinfo i;
 216                 si_meminfo(&i);
 217                 /* Aim for 1/4096 of memory per thread
 218                  * This gives 1MB on 4Gig machines
 219                  * But only uses 32K on 128M machines.
 220                  * Bottom out at 8K on 32M and smaller.
 221                  * Of course, this is only a default.
 222                  */
 223                 nfsd_max_blksize = NFSSVC_MAXBLKSIZE;
 224                 i.totalram <<= PAGE_SHIFT - 12;
 225                 while (nfsd_max_blksize > i.totalram &&
 226                        nfsd_max_blksize >= 8*1024*2)
 227                         nfsd_max_blksize /= 2;
 228         }
 229
 230         atomic_set(&nfsd_busy, 0);
 231         nfsd_serv = svc_create_pooled(&nfsd_program, nfsd_max_blksize,
 232                                       nfsd_last_thread, nfsd, THIS_MODULE);
 233         if (nfsd_serv == NULL)
 234                 err = -ENOMEM;
 235
 236         do_gettimeofday(&nfssvc_boot);          /* record boot time */
 237         return err;
 238 }
 239
 240 static int nfsd_init_socks(int port)
 241 {
 242         int error;
 243         if (!list_empty(&nfsd_serv->sv_permsocks))
 244                 return 0;
 245
 246         error = svc_create_xprt(nfsd_serv, "udp", PF_INET, port,
 247                                         SVC_SOCK_DEFAULTS);
 248         if (error < 0)
 249                 return error;
 250
 251         error = lockd_up();
 252         if (error < 0)
 253                 return error;
 254
 255         error = svc_create_xprt(nfsd_serv, "tcp", PF_INET, port,
 256                                         SVC_SOCK_DEFAULTS);
 257         if (error < 0)
 258                 return error;
 259
 260         error = lockd_up();
 261         if (error < 0)
 262                 return error;
 263
 264         return 0;
 265 }
 266
 267 int nfsd_nrpools(void)
 268 {
 269         if (nfsd_serv == NULL)
 270                 return 0;
 271         else
 272                 return nfsd_serv->sv_nrpools;
 273 }
 274
 275 int nfsd_get_nrthreads(int n, int *nthreads)
 276 {
 277         int i = 0;
 278
 279         if (nfsd_serv != NULL) {
 280                 for (i = 0; i < nfsd_serv->sv_nrpools && i < n; i++)
 281                         nthreads[i] = nfsd_serv->sv_pools[i].sp_nrthreads;
 282         }
 283
 284         return 0;
 285 }
 286
 287 int nfsd_set_nrthreads(int n, int *nthreads)
 288 {
 289         int i = 0;
 290         int tot = 0;
 291         int err = 0;
 292
 293         WARN_ON(!mutex_is_locked(&nfsd_mutex));
 294
 295         if (nfsd_serv == NULL || n <= 0)
 296                 return 0;
 297
 298         if (n > nfsd_serv->sv_nrpools)
 299                 n = nfsd_serv->sv_nrpools;
 300
 301         /* enforce a global maximum number of threads */
 302         tot = 0;
 303         for (i = 0; i < n; i++) {
 304                 if (nthreads[i] > NFSD_MAXSERVS)
 305                         nthreads[i] = NFSD_MAXSERVS;
 306                 tot += nthreads[i];
 307         }
 308         if (tot > NFSD_MAXSERVS) {
 309                 /* total too large: scale down requested numbers */
 310                 for (i = 0; i < n && tot > 0; i++) {
 311                         int new = nthreads[i] * NFSD_MAXSERVS / tot;
 312                         tot -= (nthreads[i] - new);
 313                         nthreads[i] = new;
 314                 }
 315                 for (i = 0; i < n && tot > 0; i++) {
 316                         nthreads[i]--;
 317                         tot--;
 318                 }
 319         }
 320
 321         /*
 322          * There must always be a thread in pool 0; the admin
 323          * can't shut down NFS completely using pool_threads.
 324          */
 325         if (nthreads[0] == 0)
 326                 nthreads[0] = 1;
 327
 328         /* apply the new numbers */
 329         svc_get(nfsd_serv);
 330         for (i = 0; i < n; i++) {
 331                 err = svc_set_num_threads(nfsd_serv, &nfsd_serv->sv_pools[i],
 332                                           nthreads[i]);
 333                 if (err)
 334                         break;
 335         }
 336         svc_destroy(nfsd_serv);
 337
 338         return err;
 339 }
 340
 341 int
 342 nfsd_svc(unsigned short port, int nrservs)
 343 {
 344         int     error;
 345
 346         mutex_lock(&nfsd_mutex);
 347         dprintk("nfsd: creating service\n");
 348         error = -EINVAL;
 349         if (nrservs <= 0)
 350                 nrservs = 0;
 351         if (nrservs > NFSD_MAXSERVS)
 352                 nrservs = NFSD_MAXSERVS;
 353
 354         /* Readahead param cache - will no-op if it already exists */
 355         error = nfsd_racache_init(2*nrservs);
 356         if (error<0)
 357                 goto out;
 358         nfs4_state_start();
 359
 360         nfsd_reset_versions();
 361
 362         error = nfsd_create_serv();
 363
 364         if (error)
 365                 goto out;
 366         error = nfsd_init_socks(port);
 367         if (error)
 368                 goto failure;
 369
 370         error = svc_set_num_threads(nfsd_serv, NULL, nrservs);
 371  failure:
 372         svc_destroy(nfsd_serv);         /* Release server */
 373  out:
 374         mutex_unlock(&nfsd_mutex);
 375         return error;
 376 }
 377
 378 static inline void
 379 update_thread_usage(int busy_threads)
 380 {
 381         unsigned long prev_call;
 382         unsigned long diff;
 383         int decile;
 384
 385         spin_lock(&nfsd_call_lock);
 386         prev_call = nfsd_last_call;
 387         nfsd_last_call = jiffies;
 388         decile = busy_threads*10/nfsdstats.th_cnt;
 389         if (decile>0 && decile <= 10) {
 390                 diff = nfsd_last_call - prev_call;
 391                 if ( (nfsdstats.th_usage[decile-1] += diff) >= NFSD_USAGE_WRAP)
 392                         nfsdstats.th_usage[decile-1] -= NFSD_USAGE_WRAP;
 393                 if (decile == 10)
 394                         nfsdstats.th_fullcnt++;
 395         }
 396         spin_unlock(&nfsd_call_lock);
 397 }
 398
 399 /*
 400  * This is the NFS server kernel thread
 401  */
 402 static int
 403 nfsd(void *vrqstp)
 404 {
 405         struct svc_rqst *rqstp = (struct svc_rqst *) vrqstp;
 406         struct fs_struct *fsp;
 407         int err, preverr = 0;
 408
 409         /* Lock module and set up kernel thread */
 410         mutex_lock(&nfsd_mutex);
 411
 412         /* At this point, the thread shares current->fs
 413          * with the init process. We need to create files with a
 414          * umask of 0 instead of init's umask. */
 415         fsp = copy_fs_struct(current->fs);
 416         if (!fsp) {
 417                 printk("Unable to start nfsd thread: out of memory\n");
 418                 goto out;
 419         }
 420         exit_fs(current);
 421         current->fs = fsp;
 422         current->fs->umask = 0;
 423
 424         /*
 425          * thread is spawned with all signals set to SIG_IGN, re-enable
 426          * the ones that will bring down the thread
 427          */
 428         allow_signal(SIGKILL);
 429         allow_signal(SIGHUP);
 430         allow_signal(SIGINT);
 431         allow_signal(SIGQUIT);
 432
 433         nfsdstats.th_cnt++;
 434         mutex_unlock(&nfsd_mutex);
 435
 436         /*
 437          * We want less throttling in balance_dirty_pages() so that nfs to
 438          * localhost doesn't cause nfsd to lock up due to all the client's
 439          * dirty pages.
 440          */
 441         current->flags |= PF_LESS_THROTTLE;
 442         set_freezable();
 443
 444         /*
 445          * The main request loop
 446          */
 447         for (;;) {
 448                 /*
 449                  * Find a socket with data available and call its
 450                  * recvfrom routine.
 451                  */
 452                 while ((err = svc_recv(rqstp, 60*60*HZ)) == -EAGAIN)
 453                         ;
 454                 if (err == -EINTR)
 455                         break;
 456                 else if (err < 0) {
 457                         if (err != preverr) {
 458                                 printk(KERN_WARNING "%s: unexpected error "
 459                                         "from svc_recv (%d)\n", __func__, -err);
 460                                 preverr = err;
 461                         }
 462                         schedule_timeout_uninterruptible(HZ);
 463                         continue;
 464                 }
 465
 466                 update_thread_usage(atomic_read(&nfsd_busy));
 467                 atomic_inc(&nfsd_busy);
 468
 469                 /* Lock the export hash tables for reading. */
 470                 exp_readlock();
 471
 472                 svc_process(rqstp);
 473
 474                 /* Unlock export hash tables */
 475                 exp_readunlock();
 476                 update_thread_usage(atomic_read(&nfsd_busy));
 477                 atomic_dec(&nfsd_busy);
 478         }
 479
 480         /* Clear signals before calling svc_exit_thread() */
 481         flush_signals(current);
 482
 483         mutex_lock(&nfsd_mutex);
 484         nfsdstats.th_cnt --;
 485
 486 out:
 487         /* Release the thread */
 488         svc_exit_thread(rqstp);
 489
 490         /* Release module */
 491         mutex_unlock(&nfsd_mutex);
 492         module_put_and_exit(0);
 493         return 0;
 494 }
 495
 496 static __be32 map_new_errors(u32 vers, __be32 nfserr)
 497 {
 498         if (nfserr == nfserr_jukebox && vers == 2)
 499                 return nfserr_dropit;
 500         if (nfserr == nfserr_wrongsec && vers < 4)
 501                 return nfserr_acces;
 502         return nfserr;
 503 }
 504
 505 int
 506 nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp)
 507 {
 508         struct svc_procedure    *proc;
 509         kxdrproc_t              xdr;
 510         __be32                  nfserr;
 511         __be32                  *nfserrp;
 512
 513         dprintk("nfsd_dispatch: vers %d proc %d\n",
 514                                 rqstp->rq_vers, rqstp->rq_proc);
 515         proc = rqstp->rq_procinfo;
 516
 517         /* Check whether we have this call in the cache. */
 518         switch (nfsd_cache_lookup(rqstp, proc->pc_cachetype)) {
 519         case RC_INTR:
 520         case RC_DROPIT:
 521                 return 0;
 522         case RC_REPLY:
 523                 return 1;
 524         case RC_DOIT:;
 525                 /* do it */
 526         }
 527
 528         /* Decode arguments */
 529         xdr = proc->pc_decode;
 530         if (xdr && !xdr(rqstp, (__be32*)rqstp->rq_arg.head[0].iov_base,
 531                         rqstp->rq_argp)) {
 532                 dprintk("nfsd: failed to decode arguments!\n");
 533                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
 534                 *statp = rpc_garbage_args;
 535                 return 1;
 536         }
 537
 538         /* need to grab the location to store the status, as
 539          * nfsv4 does some encoding while processing
 540          */
 541         nfserrp = rqstp->rq_res.head[0].iov_base
 542                 + rqstp->rq_res.head[0].iov_len;
 543         rqstp->rq_res.head[0].iov_len += sizeof(__be32);
 544
 545         /* Now call the procedure handler, and encode NFS status. */
 546         nfserr = proc->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
 547         nfserr = map_new_errors(rqstp->rq_vers, nfserr);
 548         if (nfserr == nfserr_dropit) {
 549                 dprintk("nfsd: Dropping request; may be revisited later\n");
 550                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
 551                 return 0;
 552         }
 553
 554         if (rqstp->rq_proc != 0)
 555                 *nfserrp++ = nfserr;
 556
 557         /* Encode result.
 558          * For NFSv2, additional info is never returned in case of an error.
 559          */
 560         if (!(nfserr && rqstp->rq_vers == 2)) {
 561                 xdr = proc->pc_encode;
 562                 if (xdr && !xdr(rqstp, nfserrp,
 563                                 rqstp->rq_resp)) {
 564                         /* Failed to encode result. Release cache entry */
 565                         dprintk("nfsd: failed to encode result!\n");
 566                         nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
 567                         *statp = rpc_system_err;
 568                         return 1;
 569                 }
 570         }
 571
 572         /* Store reply in cache. */
 573         nfsd_cache_update(rqstp, proc->pc_cachetype, statp + 1);
 574         return 1;
 575 }