net/sunrpc/rpcb_clnt.c

   1 /*
   2  * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
   3  * protocol
   4  *
   5  * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
   6  * RFC 3530: "Network File System (NFS) version 4 Protocol"
   7  *
   8  * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
   9  * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
  10  *
  11  * Descended from net/sunrpc/pmap_clnt.c,
  12  *  Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
  13  */
  14
  15 #include <linux/module.h>
  16
  17 #include <linux/types.h>
  18 #include <linux/socket.h>
  19 #include <linux/un.h>
  20 #include <linux/in.h>
  21 #include <linux/in6.h>
  22 #include <linux/kernel.h>
  23 #include <linux/errno.h>
  24 #include <linux/mutex.h>
  25 #include <linux/slab.h>
  26 #include <net/ipv6.h>
  27
  28 #include <linux/sunrpc/clnt.h>
  29 #include <linux/sunrpc/addr.h>
  30 #include <linux/sunrpc/sched.h>
  31 #include <linux/sunrpc/xprtsock.h>
  32
  33 #include "netns.h"
  34
  35 #ifdef RPC_DEBUG
  36 # define RPCDBG_FACILITY        RPCDBG_BIND
  37 #endif
  38
  39 #define RPCBIND_SOCK_PATHNAME   "/var/run/rpcbind.sock"
  40
  41 #define RPCBIND_PROGRAM         (100000u)
  42 #define RPCBIND_PORT            (111u)
  43
  44 #define RPCBVERS_2              (2u)
  45 #define RPCBVERS_3              (3u)
  46 #define RPCBVERS_4              (4u)
  47
  48 enum {
  49         RPCBPROC_NULL,
  50         RPCBPROC_SET,
  51         RPCBPROC_UNSET,
  52         RPCBPROC_GETPORT,
  53         RPCBPROC_GETADDR = 3,           /* alias for GETPORT */
  54         RPCBPROC_DUMP,
  55         RPCBPROC_CALLIT,
  56         RPCBPROC_BCAST = 5,             /* alias for CALLIT */
  57         RPCBPROC_GETTIME,
  58         RPCBPROC_UADDR2TADDR,
  59         RPCBPROC_TADDR2UADDR,
  60         RPCBPROC_GETVERSADDR,
  61         RPCBPROC_INDIRECT,
  62         RPCBPROC_GETADDRLIST,
  63         RPCBPROC_GETSTAT,
  64 };
  65
  66 /*
  67  * r_owner
  68  *
  69  * The "owner" is allowed to unset a service in the rpcbind database.
  70  *
  71  * For AF_LOCAL SET/UNSET requests, rpcbind treats this string as a
  72  * UID which it maps to a local user name via a password lookup.
  73  * In all other cases it is ignored.
  74  *
  75  * For SET/UNSET requests, user space provides a value, even for
  76  * network requests, and GETADDR uses an empty string.  We follow
  77  * those precedents here.
  78  */
  79 #define RPCB_OWNER_STRING       "0"
  80 #define RPCB_MAXOWNERLEN        sizeof(RPCB_OWNER_STRING)
  81
  82 /*
  83  * XDR data type sizes
  84  */
  85 #define RPCB_program_sz         (1)
  86 #define RPCB_version_sz         (1)
  87 #define RPCB_protocol_sz        (1)
  88 #define RPCB_port_sz            (1)
  89 #define RPCB_boolean_sz         (1)
  90
  91 #define RPCB_netid_sz           (1 + XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
  92 #define RPCB_addr_sz            (1 + XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
  93 #define RPCB_ownerstring_sz     (1 + XDR_QUADLEN(RPCB_MAXOWNERLEN))
  94
  95 /*
  96  * XDR argument and result sizes
  97  */
  98 #define RPCB_mappingargs_sz     (RPCB_program_sz + RPCB_version_sz + \
  99                                 RPCB_protocol_sz + RPCB_port_sz)
 100 #define RPCB_getaddrargs_sz     (RPCB_program_sz + RPCB_version_sz + \
 101                                 RPCB_netid_sz + RPCB_addr_sz + \
 102                                 RPCB_ownerstring_sz)
 103
 104 #define RPCB_getportres_sz      RPCB_port_sz
 105 #define RPCB_setres_sz          RPCB_boolean_sz
 106
 107 /*
 108  * Note that RFC 1833 does not put any size restrictions on the
 109  * address string returned by the remote rpcbind database.
 110  */
 111 #define RPCB_getaddrres_sz      RPCB_addr_sz
 112
 113 static void                     rpcb_getport_done(struct rpc_task *, void *);
 114 static void                     rpcb_map_release(void *data);
 115 static const struct rpc_program rpcb_program;
 116
 117 struct rpcbind_args {
 118         struct rpc_xprt *       r_xprt;
 119
 120         u32                     r_prog;
 121         u32                     r_vers;
 122         u32                     r_prot;
 123         unsigned short          r_port;
 124         const char *            r_netid;
 125         const char *            r_addr;
 126         const char *            r_owner;
 127
 128         int                     r_status;
 129 };
 130
 131 static struct rpc_procinfo rpcb_procedures2[];
 132 static struct rpc_procinfo rpcb_procedures3[];
 133 static struct rpc_procinfo rpcb_procedures4[];
 134
 135 struct rpcb_info {
 136         u32                     rpc_vers;
 137         struct rpc_procinfo *   rpc_proc;
 138 };
 139
 140 static const struct rpcb_info rpcb_next_version[];
 141 static const struct rpcb_info rpcb_next_version6[];
 142
 143 static const struct rpc_call_ops rpcb_getport_ops = {
 144         .rpc_call_done          = rpcb_getport_done,
 145         .rpc_release            = rpcb_map_release,
 146 };
 147
 148 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
 149 {
 150         xprt_clear_binding(xprt);
 151         rpc_wake_up_status(&xprt->binding, status);
 152 }
 153
 154 static void rpcb_map_release(void *data)
 155 {
 156         struct rpcbind_args *map = data;
 157
 158         rpcb_wake_rpcbind_waiters(map->r_xprt, map->r_status);
 159         xprt_put(map->r_xprt);
 160         kfree(map->r_addr);
 161         kfree(map);
 162 }
 163
 164 static int rpcb_get_local(struct net *net)
 165 {
 166         int cnt;
 167         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 168
 169         spin_lock(&sn->rpcb_clnt_lock);
 170         if (sn->rpcb_users)
 171                 sn->rpcb_users++;
 172         cnt = sn->rpcb_users;
 173         spin_unlock(&sn->rpcb_clnt_lock);
 174
 175         return cnt;
 176 }
 177
 178 void rpcb_put_local(struct net *net)
 179 {
 180         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 181         struct rpc_clnt *clnt = sn->rpcb_local_clnt;
 182         struct rpc_clnt *clnt4 = sn->rpcb_local_clnt4;
 183         int shutdown = 0;
 184
 185         spin_lock(&sn->rpcb_clnt_lock);
 186         if (sn->rpcb_users) {
 187                 if (--sn->rpcb_users == 0) {
 188                         sn->rpcb_local_clnt = NULL;
 189                         sn->rpcb_local_clnt4 = NULL;
 190                 }
 191                 shutdown = !sn->rpcb_users;
 192         }
 193         spin_unlock(&sn->rpcb_clnt_lock);
 194
 195         if (shutdown) {
 196                 /*
 197                  * cleanup_rpcb_clnt - remove xprtsock's sysctls, unregister
 198                  */
 199                 if (clnt4)
 200                         rpc_shutdown_client(clnt4);
 201                 if (clnt)
 202                         rpc_shutdown_client(clnt);
 203         }
 204 }
 205
 206 static void rpcb_set_local(struct net *net, struct rpc_clnt *clnt,
 207                         struct rpc_clnt *clnt4)
 208 {
 209         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 210
 211         /* Protected by rpcb_create_local_mutex */
 212         sn->rpcb_local_clnt = clnt;
 213         sn->rpcb_local_clnt4 = clnt4;
 214         smp_wmb();
 215         sn->rpcb_users = 1;
 216         dprintk("RPC:       created new rpcb local clients (rpcb_local_clnt: "
 217                         "%p, rpcb_local_clnt4: %p) for net %p%s\n",
 218                         sn->rpcb_local_clnt, sn->rpcb_local_clnt4,
 219                         net, (net == &init_net) ? " (init_net)" : "");
 220 }
 221
 222 /*
 223  * Returns zero on success, otherwise a negative errno value
 224  * is returned.
 225  */
 226 static int rpcb_create_local_unix(struct net *net)
 227 {
 228         static const struct sockaddr_un rpcb_localaddr_rpcbind = {
 229                 .sun_family             = AF_LOCAL,
 230                 .sun_path               = RPCBIND_SOCK_PATHNAME,
 231         };
 232         struct rpc_create_args args = {
 233                 .net            = net,
 234                 .protocol       = XPRT_TRANSPORT_LOCAL,
 235                 .address        = (struct sockaddr *)&rpcb_localaddr_rpcbind,
 236                 .addrsize       = sizeof(rpcb_localaddr_rpcbind),
 237                 .servername     = "localhost",
 238                 .program        = &rpcb_program,
 239                 .version        = RPCBVERS_2,
 240                 .authflavor     = RPC_AUTH_NULL,
 241                 /*
 242                  * We turn off the idle timeout to prevent the kernel
 243                  * from automatically disconnecting the socket.
 244                  * Otherwise, we'd have to cache the mount namespace
 245                  * of the caller and somehow pass that to the socket
 246                  * reconnect code.
 247                  */
 248                 .flags          = RPC_CLNT_CREATE_NO_IDLE_TIMEOUT,
 249         };
 250         struct rpc_clnt *clnt, *clnt4;
 251         int result = 0;
 252
 253         /*
 254          * Because we requested an RPC PING at transport creation time,
 255          * this works only if the user space portmapper is rpcbind, and
 256          * it's listening on AF_LOCAL on the named socket.
 257          */
 258         clnt = rpc_create(&args);
 259         if (IS_ERR(clnt)) {
 260                 dprintk("RPC:       failed to create AF_LOCAL rpcbind "
 261                                 "client (errno %ld).\n", PTR_ERR(clnt));
 262                 result = PTR_ERR(clnt);
 263                 goto out;
 264         }
 265
 266         clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
 267         if (IS_ERR(clnt4)) {
 268                 dprintk("RPC:       failed to bind second program to "
 269                                 "rpcbind v4 client (errno %ld).\n",
 270                                 PTR_ERR(clnt4));
 271                 clnt4 = NULL;
 272         }
 273
 274         rpcb_set_local(net, clnt, clnt4);
 275
 276 out:
 277         return result;
 278 }
 279
 280 /*
 281  * Returns zero on success, otherwise a negative errno value
 282  * is returned.
 283  */
 284 static int rpcb_create_local_net(struct net *net)
 285 {
 286         static const struct sockaddr_in rpcb_inaddr_loopback = {
 287                 .sin_family             = AF_INET,
 288                 .sin_addr.s_addr        = htonl(INADDR_LOOPBACK),
 289                 .sin_port               = htons(RPCBIND_PORT),
 290         };
 291         struct rpc_create_args args = {
 292                 .net            = net,
 293                 .protocol       = XPRT_TRANSPORT_TCP,
 294                 .address        = (struct sockaddr *)&rpcb_inaddr_loopback,
 295                 .addrsize       = sizeof(rpcb_inaddr_loopback),
 296                 .servername     = "localhost",
 297                 .program        = &rpcb_program,
 298                 .version        = RPCBVERS_2,
 299                 .authflavor     = RPC_AUTH_UNIX,
 300                 .flags          = RPC_CLNT_CREATE_NOPING,
 301         };
 302         struct rpc_clnt *clnt, *clnt4;
 303         int result = 0;
 304
 305         clnt = rpc_create(&args);
 306         if (IS_ERR(clnt)) {
 307                 dprintk("RPC:       failed to create local rpcbind "
 308                                 "client (errno %ld).\n", PTR_ERR(clnt));
 309                 result = PTR_ERR(clnt);
 310                 goto out;
 311         }
 312
 313         /*
 314          * This results in an RPC ping.  On systems running portmapper,
 315          * the v4 ping will fail.  Proceed anyway, but disallow rpcb
 316          * v4 upcalls.
 317          */
 318         clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
 319         if (IS_ERR(clnt4)) {
 320                 dprintk("RPC:       failed to bind second program to "
 321                                 "rpcbind v4 client (errno %ld).\n",
 322                                 PTR_ERR(clnt4));
 323                 clnt4 = NULL;
 324         }
 325
 326         rpcb_set_local(net, clnt, clnt4);
 327
 328 out:
 329         return result;
 330 }
 331
 332 /*
 333  * Returns zero on success, otherwise a negative errno value
 334  * is returned.
 335  */
 336 int rpcb_create_local(struct net *net)
 337 {
 338         static DEFINE_MUTEX(rpcb_create_local_mutex);
 339         int result = 0;
 340
 341         if (rpcb_get_local(net))
 342                 return result;
 343
 344         mutex_lock(&rpcb_create_local_mutex);
 345         if (rpcb_get_local(net))
 346                 goto out;
 347
 348         if (rpcb_create_local_unix(net) != 0)
 349                 result = rpcb_create_local_net(net);
 350
 351 out:
 352         mutex_unlock(&rpcb_create_local_mutex);
 353         return result;
 354 }
 355
 356 static struct rpc_clnt *rpcb_create(struct net *net, const char *hostname,
 357                                     struct sockaddr *srvaddr, size_t salen,
 358                                     int proto, u32 version)
 359 {
 360         struct rpc_create_args args = {
 361                 .net            = net,
 362                 .protocol       = proto,
 363                 .address        = srvaddr,
 364                 .addrsize       = salen,
 365                 .servername     = hostname,
 366                 .program        = &rpcb_program,
 367                 .version        = version,
 368                 .authflavor     = RPC_AUTH_UNIX,
 369                 .flags          = (RPC_CLNT_CREATE_NOPING |
 370                                         RPC_CLNT_CREATE_NONPRIVPORT),
 371         };
 372
 373         switch (srvaddr->sa_family) {
 374         case AF_INET:
 375                 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
 376                 break;
 377         case AF_INET6:
 378                 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
 379                 break;
 380         default:
 381                 return ERR_PTR(-EAFNOSUPPORT);
 382         }
 383
 384         return rpc_create(&args);
 385 }
 386
 387 static int rpcb_register_call(struct rpc_clnt *clnt, struct rpc_message *msg)
 388 {
 389         int result, error = 0;
 390
 391         msg->rpc_resp = &result;
 392
 393         error = rpc_call_sync(clnt, msg, RPC_TASK_SOFTCONN);
 394         if (error < 0) {
 395                 dprintk("RPC:       failed to contact local rpcbind "
 396                                 "server (errno %d).\n", -error);
 397                 return error;
 398         }
 399
 400         if (!result)
 401                 return -EACCES;
 402         return 0;
 403 }
 404
 405 /**
 406  * rpcb_register - set or unset a port registration with the local rpcbind svc
 407  * @net: target network namespace
 408  * @prog: RPC program number to bind
 409  * @vers: RPC version number to bind
 410  * @prot: transport protocol to register
 411  * @port: port value to register
 412  *
 413  * Returns zero if the registration request was dispatched successfully
 414  * and the rpcbind daemon returned success.  Otherwise, returns an errno
 415  * value that reflects the nature of the error (request could not be
 416  * dispatched, timed out, or rpcbind returned an error).
 417  *
 418  * RPC services invoke this function to advertise their contact
 419  * information via the system's rpcbind daemon.  RPC services
 420  * invoke this function once for each [program, version, transport]
 421  * tuple they wish to advertise.
 422  *
 423  * Callers may also unregister RPC services that are no longer
 424  * available by setting the passed-in port to zero.  This removes
 425  * all registered transports for [program, version] from the local
 426  * rpcbind database.
 427  *
 428  * This function uses rpcbind protocol version 2 to contact the
 429  * local rpcbind daemon.
 430  *
 431  * Registration works over both AF_INET and AF_INET6, and services
 432  * registered via this function are advertised as available for any
 433  * address.  If the local rpcbind daemon is listening on AF_INET6,
 434  * services registered via this function will be advertised on
 435  * IN6ADDR_ANY (ie available for all AF_INET and AF_INET6
 436  * addresses).
 437  */
 438 int rpcb_register(struct net *net, u32 prog, u32 vers, int prot, unsigned short port)
 439 {
 440         struct rpcbind_args map = {
 441                 .r_prog         = prog,
 442                 .r_vers         = vers,
 443                 .r_prot         = prot,
 444                 .r_port         = port,
 445         };
 446         struct rpc_message msg = {
 447                 .rpc_argp       = &map,
 448         };
 449         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 450
 451         dprintk("RPC:       %sregistering (%u, %u, %d, %u) with local "
 452                         "rpcbind\n", (port ? "" : "un"),
 453                         prog, vers, prot, port);
 454
 455         msg.rpc_proc = &rpcb_procedures2[RPCBPROC_UNSET];
 456         if (port)
 457                 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_SET];
 458
 459         return rpcb_register_call(sn->rpcb_local_clnt, &msg);
 460 }
 461
 462 /*
 463  * Fill in AF_INET family-specific arguments to register
 464  */
 465 static int rpcb_register_inet4(struct sunrpc_net *sn,
 466                                const struct sockaddr *sap,
 467                                struct rpc_message *msg)
 468 {
 469         const struct sockaddr_in *sin = (const struct sockaddr_in *)sap;
 470         struct rpcbind_args *map = msg->rpc_argp;
 471         unsigned short port = ntohs(sin->sin_port);
 472         int result;
 473
 474         map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
 475
 476         dprintk("RPC:       %sregistering [%u, %u, %s, '%s'] with "
 477                 "local rpcbind\n", (port ? "" : "un"),
 478                         map->r_prog, map->r_vers,
 479                         map->r_addr, map->r_netid);
 480
 481         msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
 482         if (port)
 483                 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
 484
 485         result = rpcb_register_call(sn->rpcb_local_clnt4, msg);
 486         kfree(map->r_addr);
 487         return result;
 488 }
 489
 490 /*
 491  * Fill in AF_INET6 family-specific arguments to register
 492  */
 493 static int rpcb_register_inet6(struct sunrpc_net *sn,
 494                                const struct sockaddr *sap,
 495                                struct rpc_message *msg)
 496 {
 497         const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sap;
 498         struct rpcbind_args *map = msg->rpc_argp;
 499         unsigned short port = ntohs(sin6->sin6_port);
 500         int result;
 501
 502         map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
 503
 504         dprintk("RPC:       %sregistering [%u, %u, %s, '%s'] with "
 505                 "local rpcbind\n", (port ? "" : "un"),
 506                         map->r_prog, map->r_vers,
 507                         map->r_addr, map->r_netid);
 508
 509         msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
 510         if (port)
 511                 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
 512
 513         result = rpcb_register_call(sn->rpcb_local_clnt4, msg);
 514         kfree(map->r_addr);
 515         return result;
 516 }
 517
 518 static int rpcb_unregister_all_protofamilies(struct sunrpc_net *sn,
 519                                              struct rpc_message *msg)
 520 {
 521         struct rpcbind_args *map = msg->rpc_argp;
 522
 523         dprintk("RPC:       unregistering [%u, %u, '%s'] with "
 524                 "local rpcbind\n",
 525                         map->r_prog, map->r_vers, map->r_netid);
 526
 527         map->r_addr = "";
 528         msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
 529
 530         return rpcb_register_call(sn->rpcb_local_clnt4, msg);
 531 }
 532
 533 /**
 534  * rpcb_v4_register - set or unset a port registration with the local rpcbind
 535  * @net: target network namespace
 536  * @program: RPC program number of service to (un)register
 537  * @version: RPC version number of service to (un)register
 538  * @address: address family, IP address, and port to (un)register
 539  * @netid: netid of transport protocol to (un)register
 540  *
 541  * Returns zero if the registration request was dispatched successfully
 542  * and the rpcbind daemon returned success.  Otherwise, returns an errno
 543  * value that reflects the nature of the error (request could not be
 544  * dispatched, timed out, or rpcbind returned an error).
 545  *
 546  * RPC services invoke this function to advertise their contact
 547  * information via the system's rpcbind daemon.  RPC services
 548  * invoke this function once for each [program, version, address,
 549  * netid] tuple they wish to advertise.
 550  *
 551  * Callers may also unregister RPC services that are registered at a
 552  * specific address by setting the port number in @address to zero.
 553  * They may unregister all registered protocol families at once for
 554  * a service by passing a NULL @address argument.  If @netid is ""
 555  * then all netids for [program, version, address] are unregistered.
 556  *
 557  * This function uses rpcbind protocol version 4 to contact the
 558  * local rpcbind daemon.  The local rpcbind daemon must support
 559  * version 4 of the rpcbind protocol in order for these functions
 560  * to register a service successfully.
 561  *
 562  * Supported netids include "udp" and "tcp" for UDP and TCP over
 563  * IPv4, and "udp6" and "tcp6" for UDP and TCP over IPv6,
 564  * respectively.
 565  *
 566  * The contents of @address determine the address family and the
 567  * port to be registered.  The usual practice is to pass INADDR_ANY
 568  * as the raw address, but specifying a non-zero address is also
 569  * supported by this API if the caller wishes to advertise an RPC
 570  * service on a specific network interface.
 571  *
 572  * Note that passing in INADDR_ANY does not create the same service
 573  * registration as IN6ADDR_ANY.  The former advertises an RPC
 574  * service on any IPv4 address, but not on IPv6.  The latter
 575  * advertises the service on all IPv4 and IPv6 addresses.
 576  */
 577 int rpcb_v4_register(struct net *net, const u32 program, const u32 version,
 578                      const struct sockaddr *address, const char *netid)
 579 {
 580         struct rpcbind_args map = {
 581                 .r_prog         = program,
 582                 .r_vers         = version,
 583                 .r_netid        = netid,
 584                 .r_owner        = RPCB_OWNER_STRING,
 585         };
 586         struct rpc_message msg = {
 587                 .rpc_argp       = &map,
 588         };
 589         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 590
 591         if (sn->rpcb_local_clnt4 == NULL)
 592                 return -EPROTONOSUPPORT;
 593
 594         if (address == NULL)
 595                 return rpcb_unregister_all_protofamilies(sn, &msg);
 596
 597         switch (address->sa_family) {
 598         case AF_INET:
 599                 return rpcb_register_inet4(sn, address, &msg);
 600         case AF_INET6:
 601                 return rpcb_register_inet6(sn, address, &msg);
 602         }
 603
 604         return -EAFNOSUPPORT;
 605 }
 606
 607 static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt, struct rpcbind_args *map, struct rpc_procinfo *proc)
 608 {
 609         struct rpc_message msg = {
 610                 .rpc_proc = proc,
 611                 .rpc_argp = map,
 612                 .rpc_resp = map,
 613         };
 614         struct rpc_task_setup task_setup_data = {
 615                 .rpc_client = rpcb_clnt,
 616                 .rpc_message = &msg,
 617                 .callback_ops = &rpcb_getport_ops,
 618                 .callback_data = map,
 619                 .flags = RPC_TASK_ASYNC | RPC_TASK_SOFTCONN,
 620         };
 621
 622         return rpc_run_task(&task_setup_data);
 623 }
 624
 625 /*
 626  * In the case where rpc clients have been cloned, we want to make
 627  * sure that we use the program number/version etc of the actual
 628  * owner of the xprt. To do so, we walk back up the tree of parents
 629  * to find whoever created the transport and/or whoever has the
 630  * autobind flag set.
 631  */
 632 static struct rpc_clnt *rpcb_find_transport_owner(struct rpc_clnt *clnt)
 633 {
 634         struct rpc_clnt *parent = clnt->cl_parent;
 635         struct rpc_xprt *xprt = rcu_dereference(clnt->cl_xprt);
 636
 637         while (parent != clnt) {
 638                 if (rcu_dereference(parent->cl_xprt) != xprt)
 639                         break;
 640                 if (clnt->cl_autobind)
 641                         break;
 642                 clnt = parent;
 643                 parent = parent->cl_parent;
 644         }
 645         return clnt;
 646 }
 647
 648 /**
 649  * rpcb_getport_async - obtain the port for a given RPC service on a given host
 650  * @task: task that is waiting for portmapper request
 651  *
 652  * This one can be called for an ongoing RPC request, and can be used in
 653  * an async (rpciod) context.
 654  */
 655 void rpcb_getport_async(struct rpc_task *task)
 656 {
 657         struct rpc_clnt *clnt;
 658         struct rpc_procinfo *proc;
 659         u32 bind_version;
 660         struct rpc_xprt *xprt;
 661         struct rpc_clnt *rpcb_clnt;
 662         struct rpcbind_args *map;
 663         struct rpc_task *child;
 664         struct sockaddr_storage addr;
 665         struct sockaddr *sap = (struct sockaddr *)&addr;
 666         size_t salen;
 667         int status;
 668
 669         rcu_read_lock();
 670         do {
 671                 clnt = rpcb_find_transport_owner(task->tk_client);
 672                 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
 673         } while (xprt == NULL);
 674         rcu_read_unlock();
 675
 676         dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
 677                 task->tk_pid, __func__,
 678                 xprt->servername, clnt->cl_prog, clnt->cl_vers, xprt->prot);
 679
 680         /* Put self on the wait queue to ensure we get notified if
 681          * some other task is already attempting to bind the port */
 682         rpc_sleep_on(&xprt->binding, task, NULL);
 683
 684         if (xprt_test_and_set_binding(xprt)) {
 685                 dprintk("RPC: %5u %s: waiting for another binder\n",
 686                         task->tk_pid, __func__);
 687                 xprt_put(xprt);
 688                 return;
 689         }
 690
 691         /* Someone else may have bound if we slept */
 692         if (xprt_bound(xprt)) {
 693                 status = 0;
 694                 dprintk("RPC: %5u %s: already bound\n",
 695                         task->tk_pid, __func__);
 696                 goto bailout_nofree;
 697         }
 698
 699         /* Parent transport's destination address */
 700         salen = rpc_peeraddr(clnt, sap, sizeof(addr));
 701
 702         /* Don't ever use rpcbind v2 for AF_INET6 requests */
 703         switch (sap->sa_family) {
 704         case AF_INET:
 705                 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
 706                 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
 707                 break;
 708         case AF_INET6:
 709                 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
 710                 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
 711                 break;
 712         default:
 713                 status = -EAFNOSUPPORT;
 714                 dprintk("RPC: %5u %s: bad address family\n",
 715                                 task->tk_pid, __func__);
 716                 goto bailout_nofree;
 717         }
 718         if (proc == NULL) {
 719                 xprt->bind_index = 0;
 720                 status = -EPFNOSUPPORT;
 721                 dprintk("RPC: %5u %s: no more getport versions available\n",
 722                         task->tk_pid, __func__);
 723                 goto bailout_nofree;
 724         }
 725
 726         dprintk("RPC: %5u %s: trying rpcbind version %u\n",
 727                 task->tk_pid, __func__, bind_version);
 728
 729         rpcb_clnt = rpcb_create(xprt->xprt_net, xprt->servername, sap, salen,
 730                                 xprt->prot, bind_version);
 731         if (IS_ERR(rpcb_clnt)) {
 732                 status = PTR_ERR(rpcb_clnt);
 733                 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
 734                         task->tk_pid, __func__, PTR_ERR(rpcb_clnt));
 735                 goto bailout_nofree;
 736         }
 737
 738         map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
 739         if (!map) {
 740                 status = -ENOMEM;
 741                 dprintk("RPC: %5u %s: no memory available\n",
 742                         task->tk_pid, __func__);
 743                 goto bailout_release_client;
 744         }
 745         map->r_prog = clnt->cl_prog;
 746         map->r_vers = clnt->cl_vers;
 747         map->r_prot = xprt->prot;
 748         map->r_port = 0;
 749         map->r_xprt = xprt;
 750         map->r_status = -EIO;
 751
 752         switch (bind_version) {
 753         case RPCBVERS_4:
 754         case RPCBVERS_3:
 755                 map->r_netid = xprt->address_strings[RPC_DISPLAY_NETID];
 756                 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_ATOMIC);
 757                 map->r_owner = "";
 758                 break;
 759         case RPCBVERS_2:
 760                 map->r_addr = NULL;
 761                 break;
 762         default:
 763                 BUG();
 764         }
 765
 766         child = rpcb_call_async(rpcb_clnt, map, proc);
 767         rpc_release_client(rpcb_clnt);
 768         if (IS_ERR(child)) {
 769                 /* rpcb_map_release() has freed the arguments */
 770                 dprintk("RPC: %5u %s: rpc_run_task failed\n",
 771                         task->tk_pid, __func__);
 772                 return;
 773         }
 774
 775         xprt->stat.bind_count++;
 776         rpc_put_task(child);
 777         return;
 778
 779 bailout_release_client:
 780         rpc_release_client(rpcb_clnt);
 781 bailout_nofree:
 782         rpcb_wake_rpcbind_waiters(xprt, status);
 783         task->tk_status = status;
 784         xprt_put(xprt);
 785 }
 786 EXPORT_SYMBOL_GPL(rpcb_getport_async);
 787
 788 /*
 789  * Rpcbind child task calls this callback via tk_exit.
 790  */
 791 static void rpcb_getport_done(struct rpc_task *child, void *data)
 792 {
 793         struct rpcbind_args *map = data;
 794         struct rpc_xprt *xprt = map->r_xprt;
 795         int status = child->tk_status;
 796
 797         /* Garbage reply: retry with a lesser rpcbind version */
 798         if (status == -EIO)
 799                 status = -EPROTONOSUPPORT;
 800
 801         /* rpcbind server doesn't support this rpcbind protocol version */
 802         if (status == -EPROTONOSUPPORT)
 803                 xprt->bind_index++;
 804
 805         if (status < 0) {
 806                 /* rpcbind server not available on remote host? */
 807                 xprt->ops->set_port(xprt, 0);
 808         } else if (map->r_port == 0) {
 809                 /* Requested RPC service wasn't registered on remote host */
 810                 xprt->ops->set_port(xprt, 0);
 811                 status = -EACCES;
 812         } else {
 813                 /* Succeeded */
 814                 xprt->ops->set_port(xprt, map->r_port);
 815                 xprt_set_bound(xprt);
 816                 status = 0;
 817         }
 818
 819         dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
 820                         child->tk_pid, status, map->r_port);
 821
 822         map->r_status = status;
 823 }
 824
 825 /*
 826  * XDR functions for rpcbind
 827  */
 828
 829 static void rpcb_enc_mapping(struct rpc_rqst *req, struct xdr_stream *xdr,
 830                              const struct rpcbind_args *rpcb)
 831 {
 832         __be32 *p;
 833
 834         dprintk("RPC: %5u encoding PMAP_%s call (%u, %u, %d, %u)\n",
 835                         req->rq_task->tk_pid,
 836                         req->rq_task->tk_msg.rpc_proc->p_name,
 837                         rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
 838
 839         p = xdr_reserve_space(xdr, RPCB_mappingargs_sz << 2);
 840         *p++ = cpu_to_be32(rpcb->r_prog);
 841         *p++ = cpu_to_be32(rpcb->r_vers);
 842         *p++ = cpu_to_be32(rpcb->r_prot);
 843         *p   = cpu_to_be32(rpcb->r_port);
 844 }
 845
 846 static int rpcb_dec_getport(struct rpc_rqst *req, struct xdr_stream *xdr,
 847                             struct rpcbind_args *rpcb)
 848 {
 849         unsigned long port;
 850         __be32 *p;
 851
 852         rpcb->r_port = 0;
 853
 854         p = xdr_inline_decode(xdr, 4);
 855         if (unlikely(p == NULL))
 856                 return -EIO;
 857
 858         port = be32_to_cpup(p);
 859         dprintk("RPC: %5u PMAP_%s result: %lu\n", req->rq_task->tk_pid,
 860                         req->rq_task->tk_msg.rpc_proc->p_name, port);
 861         if (unlikely(port > USHRT_MAX))
 862                 return -EIO;
 863
 864         rpcb->r_port = port;
 865         return 0;
 866 }
 867
 868 static int rpcb_dec_set(struct rpc_rqst *req, struct xdr_stream *xdr,
 869                         unsigned int *boolp)
 870 {
 871         __be32 *p;
 872
 873         p = xdr_inline_decode(xdr, 4);
 874         if (unlikely(p == NULL))
 875                 return -EIO;
 876
 877         *boolp = 0;
 878         if (*p != xdr_zero)
 879                 *boolp = 1;
 880
 881         dprintk("RPC: %5u RPCB_%s call %s\n",
 882                         req->rq_task->tk_pid,
 883                         req->rq_task->tk_msg.rpc_proc->p_name,
 884                         (*boolp ? "succeeded" : "failed"));
 885         return 0;
 886 }
 887
 888 static void encode_rpcb_string(struct xdr_stream *xdr, const char *string,
 889                                const u32 maxstrlen)
 890 {
 891         __be32 *p;
 892         u32 len;
 893
 894         len = strlen(string);
 895         WARN_ON_ONCE(len > maxstrlen);
 896         if (len > maxstrlen)
 897                 /* truncate and hope for the best */
 898                 len = maxstrlen;
 899         p = xdr_reserve_space(xdr, 4 + len);
 900         xdr_encode_opaque(p, string, len);
 901 }
 902
 903 static void rpcb_enc_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
 904                              const struct rpcbind_args *rpcb)
 905 {
 906         __be32 *p;
 907
 908         dprintk("RPC: %5u encoding RPCB_%s call (%u, %u, '%s', '%s')\n",
 909                         req->rq_task->tk_pid,
 910                         req->rq_task->tk_msg.rpc_proc->p_name,
 911                         rpcb->r_prog, rpcb->r_vers,
 912                         rpcb->r_netid, rpcb->r_addr);
 913
 914         p = xdr_reserve_space(xdr, (RPCB_program_sz + RPCB_version_sz) << 2);
 915         *p++ = cpu_to_be32(rpcb->r_prog);
 916         *p = cpu_to_be32(rpcb->r_vers);
 917
 918         encode_rpcb_string(xdr, rpcb->r_netid, RPCBIND_MAXNETIDLEN);
 919         encode_rpcb_string(xdr, rpcb->r_addr, RPCBIND_MAXUADDRLEN);
 920         encode_rpcb_string(xdr, rpcb->r_owner, RPCB_MAXOWNERLEN);
 921 }
 922
 923 static int rpcb_dec_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
 924                             struct rpcbind_args *rpcb)
 925 {
 926         struct sockaddr_storage address;
 927         struct sockaddr *sap = (struct sockaddr *)&address;
 928         __be32 *p;
 929         u32 len;
 930
 931         rpcb->r_port = 0;
 932
 933         p = xdr_inline_decode(xdr, 4);
 934         if (unlikely(p == NULL))
 935                 goto out_fail;
 936         len = be32_to_cpup(p);
 937
 938         /*
 939          * If the returned universal address is a null string,
 940          * the requested RPC service was not registered.
 941          */
 942         if (len == 0) {
 943                 dprintk("RPC: %5u RPCB reply: program not registered\n",
 944                                 req->rq_task->tk_pid);
 945                 return 0;
 946         }
 947
 948         if (unlikely(len > RPCBIND_MAXUADDRLEN))
 949                 goto out_fail;
 950
 951         p = xdr_inline_decode(xdr, len);
 952         if (unlikely(p == NULL))
 953                 goto out_fail;
 954         dprintk("RPC: %5u RPCB_%s reply: %s\n", req->rq_task->tk_pid,
 955                         req->rq_task->tk_msg.rpc_proc->p_name, (char *)p);
 956
 957         if (rpc_uaddr2sockaddr(req->rq_xprt->xprt_net, (char *)p, len,
 958                                 sap, sizeof(address)) == 0)
 959                 goto out_fail;
 960         rpcb->r_port = rpc_get_port(sap);
 961
 962         return 0;
 963
 964 out_fail:
 965         dprintk("RPC: %5u malformed RPCB_%s reply\n",
 966                         req->rq_task->tk_pid,
 967                         req->rq_task->tk_msg.rpc_proc->p_name);
 968         return -EIO;
 969 }
 970
 971 /*
 972  * Not all rpcbind procedures described in RFC 1833 are implemented
 973  * since the Linux kernel RPC code requires only these.
 974  */
 975
 976 static struct rpc_procinfo rpcb_procedures2[] = {
 977         [RPCBPROC_SET] = {
 978                 .p_proc         = RPCBPROC_SET,
 979                 .p_encode       = (kxdreproc_t)rpcb_enc_mapping,
 980                 .p_decode       = (kxdrdproc_t)rpcb_dec_set,
 981                 .p_arglen       = RPCB_mappingargs_sz,
 982                 .p_replen       = RPCB_setres_sz,
 983                 .p_statidx      = RPCBPROC_SET,
 984                 .p_timer        = 0,
 985                 .p_name         = "SET",
 986         },
 987         [RPCBPROC_UNSET] = {
 988                 .p_proc         = RPCBPROC_UNSET,
 989                 .p_encode       = (kxdreproc_t)rpcb_enc_mapping,
 990                 .p_decode       = (kxdrdproc_t)rpcb_dec_set,
 991                 .p_arglen       = RPCB_mappingargs_sz,
 992                 .p_replen       = RPCB_setres_sz,
 993                 .p_statidx      = RPCBPROC_UNSET,
 994                 .p_timer        = 0,
 995                 .p_name         = "UNSET",
 996         },
 997         [RPCBPROC_GETPORT] = {
 998                 .p_proc         = RPCBPROC_GETPORT,
 999                 .p_encode       = (kxdreproc_t)rpcb_enc_mapping,
1000                 .p_decode       = (kxdrdproc_t)rpcb_dec_getport,
1001                 .p_arglen       = RPCB_mappingargs_sz,
1002                 .p_replen       = RPCB_getportres_sz,
1003                 .p_statidx      = RPCBPROC_GETPORT,
1004                 .p_timer        = 0,
1005                 .p_name         = "GETPORT",
1006         },
1007 };
1008
1009 static struct rpc_procinfo rpcb_procedures3[] = {
1010         [RPCBPROC_SET] = {
1011                 .p_proc         = RPCBPROC_SET,
1012                 .p_encode       = (kxdreproc_t)rpcb_enc_getaddr,
1013                 .p_decode       = (kxdrdproc_t)rpcb_dec_set,
1014                 .p_arglen       = RPCB_getaddrargs_sz,
1015                 .p_replen       = RPCB_setres_sz,
1016                 .p_statidx      = RPCBPROC_SET,
1017                 .p_timer        = 0,
1018                 .p_name         = "SET",
1019         },
1020         [RPCBPROC_UNSET] = {
1021                 .p_proc         = RPCBPROC_UNSET,
1022                 .p_encode       = (kxdreproc_t)rpcb_enc_getaddr,
1023                 .p_decode       = (kxdrdproc_t)rpcb_dec_set,
1024                 .p_arglen       = RPCB_getaddrargs_sz,
1025                 .p_replen       = RPCB_setres_sz,
1026                 .p_statidx      = RPCBPROC_UNSET,
1027                 .p_timer        = 0,
1028                 .p_name         = "UNSET",
1029         },
1030         [RPCBPROC_GETADDR] = {
1031                 .p_proc         = RPCBPROC_GETADDR,
1032                 .p_encode       = (kxdreproc_t)rpcb_enc_getaddr,
1033                 .p_decode       = (kxdrdproc_t)rpcb_dec_getaddr,
1034                 .p_arglen       = RPCB_getaddrargs_sz,
1035                 .p_replen       = RPCB_getaddrres_sz,
1036                 .p_statidx      = RPCBPROC_GETADDR,
1037                 .p_timer        = 0,
1038                 .p_name         = "GETADDR",
1039         },
1040 };
1041
1042 static struct rpc_procinfo rpcb_procedures4[] = {
1043         [RPCBPROC_SET] = {
1044                 .p_proc         = RPCBPROC_SET,
1045                 .p_encode       = (kxdreproc_t)rpcb_enc_getaddr,
1046                 .p_decode       = (kxdrdproc_t)rpcb_dec_set,
1047                 .p_arglen       = RPCB_getaddrargs_sz,
1048                 .p_replen       = RPCB_setres_sz,
1049                 .p_statidx      = RPCBPROC_SET,
1050                 .p_timer        = 0,
1051                 .p_name         = "SET",
1052         },
1053         [RPCBPROC_UNSET] = {
1054                 .p_proc         = RPCBPROC_UNSET,
1055                 .p_encode       = (kxdreproc_t)rpcb_enc_getaddr,
1056                 .p_decode       = (kxdrdproc_t)rpcb_dec_set,
1057                 .p_arglen       = RPCB_getaddrargs_sz,
1058                 .p_replen       = RPCB_setres_sz,
1059                 .p_statidx      = RPCBPROC_UNSET,
1060                 .p_timer        = 0,
1061                 .p_name         = "UNSET",
1062         },
1063         [RPCBPROC_GETADDR] = {
1064                 .p_proc         = RPCBPROC_GETADDR,
1065                 .p_encode       = (kxdreproc_t)rpcb_enc_getaddr,
1066                 .p_decode       = (kxdrdproc_t)rpcb_dec_getaddr,
1067                 .p_arglen       = RPCB_getaddrargs_sz,
1068                 .p_replen       = RPCB_getaddrres_sz,
1069                 .p_statidx      = RPCBPROC_GETADDR,
1070                 .p_timer        = 0,
1071                 .p_name         = "GETADDR",
1072         },
1073 };
1074
1075 static const struct rpcb_info rpcb_next_version[] = {
1076         {
1077                 .rpc_vers       = RPCBVERS_2,
1078                 .rpc_proc       = &rpcb_procedures2[RPCBPROC_GETPORT],
1079         },
1080         {
1081                 .rpc_proc       = NULL,
1082         },
1083 };
1084
1085 static const struct rpcb_info rpcb_next_version6[] = {
1086         {
1087                 .rpc_vers       = RPCBVERS_4,
1088                 .rpc_proc       = &rpcb_procedures4[RPCBPROC_GETADDR],
1089         },
1090         {
1091                 .rpc_vers       = RPCBVERS_3,
1092                 .rpc_proc       = &rpcb_procedures3[RPCBPROC_GETADDR],
1093         },
1094         {
1095                 .rpc_proc       = NULL,
1096         },
1097 };
1098
1099 static const struct rpc_version rpcb_version2 = {
1100         .number         = RPCBVERS_2,
1101         .nrprocs        = ARRAY_SIZE(rpcb_procedures2),
1102         .procs          = rpcb_procedures2
1103 };
1104
1105 static const struct rpc_version rpcb_version3 = {
1106         .number         = RPCBVERS_3,
1107         .nrprocs        = ARRAY_SIZE(rpcb_procedures3),
1108         .procs          = rpcb_procedures3
1109 };
1110
1111 static const struct rpc_version rpcb_version4 = {
1112         .number         = RPCBVERS_4,
1113         .nrprocs        = ARRAY_SIZE(rpcb_procedures4),
1114         .procs          = rpcb_procedures4
1115 };
1116
1117 static const struct rpc_version *rpcb_version[] = {
1118         NULL,
1119         NULL,
1120         &rpcb_version2,
1121         &rpcb_version3,
1122         &rpcb_version4
1123 };
1124
1125 static struct rpc_stat rpcb_stats;
1126
1127 static const struct rpc_program rpcb_program = {
1128         .name           = "rpcbind",
1129         .number         = RPCBIND_PROGRAM,
1130         .nrvers         = ARRAY_SIZE(rpcb_version),
1131         .version        = rpcb_version,
1132         .stats          = &rpcb_stats,
1133 };