Loading...
1/* client.c: NFS client sharing and management code
2 *
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12
13#include <linux/module.h>
14#include <linux/init.h>
15#include <linux/sched.h>
16#include <linux/time.h>
17#include <linux/kernel.h>
18#include <linux/mm.h>
19#include <linux/string.h>
20#include <linux/stat.h>
21#include <linux/errno.h>
22#include <linux/unistd.h>
23#include <linux/sunrpc/clnt.h>
24#include <linux/sunrpc/stats.h>
25#include <linux/sunrpc/metrics.h>
26#include <linux/sunrpc/xprtsock.h>
27#include <linux/sunrpc/xprtrdma.h>
28#include <linux/nfs_fs.h>
29#include <linux/nfs_mount.h>
30#include <linux/nfs4_mount.h>
31#include <linux/lockd/bind.h>
32#include <linux/seq_file.h>
33#include <linux/mount.h>
34#include <linux/nfs_idmap.h>
35#include <linux/vfs.h>
36#include <linux/inet.h>
37#include <linux/in6.h>
38#include <linux/slab.h>
39#include <net/ipv6.h>
40#include <linux/nfs_xdr.h>
41#include <linux/sunrpc/bc_xprt.h>
42
43#include <asm/system.h>
44
45#include "nfs4_fs.h"
46#include "callback.h"
47#include "delegation.h"
48#include "iostat.h"
49#include "internal.h"
50#include "fscache.h"
51#include "pnfs.h"
52
53#define NFSDBG_FACILITY NFSDBG_CLIENT
54
55static DEFINE_SPINLOCK(nfs_client_lock);
56static LIST_HEAD(nfs_client_list);
57static LIST_HEAD(nfs_volume_list);
58static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
59#ifdef CONFIG_NFS_V4
60static DEFINE_IDR(cb_ident_idr); /* Protected by nfs_client_lock */
61
62/*
63 * Get a unique NFSv4.0 callback identifier which will be used
64 * by the V4.0 callback service to lookup the nfs_client struct
65 */
66static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
67{
68 int ret = 0;
69
70 if (clp->rpc_ops->version != 4 || minorversion != 0)
71 return ret;
72retry:
73 if (!idr_pre_get(&cb_ident_idr, GFP_KERNEL))
74 return -ENOMEM;
75 spin_lock(&nfs_client_lock);
76 ret = idr_get_new(&cb_ident_idr, clp, &clp->cl_cb_ident);
77 spin_unlock(&nfs_client_lock);
78 if (ret == -EAGAIN)
79 goto retry;
80 return ret;
81}
82#endif /* CONFIG_NFS_V4 */
83
84/*
85 * Turn off NFSv4 uid/gid mapping when using AUTH_SYS
86 */
87static int nfs4_disable_idmapping = 0;
88
89/*
90 * RPC cruft for NFS
91 */
92static struct rpc_version *nfs_version[5] = {
93 [2] = &nfs_version2,
94#ifdef CONFIG_NFS_V3
95 [3] = &nfs_version3,
96#endif
97#ifdef CONFIG_NFS_V4
98 [4] = &nfs_version4,
99#endif
100};
101
102struct rpc_program nfs_program = {
103 .name = "nfs",
104 .number = NFS_PROGRAM,
105 .nrvers = ARRAY_SIZE(nfs_version),
106 .version = nfs_version,
107 .stats = &nfs_rpcstat,
108 .pipe_dir_name = NFS_PIPE_DIRNAME,
109};
110
111struct rpc_stat nfs_rpcstat = {
112 .program = &nfs_program
113};
114
115
116#ifdef CONFIG_NFS_V3_ACL
117static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
118static struct rpc_version * nfsacl_version[] = {
119 [3] = &nfsacl_version3,
120};
121
122struct rpc_program nfsacl_program = {
123 .name = "nfsacl",
124 .number = NFS_ACL_PROGRAM,
125 .nrvers = ARRAY_SIZE(nfsacl_version),
126 .version = nfsacl_version,
127 .stats = &nfsacl_rpcstat,
128};
129#endif /* CONFIG_NFS_V3_ACL */
130
131struct nfs_client_initdata {
132 const char *hostname;
133 const struct sockaddr *addr;
134 size_t addrlen;
135 const struct nfs_rpc_ops *rpc_ops;
136 int proto;
137 u32 minorversion;
138};
139
140/*
141 * Allocate a shared client record
142 *
143 * Since these are allocated/deallocated very rarely, we don't
144 * bother putting them in a slab cache...
145 */
146static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
147{
148 struct nfs_client *clp;
149 struct rpc_cred *cred;
150 int err = -ENOMEM;
151
152 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
153 goto error_0;
154
155 clp->rpc_ops = cl_init->rpc_ops;
156
157 atomic_set(&clp->cl_count, 1);
158 clp->cl_cons_state = NFS_CS_INITING;
159
160 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
161 clp->cl_addrlen = cl_init->addrlen;
162
163 if (cl_init->hostname) {
164 err = -ENOMEM;
165 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
166 if (!clp->cl_hostname)
167 goto error_cleanup;
168 }
169
170 INIT_LIST_HEAD(&clp->cl_superblocks);
171 clp->cl_rpcclient = ERR_PTR(-EINVAL);
172
173 clp->cl_proto = cl_init->proto;
174
175#ifdef CONFIG_NFS_V4
176 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
177 if (err)
178 goto error_cleanup;
179
180 spin_lock_init(&clp->cl_lock);
181 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
182 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
183 clp->cl_boot_time = CURRENT_TIME;
184 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
185 clp->cl_minorversion = cl_init->minorversion;
186 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
187#endif
188 cred = rpc_lookup_machine_cred();
189 if (!IS_ERR(cred))
190 clp->cl_machine_cred = cred;
191 nfs_fscache_get_client_cookie(clp);
192
193 return clp;
194
195error_cleanup:
196 kfree(clp);
197error_0:
198 return ERR_PTR(err);
199}
200
201#ifdef CONFIG_NFS_V4
202#ifdef CONFIG_NFS_V4_1
203static void nfs4_shutdown_session(struct nfs_client *clp)
204{
205 if (nfs4_has_session(clp))
206 nfs4_destroy_session(clp->cl_session);
207}
208#else /* CONFIG_NFS_V4_1 */
209static void nfs4_shutdown_session(struct nfs_client *clp)
210{
211}
212#endif /* CONFIG_NFS_V4_1 */
213
214/*
215 * Destroy the NFS4 callback service
216 */
217static void nfs4_destroy_callback(struct nfs_client *clp)
218{
219 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
220 nfs_callback_down(clp->cl_mvops->minor_version);
221}
222
223static void nfs4_shutdown_client(struct nfs_client *clp)
224{
225 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
226 nfs4_kill_renewd(clp);
227 nfs4_shutdown_session(clp);
228 nfs4_destroy_callback(clp);
229 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
230 nfs_idmap_delete(clp);
231
232 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
233}
234
235/* idr_remove_all is not needed as all id's are removed by nfs_put_client */
236void nfs_cleanup_cb_ident_idr(void)
237{
238 idr_destroy(&cb_ident_idr);
239}
240
241/* nfs_client_lock held */
242static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
243{
244 if (clp->cl_cb_ident)
245 idr_remove(&cb_ident_idr, clp->cl_cb_ident);
246}
247
248static void pnfs_init_server(struct nfs_server *server)
249{
250 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
251}
252
253#else
254static void nfs4_shutdown_client(struct nfs_client *clp)
255{
256}
257
258void nfs_cleanup_cb_ident_idr(void)
259{
260}
261
262static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
263{
264}
265
266static void pnfs_init_server(struct nfs_server *server)
267{
268}
269
270#endif /* CONFIG_NFS_V4 */
271
272/*
273 * Destroy a shared client record
274 */
275static void nfs_free_client(struct nfs_client *clp)
276{
277 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
278
279 nfs4_shutdown_client(clp);
280
281 nfs_fscache_release_client_cookie(clp);
282
283 /* -EIO all pending I/O */
284 if (!IS_ERR(clp->cl_rpcclient))
285 rpc_shutdown_client(clp->cl_rpcclient);
286
287 if (clp->cl_machine_cred != NULL)
288 put_rpccred(clp->cl_machine_cred);
289
290 nfs4_deviceid_purge_client(clp);
291
292 kfree(clp->cl_hostname);
293 kfree(clp->server_scope);
294 kfree(clp);
295
296 dprintk("<-- nfs_free_client()\n");
297}
298
299/*
300 * Release a reference to a shared client record
301 */
302void nfs_put_client(struct nfs_client *clp)
303{
304 if (!clp)
305 return;
306
307 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
308
309 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
310 list_del(&clp->cl_share_link);
311 nfs_cb_idr_remove_locked(clp);
312 spin_unlock(&nfs_client_lock);
313
314 BUG_ON(!list_empty(&clp->cl_superblocks));
315
316 nfs_free_client(clp);
317 }
318}
319EXPORT_SYMBOL_GPL(nfs_put_client);
320
321#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
322/*
323 * Test if two ip6 socket addresses refer to the same socket by
324 * comparing relevant fields. The padding bytes specifically, are not
325 * compared. sin6_flowinfo is not compared because it only affects QoS
326 * and sin6_scope_id is only compared if the address is "link local"
327 * because "link local" addresses need only be unique to a specific
328 * link. Conversely, ordinary unicast addresses might have different
329 * sin6_scope_id.
330 *
331 * The caller should ensure both socket addresses are AF_INET6.
332 */
333static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
334 const struct sockaddr *sa2)
335{
336 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
337 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
338
339 if (ipv6_addr_scope(&sin1->sin6_addr) == IPV6_ADDR_SCOPE_LINKLOCAL &&
340 sin1->sin6_scope_id != sin2->sin6_scope_id)
341 return 0;
342
343 return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
344}
345#else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
346static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
347 const struct sockaddr *sa2)
348{
349 return 0;
350}
351#endif
352
353/*
354 * Test if two ip4 socket addresses refer to the same socket, by
355 * comparing relevant fields. The padding bytes specifically, are
356 * not compared.
357 *
358 * The caller should ensure both socket addresses are AF_INET.
359 */
360static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
361 const struct sockaddr *sa2)
362{
363 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
364 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
365
366 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
367}
368
369static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
370 const struct sockaddr *sa2)
371{
372 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
373 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
374
375 return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
376 (sin1->sin6_port == sin2->sin6_port);
377}
378
379static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
380 const struct sockaddr *sa2)
381{
382 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
383 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
384
385 return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
386 (sin1->sin_port == sin2->sin_port);
387}
388
389/*
390 * Test if two socket addresses represent the same actual socket,
391 * by comparing (only) relevant fields, excluding the port number.
392 */
393static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
394 const struct sockaddr *sa2)
395{
396 if (sa1->sa_family != sa2->sa_family)
397 return 0;
398
399 switch (sa1->sa_family) {
400 case AF_INET:
401 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
402 case AF_INET6:
403 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
404 }
405 return 0;
406}
407
408/*
409 * Test if two socket addresses represent the same actual socket,
410 * by comparing (only) relevant fields, including the port number.
411 */
412static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
413 const struct sockaddr *sa2)
414{
415 if (sa1->sa_family != sa2->sa_family)
416 return 0;
417
418 switch (sa1->sa_family) {
419 case AF_INET:
420 return nfs_sockaddr_cmp_ip4(sa1, sa2);
421 case AF_INET6:
422 return nfs_sockaddr_cmp_ip6(sa1, sa2);
423 }
424 return 0;
425}
426
427/* Common match routine for v4.0 and v4.1 callback services */
428bool
429nfs4_cb_match_client(const struct sockaddr *addr, struct nfs_client *clp,
430 u32 minorversion)
431{
432 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
433
434 /* Don't match clients that failed to initialise */
435 if (!(clp->cl_cons_state == NFS_CS_READY ||
436 clp->cl_cons_state == NFS_CS_SESSION_INITING))
437 return false;
438
439 /* Match the version and minorversion */
440 if (clp->rpc_ops->version != 4 ||
441 clp->cl_minorversion != minorversion)
442 return false;
443
444 /* Match only the IP address, not the port number */
445 if (!nfs_sockaddr_match_ipaddr(addr, clap))
446 return false;
447
448 return true;
449}
450
451/*
452 * Find an nfs_client on the list that matches the initialisation data
453 * that is supplied.
454 */
455static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
456{
457 struct nfs_client *clp;
458 const struct sockaddr *sap = data->addr;
459
460 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
461 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
462 /* Don't match clients that failed to initialise properly */
463 if (clp->cl_cons_state < 0)
464 continue;
465
466 /* Different NFS versions cannot share the same nfs_client */
467 if (clp->rpc_ops != data->rpc_ops)
468 continue;
469
470 if (clp->cl_proto != data->proto)
471 continue;
472 /* Match nfsv4 minorversion */
473 if (clp->cl_minorversion != data->minorversion)
474 continue;
475 /* Match the full socket address */
476 if (!nfs_sockaddr_cmp(sap, clap))
477 continue;
478
479 atomic_inc(&clp->cl_count);
480 return clp;
481 }
482 return NULL;
483}
484
485/*
486 * Look up a client by IP address and protocol version
487 * - creates a new record if one doesn't yet exist
488 */
489static struct nfs_client *
490nfs_get_client(const struct nfs_client_initdata *cl_init,
491 const struct rpc_timeout *timeparms,
492 const char *ip_addr,
493 rpc_authflavor_t authflavour,
494 int noresvport)
495{
496 struct nfs_client *clp, *new = NULL;
497 int error;
498
499 dprintk("--> nfs_get_client(%s,v%u)\n",
500 cl_init->hostname ?: "", cl_init->rpc_ops->version);
501
502 /* see if the client already exists */
503 do {
504 spin_lock(&nfs_client_lock);
505
506 clp = nfs_match_client(cl_init);
507 if (clp)
508 goto found_client;
509 if (new)
510 goto install_client;
511
512 spin_unlock(&nfs_client_lock);
513
514 new = nfs_alloc_client(cl_init);
515 } while (!IS_ERR(new));
516
517 dprintk("--> nfs_get_client() = %ld [failed]\n", PTR_ERR(new));
518 return new;
519
520 /* install a new client and return with it unready */
521install_client:
522 clp = new;
523 list_add(&clp->cl_share_link, &nfs_client_list);
524 spin_unlock(&nfs_client_lock);
525
526 error = cl_init->rpc_ops->init_client(clp, timeparms, ip_addr,
527 authflavour, noresvport);
528 if (error < 0) {
529 nfs_put_client(clp);
530 return ERR_PTR(error);
531 }
532 dprintk("--> nfs_get_client() = %p [new]\n", clp);
533 return clp;
534
535 /* found an existing client
536 * - make sure it's ready before returning
537 */
538found_client:
539 spin_unlock(&nfs_client_lock);
540
541 if (new)
542 nfs_free_client(new);
543
544 error = wait_event_killable(nfs_client_active_wq,
545 clp->cl_cons_state < NFS_CS_INITING);
546 if (error < 0) {
547 nfs_put_client(clp);
548 return ERR_PTR(-ERESTARTSYS);
549 }
550
551 if (clp->cl_cons_state < NFS_CS_READY) {
552 error = clp->cl_cons_state;
553 nfs_put_client(clp);
554 return ERR_PTR(error);
555 }
556
557 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
558
559 dprintk("--> nfs_get_client() = %p [share]\n", clp);
560 return clp;
561}
562
563/*
564 * Mark a server as ready or failed
565 */
566void nfs_mark_client_ready(struct nfs_client *clp, int state)
567{
568 clp->cl_cons_state = state;
569 wake_up_all(&nfs_client_active_wq);
570}
571
572/*
573 * With sessions, the client is not marked ready until after a
574 * successful EXCHANGE_ID and CREATE_SESSION.
575 *
576 * Map errors cl_cons_state errors to EPROTONOSUPPORT to indicate
577 * other versions of NFS can be tried.
578 */
579int nfs4_check_client_ready(struct nfs_client *clp)
580{
581 if (!nfs4_has_session(clp))
582 return 0;
583 if (clp->cl_cons_state < NFS_CS_READY)
584 return -EPROTONOSUPPORT;
585 return 0;
586}
587
588/*
589 * Initialise the timeout values for a connection
590 */
591static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
592 unsigned int timeo, unsigned int retrans)
593{
594 to->to_initval = timeo * HZ / 10;
595 to->to_retries = retrans;
596
597 switch (proto) {
598 case XPRT_TRANSPORT_TCP:
599 case XPRT_TRANSPORT_RDMA:
600 if (to->to_retries == 0)
601 to->to_retries = NFS_DEF_TCP_RETRANS;
602 if (to->to_initval == 0)
603 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
604 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
605 to->to_initval = NFS_MAX_TCP_TIMEOUT;
606 to->to_increment = to->to_initval;
607 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
608 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
609 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
610 if (to->to_maxval < to->to_initval)
611 to->to_maxval = to->to_initval;
612 to->to_exponential = 0;
613 break;
614 case XPRT_TRANSPORT_UDP:
615 if (to->to_retries == 0)
616 to->to_retries = NFS_DEF_UDP_RETRANS;
617 if (!to->to_initval)
618 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
619 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
620 to->to_initval = NFS_MAX_UDP_TIMEOUT;
621 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
622 to->to_exponential = 1;
623 break;
624 default:
625 BUG();
626 }
627}
628
629/*
630 * Create an RPC client handle
631 */
632static int nfs_create_rpc_client(struct nfs_client *clp,
633 const struct rpc_timeout *timeparms,
634 rpc_authflavor_t flavor,
635 int discrtry, int noresvport)
636{
637 struct rpc_clnt *clnt = NULL;
638 struct rpc_create_args args = {
639 .net = &init_net,
640 .protocol = clp->cl_proto,
641 .address = (struct sockaddr *)&clp->cl_addr,
642 .addrsize = clp->cl_addrlen,
643 .timeout = timeparms,
644 .servername = clp->cl_hostname,
645 .program = &nfs_program,
646 .version = clp->rpc_ops->version,
647 .authflavor = flavor,
648 };
649
650 if (discrtry)
651 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
652 if (noresvport)
653 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
654
655 if (!IS_ERR(clp->cl_rpcclient))
656 return 0;
657
658 clnt = rpc_create(&args);
659 if (IS_ERR(clnt)) {
660 dprintk("%s: cannot create RPC client. Error = %ld\n",
661 __func__, PTR_ERR(clnt));
662 return PTR_ERR(clnt);
663 }
664
665 clp->cl_rpcclient = clnt;
666 return 0;
667}
668
669/*
670 * Version 2 or 3 client destruction
671 */
672static void nfs_destroy_server(struct nfs_server *server)
673{
674 if (!(server->flags & NFS_MOUNT_LOCAL_FLOCK) ||
675 !(server->flags & NFS_MOUNT_LOCAL_FCNTL))
676 nlmclnt_done(server->nlm_host);
677}
678
679/*
680 * Version 2 or 3 lockd setup
681 */
682static int nfs_start_lockd(struct nfs_server *server)
683{
684 struct nlm_host *host;
685 struct nfs_client *clp = server->nfs_client;
686 struct nlmclnt_initdata nlm_init = {
687 .hostname = clp->cl_hostname,
688 .address = (struct sockaddr *)&clp->cl_addr,
689 .addrlen = clp->cl_addrlen,
690 .nfs_version = clp->rpc_ops->version,
691 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
692 1 : 0,
693 };
694
695 if (nlm_init.nfs_version > 3)
696 return 0;
697 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
698 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
699 return 0;
700
701 switch (clp->cl_proto) {
702 default:
703 nlm_init.protocol = IPPROTO_TCP;
704 break;
705 case XPRT_TRANSPORT_UDP:
706 nlm_init.protocol = IPPROTO_UDP;
707 }
708
709 host = nlmclnt_init(&nlm_init);
710 if (IS_ERR(host))
711 return PTR_ERR(host);
712
713 server->nlm_host = host;
714 server->destroy = nfs_destroy_server;
715 return 0;
716}
717
718/*
719 * Initialise an NFSv3 ACL client connection
720 */
721#ifdef CONFIG_NFS_V3_ACL
722static void nfs_init_server_aclclient(struct nfs_server *server)
723{
724 if (server->nfs_client->rpc_ops->version != 3)
725 goto out_noacl;
726 if (server->flags & NFS_MOUNT_NOACL)
727 goto out_noacl;
728
729 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
730 if (IS_ERR(server->client_acl))
731 goto out_noacl;
732
733 /* No errors! Assume that Sun nfsacls are supported */
734 server->caps |= NFS_CAP_ACLS;
735 return;
736
737out_noacl:
738 server->caps &= ~NFS_CAP_ACLS;
739}
740#else
741static inline void nfs_init_server_aclclient(struct nfs_server *server)
742{
743 server->flags &= ~NFS_MOUNT_NOACL;
744 server->caps &= ~NFS_CAP_ACLS;
745}
746#endif
747
748/*
749 * Create a general RPC client
750 */
751static int nfs_init_server_rpcclient(struct nfs_server *server,
752 const struct rpc_timeout *timeo,
753 rpc_authflavor_t pseudoflavour)
754{
755 struct nfs_client *clp = server->nfs_client;
756
757 server->client = rpc_clone_client(clp->cl_rpcclient);
758 if (IS_ERR(server->client)) {
759 dprintk("%s: couldn't create rpc_client!\n", __func__);
760 return PTR_ERR(server->client);
761 }
762
763 memcpy(&server->client->cl_timeout_default,
764 timeo,
765 sizeof(server->client->cl_timeout_default));
766 server->client->cl_timeout = &server->client->cl_timeout_default;
767
768 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
769 struct rpc_auth *auth;
770
771 auth = rpcauth_create(pseudoflavour, server->client);
772 if (IS_ERR(auth)) {
773 dprintk("%s: couldn't create credcache!\n", __func__);
774 return PTR_ERR(auth);
775 }
776 }
777 server->client->cl_softrtry = 0;
778 if (server->flags & NFS_MOUNT_SOFT)
779 server->client->cl_softrtry = 1;
780
781 return 0;
782}
783
784/*
785 * Initialise an NFS2 or NFS3 client
786 */
787int nfs_init_client(struct nfs_client *clp, const struct rpc_timeout *timeparms,
788 const char *ip_addr, rpc_authflavor_t authflavour,
789 int noresvport)
790{
791 int error;
792
793 if (clp->cl_cons_state == NFS_CS_READY) {
794 /* the client is already initialised */
795 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
796 return 0;
797 }
798
799 /*
800 * Create a client RPC handle for doing FSSTAT with UNIX auth only
801 * - RFC 2623, sec 2.3.2
802 */
803 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
804 0, noresvport);
805 if (error < 0)
806 goto error;
807 nfs_mark_client_ready(clp, NFS_CS_READY);
808 return 0;
809
810error:
811 nfs_mark_client_ready(clp, error);
812 dprintk("<-- nfs_init_client() = xerror %d\n", error);
813 return error;
814}
815
816/*
817 * Create a version 2 or 3 client
818 */
819static int nfs_init_server(struct nfs_server *server,
820 const struct nfs_parsed_mount_data *data)
821{
822 struct nfs_client_initdata cl_init = {
823 .hostname = data->nfs_server.hostname,
824 .addr = (const struct sockaddr *)&data->nfs_server.address,
825 .addrlen = data->nfs_server.addrlen,
826 .rpc_ops = &nfs_v2_clientops,
827 .proto = data->nfs_server.protocol,
828 };
829 struct rpc_timeout timeparms;
830 struct nfs_client *clp;
831 int error;
832
833 dprintk("--> nfs_init_server()\n");
834
835#ifdef CONFIG_NFS_V3
836 if (data->version == 3)
837 cl_init.rpc_ops = &nfs_v3_clientops;
838#endif
839
840 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
841 data->timeo, data->retrans);
842
843 /* Allocate or find a client reference we can use */
844 clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX,
845 data->flags & NFS_MOUNT_NORESVPORT);
846 if (IS_ERR(clp)) {
847 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
848 return PTR_ERR(clp);
849 }
850
851 server->nfs_client = clp;
852
853 /* Initialise the client representation from the mount data */
854 server->flags = data->flags;
855 server->options = data->options;
856 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
857 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
858 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
859
860 if (data->rsize)
861 server->rsize = nfs_block_size(data->rsize, NULL);
862 if (data->wsize)
863 server->wsize = nfs_block_size(data->wsize, NULL);
864
865 server->acregmin = data->acregmin * HZ;
866 server->acregmax = data->acregmax * HZ;
867 server->acdirmin = data->acdirmin * HZ;
868 server->acdirmax = data->acdirmax * HZ;
869
870 /* Start lockd here, before we might error out */
871 error = nfs_start_lockd(server);
872 if (error < 0)
873 goto error;
874
875 server->port = data->nfs_server.port;
876
877 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
878 if (error < 0)
879 goto error;
880
881 /* Preserve the values of mount_server-related mount options */
882 if (data->mount_server.addrlen) {
883 memcpy(&server->mountd_address, &data->mount_server.address,
884 data->mount_server.addrlen);
885 server->mountd_addrlen = data->mount_server.addrlen;
886 }
887 server->mountd_version = data->mount_server.version;
888 server->mountd_port = data->mount_server.port;
889 server->mountd_protocol = data->mount_server.protocol;
890
891 server->namelen = data->namlen;
892 /* Create a client RPC handle for the NFSv3 ACL management interface */
893 nfs_init_server_aclclient(server);
894 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
895 return 0;
896
897error:
898 server->nfs_client = NULL;
899 nfs_put_client(clp);
900 dprintk("<-- nfs_init_server() = xerror %d\n", error);
901 return error;
902}
903
904/*
905 * Load up the server record from information gained in an fsinfo record
906 */
907static void nfs_server_set_fsinfo(struct nfs_server *server,
908 struct nfs_fh *mntfh,
909 struct nfs_fsinfo *fsinfo)
910{
911 unsigned long max_rpc_payload;
912
913 /* Work out a lot of parameters */
914 if (server->rsize == 0)
915 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
916 if (server->wsize == 0)
917 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
918
919 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
920 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
921 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
922 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
923
924 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
925 if (server->rsize > max_rpc_payload)
926 server->rsize = max_rpc_payload;
927 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
928 server->rsize = NFS_MAX_FILE_IO_SIZE;
929 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
930
931 server->backing_dev_info.name = "nfs";
932 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
933
934 if (server->wsize > max_rpc_payload)
935 server->wsize = max_rpc_payload;
936 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
937 server->wsize = NFS_MAX_FILE_IO_SIZE;
938 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
939 server->pnfs_blksize = fsinfo->blksize;
940 set_pnfs_layoutdriver(server, mntfh, fsinfo->layouttype);
941
942 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
943
944 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
945 if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
946 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
947 if (server->dtsize > server->rsize)
948 server->dtsize = server->rsize;
949
950 if (server->flags & NFS_MOUNT_NOAC) {
951 server->acregmin = server->acregmax = 0;
952 server->acdirmin = server->acdirmax = 0;
953 }
954
955 server->maxfilesize = fsinfo->maxfilesize;
956
957 server->time_delta = fsinfo->time_delta;
958
959 /* We're airborne Set socket buffersize */
960 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
961}
962
963/*
964 * Probe filesystem information, including the FSID on v2/v3
965 */
966static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
967{
968 struct nfs_fsinfo fsinfo;
969 struct nfs_client *clp = server->nfs_client;
970 int error;
971
972 dprintk("--> nfs_probe_fsinfo()\n");
973
974 if (clp->rpc_ops->set_capabilities != NULL) {
975 error = clp->rpc_ops->set_capabilities(server, mntfh);
976 if (error < 0)
977 goto out_error;
978 }
979
980 fsinfo.fattr = fattr;
981 fsinfo.layouttype = 0;
982 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
983 if (error < 0)
984 goto out_error;
985
986 nfs_server_set_fsinfo(server, mntfh, &fsinfo);
987
988 /* Get some general file system info */
989 if (server->namelen == 0) {
990 struct nfs_pathconf pathinfo;
991
992 pathinfo.fattr = fattr;
993 nfs_fattr_init(fattr);
994
995 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
996 server->namelen = pathinfo.max_namelen;
997 }
998
999 dprintk("<-- nfs_probe_fsinfo() = 0\n");
1000 return 0;
1001
1002out_error:
1003 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
1004 return error;
1005}
1006
1007/*
1008 * Copy useful information when duplicating a server record
1009 */
1010static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
1011{
1012 target->flags = source->flags;
1013 target->rsize = source->rsize;
1014 target->wsize = source->wsize;
1015 target->acregmin = source->acregmin;
1016 target->acregmax = source->acregmax;
1017 target->acdirmin = source->acdirmin;
1018 target->acdirmax = source->acdirmax;
1019 target->caps = source->caps;
1020 target->options = source->options;
1021}
1022
1023static void nfs_server_insert_lists(struct nfs_server *server)
1024{
1025 struct nfs_client *clp = server->nfs_client;
1026
1027 spin_lock(&nfs_client_lock);
1028 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
1029 list_add_tail(&server->master_link, &nfs_volume_list);
1030 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
1031 spin_unlock(&nfs_client_lock);
1032
1033}
1034
1035static void nfs_server_remove_lists(struct nfs_server *server)
1036{
1037 struct nfs_client *clp = server->nfs_client;
1038
1039 spin_lock(&nfs_client_lock);
1040 list_del_rcu(&server->client_link);
1041 if (clp && list_empty(&clp->cl_superblocks))
1042 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
1043 list_del(&server->master_link);
1044 spin_unlock(&nfs_client_lock);
1045
1046 synchronize_rcu();
1047}
1048
1049/*
1050 * Allocate and initialise a server record
1051 */
1052static struct nfs_server *nfs_alloc_server(void)
1053{
1054 struct nfs_server *server;
1055
1056 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
1057 if (!server)
1058 return NULL;
1059
1060 server->client = server->client_acl = ERR_PTR(-EINVAL);
1061
1062 /* Zero out the NFS state stuff */
1063 INIT_LIST_HEAD(&server->client_link);
1064 INIT_LIST_HEAD(&server->master_link);
1065 INIT_LIST_HEAD(&server->delegations);
1066 INIT_LIST_HEAD(&server->layouts);
1067
1068 atomic_set(&server->active, 0);
1069
1070 server->io_stats = nfs_alloc_iostats();
1071 if (!server->io_stats) {
1072 kfree(server);
1073 return NULL;
1074 }
1075
1076 if (bdi_init(&server->backing_dev_info)) {
1077 nfs_free_iostats(server->io_stats);
1078 kfree(server);
1079 return NULL;
1080 }
1081
1082 pnfs_init_server(server);
1083
1084 return server;
1085}
1086
1087/*
1088 * Free up a server record
1089 */
1090void nfs_free_server(struct nfs_server *server)
1091{
1092 dprintk("--> nfs_free_server()\n");
1093
1094 nfs_server_remove_lists(server);
1095 unset_pnfs_layoutdriver(server);
1096
1097 if (server->destroy != NULL)
1098 server->destroy(server);
1099
1100 if (!IS_ERR(server->client_acl))
1101 rpc_shutdown_client(server->client_acl);
1102 if (!IS_ERR(server->client))
1103 rpc_shutdown_client(server->client);
1104
1105 nfs_put_client(server->nfs_client);
1106
1107 nfs_free_iostats(server->io_stats);
1108 bdi_destroy(&server->backing_dev_info);
1109 kfree(server);
1110 nfs_release_automount_timer();
1111 dprintk("<-- nfs_free_server()\n");
1112}
1113
1114/*
1115 * Create a version 2 or 3 volume record
1116 * - keyed on server and FSID
1117 */
1118struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
1119 struct nfs_fh *mntfh)
1120{
1121 struct nfs_server *server;
1122 struct nfs_fattr *fattr;
1123 int error;
1124
1125 server = nfs_alloc_server();
1126 if (!server)
1127 return ERR_PTR(-ENOMEM);
1128
1129 error = -ENOMEM;
1130 fattr = nfs_alloc_fattr();
1131 if (fattr == NULL)
1132 goto error;
1133
1134 /* Get a client representation */
1135 error = nfs_init_server(server, data);
1136 if (error < 0)
1137 goto error;
1138
1139 BUG_ON(!server->nfs_client);
1140 BUG_ON(!server->nfs_client->rpc_ops);
1141 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1142
1143 /* Probe the root fh to retrieve its FSID */
1144 error = nfs_probe_fsinfo(server, mntfh, fattr);
1145 if (error < 0)
1146 goto error;
1147 if (server->nfs_client->rpc_ops->version == 3) {
1148 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1149 server->namelen = NFS3_MAXNAMLEN;
1150 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1151 server->caps |= NFS_CAP_READDIRPLUS;
1152 } else {
1153 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1154 server->namelen = NFS2_MAXNAMLEN;
1155 }
1156
1157 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1158 error = server->nfs_client->rpc_ops->getattr(server, mntfh, fattr);
1159 if (error < 0) {
1160 dprintk("nfs_create_server: getattr error = %d\n", -error);
1161 goto error;
1162 }
1163 }
1164 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1165
1166 dprintk("Server FSID: %llx:%llx\n",
1167 (unsigned long long) server->fsid.major,
1168 (unsigned long long) server->fsid.minor);
1169
1170 nfs_server_insert_lists(server);
1171 server->mount_time = jiffies;
1172 nfs_free_fattr(fattr);
1173 return server;
1174
1175error:
1176 nfs_free_fattr(fattr);
1177 nfs_free_server(server);
1178 return ERR_PTR(error);
1179}
1180
1181#ifdef CONFIG_NFS_V4
1182/*
1183 * NFSv4.0 callback thread helper
1184 *
1185 * Find a client by IP address, protocol version, and minorversion
1186 *
1187 * Called from the pg_authenticate method. The callback identifier
1188 * is not used as it has not been decoded.
1189 *
1190 * Returns NULL if no such client
1191 */
1192struct nfs_client *
1193nfs4_find_client_no_ident(const struct sockaddr *addr)
1194{
1195 struct nfs_client *clp;
1196
1197 spin_lock(&nfs_client_lock);
1198 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
1199 if (nfs4_cb_match_client(addr, clp, 0) == false)
1200 continue;
1201 atomic_inc(&clp->cl_count);
1202 spin_unlock(&nfs_client_lock);
1203 return clp;
1204 }
1205 spin_unlock(&nfs_client_lock);
1206 return NULL;
1207}
1208
1209/*
1210 * NFSv4.0 callback thread helper
1211 *
1212 * Find a client by callback identifier
1213 */
1214struct nfs_client *
1215nfs4_find_client_ident(int cb_ident)
1216{
1217 struct nfs_client *clp;
1218
1219 spin_lock(&nfs_client_lock);
1220 clp = idr_find(&cb_ident_idr, cb_ident);
1221 if (clp)
1222 atomic_inc(&clp->cl_count);
1223 spin_unlock(&nfs_client_lock);
1224 return clp;
1225}
1226
1227#if defined(CONFIG_NFS_V4_1)
1228/*
1229 * NFSv4.1 callback thread helper
1230 * For CB_COMPOUND calls, find a client by IP address, protocol version,
1231 * minorversion, and sessionID
1232 *
1233 * Returns NULL if no such client
1234 */
1235struct nfs_client *
1236nfs4_find_client_sessionid(const struct sockaddr *addr,
1237 struct nfs4_sessionid *sid)
1238{
1239 struct nfs_client *clp;
1240
1241 spin_lock(&nfs_client_lock);
1242 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
1243 if (nfs4_cb_match_client(addr, clp, 1) == false)
1244 continue;
1245
1246 if (!nfs4_has_session(clp))
1247 continue;
1248
1249 /* Match sessionid*/
1250 if (memcmp(clp->cl_session->sess_id.data,
1251 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
1252 continue;
1253
1254 atomic_inc(&clp->cl_count);
1255 spin_unlock(&nfs_client_lock);
1256 return clp;
1257 }
1258 spin_unlock(&nfs_client_lock);
1259 return NULL;
1260}
1261
1262#else /* CONFIG_NFS_V4_1 */
1263
1264struct nfs_client *
1265nfs4_find_client_sessionid(const struct sockaddr *addr,
1266 struct nfs4_sessionid *sid)
1267{
1268 return NULL;
1269}
1270#endif /* CONFIG_NFS_V4_1 */
1271
1272/*
1273 * Initialize the NFS4 callback service
1274 */
1275static int nfs4_init_callback(struct nfs_client *clp)
1276{
1277 int error;
1278
1279 if (clp->rpc_ops->version == 4) {
1280 if (nfs4_has_session(clp)) {
1281 error = xprt_setup_backchannel(
1282 clp->cl_rpcclient->cl_xprt,
1283 NFS41_BC_MIN_CALLBACKS);
1284 if (error < 0)
1285 return error;
1286 }
1287
1288 error = nfs_callback_up(clp->cl_mvops->minor_version,
1289 clp->cl_rpcclient->cl_xprt);
1290 if (error < 0) {
1291 dprintk("%s: failed to start callback. Error = %d\n",
1292 __func__, error);
1293 return error;
1294 }
1295 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
1296 }
1297 return 0;
1298}
1299
1300/*
1301 * Initialize the minor version specific parts of an NFS4 client record
1302 */
1303static int nfs4_init_client_minor_version(struct nfs_client *clp)
1304{
1305#if defined(CONFIG_NFS_V4_1)
1306 if (clp->cl_mvops->minor_version) {
1307 struct nfs4_session *session = NULL;
1308 /*
1309 * Create the session and mark it expired.
1310 * When a SEQUENCE operation encounters the expired session
1311 * it will do session recovery to initialize it.
1312 */
1313 session = nfs4_alloc_session(clp);
1314 if (!session)
1315 return -ENOMEM;
1316
1317 clp->cl_session = session;
1318 /*
1319 * The create session reply races with the server back
1320 * channel probe. Mark the client NFS_CS_SESSION_INITING
1321 * so that the client back channel can find the
1322 * nfs_client struct
1323 */
1324 clp->cl_cons_state = NFS_CS_SESSION_INITING;
1325 }
1326#endif /* CONFIG_NFS_V4_1 */
1327
1328 return nfs4_init_callback(clp);
1329}
1330
1331/*
1332 * Initialise an NFS4 client record
1333 */
1334int nfs4_init_client(struct nfs_client *clp,
1335 const struct rpc_timeout *timeparms,
1336 const char *ip_addr,
1337 rpc_authflavor_t authflavour,
1338 int noresvport)
1339{
1340 int error;
1341
1342 if (clp->cl_cons_state == NFS_CS_READY) {
1343 /* the client is initialised already */
1344 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
1345 return 0;
1346 }
1347
1348 /* Check NFS protocol revision and initialize RPC op vector */
1349 clp->rpc_ops = &nfs_v4_clientops;
1350
1351 error = nfs_create_rpc_client(clp, timeparms, authflavour,
1352 1, noresvport);
1353 if (error < 0)
1354 goto error;
1355 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
1356
1357 error = nfs_idmap_new(clp);
1358 if (error < 0) {
1359 dprintk("%s: failed to create idmapper. Error = %d\n",
1360 __func__, error);
1361 goto error;
1362 }
1363 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1364
1365 error = nfs4_init_client_minor_version(clp);
1366 if (error < 0)
1367 goto error;
1368
1369 if (!nfs4_has_session(clp))
1370 nfs_mark_client_ready(clp, NFS_CS_READY);
1371 return 0;
1372
1373error:
1374 nfs_mark_client_ready(clp, error);
1375 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1376 return error;
1377}
1378
1379/*
1380 * Set up an NFS4 client
1381 */
1382static int nfs4_set_client(struct nfs_server *server,
1383 const char *hostname,
1384 const struct sockaddr *addr,
1385 const size_t addrlen,
1386 const char *ip_addr,
1387 rpc_authflavor_t authflavour,
1388 int proto, const struct rpc_timeout *timeparms,
1389 u32 minorversion)
1390{
1391 struct nfs_client_initdata cl_init = {
1392 .hostname = hostname,
1393 .addr = addr,
1394 .addrlen = addrlen,
1395 .rpc_ops = &nfs_v4_clientops,
1396 .proto = proto,
1397 .minorversion = minorversion,
1398 };
1399 struct nfs_client *clp;
1400 int error;
1401
1402 dprintk("--> nfs4_set_client()\n");
1403
1404 /* Allocate or find a client reference we can use */
1405 clp = nfs_get_client(&cl_init, timeparms, ip_addr, authflavour,
1406 server->flags & NFS_MOUNT_NORESVPORT);
1407 if (IS_ERR(clp)) {
1408 error = PTR_ERR(clp);
1409 goto error;
1410 }
1411
1412 /*
1413 * Query for the lease time on clientid setup or renewal
1414 *
1415 * Note that this will be set on nfs_clients that were created
1416 * only for the DS role and did not set this bit, but now will
1417 * serve a dual role.
1418 */
1419 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
1420
1421 server->nfs_client = clp;
1422 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1423 return 0;
1424error:
1425 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1426 return error;
1427}
1428
1429/*
1430 * Set up a pNFS Data Server client.
1431 *
1432 * Return any existing nfs_client that matches server address,port,version
1433 * and minorversion.
1434 *
1435 * For a new nfs_client, use a soft mount (default), a low retrans and a
1436 * low timeout interval so that if a connection is lost, we retry through
1437 * the MDS.
1438 */
1439struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
1440 const struct sockaddr *ds_addr,
1441 int ds_addrlen, int ds_proto)
1442{
1443 struct nfs_client_initdata cl_init = {
1444 .addr = ds_addr,
1445 .addrlen = ds_addrlen,
1446 .rpc_ops = &nfs_v4_clientops,
1447 .proto = ds_proto,
1448 .minorversion = mds_clp->cl_minorversion,
1449 };
1450 struct rpc_timeout ds_timeout = {
1451 .to_initval = 15 * HZ,
1452 .to_maxval = 15 * HZ,
1453 .to_retries = 1,
1454 .to_exponential = 1,
1455 };
1456 struct nfs_client *clp;
1457
1458 /*
1459 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
1460 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
1461 * (section 13.1 RFC 5661).
1462 */
1463 clp = nfs_get_client(&cl_init, &ds_timeout, mds_clp->cl_ipaddr,
1464 mds_clp->cl_rpcclient->cl_auth->au_flavor, 0);
1465
1466 dprintk("<-- %s %p\n", __func__, clp);
1467 return clp;
1468}
1469EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1470
1471/*
1472 * Session has been established, and the client marked ready.
1473 * Set the mount rsize and wsize with negotiated fore channel
1474 * attributes which will be bound checked in nfs_server_set_fsinfo.
1475 */
1476static void nfs4_session_set_rwsize(struct nfs_server *server)
1477{
1478#ifdef CONFIG_NFS_V4_1
1479 struct nfs4_session *sess;
1480 u32 server_resp_sz;
1481 u32 server_rqst_sz;
1482
1483 if (!nfs4_has_session(server->nfs_client))
1484 return;
1485 sess = server->nfs_client->cl_session;
1486 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1487 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1488
1489 if (server->rsize > server_resp_sz)
1490 server->rsize = server_resp_sz;
1491 if (server->wsize > server_rqst_sz)
1492 server->wsize = server_rqst_sz;
1493#endif /* CONFIG_NFS_V4_1 */
1494}
1495
1496static int nfs4_server_common_setup(struct nfs_server *server,
1497 struct nfs_fh *mntfh)
1498{
1499 struct nfs_fattr *fattr;
1500 int error;
1501
1502 BUG_ON(!server->nfs_client);
1503 BUG_ON(!server->nfs_client->rpc_ops);
1504 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1505
1506 /* data servers support only a subset of NFSv4.1 */
1507 if (is_ds_only_client(server->nfs_client))
1508 return -EPROTONOSUPPORT;
1509
1510 fattr = nfs_alloc_fattr();
1511 if (fattr == NULL)
1512 return -ENOMEM;
1513
1514 /* We must ensure the session is initialised first */
1515 error = nfs4_init_session(server);
1516 if (error < 0)
1517 goto out;
1518
1519 /* Probe the root fh to retrieve its FSID and filehandle */
1520 error = nfs4_get_rootfh(server, mntfh);
1521 if (error < 0)
1522 goto out;
1523
1524 dprintk("Server FSID: %llx:%llx\n",
1525 (unsigned long long) server->fsid.major,
1526 (unsigned long long) server->fsid.minor);
1527 dprintk("Mount FH: %d\n", mntfh->size);
1528
1529 nfs4_session_set_rwsize(server);
1530
1531 error = nfs_probe_fsinfo(server, mntfh, fattr);
1532 if (error < 0)
1533 goto out;
1534
1535 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1536 server->namelen = NFS4_MAXNAMLEN;
1537
1538 nfs_server_insert_lists(server);
1539 server->mount_time = jiffies;
1540out:
1541 nfs_free_fattr(fattr);
1542 return error;
1543}
1544
1545/*
1546 * Create a version 4 volume record
1547 */
1548static int nfs4_init_server(struct nfs_server *server,
1549 const struct nfs_parsed_mount_data *data)
1550{
1551 struct rpc_timeout timeparms;
1552 int error;
1553
1554 dprintk("--> nfs4_init_server()\n");
1555
1556 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1557 data->timeo, data->retrans);
1558
1559 /* Initialise the client representation from the mount data */
1560 server->flags = data->flags;
1561 server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR|NFS_CAP_POSIX_LOCK;
1562 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1563 server->caps |= NFS_CAP_READDIRPLUS;
1564 server->options = data->options;
1565
1566 /* Get a client record */
1567 error = nfs4_set_client(server,
1568 data->nfs_server.hostname,
1569 (const struct sockaddr *)&data->nfs_server.address,
1570 data->nfs_server.addrlen,
1571 data->client_address,
1572 data->auth_flavors[0],
1573 data->nfs_server.protocol,
1574 &timeparms,
1575 data->minorversion);
1576 if (error < 0)
1577 goto error;
1578
1579 /*
1580 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1581 * authentication.
1582 */
1583 if (nfs4_disable_idmapping && data->auth_flavors[0] == RPC_AUTH_UNIX)
1584 server->caps |= NFS_CAP_UIDGID_NOMAP;
1585
1586 if (data->rsize)
1587 server->rsize = nfs_block_size(data->rsize, NULL);
1588 if (data->wsize)
1589 server->wsize = nfs_block_size(data->wsize, NULL);
1590
1591 server->acregmin = data->acregmin * HZ;
1592 server->acregmax = data->acregmax * HZ;
1593 server->acdirmin = data->acdirmin * HZ;
1594 server->acdirmax = data->acdirmax * HZ;
1595
1596 server->port = data->nfs_server.port;
1597
1598 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1599
1600error:
1601 /* Done */
1602 dprintk("<-- nfs4_init_server() = %d\n", error);
1603 return error;
1604}
1605
1606/*
1607 * Create a version 4 volume record
1608 * - keyed on server and FSID
1609 */
1610struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1611 struct nfs_fh *mntfh)
1612{
1613 struct nfs_server *server;
1614 int error;
1615
1616 dprintk("--> nfs4_create_server()\n");
1617
1618 server = nfs_alloc_server();
1619 if (!server)
1620 return ERR_PTR(-ENOMEM);
1621
1622 /* set up the general RPC client */
1623 error = nfs4_init_server(server, data);
1624 if (error < 0)
1625 goto error;
1626
1627 error = nfs4_server_common_setup(server, mntfh);
1628 if (error < 0)
1629 goto error;
1630
1631 dprintk("<-- nfs4_create_server() = %p\n", server);
1632 return server;
1633
1634error:
1635 nfs_free_server(server);
1636 dprintk("<-- nfs4_create_server() = error %d\n", error);
1637 return ERR_PTR(error);
1638}
1639
1640/*
1641 * Create an NFS4 referral server record
1642 */
1643struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1644 struct nfs_fh *mntfh)
1645{
1646 struct nfs_client *parent_client;
1647 struct nfs_server *server, *parent_server;
1648 int error;
1649
1650 dprintk("--> nfs4_create_referral_server()\n");
1651
1652 server = nfs_alloc_server();
1653 if (!server)
1654 return ERR_PTR(-ENOMEM);
1655
1656 parent_server = NFS_SB(data->sb);
1657 parent_client = parent_server->nfs_client;
1658
1659 /* Initialise the client representation from the parent server */
1660 nfs_server_copy_userdata(server, parent_server);
1661 server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR;
1662
1663 /* Get a client representation.
1664 * Note: NFSv4 always uses TCP, */
1665 error = nfs4_set_client(server, data->hostname,
1666 data->addr,
1667 data->addrlen,
1668 parent_client->cl_ipaddr,
1669 data->authflavor,
1670 parent_server->client->cl_xprt->prot,
1671 parent_server->client->cl_timeout,
1672 parent_client->cl_mvops->minor_version);
1673 if (error < 0)
1674 goto error;
1675
1676 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1677 if (error < 0)
1678 goto error;
1679
1680 error = nfs4_server_common_setup(server, mntfh);
1681 if (error < 0)
1682 goto error;
1683
1684 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1685 return server;
1686
1687error:
1688 nfs_free_server(server);
1689 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1690 return ERR_PTR(error);
1691}
1692
1693#endif /* CONFIG_NFS_V4 */
1694
1695/*
1696 * Clone an NFS2, NFS3 or NFS4 server record
1697 */
1698struct nfs_server *nfs_clone_server(struct nfs_server *source,
1699 struct nfs_fh *fh,
1700 struct nfs_fattr *fattr)
1701{
1702 struct nfs_server *server;
1703 struct nfs_fattr *fattr_fsinfo;
1704 int error;
1705
1706 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1707 (unsigned long long) fattr->fsid.major,
1708 (unsigned long long) fattr->fsid.minor);
1709
1710 server = nfs_alloc_server();
1711 if (!server)
1712 return ERR_PTR(-ENOMEM);
1713
1714 error = -ENOMEM;
1715 fattr_fsinfo = nfs_alloc_fattr();
1716 if (fattr_fsinfo == NULL)
1717 goto out_free_server;
1718
1719 /* Copy data from the source */
1720 server->nfs_client = source->nfs_client;
1721 atomic_inc(&server->nfs_client->cl_count);
1722 nfs_server_copy_userdata(server, source);
1723
1724 server->fsid = fattr->fsid;
1725
1726 error = nfs_init_server_rpcclient(server,
1727 source->client->cl_timeout,
1728 source->client->cl_auth->au_flavor);
1729 if (error < 0)
1730 goto out_free_server;
1731 if (!IS_ERR(source->client_acl))
1732 nfs_init_server_aclclient(server);
1733
1734 /* probe the filesystem info for this server filesystem */
1735 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1736 if (error < 0)
1737 goto out_free_server;
1738
1739 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1740 server->namelen = NFS4_MAXNAMLEN;
1741
1742 dprintk("Cloned FSID: %llx:%llx\n",
1743 (unsigned long long) server->fsid.major,
1744 (unsigned long long) server->fsid.minor);
1745
1746 error = nfs_start_lockd(server);
1747 if (error < 0)
1748 goto out_free_server;
1749
1750 nfs_server_insert_lists(server);
1751 server->mount_time = jiffies;
1752
1753 nfs_free_fattr(fattr_fsinfo);
1754 dprintk("<-- nfs_clone_server() = %p\n", server);
1755 return server;
1756
1757out_free_server:
1758 nfs_free_fattr(fattr_fsinfo);
1759 nfs_free_server(server);
1760 dprintk("<-- nfs_clone_server() = error %d\n", error);
1761 return ERR_PTR(error);
1762}
1763
1764#ifdef CONFIG_PROC_FS
1765static struct proc_dir_entry *proc_fs_nfs;
1766
1767static int nfs_server_list_open(struct inode *inode, struct file *file);
1768static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1769static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1770static void nfs_server_list_stop(struct seq_file *p, void *v);
1771static int nfs_server_list_show(struct seq_file *m, void *v);
1772
1773static const struct seq_operations nfs_server_list_ops = {
1774 .start = nfs_server_list_start,
1775 .next = nfs_server_list_next,
1776 .stop = nfs_server_list_stop,
1777 .show = nfs_server_list_show,
1778};
1779
1780static const struct file_operations nfs_server_list_fops = {
1781 .open = nfs_server_list_open,
1782 .read = seq_read,
1783 .llseek = seq_lseek,
1784 .release = seq_release,
1785 .owner = THIS_MODULE,
1786};
1787
1788static int nfs_volume_list_open(struct inode *inode, struct file *file);
1789static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1790static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1791static void nfs_volume_list_stop(struct seq_file *p, void *v);
1792static int nfs_volume_list_show(struct seq_file *m, void *v);
1793
1794static const struct seq_operations nfs_volume_list_ops = {
1795 .start = nfs_volume_list_start,
1796 .next = nfs_volume_list_next,
1797 .stop = nfs_volume_list_stop,
1798 .show = nfs_volume_list_show,
1799};
1800
1801static const struct file_operations nfs_volume_list_fops = {
1802 .open = nfs_volume_list_open,
1803 .read = seq_read,
1804 .llseek = seq_lseek,
1805 .release = seq_release,
1806 .owner = THIS_MODULE,
1807};
1808
1809/*
1810 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1811 * we're dealing
1812 */
1813static int nfs_server_list_open(struct inode *inode, struct file *file)
1814{
1815 struct seq_file *m;
1816 int ret;
1817
1818 ret = seq_open(file, &nfs_server_list_ops);
1819 if (ret < 0)
1820 return ret;
1821
1822 m = file->private_data;
1823 m->private = PDE(inode)->data;
1824
1825 return 0;
1826}
1827
1828/*
1829 * set up the iterator to start reading from the server list and return the first item
1830 */
1831static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1832{
1833 /* lock the list against modification */
1834 spin_lock(&nfs_client_lock);
1835 return seq_list_start_head(&nfs_client_list, *_pos);
1836}
1837
1838/*
1839 * move to next server
1840 */
1841static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1842{
1843 return seq_list_next(v, &nfs_client_list, pos);
1844}
1845
1846/*
1847 * clean up after reading from the transports list
1848 */
1849static void nfs_server_list_stop(struct seq_file *p, void *v)
1850{
1851 spin_unlock(&nfs_client_lock);
1852}
1853
1854/*
1855 * display a header line followed by a load of call lines
1856 */
1857static int nfs_server_list_show(struct seq_file *m, void *v)
1858{
1859 struct nfs_client *clp;
1860
1861 /* display header on line 1 */
1862 if (v == &nfs_client_list) {
1863 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1864 return 0;
1865 }
1866
1867 /* display one transport per line on subsequent lines */
1868 clp = list_entry(v, struct nfs_client, cl_share_link);
1869
1870 seq_printf(m, "v%u %s %s %3d %s\n",
1871 clp->rpc_ops->version,
1872 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1873 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1874 atomic_read(&clp->cl_count),
1875 clp->cl_hostname);
1876
1877 return 0;
1878}
1879
1880/*
1881 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1882 */
1883static int nfs_volume_list_open(struct inode *inode, struct file *file)
1884{
1885 struct seq_file *m;
1886 int ret;
1887
1888 ret = seq_open(file, &nfs_volume_list_ops);
1889 if (ret < 0)
1890 return ret;
1891
1892 m = file->private_data;
1893 m->private = PDE(inode)->data;
1894
1895 return 0;
1896}
1897
1898/*
1899 * set up the iterator to start reading from the volume list and return the first item
1900 */
1901static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1902{
1903 /* lock the list against modification */
1904 spin_lock(&nfs_client_lock);
1905 return seq_list_start_head(&nfs_volume_list, *_pos);
1906}
1907
1908/*
1909 * move to next volume
1910 */
1911static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1912{
1913 return seq_list_next(v, &nfs_volume_list, pos);
1914}
1915
1916/*
1917 * clean up after reading from the transports list
1918 */
1919static void nfs_volume_list_stop(struct seq_file *p, void *v)
1920{
1921 spin_unlock(&nfs_client_lock);
1922}
1923
1924/*
1925 * display a header line followed by a load of call lines
1926 */
1927static int nfs_volume_list_show(struct seq_file *m, void *v)
1928{
1929 struct nfs_server *server;
1930 struct nfs_client *clp;
1931 char dev[8], fsid[17];
1932
1933 /* display header on line 1 */
1934 if (v == &nfs_volume_list) {
1935 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
1936 return 0;
1937 }
1938 /* display one transport per line on subsequent lines */
1939 server = list_entry(v, struct nfs_server, master_link);
1940 clp = server->nfs_client;
1941
1942 snprintf(dev, 8, "%u:%u",
1943 MAJOR(server->s_dev), MINOR(server->s_dev));
1944
1945 snprintf(fsid, 17, "%llx:%llx",
1946 (unsigned long long) server->fsid.major,
1947 (unsigned long long) server->fsid.minor);
1948
1949 seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1950 clp->rpc_ops->version,
1951 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1952 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1953 dev,
1954 fsid,
1955 nfs_server_fscache_state(server));
1956
1957 return 0;
1958}
1959
1960/*
1961 * initialise the /proc/fs/nfsfs/ directory
1962 */
1963int __init nfs_fs_proc_init(void)
1964{
1965 struct proc_dir_entry *p;
1966
1967 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1968 if (!proc_fs_nfs)
1969 goto error_0;
1970
1971 /* a file of servers with which we're dealing */
1972 p = proc_create("servers", S_IFREG|S_IRUGO,
1973 proc_fs_nfs, &nfs_server_list_fops);
1974 if (!p)
1975 goto error_1;
1976
1977 /* a file of volumes that we have mounted */
1978 p = proc_create("volumes", S_IFREG|S_IRUGO,
1979 proc_fs_nfs, &nfs_volume_list_fops);
1980 if (!p)
1981 goto error_2;
1982 return 0;
1983
1984error_2:
1985 remove_proc_entry("servers", proc_fs_nfs);
1986error_1:
1987 remove_proc_entry("fs/nfsfs", NULL);
1988error_0:
1989 return -ENOMEM;
1990}
1991
1992/*
1993 * clean up the /proc/fs/nfsfs/ directory
1994 */
1995void nfs_fs_proc_exit(void)
1996{
1997 remove_proc_entry("volumes", proc_fs_nfs);
1998 remove_proc_entry("servers", proc_fs_nfs);
1999 remove_proc_entry("fs/nfsfs", NULL);
2000}
2001
2002#endif /* CONFIG_PROC_FS */
2003
2004module_param(nfs4_disable_idmapping, bool, 0644);
2005MODULE_PARM_DESC(nfs4_disable_idmapping,
2006 "Turn off NFSv4 idmapping when using 'sec=sys'");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/* client.c: NFS client sharing and management code
3 *
4 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8
9#include <linux/module.h>
10#include <linux/init.h>
11#include <linux/sched.h>
12#include <linux/time.h>
13#include <linux/kernel.h>
14#include <linux/mm.h>
15#include <linux/string.h>
16#include <linux/stat.h>
17#include <linux/errno.h>
18#include <linux/unistd.h>
19#include <linux/sunrpc/addr.h>
20#include <linux/sunrpc/clnt.h>
21#include <linux/sunrpc/stats.h>
22#include <linux/sunrpc/metrics.h>
23#include <linux/sunrpc/xprtsock.h>
24#include <linux/sunrpc/xprtrdma.h>
25#include <linux/nfs_fs.h>
26#include <linux/nfs_mount.h>
27#include <linux/nfs4_mount.h>
28#include <linux/lockd/bind.h>
29#include <linux/seq_file.h>
30#include <linux/mount.h>
31#include <linux/vfs.h>
32#include <linux/inet.h>
33#include <linux/in6.h>
34#include <linux/slab.h>
35#include <linux/idr.h>
36#include <net/ipv6.h>
37#include <linux/nfs_xdr.h>
38#include <linux/sunrpc/bc_xprt.h>
39#include <linux/nsproxy.h>
40#include <linux/pid_namespace.h>
41
42
43#include "nfs4_fs.h"
44#include "callback.h"
45#include "delegation.h"
46#include "iostat.h"
47#include "internal.h"
48#include "fscache.h"
49#include "pnfs.h"
50#include "nfs.h"
51#include "netns.h"
52#include "sysfs.h"
53
54#define NFSDBG_FACILITY NFSDBG_CLIENT
55
56static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
57static DEFINE_SPINLOCK(nfs_version_lock);
58static DEFINE_MUTEX(nfs_version_mutex);
59static LIST_HEAD(nfs_versions);
60
61/*
62 * RPC cruft for NFS
63 */
64static const struct rpc_version *nfs_version[5] = {
65 [2] = NULL,
66 [3] = NULL,
67 [4] = NULL,
68};
69
70const struct rpc_program nfs_program = {
71 .name = "nfs",
72 .number = NFS_PROGRAM,
73 .nrvers = ARRAY_SIZE(nfs_version),
74 .version = nfs_version,
75 .stats = &nfs_rpcstat,
76 .pipe_dir_name = NFS_PIPE_DIRNAME,
77};
78
79struct rpc_stat nfs_rpcstat = {
80 .program = &nfs_program
81};
82
83static struct nfs_subversion *find_nfs_version(unsigned int version)
84{
85 struct nfs_subversion *nfs;
86 spin_lock(&nfs_version_lock);
87
88 list_for_each_entry(nfs, &nfs_versions, list) {
89 if (nfs->rpc_ops->version == version) {
90 spin_unlock(&nfs_version_lock);
91 return nfs;
92 }
93 }
94
95 spin_unlock(&nfs_version_lock);
96 return ERR_PTR(-EPROTONOSUPPORT);
97}
98
99struct nfs_subversion *get_nfs_version(unsigned int version)
100{
101 struct nfs_subversion *nfs = find_nfs_version(version);
102
103 if (IS_ERR(nfs)) {
104 mutex_lock(&nfs_version_mutex);
105 request_module("nfsv%d", version);
106 nfs = find_nfs_version(version);
107 mutex_unlock(&nfs_version_mutex);
108 }
109
110 if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
111 return ERR_PTR(-EAGAIN);
112 return nfs;
113}
114
115void put_nfs_version(struct nfs_subversion *nfs)
116{
117 module_put(nfs->owner);
118}
119
120void register_nfs_version(struct nfs_subversion *nfs)
121{
122 spin_lock(&nfs_version_lock);
123
124 list_add(&nfs->list, &nfs_versions);
125 nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
126
127 spin_unlock(&nfs_version_lock);
128}
129EXPORT_SYMBOL_GPL(register_nfs_version);
130
131void unregister_nfs_version(struct nfs_subversion *nfs)
132{
133 spin_lock(&nfs_version_lock);
134
135 nfs_version[nfs->rpc_ops->version] = NULL;
136 list_del(&nfs->list);
137
138 spin_unlock(&nfs_version_lock);
139}
140EXPORT_SYMBOL_GPL(unregister_nfs_version);
141
142/*
143 * Allocate a shared client record
144 *
145 * Since these are allocated/deallocated very rarely, we don't
146 * bother putting them in a slab cache...
147 */
148struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
149{
150 struct nfs_client *clp;
151 int err = -ENOMEM;
152
153 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
154 goto error_0;
155
156 clp->cl_nfs_mod = cl_init->nfs_mod;
157 if (!try_module_get(clp->cl_nfs_mod->owner))
158 goto error_dealloc;
159
160 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
161
162 refcount_set(&clp->cl_count, 1);
163 clp->cl_cons_state = NFS_CS_INITING;
164
165 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
166 clp->cl_addrlen = cl_init->addrlen;
167
168 if (cl_init->hostname) {
169 err = -ENOMEM;
170 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
171 if (!clp->cl_hostname)
172 goto error_cleanup;
173 }
174
175 INIT_LIST_HEAD(&clp->cl_superblocks);
176 clp->cl_rpcclient = ERR_PTR(-EINVAL);
177
178 clp->cl_proto = cl_init->proto;
179 clp->cl_nconnect = cl_init->nconnect;
180 clp->cl_net = get_net(cl_init->net);
181
182 clp->cl_principal = "*";
183 nfs_fscache_get_client_cookie(clp);
184
185 return clp;
186
187error_cleanup:
188 put_nfs_version(clp->cl_nfs_mod);
189error_dealloc:
190 kfree(clp);
191error_0:
192 return ERR_PTR(err);
193}
194EXPORT_SYMBOL_GPL(nfs_alloc_client);
195
196#if IS_ENABLED(CONFIG_NFS_V4)
197static void nfs_cleanup_cb_ident_idr(struct net *net)
198{
199 struct nfs_net *nn = net_generic(net, nfs_net_id);
200
201 idr_destroy(&nn->cb_ident_idr);
202}
203
204/* nfs_client_lock held */
205static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
206{
207 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
208
209 if (clp->cl_cb_ident)
210 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
211}
212
213static void pnfs_init_server(struct nfs_server *server)
214{
215 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
216}
217
218#else
219static void nfs_cleanup_cb_ident_idr(struct net *net)
220{
221}
222
223static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
224{
225}
226
227static void pnfs_init_server(struct nfs_server *server)
228{
229}
230
231#endif /* CONFIG_NFS_V4 */
232
233/*
234 * Destroy a shared client record
235 */
236void nfs_free_client(struct nfs_client *clp)
237{
238 nfs_fscache_release_client_cookie(clp);
239
240 /* -EIO all pending I/O */
241 if (!IS_ERR(clp->cl_rpcclient))
242 rpc_shutdown_client(clp->cl_rpcclient);
243
244 put_net(clp->cl_net);
245 put_nfs_version(clp->cl_nfs_mod);
246 kfree(clp->cl_hostname);
247 kfree(clp->cl_acceptor);
248 kfree(clp);
249}
250EXPORT_SYMBOL_GPL(nfs_free_client);
251
252/*
253 * Release a reference to a shared client record
254 */
255void nfs_put_client(struct nfs_client *clp)
256{
257 struct nfs_net *nn;
258
259 if (!clp)
260 return;
261
262 nn = net_generic(clp->cl_net, nfs_net_id);
263
264 if (refcount_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
265 list_del(&clp->cl_share_link);
266 nfs_cb_idr_remove_locked(clp);
267 spin_unlock(&nn->nfs_client_lock);
268
269 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
270
271 clp->rpc_ops->free_client(clp);
272 }
273}
274EXPORT_SYMBOL_GPL(nfs_put_client);
275
276/*
277 * Find an nfs_client on the list that matches the initialisation data
278 * that is supplied.
279 */
280static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
281{
282 struct nfs_client *clp;
283 const struct sockaddr *sap = data->addr;
284 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
285 int error;
286
287again:
288 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
289 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
290 /* Don't match clients that failed to initialise properly */
291 if (clp->cl_cons_state < 0)
292 continue;
293
294 /* If a client is still initializing then we need to wait */
295 if (clp->cl_cons_state > NFS_CS_READY) {
296 refcount_inc(&clp->cl_count);
297 spin_unlock(&nn->nfs_client_lock);
298 error = nfs_wait_client_init_complete(clp);
299 nfs_put_client(clp);
300 spin_lock(&nn->nfs_client_lock);
301 if (error < 0)
302 return ERR_PTR(error);
303 goto again;
304 }
305
306 /* Different NFS versions cannot share the same nfs_client */
307 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
308 continue;
309
310 if (clp->cl_proto != data->proto)
311 continue;
312 /* Match nfsv4 minorversion */
313 if (clp->cl_minorversion != data->minorversion)
314 continue;
315 /* Match the full socket address */
316 if (!rpc_cmp_addr_port(sap, clap))
317 /* Match all xprt_switch full socket addresses */
318 if (IS_ERR(clp->cl_rpcclient) ||
319 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
320 sap))
321 continue;
322
323 refcount_inc(&clp->cl_count);
324 return clp;
325 }
326 return NULL;
327}
328
329/*
330 * Return true if @clp is done initializing, false if still working on it.
331 *
332 * Use nfs_client_init_status to check if it was successful.
333 */
334bool nfs_client_init_is_complete(const struct nfs_client *clp)
335{
336 return clp->cl_cons_state <= NFS_CS_READY;
337}
338EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
339
340/*
341 * Return 0 if @clp was successfully initialized, -errno otherwise.
342 *
343 * This must be called *after* nfs_client_init_is_complete() returns true,
344 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
345 */
346int nfs_client_init_status(const struct nfs_client *clp)
347{
348 /* called without checking nfs_client_init_is_complete */
349 if (clp->cl_cons_state > NFS_CS_READY) {
350 WARN_ON_ONCE(1);
351 return -EINVAL;
352 }
353 return clp->cl_cons_state;
354}
355EXPORT_SYMBOL_GPL(nfs_client_init_status);
356
357int nfs_wait_client_init_complete(const struct nfs_client *clp)
358{
359 return wait_event_killable(nfs_client_active_wq,
360 nfs_client_init_is_complete(clp));
361}
362EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
363
364/*
365 * Found an existing client. Make sure it's ready before returning.
366 */
367static struct nfs_client *
368nfs_found_client(const struct nfs_client_initdata *cl_init,
369 struct nfs_client *clp)
370{
371 int error;
372
373 error = nfs_wait_client_init_complete(clp);
374 if (error < 0) {
375 nfs_put_client(clp);
376 return ERR_PTR(-ERESTARTSYS);
377 }
378
379 if (clp->cl_cons_state < NFS_CS_READY) {
380 error = clp->cl_cons_state;
381 nfs_put_client(clp);
382 return ERR_PTR(error);
383 }
384
385 smp_rmb();
386 return clp;
387}
388
389/*
390 * Look up a client by IP address and protocol version
391 * - creates a new record if one doesn't yet exist
392 */
393struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
394{
395 struct nfs_client *clp, *new = NULL;
396 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
397 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
398
399 if (cl_init->hostname == NULL) {
400 WARN_ON(1);
401 return NULL;
402 }
403
404 /* see if the client already exists */
405 do {
406 spin_lock(&nn->nfs_client_lock);
407
408 clp = nfs_match_client(cl_init);
409 if (clp) {
410 spin_unlock(&nn->nfs_client_lock);
411 if (new)
412 new->rpc_ops->free_client(new);
413 if (IS_ERR(clp))
414 return clp;
415 return nfs_found_client(cl_init, clp);
416 }
417 if (new) {
418 list_add_tail(&new->cl_share_link,
419 &nn->nfs_client_list);
420 spin_unlock(&nn->nfs_client_lock);
421 new->cl_flags = cl_init->init_flags;
422 return rpc_ops->init_client(new, cl_init);
423 }
424
425 spin_unlock(&nn->nfs_client_lock);
426
427 new = rpc_ops->alloc_client(cl_init);
428 } while (!IS_ERR(new));
429
430 return new;
431}
432EXPORT_SYMBOL_GPL(nfs_get_client);
433
434/*
435 * Mark a server as ready or failed
436 */
437void nfs_mark_client_ready(struct nfs_client *clp, int state)
438{
439 smp_wmb();
440 clp->cl_cons_state = state;
441 wake_up_all(&nfs_client_active_wq);
442}
443EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
444
445/*
446 * Initialise the timeout values for a connection
447 */
448void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
449 int timeo, int retrans)
450{
451 to->to_initval = timeo * HZ / 10;
452 to->to_retries = retrans;
453
454 switch (proto) {
455 case XPRT_TRANSPORT_TCP:
456 case XPRT_TRANSPORT_RDMA:
457 if (retrans == NFS_UNSPEC_RETRANS)
458 to->to_retries = NFS_DEF_TCP_RETRANS;
459 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
460 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
461 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
462 to->to_initval = NFS_MAX_TCP_TIMEOUT;
463 to->to_increment = to->to_initval;
464 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
465 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
466 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
467 if (to->to_maxval < to->to_initval)
468 to->to_maxval = to->to_initval;
469 to->to_exponential = 0;
470 break;
471 case XPRT_TRANSPORT_UDP:
472 if (retrans == NFS_UNSPEC_RETRANS)
473 to->to_retries = NFS_DEF_UDP_RETRANS;
474 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
475 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
476 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
477 to->to_initval = NFS_MAX_UDP_TIMEOUT;
478 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
479 to->to_exponential = 1;
480 break;
481 default:
482 BUG();
483 }
484}
485EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
486
487/*
488 * Create an RPC client handle
489 */
490int nfs_create_rpc_client(struct nfs_client *clp,
491 const struct nfs_client_initdata *cl_init,
492 rpc_authflavor_t flavor)
493{
494 struct rpc_clnt *clnt = NULL;
495 struct rpc_create_args args = {
496 .net = clp->cl_net,
497 .protocol = clp->cl_proto,
498 .nconnect = clp->cl_nconnect,
499 .address = (struct sockaddr *)&clp->cl_addr,
500 .addrsize = clp->cl_addrlen,
501 .timeout = cl_init->timeparms,
502 .servername = clp->cl_hostname,
503 .nodename = cl_init->nodename,
504 .program = &nfs_program,
505 .version = clp->rpc_ops->version,
506 .authflavor = flavor,
507 .cred = cl_init->cred,
508 };
509
510 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
511 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
512 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
513 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
514 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
515 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
516 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
517 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
518
519 if (!IS_ERR(clp->cl_rpcclient))
520 return 0;
521
522 clnt = rpc_create(&args);
523 if (IS_ERR(clnt)) {
524 dprintk("%s: cannot create RPC client. Error = %ld\n",
525 __func__, PTR_ERR(clnt));
526 return PTR_ERR(clnt);
527 }
528
529 clnt->cl_principal = clp->cl_principal;
530 clp->cl_rpcclient = clnt;
531 return 0;
532}
533EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
534
535/*
536 * Version 2 or 3 client destruction
537 */
538static void nfs_destroy_server(struct nfs_server *server)
539{
540 if (server->nlm_host)
541 nlmclnt_done(server->nlm_host);
542}
543
544/*
545 * Version 2 or 3 lockd setup
546 */
547static int nfs_start_lockd(struct nfs_server *server)
548{
549 struct nlm_host *host;
550 struct nfs_client *clp = server->nfs_client;
551 struct nlmclnt_initdata nlm_init = {
552 .hostname = clp->cl_hostname,
553 .address = (struct sockaddr *)&clp->cl_addr,
554 .addrlen = clp->cl_addrlen,
555 .nfs_version = clp->rpc_ops->version,
556 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
557 1 : 0,
558 .net = clp->cl_net,
559 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
560 .cred = current_cred(),
561 };
562
563 if (nlm_init.nfs_version > 3)
564 return 0;
565 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
566 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
567 return 0;
568
569 switch (clp->cl_proto) {
570 default:
571 nlm_init.protocol = IPPROTO_TCP;
572 break;
573 case XPRT_TRANSPORT_UDP:
574 nlm_init.protocol = IPPROTO_UDP;
575 }
576
577 host = nlmclnt_init(&nlm_init);
578 if (IS_ERR(host))
579 return PTR_ERR(host);
580
581 server->nlm_host = host;
582 server->destroy = nfs_destroy_server;
583 return 0;
584}
585
586/*
587 * Create a general RPC client
588 */
589int nfs_init_server_rpcclient(struct nfs_server *server,
590 const struct rpc_timeout *timeo,
591 rpc_authflavor_t pseudoflavour)
592{
593 struct nfs_client *clp = server->nfs_client;
594
595 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
596 pseudoflavour);
597 if (IS_ERR(server->client)) {
598 dprintk("%s: couldn't create rpc_client!\n", __func__);
599 return PTR_ERR(server->client);
600 }
601
602 memcpy(&server->client->cl_timeout_default,
603 timeo,
604 sizeof(server->client->cl_timeout_default));
605 server->client->cl_timeout = &server->client->cl_timeout_default;
606 server->client->cl_softrtry = 0;
607 if (server->flags & NFS_MOUNT_SOFTERR)
608 server->client->cl_softerr = 1;
609 if (server->flags & NFS_MOUNT_SOFT)
610 server->client->cl_softrtry = 1;
611
612 return 0;
613}
614EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
615
616/**
617 * nfs_init_client - Initialise an NFS2 or NFS3 client
618 *
619 * @clp: nfs_client to initialise
620 * @cl_init: Initialisation parameters
621 *
622 * Returns pointer to an NFS client, or an ERR_PTR value.
623 */
624struct nfs_client *nfs_init_client(struct nfs_client *clp,
625 const struct nfs_client_initdata *cl_init)
626{
627 int error;
628
629 /* the client is already initialised */
630 if (clp->cl_cons_state == NFS_CS_READY)
631 return clp;
632
633 /*
634 * Create a client RPC handle for doing FSSTAT with UNIX auth only
635 * - RFC 2623, sec 2.3.2
636 */
637 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
638 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
639 if (error < 0) {
640 nfs_put_client(clp);
641 clp = ERR_PTR(error);
642 }
643 return clp;
644}
645EXPORT_SYMBOL_GPL(nfs_init_client);
646
647/*
648 * Create a version 2 or 3 client
649 */
650static int nfs_init_server(struct nfs_server *server,
651 const struct nfs_parsed_mount_data *data,
652 struct nfs_subversion *nfs_mod)
653{
654 struct rpc_timeout timeparms;
655 struct nfs_client_initdata cl_init = {
656 .hostname = data->nfs_server.hostname,
657 .addr = (const struct sockaddr *)&data->nfs_server.address,
658 .addrlen = data->nfs_server.addrlen,
659 .nfs_mod = nfs_mod,
660 .proto = data->nfs_server.protocol,
661 .net = data->net,
662 .timeparms = &timeparms,
663 .cred = server->cred,
664 .nconnect = data->nfs_server.nconnect,
665 };
666 struct nfs_client *clp;
667 int error;
668
669 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
670 data->timeo, data->retrans);
671 if (data->flags & NFS_MOUNT_NORESVPORT)
672 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
673
674 /* Allocate or find a client reference we can use */
675 clp = nfs_get_client(&cl_init);
676 if (IS_ERR(clp))
677 return PTR_ERR(clp);
678
679 server->nfs_client = clp;
680
681 /* Initialise the client representation from the mount data */
682 server->flags = data->flags;
683 server->options = data->options;
684 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
685 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
686 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
687
688 if (data->rsize)
689 server->rsize = nfs_block_size(data->rsize, NULL);
690 if (data->wsize)
691 server->wsize = nfs_block_size(data->wsize, NULL);
692
693 server->acregmin = data->acregmin * HZ;
694 server->acregmax = data->acregmax * HZ;
695 server->acdirmin = data->acdirmin * HZ;
696 server->acdirmax = data->acdirmax * HZ;
697
698 /* Start lockd here, before we might error out */
699 error = nfs_start_lockd(server);
700 if (error < 0)
701 goto error;
702
703 server->port = data->nfs_server.port;
704 server->auth_info = data->auth_info;
705
706 error = nfs_init_server_rpcclient(server, &timeparms,
707 data->selected_flavor);
708 if (error < 0)
709 goto error;
710
711 /* Preserve the values of mount_server-related mount options */
712 if (data->mount_server.addrlen) {
713 memcpy(&server->mountd_address, &data->mount_server.address,
714 data->mount_server.addrlen);
715 server->mountd_addrlen = data->mount_server.addrlen;
716 }
717 server->mountd_version = data->mount_server.version;
718 server->mountd_port = data->mount_server.port;
719 server->mountd_protocol = data->mount_server.protocol;
720
721 server->namelen = data->namlen;
722 return 0;
723
724error:
725 server->nfs_client = NULL;
726 nfs_put_client(clp);
727 return error;
728}
729
730/*
731 * Load up the server record from information gained in an fsinfo record
732 */
733static void nfs_server_set_fsinfo(struct nfs_server *server,
734 struct nfs_fsinfo *fsinfo)
735{
736 unsigned long max_rpc_payload;
737
738 /* Work out a lot of parameters */
739 if (server->rsize == 0)
740 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
741 if (server->wsize == 0)
742 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
743
744 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
745 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
746 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
747 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
748
749 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
750 if (server->rsize > max_rpc_payload)
751 server->rsize = max_rpc_payload;
752 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
753 server->rsize = NFS_MAX_FILE_IO_SIZE;
754 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
755
756 if (server->wsize > max_rpc_payload)
757 server->wsize = max_rpc_payload;
758 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
759 server->wsize = NFS_MAX_FILE_IO_SIZE;
760 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
761
762 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
763
764 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
765 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
766 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
767 if (server->dtsize > server->rsize)
768 server->dtsize = server->rsize;
769
770 if (server->flags & NFS_MOUNT_NOAC) {
771 server->acregmin = server->acregmax = 0;
772 server->acdirmin = server->acdirmax = 0;
773 }
774
775 server->maxfilesize = fsinfo->maxfilesize;
776
777 server->time_delta = fsinfo->time_delta;
778
779 server->clone_blksize = fsinfo->clone_blksize;
780 /* We're airborne Set socket buffersize */
781 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
782}
783
784/*
785 * Probe filesystem information, including the FSID on v2/v3
786 */
787int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
788{
789 struct nfs_fsinfo fsinfo;
790 struct nfs_client *clp = server->nfs_client;
791 int error;
792
793 if (clp->rpc_ops->set_capabilities != NULL) {
794 error = clp->rpc_ops->set_capabilities(server, mntfh);
795 if (error < 0)
796 return error;
797 }
798
799 fsinfo.fattr = fattr;
800 fsinfo.nlayouttypes = 0;
801 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
802 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
803 if (error < 0)
804 return error;
805
806 nfs_server_set_fsinfo(server, &fsinfo);
807
808 /* Get some general file system info */
809 if (server->namelen == 0) {
810 struct nfs_pathconf pathinfo;
811
812 pathinfo.fattr = fattr;
813 nfs_fattr_init(fattr);
814
815 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
816 server->namelen = pathinfo.max_namelen;
817 }
818
819 return 0;
820}
821EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
822
823/*
824 * Copy useful information when duplicating a server record
825 */
826void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
827{
828 target->flags = source->flags;
829 target->rsize = source->rsize;
830 target->wsize = source->wsize;
831 target->acregmin = source->acregmin;
832 target->acregmax = source->acregmax;
833 target->acdirmin = source->acdirmin;
834 target->acdirmax = source->acdirmax;
835 target->caps = source->caps;
836 target->options = source->options;
837 target->auth_info = source->auth_info;
838 target->port = source->port;
839}
840EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
841
842void nfs_server_insert_lists(struct nfs_server *server)
843{
844 struct nfs_client *clp = server->nfs_client;
845 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
846
847 spin_lock(&nn->nfs_client_lock);
848 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
849 list_add_tail(&server->master_link, &nn->nfs_volume_list);
850 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
851 spin_unlock(&nn->nfs_client_lock);
852
853}
854EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
855
856void nfs_server_remove_lists(struct nfs_server *server)
857{
858 struct nfs_client *clp = server->nfs_client;
859 struct nfs_net *nn;
860
861 if (clp == NULL)
862 return;
863 nn = net_generic(clp->cl_net, nfs_net_id);
864 spin_lock(&nn->nfs_client_lock);
865 list_del_rcu(&server->client_link);
866 if (list_empty(&clp->cl_superblocks))
867 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
868 list_del(&server->master_link);
869 spin_unlock(&nn->nfs_client_lock);
870
871 synchronize_rcu();
872}
873EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
874
875/*
876 * Allocate and initialise a server record
877 */
878struct nfs_server *nfs_alloc_server(void)
879{
880 struct nfs_server *server;
881
882 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
883 if (!server)
884 return NULL;
885
886 server->client = server->client_acl = ERR_PTR(-EINVAL);
887
888 /* Zero out the NFS state stuff */
889 INIT_LIST_HEAD(&server->client_link);
890 INIT_LIST_HEAD(&server->master_link);
891 INIT_LIST_HEAD(&server->delegations);
892 INIT_LIST_HEAD(&server->layouts);
893 INIT_LIST_HEAD(&server->state_owners_lru);
894 INIT_LIST_HEAD(&server->ss_copies);
895
896 atomic_set(&server->active, 0);
897
898 server->io_stats = nfs_alloc_iostats();
899 if (!server->io_stats) {
900 kfree(server);
901 return NULL;
902 }
903
904 ida_init(&server->openowner_id);
905 ida_init(&server->lockowner_id);
906 pnfs_init_server(server);
907 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
908
909 return server;
910}
911EXPORT_SYMBOL_GPL(nfs_alloc_server);
912
913/*
914 * Free up a server record
915 */
916void nfs_free_server(struct nfs_server *server)
917{
918 nfs_server_remove_lists(server);
919
920 if (server->destroy != NULL)
921 server->destroy(server);
922
923 if (!IS_ERR(server->client_acl))
924 rpc_shutdown_client(server->client_acl);
925 if (!IS_ERR(server->client))
926 rpc_shutdown_client(server->client);
927
928 nfs_put_client(server->nfs_client);
929
930 ida_destroy(&server->lockowner_id);
931 ida_destroy(&server->openowner_id);
932 nfs_free_iostats(server->io_stats);
933 put_cred(server->cred);
934 kfree(server);
935 nfs_release_automount_timer();
936}
937EXPORT_SYMBOL_GPL(nfs_free_server);
938
939/*
940 * Create a version 2 or 3 volume record
941 * - keyed on server and FSID
942 */
943struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
944 struct nfs_subversion *nfs_mod)
945{
946 struct nfs_server *server;
947 struct nfs_fattr *fattr;
948 int error;
949
950 server = nfs_alloc_server();
951 if (!server)
952 return ERR_PTR(-ENOMEM);
953
954 server->cred = get_cred(current_cred());
955
956 error = -ENOMEM;
957 fattr = nfs_alloc_fattr();
958 if (fattr == NULL)
959 goto error;
960
961 /* Get a client representation */
962 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
963 if (error < 0)
964 goto error;
965
966 /* Probe the root fh to retrieve its FSID */
967 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
968 if (error < 0)
969 goto error;
970 if (server->nfs_client->rpc_ops->version == 3) {
971 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
972 server->namelen = NFS3_MAXNAMLEN;
973 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
974 server->caps |= NFS_CAP_READDIRPLUS;
975 } else {
976 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
977 server->namelen = NFS2_MAXNAMLEN;
978 }
979
980 if (!(fattr->valid & NFS_ATTR_FATTR)) {
981 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh,
982 fattr, NULL, NULL);
983 if (error < 0) {
984 dprintk("nfs_create_server: getattr error = %d\n", -error);
985 goto error;
986 }
987 }
988 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
989
990 dprintk("Server FSID: %llx:%llx\n",
991 (unsigned long long) server->fsid.major,
992 (unsigned long long) server->fsid.minor);
993
994 nfs_server_insert_lists(server);
995 server->mount_time = jiffies;
996 nfs_free_fattr(fattr);
997 return server;
998
999error:
1000 nfs_free_fattr(fattr);
1001 nfs_free_server(server);
1002 return ERR_PTR(error);
1003}
1004EXPORT_SYMBOL_GPL(nfs_create_server);
1005
1006/*
1007 * Clone an NFS2, NFS3 or NFS4 server record
1008 */
1009struct nfs_server *nfs_clone_server(struct nfs_server *source,
1010 struct nfs_fh *fh,
1011 struct nfs_fattr *fattr,
1012 rpc_authflavor_t flavor)
1013{
1014 struct nfs_server *server;
1015 struct nfs_fattr *fattr_fsinfo;
1016 int error;
1017
1018 server = nfs_alloc_server();
1019 if (!server)
1020 return ERR_PTR(-ENOMEM);
1021
1022 server->cred = get_cred(source->cred);
1023
1024 error = -ENOMEM;
1025 fattr_fsinfo = nfs_alloc_fattr();
1026 if (fattr_fsinfo == NULL)
1027 goto out_free_server;
1028
1029 /* Copy data from the source */
1030 server->nfs_client = source->nfs_client;
1031 server->destroy = source->destroy;
1032 refcount_inc(&server->nfs_client->cl_count);
1033 nfs_server_copy_userdata(server, source);
1034
1035 server->fsid = fattr->fsid;
1036
1037 error = nfs_init_server_rpcclient(server,
1038 source->client->cl_timeout,
1039 flavor);
1040 if (error < 0)
1041 goto out_free_server;
1042
1043 /* probe the filesystem info for this server filesystem */
1044 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1045 if (error < 0)
1046 goto out_free_server;
1047
1048 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1049 server->namelen = NFS4_MAXNAMLEN;
1050
1051 error = nfs_start_lockd(server);
1052 if (error < 0)
1053 goto out_free_server;
1054
1055 nfs_server_insert_lists(server);
1056 server->mount_time = jiffies;
1057
1058 nfs_free_fattr(fattr_fsinfo);
1059 return server;
1060
1061out_free_server:
1062 nfs_free_fattr(fattr_fsinfo);
1063 nfs_free_server(server);
1064 return ERR_PTR(error);
1065}
1066EXPORT_SYMBOL_GPL(nfs_clone_server);
1067
1068void nfs_clients_init(struct net *net)
1069{
1070 struct nfs_net *nn = net_generic(net, nfs_net_id);
1071
1072 INIT_LIST_HEAD(&nn->nfs_client_list);
1073 INIT_LIST_HEAD(&nn->nfs_volume_list);
1074#if IS_ENABLED(CONFIG_NFS_V4)
1075 idr_init(&nn->cb_ident_idr);
1076#endif
1077 spin_lock_init(&nn->nfs_client_lock);
1078 nn->boot_time = ktime_get_real();
1079
1080 nfs_netns_sysfs_setup(nn, net);
1081}
1082
1083void nfs_clients_exit(struct net *net)
1084{
1085 struct nfs_net *nn = net_generic(net, nfs_net_id);
1086
1087 nfs_netns_sysfs_destroy(nn);
1088 nfs_cleanup_cb_ident_idr(net);
1089 WARN_ON_ONCE(!list_empty(&nn->nfs_client_list));
1090 WARN_ON_ONCE(!list_empty(&nn->nfs_volume_list));
1091}
1092
1093#ifdef CONFIG_PROC_FS
1094static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1095static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1096static void nfs_server_list_stop(struct seq_file *p, void *v);
1097static int nfs_server_list_show(struct seq_file *m, void *v);
1098
1099static const struct seq_operations nfs_server_list_ops = {
1100 .start = nfs_server_list_start,
1101 .next = nfs_server_list_next,
1102 .stop = nfs_server_list_stop,
1103 .show = nfs_server_list_show,
1104};
1105
1106static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1107static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1108static void nfs_volume_list_stop(struct seq_file *p, void *v);
1109static int nfs_volume_list_show(struct seq_file *m, void *v);
1110
1111static const struct seq_operations nfs_volume_list_ops = {
1112 .start = nfs_volume_list_start,
1113 .next = nfs_volume_list_next,
1114 .stop = nfs_volume_list_stop,
1115 .show = nfs_volume_list_show,
1116};
1117
1118/*
1119 * set up the iterator to start reading from the server list and return the first item
1120 */
1121static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1122 __acquires(&nn->nfs_client_lock)
1123{
1124 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1125
1126 /* lock the list against modification */
1127 spin_lock(&nn->nfs_client_lock);
1128 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1129}
1130
1131/*
1132 * move to next server
1133 */
1134static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1135{
1136 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1137
1138 return seq_list_next(v, &nn->nfs_client_list, pos);
1139}
1140
1141/*
1142 * clean up after reading from the transports list
1143 */
1144static void nfs_server_list_stop(struct seq_file *p, void *v)
1145 __releases(&nn->nfs_client_lock)
1146{
1147 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1148
1149 spin_unlock(&nn->nfs_client_lock);
1150}
1151
1152/*
1153 * display a header line followed by a load of call lines
1154 */
1155static int nfs_server_list_show(struct seq_file *m, void *v)
1156{
1157 struct nfs_client *clp;
1158 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1159
1160 /* display header on line 1 */
1161 if (v == &nn->nfs_client_list) {
1162 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1163 return 0;
1164 }
1165
1166 /* display one transport per line on subsequent lines */
1167 clp = list_entry(v, struct nfs_client, cl_share_link);
1168
1169 /* Check if the client is initialized */
1170 if (clp->cl_cons_state != NFS_CS_READY)
1171 return 0;
1172
1173 rcu_read_lock();
1174 seq_printf(m, "v%u %s %s %3d %s\n",
1175 clp->rpc_ops->version,
1176 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1177 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1178 refcount_read(&clp->cl_count),
1179 clp->cl_hostname);
1180 rcu_read_unlock();
1181
1182 return 0;
1183}
1184
1185/*
1186 * set up the iterator to start reading from the volume list and return the first item
1187 */
1188static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1189 __acquires(&nn->nfs_client_lock)
1190{
1191 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1192
1193 /* lock the list against modification */
1194 spin_lock(&nn->nfs_client_lock);
1195 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1196}
1197
1198/*
1199 * move to next volume
1200 */
1201static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1202{
1203 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1204
1205 return seq_list_next(v, &nn->nfs_volume_list, pos);
1206}
1207
1208/*
1209 * clean up after reading from the transports list
1210 */
1211static void nfs_volume_list_stop(struct seq_file *p, void *v)
1212 __releases(&nn->nfs_client_lock)
1213{
1214 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1215
1216 spin_unlock(&nn->nfs_client_lock);
1217}
1218
1219/*
1220 * display a header line followed by a load of call lines
1221 */
1222static int nfs_volume_list_show(struct seq_file *m, void *v)
1223{
1224 struct nfs_server *server;
1225 struct nfs_client *clp;
1226 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1227 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1228 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1229
1230 /* display header on line 1 */
1231 if (v == &nn->nfs_volume_list) {
1232 seq_puts(m, "NV SERVER PORT DEV FSID"
1233 " FSC\n");
1234 return 0;
1235 }
1236 /* display one transport per line on subsequent lines */
1237 server = list_entry(v, struct nfs_server, master_link);
1238 clp = server->nfs_client;
1239
1240 snprintf(dev, sizeof(dev), "%u:%u",
1241 MAJOR(server->s_dev), MINOR(server->s_dev));
1242
1243 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1244 (unsigned long long) server->fsid.major,
1245 (unsigned long long) server->fsid.minor);
1246
1247 rcu_read_lock();
1248 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1249 clp->rpc_ops->version,
1250 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1251 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1252 dev,
1253 fsid,
1254 nfs_server_fscache_state(server));
1255 rcu_read_unlock();
1256
1257 return 0;
1258}
1259
1260int nfs_fs_proc_net_init(struct net *net)
1261{
1262 struct nfs_net *nn = net_generic(net, nfs_net_id);
1263 struct proc_dir_entry *p;
1264
1265 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1266 if (!nn->proc_nfsfs)
1267 goto error_0;
1268
1269 /* a file of servers with which we're dealing */
1270 p = proc_create_net("servers", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1271 &nfs_server_list_ops, sizeof(struct seq_net_private));
1272 if (!p)
1273 goto error_1;
1274
1275 /* a file of volumes that we have mounted */
1276 p = proc_create_net("volumes", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1277 &nfs_volume_list_ops, sizeof(struct seq_net_private));
1278 if (!p)
1279 goto error_1;
1280 return 0;
1281
1282error_1:
1283 remove_proc_subtree("nfsfs", net->proc_net);
1284error_0:
1285 return -ENOMEM;
1286}
1287
1288void nfs_fs_proc_net_exit(struct net *net)
1289{
1290 remove_proc_subtree("nfsfs", net->proc_net);
1291}
1292
1293/*
1294 * initialise the /proc/fs/nfsfs/ directory
1295 */
1296int __init nfs_fs_proc_init(void)
1297{
1298 if (!proc_mkdir("fs/nfsfs", NULL))
1299 goto error_0;
1300
1301 /* a file of servers with which we're dealing */
1302 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1303 goto error_1;
1304
1305 /* a file of volumes that we have mounted */
1306 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1307 goto error_1;
1308
1309 return 0;
1310error_1:
1311 remove_proc_subtree("fs/nfsfs", NULL);
1312error_0:
1313 return -ENOMEM;
1314}
1315
1316/*
1317 * clean up the /proc/fs/nfsfs/ directory
1318 */
1319void nfs_fs_proc_exit(void)
1320{
1321 remove_proc_subtree("fs/nfsfs", NULL);
1322}
1323
1324#endif /* CONFIG_PROC_FS */