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