arm64/efi: Mark __efistub_stext_offset as an absolute symbol explicitly
[linux/fpc-iii.git] / net / sunrpc / rpcb_clnt.c
blob2277b7cdad27ff14cabf3ecdc7dfe2b6ffb757f8
1 /*
2 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
3 * protocol
5 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
6 * RFC 3530: "Network File System (NFS) version 4 Protocol"
8 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
9 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
11 * Descended from net/sunrpc/pmap_clnt.c,
12 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
15 #include <linux/module.h>
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>
28 #include <linux/sunrpc/clnt.h>
29 #include <linux/sunrpc/addr.h>
30 #include <linux/sunrpc/sched.h>
31 #include <linux/sunrpc/xprtsock.h>
33 #include "netns.h"
35 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
36 # define RPCDBG_FACILITY RPCDBG_BIND
37 #endif
39 #define RPCBIND_SOCK_PATHNAME "/var/run/rpcbind.sock"
41 #define RPCBIND_PROGRAM (100000u)
42 #define RPCBIND_PORT (111u)
44 #define RPCBVERS_2 (2u)
45 #define RPCBVERS_3 (3u)
46 #define RPCBVERS_4 (4u)
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,
67 * r_owner
69 * The "owner" is allowed to unset a service in the rpcbind database.
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.
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.
79 #define RPCB_OWNER_STRING "0"
80 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
83 * XDR data type sizes
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)
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))
96 * XDR argument and result sizes
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)
104 #define RPCB_getportres_sz RPCB_port_sz
105 #define RPCB_setres_sz RPCB_boolean_sz
108 * Note that RFC 1833 does not put any size restrictions on the
109 * address string returned by the remote rpcbind database.
111 #define RPCB_getaddrres_sz RPCB_addr_sz
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;
117 struct rpcbind_args {
118 struct rpc_xprt * r_xprt;
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;
128 int r_status;
131 static const struct rpc_procinfo rpcb_procedures2[];
132 static const struct rpc_procinfo rpcb_procedures3[];
133 static const struct rpc_procinfo rpcb_procedures4[];
135 struct rpcb_info {
136 u32 rpc_vers;
137 const struct rpc_procinfo *rpc_proc;
140 static const struct rpcb_info rpcb_next_version[];
141 static const struct rpcb_info rpcb_next_version6[];
143 static const struct rpc_call_ops rpcb_getport_ops = {
144 .rpc_call_done = rpcb_getport_done,
145 .rpc_release = rpcb_map_release,
148 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
150 xprt_clear_binding(xprt);
151 rpc_wake_up_status(&xprt->binding, status);
154 static void rpcb_map_release(void *data)
156 struct rpcbind_args *map = data;
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);
164 static int rpcb_get_local(struct net *net)
166 int cnt;
167 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
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);
175 return cnt;
178 void rpcb_put_local(struct net *net)
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;
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;
191 shutdown = !sn->rpcb_users;
193 spin_unlock(&sn->rpcb_clnt_lock);
195 if (shutdown) {
197 * cleanup_rpcb_clnt - remove xprtsock's sysctls, unregister
199 if (clnt4)
200 rpc_shutdown_client(clnt4);
201 if (clnt)
202 rpc_shutdown_client(clnt);
206 static void rpcb_set_local(struct net *net, struct rpc_clnt *clnt,
207 struct rpc_clnt *clnt4,
208 bool is_af_local)
210 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
212 /* Protected by rpcb_create_local_mutex */
213 sn->rpcb_local_clnt = clnt;
214 sn->rpcb_local_clnt4 = clnt4;
215 sn->rpcb_is_af_local = is_af_local ? 1 : 0;
216 smp_wmb();
217 sn->rpcb_users = 1;
218 dprintk("RPC: created new rpcb local clients (rpcb_local_clnt: "
219 "%p, rpcb_local_clnt4: %p) for net %x%s\n",
220 sn->rpcb_local_clnt, sn->rpcb_local_clnt4,
221 net->ns.inum, (net == &init_net) ? " (init_net)" : "");
225 * Returns zero on success, otherwise a negative errno value
226 * is returned.
228 static int rpcb_create_local_unix(struct net *net)
230 static const struct sockaddr_un rpcb_localaddr_rpcbind = {
231 .sun_family = AF_LOCAL,
232 .sun_path = RPCBIND_SOCK_PATHNAME,
234 struct rpc_create_args args = {
235 .net = net,
236 .protocol = XPRT_TRANSPORT_LOCAL,
237 .address = (struct sockaddr *)&rpcb_localaddr_rpcbind,
238 .addrsize = sizeof(rpcb_localaddr_rpcbind),
239 .servername = "localhost",
240 .program = &rpcb_program,
241 .version = RPCBVERS_2,
242 .authflavor = RPC_AUTH_NULL,
243 .cred = current_cred(),
245 * We turn off the idle timeout to prevent the kernel
246 * from automatically disconnecting the socket.
247 * Otherwise, we'd have to cache the mount namespace
248 * of the caller and somehow pass that to the socket
249 * reconnect code.
251 .flags = RPC_CLNT_CREATE_NO_IDLE_TIMEOUT,
253 struct rpc_clnt *clnt, *clnt4;
254 int result = 0;
257 * Because we requested an RPC PING at transport creation time,
258 * this works only if the user space portmapper is rpcbind, and
259 * it's listening on AF_LOCAL on the named socket.
261 clnt = rpc_create(&args);
262 if (IS_ERR(clnt)) {
263 dprintk("RPC: failed to create AF_LOCAL rpcbind "
264 "client (errno %ld).\n", PTR_ERR(clnt));
265 result = PTR_ERR(clnt);
266 goto out;
269 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
270 if (IS_ERR(clnt4)) {
271 dprintk("RPC: failed to bind second program to "
272 "rpcbind v4 client (errno %ld).\n",
273 PTR_ERR(clnt4));
274 clnt4 = NULL;
277 rpcb_set_local(net, clnt, clnt4, true);
279 out:
280 return result;
284 * Returns zero on success, otherwise a negative errno value
285 * is returned.
287 static int rpcb_create_local_net(struct net *net)
289 static const struct sockaddr_in rpcb_inaddr_loopback = {
290 .sin_family = AF_INET,
291 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
292 .sin_port = htons(RPCBIND_PORT),
294 struct rpc_create_args args = {
295 .net = net,
296 .protocol = XPRT_TRANSPORT_TCP,
297 .address = (struct sockaddr *)&rpcb_inaddr_loopback,
298 .addrsize = sizeof(rpcb_inaddr_loopback),
299 .servername = "localhost",
300 .program = &rpcb_program,
301 .version = RPCBVERS_2,
302 .authflavor = RPC_AUTH_UNIX,
303 .cred = current_cred(),
304 .flags = RPC_CLNT_CREATE_NOPING,
306 struct rpc_clnt *clnt, *clnt4;
307 int result = 0;
309 clnt = rpc_create(&args);
310 if (IS_ERR(clnt)) {
311 dprintk("RPC: failed to create local rpcbind "
312 "client (errno %ld).\n", PTR_ERR(clnt));
313 result = PTR_ERR(clnt);
314 goto out;
318 * This results in an RPC ping. On systems running portmapper,
319 * the v4 ping will fail. Proceed anyway, but disallow rpcb
320 * v4 upcalls.
322 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
323 if (IS_ERR(clnt4)) {
324 dprintk("RPC: failed to bind second program to "
325 "rpcbind v4 client (errno %ld).\n",
326 PTR_ERR(clnt4));
327 clnt4 = NULL;
330 rpcb_set_local(net, clnt, clnt4, false);
332 out:
333 return result;
337 * Returns zero on success, otherwise a negative errno value
338 * is returned.
340 int rpcb_create_local(struct net *net)
342 static DEFINE_MUTEX(rpcb_create_local_mutex);
343 int result = 0;
345 if (rpcb_get_local(net))
346 return result;
348 mutex_lock(&rpcb_create_local_mutex);
349 if (rpcb_get_local(net))
350 goto out;
352 if (rpcb_create_local_unix(net) != 0)
353 result = rpcb_create_local_net(net);
355 out:
356 mutex_unlock(&rpcb_create_local_mutex);
357 return result;
360 static struct rpc_clnt *rpcb_create(struct net *net, const char *nodename,
361 const char *hostname,
362 struct sockaddr *srvaddr, size_t salen,
363 int proto, u32 version,
364 const struct cred *cred)
366 struct rpc_create_args args = {
367 .net = net,
368 .protocol = proto,
369 .address = srvaddr,
370 .addrsize = salen,
371 .servername = hostname,
372 .nodename = nodename,
373 .program = &rpcb_program,
374 .version = version,
375 .authflavor = RPC_AUTH_UNIX,
376 .cred = cred,
377 .flags = (RPC_CLNT_CREATE_NOPING |
378 RPC_CLNT_CREATE_NONPRIVPORT),
381 switch (srvaddr->sa_family) {
382 case AF_INET:
383 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
384 break;
385 case AF_INET6:
386 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
387 break;
388 default:
389 return ERR_PTR(-EAFNOSUPPORT);
392 return rpc_create(&args);
395 static int rpcb_register_call(struct sunrpc_net *sn, struct rpc_clnt *clnt, struct rpc_message *msg, bool is_set)
397 int flags = RPC_TASK_NOCONNECT;
398 int error, result = 0;
400 if (is_set || !sn->rpcb_is_af_local)
401 flags = RPC_TASK_SOFTCONN;
402 msg->rpc_resp = &result;
404 error = rpc_call_sync(clnt, msg, flags);
405 if (error < 0) {
406 dprintk("RPC: failed to contact local rpcbind "
407 "server (errno %d).\n", -error);
408 return error;
411 if (!result)
412 return -EACCES;
413 return 0;
417 * rpcb_register - set or unset a port registration with the local rpcbind svc
418 * @net: target network namespace
419 * @prog: RPC program number to bind
420 * @vers: RPC version number to bind
421 * @prot: transport protocol to register
422 * @port: port value to register
424 * Returns zero if the registration request was dispatched successfully
425 * and the rpcbind daemon returned success. Otherwise, returns an errno
426 * value that reflects the nature of the error (request could not be
427 * dispatched, timed out, or rpcbind returned an error).
429 * RPC services invoke this function to advertise their contact
430 * information via the system's rpcbind daemon. RPC services
431 * invoke this function once for each [program, version, transport]
432 * tuple they wish to advertise.
434 * Callers may also unregister RPC services that are no longer
435 * available by setting the passed-in port to zero. This removes
436 * all registered transports for [program, version] from the local
437 * rpcbind database.
439 * This function uses rpcbind protocol version 2 to contact the
440 * local rpcbind daemon.
442 * Registration works over both AF_INET and AF_INET6, and services
443 * registered via this function are advertised as available for any
444 * address. If the local rpcbind daemon is listening on AF_INET6,
445 * services registered via this function will be advertised on
446 * IN6ADDR_ANY (ie available for all AF_INET and AF_INET6
447 * addresses).
449 int rpcb_register(struct net *net, u32 prog, u32 vers, int prot, unsigned short port)
451 struct rpcbind_args map = {
452 .r_prog = prog,
453 .r_vers = vers,
454 .r_prot = prot,
455 .r_port = port,
457 struct rpc_message msg = {
458 .rpc_argp = &map,
460 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
461 bool is_set = false;
463 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
464 "rpcbind\n", (port ? "" : "un"),
465 prog, vers, prot, port);
467 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_UNSET];
468 if (port != 0) {
469 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_SET];
470 is_set = true;
473 return rpcb_register_call(sn, sn->rpcb_local_clnt, &msg, is_set);
477 * Fill in AF_INET family-specific arguments to register
479 static int rpcb_register_inet4(struct sunrpc_net *sn,
480 const struct sockaddr *sap,
481 struct rpc_message *msg)
483 const struct sockaddr_in *sin = (const struct sockaddr_in *)sap;
484 struct rpcbind_args *map = msg->rpc_argp;
485 unsigned short port = ntohs(sin->sin_port);
486 bool is_set = false;
487 int result;
489 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
491 dprintk("RPC: %sregistering [%u, %u, %s, '%s'] with "
492 "local rpcbind\n", (port ? "" : "un"),
493 map->r_prog, map->r_vers,
494 map->r_addr, map->r_netid);
496 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
497 if (port != 0) {
498 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
499 is_set = true;
502 result = rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, is_set);
503 kfree(map->r_addr);
504 return result;
508 * Fill in AF_INET6 family-specific arguments to register
510 static int rpcb_register_inet6(struct sunrpc_net *sn,
511 const struct sockaddr *sap,
512 struct rpc_message *msg)
514 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sap;
515 struct rpcbind_args *map = msg->rpc_argp;
516 unsigned short port = ntohs(sin6->sin6_port);
517 bool is_set = false;
518 int result;
520 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
522 dprintk("RPC: %sregistering [%u, %u, %s, '%s'] with "
523 "local rpcbind\n", (port ? "" : "un"),
524 map->r_prog, map->r_vers,
525 map->r_addr, map->r_netid);
527 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
528 if (port != 0) {
529 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
530 is_set = true;
533 result = rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, is_set);
534 kfree(map->r_addr);
535 return result;
538 static int rpcb_unregister_all_protofamilies(struct sunrpc_net *sn,
539 struct rpc_message *msg)
541 struct rpcbind_args *map = msg->rpc_argp;
543 dprintk("RPC: unregistering [%u, %u, '%s'] with "
544 "local rpcbind\n",
545 map->r_prog, map->r_vers, map->r_netid);
547 map->r_addr = "";
548 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
550 return rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, false);
554 * rpcb_v4_register - set or unset a port registration with the local rpcbind
555 * @net: target network namespace
556 * @program: RPC program number of service to (un)register
557 * @version: RPC version number of service to (un)register
558 * @address: address family, IP address, and port to (un)register
559 * @netid: netid of transport protocol to (un)register
561 * Returns zero if the registration request was dispatched successfully
562 * and the rpcbind daemon returned success. Otherwise, returns an errno
563 * value that reflects the nature of the error (request could not be
564 * dispatched, timed out, or rpcbind returned an error).
566 * RPC services invoke this function to advertise their contact
567 * information via the system's rpcbind daemon. RPC services
568 * invoke this function once for each [program, version, address,
569 * netid] tuple they wish to advertise.
571 * Callers may also unregister RPC services that are registered at a
572 * specific address by setting the port number in @address to zero.
573 * They may unregister all registered protocol families at once for
574 * a service by passing a NULL @address argument. If @netid is ""
575 * then all netids for [program, version, address] are unregistered.
577 * This function uses rpcbind protocol version 4 to contact the
578 * local rpcbind daemon. The local rpcbind daemon must support
579 * version 4 of the rpcbind protocol in order for these functions
580 * to register a service successfully.
582 * Supported netids include "udp" and "tcp" for UDP and TCP over
583 * IPv4, and "udp6" and "tcp6" for UDP and TCP over IPv6,
584 * respectively.
586 * The contents of @address determine the address family and the
587 * port to be registered. The usual practice is to pass INADDR_ANY
588 * as the raw address, but specifying a non-zero address is also
589 * supported by this API if the caller wishes to advertise an RPC
590 * service on a specific network interface.
592 * Note that passing in INADDR_ANY does not create the same service
593 * registration as IN6ADDR_ANY. The former advertises an RPC
594 * service on any IPv4 address, but not on IPv6. The latter
595 * advertises the service on all IPv4 and IPv6 addresses.
597 int rpcb_v4_register(struct net *net, const u32 program, const u32 version,
598 const struct sockaddr *address, const char *netid)
600 struct rpcbind_args map = {
601 .r_prog = program,
602 .r_vers = version,
603 .r_netid = netid,
604 .r_owner = RPCB_OWNER_STRING,
606 struct rpc_message msg = {
607 .rpc_argp = &map,
609 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
611 if (sn->rpcb_local_clnt4 == NULL)
612 return -EPROTONOSUPPORT;
614 if (address == NULL)
615 return rpcb_unregister_all_protofamilies(sn, &msg);
617 switch (address->sa_family) {
618 case AF_INET:
619 return rpcb_register_inet4(sn, address, &msg);
620 case AF_INET6:
621 return rpcb_register_inet6(sn, address, &msg);
624 return -EAFNOSUPPORT;
627 static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt,
628 struct rpcbind_args *map, const struct rpc_procinfo *proc)
630 struct rpc_message msg = {
631 .rpc_proc = proc,
632 .rpc_argp = map,
633 .rpc_resp = map,
635 struct rpc_task_setup task_setup_data = {
636 .rpc_client = rpcb_clnt,
637 .rpc_message = &msg,
638 .callback_ops = &rpcb_getport_ops,
639 .callback_data = map,
640 .flags = RPC_TASK_ASYNC | RPC_TASK_SOFTCONN,
643 return rpc_run_task(&task_setup_data);
647 * In the case where rpc clients have been cloned, we want to make
648 * sure that we use the program number/version etc of the actual
649 * owner of the xprt. To do so, we walk back up the tree of parents
650 * to find whoever created the transport and/or whoever has the
651 * autobind flag set.
653 static struct rpc_clnt *rpcb_find_transport_owner(struct rpc_clnt *clnt)
655 struct rpc_clnt *parent = clnt->cl_parent;
656 struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
658 while (parent != clnt) {
659 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
660 break;
661 if (clnt->cl_autobind)
662 break;
663 clnt = parent;
664 parent = parent->cl_parent;
666 return clnt;
670 * rpcb_getport_async - obtain the port for a given RPC service on a given host
671 * @task: task that is waiting for portmapper request
673 * This one can be called for an ongoing RPC request, and can be used in
674 * an async (rpciod) context.
676 void rpcb_getport_async(struct rpc_task *task)
678 struct rpc_clnt *clnt;
679 const struct rpc_procinfo *proc;
680 u32 bind_version;
681 struct rpc_xprt *xprt;
682 struct rpc_clnt *rpcb_clnt;
683 struct rpcbind_args *map;
684 struct rpc_task *child;
685 struct sockaddr_storage addr;
686 struct sockaddr *sap = (struct sockaddr *)&addr;
687 size_t salen;
688 int status;
690 rcu_read_lock();
691 clnt = rpcb_find_transport_owner(task->tk_client);
692 rcu_read_unlock();
693 xprt = xprt_get(task->tk_xprt);
695 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
696 task->tk_pid, __func__,
697 xprt->servername, clnt->cl_prog, clnt->cl_vers, xprt->prot);
699 /* Put self on the wait queue to ensure we get notified if
700 * some other task is already attempting to bind the port */
701 rpc_sleep_on_timeout(&xprt->binding, task,
702 NULL, jiffies + xprt->bind_timeout);
704 if (xprt_test_and_set_binding(xprt)) {
705 dprintk("RPC: %5u %s: waiting for another binder\n",
706 task->tk_pid, __func__);
707 xprt_put(xprt);
708 return;
711 /* Someone else may have bound if we slept */
712 if (xprt_bound(xprt)) {
713 status = 0;
714 dprintk("RPC: %5u %s: already bound\n",
715 task->tk_pid, __func__);
716 goto bailout_nofree;
719 /* Parent transport's destination address */
720 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
722 /* Don't ever use rpcbind v2 for AF_INET6 requests */
723 switch (sap->sa_family) {
724 case AF_INET:
725 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
726 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
727 break;
728 case AF_INET6:
729 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
730 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
731 break;
732 default:
733 status = -EAFNOSUPPORT;
734 dprintk("RPC: %5u %s: bad address family\n",
735 task->tk_pid, __func__);
736 goto bailout_nofree;
738 if (proc == NULL) {
739 xprt->bind_index = 0;
740 status = -EPFNOSUPPORT;
741 dprintk("RPC: %5u %s: no more getport versions available\n",
742 task->tk_pid, __func__);
743 goto bailout_nofree;
746 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
747 task->tk_pid, __func__, bind_version);
749 rpcb_clnt = rpcb_create(xprt->xprt_net,
750 clnt->cl_nodename,
751 xprt->servername, sap, salen,
752 xprt->prot, bind_version,
753 clnt->cl_cred);
754 if (IS_ERR(rpcb_clnt)) {
755 status = PTR_ERR(rpcb_clnt);
756 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
757 task->tk_pid, __func__, PTR_ERR(rpcb_clnt));
758 goto bailout_nofree;
761 map = kzalloc(sizeof(struct rpcbind_args), GFP_NOFS);
762 if (!map) {
763 status = -ENOMEM;
764 dprintk("RPC: %5u %s: no memory available\n",
765 task->tk_pid, __func__);
766 goto bailout_release_client;
768 map->r_prog = clnt->cl_prog;
769 map->r_vers = clnt->cl_vers;
770 map->r_prot = xprt->prot;
771 map->r_port = 0;
772 map->r_xprt = xprt;
773 map->r_status = -EIO;
775 switch (bind_version) {
776 case RPCBVERS_4:
777 case RPCBVERS_3:
778 map->r_netid = xprt->address_strings[RPC_DISPLAY_NETID];
779 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_NOFS);
780 if (!map->r_addr) {
781 status = -ENOMEM;
782 dprintk("RPC: %5u %s: no memory available\n",
783 task->tk_pid, __func__);
784 goto bailout_free_args;
786 map->r_owner = "";
787 break;
788 case RPCBVERS_2:
789 map->r_addr = NULL;
790 break;
791 default:
792 BUG();
795 child = rpcb_call_async(rpcb_clnt, map, proc);
796 rpc_release_client(rpcb_clnt);
797 if (IS_ERR(child)) {
798 /* rpcb_map_release() has freed the arguments */
799 dprintk("RPC: %5u %s: rpc_run_task failed\n",
800 task->tk_pid, __func__);
801 return;
804 xprt->stat.bind_count++;
805 rpc_put_task(child);
806 return;
808 bailout_free_args:
809 kfree(map);
810 bailout_release_client:
811 rpc_release_client(rpcb_clnt);
812 bailout_nofree:
813 rpcb_wake_rpcbind_waiters(xprt, status);
814 task->tk_status = status;
815 xprt_put(xprt);
817 EXPORT_SYMBOL_GPL(rpcb_getport_async);
820 * Rpcbind child task calls this callback via tk_exit.
822 static void rpcb_getport_done(struct rpc_task *child, void *data)
824 struct rpcbind_args *map = data;
825 struct rpc_xprt *xprt = map->r_xprt;
826 int status = child->tk_status;
828 /* Garbage reply: retry with a lesser rpcbind version */
829 if (status == -EIO)
830 status = -EPROTONOSUPPORT;
832 /* rpcbind server doesn't support this rpcbind protocol version */
833 if (status == -EPROTONOSUPPORT)
834 xprt->bind_index++;
836 if (status < 0) {
837 /* rpcbind server not available on remote host? */
838 xprt->ops->set_port(xprt, 0);
839 } else if (map->r_port == 0) {
840 /* Requested RPC service wasn't registered on remote host */
841 xprt->ops->set_port(xprt, 0);
842 status = -EACCES;
843 } else {
844 /* Succeeded */
845 xprt->ops->set_port(xprt, map->r_port);
846 xprt_set_bound(xprt);
847 status = 0;
850 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
851 child->tk_pid, status, map->r_port);
853 map->r_status = status;
857 * XDR functions for rpcbind
860 static void rpcb_enc_mapping(struct rpc_rqst *req, struct xdr_stream *xdr,
861 const void *data)
863 const struct rpcbind_args *rpcb = data;
864 __be32 *p;
866 dprintk("RPC: %5u encoding PMAP_%s call (%u, %u, %d, %u)\n",
867 req->rq_task->tk_pid,
868 req->rq_task->tk_msg.rpc_proc->p_name,
869 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
871 p = xdr_reserve_space(xdr, RPCB_mappingargs_sz << 2);
872 *p++ = cpu_to_be32(rpcb->r_prog);
873 *p++ = cpu_to_be32(rpcb->r_vers);
874 *p++ = cpu_to_be32(rpcb->r_prot);
875 *p = cpu_to_be32(rpcb->r_port);
878 static int rpcb_dec_getport(struct rpc_rqst *req, struct xdr_stream *xdr,
879 void *data)
881 struct rpcbind_args *rpcb = data;
882 unsigned long port;
883 __be32 *p;
885 rpcb->r_port = 0;
887 p = xdr_inline_decode(xdr, 4);
888 if (unlikely(p == NULL))
889 return -EIO;
891 port = be32_to_cpup(p);
892 dprintk("RPC: %5u PMAP_%s result: %lu\n", req->rq_task->tk_pid,
893 req->rq_task->tk_msg.rpc_proc->p_name, port);
894 if (unlikely(port > USHRT_MAX))
895 return -EIO;
897 rpcb->r_port = port;
898 return 0;
901 static int rpcb_dec_set(struct rpc_rqst *req, struct xdr_stream *xdr,
902 void *data)
904 unsigned int *boolp = data;
905 __be32 *p;
907 p = xdr_inline_decode(xdr, 4);
908 if (unlikely(p == NULL))
909 return -EIO;
911 *boolp = 0;
912 if (*p != xdr_zero)
913 *boolp = 1;
915 dprintk("RPC: %5u RPCB_%s call %s\n",
916 req->rq_task->tk_pid,
917 req->rq_task->tk_msg.rpc_proc->p_name,
918 (*boolp ? "succeeded" : "failed"));
919 return 0;
922 static void encode_rpcb_string(struct xdr_stream *xdr, const char *string,
923 const u32 maxstrlen)
925 __be32 *p;
926 u32 len;
928 len = strlen(string);
929 WARN_ON_ONCE(len > maxstrlen);
930 if (len > maxstrlen)
931 /* truncate and hope for the best */
932 len = maxstrlen;
933 p = xdr_reserve_space(xdr, 4 + len);
934 xdr_encode_opaque(p, string, len);
937 static void rpcb_enc_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
938 const void *data)
940 const struct rpcbind_args *rpcb = data;
941 __be32 *p;
943 dprintk("RPC: %5u encoding RPCB_%s call (%u, %u, '%s', '%s')\n",
944 req->rq_task->tk_pid,
945 req->rq_task->tk_msg.rpc_proc->p_name,
946 rpcb->r_prog, rpcb->r_vers,
947 rpcb->r_netid, rpcb->r_addr);
949 p = xdr_reserve_space(xdr, (RPCB_program_sz + RPCB_version_sz) << 2);
950 *p++ = cpu_to_be32(rpcb->r_prog);
951 *p = cpu_to_be32(rpcb->r_vers);
953 encode_rpcb_string(xdr, rpcb->r_netid, RPCBIND_MAXNETIDLEN);
954 encode_rpcb_string(xdr, rpcb->r_addr, RPCBIND_MAXUADDRLEN);
955 encode_rpcb_string(xdr, rpcb->r_owner, RPCB_MAXOWNERLEN);
958 static int rpcb_dec_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
959 void *data)
961 struct rpcbind_args *rpcb = data;
962 struct sockaddr_storage address;
963 struct sockaddr *sap = (struct sockaddr *)&address;
964 __be32 *p;
965 u32 len;
967 rpcb->r_port = 0;
969 p = xdr_inline_decode(xdr, 4);
970 if (unlikely(p == NULL))
971 goto out_fail;
972 len = be32_to_cpup(p);
975 * If the returned universal address is a null string,
976 * the requested RPC service was not registered.
978 if (len == 0) {
979 dprintk("RPC: %5u RPCB reply: program not registered\n",
980 req->rq_task->tk_pid);
981 return 0;
984 if (unlikely(len > RPCBIND_MAXUADDRLEN))
985 goto out_fail;
987 p = xdr_inline_decode(xdr, len);
988 if (unlikely(p == NULL))
989 goto out_fail;
990 dprintk("RPC: %5u RPCB_%s reply: %s\n", req->rq_task->tk_pid,
991 req->rq_task->tk_msg.rpc_proc->p_name, (char *)p);
993 if (rpc_uaddr2sockaddr(req->rq_xprt->xprt_net, (char *)p, len,
994 sap, sizeof(address)) == 0)
995 goto out_fail;
996 rpcb->r_port = rpc_get_port(sap);
998 return 0;
1000 out_fail:
1001 dprintk("RPC: %5u malformed RPCB_%s reply\n",
1002 req->rq_task->tk_pid,
1003 req->rq_task->tk_msg.rpc_proc->p_name);
1004 return -EIO;
1008 * Not all rpcbind procedures described in RFC 1833 are implemented
1009 * since the Linux kernel RPC code requires only these.
1012 static const struct rpc_procinfo rpcb_procedures2[] = {
1013 [RPCBPROC_SET] = {
1014 .p_proc = RPCBPROC_SET,
1015 .p_encode = rpcb_enc_mapping,
1016 .p_decode = rpcb_dec_set,
1017 .p_arglen = RPCB_mappingargs_sz,
1018 .p_replen = RPCB_setres_sz,
1019 .p_statidx = RPCBPROC_SET,
1020 .p_timer = 0,
1021 .p_name = "SET",
1023 [RPCBPROC_UNSET] = {
1024 .p_proc = RPCBPROC_UNSET,
1025 .p_encode = rpcb_enc_mapping,
1026 .p_decode = rpcb_dec_set,
1027 .p_arglen = RPCB_mappingargs_sz,
1028 .p_replen = RPCB_setres_sz,
1029 .p_statidx = RPCBPROC_UNSET,
1030 .p_timer = 0,
1031 .p_name = "UNSET",
1033 [RPCBPROC_GETPORT] = {
1034 .p_proc = RPCBPROC_GETPORT,
1035 .p_encode = rpcb_enc_mapping,
1036 .p_decode = rpcb_dec_getport,
1037 .p_arglen = RPCB_mappingargs_sz,
1038 .p_replen = RPCB_getportres_sz,
1039 .p_statidx = RPCBPROC_GETPORT,
1040 .p_timer = 0,
1041 .p_name = "GETPORT",
1045 static const struct rpc_procinfo rpcb_procedures3[] = {
1046 [RPCBPROC_SET] = {
1047 .p_proc = RPCBPROC_SET,
1048 .p_encode = rpcb_enc_getaddr,
1049 .p_decode = rpcb_dec_set,
1050 .p_arglen = RPCB_getaddrargs_sz,
1051 .p_replen = RPCB_setres_sz,
1052 .p_statidx = RPCBPROC_SET,
1053 .p_timer = 0,
1054 .p_name = "SET",
1056 [RPCBPROC_UNSET] = {
1057 .p_proc = RPCBPROC_UNSET,
1058 .p_encode = rpcb_enc_getaddr,
1059 .p_decode = rpcb_dec_set,
1060 .p_arglen = RPCB_getaddrargs_sz,
1061 .p_replen = RPCB_setres_sz,
1062 .p_statidx = RPCBPROC_UNSET,
1063 .p_timer = 0,
1064 .p_name = "UNSET",
1066 [RPCBPROC_GETADDR] = {
1067 .p_proc = RPCBPROC_GETADDR,
1068 .p_encode = rpcb_enc_getaddr,
1069 .p_decode = rpcb_dec_getaddr,
1070 .p_arglen = RPCB_getaddrargs_sz,
1071 .p_replen = RPCB_getaddrres_sz,
1072 .p_statidx = RPCBPROC_GETADDR,
1073 .p_timer = 0,
1074 .p_name = "GETADDR",
1078 static const struct rpc_procinfo rpcb_procedures4[] = {
1079 [RPCBPROC_SET] = {
1080 .p_proc = RPCBPROC_SET,
1081 .p_encode = rpcb_enc_getaddr,
1082 .p_decode = rpcb_dec_set,
1083 .p_arglen = RPCB_getaddrargs_sz,
1084 .p_replen = RPCB_setres_sz,
1085 .p_statidx = RPCBPROC_SET,
1086 .p_timer = 0,
1087 .p_name = "SET",
1089 [RPCBPROC_UNSET] = {
1090 .p_proc = RPCBPROC_UNSET,
1091 .p_encode = rpcb_enc_getaddr,
1092 .p_decode = rpcb_dec_set,
1093 .p_arglen = RPCB_getaddrargs_sz,
1094 .p_replen = RPCB_setres_sz,
1095 .p_statidx = RPCBPROC_UNSET,
1096 .p_timer = 0,
1097 .p_name = "UNSET",
1099 [RPCBPROC_GETADDR] = {
1100 .p_proc = RPCBPROC_GETADDR,
1101 .p_encode = rpcb_enc_getaddr,
1102 .p_decode = rpcb_dec_getaddr,
1103 .p_arglen = RPCB_getaddrargs_sz,
1104 .p_replen = RPCB_getaddrres_sz,
1105 .p_statidx = RPCBPROC_GETADDR,
1106 .p_timer = 0,
1107 .p_name = "GETADDR",
1111 static const struct rpcb_info rpcb_next_version[] = {
1113 .rpc_vers = RPCBVERS_2,
1114 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
1117 .rpc_proc = NULL,
1121 static const struct rpcb_info rpcb_next_version6[] = {
1123 .rpc_vers = RPCBVERS_4,
1124 .rpc_proc = &rpcb_procedures4[RPCBPROC_GETADDR],
1127 .rpc_vers = RPCBVERS_3,
1128 .rpc_proc = &rpcb_procedures3[RPCBPROC_GETADDR],
1131 .rpc_proc = NULL,
1135 static unsigned int rpcb_version2_counts[ARRAY_SIZE(rpcb_procedures2)];
1136 static const struct rpc_version rpcb_version2 = {
1137 .number = RPCBVERS_2,
1138 .nrprocs = ARRAY_SIZE(rpcb_procedures2),
1139 .procs = rpcb_procedures2,
1140 .counts = rpcb_version2_counts,
1143 static unsigned int rpcb_version3_counts[ARRAY_SIZE(rpcb_procedures3)];
1144 static const struct rpc_version rpcb_version3 = {
1145 .number = RPCBVERS_3,
1146 .nrprocs = ARRAY_SIZE(rpcb_procedures3),
1147 .procs = rpcb_procedures3,
1148 .counts = rpcb_version3_counts,
1151 static unsigned int rpcb_version4_counts[ARRAY_SIZE(rpcb_procedures4)];
1152 static const struct rpc_version rpcb_version4 = {
1153 .number = RPCBVERS_4,
1154 .nrprocs = ARRAY_SIZE(rpcb_procedures4),
1155 .procs = rpcb_procedures4,
1156 .counts = rpcb_version4_counts,
1159 static const struct rpc_version *rpcb_version[] = {
1160 NULL,
1161 NULL,
1162 &rpcb_version2,
1163 &rpcb_version3,
1164 &rpcb_version4
1167 static struct rpc_stat rpcb_stats;
1169 static const struct rpc_program rpcb_program = {
1170 .name = "rpcbind",
1171 .number = RPCBIND_PROGRAM,
1172 .nrvers = ARRAY_SIZE(rpcb_version),
1173 .version = rpcb_version,
1174 .stats = &rpcb_stats,