fs/nfs/client.c

   1 /* client.c: NFS client sharing and management code
   2  *
   3  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12
  13 #include <linux/module.h>
  14 #include <linux/init.h>
  15 #include <linux/sched.h>
  16 #include <linux/time.h>
  17 #include <linux/kernel.h>
  18 #include <linux/mm.h>
  19 #include <linux/string.h>
  20 #include <linux/stat.h>
  21 #include <linux/errno.h>
  22 #include <linux/unistd.h>
  23 #include <linux/sunrpc/clnt.h>
  24 #include <linux/sunrpc/stats.h>
  25 #include <linux/sunrpc/metrics.h>
  26 #include <linux/sunrpc/xprtsock.h>
  27 #include <linux/sunrpc/xprtrdma.h>
  28 #include <linux/nfs_fs.h>
  29 #include <linux/nfs_mount.h>
  30 #include <linux/nfs4_mount.h>
  31 #include <linux/lockd/bind.h>
  32 #include <linux/seq_file.h>
  33 #include <linux/mount.h>
  34 #include <linux/nfs_idmap.h>
  35 #include <linux/vfs.h>
  36 #include <linux/inet.h>
  37 #include <linux/in6.h>
  38 #include <linux/slab.h>
  39 #include <linux/idr.h>
  40 #include <net/ipv6.h>
  41 #include <linux/nfs_xdr.h>
  42 #include <linux/sunrpc/bc_xprt.h>
  43 #include <linux/nsproxy.h>
  44 #include <linux/pid_namespace.h>
  45
  46
  47 #include "nfs4_fs.h"
  48 #include "callback.h"
  49 #include "delegation.h"
  50 #include "iostat.h"
  51 #include "internal.h"
  52 #include "fscache.h"
  53 #include "pnfs.h"
  54 #include "netns.h"
  55
  56 #define NFSDBG_FACILITY         NFSDBG_CLIENT
  57
  58 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
  59
  60 /*
  61  * RPC cruft for NFS
  62  */
  63 static const struct rpc_version *nfs_version[5] = {
  64 #ifdef CONFIG_NFS_V2
  65         [2]                     = &nfs_version2,
  66 #endif
  67 #ifdef CONFIG_NFS_V3
  68         [3]                     = &nfs_version3,
  69 #endif
  70 #ifdef CONFIG_NFS_V4
  71         [4]                     = &nfs_version4,
  72 #endif
  73 };
  74
  75 const struct rpc_program nfs_program = {
  76         .name                   = "nfs",
  77         .number                 = NFS_PROGRAM,
  78         .nrvers                 = ARRAY_SIZE(nfs_version),
  79         .version                = nfs_version,
  80         .stats                  = &nfs_rpcstat,
  81         .pipe_dir_name          = NFS_PIPE_DIRNAME,
  82 };
  83
  84 struct rpc_stat nfs_rpcstat = {
  85         .program                = &nfs_program
  86 };
  87
  88
  89 #ifdef CONFIG_NFS_V3_ACL
  90 static struct rpc_stat          nfsacl_rpcstat = { &nfsacl_program };
  91 static const struct rpc_version *nfsacl_version[] = {
  92         [3]                     = &nfsacl_version3,
  93 };
  94
  95 const struct rpc_program nfsacl_program = {
  96         .name                   = "nfsacl",
  97         .number                 = NFS_ACL_PROGRAM,
  98         .nrvers                 = ARRAY_SIZE(nfsacl_version),
  99         .version                = nfsacl_version,
 100         .stats                  = &nfsacl_rpcstat,
 101 };
 102 #endif  /* CONFIG_NFS_V3_ACL */
 103
 104 /*
 105  * Allocate a shared client record
 106  *
 107  * Since these are allocated/deallocated very rarely, we don't
 108  * bother putting them in a slab cache...
 109  */
 110 struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
 111 {
 112         struct nfs_client *clp;
 113         struct rpc_cred *cred;
 114         int err = -ENOMEM;
 115
 116         if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
 117                 goto error_0;
 118
 119         clp->rpc_ops = cl_init->rpc_ops;
 120
 121         atomic_set(&clp->cl_count, 1);
 122         clp->cl_cons_state = NFS_CS_INITING;
 123
 124         memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
 125         clp->cl_addrlen = cl_init->addrlen;
 126
 127         if (cl_init->hostname) {
 128                 err = -ENOMEM;
 129                 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
 130                 if (!clp->cl_hostname)
 131                         goto error_cleanup;
 132         }
 133
 134         INIT_LIST_HEAD(&clp->cl_superblocks);
 135         clp->cl_rpcclient = ERR_PTR(-EINVAL);
 136
 137         clp->cl_proto = cl_init->proto;
 138         clp->cl_net = get_net(cl_init->net);
 139
 140         cred = rpc_lookup_machine_cred("*");
 141         if (!IS_ERR(cred))
 142                 clp->cl_machine_cred = cred;
 143         nfs_fscache_get_client_cookie(clp);
 144
 145         return clp;
 146
 147 error_cleanup:
 148         kfree(clp);
 149 error_0:
 150         return ERR_PTR(err);
 151 }
 152
 153 #ifdef CONFIG_NFS_V4
 154 /* idr_remove_all is not needed as all id's are removed by nfs_put_client */
 155 void nfs_cleanup_cb_ident_idr(struct net *net)
 156 {
 157         struct nfs_net *nn = net_generic(net, nfs_net_id);
 158
 159         idr_destroy(&nn->cb_ident_idr);
 160 }
 161
 162 /* nfs_client_lock held */
 163 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
 164 {
 165         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
 166
 167         if (clp->cl_cb_ident)
 168                 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
 169 }
 170
 171 static void pnfs_init_server(struct nfs_server *server)
 172 {
 173         rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
 174 }
 175
 176 #else
 177 void nfs_cleanup_cb_ident_idr(struct net *net)
 178 {
 179 }
 180
 181 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
 182 {
 183 }
 184
 185 static void pnfs_init_server(struct nfs_server *server)
 186 {
 187 }
 188
 189 #endif /* CONFIG_NFS_V4 */
 190
 191 /*
 192  * Destroy a shared client record
 193  */
 194 void nfs_free_client(struct nfs_client *clp)
 195 {
 196         dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
 197
 198         nfs_fscache_release_client_cookie(clp);
 199
 200         /* -EIO all pending I/O */
 201         if (!IS_ERR(clp->cl_rpcclient))
 202                 rpc_shutdown_client(clp->cl_rpcclient);
 203
 204         if (clp->cl_machine_cred != NULL)
 205                 put_rpccred(clp->cl_machine_cred);
 206
 207         put_net(clp->cl_net);
 208         kfree(clp->cl_hostname);
 209         kfree(clp);
 210
 211         dprintk("<-- nfs_free_client()\n");
 212 }
 213
 214 /*
 215  * Release a reference to a shared client record
 216  */
 217 void nfs_put_client(struct nfs_client *clp)
 218 {
 219         struct nfs_net *nn;
 220
 221         if (!clp)
 222                 return;
 223
 224         dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
 225         nn = net_generic(clp->cl_net, nfs_net_id);
 226
 227         if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
 228                 list_del(&clp->cl_share_link);
 229                 nfs_cb_idr_remove_locked(clp);
 230                 spin_unlock(&nn->nfs_client_lock);
 231
 232                 BUG_ON(!list_empty(&clp->cl_superblocks));
 233
 234                 clp->rpc_ops->free_client(clp);
 235         }
 236 }
 237 EXPORT_SYMBOL_GPL(nfs_put_client);
 238
 239 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 240 /*
 241  * Test if two ip6 socket addresses refer to the same socket by
 242  * comparing relevant fields. The padding bytes specifically, are not
 243  * compared. sin6_flowinfo is not compared because it only affects QoS
 244  * and sin6_scope_id is only compared if the address is "link local"
 245  * because "link local" addresses need only be unique to a specific
 246  * link. Conversely, ordinary unicast addresses might have different
 247  * sin6_scope_id.
 248  *
 249  * The caller should ensure both socket addresses are AF_INET6.
 250  */
 251 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
 252                                       const struct sockaddr *sa2)
 253 {
 254         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
 255         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
 256
 257         if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
 258                 return 0;
 259         else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
 260                 return sin1->sin6_scope_id == sin2->sin6_scope_id;
 261
 262         return 1;
 263 }
 264 #else   /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
 265 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
 266                                       const struct sockaddr *sa2)
 267 {
 268         return 0;
 269 }
 270 #endif
 271
 272 /*
 273  * Test if two ip4 socket addresses refer to the same socket, by
 274  * comparing relevant fields. The padding bytes specifically, are
 275  * not compared.
 276  *
 277  * The caller should ensure both socket addresses are AF_INET.
 278  */
 279 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
 280                                       const struct sockaddr *sa2)
 281 {
 282         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
 283         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
 284
 285         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
 286 }
 287
 288 static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
 289                                 const struct sockaddr *sa2)
 290 {
 291         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
 292         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
 293
 294         return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
 295                 (sin1->sin6_port == sin2->sin6_port);
 296 }
 297
 298 static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
 299                                 const struct sockaddr *sa2)
 300 {
 301         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
 302         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
 303
 304         return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
 305                 (sin1->sin_port == sin2->sin_port);
 306 }
 307
 308 #if defined(CONFIG_NFS_V4_1)
 309 /*
 310  * Test if two socket addresses represent the same actual socket,
 311  * by comparing (only) relevant fields, excluding the port number.
 312  */
 313 int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
 314                               const struct sockaddr *sa2)
 315 {
 316         if (sa1->sa_family != sa2->sa_family)
 317                 return 0;
 318
 319         switch (sa1->sa_family) {
 320         case AF_INET:
 321                 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
 322         case AF_INET6:
 323                 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
 324         }
 325         return 0;
 326 }
 327 #endif /* CONFIG_NFS_V4_1 */
 328
 329 /*
 330  * Test if two socket addresses represent the same actual socket,
 331  * by comparing (only) relevant fields, including the port number.
 332  */
 333 static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
 334                             const struct sockaddr *sa2)
 335 {
 336         if (sa1->sa_family != sa2->sa_family)
 337                 return 0;
 338
 339         switch (sa1->sa_family) {
 340         case AF_INET:
 341                 return nfs_sockaddr_cmp_ip4(sa1, sa2);
 342         case AF_INET6:
 343                 return nfs_sockaddr_cmp_ip6(sa1, sa2);
 344         }
 345         return 0;
 346 }
 347
 348 /*
 349  * Find an nfs_client on the list that matches the initialisation data
 350  * that is supplied.
 351  */
 352 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
 353 {
 354         struct nfs_client *clp;
 355         const struct sockaddr *sap = data->addr;
 356         struct nfs_net *nn = net_generic(data->net, nfs_net_id);
 357
 358         list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
 359                 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
 360                 /* Don't match clients that failed to initialise properly */
 361                 if (clp->cl_cons_state < 0)
 362                         continue;
 363
 364                 /* Different NFS versions cannot share the same nfs_client */
 365                 if (clp->rpc_ops != data->rpc_ops)
 366                         continue;
 367
 368                 if (clp->cl_proto != data->proto)
 369                         continue;
 370                 /* Match nfsv4 minorversion */
 371                 if (clp->cl_minorversion != data->minorversion)
 372                         continue;
 373                 /* Match the full socket address */
 374                 if (!nfs_sockaddr_cmp(sap, clap))
 375                         continue;
 376
 377                 atomic_inc(&clp->cl_count);
 378                 return clp;
 379         }
 380         return NULL;
 381 }
 382
 383 static bool nfs_client_init_is_complete(const struct nfs_client *clp)
 384 {
 385         return clp->cl_cons_state != NFS_CS_INITING;
 386 }
 387
 388 int nfs_wait_client_init_complete(const struct nfs_client *clp)
 389 {
 390         return wait_event_killable(nfs_client_active_wq,
 391                         nfs_client_init_is_complete(clp));
 392 }
 393
 394 /*
 395  * Found an existing client.  Make sure it's ready before returning.
 396  */
 397 static struct nfs_client *
 398 nfs_found_client(const struct nfs_client_initdata *cl_init,
 399                  struct nfs_client *clp)
 400 {
 401         int error;
 402
 403         error = nfs_wait_client_init_complete(clp);
 404         if (error < 0) {
 405                 nfs_put_client(clp);
 406                 return ERR_PTR(-ERESTARTSYS);
 407         }
 408
 409         if (clp->cl_cons_state < NFS_CS_READY) {
 410                 error = clp->cl_cons_state;
 411                 nfs_put_client(clp);
 412                 return ERR_PTR(error);
 413         }
 414
 415         smp_rmb();
 416
 417         dprintk("<-- %s found nfs_client %p for %s\n",
 418                 __func__, clp, cl_init->hostname ?: "");
 419         return clp;
 420 }
 421
 422 /*
 423  * Look up a client by IP address and protocol version
 424  * - creates a new record if one doesn't yet exist
 425  */
 426 struct nfs_client *
 427 nfs_get_client(const struct nfs_client_initdata *cl_init,
 428                const struct rpc_timeout *timeparms,
 429                const char *ip_addr,
 430                rpc_authflavor_t authflavour)
 431 {
 432         struct nfs_client *clp, *new = NULL;
 433         struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
 434
 435         dprintk("--> nfs_get_client(%s,v%u)\n",
 436                 cl_init->hostname ?: "", cl_init->rpc_ops->version);
 437
 438         /* see if the client already exists */
 439         do {
 440                 spin_lock(&nn->nfs_client_lock);
 441
 442                 clp = nfs_match_client(cl_init);
 443                 if (clp) {
 444                         spin_unlock(&nn->nfs_client_lock);
 445                         if (new)
 446                                 new->rpc_ops->free_client(new);
 447                         return nfs_found_client(cl_init, clp);
 448                 }
 449                 if (new) {
 450                         list_add(&new->cl_share_link, &nn->nfs_client_list);
 451                         spin_unlock(&nn->nfs_client_lock);
 452                         new->cl_flags = cl_init->init_flags;
 453                         return cl_init->rpc_ops->init_client(new,
 454                                                 timeparms, ip_addr,
 455                                                 authflavour);
 456                 }
 457
 458                 spin_unlock(&nn->nfs_client_lock);
 459
 460                 new = cl_init->rpc_ops->alloc_client(cl_init);
 461         } while (!IS_ERR(new));
 462
 463         dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
 464                 cl_init->hostname ?: "", PTR_ERR(new));
 465         return new;
 466 }
 467
 468 /*
 469  * Mark a server as ready or failed
 470  */
 471 void nfs_mark_client_ready(struct nfs_client *clp, int state)
 472 {
 473         smp_wmb();
 474         clp->cl_cons_state = state;
 475         wake_up_all(&nfs_client_active_wq);
 476 }
 477
 478 /*
 479  * Initialise the timeout values for a connection
 480  */
 481 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
 482                                     unsigned int timeo, unsigned int retrans)
 483 {
 484         to->to_initval = timeo * HZ / 10;
 485         to->to_retries = retrans;
 486
 487         switch (proto) {
 488         case XPRT_TRANSPORT_TCP:
 489         case XPRT_TRANSPORT_RDMA:
 490                 if (to->to_retries == 0)
 491                         to->to_retries = NFS_DEF_TCP_RETRANS;
 492                 if (to->to_initval == 0)
 493                         to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
 494                 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
 495                         to->to_initval = NFS_MAX_TCP_TIMEOUT;
 496                 to->to_increment = to->to_initval;
 497                 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
 498                 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
 499                         to->to_maxval = NFS_MAX_TCP_TIMEOUT;
 500                 if (to->to_maxval < to->to_initval)
 501                         to->to_maxval = to->to_initval;
 502                 to->to_exponential = 0;
 503                 break;
 504         case XPRT_TRANSPORT_UDP:
 505                 if (to->to_retries == 0)
 506                         to->to_retries = NFS_DEF_UDP_RETRANS;
 507                 if (!to->to_initval)
 508                         to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
 509                 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
 510                         to->to_initval = NFS_MAX_UDP_TIMEOUT;
 511                 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
 512                 to->to_exponential = 1;
 513                 break;
 514         default:
 515                 BUG();
 516         }
 517 }
 518
 519 /*
 520  * Create an RPC client handle
 521  */
 522 int nfs_create_rpc_client(struct nfs_client *clp,
 523                           const struct rpc_timeout *timeparms,
 524                           rpc_authflavor_t flavor)
 525 {
 526         struct rpc_clnt         *clnt = NULL;
 527         struct rpc_create_args args = {
 528                 .net            = clp->cl_net,
 529                 .protocol       = clp->cl_proto,
 530                 .address        = (struct sockaddr *)&clp->cl_addr,
 531                 .addrsize       = clp->cl_addrlen,
 532                 .timeout        = timeparms,
 533                 .servername     = clp->cl_hostname,
 534                 .program        = &nfs_program,
 535                 .version        = clp->rpc_ops->version,
 536                 .authflavor     = flavor,
 537         };
 538
 539         if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
 540                 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
 541         if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
 542                 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
 543
 544         if (!IS_ERR(clp->cl_rpcclient))
 545                 return 0;
 546
 547         clnt = rpc_create(&args);
 548         if (IS_ERR(clnt)) {
 549                 dprintk("%s: cannot create RPC client. Error = %ld\n",
 550                                 __func__, PTR_ERR(clnt));
 551                 return PTR_ERR(clnt);
 552         }
 553
 554         clp->cl_rpcclient = clnt;
 555         return 0;
 556 }
 557
 558 /*
 559  * Version 2 or 3 client destruction
 560  */
 561 static void nfs_destroy_server(struct nfs_server *server)
 562 {
 563         if (!(server->flags & NFS_MOUNT_LOCAL_FLOCK) ||
 564                         !(server->flags & NFS_MOUNT_LOCAL_FCNTL))
 565                 nlmclnt_done(server->nlm_host);
 566 }
 567
 568 /*
 569  * Version 2 or 3 lockd setup
 570  */
 571 static int nfs_start_lockd(struct nfs_server *server)
 572 {
 573         struct nlm_host *host;
 574         struct nfs_client *clp = server->nfs_client;
 575         struct nlmclnt_initdata nlm_init = {
 576                 .hostname       = clp->cl_hostname,
 577                 .address        = (struct sockaddr *)&clp->cl_addr,
 578                 .addrlen        = clp->cl_addrlen,
 579                 .nfs_version    = clp->rpc_ops->version,
 580                 .noresvport     = server->flags & NFS_MOUNT_NORESVPORT ?
 581                                         1 : 0,
 582                 .net            = clp->cl_net,
 583         };
 584
 585         if (nlm_init.nfs_version > 3)
 586                 return 0;
 587         if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
 588                         (server->flags & NFS_MOUNT_LOCAL_FCNTL))
 589                 return 0;
 590
 591         switch (clp->cl_proto) {
 592                 default:
 593                         nlm_init.protocol = IPPROTO_TCP;
 594                         break;
 595                 case XPRT_TRANSPORT_UDP:
 596                         nlm_init.protocol = IPPROTO_UDP;
 597         }
 598
 599         host = nlmclnt_init(&nlm_init);
 600         if (IS_ERR(host))
 601                 return PTR_ERR(host);
 602
 603         server->nlm_host = host;
 604         server->destroy = nfs_destroy_server;
 605         return 0;
 606 }
 607
 608 /*
 609  * Initialise an NFSv3 ACL client connection
 610  */
 611 #ifdef CONFIG_NFS_V3_ACL
 612 static void nfs_init_server_aclclient(struct nfs_server *server)
 613 {
 614         if (server->nfs_client->rpc_ops->version != 3)
 615                 goto out_noacl;
 616         if (server->flags & NFS_MOUNT_NOACL)
 617                 goto out_noacl;
 618
 619         server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
 620         if (IS_ERR(server->client_acl))
 621                 goto out_noacl;
 622
 623         /* No errors! Assume that Sun nfsacls are supported */
 624         server->caps |= NFS_CAP_ACLS;
 625         return;
 626
 627 out_noacl:
 628         server->caps &= ~NFS_CAP_ACLS;
 629 }
 630 #else
 631 static inline void nfs_init_server_aclclient(struct nfs_server *server)
 632 {
 633         server->flags &= ~NFS_MOUNT_NOACL;
 634         server->caps &= ~NFS_CAP_ACLS;
 635 }
 636 #endif
 637
 638 /*
 639  * Create a general RPC client
 640  */
 641 int nfs_init_server_rpcclient(struct nfs_server *server,
 642                 const struct rpc_timeout *timeo,
 643                 rpc_authflavor_t pseudoflavour)
 644 {
 645         struct nfs_client *clp = server->nfs_client;
 646
 647         server->client = rpc_clone_client(clp->cl_rpcclient);
 648         if (IS_ERR(server->client)) {
 649                 dprintk("%s: couldn't create rpc_client!\n", __func__);
 650                 return PTR_ERR(server->client);
 651         }
 652
 653         memcpy(&server->client->cl_timeout_default,
 654                         timeo,
 655                         sizeof(server->client->cl_timeout_default));
 656         server->client->cl_timeout = &server->client->cl_timeout_default;
 657
 658         if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
 659                 struct rpc_auth *auth;
 660
 661                 auth = rpcauth_create(pseudoflavour, server->client);
 662                 if (IS_ERR(auth)) {
 663                         dprintk("%s: couldn't create credcache!\n", __func__);
 664                         return PTR_ERR(auth);
 665                 }
 666         }
 667         server->client->cl_softrtry = 0;
 668         if (server->flags & NFS_MOUNT_SOFT)
 669                 server->client->cl_softrtry = 1;
 670
 671         return 0;
 672 }
 673
 674 /**
 675  * nfs_init_client - Initialise an NFS2 or NFS3 client
 676  *
 677  * @clp: nfs_client to initialise
 678  * @timeparms: timeout parameters for underlying RPC transport
 679  * @ip_addr: IP presentation address (not used)
 680  * @authflavor: authentication flavor for underlying RPC transport
 681  *
 682  * Returns pointer to an NFS client, or an ERR_PTR value.
 683  */
 684 struct nfs_client *nfs_init_client(struct nfs_client *clp,
 685                     const struct rpc_timeout *timeparms,
 686                     const char *ip_addr, rpc_authflavor_t authflavour)
 687 {
 688         int error;
 689
 690         if (clp->cl_cons_state == NFS_CS_READY) {
 691                 /* the client is already initialised */
 692                 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
 693                 return clp;
 694         }
 695
 696         /*
 697          * Create a client RPC handle for doing FSSTAT with UNIX auth only
 698          * - RFC 2623, sec 2.3.2
 699          */
 700         error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
 701         if (error < 0)
 702                 goto error;
 703         nfs_mark_client_ready(clp, NFS_CS_READY);
 704         return clp;
 705
 706 error:
 707         nfs_mark_client_ready(clp, error);
 708         nfs_put_client(clp);
 709         dprintk("<-- nfs_init_client() = xerror %d\n", error);
 710         return ERR_PTR(error);
 711 }
 712
 713 /*
 714  * Create a version 2 or 3 client
 715  */
 716 static int nfs_init_server(struct nfs_server *server,
 717                            const struct nfs_parsed_mount_data *data)
 718 {
 719         struct nfs_client_initdata cl_init = {
 720                 .hostname = data->nfs_server.hostname,
 721                 .addr = (const struct sockaddr *)&data->nfs_server.address,
 722                 .addrlen = data->nfs_server.addrlen,
 723                 .rpc_ops = NULL,
 724                 .proto = data->nfs_server.protocol,
 725                 .net = data->net,
 726         };
 727         struct rpc_timeout timeparms;
 728         struct nfs_client *clp;
 729         int error;
 730
 731         dprintk("--> nfs_init_server()\n");
 732
 733         switch (data->version) {
 734 #ifdef CONFIG_NFS_V2
 735         case 2:
 736                 cl_init.rpc_ops = &nfs_v2_clientops;
 737                 break;
 738 #endif
 739 #ifdef CONFIG_NFS_V3
 740         case 3:
 741                 cl_init.rpc_ops = &nfs_v3_clientops;
 742                 break;
 743 #endif
 744         default:
 745                 return -EPROTONOSUPPORT;
 746         }
 747
 748         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
 749                         data->timeo, data->retrans);
 750         if (data->flags & NFS_MOUNT_NORESVPORT)
 751                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
 752
 753         /* Allocate or find a client reference we can use */
 754         clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX);
 755         if (IS_ERR(clp)) {
 756                 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
 757                 return PTR_ERR(clp);
 758         }
 759
 760         server->nfs_client = clp;
 761
 762         /* Initialise the client representation from the mount data */
 763         server->flags = data->flags;
 764         server->options = data->options;
 765         server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
 766                 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
 767                 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME|NFS_CAP_CHANGE_ATTR;
 768
 769         if (data->rsize)
 770                 server->rsize = nfs_block_size(data->rsize, NULL);
 771         if (data->wsize)
 772                 server->wsize = nfs_block_size(data->wsize, NULL);
 773
 774         server->acregmin = data->acregmin * HZ;
 775         server->acregmax = data->acregmax * HZ;
 776         server->acdirmin = data->acdirmin * HZ;
 777         server->acdirmax = data->acdirmax * HZ;
 778
 779         /* Start lockd here, before we might error out */
 780         error = nfs_start_lockd(server);
 781         if (error < 0)
 782                 goto error;
 783
 784         server->port = data->nfs_server.port;
 785
 786         error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
 787         if (error < 0)
 788                 goto error;
 789
 790         /* Preserve the values of mount_server-related mount options */
 791         if (data->mount_server.addrlen) {
 792                 memcpy(&server->mountd_address, &data->mount_server.address,
 793                         data->mount_server.addrlen);
 794                 server->mountd_addrlen = data->mount_server.addrlen;
 795         }
 796         server->mountd_version = data->mount_server.version;
 797         server->mountd_port = data->mount_server.port;
 798         server->mountd_protocol = data->mount_server.protocol;
 799
 800         server->namelen  = data->namlen;
 801         /* Create a client RPC handle for the NFSv3 ACL management interface */
 802         nfs_init_server_aclclient(server);
 803         dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
 804         return 0;
 805
 806 error:
 807         server->nfs_client = NULL;
 808         nfs_put_client(clp);
 809         dprintk("<-- nfs_init_server() = xerror %d\n", error);
 810         return error;
 811 }
 812
 813 /*
 814  * Load up the server record from information gained in an fsinfo record
 815  */
 816 static void nfs_server_set_fsinfo(struct nfs_server *server,
 817                                   struct nfs_fh *mntfh,
 818                                   struct nfs_fsinfo *fsinfo)
 819 {
 820         unsigned long max_rpc_payload;
 821
 822         /* Work out a lot of parameters */
 823         if (server->rsize == 0)
 824                 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
 825         if (server->wsize == 0)
 826                 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
 827
 828         if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
 829                 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
 830         if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
 831                 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
 832
 833         max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
 834         if (server->rsize > max_rpc_payload)
 835                 server->rsize = max_rpc_payload;
 836         if (server->rsize > NFS_MAX_FILE_IO_SIZE)
 837                 server->rsize = NFS_MAX_FILE_IO_SIZE;
 838         server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
 839
 840         server->backing_dev_info.name = "nfs";
 841         server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
 842
 843         if (server->wsize > max_rpc_payload)
 844                 server->wsize = max_rpc_payload;
 845         if (server->wsize > NFS_MAX_FILE_IO_SIZE)
 846                 server->wsize = NFS_MAX_FILE_IO_SIZE;
 847         server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
 848         server->pnfs_blksize = fsinfo->blksize;
 849
 850         server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
 851
 852         server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
 853         if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
 854                 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
 855         if (server->dtsize > server->rsize)
 856                 server->dtsize = server->rsize;
 857
 858         if (server->flags & NFS_MOUNT_NOAC) {
 859                 server->acregmin = server->acregmax = 0;
 860                 server->acdirmin = server->acdirmax = 0;
 861         }
 862
 863         server->maxfilesize = fsinfo->maxfilesize;
 864
 865         server->time_delta = fsinfo->time_delta;
 866
 867         /* We're airborne Set socket buffersize */
 868         rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
 869 }
 870
 871 /*
 872  * Probe filesystem information, including the FSID on v2/v3
 873  */
 874 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
 875 {
 876         struct nfs_fsinfo fsinfo;
 877         struct nfs_client *clp = server->nfs_client;
 878         int error;
 879
 880         dprintk("--> nfs_probe_fsinfo()\n");
 881
 882         if (clp->rpc_ops->set_capabilities != NULL) {
 883                 error = clp->rpc_ops->set_capabilities(server, mntfh);
 884                 if (error < 0)
 885                         goto out_error;
 886         }
 887
 888         fsinfo.fattr = fattr;
 889         fsinfo.layouttype = 0;
 890         error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
 891         if (error < 0)
 892                 goto out_error;
 893
 894         nfs_server_set_fsinfo(server, mntfh, &fsinfo);
 895
 896         /* Get some general file system info */
 897         if (server->namelen == 0) {
 898                 struct nfs_pathconf pathinfo;
 899
 900                 pathinfo.fattr = fattr;
 901                 nfs_fattr_init(fattr);
 902
 903                 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
 904                         server->namelen = pathinfo.max_namelen;
 905         }
 906
 907         dprintk("<-- nfs_probe_fsinfo() = 0\n");
 908         return 0;
 909
 910 out_error:
 911         dprintk("nfs_probe_fsinfo: error = %d\n", -error);
 912         return error;
 913 }
 914
 915 /*
 916  * Copy useful information when duplicating a server record
 917  */
 918 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
 919 {
 920         target->flags = source->flags;
 921         target->rsize = source->rsize;
 922         target->wsize = source->wsize;
 923         target->acregmin = source->acregmin;
 924         target->acregmax = source->acregmax;
 925         target->acdirmin = source->acdirmin;
 926         target->acdirmax = source->acdirmax;
 927         target->caps = source->caps;
 928         target->options = source->options;
 929 }
 930
 931 void nfs_server_insert_lists(struct nfs_server *server)
 932 {
 933         struct nfs_client *clp = server->nfs_client;
 934         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
 935
 936         spin_lock(&nn->nfs_client_lock);
 937         list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
 938         list_add_tail(&server->master_link, &nn->nfs_volume_list);
 939         clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
 940         spin_unlock(&nn->nfs_client_lock);
 941
 942 }
 943
 944 static void nfs_server_remove_lists(struct nfs_server *server)
 945 {
 946         struct nfs_client *clp = server->nfs_client;
 947         struct nfs_net *nn;
 948
 949         if (clp == NULL)
 950                 return;
 951         nn = net_generic(clp->cl_net, nfs_net_id);
 952         spin_lock(&nn->nfs_client_lock);
 953         list_del_rcu(&server->client_link);
 954         if (list_empty(&clp->cl_superblocks))
 955                 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
 956         list_del(&server->master_link);
 957         spin_unlock(&nn->nfs_client_lock);
 958
 959         synchronize_rcu();
 960 }
 961
 962 /*
 963  * Allocate and initialise a server record
 964  */
 965 struct nfs_server *nfs_alloc_server(void)
 966 {
 967         struct nfs_server *server;
 968
 969         server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
 970         if (!server)
 971                 return NULL;
 972
 973         server->client = server->client_acl = ERR_PTR(-EINVAL);
 974
 975         /* Zero out the NFS state stuff */
 976         INIT_LIST_HEAD(&server->client_link);
 977         INIT_LIST_HEAD(&server->master_link);
 978         INIT_LIST_HEAD(&server->delegations);
 979         INIT_LIST_HEAD(&server->layouts);
 980         INIT_LIST_HEAD(&server->state_owners_lru);
 981
 982         atomic_set(&server->active, 0);
 983
 984         server->io_stats = nfs_alloc_iostats();
 985         if (!server->io_stats) {
 986                 kfree(server);
 987                 return NULL;
 988         }
 989
 990         if (bdi_init(&server->backing_dev_info)) {
 991                 nfs_free_iostats(server->io_stats);
 992                 kfree(server);
 993                 return NULL;
 994         }
 995
 996         ida_init(&server->openowner_id);
 997         ida_init(&server->lockowner_id);
 998         pnfs_init_server(server);
 999
1000         return server;
1001 }
1002
1003 /*
1004  * Free up a server record
1005  */
1006 void nfs_free_server(struct nfs_server *server)
1007 {
1008         dprintk("--> nfs_free_server()\n");
1009
1010         nfs_server_remove_lists(server);
1011
1012         if (server->destroy != NULL)
1013                 server->destroy(server);
1014
1015         if (!IS_ERR(server->client_acl))
1016                 rpc_shutdown_client(server->client_acl);
1017         if (!IS_ERR(server->client))
1018                 rpc_shutdown_client(server->client);
1019
1020         nfs_put_client(server->nfs_client);
1021
1022         ida_destroy(&server->lockowner_id);
1023         ida_destroy(&server->openowner_id);
1024         nfs_free_iostats(server->io_stats);
1025         bdi_destroy(&server->backing_dev_info);
1026         kfree(server);
1027         nfs_release_automount_timer();
1028         dprintk("<-- nfs_free_server()\n");
1029 }
1030
1031 /*
1032  * Create a version 2 or 3 volume record
1033  * - keyed on server and FSID
1034  */
1035 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
1036                                      struct nfs_fh *mntfh)
1037 {
1038         struct nfs_server *server;
1039         struct nfs_fattr *fattr;
1040         int error;
1041
1042         server = nfs_alloc_server();
1043         if (!server)
1044                 return ERR_PTR(-ENOMEM);
1045
1046         error = -ENOMEM;
1047         fattr = nfs_alloc_fattr();
1048         if (fattr == NULL)
1049                 goto error;
1050
1051         /* Get a client representation */
1052         error = nfs_init_server(server, data);
1053         if (error < 0)
1054                 goto error;
1055
1056         BUG_ON(!server->nfs_client);
1057         BUG_ON(!server->nfs_client->rpc_ops);
1058         BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1059
1060         /* Probe the root fh to retrieve its FSID */
1061         error = nfs_probe_fsinfo(server, mntfh, fattr);
1062         if (error < 0)
1063                 goto error;
1064         if (server->nfs_client->rpc_ops->version == 3) {
1065                 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1066                         server->namelen = NFS3_MAXNAMLEN;
1067                 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1068                         server->caps |= NFS_CAP_READDIRPLUS;
1069         } else {
1070                 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1071                         server->namelen = NFS2_MAXNAMLEN;
1072         }
1073
1074         if (!(fattr->valid & NFS_ATTR_FATTR)) {
1075                 error = server->nfs_client->rpc_ops->getattr(server, mntfh, fattr);
1076                 if (error < 0) {
1077                         dprintk("nfs_create_server: getattr error = %d\n", -error);
1078                         goto error;
1079                 }
1080         }
1081         memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1082
1083         dprintk("Server FSID: %llx:%llx\n",
1084                 (unsigned long long) server->fsid.major,
1085                 (unsigned long long) server->fsid.minor);
1086
1087         nfs_server_insert_lists(server);
1088         server->mount_time = jiffies;
1089         nfs_free_fattr(fattr);
1090         return server;
1091
1092 error:
1093         nfs_free_fattr(fattr);
1094         nfs_free_server(server);
1095         return ERR_PTR(error);
1096 }
1097
1098 /*
1099  * Clone an NFS2, NFS3 or NFS4 server record
1100  */
1101 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1102                                     struct nfs_fh *fh,
1103                                     struct nfs_fattr *fattr,
1104                                     rpc_authflavor_t flavor)
1105 {
1106         struct nfs_server *server;
1107         struct nfs_fattr *fattr_fsinfo;
1108         int error;
1109
1110         dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1111                 (unsigned long long) fattr->fsid.major,
1112                 (unsigned long long) fattr->fsid.minor);
1113
1114         server = nfs_alloc_server();
1115         if (!server)
1116                 return ERR_PTR(-ENOMEM);
1117
1118         error = -ENOMEM;
1119         fattr_fsinfo = nfs_alloc_fattr();
1120         if (fattr_fsinfo == NULL)
1121                 goto out_free_server;
1122
1123         /* Copy data from the source */
1124         server->nfs_client = source->nfs_client;
1125         server->destroy = source->destroy;
1126         atomic_inc(&server->nfs_client->cl_count);
1127         nfs_server_copy_userdata(server, source);
1128
1129         server->fsid = fattr->fsid;
1130
1131         error = nfs_init_server_rpcclient(server,
1132                         source->client->cl_timeout,
1133                         flavor);
1134         if (error < 0)
1135                 goto out_free_server;
1136         if (!IS_ERR(source->client_acl))
1137                 nfs_init_server_aclclient(server);
1138
1139         /* probe the filesystem info for this server filesystem */
1140         error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1141         if (error < 0)
1142                 goto out_free_server;
1143
1144         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1145                 server->namelen = NFS4_MAXNAMLEN;
1146
1147         dprintk("Cloned FSID: %llx:%llx\n",
1148                 (unsigned long long) server->fsid.major,
1149                 (unsigned long long) server->fsid.minor);
1150
1151         error = nfs_start_lockd(server);
1152         if (error < 0)
1153                 goto out_free_server;
1154
1155         nfs_server_insert_lists(server);
1156         server->mount_time = jiffies;
1157
1158         nfs_free_fattr(fattr_fsinfo);
1159         dprintk("<-- nfs_clone_server() = %p\n", server);
1160         return server;
1161
1162 out_free_server:
1163         nfs_free_fattr(fattr_fsinfo);
1164         nfs_free_server(server);
1165         dprintk("<-- nfs_clone_server() = error %d\n", error);
1166         return ERR_PTR(error);
1167 }
1168
1169 void nfs_clients_init(struct net *net)
1170 {
1171         struct nfs_net *nn = net_generic(net, nfs_net_id);
1172
1173         INIT_LIST_HEAD(&nn->nfs_client_list);
1174         INIT_LIST_HEAD(&nn->nfs_volume_list);
1175 #ifdef CONFIG_NFS_V4
1176         idr_init(&nn->cb_ident_idr);
1177 #endif
1178         spin_lock_init(&nn->nfs_client_lock);
1179         nn->boot_time = CURRENT_TIME;
1180 }
1181
1182 #ifdef CONFIG_PROC_FS
1183 static struct proc_dir_entry *proc_fs_nfs;
1184
1185 static int nfs_server_list_open(struct inode *inode, struct file *file);
1186 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1187 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1188 static void nfs_server_list_stop(struct seq_file *p, void *v);
1189 static int nfs_server_list_show(struct seq_file *m, void *v);
1190
1191 static const struct seq_operations nfs_server_list_ops = {
1192         .start  = nfs_server_list_start,
1193         .next   = nfs_server_list_next,
1194         .stop   = nfs_server_list_stop,
1195         .show   = nfs_server_list_show,
1196 };
1197
1198 static const struct file_operations nfs_server_list_fops = {
1199         .open           = nfs_server_list_open,
1200         .read           = seq_read,
1201         .llseek         = seq_lseek,
1202         .release        = seq_release,
1203         .owner          = THIS_MODULE,
1204 };
1205
1206 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1207 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1208 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1209 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1210 static int nfs_volume_list_show(struct seq_file *m, void *v);
1211
1212 static const struct seq_operations nfs_volume_list_ops = {
1213         .start  = nfs_volume_list_start,
1214         .next   = nfs_volume_list_next,
1215         .stop   = nfs_volume_list_stop,
1216         .show   = nfs_volume_list_show,
1217 };
1218
1219 static const struct file_operations nfs_volume_list_fops = {
1220         .open           = nfs_volume_list_open,
1221         .read           = seq_read,
1222         .llseek         = seq_lseek,
1223         .release        = seq_release,
1224         .owner          = THIS_MODULE,
1225 };
1226
1227 /*
1228  * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1229  * we're dealing
1230  */
1231 static int nfs_server_list_open(struct inode *inode, struct file *file)
1232 {
1233         struct seq_file *m;
1234         int ret;
1235         struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1236         struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1237
1238         ret = seq_open(file, &nfs_server_list_ops);
1239         if (ret < 0)
1240                 return ret;
1241
1242         m = file->private_data;
1243         m->private = net;
1244
1245         return 0;
1246 }
1247
1248 /*
1249  * set up the iterator to start reading from the server list and return the first item
1250  */
1251 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1252 {
1253         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1254
1255         /* lock the list against modification */
1256         spin_lock(&nn->nfs_client_lock);
1257         return seq_list_start_head(&nn->nfs_client_list, *_pos);
1258 }
1259
1260 /*
1261  * move to next server
1262  */
1263 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1264 {
1265         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1266
1267         return seq_list_next(v, &nn->nfs_client_list, pos);
1268 }
1269
1270 /*
1271  * clean up after reading from the transports list
1272  */
1273 static void nfs_server_list_stop(struct seq_file *p, void *v)
1274 {
1275         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1276
1277         spin_unlock(&nn->nfs_client_lock);
1278 }
1279
1280 /*
1281  * display a header line followed by a load of call lines
1282  */
1283 static int nfs_server_list_show(struct seq_file *m, void *v)
1284 {
1285         struct nfs_client *clp;
1286         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1287
1288         /* display header on line 1 */
1289         if (v == &nn->nfs_client_list) {
1290                 seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1291                 return 0;
1292         }
1293
1294         /* display one transport per line on subsequent lines */
1295         clp = list_entry(v, struct nfs_client, cl_share_link);
1296
1297         /* Check if the client is initialized */
1298         if (clp->cl_cons_state != NFS_CS_READY)
1299                 return 0;
1300
1301         rcu_read_lock();
1302         seq_printf(m, "v%u %s %s %3d %s\n",
1303                    clp->rpc_ops->version,
1304                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1305                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1306                    atomic_read(&clp->cl_count),
1307                    clp->cl_hostname);
1308         rcu_read_unlock();
1309
1310         return 0;
1311 }
1312
1313 /*
1314  * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1315  */
1316 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1317 {
1318         struct seq_file *m;
1319         int ret;
1320         struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1321         struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1322
1323         ret = seq_open(file, &nfs_volume_list_ops);
1324         if (ret < 0)
1325                 return ret;
1326
1327         m = file->private_data;
1328         m->private = net;
1329
1330         return 0;
1331 }
1332
1333 /*
1334  * set up the iterator to start reading from the volume list and return the first item
1335  */
1336 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1337 {
1338         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1339
1340         /* lock the list against modification */
1341         spin_lock(&nn->nfs_client_lock);
1342         return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1343 }
1344
1345 /*
1346  * move to next volume
1347  */
1348 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1349 {
1350         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1351
1352         return seq_list_next(v, &nn->nfs_volume_list, pos);
1353 }
1354
1355 /*
1356  * clean up after reading from the transports list
1357  */
1358 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1359 {
1360         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1361
1362         spin_unlock(&nn->nfs_client_lock);
1363 }
1364
1365 /*
1366  * display a header line followed by a load of call lines
1367  */
1368 static int nfs_volume_list_show(struct seq_file *m, void *v)
1369 {
1370         struct nfs_server *server;
1371         struct nfs_client *clp;
1372         char dev[8], fsid[17];
1373         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1374
1375         /* display header on line 1 */
1376         if (v == &nn->nfs_volume_list) {
1377                 seq_puts(m, "NV SERVER   PORT DEV     FSID              FSC\n");
1378                 return 0;
1379         }
1380         /* display one transport per line on subsequent lines */
1381         server = list_entry(v, struct nfs_server, master_link);
1382         clp = server->nfs_client;
1383
1384         snprintf(dev, 8, "%u:%u",
1385                  MAJOR(server->s_dev), MINOR(server->s_dev));
1386
1387         snprintf(fsid, 17, "%llx:%llx",
1388                  (unsigned long long) server->fsid.major,
1389                  (unsigned long long) server->fsid.minor);
1390
1391         rcu_read_lock();
1392         seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1393                    clp->rpc_ops->version,
1394                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1395                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1396                    dev,
1397                    fsid,
1398                    nfs_server_fscache_state(server));
1399         rcu_read_unlock();
1400
1401         return 0;
1402 }
1403
1404 /*
1405  * initialise the /proc/fs/nfsfs/ directory
1406  */
1407 int __init nfs_fs_proc_init(void)
1408 {
1409         struct proc_dir_entry *p;
1410
1411         proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1412         if (!proc_fs_nfs)
1413                 goto error_0;
1414
1415         /* a file of servers with which we're dealing */
1416         p = proc_create("servers", S_IFREG|S_IRUGO,
1417                         proc_fs_nfs, &nfs_server_list_fops);
1418         if (!p)
1419                 goto error_1;
1420
1421         /* a file of volumes that we have mounted */
1422         p = proc_create("volumes", S_IFREG|S_IRUGO,
1423                         proc_fs_nfs, &nfs_volume_list_fops);
1424         if (!p)
1425                 goto error_2;
1426         return 0;
1427
1428 error_2:
1429         remove_proc_entry("servers", proc_fs_nfs);
1430 error_1:
1431         remove_proc_entry("fs/nfsfs", NULL);
1432 error_0:
1433         return -ENOMEM;
1434 }
1435
1436 /*
1437  * clean up the /proc/fs/nfsfs/ directory
1438  */
1439 void nfs_fs_proc_exit(void)
1440 {
1441         remove_proc_entry("volumes", proc_fs_nfs);
1442         remove_proc_entry("servers", proc_fs_nfs);
1443         remove_proc_entry("fs/nfsfs", NULL);
1444 }
1445
1446 #endif /* CONFIG_PROC_FS */