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