1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Central processing for nfsd.
4 *
5 * Authors: Olaf Kirch (okir@monad.swb.de)
6 *
7 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
8 */
9
10 #include <linux/sched/signal.h>
11 #include <linux/freezer.h>
12 #include <linux/module.h>
13 #include <linux/fs_struct.h>
14 #include <linux/swap.h>
15 #include <linux/siphash.h>
16
17 #include <linux/sunrpc/stats.h>
18 #include <linux/sunrpc/svcsock.h>
19 #include <linux/sunrpc/svc_xprt.h>
20 #include <linux/lockd/bind.h>
21 #include <linux/nfsacl.h>
22 #include <linux/seq_file.h>
23 #include <linux/inetdevice.h>
24 #include <net/addrconf.h>
25 #include <net/ipv6.h>
26 #include <net/net_namespace.h>
27 #include "nfsd.h"
28 #include "cache.h"
29 #include "vfs.h"
30 #include "netns.h"
31 #include "filecache.h"
32
33 #include "trace.h"
34
35 #define NFSDDBG_FACILITY NFSDDBG_SVC
36
37 extern struct svc_program nfsd_program;
38 static int nfsd(void *vrqstp);
39 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
40 static int nfsd_acl_rpcbind_set(struct net *,
41 const struct svc_program *,
42 u32, int,
43 unsigned short,
44 unsigned short);
45 static __be32 nfsd_acl_init_request(struct svc_rqst *,
46 const struct svc_program *,
47 struct svc_process_info *);
48 #endif
49 static int nfsd_rpcbind_set(struct net *,
50 const struct svc_program *,
51 u32, int,
52 unsigned short,
53 unsigned short);
54 static __be32 nfsd_init_request(struct svc_rqst *,
55 const struct svc_program *,
56 struct svc_process_info *);
57
58 /*
59 * nfsd_mutex protects nn->nfsd_serv -- both the pointer itself and some members
60 * of the svc_serv struct such as ->sv_temp_socks and ->sv_permsocks.
61 *
62 * If (out side the lock) nn->nfsd_serv is non-NULL, then it must point to a
63 * properly initialised 'struct svc_serv' with ->sv_nrthreads > 0 (unless
64 * nn->keep_active is set). That number of nfsd threads must
65 * exist and each must be listed in ->sp_all_threads in some entry of
66 * ->sv_pools[].
67 *
68 * Each active thread holds a counted reference on nn->nfsd_serv, as does
69 * the nn->keep_active flag and various transient calls to svc_get().
70 *
71 * Finally, the nfsd_mutex also protects some of the global variables that are
72 * accessed when nfsd starts and that are settable via the write_* routines in
73 * nfsctl.c. In particular:
74 *
75 * user_recovery_dirname
76 * user_lease_time
77 * nfsd_versions
78 */
79 DEFINE_MUTEX(nfsd_mutex);
80
81 /*
82 * nfsd_drc_lock protects nfsd_drc_max_pages and nfsd_drc_pages_used.
83 * nfsd_drc_max_pages limits the total amount of memory available for
84 * version 4.1 DRC caches.
85 * nfsd_drc_pages_used tracks the current version 4.1 DRC memory usage.
86 */
87 DEFINE_SPINLOCK(nfsd_drc_lock);
88 unsigned long nfsd_drc_max_mem;
89 unsigned long nfsd_drc_mem_used;
90
91 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
92 static struct svc_stat nfsd_acl_svcstats;
93 static const struct svc_version *nfsd_acl_version[] = {
94 # if defined(CONFIG_NFSD_V2_ACL)
95 [2] = &nfsd_acl_version2,
96 # endif
97 # if defined(CONFIG_NFSD_V3_ACL)
98 [3] = &nfsd_acl_version3,
99 # endif
100 };
101
102 #define NFSD_ACL_MINVERS 2
103 #define NFSD_ACL_NRVERS ARRAY_SIZE(nfsd_acl_version)
104
105 static struct svc_program nfsd_acl_program = {
106 .pg_prog = NFS_ACL_PROGRAM,
107 .pg_nvers = NFSD_ACL_NRVERS,
108 .pg_vers = nfsd_acl_version,
109 .pg_name = "nfsacl",
110 .pg_class = "nfsd",
111 .pg_stats = &nfsd_acl_svcstats,
112 .pg_authenticate = &svc_set_client,
113 .pg_init_request = nfsd_acl_init_request,
114 .pg_rpcbind_set = nfsd_acl_rpcbind_set,
115 };
116
117 static struct svc_stat nfsd_acl_svcstats = {
118 .program = &nfsd_acl_program,
119 };
120 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
121
122 static const struct svc_version *nfsd_version[] = {
123 #if defined(CONFIG_NFSD_V2)
124 [2] = &nfsd_version2,
125 #endif
126 [3] = &nfsd_version3,
127 #if defined(CONFIG_NFSD_V4)
128 [4] = &nfsd_version4,
129 #endif
130 };
131
132 #define NFSD_MINVERS 2
133 #define NFSD_NRVERS ARRAY_SIZE(nfsd_version)
134
135 struct svc_program nfsd_program = {
136 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
137 .pg_next = &nfsd_acl_program,
138 #endif
139 .pg_prog = NFS_PROGRAM, /* program number */
140 .pg_nvers = NFSD_NRVERS, /* nr of entries in nfsd_version */
141 .pg_vers = nfsd_version, /* version table */
142 .pg_name = "nfsd", /* program name */
143 .pg_class = "nfsd", /* authentication class */
144 .pg_stats = &nfsd_svcstats, /* version table */
145 .pg_authenticate = &svc_set_client, /* export authentication */
146 .pg_init_request = nfsd_init_request,
147 .pg_rpcbind_set = nfsd_rpcbind_set,
148 };
149
150 static bool
nfsd_support_version(int vers)151 nfsd_support_version(int vers)
152 {
153 if (vers >= NFSD_MINVERS && vers < NFSD_NRVERS)
154 return nfsd_version[vers] != NULL;
155 return false;
156 }
157
158 static bool *
nfsd_alloc_versions(void)159 nfsd_alloc_versions(void)
160 {
161 bool *vers = kmalloc_array(NFSD_NRVERS, sizeof(bool), GFP_KERNEL);
162 unsigned i;
163
164 if (vers) {
165 /* All compiled versions are enabled by default */
166 for (i = 0; i < NFSD_NRVERS; i++)
167 vers[i] = nfsd_support_version(i);
168 }
169 return vers;
170 }
171
172 static bool *
nfsd_alloc_minorversions(void)173 nfsd_alloc_minorversions(void)
174 {
175 bool *vers = kmalloc_array(NFSD_SUPPORTED_MINOR_VERSION + 1,
176 sizeof(bool), GFP_KERNEL);
177 unsigned i;
178
179 if (vers) {
180 /* All minor versions are enabled by default */
181 for (i = 0; i <= NFSD_SUPPORTED_MINOR_VERSION; i++)
182 vers[i] = nfsd_support_version(4);
183 }
184 return vers;
185 }
186
187 void
nfsd_netns_free_versions(struct nfsd_net * nn)188 nfsd_netns_free_versions(struct nfsd_net *nn)
189 {
190 kfree(nn->nfsd_versions);
191 kfree(nn->nfsd4_minorversions);
192 nn->nfsd_versions = NULL;
193 nn->nfsd4_minorversions = NULL;
194 }
195
196 static void
nfsd_netns_init_versions(struct nfsd_net * nn)197 nfsd_netns_init_versions(struct nfsd_net *nn)
198 {
199 if (!nn->nfsd_versions) {
200 nn->nfsd_versions = nfsd_alloc_versions();
201 nn->nfsd4_minorversions = nfsd_alloc_minorversions();
202 if (!nn->nfsd_versions || !nn->nfsd4_minorversions)
203 nfsd_netns_free_versions(nn);
204 }
205 }
206
nfsd_vers(struct nfsd_net * nn,int vers,enum vers_op change)207 int nfsd_vers(struct nfsd_net *nn, int vers, enum vers_op change)
208 {
209 if (vers < NFSD_MINVERS || vers >= NFSD_NRVERS)
210 return 0;
211 switch(change) {
212 case NFSD_SET:
213 if (nn->nfsd_versions)
214 nn->nfsd_versions[vers] = nfsd_support_version(vers);
215 break;
216 case NFSD_CLEAR:
217 nfsd_netns_init_versions(nn);
218 if (nn->nfsd_versions)
219 nn->nfsd_versions[vers] = false;
220 break;
221 case NFSD_TEST:
222 if (nn->nfsd_versions)
223 return nn->nfsd_versions[vers];
224 fallthrough;
225 case NFSD_AVAIL:
226 return nfsd_support_version(vers);
227 }
228 return 0;
229 }
230
231 static void
nfsd_adjust_nfsd_versions4(struct nfsd_net * nn)232 nfsd_adjust_nfsd_versions4(struct nfsd_net *nn)
233 {
234 unsigned i;
235
236 for (i = 0; i <= NFSD_SUPPORTED_MINOR_VERSION; i++) {
237 if (nn->nfsd4_minorversions[i])
238 return;
239 }
240 nfsd_vers(nn, 4, NFSD_CLEAR);
241 }
242
nfsd_minorversion(struct nfsd_net * nn,u32 minorversion,enum vers_op change)243 int nfsd_minorversion(struct nfsd_net *nn, u32 minorversion, enum vers_op change)
244 {
245 if (minorversion > NFSD_SUPPORTED_MINOR_VERSION &&
246 change != NFSD_AVAIL)
247 return -1;
248
249 switch(change) {
250 case NFSD_SET:
251 if (nn->nfsd4_minorversions) {
252 nfsd_vers(nn, 4, NFSD_SET);
253 nn->nfsd4_minorversions[minorversion] =
254 nfsd_vers(nn, 4, NFSD_TEST);
255 }
256 break;
257 case NFSD_CLEAR:
258 nfsd_netns_init_versions(nn);
259 if (nn->nfsd4_minorversions) {
260 nn->nfsd4_minorversions[minorversion] = false;
261 nfsd_adjust_nfsd_versions4(nn);
262 }
263 break;
264 case NFSD_TEST:
265 if (nn->nfsd4_minorversions)
266 return nn->nfsd4_minorversions[minorversion];
267 return nfsd_vers(nn, 4, NFSD_TEST);
268 case NFSD_AVAIL:
269 return minorversion <= NFSD_SUPPORTED_MINOR_VERSION &&
270 nfsd_vers(nn, 4, NFSD_AVAIL);
271 }
272 return 0;
273 }
274
275 /*
276 * Maximum number of nfsd processes
277 */
278 #define NFSD_MAXSERVS 8192
279
nfsd_nrthreads(struct net * net)280 int nfsd_nrthreads(struct net *net)
281 {
282 int rv = 0;
283 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
284
285 mutex_lock(&nfsd_mutex);
286 if (nn->nfsd_serv)
287 rv = nn->nfsd_serv->sv_nrthreads;
288 mutex_unlock(&nfsd_mutex);
289 return rv;
290 }
291
nfsd_init_socks(struct net * net,const struct cred * cred)292 static int nfsd_init_socks(struct net *net, const struct cred *cred)
293 {
294 int error;
295 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
296
297 if (!list_empty(&nn->nfsd_serv->sv_permsocks))
298 return 0;
299
300 error = svc_xprt_create(nn->nfsd_serv, "udp", net, PF_INET, NFS_PORT,
301 SVC_SOCK_DEFAULTS, cred);
302 if (error < 0)
303 return error;
304
305 error = svc_xprt_create(nn->nfsd_serv, "tcp", net, PF_INET, NFS_PORT,
306 SVC_SOCK_DEFAULTS, cred);
307 if (error < 0)
308 return error;
309
310 return 0;
311 }
312
313 static int nfsd_users = 0;
314
nfsd_startup_generic(void)315 static int nfsd_startup_generic(void)
316 {
317 int ret;
318
319 if (nfsd_users++)
320 return 0;
321
322 ret = nfsd_file_cache_init();
323 if (ret)
324 goto dec_users;
325
326 ret = nfs4_state_start();
327 if (ret)
328 goto out_file_cache;
329 return 0;
330
331 out_file_cache:
332 nfsd_file_cache_shutdown();
333 dec_users:
334 nfsd_users--;
335 return ret;
336 }
337
nfsd_shutdown_generic(void)338 static void nfsd_shutdown_generic(void)
339 {
340 if (--nfsd_users)
341 return;
342
343 nfs4_state_shutdown();
344 nfsd_file_cache_shutdown();
345 }
346
nfsd_needs_lockd(struct nfsd_net * nn)347 static bool nfsd_needs_lockd(struct nfsd_net *nn)
348 {
349 return nfsd_vers(nn, 2, NFSD_TEST) || nfsd_vers(nn, 3, NFSD_TEST);
350 }
351
352 /**
353 * nfsd_copy_write_verifier - Atomically copy a write verifier
354 * @verf: buffer in which to receive the verifier cookie
355 * @nn: NFS net namespace
356 *
357 * This function provides a wait-free mechanism for copying the
358 * namespace's write verifier without tearing it.
359 */
nfsd_copy_write_verifier(__be32 verf[2],struct nfsd_net * nn)360 void nfsd_copy_write_verifier(__be32 verf[2], struct nfsd_net *nn)
361 {
362 int seq = 0;
363
364 do {
365 read_seqbegin_or_lock(&nn->writeverf_lock, &seq);
366 memcpy(verf, nn->writeverf, sizeof(nn->writeverf));
367 } while (need_seqretry(&nn->writeverf_lock, seq));
368 done_seqretry(&nn->writeverf_lock, seq);
369 }
370
nfsd_reset_write_verifier_locked(struct nfsd_net * nn)371 static void nfsd_reset_write_verifier_locked(struct nfsd_net *nn)
372 {
373 struct timespec64 now;
374 u64 verf;
375
376 /*
377 * Because the time value is hashed, y2038 time_t overflow
378 * is irrelevant in this usage.
379 */
380 ktime_get_raw_ts64(&now);
381 verf = siphash_2u64(now.tv_sec, now.tv_nsec, &nn->siphash_key);
382 memcpy(nn->writeverf, &verf, sizeof(nn->writeverf));
383 }
384
385 /**
386 * nfsd_reset_write_verifier - Generate a new write verifier
387 * @nn: NFS net namespace
388 *
389 * This function updates the ->writeverf field of @nn. This field
390 * contains an opaque cookie that, according to Section 18.32.3 of
391 * RFC 8881, "the client can use to determine whether a server has
392 * changed instance state (e.g., server restart) between a call to
393 * WRITE and a subsequent call to either WRITE or COMMIT. This
394 * cookie MUST be unchanged during a single instance of the NFSv4.1
395 * server and MUST be unique between instances of the NFSv4.1
396 * server."
397 */
nfsd_reset_write_verifier(struct nfsd_net * nn)398 void nfsd_reset_write_verifier(struct nfsd_net *nn)
399 {
400 write_seqlock(&nn->writeverf_lock);
401 nfsd_reset_write_verifier_locked(nn);
402 write_sequnlock(&nn->writeverf_lock);
403 }
404
nfsd_startup_net(struct net * net,const struct cred * cred)405 static int nfsd_startup_net(struct net *net, const struct cred *cred)
406 {
407 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
408 int ret;
409
410 if (nn->nfsd_net_up)
411 return 0;
412
413 ret = nfsd_startup_generic();
414 if (ret)
415 return ret;
416 ret = nfsd_init_socks(net, cred);
417 if (ret)
418 goto out_socks;
419
420 if (nfsd_needs_lockd(nn) && !nn->lockd_up) {
421 ret = lockd_up(net, cred);
422 if (ret)
423 goto out_socks;
424 nn->lockd_up = true;
425 }
426
427 ret = nfsd_file_cache_start_net(net);
428 if (ret)
429 goto out_lockd;
430
431 ret = nfsd_reply_cache_init(nn);
432 if (ret)
433 goto out_filecache;
434
435 ret = nfs4_state_start_net(net);
436 if (ret)
437 goto out_reply_cache;
438
439 #ifdef CONFIG_NFSD_V4_2_INTER_SSC
440 nfsd4_ssc_init_umount_work(nn);
441 #endif
442 nn->nfsd_net_up = true;
443 return 0;
444
445 out_reply_cache:
446 nfsd_reply_cache_shutdown(nn);
447 out_filecache:
448 nfsd_file_cache_shutdown_net(net);
449 out_lockd:
450 if (nn->lockd_up) {
451 lockd_down(net);
452 nn->lockd_up = false;
453 }
454 out_socks:
455 nfsd_shutdown_generic();
456 return ret;
457 }
458
nfsd_shutdown_net(struct net * net)459 static void nfsd_shutdown_net(struct net *net)
460 {
461 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
462
463 nfs4_state_shutdown_net(net);
464 nfsd_reply_cache_shutdown(nn);
465 nfsd_file_cache_shutdown_net(net);
466 if (nn->lockd_up) {
467 lockd_down(net);
468 nn->lockd_up = false;
469 }
470 nn->nfsd_net_up = false;
471 nfsd_shutdown_generic();
472 }
473
474 static DEFINE_SPINLOCK(nfsd_notifier_lock);
nfsd_inetaddr_event(struct notifier_block * this,unsigned long event,void * ptr)475 static int nfsd_inetaddr_event(struct notifier_block *this, unsigned long event,
476 void *ptr)
477 {
478 struct in_ifaddr *ifa = (struct in_ifaddr *)ptr;
479 struct net_device *dev = ifa->ifa_dev->dev;
480 struct net *net = dev_net(dev);
481 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
482 struct sockaddr_in sin;
483
484 if (event != NETDEV_DOWN || !nn->nfsd_serv)
485 goto out;
486
487 spin_lock(&nfsd_notifier_lock);
488 if (nn->nfsd_serv) {
489 dprintk("nfsd_inetaddr_event: removed %pI4\n", &ifa->ifa_local);
490 sin.sin_family = AF_INET;
491 sin.sin_addr.s_addr = ifa->ifa_local;
492 svc_age_temp_xprts_now(nn->nfsd_serv, (struct sockaddr *)&sin);
493 }
494 spin_unlock(&nfsd_notifier_lock);
495
496 out:
497 return NOTIFY_DONE;
498 }
499
500 static struct notifier_block nfsd_inetaddr_notifier = {
501 .notifier_call = nfsd_inetaddr_event,
502 };
503
504 #if IS_ENABLED(CONFIG_IPV6)
nfsd_inet6addr_event(struct notifier_block * this,unsigned long event,void * ptr)505 static int nfsd_inet6addr_event(struct notifier_block *this,
506 unsigned long event, void *ptr)
507 {
508 struct inet6_ifaddr *ifa = (struct inet6_ifaddr *)ptr;
509 struct net_device *dev = ifa->idev->dev;
510 struct net *net = dev_net(dev);
511 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
512 struct sockaddr_in6 sin6;
513
514 if (event != NETDEV_DOWN || !nn->nfsd_serv)
515 goto out;
516
517 spin_lock(&nfsd_notifier_lock);
518 if (nn->nfsd_serv) {
519 dprintk("nfsd_inet6addr_event: removed %pI6\n", &ifa->addr);
520 sin6.sin6_family = AF_INET6;
521 sin6.sin6_addr = ifa->addr;
522 if (ipv6_addr_type(&sin6.sin6_addr) & IPV6_ADDR_LINKLOCAL)
523 sin6.sin6_scope_id = ifa->idev->dev->ifindex;
524 svc_age_temp_xprts_now(nn->nfsd_serv, (struct sockaddr *)&sin6);
525 }
526 spin_unlock(&nfsd_notifier_lock);
527
528 out:
529 return NOTIFY_DONE;
530 }
531
532 static struct notifier_block nfsd_inet6addr_notifier = {
533 .notifier_call = nfsd_inet6addr_event,
534 };
535 #endif
536
537 /* Only used under nfsd_mutex, so this atomic may be overkill: */
538 static atomic_t nfsd_notifier_refcount = ATOMIC_INIT(0);
539
nfsd_last_thread(struct svc_serv * serv,struct net * net)540 static void nfsd_last_thread(struct svc_serv *serv, struct net *net)
541 {
542 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
543
544 /* check if the notifier still has clients */
545 if (atomic_dec_return(&nfsd_notifier_refcount) == 0) {
546 unregister_inetaddr_notifier(&nfsd_inetaddr_notifier);
547 #if IS_ENABLED(CONFIG_IPV6)
548 unregister_inet6addr_notifier(&nfsd_inet6addr_notifier);
549 #endif
550 }
551
552 /*
553 * write_ports can create the server without actually starting
554 * any threads--if we get shut down before any threads are
555 * started, then nfsd_last_thread will be run before any of this
556 * other initialization has been done except the rpcb information.
557 */
558 svc_rpcb_cleanup(serv, net);
559 if (!nn->nfsd_net_up)
560 return;
561
562 nfsd_shutdown_net(net);
563 pr_info("nfsd: last server has exited, flushing export cache\n");
564 nfsd_export_flush(net);
565 }
566
nfsd_reset_versions(struct nfsd_net * nn)567 void nfsd_reset_versions(struct nfsd_net *nn)
568 {
569 int i;
570
571 for (i = 0; i < NFSD_NRVERS; i++)
572 if (nfsd_vers(nn, i, NFSD_TEST))
573 return;
574
575 for (i = 0; i < NFSD_NRVERS; i++)
576 if (i != 4)
577 nfsd_vers(nn, i, NFSD_SET);
578 else {
579 int minor = 0;
580 while (nfsd_minorversion(nn, minor, NFSD_SET) >= 0)
581 minor++;
582 }
583 }
584
585 /*
586 * Each session guarantees a negotiated per slot memory cache for replies
587 * which in turn consumes memory beyond the v2/v3/v4.0 server. A dedicated
588 * NFSv4.1 server might want to use more memory for a DRC than a machine
589 * with mutiple services.
590 *
591 * Impose a hard limit on the number of pages for the DRC which varies
592 * according to the machines free pages. This is of course only a default.
593 *
594 * For now this is a #defined shift which could be under admin control
595 * in the future.
596 */
set_max_drc(void)597 static void set_max_drc(void)
598 {
599 #define NFSD_DRC_SIZE_SHIFT 7
600 nfsd_drc_max_mem = (nr_free_buffer_pages()
601 >> NFSD_DRC_SIZE_SHIFT) * PAGE_SIZE;
602 nfsd_drc_mem_used = 0;
603 dprintk("%s nfsd_drc_max_mem %lu \n", __func__, nfsd_drc_max_mem);
604 }
605
nfsd_get_default_max_blksize(void)606 static int nfsd_get_default_max_blksize(void)
607 {
608 struct sysinfo i;
609 unsigned long long target;
610 unsigned long ret;
611
612 si_meminfo(&i);
613 target = (i.totalram - i.totalhigh) << PAGE_SHIFT;
614 /*
615 * Aim for 1/4096 of memory per thread This gives 1MB on 4Gig
616 * machines, but only uses 32K on 128M machines. Bottom out at
617 * 8K on 32M and smaller. Of course, this is only a default.
618 */
619 target >>= 12;
620
621 ret = NFSSVC_MAXBLKSIZE;
622 while (ret > target && ret >= 8*1024*2)
623 ret /= 2;
624 return ret;
625 }
626
nfsd_shutdown_threads(struct net * net)627 void nfsd_shutdown_threads(struct net *net)
628 {
629 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
630 struct svc_serv *serv;
631
632 mutex_lock(&nfsd_mutex);
633 serv = nn->nfsd_serv;
634 if (serv == NULL) {
635 mutex_unlock(&nfsd_mutex);
636 return;
637 }
638
639 svc_get(serv);
640 /* Kill outstanding nfsd threads */
641 svc_set_num_threads(serv, NULL, 0);
642 nfsd_put(net);
643 mutex_unlock(&nfsd_mutex);
644 }
645
i_am_nfsd(void)646 bool i_am_nfsd(void)
647 {
648 return kthread_func(current) == nfsd;
649 }
650
nfsd_create_serv(struct net * net)651 int nfsd_create_serv(struct net *net)
652 {
653 int error;
654 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
655 struct svc_serv *serv;
656
657 WARN_ON(!mutex_is_locked(&nfsd_mutex));
658 if (nn->nfsd_serv) {
659 svc_get(nn->nfsd_serv);
660 return 0;
661 }
662 if (nfsd_max_blksize == 0)
663 nfsd_max_blksize = nfsd_get_default_max_blksize();
664 nfsd_reset_versions(nn);
665 serv = svc_create_pooled(&nfsd_program, nfsd_max_blksize, nfsd);
666 if (serv == NULL)
667 return -ENOMEM;
668
669 serv->sv_maxconn = nn->max_connections;
670 error = svc_bind(serv, net);
671 if (error < 0) {
672 /* NOT nfsd_put() as notifiers (see below) haven't
673 * been set up yet.
674 */
675 svc_put(serv);
676 return error;
677 }
678 spin_lock(&nfsd_notifier_lock);
679 nn->nfsd_serv = serv;
680 spin_unlock(&nfsd_notifier_lock);
681
682 set_max_drc();
683 /* check if the notifier is already set */
684 if (atomic_inc_return(&nfsd_notifier_refcount) == 1) {
685 register_inetaddr_notifier(&nfsd_inetaddr_notifier);
686 #if IS_ENABLED(CONFIG_IPV6)
687 register_inet6addr_notifier(&nfsd_inet6addr_notifier);
688 #endif
689 }
690 nfsd_reset_write_verifier(nn);
691 return 0;
692 }
693
nfsd_nrpools(struct net * net)694 int nfsd_nrpools(struct net *net)
695 {
696 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
697
698 if (nn->nfsd_serv == NULL)
699 return 0;
700 else
701 return nn->nfsd_serv->sv_nrpools;
702 }
703
nfsd_get_nrthreads(int n,int * nthreads,struct net * net)704 int nfsd_get_nrthreads(int n, int *nthreads, struct net *net)
705 {
706 int i = 0;
707 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
708
709 if (nn->nfsd_serv != NULL) {
710 for (i = 0; i < nn->nfsd_serv->sv_nrpools && i < n; i++)
711 nthreads[i] = nn->nfsd_serv->sv_pools[i].sp_nrthreads;
712 }
713
714 return 0;
715 }
716
717 /* This is the callback for kref_put() below.
718 * There is no code here as the first thing to be done is
719 * call svc_shutdown_net(), but we cannot get the 'net' from
720 * the kref. So do all the work when kref_put returns true.
721 */
nfsd_noop(struct kref * ref)722 static void nfsd_noop(struct kref *ref)
723 {
724 }
725
nfsd_put(struct net * net)726 void nfsd_put(struct net *net)
727 {
728 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
729
730 if (kref_put(&nn->nfsd_serv->sv_refcnt, nfsd_noop)) {
731 svc_xprt_destroy_all(nn->nfsd_serv, net);
732 nfsd_last_thread(nn->nfsd_serv, net);
733 svc_destroy(&nn->nfsd_serv->sv_refcnt);
734 spin_lock(&nfsd_notifier_lock);
735 nn->nfsd_serv = NULL;
736 spin_unlock(&nfsd_notifier_lock);
737 }
738 }
739
nfsd_set_nrthreads(int n,int * nthreads,struct net * net)740 int nfsd_set_nrthreads(int n, int *nthreads, struct net *net)
741 {
742 int i = 0;
743 int tot = 0;
744 int err = 0;
745 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
746
747 WARN_ON(!mutex_is_locked(&nfsd_mutex));
748
749 if (nn->nfsd_serv == NULL || n <= 0)
750 return 0;
751
752 if (n > nn->nfsd_serv->sv_nrpools)
753 n = nn->nfsd_serv->sv_nrpools;
754
755 /* enforce a global maximum number of threads */
756 tot = 0;
757 for (i = 0; i < n; i++) {
758 nthreads[i] = min(nthreads[i], NFSD_MAXSERVS);
759 tot += nthreads[i];
760 }
761 if (tot > NFSD_MAXSERVS) {
762 /* total too large: scale down requested numbers */
763 for (i = 0; i < n && tot > 0; i++) {
764 int new = nthreads[i] * NFSD_MAXSERVS / tot;
765 tot -= (nthreads[i] - new);
766 nthreads[i] = new;
767 }
768 for (i = 0; i < n && tot > 0; i++) {
769 nthreads[i]--;
770 tot--;
771 }
772 }
773
774 /*
775 * There must always be a thread in pool 0; the admin
776 * can't shut down NFS completely using pool_threads.
777 */
778 if (nthreads[0] == 0)
779 nthreads[0] = 1;
780
781 /* apply the new numbers */
782 svc_get(nn->nfsd_serv);
783 for (i = 0; i < n; i++) {
784 err = svc_set_num_threads(nn->nfsd_serv,
785 &nn->nfsd_serv->sv_pools[i],
786 nthreads[i]);
787 if (err)
788 break;
789 }
790 nfsd_put(net);
791 return err;
792 }
793
794 /*
795 * Adjust the number of threads and return the new number of threads.
796 * This is also the function that starts the server if necessary, if
797 * this is the first time nrservs is nonzero.
798 */
799 int
nfsd_svc(int nrservs,struct net * net,const struct cred * cred)800 nfsd_svc(int nrservs, struct net *net, const struct cred *cred)
801 {
802 int error;
803 bool nfsd_up_before;
804 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
805
806 mutex_lock(&nfsd_mutex);
807 dprintk("nfsd: creating service\n");
808
809 nrservs = max(nrservs, 0);
810 nrservs = min(nrservs, NFSD_MAXSERVS);
811 error = 0;
812
813 if (nrservs == 0 && nn->nfsd_serv == NULL)
814 goto out;
815
816 strscpy(nn->nfsd_name, utsname()->nodename,
817 sizeof(nn->nfsd_name));
818
819 error = nfsd_create_serv(net);
820 if (error)
821 goto out;
822
823 nfsd_up_before = nn->nfsd_net_up;
824
825 error = nfsd_startup_net(net, cred);
826 if (error)
827 goto out_put;
828 error = svc_set_num_threads(nn->nfsd_serv, NULL, nrservs);
829 if (error)
830 goto out_shutdown;
831 error = nn->nfsd_serv->sv_nrthreads;
832 out_shutdown:
833 if (error < 0 && !nfsd_up_before)
834 nfsd_shutdown_net(net);
835 out_put:
836 /* Threads now hold service active */
837 if (xchg(&nn->keep_active, 0))
838 nfsd_put(net);
839 nfsd_put(net);
840 out:
841 mutex_unlock(&nfsd_mutex);
842 return error;
843 }
844
845 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
846 static bool
nfsd_support_acl_version(int vers)847 nfsd_support_acl_version(int vers)
848 {
849 if (vers >= NFSD_ACL_MINVERS && vers < NFSD_ACL_NRVERS)
850 return nfsd_acl_version[vers] != NULL;
851 return false;
852 }
853
854 static int
nfsd_acl_rpcbind_set(struct net * net,const struct svc_program * progp,u32 version,int family,unsigned short proto,unsigned short port)855 nfsd_acl_rpcbind_set(struct net *net, const struct svc_program *progp,
856 u32 version, int family, unsigned short proto,
857 unsigned short port)
858 {
859 if (!nfsd_support_acl_version(version) ||
860 !nfsd_vers(net_generic(net, nfsd_net_id), version, NFSD_TEST))
861 return 0;
862 return svc_generic_rpcbind_set(net, progp, version, family,
863 proto, port);
864 }
865
866 static __be32
nfsd_acl_init_request(struct svc_rqst * rqstp,const struct svc_program * progp,struct svc_process_info * ret)867 nfsd_acl_init_request(struct svc_rqst *rqstp,
868 const struct svc_program *progp,
869 struct svc_process_info *ret)
870 {
871 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
872 int i;
873
874 if (likely(nfsd_support_acl_version(rqstp->rq_vers) &&
875 nfsd_vers(nn, rqstp->rq_vers, NFSD_TEST)))
876 return svc_generic_init_request(rqstp, progp, ret);
877
878 ret->mismatch.lovers = NFSD_ACL_NRVERS;
879 for (i = NFSD_ACL_MINVERS; i < NFSD_ACL_NRVERS; i++) {
880 if (nfsd_support_acl_version(rqstp->rq_vers) &&
881 nfsd_vers(nn, i, NFSD_TEST)) {
882 ret->mismatch.lovers = i;
883 break;
884 }
885 }
886 if (ret->mismatch.lovers == NFSD_ACL_NRVERS)
887 return rpc_prog_unavail;
888 ret->mismatch.hivers = NFSD_ACL_MINVERS;
889 for (i = NFSD_ACL_NRVERS - 1; i >= NFSD_ACL_MINVERS; i--) {
890 if (nfsd_support_acl_version(rqstp->rq_vers) &&
891 nfsd_vers(nn, i, NFSD_TEST)) {
892 ret->mismatch.hivers = i;
893 break;
894 }
895 }
896 return rpc_prog_mismatch;
897 }
898 #endif
899
900 static int
nfsd_rpcbind_set(struct net * net,const struct svc_program * progp,u32 version,int family,unsigned short proto,unsigned short port)901 nfsd_rpcbind_set(struct net *net, const struct svc_program *progp,
902 u32 version, int family, unsigned short proto,
903 unsigned short port)
904 {
905 if (!nfsd_vers(net_generic(net, nfsd_net_id), version, NFSD_TEST))
906 return 0;
907 return svc_generic_rpcbind_set(net, progp, version, family,
908 proto, port);
909 }
910
911 static __be32
nfsd_init_request(struct svc_rqst * rqstp,const struct svc_program * progp,struct svc_process_info * ret)912 nfsd_init_request(struct svc_rqst *rqstp,
913 const struct svc_program *progp,
914 struct svc_process_info *ret)
915 {
916 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
917 int i;
918
919 if (likely(nfsd_vers(nn, rqstp->rq_vers, NFSD_TEST)))
920 return svc_generic_init_request(rqstp, progp, ret);
921
922 ret->mismatch.lovers = NFSD_NRVERS;
923 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++) {
924 if (nfsd_vers(nn, i, NFSD_TEST)) {
925 ret->mismatch.lovers = i;
926 break;
927 }
928 }
929 if (ret->mismatch.lovers == NFSD_NRVERS)
930 return rpc_prog_unavail;
931 ret->mismatch.hivers = NFSD_MINVERS;
932 for (i = NFSD_NRVERS - 1; i >= NFSD_MINVERS; i--) {
933 if (nfsd_vers(nn, i, NFSD_TEST)) {
934 ret->mismatch.hivers = i;
935 break;
936 }
937 }
938 return rpc_prog_mismatch;
939 }
940
941 /*
942 * This is the NFS server kernel thread
943 */
944 static int
nfsd(void * vrqstp)945 nfsd(void *vrqstp)
946 {
947 struct svc_rqst *rqstp = (struct svc_rqst *) vrqstp;
948 struct svc_xprt *perm_sock = list_entry(rqstp->rq_server->sv_permsocks.next, typeof(struct svc_xprt), xpt_list);
949 struct net *net = perm_sock->xpt_net;
950 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
951 int err;
952
953 /* At this point, the thread shares current->fs
954 * with the init process. We need to create files with the
955 * umask as defined by the client instead of init's umask. */
956 if (unshare_fs_struct() < 0) {
957 printk("Unable to start nfsd thread: out of memory\n");
958 goto out;
959 }
960
961 current->fs->umask = 0;
962
963 /*
964 * thread is spawned with all signals set to SIG_IGN, re-enable
965 * the ones that will bring down the thread
966 */
967 allow_signal(SIGKILL);
968 allow_signal(SIGHUP);
969 allow_signal(SIGINT);
970 allow_signal(SIGQUIT);
971
972 atomic_inc(&nfsdstats.th_cnt);
973
974 set_freezable();
975
976 /*
977 * The main request loop
978 */
979 for (;;) {
980 /* Update sv_maxconn if it has changed */
981 rqstp->rq_server->sv_maxconn = nn->max_connections;
982
983 /*
984 * Find a socket with data available and call its
985 * recvfrom routine.
986 */
987 while ((err = svc_recv(rqstp, 60*60*HZ)) == -EAGAIN)
988 ;
989 if (err == -EINTR)
990 break;
991 validate_process_creds();
992 svc_process(rqstp);
993 validate_process_creds();
994 }
995
996 /* Clear signals before calling svc_exit_thread() */
997 flush_signals(current);
998
999 atomic_dec(&nfsdstats.th_cnt);
1000
1001 out:
1002 /* Take an extra ref so that the svc_put in svc_exit_thread()
1003 * doesn't call svc_destroy()
1004 */
1005 svc_get(nn->nfsd_serv);
1006
1007 /* Release the thread */
1008 svc_exit_thread(rqstp);
1009
1010 /* We need to drop a ref, but may not drop the last reference
1011 * without holding nfsd_mutex, and we cannot wait for nfsd_mutex as that
1012 * could deadlock with nfsd_shutdown_threads() waiting for us.
1013 * So three options are:
1014 * - drop a non-final reference,
1015 * - get the mutex without waiting
1016 * - sleep briefly andd try the above again
1017 */
1018 while (!svc_put_not_last(nn->nfsd_serv)) {
1019 if (mutex_trylock(&nfsd_mutex)) {
1020 nfsd_put(net);
1021 mutex_unlock(&nfsd_mutex);
1022 break;
1023 }
1024 msleep(20);
1025 }
1026
1027 return 0;
1028 }
1029
1030 /**
1031 * nfsd_dispatch - Process an NFS or NFSACL Request
1032 * @rqstp: incoming request
1033 *
1034 * This RPC dispatcher integrates the NFS server's duplicate reply cache.
1035 *
1036 * Return values:
1037 * %0: Processing complete; do not send a Reply
1038 * %1: Processing complete; send Reply in rqstp->rq_res
1039 */
nfsd_dispatch(struct svc_rqst * rqstp)1040 int nfsd_dispatch(struct svc_rqst *rqstp)
1041 {
1042 const struct svc_procedure *proc = rqstp->rq_procinfo;
1043 __be32 *statp = rqstp->rq_accept_statp;
1044
1045 /*
1046 * Give the xdr decoder a chance to change this if it wants
1047 * (necessary in the NFSv4.0 compound case)
1048 */
1049 rqstp->rq_cachetype = proc->pc_cachetype;
1050
1051 if (!proc->pc_decode(rqstp, &rqstp->rq_arg_stream))
1052 goto out_decode_err;
1053
1054 switch (nfsd_cache_lookup(rqstp)) {
1055 case RC_DOIT:
1056 break;
1057 case RC_REPLY:
1058 goto out_cached_reply;
1059 case RC_DROPIT:
1060 goto out_dropit;
1061 }
1062
1063 *statp = proc->pc_func(rqstp);
1064 if (test_bit(RQ_DROPME, &rqstp->rq_flags))
1065 goto out_update_drop;
1066
1067 if (!proc->pc_encode(rqstp, &rqstp->rq_res_stream))
1068 goto out_encode_err;
1069
1070 nfsd_cache_update(rqstp, rqstp->rq_cachetype, statp + 1);
1071 out_cached_reply:
1072 return 1;
1073
1074 out_decode_err:
1075 trace_nfsd_garbage_args_err(rqstp);
1076 *statp = rpc_garbage_args;
1077 return 1;
1078
1079 out_update_drop:
1080 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
1081 out_dropit:
1082 return 0;
1083
1084 out_encode_err:
1085 trace_nfsd_cant_encode_err(rqstp);
1086 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
1087 *statp = rpc_system_err;
1088 return 1;
1089 }
1090
1091 /**
1092 * nfssvc_decode_voidarg - Decode void arguments
1093 * @rqstp: Server RPC transaction context
1094 * @xdr: XDR stream positioned at arguments to decode
1095 *
1096 * Return values:
1097 * %false: Arguments were not valid
1098 * %true: Decoding was successful
1099 */
nfssvc_decode_voidarg(struct svc_rqst * rqstp,struct xdr_stream * xdr)1100 bool nfssvc_decode_voidarg(struct svc_rqst *rqstp, struct xdr_stream *xdr)
1101 {
1102 return true;
1103 }
1104
1105 /**
1106 * nfssvc_encode_voidres - Encode void results
1107 * @rqstp: Server RPC transaction context
1108 * @xdr: XDR stream into which to encode results
1109 *
1110 * Return values:
1111 * %false: Local error while encoding
1112 * %true: Encoding was successful
1113 */
nfssvc_encode_voidres(struct svc_rqst * rqstp,struct xdr_stream * xdr)1114 bool nfssvc_encode_voidres(struct svc_rqst *rqstp, struct xdr_stream *xdr)
1115 {
1116 return true;
1117 }
1118
nfsd_pool_stats_open(struct inode * inode,struct file * file)1119 int nfsd_pool_stats_open(struct inode *inode, struct file *file)
1120 {
1121 int ret;
1122 struct nfsd_net *nn = net_generic(inode->i_sb->s_fs_info, nfsd_net_id);
1123
1124 mutex_lock(&nfsd_mutex);
1125 if (nn->nfsd_serv == NULL) {
1126 mutex_unlock(&nfsd_mutex);
1127 return -ENODEV;
1128 }
1129 svc_get(nn->nfsd_serv);
1130 ret = svc_pool_stats_open(nn->nfsd_serv, file);
1131 mutex_unlock(&nfsd_mutex);
1132 return ret;
1133 }
1134
nfsd_pool_stats_release(struct inode * inode,struct file * file)1135 int nfsd_pool_stats_release(struct inode *inode, struct file *file)
1136 {
1137 int ret = seq_release(inode, file);
1138 struct net *net = inode->i_sb->s_fs_info;
1139
1140 mutex_lock(&nfsd_mutex);
1141 nfsd_put(net);
1142 mutex_unlock(&nfsd_mutex);
1143 return ret;
1144 }
1145