GNU Linux-libre 4.14.332-gnu1
[releases.git] / fs / nfs / nfs4client.c
1 /*
2  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3  * Written by David Howells (dhowells@redhat.com)
4  */
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>
13 #include "internal.h"
14 #include "callback.h"
15 #include "delegation.h"
16 #include "nfs4session.h"
17 #include "nfs4idmap.h"
18 #include "pnfs.h"
19 #include "netns.h"
20
21 #define NFSDBG_FACILITY         NFSDBG_CLIENT
22
23 /*
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
26  */
27 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
28 {
29         int ret = 0;
30         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
31
32         if (clp->rpc_ops->version != 4 || minorversion != 0)
33                 return ret;
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);
37         if (ret >= 0)
38                 clp->cl_cb_ident = ret;
39         spin_unlock(&nn->nfs_client_lock);
40         idr_preload_end();
41         return ret < 0 ? ret : 0;
42 }
43
44 #ifdef CONFIG_NFS_V4_1
45 /**
46  * Per auth flavor data server rpc clients
47  */
48 struct nfs4_ds_server {
49         struct list_head        list;   /* ds_clp->cl_ds_clients */
50         struct rpc_clnt         *rpc_clnt;
51 };
52
53 /**
54  * Common lookup case for DS I/O
55  */
56 static struct nfs4_ds_server *
57 nfs4_find_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
58 {
59         struct nfs4_ds_server *dss;
60
61         rcu_read_lock();
62         list_for_each_entry_rcu(dss, &ds_clp->cl_ds_clients, list) {
63                 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
64                         continue;
65                 goto out;
66         }
67         dss = NULL;
68 out:
69         rcu_read_unlock();
70         return dss;
71 }
72
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)
76 {
77         struct nfs4_ds_server *dss;
78
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)
82                         continue;
83                 goto out;
84         }
85         if (new)
86                 list_add_rcu(&new->list, &ds_clp->cl_ds_clients);
87         dss = new;
88 out:
89         spin_unlock(&ds_clp->cl_lock); /* need some lock to protect list */
90         return dss;
91 }
92
93 static struct nfs4_ds_server *
94 nfs4_alloc_ds_server(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
95 {
96         struct nfs4_ds_server *dss;
97
98         dss = kmalloc(sizeof(*dss), GFP_NOFS);
99         if (dss == NULL)
100                 return ERR_PTR(-ENOMEM);
101
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);
105                 kfree (dss);
106                 return ERR_PTR(err);
107         }
108         INIT_LIST_HEAD(&dss->list);
109
110         return dss;
111 }
112
113 static void
114 nfs4_free_ds_server(struct nfs4_ds_server *dss)
115 {
116         rpc_release_client(dss->rpc_clnt);
117         kfree(dss);
118 }
119
120 /**
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.
123 */
124 struct rpc_clnt *
125 nfs4_find_or_create_ds_client(struct nfs_client *ds_clp, struct inode *inode)
126 {
127         struct nfs4_ds_server *dss, *new;
128         rpc_authflavor_t flavor = NFS_SERVER(inode)->client->cl_auth->au_flavor;
129
130         dss = nfs4_find_ds_client(ds_clp, flavor);
131         if (dss != NULL)
132                 goto out;
133         new = nfs4_alloc_ds_server(ds_clp, flavor);
134         if (IS_ERR(new))
135                 return ERR_CAST(new);
136         dss = nfs4_add_ds_client(ds_clp, flavor, new);
137         if (dss != new)
138                 nfs4_free_ds_server(new);
139 out:
140         return dss->rpc_clnt;
141 }
142 EXPORT_SYMBOL_GPL(nfs4_find_or_create_ds_client);
143
144 static void
145 nfs4_shutdown_ds_clients(struct nfs_client *clp)
146 {
147         struct nfs4_ds_server *dss;
148         LIST_HEAD(shutdown_list);
149
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);
155                 kfree (dss);
156         }
157 }
158
159 void nfs41_shutdown_client(struct nfs_client *clp)
160 {
161         if (nfs4_has_session(clp)) {
162                 nfs4_shutdown_ds_clients(clp);
163                 nfs4_destroy_session(clp->cl_session);
164                 nfs4_destroy_clientid(clp);
165         }
166
167 }
168 #endif  /* CONFIG_NFS_V4_1 */
169
170 void nfs40_shutdown_client(struct nfs_client *clp)
171 {
172         if (clp->cl_slot_tbl) {
173                 nfs4_shutdown_slot_table(clp->cl_slot_tbl);
174                 kfree(clp->cl_slot_tbl);
175         }
176 }
177
178 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *cl_init)
179 {
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);
183         int err;
184
185         if (IS_ERR(clp))
186                 return clp;
187
188         err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
189         if (err)
190                 goto error;
191
192         if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
193                 err = -EINVAL;
194                 goto error;
195         }
196
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];
204         clp->cl_mig_gen = 1;
205 #if IS_ENABLED(CONFIG_NFS_V4_1)
206         init_waitqueue_head(&clp->cl_lock_waitq);
207 #endif
208
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);
213
214         /*
215          * Set up the connection to the server before we add add to the
216          * global list.
217          */
218         err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
219         if (err == -EINVAL)
220                 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
221         if (err < 0)
222                 goto error;
223
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;
228
229                 err = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
230                 if (err < 0)
231                         goto error;
232                 err = rpc_ntop(sap, buf, sizeof(buf));
233                 if (err < 0)
234                         goto error;
235                 ip_addr = (const char *)buf;
236         }
237         strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
238
239         err = nfs_idmap_new(clp);
240         if (err < 0) {
241                 dprintk("%s: failed to create idmapper. Error = %d\n",
242                         __func__, err);
243                 goto error;
244         }
245         __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
246         return clp;
247
248 error:
249         nfs_free_client(clp);
250         return ERR_PTR(err);
251 }
252
253 /*
254  * Destroy the NFS4 callback service
255  */
256 static void nfs4_destroy_callback(struct nfs_client *clp)
257 {
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);
260 }
261
262 static void nfs4_shutdown_client(struct nfs_client *clp)
263 {
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);
270
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);
276 }
277
278 void nfs4_free_client(struct nfs_client *clp)
279 {
280         nfs4_shutdown_client(clp);
281         nfs_free_client(clp);
282 }
283
284 /*
285  * Initialize the NFS4 callback service
286  */
287 static int nfs4_init_callback(struct nfs_client *clp)
288 {
289         struct rpc_xprt *xprt;
290         int error;
291
292         xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
293
294         if (nfs4_has_session(clp)) {
295                 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
296                 if (error < 0)
297                         return error;
298         }
299
300         error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
301         if (error < 0) {
302                 dprintk("%s: failed to start callback. Error = %d\n",
303                         __func__, error);
304                 return error;
305         }
306         __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
307
308         return 0;
309 }
310
311 /**
312  * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
313  * @clp - nfs_client to initialize
314  *
315  * Returns zero on success, or a negative errno if some error occurred.
316  */
317 int nfs40_init_client(struct nfs_client *clp)
318 {
319         struct nfs4_slot_table *tbl;
320         int ret;
321
322         tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
323         if (tbl == NULL)
324                 return -ENOMEM;
325
326         ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
327                                         "NFSv4.0 transport Slot table");
328         if (ret) {
329                 nfs4_shutdown_slot_table(tbl);
330                 kfree(tbl);
331                 return ret;
332         }
333
334         clp->cl_slot_tbl = tbl;
335         return 0;
336 }
337
338 #if defined(CONFIG_NFS_V4_1)
339
340 /**
341  * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
342  * @clp - nfs_client to initialize
343  *
344  * Returns zero on success, or a negative errno if some error occurred.
345  */
346 int nfs41_init_client(struct nfs_client *clp)
347 {
348         struct nfs4_session *session = NULL;
349
350         /*
351          * Create the session and mark it expired.
352          * When a SEQUENCE operation encounters the expired session
353          * it will do session recovery to initialize it.
354          */
355         session = nfs4_alloc_session(clp);
356         if (!session)
357                 return -ENOMEM;
358
359         clp->cl_session = session;
360
361         /*
362          * The create session reply races with the server back
363          * channel probe. Mark the client NFS_CS_SESSION_INITING
364          * so that the client back channel can find the
365          * nfs_client struct
366          */
367         nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
368         return 0;
369 }
370
371 #endif  /* CONFIG_NFS_V4_1 */
372
373 /*
374  * Initialize the minor version specific parts of an NFS4 client record
375  */
376 static int nfs4_init_client_minor_version(struct nfs_client *clp)
377 {
378         int ret;
379
380         ret = clp->cl_mvops->init_client(clp);
381         if (ret)
382                 return ret;
383         return nfs4_init_callback(clp);
384 }
385
386 /**
387  * nfs4_init_client - Initialise an NFS4 client record
388  *
389  * @clp: nfs_client to initialise
390  * @timeparms: timeout parameters for underlying RPC transport
391  * @ip_addr: callback IP address in presentation format
392  * @authflavor: authentication flavor for underlying RPC transport
393  *
394  * Returns pointer to an NFS client, or an ERR_PTR value.
395  */
396 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
397                                     const struct nfs_client_initdata *cl_init)
398 {
399         struct nfs_client *old;
400         int error;
401
402         if (clp->cl_cons_state == NFS_CS_READY)
403                 /* the client is initialised already */
404                 return clp;
405
406         error = nfs4_init_client_minor_version(clp);
407         if (error < 0)
408                 goto error;
409
410         error = nfs4_discover_server_trunking(clp, &old);
411         if (error < 0)
412                 goto error;
413
414         if (clp != old) {
415                 clp->cl_preserve_clid = true;
416                 /*
417                  * Mark the client as having failed initialization so other
418                  * processes walking the nfs_client_list in nfs_match_client()
419                  * won't try to use it.
420                  */
421                 nfs_mark_client_ready(clp, -EPERM);
422         }
423         clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
424         nfs_put_client(clp);
425         return old;
426
427 error:
428         nfs_mark_client_ready(clp, error);
429         nfs_put_client(clp);
430         return ERR_PTR(error);
431 }
432
433 /*
434  * SETCLIENTID just did a callback update with the callback ident in
435  * "drop," but server trunking discovery claims "drop" and "keep" are
436  * actually the same server.  Swap the callback IDs so that "keep"
437  * will continue to use the callback ident the server now knows about,
438  * and so that "keep"'s original callback ident is destroyed when
439  * "drop" is freed.
440  */
441 static void nfs4_swap_callback_idents(struct nfs_client *keep,
442                                       struct nfs_client *drop)
443 {
444         struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
445         unsigned int save = keep->cl_cb_ident;
446
447         if (keep->cl_cb_ident == drop->cl_cb_ident)
448                 return;
449
450         dprintk("%s: keeping callback ident %u and dropping ident %u\n",
451                 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
452
453         spin_lock(&nn->nfs_client_lock);
454
455         idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
456         keep->cl_cb_ident = drop->cl_cb_ident;
457
458         idr_replace(&nn->cb_ident_idr, drop, save);
459         drop->cl_cb_ident = save;
460
461         spin_unlock(&nn->nfs_client_lock);
462 }
463
464 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
465                 const struct nfs_client *clp2)
466 {
467         if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
468                 return true;
469         return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
470 }
471
472 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
473 {
474         return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
475 }
476
477 static int nfs4_match_client(struct nfs_client  *pos,  struct nfs_client *new,
478                              struct nfs_client **prev, struct nfs_net *nn)
479 {
480         int status;
481
482         if (pos->rpc_ops != new->rpc_ops)
483                 return 1;
484
485         if (pos->cl_minorversion != new->cl_minorversion)
486                 return 1;
487
488         /* If "pos" isn't marked ready, we can't trust the
489          * remaining fields in "pos", especially the client
490          * ID and serverowner fields.  Wait for CREATE_SESSION
491          * to finish. */
492         if (pos->cl_cons_state > NFS_CS_READY) {
493                 atomic_inc(&pos->cl_count);
494                 spin_unlock(&nn->nfs_client_lock);
495
496                 nfs_put_client(*prev);
497                 *prev = pos;
498
499                 status = nfs_wait_client_init_complete(pos);
500                 spin_lock(&nn->nfs_client_lock);
501
502                 if (status < 0)
503                         return status;
504         }
505
506         if (pos->cl_cons_state != NFS_CS_READY)
507                 return 1;
508
509         if (pos->cl_clientid != new->cl_clientid)
510                 return 1;
511
512         /* NFSv4.1 always uses the uniform string, however someone
513          * might switch the uniquifier string on us.
514          */
515         if (!nfs4_match_client_owner_id(pos, new))
516                 return 1;
517
518         return 0;
519 }
520
521 /**
522  * nfs40_walk_client_list - Find server that recognizes a client ID
523  *
524  * @new: nfs_client with client ID to test
525  * @result: OUT: found nfs_client, or new
526  * @cred: credential to use for trunking test
527  *
528  * Returns zero, a negative errno, or a negative NFS4ERR status.
529  * If zero is returned, an nfs_client pointer is planted in "result."
530  *
531  * NB: nfs40_walk_client_list() relies on the new nfs_client being
532  *     the last nfs_client on the list.
533  */
534 int nfs40_walk_client_list(struct nfs_client *new,
535                            struct nfs_client **result,
536                            struct rpc_cred *cred)
537 {
538         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
539         struct nfs_client *pos, *prev = NULL;
540         struct nfs4_setclientid_res clid = {
541                 .clientid       = new->cl_clientid,
542                 .confirm        = new->cl_confirm,
543         };
544         int status = -NFS4ERR_STALE_CLIENTID;
545
546         spin_lock(&nn->nfs_client_lock);
547         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
548
549                 if (pos == new)
550                         goto found;
551
552                 status = nfs4_match_client(pos, new, &prev, nn);
553                 if (status < 0)
554                         goto out_unlock;
555                 if (status != 0)
556                         continue;
557                 /*
558                  * We just sent a new SETCLIENTID, which should have
559                  * caused the server to return a new cl_confirm.  So if
560                  * cl_confirm is the same, then this is a different
561                  * server that just returned the same cl_confirm by
562                  * coincidence:
563                  */
564                 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
565                                                        &new->cl_confirm))
566                         continue;
567                 /*
568                  * But if the cl_confirm's are different, then the only
569                  * way that a SETCLIENTID_CONFIRM to pos can succeed is
570                  * if new and pos point to the same server:
571                  */
572 found:
573                 atomic_inc(&pos->cl_count);
574                 spin_unlock(&nn->nfs_client_lock);
575
576                 nfs_put_client(prev);
577                 prev = pos;
578
579                 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
580                 switch (status) {
581                 case -NFS4ERR_STALE_CLIENTID:
582                         break;
583                 case 0:
584                         nfs4_swap_callback_idents(pos, new);
585                         pos->cl_confirm = new->cl_confirm;
586                         nfs_mark_client_ready(pos, NFS_CS_READY);
587
588                         prev = NULL;
589                         *result = pos;
590                         goto out;
591                 case -ERESTARTSYS:
592                 case -ETIMEDOUT:
593                         /* The callback path may have been inadvertently
594                          * changed. Schedule recovery!
595                          */
596                         nfs4_schedule_path_down_recovery(pos);
597                 default:
598                         goto out;
599                 }
600
601                 spin_lock(&nn->nfs_client_lock);
602         }
603 out_unlock:
604         spin_unlock(&nn->nfs_client_lock);
605
606         /* No match found. The server lost our clientid */
607 out:
608         nfs_put_client(prev);
609         return status;
610 }
611
612 #ifdef CONFIG_NFS_V4_1
613 /*
614  * Returns true if the server major ids match
615  */
616 static bool
617 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
618                                 struct nfs41_server_owner *o2)
619 {
620         if (o1->major_id_sz != o2->major_id_sz)
621                 return false;
622         return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
623 }
624
625 /*
626  * Returns true if the server scopes match
627  */
628 static bool
629 nfs4_check_server_scope(struct nfs41_server_scope *s1,
630                         struct nfs41_server_scope *s2)
631 {
632         if (s1->server_scope_sz != s2->server_scope_sz)
633                 return false;
634         return memcmp(s1->server_scope, s2->server_scope,
635                                         s1->server_scope_sz) == 0;
636 }
637
638 /**
639  * nfs4_detect_session_trunking - Checks for session trunking.
640  *
641  * Called after a successful EXCHANGE_ID on a multi-addr connection.
642  * Upon success, add the transport.
643  *
644  * @clp:    original mount nfs_client
645  * @res:    result structure from an exchange_id using the original mount
646  *          nfs_client with a new multi_addr transport
647  *
648  * Returns zero on success, otherwise -EINVAL
649  *
650  * Note: since the exchange_id for the new multi_addr transport uses the
651  * same nfs_client from the original mount, the cl_owner_id is reused,
652  * so eir_clientowner is the same.
653  */
654 int nfs4_detect_session_trunking(struct nfs_client *clp,
655                                  struct nfs41_exchange_id_res *res,
656                                  struct rpc_xprt *xprt)
657 {
658         /* Check eir_clientid */
659         if (clp->cl_clientid != res->clientid)
660                 goto out_err;
661
662         /* Check eir_server_owner so_major_id */
663         if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
664                                              res->server_owner))
665                 goto out_err;
666
667         /* Check eir_server_owner so_minor_id */
668         if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
669                 goto out_err;
670
671         /* Check eir_server_scope */
672         if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
673                 goto out_err;
674
675         pr_info("NFS:  %s: Session trunking succeeded for %s\n",
676                 clp->cl_hostname,
677                 xprt->address_strings[RPC_DISPLAY_ADDR]);
678
679         return 0;
680 out_err:
681         pr_info("NFS:  %s: Session trunking failed for %s\n", clp->cl_hostname,
682                 xprt->address_strings[RPC_DISPLAY_ADDR]);
683
684         return -EINVAL;
685 }
686
687 /**
688  * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
689  *
690  * @new: nfs_client with client ID to test
691  * @result: OUT: found nfs_client, or new
692  * @cred: credential to use for trunking test
693  *
694  * Returns zero, a negative errno, or a negative NFS4ERR status.
695  * If zero is returned, an nfs_client pointer is planted in "result."
696  *
697  * NB: nfs41_walk_client_list() relies on the new nfs_client being
698  *     the last nfs_client on the list.
699  */
700 int nfs41_walk_client_list(struct nfs_client *new,
701                            struct nfs_client **result,
702                            struct rpc_cred *cred)
703 {
704         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
705         struct nfs_client *pos, *prev = NULL;
706         int status = -NFS4ERR_STALE_CLIENTID;
707
708         spin_lock(&nn->nfs_client_lock);
709         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
710
711                 if (pos == new)
712                         goto found;
713
714                 status = nfs4_match_client(pos, new, &prev, nn);
715                 if (status < 0)
716                         goto out;
717                 if (status != 0)
718                         continue;
719
720                 /*
721                  * Note that session trunking is just a special subcase of
722                  * client id trunking. In either case, we want to fall back
723                  * to using the existing nfs_client.
724                  */
725                 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
726                                                      new->cl_serverowner))
727                         continue;
728
729 found:
730                 atomic_inc(&pos->cl_count);
731                 *result = pos;
732                 status = 0;
733                 break;
734         }
735
736 out:
737         spin_unlock(&nn->nfs_client_lock);
738         nfs_put_client(prev);
739         return status;
740 }
741 #endif  /* CONFIG_NFS_V4_1 */
742
743 static void nfs4_destroy_server(struct nfs_server *server)
744 {
745         LIST_HEAD(freeme);
746
747         nfs_server_return_all_delegations(server);
748         unset_pnfs_layoutdriver(server);
749         nfs4_purge_state_owners(server, &freeme);
750         nfs4_free_state_owners(&freeme);
751 }
752
753 /*
754  * NFSv4.0 callback thread helper
755  *
756  * Find a client by callback identifier
757  */
758 struct nfs_client *
759 nfs4_find_client_ident(struct net *net, int cb_ident)
760 {
761         struct nfs_client *clp;
762         struct nfs_net *nn = net_generic(net, nfs_net_id);
763
764         spin_lock(&nn->nfs_client_lock);
765         clp = idr_find(&nn->cb_ident_idr, cb_ident);
766         if (clp)
767                 atomic_inc(&clp->cl_count);
768         spin_unlock(&nn->nfs_client_lock);
769         return clp;
770 }
771
772 #if defined(CONFIG_NFS_V4_1)
773 /* Common match routine for v4.0 and v4.1 callback services */
774 static bool nfs4_cb_match_client(const struct sockaddr *addr,
775                 struct nfs_client *clp, u32 minorversion)
776 {
777         struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
778
779         /* Don't match clients that failed to initialise */
780         if (!(clp->cl_cons_state == NFS_CS_READY ||
781             clp->cl_cons_state == NFS_CS_SESSION_INITING))
782                 return false;
783
784         smp_rmb();
785
786         /* Match the version and minorversion */
787         if (clp->rpc_ops->version != 4 ||
788             clp->cl_minorversion != minorversion)
789                 return false;
790
791         /* Match only the IP address, not the port number */
792         return rpc_cmp_addr(addr, clap);
793 }
794
795 /*
796  * NFSv4.1 callback thread helper
797  * For CB_COMPOUND calls, find a client by IP address, protocol version,
798  * minorversion, and sessionID
799  *
800  * Returns NULL if no such client
801  */
802 struct nfs_client *
803 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
804                            struct nfs4_sessionid *sid, u32 minorversion)
805 {
806         struct nfs_client *clp;
807         struct nfs_net *nn = net_generic(net, nfs_net_id);
808
809         spin_lock(&nn->nfs_client_lock);
810         list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
811                 if (nfs4_cb_match_client(addr, clp, minorversion) == false)
812                         continue;
813
814                 if (!nfs4_has_session(clp))
815                         continue;
816
817                 /* Match sessionid*/
818                 if (memcmp(clp->cl_session->sess_id.data,
819                     sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
820                         continue;
821
822                 atomic_inc(&clp->cl_count);
823                 spin_unlock(&nn->nfs_client_lock);
824                 return clp;
825         }
826         spin_unlock(&nn->nfs_client_lock);
827         return NULL;
828 }
829
830 #else /* CONFIG_NFS_V4_1 */
831
832 struct nfs_client *
833 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
834                            struct nfs4_sessionid *sid, u32 minorversion)
835 {
836         return NULL;
837 }
838 #endif /* CONFIG_NFS_V4_1 */
839
840 /*
841  * Set up an NFS4 client
842  */
843 static int nfs4_set_client(struct nfs_server *server,
844                 const char *hostname,
845                 const struct sockaddr *addr,
846                 const size_t addrlen,
847                 const char *ip_addr,
848                 int proto, const struct rpc_timeout *timeparms,
849                 u32 minorversion, struct net *net)
850 {
851         struct nfs_client_initdata cl_init = {
852                 .hostname = hostname,
853                 .addr = addr,
854                 .addrlen = addrlen,
855                 .ip_addr = ip_addr,
856                 .nfs_mod = &nfs_v4,
857                 .proto = proto,
858                 .minorversion = minorversion,
859                 .net = net,
860                 .timeparms = timeparms,
861         };
862         struct nfs_client *clp;
863
864         if (server->flags & NFS_MOUNT_NORESVPORT)
865                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
866         if (server->options & NFS_OPTION_MIGRATION)
867                 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
868         if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
869                 set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
870
871         /* Allocate or find a client reference we can use */
872         clp = nfs_get_client(&cl_init);
873         if (IS_ERR(clp))
874                 return PTR_ERR(clp);
875
876         if (server->nfs_client == clp) {
877                 nfs_put_client(clp);
878                 return -ELOOP;
879         }
880
881         /*
882          * Query for the lease time on clientid setup or renewal
883          *
884          * Note that this will be set on nfs_clients that were created
885          * only for the DS role and did not set this bit, but now will
886          * serve a dual role.
887          */
888         set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
889
890         server->nfs_client = clp;
891         return 0;
892 }
893
894 /*
895  * Set up a pNFS Data Server client.
896  *
897  * Return any existing nfs_client that matches server address,port,version
898  * and minorversion.
899  *
900  * For a new nfs_client, use a soft mount (default), a low retrans and a
901  * low timeout interval so that if a connection is lost, we retry through
902  * the MDS.
903  */
904 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
905                 const struct sockaddr *ds_addr, int ds_addrlen,
906                 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
907                 u32 minor_version)
908 {
909         struct rpc_timeout ds_timeout;
910         struct nfs_client *mds_clp = mds_srv->nfs_client;
911         struct nfs_client_initdata cl_init = {
912                 .addr = ds_addr,
913                 .addrlen = ds_addrlen,
914                 .nodename = mds_clp->cl_rpcclient->cl_nodename,
915                 .ip_addr = mds_clp->cl_ipaddr,
916                 .nfs_mod = &nfs_v4,
917                 .proto = ds_proto,
918                 .minorversion = minor_version,
919                 .net = mds_clp->cl_net,
920                 .timeparms = &ds_timeout,
921         };
922         char buf[INET6_ADDRSTRLEN + 1];
923
924         if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
925                 return ERR_PTR(-EINVAL);
926         cl_init.hostname = buf;
927
928         if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
929                 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
930
931         /*
932          * Set an authflavor equual to the MDS value. Use the MDS nfs_client
933          * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
934          * (section 13.1 RFC 5661).
935          */
936         nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
937         return nfs_get_client(&cl_init);
938 }
939 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
940
941 /*
942  * Session has been established, and the client marked ready.
943  * Limit the mount rsize, wsize and dtsize using negotiated fore
944  * channel attributes.
945  */
946 static void nfs4_session_limit_rwsize(struct nfs_server *server)
947 {
948 #ifdef CONFIG_NFS_V4_1
949         struct nfs4_session *sess;
950         u32 server_resp_sz;
951         u32 server_rqst_sz;
952
953         if (!nfs4_has_session(server->nfs_client))
954                 return;
955         sess = server->nfs_client->cl_session;
956         server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
957         server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
958
959         if (server->dtsize > server_resp_sz)
960                 server->dtsize = server_resp_sz;
961         if (server->rsize > server_resp_sz)
962                 server->rsize = server_resp_sz;
963         if (server->wsize > server_rqst_sz)
964                 server->wsize = server_rqst_sz;
965 #endif /* CONFIG_NFS_V4_1 */
966 }
967
968 static int nfs4_server_common_setup(struct nfs_server *server,
969                 struct nfs_fh *mntfh, bool auth_probe)
970 {
971         struct nfs_fattr *fattr;
972         int error;
973
974         /* data servers support only a subset of NFSv4.1 */
975         if (is_ds_only_client(server->nfs_client))
976                 return -EPROTONOSUPPORT;
977
978         fattr = nfs_alloc_fattr();
979         if (fattr == NULL)
980                 return -ENOMEM;
981
982         /* We must ensure the session is initialised first */
983         error = nfs4_init_session(server->nfs_client);
984         if (error < 0)
985                 goto out;
986
987         /* Set the basic capabilities */
988         server->caps |= server->nfs_client->cl_mvops->init_caps;
989         if (server->flags & NFS_MOUNT_NORDIRPLUS)
990                         server->caps &= ~NFS_CAP_READDIRPLUS;
991         /*
992          * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
993          * authentication.
994          */
995         if (nfs4_disable_idmapping &&
996                         server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
997                 server->caps |= NFS_CAP_UIDGID_NOMAP;
998
999
1000         /* Probe the root fh to retrieve its FSID and filehandle */
1001         error = nfs4_get_rootfh(server, mntfh, auth_probe);
1002         if (error < 0)
1003                 goto out;
1004
1005         dprintk("Server FSID: %llx:%llx\n",
1006                         (unsigned long long) server->fsid.major,
1007                         (unsigned long long) server->fsid.minor);
1008         nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1009
1010         error = nfs_probe_fsinfo(server, mntfh, fattr);
1011         if (error < 0)
1012                 goto out;
1013
1014         nfs4_session_limit_rwsize(server);
1015
1016         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1017                 server->namelen = NFS4_MAXNAMLEN;
1018
1019         nfs_server_insert_lists(server);
1020         server->mount_time = jiffies;
1021         server->destroy = nfs4_destroy_server;
1022 out:
1023         nfs_free_fattr(fattr);
1024         return error;
1025 }
1026
1027 /*
1028  * Create a version 4 volume record
1029  */
1030 static int nfs4_init_server(struct nfs_server *server,
1031                 struct nfs_parsed_mount_data *data)
1032 {
1033         struct rpc_timeout timeparms;
1034         int error;
1035
1036         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1037                         data->timeo, data->retrans);
1038
1039         /* Initialise the client representation from the mount data */
1040         server->flags = data->flags;
1041         server->options = data->options;
1042         server->auth_info = data->auth_info;
1043
1044         /* Use the first specified auth flavor. If this flavor isn't
1045          * allowed by the server, use the SECINFO path to try the
1046          * other specified flavors */
1047         if (data->auth_info.flavor_len >= 1)
1048                 data->selected_flavor = data->auth_info.flavors[0];
1049         else
1050                 data->selected_flavor = RPC_AUTH_UNIX;
1051
1052         /* Get a client record */
1053         error = nfs4_set_client(server,
1054                         data->nfs_server.hostname,
1055                         (const struct sockaddr *)&data->nfs_server.address,
1056                         data->nfs_server.addrlen,
1057                         data->client_address,
1058                         data->nfs_server.protocol,
1059                         &timeparms,
1060                         data->minorversion,
1061                         data->net);
1062         if (error < 0)
1063                 return error;
1064
1065         if (data->rsize)
1066                 server->rsize = nfs_block_size(data->rsize, NULL);
1067         if (data->wsize)
1068                 server->wsize = nfs_block_size(data->wsize, NULL);
1069
1070         server->acregmin = data->acregmin * HZ;
1071         server->acregmax = data->acregmax * HZ;
1072         server->acdirmin = data->acdirmin * HZ;
1073         server->acdirmax = data->acdirmax * HZ;
1074         server->port     = data->nfs_server.port;
1075
1076         return nfs_init_server_rpcclient(server, &timeparms,
1077                                          data->selected_flavor);
1078 }
1079
1080 /*
1081  * Create a version 4 volume record
1082  * - keyed on server and FSID
1083  */
1084 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1085                                       struct nfs_fh *mntfh)*/
1086 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1087                                       struct nfs_subversion *nfs_mod)
1088 {
1089         struct nfs_server *server;
1090         bool auth_probe;
1091         int error;
1092
1093         server = nfs_alloc_server();
1094         if (!server)
1095                 return ERR_PTR(-ENOMEM);
1096
1097         auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1098
1099         /* set up the general RPC client */
1100         error = nfs4_init_server(server, mount_info->parsed);
1101         if (error < 0)
1102                 goto error;
1103
1104         error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1105         if (error < 0)
1106                 goto error;
1107
1108         return server;
1109
1110 error:
1111         nfs_free_server(server);
1112         return ERR_PTR(error);
1113 }
1114
1115 /*
1116  * Create an NFS4 referral server record
1117  */
1118 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1119                                                struct nfs_fh *mntfh)
1120 {
1121         struct nfs_client *parent_client;
1122         struct nfs_server *server, *parent_server;
1123         bool auth_probe;
1124         int error;
1125
1126         server = nfs_alloc_server();
1127         if (!server)
1128                 return ERR_PTR(-ENOMEM);
1129
1130         parent_server = NFS_SB(data->sb);
1131         parent_client = parent_server->nfs_client;
1132
1133         /* Initialise the client representation from the parent server */
1134         nfs_server_copy_userdata(server, parent_server);
1135
1136         /* Get a client representation.
1137          * Note: NFSv4 always uses TCP, */
1138         error = nfs4_set_client(server, data->hostname,
1139                                 data->addr,
1140                                 data->addrlen,
1141                                 parent_client->cl_ipaddr,
1142                                 rpc_protocol(parent_server->client),
1143                                 parent_server->client->cl_timeout,
1144                                 parent_client->cl_mvops->minor_version,
1145                                 parent_client->cl_net);
1146         if (error < 0)
1147                 goto error;
1148
1149         error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1150         if (error < 0)
1151                 goto error;
1152
1153         auth_probe = parent_server->auth_info.flavor_len < 1;
1154
1155         error = nfs4_server_common_setup(server, mntfh, auth_probe);
1156         if (error < 0)
1157                 goto error;
1158
1159         return server;
1160
1161 error:
1162         nfs_free_server(server);
1163         return ERR_PTR(error);
1164 }
1165
1166 /*
1167  * Grab the destination's particulars, including lease expiry time.
1168  *
1169  * Returns zero if probe succeeded and retrieved FSID matches the FSID
1170  * we have cached.
1171  */
1172 static int nfs_probe_destination(struct nfs_server *server)
1173 {
1174         struct inode *inode = d_inode(server->super->s_root);
1175         struct nfs_fattr *fattr;
1176         int error;
1177
1178         fattr = nfs_alloc_fattr();
1179         if (fattr == NULL)
1180                 return -ENOMEM;
1181
1182         /* Sanity: the probe won't work if the destination server
1183          * does not recognize the migrated FH. */
1184         error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1185
1186         nfs_free_fattr(fattr);
1187         return error;
1188 }
1189
1190 /**
1191  * nfs4_update_server - Move an nfs_server to a different nfs_client
1192  *
1193  * @server: represents FSID to be moved
1194  * @hostname: new end-point's hostname
1195  * @sap: new end-point's socket address
1196  * @salen: size of "sap"
1197  * @net: net namespace
1198  *
1199  * The nfs_server must be quiescent before this function is invoked.
1200  * Either its session is drained (NFSv4.1+), or its transport is
1201  * plugged and drained (NFSv4.0).
1202  *
1203  * Returns zero on success, or a negative errno value.
1204  */
1205 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1206                        struct sockaddr *sap, size_t salen, struct net *net)
1207 {
1208         struct nfs_client *clp = server->nfs_client;
1209         struct rpc_clnt *clnt = server->client;
1210         struct xprt_create xargs = {
1211                 .ident          = clp->cl_proto,
1212                 .net            = net,
1213                 .dstaddr        = sap,
1214                 .addrlen        = salen,
1215                 .servername     = hostname,
1216         };
1217         char buf[INET6_ADDRSTRLEN + 1];
1218         struct sockaddr_storage address;
1219         struct sockaddr *localaddr = (struct sockaddr *)&address;
1220         int error;
1221
1222         error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1223         if (error != 0)
1224                 return error;
1225
1226         error = rpc_localaddr(clnt, localaddr, sizeof(address));
1227         if (error != 0)
1228                 return error;
1229
1230         if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1231                 return -EAFNOSUPPORT;
1232
1233         nfs_server_remove_lists(server);
1234         set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1235         error = nfs4_set_client(server, hostname, sap, salen, buf,
1236                                 clp->cl_proto, clnt->cl_timeout,
1237                                 clp->cl_minorversion, net);
1238         clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1239         if (error != 0) {
1240                 nfs_server_insert_lists(server);
1241                 return error;
1242         }
1243         nfs_put_client(clp);
1244
1245         if (server->nfs_client->cl_hostname == NULL) {
1246                 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1247                 if (server->nfs_client->cl_hostname == NULL)
1248                         return -ENOMEM;
1249         }
1250         nfs_server_insert_lists(server);
1251
1252         return nfs_probe_destination(server);
1253 }