fs/nfsd/nfssvc.c

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