2 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3 * Written by David Howells (dhowells@redhat.com)
5 #include <linux/module.h>
6 #include <linux/nfs_fs.h>
7 #include <linux/nfs_mount.h>
8 #include <linux/sunrpc/addr.h>
9 #include <linux/sunrpc/auth.h>
10 #include <linux/sunrpc/xprt.h>
11 #include <linux/sunrpc/bc_xprt.h>
12 #include <linux/sunrpc/rpc_pipe_fs.h>
15 #include "delegation.h"
16 #include "nfs4session.h"
17 #include "nfs4idmap.h"
21 #define NFSDBG_FACILITY NFSDBG_CLIENT
24 * Get a unique NFSv4.0 callback identifier which will be used
25 * by the V4.0 callback service to lookup the nfs_client struct
27 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
30 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
32 if (clp->rpc_ops->version != 4 || minorversion != 0)
34 idr_preload(GFP_KERNEL);
35 spin_lock(&nn->nfs_client_lock);
36 ret = idr_alloc(&nn->cb_ident_idr, clp, 1, 0, GFP_NOWAIT);
38 clp->cl_cb_ident = ret;
39 spin_unlock(&nn->nfs_client_lock);
41 return ret < 0 ? ret : 0;
44 #ifdef CONFIG_NFS_V4_1
46 * Per auth flavor data server rpc clients
48 struct nfs4_ds_server {
49 struct list_head list; /* ds_clp->cl_ds_clients */
50 struct rpc_clnt *rpc_clnt;
54 * Common lookup case for DS I/O
56 static struct nfs4_ds_server *
57 nfs4_find_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
59 struct nfs4_ds_server *dss;
62 list_for_each_entry_rcu(dss, &ds_clp->cl_ds_clients, list) {
63 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
73 static struct nfs4_ds_server *
74 nfs4_add_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor,
75 struct nfs4_ds_server *new)
77 struct nfs4_ds_server *dss;
79 spin_lock(&ds_clp->cl_lock);
80 list_for_each_entry(dss, &ds_clp->cl_ds_clients, list) {
81 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
86 list_add_rcu(&new->list, &ds_clp->cl_ds_clients);
89 spin_unlock(&ds_clp->cl_lock); /* need some lock to protect list */
93 static struct nfs4_ds_server *
94 nfs4_alloc_ds_server(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
96 struct nfs4_ds_server *dss;
98 dss = kmalloc(sizeof(*dss), GFP_NOFS);
100 return ERR_PTR(-ENOMEM);
102 dss->rpc_clnt = rpc_clone_client_set_auth(ds_clp->cl_rpcclient, flavor);
103 if (IS_ERR(dss->rpc_clnt)) {
104 int err = PTR_ERR(dss->rpc_clnt);
108 INIT_LIST_HEAD(&dss->list);
114 nfs4_free_ds_server(struct nfs4_ds_server *dss)
116 rpc_release_client(dss->rpc_clnt);
121 * Find or create a DS rpc client with th MDS server rpc client auth flavor
122 * in the nfs_client cl_ds_clients list.
125 nfs4_find_or_create_ds_client(struct nfs_client *ds_clp, struct inode *inode)
127 struct nfs4_ds_server *dss, *new;
128 rpc_authflavor_t flavor = NFS_SERVER(inode)->client->cl_auth->au_flavor;
130 dss = nfs4_find_ds_client(ds_clp, flavor);
133 new = nfs4_alloc_ds_server(ds_clp, flavor);
135 return ERR_CAST(new);
136 dss = nfs4_add_ds_client(ds_clp, flavor, new);
138 nfs4_free_ds_server(new);
140 return dss->rpc_clnt;
142 EXPORT_SYMBOL_GPL(nfs4_find_or_create_ds_client);
145 nfs4_shutdown_ds_clients(struct nfs_client *clp)
147 struct nfs4_ds_server *dss;
148 LIST_HEAD(shutdown_list);
150 while (!list_empty(&clp->cl_ds_clients)) {
151 dss = list_entry(clp->cl_ds_clients.next,
152 struct nfs4_ds_server, list);
153 list_del(&dss->list);
154 rpc_shutdown_client(dss->rpc_clnt);
159 void nfs41_shutdown_client(struct nfs_client *clp)
161 if (nfs4_has_session(clp)) {
162 nfs4_shutdown_ds_clients(clp);
163 nfs4_destroy_session(clp->cl_session);
164 nfs4_destroy_clientid(clp);
168 #endif /* CONFIG_NFS_V4_1 */
170 void nfs40_shutdown_client(struct nfs_client *clp)
172 if (clp->cl_slot_tbl) {
173 nfs4_shutdown_slot_table(clp->cl_slot_tbl);
174 kfree(clp->cl_slot_tbl);
178 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *cl_init)
180 char buf[INET6_ADDRSTRLEN + 1];
181 const char *ip_addr = cl_init->ip_addr;
182 struct nfs_client *clp = nfs_alloc_client(cl_init);
188 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
192 if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
197 spin_lock_init(&clp->cl_lock);
198 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
199 INIT_LIST_HEAD(&clp->cl_ds_clients);
200 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
201 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
202 clp->cl_minorversion = cl_init->minorversion;
203 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
205 #if IS_ENABLED(CONFIG_NFS_V4_1)
206 init_waitqueue_head(&clp->cl_lock_waitq);
209 if (cl_init->minorversion != 0)
210 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
211 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
212 __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
215 * Set up the connection to the server before we add add to the
218 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
220 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
224 /* If no clientaddr= option was specified, find a usable cb address */
225 if (ip_addr == NULL) {
226 struct sockaddr_storage cb_addr;
227 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
229 err = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
232 err = rpc_ntop(sap, buf, sizeof(buf));
235 ip_addr = (const char *)buf;
237 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
239 err = nfs_idmap_new(clp);
241 dprintk("%s: failed to create idmapper. Error = %d\n",
245 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
249 nfs_free_client(clp);
254 * Destroy the NFS4 callback service
256 static void nfs4_destroy_callback(struct nfs_client *clp)
258 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
259 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
262 static void nfs4_shutdown_client(struct nfs_client *clp)
264 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
265 nfs4_kill_renewd(clp);
266 clp->cl_mvops->shutdown_client(clp);
267 nfs4_destroy_callback(clp);
268 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
269 nfs_idmap_delete(clp);
271 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
272 kfree(clp->cl_serverowner);
273 kfree(clp->cl_serverscope);
274 kfree(clp->cl_implid);
275 kfree(clp->cl_owner_id);
278 void nfs4_free_client(struct nfs_client *clp)
280 nfs4_shutdown_client(clp);
281 nfs_free_client(clp);
285 * Initialize the NFS4 callback service
287 static int nfs4_init_callback(struct nfs_client *clp)
289 struct rpc_xprt *xprt;
292 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
294 if (nfs4_has_session(clp)) {
295 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
300 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
302 dprintk("%s: failed to start callback. Error = %d\n",
306 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
312 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
313 * @clp - nfs_client to initialize
315 * Returns zero on success, or a negative errno if some error occurred.
317 int nfs40_init_client(struct nfs_client *clp)
319 struct nfs4_slot_table *tbl;
322 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
326 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
327 "NFSv4.0 transport Slot table");
333 clp->cl_slot_tbl = tbl;
337 #if defined(CONFIG_NFS_V4_1)
340 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
341 * @clp - nfs_client to initialize
343 * Returns zero on success, or a negative errno if some error occurred.
345 int nfs41_init_client(struct nfs_client *clp)
347 struct nfs4_session *session = NULL;
350 * Create the session and mark it expired.
351 * When a SEQUENCE operation encounters the expired session
352 * it will do session recovery to initialize it.
354 session = nfs4_alloc_session(clp);
358 clp->cl_session = session;
361 * The create session reply races with the server back
362 * channel probe. Mark the client NFS_CS_SESSION_INITING
363 * so that the client back channel can find the
366 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
370 #endif /* CONFIG_NFS_V4_1 */
373 * Initialize the minor version specific parts of an NFS4 client record
375 static int nfs4_init_client_minor_version(struct nfs_client *clp)
379 ret = clp->cl_mvops->init_client(clp);
382 return nfs4_init_callback(clp);
386 * nfs4_init_client - Initialise an NFS4 client record
388 * @clp: nfs_client to initialise
389 * @timeparms: timeout parameters for underlying RPC transport
390 * @ip_addr: callback IP address in presentation format
391 * @authflavor: authentication flavor for underlying RPC transport
393 * Returns pointer to an NFS client, or an ERR_PTR value.
395 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
396 const struct nfs_client_initdata *cl_init)
398 struct nfs_client *old;
401 if (clp->cl_cons_state == NFS_CS_READY) {
402 /* the client is initialised already */
403 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
407 error = nfs4_init_client_minor_version(clp);
411 if (!nfs4_has_session(clp))
412 nfs_mark_client_ready(clp, NFS_CS_READY);
414 error = nfs4_discover_server_trunking(clp, &old);
419 clp->cl_preserve_clid = true;
424 nfs_mark_client_ready(clp, error);
426 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
427 return ERR_PTR(error);
431 * SETCLIENTID just did a callback update with the callback ident in
432 * "drop," but server trunking discovery claims "drop" and "keep" are
433 * actually the same server. Swap the callback IDs so that "keep"
434 * will continue to use the callback ident the server now knows about,
435 * and so that "keep"'s original callback ident is destroyed when
438 static void nfs4_swap_callback_idents(struct nfs_client *keep,
439 struct nfs_client *drop)
441 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
442 unsigned int save = keep->cl_cb_ident;
444 if (keep->cl_cb_ident == drop->cl_cb_ident)
447 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
448 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
450 spin_lock(&nn->nfs_client_lock);
452 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
453 keep->cl_cb_ident = drop->cl_cb_ident;
455 idr_replace(&nn->cb_ident_idr, drop, save);
456 drop->cl_cb_ident = save;
458 spin_unlock(&nn->nfs_client_lock);
461 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
462 const struct nfs_client *clp2)
464 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
466 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
470 * nfs40_walk_client_list - Find server that recognizes a client ID
472 * @new: nfs_client with client ID to test
473 * @result: OUT: found nfs_client, or new
474 * @cred: credential to use for trunking test
476 * Returns zero, a negative errno, or a negative NFS4ERR status.
477 * If zero is returned, an nfs_client pointer is planted in "result."
479 * NB: nfs40_walk_client_list() relies on the new nfs_client being
480 * the last nfs_client on the list.
482 int nfs40_walk_client_list(struct nfs_client *new,
483 struct nfs_client **result,
484 struct rpc_cred *cred)
486 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
487 struct nfs_client *pos, *prev = NULL;
488 struct nfs4_setclientid_res clid = {
489 .clientid = new->cl_clientid,
490 .confirm = new->cl_confirm,
492 int status = -NFS4ERR_STALE_CLIENTID;
494 spin_lock(&nn->nfs_client_lock);
495 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
497 if (pos->rpc_ops != new->rpc_ops)
500 if (pos->cl_minorversion != new->cl_minorversion)
503 /* If "pos" isn't marked ready, we can't trust the
504 * remaining fields in "pos" */
505 if (pos->cl_cons_state > NFS_CS_READY) {
506 atomic_inc(&pos->cl_count);
507 spin_unlock(&nn->nfs_client_lock);
509 nfs_put_client(prev);
512 status = nfs_wait_client_init_complete(pos);
515 status = -NFS4ERR_STALE_CLIENTID;
516 spin_lock(&nn->nfs_client_lock);
518 if (pos->cl_cons_state != NFS_CS_READY)
521 if (pos->cl_clientid != new->cl_clientid)
524 if (!nfs4_match_client_owner_id(pos, new))
527 atomic_inc(&pos->cl_count);
528 spin_unlock(&nn->nfs_client_lock);
530 nfs_put_client(prev);
533 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
535 case -NFS4ERR_STALE_CLIENTID:
538 nfs4_swap_callback_idents(pos, new);
542 dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
543 __func__, pos, atomic_read(&pos->cl_count));
547 /* The callback path may have been inadvertently
548 * changed. Schedule recovery!
550 nfs4_schedule_path_down_recovery(pos);
555 spin_lock(&nn->nfs_client_lock);
557 spin_unlock(&nn->nfs_client_lock);
559 /* No match found. The server lost our clientid */
561 nfs_put_client(prev);
562 dprintk("NFS: <-- %s status = %d\n", __func__, status);
566 #ifdef CONFIG_NFS_V4_1
568 * Returns true if the client IDs match
570 static bool nfs4_match_clientids(u64 a, u64 b)
573 dprintk("NFS: --> %s client ID %llx does not match %llx\n",
577 dprintk("NFS: --> %s client ID %llx matches %llx\n",
583 * Returns true if the server major ids match
586 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
587 struct nfs41_server_owner *o2)
589 if (o1->major_id_sz != o2->major_id_sz)
590 goto out_major_mismatch;
591 if (memcmp(o1->major_id, o2->major_id, o1->major_id_sz) != 0)
592 goto out_major_mismatch;
594 dprintk("NFS: --> %s server owner major IDs match\n", __func__);
598 dprintk("NFS: --> %s server owner major IDs do not match\n",
604 * Returns true if server minor ids match
607 nfs4_check_serverowner_minor_id(struct nfs41_server_owner *o1,
608 struct nfs41_server_owner *o2)
610 /* Check eir_server_owner so_minor_id */
611 if (o1->minor_id != o2->minor_id)
612 goto out_minor_mismatch;
614 dprintk("NFS: --> %s server owner minor IDs match\n", __func__);
618 dprintk("NFS: --> %s server owner minor IDs do not match\n", __func__);
623 * Returns true if the server scopes match
626 nfs4_check_server_scope(struct nfs41_server_scope *s1,
627 struct nfs41_server_scope *s2)
629 if (s1->server_scope_sz != s2->server_scope_sz)
630 goto out_scope_mismatch;
631 if (memcmp(s1->server_scope, s2->server_scope,
632 s1->server_scope_sz) != 0)
633 goto out_scope_mismatch;
635 dprintk("NFS: --> %s server scopes match\n", __func__);
639 dprintk("NFS: --> %s server scopes do not match\n",
645 * nfs4_detect_session_trunking - Checks for session trunking.
647 * Called after a successful EXCHANGE_ID on a multi-addr connection.
648 * Upon success, add the transport.
650 * @clp: original mount nfs_client
651 * @res: result structure from an exchange_id using the original mount
652 * nfs_client with a new multi_addr transport
654 * Returns zero on success, otherwise -EINVAL
656 * Note: since the exchange_id for the new multi_addr transport uses the
657 * same nfs_client from the original mount, the cl_owner_id is reused,
658 * so eir_clientowner is the same.
660 int nfs4_detect_session_trunking(struct nfs_client *clp,
661 struct nfs41_exchange_id_res *res,
662 struct rpc_xprt *xprt)
664 /* Check eir_clientid */
665 if (!nfs4_match_clientids(clp->cl_clientid, res->clientid))
668 /* Check eir_server_owner so_major_id */
669 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
673 /* Check eir_server_owner so_minor_id */
674 if (!nfs4_check_serverowner_minor_id(clp->cl_serverowner,
678 /* Check eir_server_scope */
679 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
682 /* Session trunking passed, add the xprt */
683 rpc_clnt_xprt_switch_add_xprt(clp->cl_rpcclient, xprt);
685 pr_info("NFS: %s: Session trunking succeeded for %s\n",
687 xprt->address_strings[RPC_DISPLAY_ADDR]);
691 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
692 xprt->address_strings[RPC_DISPLAY_ADDR]);
698 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
700 * @new: nfs_client with client ID to test
701 * @result: OUT: found nfs_client, or new
702 * @cred: credential to use for trunking test
704 * Returns zero, a negative errno, or a negative NFS4ERR status.
705 * If zero is returned, an nfs_client pointer is planted in "result."
707 * NB: nfs41_walk_client_list() relies on the new nfs_client being
708 * the last nfs_client on the list.
710 int nfs41_walk_client_list(struct nfs_client *new,
711 struct nfs_client **result,
712 struct rpc_cred *cred)
714 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
715 struct nfs_client *pos, *prev = NULL;
716 int status = -NFS4ERR_STALE_CLIENTID;
718 spin_lock(&nn->nfs_client_lock);
719 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
724 if (pos->rpc_ops != new->rpc_ops)
727 if (pos->cl_minorversion != new->cl_minorversion)
730 /* If "pos" isn't marked ready, we can't trust the
731 * remaining fields in "pos", especially the client
732 * ID and serverowner fields. Wait for CREATE_SESSION
734 if (pos->cl_cons_state > NFS_CS_READY) {
735 atomic_inc(&pos->cl_count);
736 spin_unlock(&nn->nfs_client_lock);
738 nfs_put_client(prev);
741 status = nfs_wait_client_init_complete(pos);
742 spin_lock(&nn->nfs_client_lock);
745 status = -NFS4ERR_STALE_CLIENTID;
747 if (pos->cl_cons_state != NFS_CS_READY)
750 if (!nfs4_match_clientids(pos->cl_clientid, new->cl_clientid))
754 * Note that session trunking is just a special subcase of
755 * client id trunking. In either case, we want to fall back
756 * to using the existing nfs_client.
758 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
759 new->cl_serverowner))
762 /* Unlike NFSv4.0, we know that NFSv4.1 always uses the
763 * uniform string, however someone might switch the
764 * uniquifier string on us.
766 if (!nfs4_match_client_owner_id(pos, new))
769 atomic_inc(&pos->cl_count);
772 dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
773 __func__, pos, atomic_read(&pos->cl_count));
777 spin_unlock(&nn->nfs_client_lock);
778 dprintk("NFS: <-- %s status = %d\n", __func__, status);
779 nfs_put_client(prev);
782 #endif /* CONFIG_NFS_V4_1 */
784 static void nfs4_destroy_server(struct nfs_server *server)
788 nfs_server_return_all_delegations(server);
789 unset_pnfs_layoutdriver(server);
790 nfs4_purge_state_owners(server, &freeme);
791 nfs4_free_state_owners(&freeme);
795 * NFSv4.0 callback thread helper
797 * Find a client by callback identifier
800 nfs4_find_client_ident(struct net *net, int cb_ident)
802 struct nfs_client *clp;
803 struct nfs_net *nn = net_generic(net, nfs_net_id);
805 spin_lock(&nn->nfs_client_lock);
806 clp = idr_find(&nn->cb_ident_idr, cb_ident);
808 atomic_inc(&clp->cl_count);
809 spin_unlock(&nn->nfs_client_lock);
813 #if defined(CONFIG_NFS_V4_1)
814 /* Common match routine for v4.0 and v4.1 callback services */
815 static bool nfs4_cb_match_client(const struct sockaddr *addr,
816 struct nfs_client *clp, u32 minorversion)
818 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
820 /* Don't match clients that failed to initialise */
821 if (!(clp->cl_cons_state == NFS_CS_READY ||
822 clp->cl_cons_state == NFS_CS_SESSION_INITING))
827 /* Match the version and minorversion */
828 if (clp->rpc_ops->version != 4 ||
829 clp->cl_minorversion != minorversion)
832 /* Match only the IP address, not the port number */
833 return rpc_cmp_addr(addr, clap);
837 * NFSv4.1 callback thread helper
838 * For CB_COMPOUND calls, find a client by IP address, protocol version,
839 * minorversion, and sessionID
841 * Returns NULL if no such client
844 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
845 struct nfs4_sessionid *sid, u32 minorversion)
847 struct nfs_client *clp;
848 struct nfs_net *nn = net_generic(net, nfs_net_id);
850 spin_lock(&nn->nfs_client_lock);
851 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
852 if (!nfs4_cb_match_client(addr, clp, minorversion))
855 if (!nfs4_has_session(clp))
859 if (memcmp(clp->cl_session->sess_id.data,
860 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
863 atomic_inc(&clp->cl_count);
864 spin_unlock(&nn->nfs_client_lock);
867 spin_unlock(&nn->nfs_client_lock);
871 #else /* CONFIG_NFS_V4_1 */
874 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
875 struct nfs4_sessionid *sid, u32 minorversion)
879 #endif /* CONFIG_NFS_V4_1 */
882 * Set up an NFS4 client
884 static int nfs4_set_client(struct nfs_server *server,
885 const char *hostname,
886 const struct sockaddr *addr,
887 const size_t addrlen,
889 rpc_authflavor_t authflavour,
890 int proto, const struct rpc_timeout *timeparms,
891 u32 minorversion, struct net *net)
893 struct nfs_client_initdata cl_init = {
894 .hostname = hostname,
900 .minorversion = minorversion,
902 .timeparms = timeparms,
904 struct nfs_client *clp;
907 dprintk("--> nfs4_set_client()\n");
909 if (server->flags & NFS_MOUNT_NORESVPORT)
910 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
911 if (server->options & NFS_OPTION_MIGRATION)
912 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
914 /* Allocate or find a client reference we can use */
915 clp = nfs_get_client(&cl_init, authflavour);
917 error = PTR_ERR(clp);
921 if (server->nfs_client == clp) {
927 * Query for the lease time on clientid setup or renewal
929 * Note that this will be set on nfs_clients that were created
930 * only for the DS role and did not set this bit, but now will
933 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
935 server->nfs_client = clp;
936 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
939 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
944 * Set up a pNFS Data Server client.
946 * Return any existing nfs_client that matches server address,port,version
949 * For a new nfs_client, use a soft mount (default), a low retrans and a
950 * low timeout interval so that if a connection is lost, we retry through
953 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
954 const struct sockaddr *ds_addr, int ds_addrlen,
955 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
956 u32 minor_version, rpc_authflavor_t au_flavor)
958 struct rpc_timeout ds_timeout;
959 struct nfs_client *mds_clp = mds_srv->nfs_client;
960 struct nfs_client_initdata cl_init = {
962 .addrlen = ds_addrlen,
963 .nodename = mds_clp->cl_rpcclient->cl_nodename,
964 .ip_addr = mds_clp->cl_ipaddr,
967 .minorversion = minor_version,
968 .net = mds_clp->cl_net,
969 .timeparms = &ds_timeout,
971 struct nfs_client *clp;
972 char buf[INET6_ADDRSTRLEN + 1];
974 if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
975 return ERR_PTR(-EINVAL);
976 cl_init.hostname = buf;
978 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
979 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
982 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
983 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
984 * (section 13.1 RFC 5661).
986 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
987 clp = nfs_get_client(&cl_init, au_flavor);
989 dprintk("<-- %s %p\n", __func__, clp);
992 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
995 * Session has been established, and the client marked ready.
996 * Limit the mount rsize, wsize and dtsize using negotiated fore
997 * channel attributes.
999 static void nfs4_session_limit_rwsize(struct nfs_server *server)
1001 #ifdef CONFIG_NFS_V4_1
1002 struct nfs4_session *sess;
1006 if (!nfs4_has_session(server->nfs_client))
1008 sess = server->nfs_client->cl_session;
1009 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1010 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1012 if (server->dtsize > server_resp_sz)
1013 server->dtsize = server_resp_sz;
1014 if (server->rsize > server_resp_sz)
1015 server->rsize = server_resp_sz;
1016 if (server->wsize > server_rqst_sz)
1017 server->wsize = server_rqst_sz;
1018 #endif /* CONFIG_NFS_V4_1 */
1021 static int nfs4_server_common_setup(struct nfs_server *server,
1022 struct nfs_fh *mntfh, bool auth_probe)
1024 struct nfs_fattr *fattr;
1027 /* data servers support only a subset of NFSv4.1 */
1028 if (is_ds_only_client(server->nfs_client))
1029 return -EPROTONOSUPPORT;
1031 fattr = nfs_alloc_fattr();
1035 /* We must ensure the session is initialised first */
1036 error = nfs4_init_session(server->nfs_client);
1040 /* Set the basic capabilities */
1041 server->caps |= server->nfs_client->cl_mvops->init_caps;
1042 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1043 server->caps &= ~NFS_CAP_READDIRPLUS;
1045 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1048 if (nfs4_disable_idmapping &&
1049 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1050 server->caps |= NFS_CAP_UIDGID_NOMAP;
1053 /* Probe the root fh to retrieve its FSID and filehandle */
1054 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1058 dprintk("Server FSID: %llx:%llx\n",
1059 (unsigned long long) server->fsid.major,
1060 (unsigned long long) server->fsid.minor);
1061 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1063 error = nfs_probe_fsinfo(server, mntfh, fattr);
1067 nfs4_session_limit_rwsize(server);
1069 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1070 server->namelen = NFS4_MAXNAMLEN;
1072 nfs_server_insert_lists(server);
1073 server->mount_time = jiffies;
1074 server->destroy = nfs4_destroy_server;
1076 nfs_free_fattr(fattr);
1081 * Create a version 4 volume record
1083 static int nfs4_init_server(struct nfs_server *server,
1084 struct nfs_parsed_mount_data *data)
1086 struct rpc_timeout timeparms;
1089 dprintk("--> nfs4_init_server()\n");
1091 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1092 data->timeo, data->retrans);
1094 /* Initialise the client representation from the mount data */
1095 server->flags = data->flags;
1096 server->options = data->options;
1097 server->auth_info = data->auth_info;
1099 /* Use the first specified auth flavor. If this flavor isn't
1100 * allowed by the server, use the SECINFO path to try the
1101 * other specified flavors */
1102 if (data->auth_info.flavor_len >= 1)
1103 data->selected_flavor = data->auth_info.flavors[0];
1105 data->selected_flavor = RPC_AUTH_UNIX;
1107 /* Get a client record */
1108 error = nfs4_set_client(server,
1109 data->nfs_server.hostname,
1110 (const struct sockaddr *)&data->nfs_server.address,
1111 data->nfs_server.addrlen,
1112 data->client_address,
1113 data->selected_flavor,
1114 data->nfs_server.protocol,
1122 server->rsize = nfs_block_size(data->rsize, NULL);
1124 server->wsize = nfs_block_size(data->wsize, NULL);
1126 server->acregmin = data->acregmin * HZ;
1127 server->acregmax = data->acregmax * HZ;
1128 server->acdirmin = data->acdirmin * HZ;
1129 server->acdirmax = data->acdirmax * HZ;
1131 server->port = data->nfs_server.port;
1133 error = nfs_init_server_rpcclient(server, &timeparms,
1134 data->selected_flavor);
1138 dprintk("<-- nfs4_init_server() = %d\n", error);
1143 * Create a version 4 volume record
1144 * - keyed on server and FSID
1146 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1147 struct nfs_fh *mntfh)*/
1148 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1149 struct nfs_subversion *nfs_mod)
1151 struct nfs_server *server;
1155 dprintk("--> nfs4_create_server()\n");
1157 server = nfs_alloc_server();
1159 return ERR_PTR(-ENOMEM);
1161 auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1163 /* set up the general RPC client */
1164 error = nfs4_init_server(server, mount_info->parsed);
1168 error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1172 dprintk("<-- nfs4_create_server() = %p\n", server);
1176 nfs_free_server(server);
1177 dprintk("<-- nfs4_create_server() = error %d\n", error);
1178 return ERR_PTR(error);
1182 * Create an NFS4 referral server record
1184 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1185 struct nfs_fh *mntfh)
1187 struct nfs_client *parent_client;
1188 struct nfs_server *server, *parent_server;
1192 dprintk("--> nfs4_create_referral_server()\n");
1194 server = nfs_alloc_server();
1196 return ERR_PTR(-ENOMEM);
1198 parent_server = NFS_SB(data->sb);
1199 parent_client = parent_server->nfs_client;
1201 /* Initialise the client representation from the parent server */
1202 nfs_server_copy_userdata(server, parent_server);
1204 /* Get a client representation.
1205 * Note: NFSv4 always uses TCP, */
1206 error = nfs4_set_client(server, data->hostname,
1209 parent_client->cl_ipaddr,
1211 rpc_protocol(parent_server->client),
1212 parent_server->client->cl_timeout,
1213 parent_client->cl_mvops->minor_version,
1214 parent_client->cl_net);
1218 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1222 auth_probe = parent_server->auth_info.flavor_len < 1;
1224 error = nfs4_server_common_setup(server, mntfh, auth_probe);
1228 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1232 nfs_free_server(server);
1233 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1234 return ERR_PTR(error);
1238 * Grab the destination's particulars, including lease expiry time.
1240 * Returns zero if probe succeeded and retrieved FSID matches the FSID
1243 static int nfs_probe_destination(struct nfs_server *server)
1245 struct inode *inode = d_inode(server->super->s_root);
1246 struct nfs_fattr *fattr;
1249 fattr = nfs_alloc_fattr();
1253 /* Sanity: the probe won't work if the destination server
1254 * does not recognize the migrated FH. */
1255 error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1257 nfs_free_fattr(fattr);
1262 * nfs4_update_server - Move an nfs_server to a different nfs_client
1264 * @server: represents FSID to be moved
1265 * @hostname: new end-point's hostname
1266 * @sap: new end-point's socket address
1267 * @salen: size of "sap"
1268 * @net: net namespace
1270 * The nfs_server must be quiescent before this function is invoked.
1271 * Either its session is drained (NFSv4.1+), or its transport is
1272 * plugged and drained (NFSv4.0).
1274 * Returns zero on success, or a negative errno value.
1276 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1277 struct sockaddr *sap, size_t salen, struct net *net)
1279 struct nfs_client *clp = server->nfs_client;
1280 struct rpc_clnt *clnt = server->client;
1281 struct xprt_create xargs = {
1282 .ident = clp->cl_proto,
1286 .servername = hostname,
1288 char buf[INET6_ADDRSTRLEN + 1];
1289 struct sockaddr_storage address;
1290 struct sockaddr *localaddr = (struct sockaddr *)&address;
1293 dprintk("--> %s: move FSID %llx:%llx to \"%s\")\n", __func__,
1294 (unsigned long long)server->fsid.major,
1295 (unsigned long long)server->fsid.minor,
1298 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1300 dprintk("<-- %s(): rpc_switch_client_transport returned %d\n",
1305 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1307 dprintk("<-- %s(): rpc_localaddr returned %d\n",
1312 error = -EAFNOSUPPORT;
1313 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0) {
1314 dprintk("<-- %s(): rpc_ntop returned %d\n",
1319 nfs_server_remove_lists(server);
1320 error = nfs4_set_client(server, hostname, sap, salen, buf,
1321 clp->cl_rpcclient->cl_auth->au_flavor,
1322 clp->cl_proto, clnt->cl_timeout,
1323 clp->cl_minorversion, net);
1324 nfs_put_client(clp);
1326 nfs_server_insert_lists(server);
1327 dprintk("<-- %s(): nfs4_set_client returned %d\n",
1332 if (server->nfs_client->cl_hostname == NULL)
1333 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1334 nfs_server_insert_lists(server);
1336 error = nfs_probe_destination(server);
1340 dprintk("<-- %s() succeeded\n", __func__);