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)
181 struct nfs_client *clp = nfs_alloc_client(cl_init);
185 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
189 if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
194 spin_lock_init(&clp->cl_lock);
195 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
196 INIT_LIST_HEAD(&clp->cl_ds_clients);
197 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
198 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
199 clp->cl_minorversion = cl_init->minorversion;
200 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
202 #if IS_ENABLED(CONFIG_NFS_V4_1)
203 init_waitqueue_head(&clp->cl_lock_waitq);
208 nfs_free_client(clp);
213 * Destroy the NFS4 callback service
215 static void nfs4_destroy_callback(struct nfs_client *clp)
217 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
218 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
221 static void nfs4_shutdown_client(struct nfs_client *clp)
223 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
224 nfs4_kill_renewd(clp);
225 clp->cl_mvops->shutdown_client(clp);
226 nfs4_destroy_callback(clp);
227 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
228 nfs_idmap_delete(clp);
230 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
231 kfree(clp->cl_serverowner);
232 kfree(clp->cl_serverscope);
233 kfree(clp->cl_implid);
234 kfree(clp->cl_owner_id);
237 void nfs4_free_client(struct nfs_client *clp)
239 nfs4_shutdown_client(clp);
240 nfs_free_client(clp);
244 * Initialize the NFS4 callback service
246 static int nfs4_init_callback(struct nfs_client *clp)
248 struct rpc_xprt *xprt;
251 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
253 if (nfs4_has_session(clp)) {
254 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
259 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
261 dprintk("%s: failed to start callback. Error = %d\n",
265 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
271 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
272 * @clp - nfs_client to initialize
274 * Returns zero on success, or a negative errno if some error occurred.
276 int nfs40_init_client(struct nfs_client *clp)
278 struct nfs4_slot_table *tbl;
281 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
285 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
286 "NFSv4.0 transport Slot table");
292 clp->cl_slot_tbl = tbl;
296 #if defined(CONFIG_NFS_V4_1)
299 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
300 * @clp - nfs_client to initialize
302 * Returns zero on success, or a negative errno if some error occurred.
304 int nfs41_init_client(struct nfs_client *clp)
306 struct nfs4_session *session = NULL;
309 * Create the session and mark it expired.
310 * When a SEQUENCE operation encounters the expired session
311 * it will do session recovery to initialize it.
313 session = nfs4_alloc_session(clp);
317 clp->cl_session = session;
320 * The create session reply races with the server back
321 * channel probe. Mark the client NFS_CS_SESSION_INITING
322 * so that the client back channel can find the
325 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
329 #endif /* CONFIG_NFS_V4_1 */
332 * Initialize the minor version specific parts of an NFS4 client record
334 static int nfs4_init_client_minor_version(struct nfs_client *clp)
338 ret = clp->cl_mvops->init_client(clp);
341 return nfs4_init_callback(clp);
345 * nfs4_init_client - Initialise an NFS4 client record
347 * @clp: nfs_client to initialise
348 * @timeparms: timeout parameters for underlying RPC transport
349 * @ip_addr: callback IP address in presentation format
350 * @authflavor: authentication flavor for underlying RPC transport
352 * Returns pointer to an NFS client, or an ERR_PTR value.
354 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
355 const struct nfs_client_initdata *cl_init)
357 char buf[INET6_ADDRSTRLEN + 1];
358 const char *ip_addr = cl_init->ip_addr;
359 struct nfs_client *old;
362 if (clp->cl_cons_state == NFS_CS_READY) {
363 /* the client is initialised already */
364 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
368 /* Check NFS protocol revision and initialize RPC op vector */
369 clp->rpc_ops = &nfs_v4_clientops;
371 if (clp->cl_minorversion != 0)
372 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
373 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
374 __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
376 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
377 if (error == -EINVAL)
378 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
382 /* If no clientaddr= option was specified, find a usable cb address */
383 if (ip_addr == NULL) {
384 struct sockaddr_storage cb_addr;
385 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
387 error = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
390 error = rpc_ntop(sap, buf, sizeof(buf));
393 ip_addr = (const char *)buf;
395 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
397 error = nfs_idmap_new(clp);
399 dprintk("%s: failed to create idmapper. Error = %d\n",
403 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
405 error = nfs4_init_client_minor_version(clp);
409 if (!nfs4_has_session(clp))
410 nfs_mark_client_ready(clp, NFS_CS_READY);
412 error = nfs4_discover_server_trunking(clp, &old);
417 clp->cl_preserve_clid = true;
422 nfs_mark_client_ready(clp, error);
424 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
425 return ERR_PTR(error);
429 * SETCLIENTID just did a callback update with the callback ident in
430 * "drop," but server trunking discovery claims "drop" and "keep" are
431 * actually the same server. Swap the callback IDs so that "keep"
432 * will continue to use the callback ident the server now knows about,
433 * and so that "keep"'s original callback ident is destroyed when
436 static void nfs4_swap_callback_idents(struct nfs_client *keep,
437 struct nfs_client *drop)
439 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
440 unsigned int save = keep->cl_cb_ident;
442 if (keep->cl_cb_ident == drop->cl_cb_ident)
445 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
446 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
448 spin_lock(&nn->nfs_client_lock);
450 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
451 keep->cl_cb_ident = drop->cl_cb_ident;
453 idr_replace(&nn->cb_ident_idr, drop, save);
454 drop->cl_cb_ident = save;
456 spin_unlock(&nn->nfs_client_lock);
459 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
460 const struct nfs_client *clp2)
462 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
464 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
468 * nfs40_walk_client_list - Find server that recognizes a client ID
470 * @new: nfs_client with client ID to test
471 * @result: OUT: found nfs_client, or new
472 * @cred: credential to use for trunking test
474 * Returns zero, a negative errno, or a negative NFS4ERR status.
475 * If zero is returned, an nfs_client pointer is planted in "result."
477 * NB: nfs40_walk_client_list() relies on the new nfs_client being
478 * the last nfs_client on the list.
480 int nfs40_walk_client_list(struct nfs_client *new,
481 struct nfs_client **result,
482 struct rpc_cred *cred)
484 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
485 struct nfs_client *pos, *prev = NULL;
486 struct nfs4_setclientid_res clid = {
487 .clientid = new->cl_clientid,
488 .confirm = new->cl_confirm,
490 int status = -NFS4ERR_STALE_CLIENTID;
492 spin_lock(&nn->nfs_client_lock);
493 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
495 if (pos->rpc_ops != new->rpc_ops)
498 if (pos->cl_minorversion != new->cl_minorversion)
501 /* If "pos" isn't marked ready, we can't trust the
502 * remaining fields in "pos" */
503 if (pos->cl_cons_state > NFS_CS_READY) {
504 atomic_inc(&pos->cl_count);
505 spin_unlock(&nn->nfs_client_lock);
507 nfs_put_client(prev);
510 status = nfs_wait_client_init_complete(pos);
513 status = -NFS4ERR_STALE_CLIENTID;
514 spin_lock(&nn->nfs_client_lock);
516 if (pos->cl_cons_state != NFS_CS_READY)
519 if (pos->cl_clientid != new->cl_clientid)
522 if (!nfs4_match_client_owner_id(pos, new))
525 atomic_inc(&pos->cl_count);
526 spin_unlock(&nn->nfs_client_lock);
528 nfs_put_client(prev);
531 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
533 case -NFS4ERR_STALE_CLIENTID:
536 nfs4_swap_callback_idents(pos, new);
540 dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
541 __func__, pos, atomic_read(&pos->cl_count));
545 /* The callback path may have been inadvertently
546 * changed. Schedule recovery!
548 nfs4_schedule_path_down_recovery(pos);
553 spin_lock(&nn->nfs_client_lock);
555 spin_unlock(&nn->nfs_client_lock);
557 /* No match found. The server lost our clientid */
559 nfs_put_client(prev);
560 dprintk("NFS: <-- %s status = %d\n", __func__, status);
564 #ifdef CONFIG_NFS_V4_1
566 * Returns true if the client IDs match
568 static bool nfs4_match_clientids(u64 a, u64 b)
571 dprintk("NFS: --> %s client ID %llx does not match %llx\n",
575 dprintk("NFS: --> %s client ID %llx matches %llx\n",
581 * Returns true if the server major ids match
584 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
585 struct nfs41_server_owner *o2)
587 if (o1->major_id_sz != o2->major_id_sz)
588 goto out_major_mismatch;
589 if (memcmp(o1->major_id, o2->major_id, o1->major_id_sz) != 0)
590 goto out_major_mismatch;
592 dprintk("NFS: --> %s server owner major IDs match\n", __func__);
596 dprintk("NFS: --> %s server owner major IDs do not match\n",
602 * Returns true if server minor ids match
605 nfs4_check_serverowner_minor_id(struct nfs41_server_owner *o1,
606 struct nfs41_server_owner *o2)
608 /* Check eir_server_owner so_minor_id */
609 if (o1->minor_id != o2->minor_id)
610 goto out_minor_mismatch;
612 dprintk("NFS: --> %s server owner minor IDs match\n", __func__);
616 dprintk("NFS: --> %s server owner minor IDs do not match\n", __func__);
621 * Returns true if the server scopes match
624 nfs4_check_server_scope(struct nfs41_server_scope *s1,
625 struct nfs41_server_scope *s2)
627 if (s1->server_scope_sz != s2->server_scope_sz)
628 goto out_scope_mismatch;
629 if (memcmp(s1->server_scope, s2->server_scope,
630 s1->server_scope_sz) != 0)
631 goto out_scope_mismatch;
633 dprintk("NFS: --> %s server scopes match\n", __func__);
637 dprintk("NFS: --> %s server scopes do not match\n",
643 * nfs4_detect_session_trunking - Checks for session trunking.
645 * Called after a successful EXCHANGE_ID on a multi-addr connection.
646 * Upon success, add the transport.
648 * @clp: original mount nfs_client
649 * @res: result structure from an exchange_id using the original mount
650 * nfs_client with a new multi_addr transport
652 * Returns zero on success, otherwise -EINVAL
654 * Note: since the exchange_id for the new multi_addr transport uses the
655 * same nfs_client from the original mount, the cl_owner_id is reused,
656 * so eir_clientowner is the same.
658 int nfs4_detect_session_trunking(struct nfs_client *clp,
659 struct nfs41_exchange_id_res *res,
660 struct rpc_xprt *xprt)
662 /* Check eir_clientid */
663 if (!nfs4_match_clientids(clp->cl_clientid, res->clientid))
666 /* Check eir_server_owner so_major_id */
667 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
671 /* Check eir_server_owner so_minor_id */
672 if (!nfs4_check_serverowner_minor_id(clp->cl_serverowner,
676 /* Check eir_server_scope */
677 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
680 /* Session trunking passed, add the xprt */
681 rpc_clnt_xprt_switch_add_xprt(clp->cl_rpcclient, xprt);
683 pr_info("NFS: %s: Session trunking succeeded for %s\n",
685 xprt->address_strings[RPC_DISPLAY_ADDR]);
689 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
690 xprt->address_strings[RPC_DISPLAY_ADDR]);
696 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
698 * @new: nfs_client with client ID to test
699 * @result: OUT: found nfs_client, or new
700 * @cred: credential to use for trunking test
702 * Returns zero, a negative errno, or a negative NFS4ERR status.
703 * If zero is returned, an nfs_client pointer is planted in "result."
705 * NB: nfs41_walk_client_list() relies on the new nfs_client being
706 * the last nfs_client on the list.
708 int nfs41_walk_client_list(struct nfs_client *new,
709 struct nfs_client **result,
710 struct rpc_cred *cred)
712 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
713 struct nfs_client *pos, *prev = NULL;
714 int status = -NFS4ERR_STALE_CLIENTID;
716 spin_lock(&nn->nfs_client_lock);
717 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
722 if (pos->rpc_ops != new->rpc_ops)
725 if (pos->cl_minorversion != new->cl_minorversion)
728 /* If "pos" isn't marked ready, we can't trust the
729 * remaining fields in "pos", especially the client
730 * ID and serverowner fields. Wait for CREATE_SESSION
732 if (pos->cl_cons_state > NFS_CS_READY) {
733 atomic_inc(&pos->cl_count);
734 spin_unlock(&nn->nfs_client_lock);
736 nfs_put_client(prev);
739 status = nfs_wait_client_init_complete(pos);
740 spin_lock(&nn->nfs_client_lock);
743 status = -NFS4ERR_STALE_CLIENTID;
745 if (pos->cl_cons_state != NFS_CS_READY)
748 if (!nfs4_match_clientids(pos->cl_clientid, new->cl_clientid))
752 * Note that session trunking is just a special subcase of
753 * client id trunking. In either case, we want to fall back
754 * to using the existing nfs_client.
756 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
757 new->cl_serverowner))
760 /* Unlike NFSv4.0, we know that NFSv4.1 always uses the
761 * uniform string, however someone might switch the
762 * uniquifier string on us.
764 if (!nfs4_match_client_owner_id(pos, new))
767 atomic_inc(&pos->cl_count);
770 dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
771 __func__, pos, atomic_read(&pos->cl_count));
775 spin_unlock(&nn->nfs_client_lock);
776 dprintk("NFS: <-- %s status = %d\n", __func__, status);
777 nfs_put_client(prev);
780 #endif /* CONFIG_NFS_V4_1 */
782 static void nfs4_destroy_server(struct nfs_server *server)
786 nfs_server_return_all_delegations(server);
787 unset_pnfs_layoutdriver(server);
788 nfs4_purge_state_owners(server, &freeme);
789 nfs4_free_state_owners(&freeme);
793 * NFSv4.0 callback thread helper
795 * Find a client by callback identifier
798 nfs4_find_client_ident(struct net *net, int cb_ident)
800 struct nfs_client *clp;
801 struct nfs_net *nn = net_generic(net, nfs_net_id);
803 spin_lock(&nn->nfs_client_lock);
804 clp = idr_find(&nn->cb_ident_idr, cb_ident);
806 atomic_inc(&clp->cl_count);
807 spin_unlock(&nn->nfs_client_lock);
811 #if defined(CONFIG_NFS_V4_1)
812 /* Common match routine for v4.0 and v4.1 callback services */
813 static bool nfs4_cb_match_client(const struct sockaddr *addr,
814 struct nfs_client *clp, u32 minorversion)
816 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
818 /* Don't match clients that failed to initialise */
819 if (!(clp->cl_cons_state == NFS_CS_READY ||
820 clp->cl_cons_state == NFS_CS_SESSION_INITING))
825 /* Match the version and minorversion */
826 if (clp->rpc_ops->version != 4 ||
827 clp->cl_minorversion != minorversion)
830 /* Match only the IP address, not the port number */
831 return rpc_cmp_addr(addr, clap);
835 * NFSv4.1 callback thread helper
836 * For CB_COMPOUND calls, find a client by IP address, protocol version,
837 * minorversion, and sessionID
839 * Returns NULL if no such client
842 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
843 struct nfs4_sessionid *sid, u32 minorversion)
845 struct nfs_client *clp;
846 struct nfs_net *nn = net_generic(net, nfs_net_id);
848 spin_lock(&nn->nfs_client_lock);
849 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
850 if (!nfs4_cb_match_client(addr, clp, minorversion))
853 if (!nfs4_has_session(clp))
857 if (memcmp(clp->cl_session->sess_id.data,
858 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
861 atomic_inc(&clp->cl_count);
862 spin_unlock(&nn->nfs_client_lock);
865 spin_unlock(&nn->nfs_client_lock);
869 #else /* CONFIG_NFS_V4_1 */
872 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
873 struct nfs4_sessionid *sid, u32 minorversion)
877 #endif /* CONFIG_NFS_V4_1 */
880 * Set up an NFS4 client
882 static int nfs4_set_client(struct nfs_server *server,
883 const char *hostname,
884 const struct sockaddr *addr,
885 const size_t addrlen,
887 rpc_authflavor_t authflavour,
888 int proto, const struct rpc_timeout *timeparms,
889 u32 minorversion, struct net *net)
891 struct nfs_client_initdata cl_init = {
892 .hostname = hostname,
898 .minorversion = minorversion,
900 .timeparms = timeparms,
902 struct nfs_client *clp;
905 dprintk("--> nfs4_set_client()\n");
907 if (server->flags & NFS_MOUNT_NORESVPORT)
908 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
909 if (server->options & NFS_OPTION_MIGRATION)
910 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
912 /* Allocate or find a client reference we can use */
913 clp = nfs_get_client(&cl_init, authflavour);
915 error = PTR_ERR(clp);
919 if (server->nfs_client == clp) {
925 * Query for the lease time on clientid setup or renewal
927 * Note that this will be set on nfs_clients that were created
928 * only for the DS role and did not set this bit, but now will
931 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
933 server->nfs_client = clp;
934 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
937 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
942 * Set up a pNFS Data Server client.
944 * Return any existing nfs_client that matches server address,port,version
947 * For a new nfs_client, use a soft mount (default), a low retrans and a
948 * low timeout interval so that if a connection is lost, we retry through
951 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
952 const struct sockaddr *ds_addr, int ds_addrlen,
953 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
954 u32 minor_version, rpc_authflavor_t au_flavor)
956 struct rpc_timeout ds_timeout;
957 struct nfs_client *mds_clp = mds_srv->nfs_client;
958 struct nfs_client_initdata cl_init = {
960 .addrlen = ds_addrlen,
961 .nodename = mds_clp->cl_rpcclient->cl_nodename,
962 .ip_addr = mds_clp->cl_ipaddr,
965 .minorversion = minor_version,
966 .net = mds_clp->cl_net,
967 .timeparms = &ds_timeout,
969 struct nfs_client *clp;
970 char buf[INET6_ADDRSTRLEN + 1];
972 if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
973 return ERR_PTR(-EINVAL);
974 cl_init.hostname = buf;
976 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
977 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
980 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
981 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
982 * (section 13.1 RFC 5661).
984 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
985 clp = nfs_get_client(&cl_init, au_flavor);
987 dprintk("<-- %s %p\n", __func__, clp);
990 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
993 * Session has been established, and the client marked ready.
994 * Limit the mount rsize, wsize and dtsize using negotiated fore
995 * channel attributes.
997 static void nfs4_session_limit_rwsize(struct nfs_server *server)
999 #ifdef CONFIG_NFS_V4_1
1000 struct nfs4_session *sess;
1004 if (!nfs4_has_session(server->nfs_client))
1006 sess = server->nfs_client->cl_session;
1007 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1008 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1010 if (server->dtsize > server_resp_sz)
1011 server->dtsize = server_resp_sz;
1012 if (server->rsize > server_resp_sz)
1013 server->rsize = server_resp_sz;
1014 if (server->wsize > server_rqst_sz)
1015 server->wsize = server_rqst_sz;
1016 #endif /* CONFIG_NFS_V4_1 */
1019 static int nfs4_server_common_setup(struct nfs_server *server,
1020 struct nfs_fh *mntfh, bool auth_probe)
1022 struct nfs_fattr *fattr;
1025 /* data servers support only a subset of NFSv4.1 */
1026 if (is_ds_only_client(server->nfs_client))
1027 return -EPROTONOSUPPORT;
1029 fattr = nfs_alloc_fattr();
1033 /* We must ensure the session is initialised first */
1034 error = nfs4_init_session(server->nfs_client);
1038 /* Set the basic capabilities */
1039 server->caps |= server->nfs_client->cl_mvops->init_caps;
1040 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1041 server->caps &= ~NFS_CAP_READDIRPLUS;
1043 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1046 if (nfs4_disable_idmapping &&
1047 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1048 server->caps |= NFS_CAP_UIDGID_NOMAP;
1051 /* Probe the root fh to retrieve its FSID and filehandle */
1052 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1056 dprintk("Server FSID: %llx:%llx\n",
1057 (unsigned long long) server->fsid.major,
1058 (unsigned long long) server->fsid.minor);
1059 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1061 error = nfs_probe_fsinfo(server, mntfh, fattr);
1065 nfs4_session_limit_rwsize(server);
1067 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1068 server->namelen = NFS4_MAXNAMLEN;
1070 nfs_server_insert_lists(server);
1071 server->mount_time = jiffies;
1072 server->destroy = nfs4_destroy_server;
1074 nfs_free_fattr(fattr);
1079 * Create a version 4 volume record
1081 static int nfs4_init_server(struct nfs_server *server,
1082 struct nfs_parsed_mount_data *data)
1084 struct rpc_timeout timeparms;
1087 dprintk("--> nfs4_init_server()\n");
1089 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1090 data->timeo, data->retrans);
1092 /* Initialise the client representation from the mount data */
1093 server->flags = data->flags;
1094 server->options = data->options;
1095 server->auth_info = data->auth_info;
1097 /* Use the first specified auth flavor. If this flavor isn't
1098 * allowed by the server, use the SECINFO path to try the
1099 * other specified flavors */
1100 if (data->auth_info.flavor_len >= 1)
1101 data->selected_flavor = data->auth_info.flavors[0];
1103 data->selected_flavor = RPC_AUTH_UNIX;
1105 /* Get a client record */
1106 error = nfs4_set_client(server,
1107 data->nfs_server.hostname,
1108 (const struct sockaddr *)&data->nfs_server.address,
1109 data->nfs_server.addrlen,
1110 data->client_address,
1111 data->selected_flavor,
1112 data->nfs_server.protocol,
1120 server->rsize = nfs_block_size(data->rsize, NULL);
1122 server->wsize = nfs_block_size(data->wsize, NULL);
1124 server->acregmin = data->acregmin * HZ;
1125 server->acregmax = data->acregmax * HZ;
1126 server->acdirmin = data->acdirmin * HZ;
1127 server->acdirmax = data->acdirmax * HZ;
1129 server->port = data->nfs_server.port;
1131 error = nfs_init_server_rpcclient(server, &timeparms,
1132 data->selected_flavor);
1136 dprintk("<-- nfs4_init_server() = %d\n", error);
1141 * Create a version 4 volume record
1142 * - keyed on server and FSID
1144 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1145 struct nfs_fh *mntfh)*/
1146 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1147 struct nfs_subversion *nfs_mod)
1149 struct nfs_server *server;
1153 dprintk("--> nfs4_create_server()\n");
1155 server = nfs_alloc_server();
1157 return ERR_PTR(-ENOMEM);
1159 auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1161 /* set up the general RPC client */
1162 error = nfs4_init_server(server, mount_info->parsed);
1166 error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1170 dprintk("<-- nfs4_create_server() = %p\n", server);
1174 nfs_free_server(server);
1175 dprintk("<-- nfs4_create_server() = error %d\n", error);
1176 return ERR_PTR(error);
1180 * Create an NFS4 referral server record
1182 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1183 struct nfs_fh *mntfh)
1185 struct nfs_client *parent_client;
1186 struct nfs_server *server, *parent_server;
1190 dprintk("--> nfs4_create_referral_server()\n");
1192 server = nfs_alloc_server();
1194 return ERR_PTR(-ENOMEM);
1196 parent_server = NFS_SB(data->sb);
1197 parent_client = parent_server->nfs_client;
1199 /* Initialise the client representation from the parent server */
1200 nfs_server_copy_userdata(server, parent_server);
1202 /* Get a client representation.
1203 * Note: NFSv4 always uses TCP, */
1204 error = nfs4_set_client(server, data->hostname,
1207 parent_client->cl_ipaddr,
1209 rpc_protocol(parent_server->client),
1210 parent_server->client->cl_timeout,
1211 parent_client->cl_mvops->minor_version,
1212 parent_client->cl_net);
1216 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1220 auth_probe = parent_server->auth_info.flavor_len < 1;
1222 error = nfs4_server_common_setup(server, mntfh, auth_probe);
1226 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1230 nfs_free_server(server);
1231 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1232 return ERR_PTR(error);
1236 * Grab the destination's particulars, including lease expiry time.
1238 * Returns zero if probe succeeded and retrieved FSID matches the FSID
1241 static int nfs_probe_destination(struct nfs_server *server)
1243 struct inode *inode = d_inode(server->super->s_root);
1244 struct nfs_fattr *fattr;
1247 fattr = nfs_alloc_fattr();
1251 /* Sanity: the probe won't work if the destination server
1252 * does not recognize the migrated FH. */
1253 error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1255 nfs_free_fattr(fattr);
1260 * nfs4_update_server - Move an nfs_server to a different nfs_client
1262 * @server: represents FSID to be moved
1263 * @hostname: new end-point's hostname
1264 * @sap: new end-point's socket address
1265 * @salen: size of "sap"
1266 * @net: net namespace
1268 * The nfs_server must be quiescent before this function is invoked.
1269 * Either its session is drained (NFSv4.1+), or its transport is
1270 * plugged and drained (NFSv4.0).
1272 * Returns zero on success, or a negative errno value.
1274 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1275 struct sockaddr *sap, size_t salen, struct net *net)
1277 struct nfs_client *clp = server->nfs_client;
1278 struct rpc_clnt *clnt = server->client;
1279 struct xprt_create xargs = {
1280 .ident = clp->cl_proto,
1284 .servername = hostname,
1286 char buf[INET6_ADDRSTRLEN + 1];
1287 struct sockaddr_storage address;
1288 struct sockaddr *localaddr = (struct sockaddr *)&address;
1291 dprintk("--> %s: move FSID %llx:%llx to \"%s\")\n", __func__,
1292 (unsigned long long)server->fsid.major,
1293 (unsigned long long)server->fsid.minor,
1296 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1298 dprintk("<-- %s(): rpc_switch_client_transport returned %d\n",
1303 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1305 dprintk("<-- %s(): rpc_localaddr returned %d\n",
1310 error = -EAFNOSUPPORT;
1311 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0) {
1312 dprintk("<-- %s(): rpc_ntop returned %d\n",
1317 nfs_server_remove_lists(server);
1318 error = nfs4_set_client(server, hostname, sap, salen, buf,
1319 clp->cl_rpcclient->cl_auth->au_flavor,
1320 clp->cl_proto, clnt->cl_timeout,
1321 clp->cl_minorversion, net);
1322 nfs_put_client(clp);
1324 nfs_server_insert_lists(server);
1325 dprintk("<-- %s(): nfs4_set_client returned %d\n",
1330 if (server->nfs_client->cl_hostname == NULL)
1331 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1332 nfs_server_insert_lists(server);
1334 error = nfs_probe_destination(server);
1338 dprintk("<-- %s() succeeded\n", __func__);