fs/nfs/nfs4client.c

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