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                 nfs4_shutdown_slot_table(tbl);
 344                 kfree(tbl);
 345                 return ret;
 346         }
 347
 348         clp->cl_slot_tbl = tbl;
 349         return 0;
 350 }
 351
 352 #if defined(CONFIG_NFS_V4_1)
 353
 354 /**
 355  * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
 356  * @clp - nfs_client to initialize
 357  *
 358  * Returns zero on success, or a negative errno if some error occurred.
 359  */
 360 int nfs41_init_client(struct nfs_client *clp)
 361 {
 362         struct nfs4_session *session = NULL;
 363
 364         /*
 365          * Create the session and mark it expired.
 366          * When a SEQUENCE operation encounters the expired session
 367          * it will do session recovery to initialize it.
 368          */
 369         session = nfs4_alloc_session(clp);
 370         if (!session)
 371                 return -ENOMEM;
 372
 373         clp->cl_session = session;
 374
 375         /*
 376          * The create session reply races with the server back
 377          * channel probe. Mark the client NFS_CS_SESSION_INITING
 378          * so that the client back channel can find the
 379          * nfs_client struct
 380          */
 381         nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
 382         return 0;
 383 }
 384
 385 #endif  /* CONFIG_NFS_V4_1 */
 386
 387 /*
 388  * Initialize the minor version specific parts of an NFS4 client record
 389  */
 390 static int nfs4_init_client_minor_version(struct nfs_client *clp)
 391 {
 392         int ret;
 393
 394         ret = clp->cl_mvops->init_client(clp);
 395         if (ret)
 396                 return ret;
 397         return nfs4_init_callback(clp);
 398 }
 399
 400 /**
 401  * nfs4_init_client - Initialise an NFS4 client record
 402  *
 403  * @clp: nfs_client to initialise
 404  * @timeparms: timeout parameters for underlying RPC transport
 405  * @ip_addr: callback IP address in presentation format
 406  * @authflavor: authentication flavor for underlying RPC transport
 407  *
 408  * Returns pointer to an NFS client, or an ERR_PTR value.
 409  */
 410 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
 411                                     const struct nfs_client_initdata *cl_init)
 412 {
 413         struct nfs_client *old;
 414         int error;
 415
 416         if (clp->cl_cons_state == NFS_CS_READY)
 417                 /* the client is initialised already */
 418                 return clp;
 419
 420         error = nfs4_init_client_minor_version(clp);
 421         if (error < 0)
 422                 goto error;
 423
 424         error = nfs4_discover_server_trunking(clp, &old);
 425         if (error < 0)
 426                 goto error;
 427
 428         if (clp != old) {
 429                 clp->cl_preserve_clid = true;
 430                 /*
 431                  * Mark the client as having failed initialization so other
 432                  * processes walking the nfs_client_list in nfs_match_client()
 433                  * won't try to use it.
 434                  */
 435                 nfs_mark_client_ready(clp, -EPERM);
 436         }
 437         clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
 438         nfs_put_client(clp);
 439         return old;
 440
 441 error:
 442         nfs_mark_client_ready(clp, error);
 443         nfs_put_client(clp);
 444         return ERR_PTR(error);
 445 }
 446
 447 /*
 448  * SETCLIENTID just did a callback update with the callback ident in
 449  * "drop," but server trunking discovery claims "drop" and "keep" are
 450  * actually the same server.  Swap the callback IDs so that "keep"
 451  * will continue to use the callback ident the server now knows about,
 452  * and so that "keep"'s original callback ident is destroyed when
 453  * "drop" is freed.
 454  */
 455 static void nfs4_swap_callback_idents(struct nfs_client *keep,
 456                                       struct nfs_client *drop)
 457 {
 458         struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
 459         unsigned int save = keep->cl_cb_ident;
 460
 461         if (keep->cl_cb_ident == drop->cl_cb_ident)
 462                 return;
 463
 464         dprintk("%s: keeping callback ident %u and dropping ident %u\n",
 465                 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
 466
 467         spin_lock(&nn->nfs_client_lock);
 468
 469         idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
 470         keep->cl_cb_ident = drop->cl_cb_ident;
 471
 472         idr_replace(&nn->cb_ident_idr, drop, save);
 473         drop->cl_cb_ident = save;
 474
 475         spin_unlock(&nn->nfs_client_lock);
 476 }
 477
 478 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
 479                 const struct nfs_client *clp2)
 480 {
 481         if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
 482                 return true;
 483         return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
 484 }
 485
 486 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
 487 {
 488         return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
 489 }
 490
 491 static int nfs4_match_client(struct nfs_client  *pos,  struct nfs_client *new,
 492                              struct nfs_client **prev, struct nfs_net *nn)
 493 {
 494         int status;
 495
 496         if (pos->rpc_ops != new->rpc_ops)
 497                 return 1;
 498
 499         if (pos->cl_minorversion != new->cl_minorversion)
 500                 return 1;
 501
 502         /* If "pos" isn't marked ready, we can't trust the
 503          * remaining fields in "pos", especially the client
 504          * ID and serverowner fields.  Wait for CREATE_SESSION
 505          * to finish. */
 506         if (pos->cl_cons_state > NFS_CS_READY) {
 507                 refcount_inc(&pos->cl_count);
 508                 spin_unlock(&nn->nfs_client_lock);
 509
 510                 nfs_put_client(*prev);
 511                 *prev = pos;
 512
 513                 status = nfs_wait_client_init_complete(pos);
 514                 spin_lock(&nn->nfs_client_lock);
 515
 516                 if (status < 0)
 517                         return status;
 518         }
 519
 520         if (pos->cl_cons_state != NFS_CS_READY)
 521                 return 1;
 522
 523         if (pos->cl_clientid != new->cl_clientid)
 524                 return 1;
 525
 526         /* NFSv4.1 always uses the uniform string, however someone
 527          * might switch the uniquifier string on us.
 528          */
 529         if (!nfs4_match_client_owner_id(pos, new))
 530                 return 1;
 531
 532         return 0;
 533 }
 534
 535 /**
 536  * nfs40_walk_client_list - Find server that recognizes a client ID
 537  *
 538  * @new: nfs_client with client ID to test
 539  * @result: OUT: found nfs_client, or new
 540  * @cred: credential to use for trunking test
 541  *
 542  * Returns zero, a negative errno, or a negative NFS4ERR status.
 543  * If zero is returned, an nfs_client pointer is planted in "result."
 544  *
 545  * NB: nfs40_walk_client_list() relies on the new nfs_client being
 546  *     the last nfs_client on the list.
 547  */
 548 int nfs40_walk_client_list(struct nfs_client *new,
 549                            struct nfs_client **result,
 550                            struct rpc_cred *cred)
 551 {
 552         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
 553         struct nfs_client *pos, *prev = NULL;
 554         struct nfs4_setclientid_res clid = {
 555                 .clientid       = new->cl_clientid,
 556                 .confirm        = new->cl_confirm,
 557         };
 558         int status = -NFS4ERR_STALE_CLIENTID;
 559
 560         spin_lock(&nn->nfs_client_lock);
 561         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
 562
 563                 if (pos == new)
 564                         goto found;
 565
 566                 status = nfs4_match_client(pos, new, &prev, nn);
 567                 if (status < 0)
 568                         goto out_unlock;
 569                 if (status != 0)
 570                         continue;
 571                 /*
 572                  * We just sent a new SETCLIENTID, which should have
 573                  * caused the server to return a new cl_confirm.  So if
 574                  * cl_confirm is the same, then this is a different
 575                  * server that just returned the same cl_confirm by
 576                  * coincidence:
 577                  */
 578                 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
 579                                                        &new->cl_confirm))
 580                         continue;
 581                 /*
 582                  * But if the cl_confirm's are different, then the only
 583                  * way that a SETCLIENTID_CONFIRM to pos can succeed is
 584                  * if new and pos point to the same server:
 585                  */
 586 found:
 587                 refcount_inc(&pos->cl_count);
 588                 spin_unlock(&nn->nfs_client_lock);
 589
 590                 nfs_put_client(prev);
 591                 prev = pos;
 592
 593                 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
 594                 switch (status) {
 595                 case -NFS4ERR_STALE_CLIENTID:
 596                         break;
 597                 case 0:
 598                         nfs4_swap_callback_idents(pos, new);
 599                         pos->cl_confirm = new->cl_confirm;
 600                         nfs_mark_client_ready(pos, NFS_CS_READY);
 601
 602                         prev = NULL;
 603                         *result = pos;
 604                         goto out;
 605                 case -ERESTARTSYS:
 606                 case -ETIMEDOUT:
 607                         /* The callback path may have been inadvertently
 608                          * changed. Schedule recovery!
 609                          */
 610                         nfs4_schedule_path_down_recovery(pos);
 611                 default:
 612                         goto out;
 613                 }
 614
 615                 spin_lock(&nn->nfs_client_lock);
 616         }
 617 out_unlock:
 618         spin_unlock(&nn->nfs_client_lock);
 619
 620         /* No match found. The server lost our clientid */
 621 out:
 622         nfs_put_client(prev);
 623         return status;
 624 }
 625
 626 #ifdef CONFIG_NFS_V4_1
 627 /*
 628  * Returns true if the server major ids match
 629  */
 630 static bool
 631 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
 632                                 struct nfs41_server_owner *o2)
 633 {
 634         if (o1->major_id_sz != o2->major_id_sz)
 635                 return false;
 636         return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
 637 }
 638
 639 /*
 640  * Returns true if the server scopes match
 641  */
 642 static bool
 643 nfs4_check_server_scope(struct nfs41_server_scope *s1,
 644                         struct nfs41_server_scope *s2)
 645 {
 646         if (s1->server_scope_sz != s2->server_scope_sz)
 647                 return false;
 648         return memcmp(s1->server_scope, s2->server_scope,
 649                                         s1->server_scope_sz) == 0;
 650 }
 651
 652 /**
 653  * nfs4_detect_session_trunking - Checks for session trunking.
 654  *
 655  * Called after a successful EXCHANGE_ID on a multi-addr connection.
 656  * Upon success, add the transport.
 657  *
 658  * @clp:    original mount nfs_client
 659  * @res:    result structure from an exchange_id using the original mount
 660  *          nfs_client with a new multi_addr transport
 661  *
 662  * Returns zero on success, otherwise -EINVAL
 663  *
 664  * Note: since the exchange_id for the new multi_addr transport uses the
 665  * same nfs_client from the original mount, the cl_owner_id is reused,
 666  * so eir_clientowner is the same.
 667  */
 668 int nfs4_detect_session_trunking(struct nfs_client *clp,
 669                                  struct nfs41_exchange_id_res *res,
 670                                  struct rpc_xprt *xprt)
 671 {
 672         /* Check eir_clientid */
 673         if (clp->cl_clientid != res->clientid)
 674                 goto out_err;
 675
 676         /* Check eir_server_owner so_major_id */
 677         if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
 678                                              res->server_owner))
 679                 goto out_err;
 680
 681         /* Check eir_server_owner so_minor_id */
 682         if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
 683                 goto out_err;
 684
 685         /* Check eir_server_scope */
 686         if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
 687                 goto out_err;
 688
 689         pr_info("NFS:  %s: Session trunking succeeded for %s\n",
 690                 clp->cl_hostname,
 691                 xprt->address_strings[RPC_DISPLAY_ADDR]);
 692
 693         return 0;
 694 out_err:
 695         pr_info("NFS:  %s: Session trunking failed for %s\n", clp->cl_hostname,
 696                 xprt->address_strings[RPC_DISPLAY_ADDR]);
 697
 698         return -EINVAL;
 699 }
 700
 701 /**
 702  * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
 703  *
 704  * @new: nfs_client with client ID to test
 705  * @result: OUT: found nfs_client, or new
 706  * @cred: credential to use for trunking test
 707  *
 708  * Returns zero, a negative errno, or a negative NFS4ERR status.
 709  * If zero is returned, an nfs_client pointer is planted in "result."
 710  *
 711  * NB: nfs41_walk_client_list() relies on the new nfs_client being
 712  *     the last nfs_client on the list.
 713  */
 714 int nfs41_walk_client_list(struct nfs_client *new,
 715                            struct nfs_client **result,
 716                            struct rpc_cred *cred)
 717 {
 718         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
 719         struct nfs_client *pos, *prev = NULL;
 720         int status = -NFS4ERR_STALE_CLIENTID;
 721
 722         spin_lock(&nn->nfs_client_lock);
 723         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
 724
 725                 if (pos == new)
 726                         goto found;
 727
 728                 status = nfs4_match_client(pos, new, &prev, nn);
 729                 if (status < 0)
 730                         goto out;
 731                 if (status != 0)
 732                         continue;
 733
 734                 /*
 735                  * Note that session trunking is just a special subcase of
 736                  * client id trunking. In either case, we want to fall back
 737                  * to using the existing nfs_client.
 738                  */
 739                 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
 740                                                      new->cl_serverowner))
 741                         continue;
 742
 743 found:
 744                 refcount_inc(&pos->cl_count);
 745                 *result = pos;
 746                 status = 0;
 747                 break;
 748         }
 749
 750 out:
 751         spin_unlock(&nn->nfs_client_lock);
 752         nfs_put_client(prev);
 753         return status;
 754 }
 755 #endif  /* CONFIG_NFS_V4_1 */
 756
 757 static void nfs4_destroy_server(struct nfs_server *server)
 758 {
 759         LIST_HEAD(freeme);
 760
 761         nfs_server_return_all_delegations(server);
 762         unset_pnfs_layoutdriver(server);
 763         nfs4_purge_state_owners(server, &freeme);
 764         nfs4_free_state_owners(&freeme);
 765 }
 766
 767 /*
 768  * NFSv4.0 callback thread helper
 769  *
 770  * Find a client by callback identifier
 771  */
 772 struct nfs_client *
 773 nfs4_find_client_ident(struct net *net, int cb_ident)
 774 {
 775         struct nfs_client *clp;
 776         struct nfs_net *nn = net_generic(net, nfs_net_id);
 777
 778         spin_lock(&nn->nfs_client_lock);
 779         clp = idr_find(&nn->cb_ident_idr, cb_ident);
 780         if (clp)
 781                 refcount_inc(&clp->cl_count);
 782         spin_unlock(&nn->nfs_client_lock);
 783         return clp;
 784 }
 785
 786 #if defined(CONFIG_NFS_V4_1)
 787 /* Common match routine for v4.0 and v4.1 callback services */
 788 static bool nfs4_cb_match_client(const struct sockaddr *addr,
 789                 struct nfs_client *clp, u32 minorversion)
 790 {
 791         struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
 792
 793         /* Don't match clients that failed to initialise */
 794         if (!(clp->cl_cons_state == NFS_CS_READY ||
 795             clp->cl_cons_state == NFS_CS_SESSION_INITING))
 796                 return false;
 797
 798         smp_rmb();
 799
 800         /* Match the version and minorversion */
 801         if (clp->rpc_ops->version != 4 ||
 802             clp->cl_minorversion != minorversion)
 803                 return false;
 804
 805         /* Match only the IP address, not the port number */
 806         return rpc_cmp_addr(addr, clap);
 807 }
 808
 809 /*
 810  * NFSv4.1 callback thread helper
 811  * For CB_COMPOUND calls, find a client by IP address, protocol version,
 812  * minorversion, and sessionID
 813  *
 814  * Returns NULL if no such client
 815  */
 816 struct nfs_client *
 817 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
 818                            struct nfs4_sessionid *sid, u32 minorversion)
 819 {
 820         struct nfs_client *clp;
 821         struct nfs_net *nn = net_generic(net, nfs_net_id);
 822
 823         spin_lock(&nn->nfs_client_lock);
 824         list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
 825                 if (!nfs4_cb_match_client(addr, clp, minorversion))
 826                         continue;
 827
 828                 if (!nfs4_has_session(clp))
 829                         continue;
 830
 831                 /* Match sessionid*/
 832                 if (memcmp(clp->cl_session->sess_id.data,
 833                     sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
 834                         continue;
 835
 836                 refcount_inc(&clp->cl_count);
 837                 spin_unlock(&nn->nfs_client_lock);
 838                 return clp;
 839         }
 840         spin_unlock(&nn->nfs_client_lock);
 841         return NULL;
 842 }
 843
 844 #else /* CONFIG_NFS_V4_1 */
 845
 846 struct nfs_client *
 847 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
 848                            struct nfs4_sessionid *sid, u32 minorversion)
 849 {
 850         return NULL;
 851 }
 852 #endif /* CONFIG_NFS_V4_1 */
 853
 854 /*
 855  * Set up an NFS4 client
 856  */
 857 static int nfs4_set_client(struct nfs_server *server,
 858                 const char *hostname,
 859                 const struct sockaddr *addr,
 860                 const size_t addrlen,
 861                 const char *ip_addr,
 862                 int proto, const struct rpc_timeout *timeparms,
 863                 u32 minorversion, struct net *net)
 864 {
 865         struct nfs_client_initdata cl_init = {
 866                 .hostname = hostname,
 867                 .addr = addr,
 868                 .addrlen = addrlen,
 869                 .ip_addr = ip_addr,
 870                 .nfs_mod = &nfs_v4,
 871                 .proto = proto,
 872                 .minorversion = minorversion,
 873                 .net = net,
 874                 .timeparms = timeparms,
 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         };
 937         char buf[INET6_ADDRSTRLEN + 1];
 938
 939         if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
 940                 return ERR_PTR(-EINVAL);
 941         cl_init.hostname = buf;
 942
 943         if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
 944                 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
 945
 946         /*
 947          * Set an authflavor equual to the MDS value. Use the MDS nfs_client
 948          * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
 949          * (section 13.1 RFC 5661).
 950          */
 951         nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
 952         return nfs_get_client(&cl_init);
 953 }
 954 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
 955
 956 /*
 957  * Session has been established, and the client marked ready.
 958  * Limit the mount rsize, wsize and dtsize using negotiated fore
 959  * channel attributes.
 960  */
 961 static void nfs4_session_limit_rwsize(struct nfs_server *server)
 962 {
 963 #ifdef CONFIG_NFS_V4_1
 964         struct nfs4_session *sess;
 965         u32 server_resp_sz;
 966         u32 server_rqst_sz;
 967
 968         if (!nfs4_has_session(server->nfs_client))
 969                 return;
 970         sess = server->nfs_client->cl_session;
 971         server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
 972         server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
 973
 974         if (server->dtsize > server_resp_sz)
 975                 server->dtsize = server_resp_sz;
 976         if (server->rsize > server_resp_sz)
 977                 server->rsize = server_resp_sz;
 978         if (server->wsize > server_rqst_sz)
 979                 server->wsize = server_rqst_sz;
 980 #endif /* CONFIG_NFS_V4_1 */
 981 }
 982
 983 static int nfs4_server_common_setup(struct nfs_server *server,
 984                 struct nfs_fh *mntfh, bool auth_probe)
 985 {
 986         struct nfs_fattr *fattr;
 987         int error;
 988
 989         /* data servers support only a subset of NFSv4.1 */
 990         if (is_ds_only_client(server->nfs_client))
 991                 return -EPROTONOSUPPORT;
 992
 993         fattr = nfs_alloc_fattr();
 994         if (fattr == NULL)
 995                 return -ENOMEM;
 996
 997         /* We must ensure the session is initialised first */
 998         error = nfs4_init_session(server->nfs_client);
 999         if (error < 0)
1000                 goto out;
1001
1002         /* Set the basic capabilities */
1003         server->caps |= server->nfs_client->cl_mvops->init_caps;
1004         if (server->flags & NFS_MOUNT_NORDIRPLUS)
1005                         server->caps &= ~NFS_CAP_READDIRPLUS;
1006         /*
1007          * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1008          * authentication.
1009          */
1010         if (nfs4_disable_idmapping &&
1011                         server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1012                 server->caps |= NFS_CAP_UIDGID_NOMAP;
1013
1014
1015         /* Probe the root fh to retrieve its FSID and filehandle */
1016         error = nfs4_get_rootfh(server, mntfh, auth_probe);
1017         if (error < 0)
1018                 goto out;
1019
1020         dprintk("Server FSID: %llx:%llx\n",
1021                         (unsigned long long) server->fsid.major,
1022                         (unsigned long long) server->fsid.minor);
1023         nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1024
1025         error = nfs_probe_fsinfo(server, mntfh, fattr);
1026         if (error < 0)
1027                 goto out;
1028
1029         nfs4_session_limit_rwsize(server);
1030
1031         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1032                 server->namelen = NFS4_MAXNAMLEN;
1033
1034         nfs_server_insert_lists(server);
1035         server->mount_time = jiffies;
1036         server->destroy = nfs4_destroy_server;
1037 out:
1038         nfs_free_fattr(fattr);
1039         return error;
1040 }
1041
1042 /*
1043  * Create a version 4 volume record
1044  */
1045 static int nfs4_init_server(struct nfs_server *server,
1046                 struct nfs_parsed_mount_data *data)
1047 {
1048         struct rpc_timeout timeparms;
1049         int error;
1050
1051         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1052                         data->timeo, data->retrans);
1053
1054         /* Initialise the client representation from the mount data */
1055         server->flags = data->flags;
1056         server->options = data->options;
1057         server->auth_info = data->auth_info;
1058
1059         /* Use the first specified auth flavor. If this flavor isn't
1060          * allowed by the server, use the SECINFO path to try the
1061          * other specified flavors */
1062         if (data->auth_info.flavor_len >= 1)
1063                 data->selected_flavor = data->auth_info.flavors[0];
1064         else
1065                 data->selected_flavor = RPC_AUTH_UNIX;
1066
1067         /* Get a client record */
1068         error = nfs4_set_client(server,
1069                         data->nfs_server.hostname,
1070                         (const struct sockaddr *)&data->nfs_server.address,
1071                         data->nfs_server.addrlen,
1072                         data->client_address,
1073                         data->nfs_server.protocol,
1074                         &timeparms,
1075                         data->minorversion,
1076                         data->net);
1077         if (error < 0)
1078                 return error;
1079
1080         if (data->rsize)
1081                 server->rsize = nfs_block_size(data->rsize, NULL);
1082         if (data->wsize)
1083                 server->wsize = nfs_block_size(data->wsize, NULL);
1084
1085         server->acregmin = data->acregmin * HZ;
1086         server->acregmax = data->acregmax * HZ;
1087         server->acdirmin = data->acdirmin * HZ;
1088         server->acdirmax = data->acdirmax * HZ;
1089         server->port     = data->nfs_server.port;
1090
1091         return nfs_init_server_rpcclient(server, &timeparms,
1092                                          data->selected_flavor);
1093 }
1094
1095 /*
1096  * Create a version 4 volume record
1097  * - keyed on server and FSID
1098  */
1099 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1100                                       struct nfs_fh *mntfh)*/
1101 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1102                                       struct nfs_subversion *nfs_mod)
1103 {
1104         struct nfs_server *server;
1105         bool auth_probe;
1106         int error;
1107
1108         server = nfs_alloc_server();
1109         if (!server)
1110                 return ERR_PTR(-ENOMEM);
1111
1112         auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1113
1114         /* set up the general RPC client */
1115         error = nfs4_init_server(server, mount_info->parsed);
1116         if (error < 0)
1117                 goto error;
1118
1119         error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1120         if (error < 0)
1121                 goto error;
1122
1123         return server;
1124
1125 error:
1126         nfs_free_server(server);
1127         return ERR_PTR(error);
1128 }
1129
1130 /*
1131  * Create an NFS4 referral server record
1132  */
1133 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1134                                                struct nfs_fh *mntfh)
1135 {
1136         struct nfs_client *parent_client;
1137         struct nfs_server *server, *parent_server;
1138         bool auth_probe;
1139         int error;
1140
1141         server = nfs_alloc_server();
1142         if (!server)
1143                 return ERR_PTR(-ENOMEM);
1144
1145         parent_server = NFS_SB(data->sb);
1146         parent_client = parent_server->nfs_client;
1147
1148         /* Initialise the client representation from the parent server */
1149         nfs_server_copy_userdata(server, parent_server);
1150
1151         /* Get a client representation */
1152 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1153         rpc_set_port(data->addr, NFS_RDMA_PORT);
1154         error = nfs4_set_client(server, data->hostname,
1155                                 data->addr,
1156                                 data->addrlen,
1157                                 parent_client->cl_ipaddr,
1158                                 XPRT_TRANSPORT_RDMA,
1159                                 parent_server->client->cl_timeout,
1160                                 parent_client->cl_mvops->minor_version,
1161                                 parent_client->cl_net);
1162         if (!error)
1163                 goto init_server;
1164 #endif  /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1165
1166         rpc_set_port(data->addr, NFS_PORT);
1167         error = nfs4_set_client(server, data->hostname,
1168                                 data->addr,
1169                                 data->addrlen,
1170                                 parent_client->cl_ipaddr,
1171                                 XPRT_TRANSPORT_TCP,
1172                                 parent_server->client->cl_timeout,
1173                                 parent_client->cl_mvops->minor_version,
1174                                 parent_client->cl_net);
1175         if (error < 0)
1176                 goto error;
1177
1178 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1179 init_server:
1180 #endif
1181         error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1182         if (error < 0)
1183                 goto error;
1184
1185         auth_probe = parent_server->auth_info.flavor_len < 1;
1186
1187         error = nfs4_server_common_setup(server, mntfh, auth_probe);
1188         if (error < 0)
1189                 goto error;
1190
1191         return server;
1192
1193 error:
1194         nfs_free_server(server);
1195         return ERR_PTR(error);
1196 }
1197
1198 /*
1199  * Grab the destination's particulars, including lease expiry time.
1200  *
1201  * Returns zero if probe succeeded and retrieved FSID matches the FSID
1202  * we have cached.
1203  */
1204 static int nfs_probe_destination(struct nfs_server *server)
1205 {
1206         struct inode *inode = d_inode(server->super->s_root);
1207         struct nfs_fattr *fattr;
1208         int error;
1209
1210         fattr = nfs_alloc_fattr();
1211         if (fattr == NULL)
1212                 return -ENOMEM;
1213
1214         /* Sanity: the probe won't work if the destination server
1215          * does not recognize the migrated FH. */
1216         error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1217
1218         nfs_free_fattr(fattr);
1219         return error;
1220 }
1221
1222 /**
1223  * nfs4_update_server - Move an nfs_server to a different nfs_client
1224  *
1225  * @server: represents FSID to be moved
1226  * @hostname: new end-point's hostname
1227  * @sap: new end-point's socket address
1228  * @salen: size of "sap"
1229  * @net: net namespace
1230  *
1231  * The nfs_server must be quiescent before this function is invoked.
1232  * Either its session is drained (NFSv4.1+), or its transport is
1233  * plugged and drained (NFSv4.0).
1234  *
1235  * Returns zero on success, or a negative errno value.
1236  */
1237 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1238                        struct sockaddr *sap, size_t salen, struct net *net)
1239 {
1240         struct nfs_client *clp = server->nfs_client;
1241         struct rpc_clnt *clnt = server->client;
1242         struct xprt_create xargs = {
1243                 .ident          = clp->cl_proto,
1244                 .net            = net,
1245                 .dstaddr        = sap,
1246                 .addrlen        = salen,
1247                 .servername     = hostname,
1248         };
1249         char buf[INET6_ADDRSTRLEN + 1];
1250         struct sockaddr_storage address;
1251         struct sockaddr *localaddr = (struct sockaddr *)&address;
1252         int error;
1253
1254         error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1255         if (error != 0)
1256                 return error;
1257
1258         error = rpc_localaddr(clnt, localaddr, sizeof(address));
1259         if (error != 0)
1260                 return error;
1261
1262         if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1263                 return -EAFNOSUPPORT;
1264
1265         nfs_server_remove_lists(server);
1266         set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1267         error = nfs4_set_client(server, hostname, sap, salen, buf,
1268                                 clp->cl_proto, clnt->cl_timeout,
1269                                 clp->cl_minorversion, net);
1270         clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1271         if (error != 0) {
1272                 nfs_server_insert_lists(server);
1273                 return error;
1274         }
1275         nfs_put_client(clp);
1276
1277         if (server->nfs_client->cl_hostname == NULL) {
1278                 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1279                 if (server->nfs_client->cl_hostname == NULL)
1280                         return -ENOMEM;
1281         }
1282         nfs_server_insert_lists(server);
1283
1284         return nfs_probe_destination(server);
1285 }