blob: 41013dd66ac3f3e61e4823ef853911e179efc46b [file] [log] [blame]
Chuck Levera5090502007-03-29 16:48:04 -04001/*
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
Chuck Levercce63cd2007-07-01 12:13:12 -040015#include <linux/module.h>
16
Chuck Levera5090502007-03-29 16:48:04 -040017#include <linux/types.h>
18#include <linux/socket.h>
Chuck Leverd5b64432007-08-06 11:57:18 -040019#include <linux/in.h>
20#include <linux/in6.h>
Chuck Levera5090502007-03-29 16:48:04 -040021#include <linux/kernel.h>
22#include <linux/errno.h>
Chuck Lever9d548b92008-09-15 16:27:30 -050023#include <net/ipv6.h>
Chuck Levera5090502007-03-29 16:48:04 -040024
25#include <linux/sunrpc/clnt.h>
26#include <linux/sunrpc/sched.h>
\"Talpey, Thomas\0896a722007-09-10 13:48:23 -040027#include <linux/sunrpc/xprtsock.h>
Chuck Levera5090502007-03-29 16:48:04 -040028
29#ifdef RPC_DEBUG
30# define RPCDBG_FACILITY RPCDBG_BIND
31#endif
32
33#define RPCBIND_PROGRAM (100000u)
34#define RPCBIND_PORT (111u)
35
Chuck Leverfc200e72008-06-25 17:24:31 -040036#define RPCBVERS_2 (2u)
37#define RPCBVERS_3 (3u)
38#define RPCBVERS_4 (4u)
39
Chuck Levera5090502007-03-29 16:48:04 -040040enum {
41 RPCBPROC_NULL,
42 RPCBPROC_SET,
43 RPCBPROC_UNSET,
44 RPCBPROC_GETPORT,
45 RPCBPROC_GETADDR = 3, /* alias for GETPORT */
46 RPCBPROC_DUMP,
47 RPCBPROC_CALLIT,
48 RPCBPROC_BCAST = 5, /* alias for CALLIT */
49 RPCBPROC_GETTIME,
50 RPCBPROC_UADDR2TADDR,
51 RPCBPROC_TADDR2UADDR,
52 RPCBPROC_GETVERSADDR,
53 RPCBPROC_INDIRECT,
54 RPCBPROC_GETADDRLIST,
55 RPCBPROC_GETSTAT,
56};
57
58#define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
59#define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
60#define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
61
62/*
Chuck Levera5090502007-03-29 16:48:04 -040063 * r_owner
64 *
65 * The "owner" is allowed to unset a service in the rpcbind database.
66 * We always use the following (arbitrary) fixed string.
67 */
68#define RPCB_OWNER_STRING "rpcb"
69#define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
70
71static void rpcb_getport_done(struct rpc_task *, void *);
Trond Myklebust381ba742008-07-07 12:18:53 -040072static void rpcb_map_release(void *data);
Adrian Bunk7f4adef2007-06-13 01:03:13 +020073static struct rpc_program rpcb_program;
Chuck Levera5090502007-03-29 16:48:04 -040074
75struct rpcbind_args {
76 struct rpc_xprt * r_xprt;
77
78 u32 r_prog;
79 u32 r_vers;
80 u32 r_prot;
81 unsigned short r_port;
Trond Myklebust86d61d82008-01-07 21:16:56 -050082 const char * r_netid;
83 const char * r_addr;
84 const char * r_owner;
Trond Myklebust381ba742008-07-07 12:18:53 -040085
86 int r_status;
Chuck Levera5090502007-03-29 16:48:04 -040087};
88
89static struct rpc_procinfo rpcb_procedures2[];
90static struct rpc_procinfo rpcb_procedures3[];
Chuck Leverc2e1b092008-07-14 16:03:30 -040091static struct rpc_procinfo rpcb_procedures4[];
Chuck Levera5090502007-03-29 16:48:04 -040092
Chuck Leverd5b64432007-08-06 11:57:18 -040093struct rpcb_info {
Chuck Leverfc200e72008-06-25 17:24:31 -040094 u32 rpc_vers;
Chuck Levera5090502007-03-29 16:48:04 -040095 struct rpc_procinfo * rpc_proc;
Chuck Leverd5b64432007-08-06 11:57:18 -040096};
97
98static struct rpcb_info rpcb_next_version[];
99static struct rpcb_info rpcb_next_version6[];
Chuck Levera5090502007-03-29 16:48:04 -0400100
Chuck Levera5090502007-03-29 16:48:04 -0400101static const struct rpc_call_ops rpcb_getport_ops = {
Chuck Levera5090502007-03-29 16:48:04 -0400102 .rpc_call_done = rpcb_getport_done,
103 .rpc_release = rpcb_map_release,
104};
105
106static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
107{
108 xprt_clear_binding(xprt);
109 rpc_wake_up_status(&xprt->binding, status);
110}
111
Trond Myklebust381ba742008-07-07 12:18:53 -0400112static void rpcb_map_release(void *data)
113{
114 struct rpcbind_args *map = data;
115
116 rpcb_wake_rpcbind_waiters(map->r_xprt, map->r_status);
117 xprt_put(map->r_xprt);
118 kfree(map);
119}
120
Chuck Levercc5598b2008-07-14 16:03:27 -0400121static const struct sockaddr_in rpcb_inaddr_loopback = {
122 .sin_family = AF_INET,
123 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
124 .sin_port = htons(RPCBIND_PORT),
125};
126
Chuck Leverc2e1b092008-07-14 16:03:30 -0400127static const struct sockaddr_in6 rpcb_in6addr_loopback = {
128 .sin6_family = AF_INET6,
129 .sin6_addr = IN6ADDR_LOOPBACK_INIT,
130 .sin6_port = htons(RPCBIND_PORT),
131};
132
Chuck Levercc5598b2008-07-14 16:03:27 -0400133static struct rpc_clnt *rpcb_create_local(struct sockaddr *addr,
134 size_t addrlen, u32 version)
135{
136 struct rpc_create_args args = {
137 .protocol = XPRT_TRANSPORT_UDP,
138 .address = addr,
139 .addrsize = addrlen,
140 .servername = "localhost",
141 .program = &rpcb_program,
142 .version = version,
143 .authflavor = RPC_AUTH_UNIX,
144 .flags = RPC_CLNT_CREATE_NOPING,
145 };
146
147 return rpc_create(&args);
148}
149
Chuck Levera5090502007-03-29 16:48:04 -0400150static struct rpc_clnt *rpcb_create(char *hostname, struct sockaddr *srvaddr,
Chuck Lever423d8b02008-07-14 16:03:28 -0400151 size_t salen, int proto, u32 version)
Chuck Levera5090502007-03-29 16:48:04 -0400152{
153 struct rpc_create_args args = {
154 .protocol = proto,
155 .address = srvaddr,
Chuck Lever9f6ad262007-12-10 14:56:31 -0500156 .addrsize = salen,
Chuck Levera5090502007-03-29 16:48:04 -0400157 .servername = hostname,
158 .program = &rpcb_program,
159 .version = version,
160 .authflavor = RPC_AUTH_UNIX,
Chuck Lever423d8b02008-07-14 16:03:28 -0400161 .flags = (RPC_CLNT_CREATE_NOPING |
162 RPC_CLNT_CREATE_NONPRIVPORT),
Chuck Levera5090502007-03-29 16:48:04 -0400163 };
164
Chuck Leverd5b64432007-08-06 11:57:18 -0400165 switch (srvaddr->sa_family) {
166 case AF_INET:
167 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
168 break;
169 case AF_INET6:
170 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
171 break;
172 default:
173 return NULL;
174 }
175
Chuck Levera5090502007-03-29 16:48:04 -0400176 return rpc_create(&args);
177}
178
Chuck Leverbabe80e2008-07-14 16:03:29 -0400179static int rpcb_register_call(struct sockaddr *addr, size_t addrlen,
Chuck Lever14aeb212008-08-18 19:34:00 -0400180 u32 version, struct rpc_message *msg)
Chuck Leverbabe80e2008-07-14 16:03:29 -0400181{
182 struct rpc_clnt *rpcb_clnt;
Chuck Lever14aeb212008-08-18 19:34:00 -0400183 int result, error = 0;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400184
Chuck Lever14aeb212008-08-18 19:34:00 -0400185 msg->rpc_resp = &result;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400186
187 rpcb_clnt = rpcb_create_local(addr, addrlen, version);
188 if (!IS_ERR(rpcb_clnt)) {
189 error = rpc_call_sync(rpcb_clnt, msg, 0);
190 rpc_shutdown_client(rpcb_clnt);
191 } else
192 error = PTR_ERR(rpcb_clnt);
193
Chuck Lever14aeb212008-08-18 19:34:00 -0400194 if (error < 0) {
Chuck Leverbabe80e2008-07-14 16:03:29 -0400195 printk(KERN_WARNING "RPC: failed to contact local rpcbind "
196 "server (errno %d).\n", -error);
Chuck Lever14aeb212008-08-18 19:34:00 -0400197 return error;
198 }
Chuck Leverbabe80e2008-07-14 16:03:29 -0400199
Chuck Leverdb820d62008-09-25 11:57:05 -0400200 if (!result)
Chuck Lever14aeb212008-08-18 19:34:00 -0400201 return -EACCES;
Chuck Lever14aeb212008-08-18 19:34:00 -0400202 return 0;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400203}
204
Chuck Levera5090502007-03-29 16:48:04 -0400205/**
206 * rpcb_register - set or unset a port registration with the local rpcbind svc
207 * @prog: RPC program number to bind
208 * @vers: RPC version number to bind
Chuck Leverc2e1b092008-07-14 16:03:30 -0400209 * @prot: transport protocol to register
Chuck Levera5090502007-03-29 16:48:04 -0400210 * @port: port value to register
Chuck Lever14aeb212008-08-18 19:34:00 -0400211 *
212 * Returns zero if the registration request was dispatched successfully
213 * and the rpcbind daemon returned success. Otherwise, returns an errno
214 * value that reflects the nature of the error (request could not be
215 * dispatched, timed out, or rpcbind returned an error).
Chuck Levera5090502007-03-29 16:48:04 -0400216 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400217 * RPC services invoke this function to advertise their contact
218 * information via the system's rpcbind daemon. RPC services
219 * invoke this function once for each [program, version, transport]
220 * tuple they wish to advertise.
Chuck Levera5090502007-03-29 16:48:04 -0400221 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400222 * Callers may also unregister RPC services that are no longer
223 * available by setting the passed-in port to zero. This removes
224 * all registered transports for [program, version] from the local
225 * rpcbind database.
226 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400227 * This function uses rpcbind protocol version 2 to contact the
228 * local rpcbind daemon.
229 *
230 * Registration works over both AF_INET and AF_INET6, and services
231 * registered via this function are advertised as available for any
232 * address. If the local rpcbind daemon is listening on AF_INET6,
233 * services registered via this function will be advertised on
234 * IN6ADDR_ANY (ie available for all AF_INET and AF_INET6
235 * addresses).
Chuck Levera5090502007-03-29 16:48:04 -0400236 */
Chuck Lever14aeb212008-08-18 19:34:00 -0400237int rpcb_register(u32 prog, u32 vers, int prot, unsigned short port)
Chuck Levera5090502007-03-29 16:48:04 -0400238{
Chuck Levera5090502007-03-29 16:48:04 -0400239 struct rpcbind_args map = {
240 .r_prog = prog,
241 .r_vers = vers,
242 .r_prot = prot,
243 .r_port = port,
244 };
245 struct rpc_message msg = {
Chuck Levera5090502007-03-29 16:48:04 -0400246 .rpc_argp = &map,
Chuck Levera5090502007-03-29 16:48:04 -0400247 };
Chuck Levera5090502007-03-29 16:48:04 -0400248
249 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
250 "rpcbind\n", (port ? "" : "un"),
251 prog, vers, prot, port);
252
Chuck Leverbabe80e2008-07-14 16:03:29 -0400253 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_UNSET];
254 if (port)
255 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_SET];
256
257 return rpcb_register_call((struct sockaddr *)&rpcb_inaddr_loopback,
Chuck Levercc5598b2008-07-14 16:03:27 -0400258 sizeof(rpcb_inaddr_loopback),
Chuck Lever14aeb212008-08-18 19:34:00 -0400259 RPCBVERS_2, &msg);
Chuck Levera5090502007-03-29 16:48:04 -0400260}
261
Chuck Leverc2e1b092008-07-14 16:03:30 -0400262/*
263 * Fill in AF_INET family-specific arguments to register
264 */
265static int rpcb_register_netid4(struct sockaddr_in *address_to_register,
266 struct rpc_message *msg)
267{
268 struct rpcbind_args *map = msg->rpc_argp;
269 unsigned short port = ntohs(address_to_register->sin_port);
270 char buf[32];
271
272 /* Construct AF_INET universal address */
273 snprintf(buf, sizeof(buf),
274 NIPQUAD_FMT".%u.%u",
275 NIPQUAD(address_to_register->sin_addr.s_addr),
276 port >> 8, port & 0xff);
277 map->r_addr = buf;
278
279 dprintk("RPC: %sregistering [%u, %u, %s, '%s'] with "
280 "local rpcbind\n", (port ? "" : "un"),
281 map->r_prog, map->r_vers,
282 map->r_addr, map->r_netid);
283
284 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
285 if (port)
286 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
287
288 return rpcb_register_call((struct sockaddr *)&rpcb_inaddr_loopback,
289 sizeof(rpcb_inaddr_loopback),
Chuck Lever14aeb212008-08-18 19:34:00 -0400290 RPCBVERS_4, msg);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400291}
292
293/*
294 * Fill in AF_INET6 family-specific arguments to register
295 */
296static int rpcb_register_netid6(struct sockaddr_in6 *address_to_register,
297 struct rpc_message *msg)
298{
299 struct rpcbind_args *map = msg->rpc_argp;
300 unsigned short port = ntohs(address_to_register->sin6_port);
301 char buf[64];
302
303 /* Construct AF_INET6 universal address */
Chuck Lever9d548b92008-09-15 16:27:30 -0500304 if (ipv6_addr_any(&address_to_register->sin6_addr))
305 snprintf(buf, sizeof(buf), "::.%u.%u",
306 port >> 8, port & 0xff);
307 else
308 snprintf(buf, sizeof(buf), NIP6_FMT".%u.%u",
309 NIP6(address_to_register->sin6_addr),
310 port >> 8, port & 0xff);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400311 map->r_addr = buf;
312
313 dprintk("RPC: %sregistering [%u, %u, %s, '%s'] with "
314 "local rpcbind\n", (port ? "" : "un"),
315 map->r_prog, map->r_vers,
316 map->r_addr, map->r_netid);
317
318 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
319 if (port)
320 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
321
322 return rpcb_register_call((struct sockaddr *)&rpcb_in6addr_loopback,
323 sizeof(rpcb_in6addr_loopback),
Chuck Lever14aeb212008-08-18 19:34:00 -0400324 RPCBVERS_4, msg);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400325}
326
327/**
328 * rpcb_v4_register - set or unset a port registration with the local rpcbind
329 * @program: RPC program number of service to (un)register
330 * @version: RPC version number of service to (un)register
331 * @address: address family, IP address, and port to (un)register
332 * @netid: netid of transport protocol to (un)register
Chuck Lever14aeb212008-08-18 19:34:00 -0400333 *
334 * Returns zero if the registration request was dispatched successfully
335 * and the rpcbind daemon returned success. Otherwise, returns an errno
336 * value that reflects the nature of the error (request could not be
337 * dispatched, timed out, or rpcbind returned an error).
Chuck Leverc2e1b092008-07-14 16:03:30 -0400338 *
339 * RPC services invoke this function to advertise their contact
340 * information via the system's rpcbind daemon. RPC services
341 * invoke this function once for each [program, version, address,
342 * netid] tuple they wish to advertise.
343 *
344 * Callers may also unregister RPC services that are no longer
345 * available by setting the port number in the passed-in address
346 * to zero. Callers pass a netid of "" to unregister all
347 * transport netids associated with [program, version, address].
348 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400349 * This function uses rpcbind protocol version 4 to contact the
350 * local rpcbind daemon. The local rpcbind daemon must support
351 * version 4 of the rpcbind protocol in order for these functions
352 * to register a service successfully.
353 *
354 * Supported netids include "udp" and "tcp" for UDP and TCP over
355 * IPv4, and "udp6" and "tcp6" for UDP and TCP over IPv6,
356 * respectively.
357 *
358 * The contents of @address determine the address family and the
359 * port to be registered. The usual practice is to pass INADDR_ANY
360 * as the raw address, but specifying a non-zero address is also
361 * supported by this API if the caller wishes to advertise an RPC
362 * service on a specific network interface.
363 *
364 * Note that passing in INADDR_ANY does not create the same service
365 * registration as IN6ADDR_ANY. The former advertises an RPC
366 * service on any IPv4 address, but not on IPv6. The latter
367 * advertises the service on all IPv4 and IPv6 addresses.
368 */
369int rpcb_v4_register(const u32 program, const u32 version,
Chuck Lever14aeb212008-08-18 19:34:00 -0400370 const struct sockaddr *address, const char *netid)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400371{
372 struct rpcbind_args map = {
373 .r_prog = program,
374 .r_vers = version,
375 .r_netid = netid,
376 .r_owner = RPCB_OWNER_STRING,
377 };
378 struct rpc_message msg = {
379 .rpc_argp = &map,
Chuck Leverc2e1b092008-07-14 16:03:30 -0400380 };
381
Chuck Leverc2e1b092008-07-14 16:03:30 -0400382 switch (address->sa_family) {
383 case AF_INET:
384 return rpcb_register_netid4((struct sockaddr_in *)address,
385 &msg);
386 case AF_INET6:
387 return rpcb_register_netid6((struct sockaddr_in6 *)address,
388 &msg);
389 }
390
391 return -EAFNOSUPPORT;
392}
393
Chuck Levera5090502007-03-29 16:48:04 -0400394/**
Chuck Levercce63cd2007-07-01 12:13:12 -0400395 * rpcb_getport_sync - obtain the port for an RPC service on a given host
Chuck Levera5090502007-03-29 16:48:04 -0400396 * @sin: address of remote peer
397 * @prog: RPC program number to bind
398 * @vers: RPC version number to bind
399 * @prot: transport protocol to use to make this request
400 *
Chuck Lever67d60212008-01-14 15:12:01 -0500401 * Return value is the requested advertised port number,
402 * or a negative errno value.
403 *
Chuck Levera5090502007-03-29 16:48:04 -0400404 * Called from outside the RPC client in a synchronous task context.
Chuck Levercce63cd2007-07-01 12:13:12 -0400405 * Uses default timeout parameters specified by underlying transport.
Chuck Levera5090502007-03-29 16:48:04 -0400406 *
Chuck Lever67d60212008-01-14 15:12:01 -0500407 * XXX: Needs to support IPv6
Chuck Levera5090502007-03-29 16:48:04 -0400408 */
Chuck Leverf1ec08c2008-01-14 15:11:53 -0500409int rpcb_getport_sync(struct sockaddr_in *sin, u32 prog, u32 vers, int prot)
Chuck Levera5090502007-03-29 16:48:04 -0400410{
411 struct rpcbind_args map = {
412 .r_prog = prog,
413 .r_vers = vers,
414 .r_prot = prot,
415 .r_port = 0,
416 };
417 struct rpc_message msg = {
418 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
419 .rpc_argp = &map,
420 .rpc_resp = &map.r_port,
421 };
422 struct rpc_clnt *rpcb_clnt;
Chuck Levera5090502007-03-29 16:48:04 -0400423 int status;
424
Chuck Levercce63cd2007-07-01 12:13:12 -0400425 dprintk("RPC: %s(" NIPQUAD_FMT ", %u, %u, %d)\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800426 __func__, NIPQUAD(sin->sin_addr.s_addr), prog, vers, prot);
Chuck Levera5090502007-03-29 16:48:04 -0400427
Chuck Leverb91e1012008-01-14 15:11:46 -0500428 rpcb_clnt = rpcb_create(NULL, (struct sockaddr *)sin,
Chuck Lever423d8b02008-07-14 16:03:28 -0400429 sizeof(*sin), prot, RPCBVERS_2);
Chuck Levera5090502007-03-29 16:48:04 -0400430 if (IS_ERR(rpcb_clnt))
431 return PTR_ERR(rpcb_clnt);
432
433 status = rpc_call_sync(rpcb_clnt, &msg, 0);
Trond Myklebust90c57552007-06-09 19:49:36 -0400434 rpc_shutdown_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400435
436 if (status >= 0) {
437 if (map.r_port != 0)
438 return map.r_port;
439 status = -EACCES;
440 }
441 return status;
442}
Chuck Levercce63cd2007-07-01 12:13:12 -0400443EXPORT_SYMBOL_GPL(rpcb_getport_sync);
Chuck Levera5090502007-03-29 16:48:04 -0400444
Trond Myklebust803a9062008-07-01 15:20:55 -0400445static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt, struct rpcbind_args *map, struct rpc_procinfo *proc)
Trond Myklebust5138fde2007-07-14 15:40:01 -0400446{
447 struct rpc_message msg = {
Trond Myklebust803a9062008-07-01 15:20:55 -0400448 .rpc_proc = proc,
Trond Myklebust5138fde2007-07-14 15:40:01 -0400449 .rpc_argp = map,
450 .rpc_resp = &map->r_port,
451 };
452 struct rpc_task_setup task_setup_data = {
453 .rpc_client = rpcb_clnt,
454 .rpc_message = &msg,
455 .callback_ops = &rpcb_getport_ops,
456 .callback_data = map,
457 .flags = RPC_TASK_ASYNC,
458 };
459
460 return rpc_run_task(&task_setup_data);
461}
462
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400463/*
464 * In the case where rpc clients have been cloned, we want to make
465 * sure that we use the program number/version etc of the actual
466 * owner of the xprt. To do so, we walk back up the tree of parents
467 * to find whoever created the transport and/or whoever has the
468 * autobind flag set.
469 */
470static struct rpc_clnt *rpcb_find_transport_owner(struct rpc_clnt *clnt)
471{
472 struct rpc_clnt *parent = clnt->cl_parent;
473
474 while (parent != clnt) {
475 if (parent->cl_xprt != clnt->cl_xprt)
476 break;
477 if (clnt->cl_autobind)
478 break;
479 clnt = parent;
480 parent = parent->cl_parent;
481 }
482 return clnt;
483}
484
Chuck Levera5090502007-03-29 16:48:04 -0400485/**
Chuck Lever45160d62007-07-01 12:13:17 -0400486 * rpcb_getport_async - obtain the port for a given RPC service on a given host
Chuck Levera5090502007-03-29 16:48:04 -0400487 * @task: task that is waiting for portmapper request
488 *
489 * This one can be called for an ongoing RPC request, and can be used in
490 * an async (rpciod) context.
491 */
Chuck Lever45160d62007-07-01 12:13:17 -0400492void rpcb_getport_async(struct rpc_task *task)
Chuck Levera5090502007-03-29 16:48:04 -0400493{
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400494 struct rpc_clnt *clnt;
Trond Myklebust803a9062008-07-01 15:20:55 -0400495 struct rpc_procinfo *proc;
Chuck Lever0a48f5d2007-12-10 14:56:38 -0500496 u32 bind_version;
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400497 struct rpc_xprt *xprt;
Chuck Levera5090502007-03-29 16:48:04 -0400498 struct rpc_clnt *rpcb_clnt;
499 static struct rpcbind_args *map;
500 struct rpc_task *child;
Chuck Lever9f6ad262007-12-10 14:56:31 -0500501 struct sockaddr_storage addr;
502 struct sockaddr *sap = (struct sockaddr *)&addr;
503 size_t salen;
Chuck Levera5090502007-03-29 16:48:04 -0400504 int status;
505
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400506 clnt = rpcb_find_transport_owner(task->tk_client);
507 xprt = clnt->cl_xprt;
508
Chuck Lever45160d62007-07-01 12:13:17 -0400509 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800510 task->tk_pid, __func__,
Chuck Lever45160d62007-07-01 12:13:17 -0400511 clnt->cl_server, clnt->cl_prog, clnt->cl_vers, xprt->prot);
Chuck Levera5090502007-03-29 16:48:04 -0400512
Trond Myklebust381ba742008-07-07 12:18:53 -0400513 /* Put self on the wait queue to ensure we get notified if
514 * some other task is already attempting to bind the port */
515 rpc_sleep_on(&xprt->binding, task, NULL);
516
Chuck Levera5090502007-03-29 16:48:04 -0400517 if (xprt_test_and_set_binding(xprt)) {
Chuck Lever45160d62007-07-01 12:13:17 -0400518 dprintk("RPC: %5u %s: waiting for another binder\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800519 task->tk_pid, __func__);
Trond Myklebust381ba742008-07-07 12:18:53 -0400520 return;
Chuck Levera5090502007-03-29 16:48:04 -0400521 }
522
Chuck Levera5090502007-03-29 16:48:04 -0400523 /* Someone else may have bound if we slept */
524 if (xprt_bound(xprt)) {
525 status = 0;
Chuck Lever45160d62007-07-01 12:13:17 -0400526 dprintk("RPC: %5u %s: already bound\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800527 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400528 goto bailout_nofree;
529 }
530
Chuck Lever9f6ad262007-12-10 14:56:31 -0500531 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
Chuck Leverd5b64432007-08-06 11:57:18 -0400532
533 /* Don't ever use rpcbind v2 for AF_INET6 requests */
Chuck Lever9f6ad262007-12-10 14:56:31 -0500534 switch (sap->sa_family) {
Chuck Leverd5b64432007-08-06 11:57:18 -0400535 case AF_INET:
Trond Myklebust803a9062008-07-01 15:20:55 -0400536 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
537 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400538 break;
539 case AF_INET6:
Trond Myklebust803a9062008-07-01 15:20:55 -0400540 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
541 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400542 break;
543 default:
544 status = -EAFNOSUPPORT;
545 dprintk("RPC: %5u %s: bad address family\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800546 task->tk_pid, __func__);
Chuck Leverd5b64432007-08-06 11:57:18 -0400547 goto bailout_nofree;
548 }
Trond Myklebust803a9062008-07-01 15:20:55 -0400549 if (proc == NULL) {
Chuck Levera5090502007-03-29 16:48:04 -0400550 xprt->bind_index = 0;
Chuck Lever906462a2007-09-11 18:00:47 -0400551 status = -EPFNOSUPPORT;
Chuck Lever45160d62007-07-01 12:13:17 -0400552 dprintk("RPC: %5u %s: no more getport versions available\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800553 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400554 goto bailout_nofree;
555 }
Chuck Levera5090502007-03-29 16:48:04 -0400556
Chuck Lever45160d62007-07-01 12:13:17 -0400557 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800558 task->tk_pid, __func__, bind_version);
Chuck Levera5090502007-03-29 16:48:04 -0400559
Chuck Lever9f6ad262007-12-10 14:56:31 -0500560 rpcb_clnt = rpcb_create(clnt->cl_server, sap, salen, xprt->prot,
Chuck Lever423d8b02008-07-14 16:03:28 -0400561 bind_version);
Chuck Lever143b6c42007-08-16 16:03:31 -0400562 if (IS_ERR(rpcb_clnt)) {
563 status = PTR_ERR(rpcb_clnt);
564 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800565 task->tk_pid, __func__, PTR_ERR(rpcb_clnt));
Chuck Lever143b6c42007-08-16 16:03:31 -0400566 goto bailout_nofree;
567 }
568
Chuck Levera5090502007-03-29 16:48:04 -0400569 map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
570 if (!map) {
571 status = -ENOMEM;
Chuck Lever45160d62007-07-01 12:13:17 -0400572 dprintk("RPC: %5u %s: no memory available\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800573 task->tk_pid, __func__);
Trond Myklebust96165e22008-10-03 16:48:40 -0400574 goto bailout_release_client;
Chuck Levera5090502007-03-29 16:48:04 -0400575 }
576 map->r_prog = clnt->cl_prog;
577 map->r_vers = clnt->cl_vers;
578 map->r_prot = xprt->prot;
579 map->r_port = 0;
580 map->r_xprt = xprt_get(xprt);
Trond Myklebust86d61d82008-01-07 21:16:56 -0500581 map->r_netid = rpc_peeraddr2str(clnt, RPC_DISPLAY_NETID);
582 map->r_addr = rpc_peeraddr2str(rpcb_clnt, RPC_DISPLAY_UNIVERSAL_ADDR);
Chuck Levera5090502007-03-29 16:48:04 -0400583 map->r_owner = RPCB_OWNER_STRING; /* ignored for GETADDR */
Trond Myklebust381ba742008-07-07 12:18:53 -0400584 map->r_status = -EIO;
Chuck Levera5090502007-03-29 16:48:04 -0400585
Trond Myklebust803a9062008-07-01 15:20:55 -0400586 child = rpcb_call_async(rpcb_clnt, map, proc);
Trond Myklebust4c402b42007-06-14 16:40:32 -0400587 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400588 if (IS_ERR(child)) {
Trond Myklebust0d3a34b2008-07-07 12:18:52 -0400589 /* rpcb_map_release() has freed the arguments */
Chuck Lever45160d62007-07-01 12:13:17 -0400590 dprintk("RPC: %5u %s: rpc_run_task failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800591 task->tk_pid, __func__);
Trond Myklebust381ba742008-07-07 12:18:53 -0400592 return;
Chuck Levera5090502007-03-29 16:48:04 -0400593 }
Chuck Levera5090502007-03-29 16:48:04 -0400594
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400595 xprt->stat.bind_count++;
596 rpc_put_task(child);
Chuck Levera5090502007-03-29 16:48:04 -0400597 return;
598
Trond Myklebust96165e22008-10-03 16:48:40 -0400599bailout_release_client:
600 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400601bailout_nofree:
602 rpcb_wake_rpcbind_waiters(xprt, status);
Chuck Levera5090502007-03-29 16:48:04 -0400603 task->tk_status = status;
604}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400605EXPORT_SYMBOL_GPL(rpcb_getport_async);
Chuck Levera5090502007-03-29 16:48:04 -0400606
607/*
608 * Rpcbind child task calls this callback via tk_exit.
609 */
610static void rpcb_getport_done(struct rpc_task *child, void *data)
611{
612 struct rpcbind_args *map = data;
613 struct rpc_xprt *xprt = map->r_xprt;
614 int status = child->tk_status;
615
Chuck Lever4784cb52007-09-11 18:00:36 -0400616 /* Garbage reply: retry with a lesser rpcbind version */
617 if (status == -EIO)
618 status = -EPROTONOSUPPORT;
619
Chuck Levera5090502007-03-29 16:48:04 -0400620 /* rpcbind server doesn't support this rpcbind protocol version */
621 if (status == -EPROTONOSUPPORT)
622 xprt->bind_index++;
623
624 if (status < 0) {
625 /* rpcbind server not available on remote host? */
626 xprt->ops->set_port(xprt, 0);
627 } else if (map->r_port == 0) {
628 /* Requested RPC service wasn't registered on remote host */
629 xprt->ops->set_port(xprt, 0);
630 status = -EACCES;
631 } else {
632 /* Succeeded */
633 xprt->ops->set_port(xprt, map->r_port);
634 xprt_set_bound(xprt);
635 status = 0;
636 }
637
638 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
639 child->tk_pid, status, map->r_port);
640
Trond Myklebust381ba742008-07-07 12:18:53 -0400641 map->r_status = status;
Chuck Levera5090502007-03-29 16:48:04 -0400642}
643
Chuck Lever166b88d2008-07-14 16:03:26 -0400644/*
645 * XDR functions for rpcbind
646 */
647
Chuck Levera5090502007-03-29 16:48:04 -0400648static int rpcb_encode_mapping(struct rpc_rqst *req, __be32 *p,
649 struct rpcbind_args *rpcb)
650{
Chuck Leverdb820d62008-09-25 11:57:05 -0400651 dprintk("RPC: encoding rpcb request (%u, %u, %d, %u)\n",
Chuck Levera5090502007-03-29 16:48:04 -0400652 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
653 *p++ = htonl(rpcb->r_prog);
654 *p++ = htonl(rpcb->r_vers);
655 *p++ = htonl(rpcb->r_prot);
656 *p++ = htonl(rpcb->r_port);
657
658 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
659 return 0;
660}
661
662static int rpcb_decode_getport(struct rpc_rqst *req, __be32 *p,
663 unsigned short *portp)
664{
665 *portp = (unsigned short) ntohl(*p++);
Chuck Leverdb820d62008-09-25 11:57:05 -0400666 dprintk("RPC: rpcb getport result: %u\n",
Chuck Levera5090502007-03-29 16:48:04 -0400667 *portp);
668 return 0;
669}
670
671static int rpcb_decode_set(struct rpc_rqst *req, __be32 *p,
672 unsigned int *boolp)
673{
674 *boolp = (unsigned int) ntohl(*p++);
Chuck Leverdb820d62008-09-25 11:57:05 -0400675 dprintk("RPC: rpcb set/unset call %s\n",
Chuck Lever877fcf12008-06-25 17:24:23 -0400676 (*boolp ? "succeeded" : "failed"));
Chuck Levera5090502007-03-29 16:48:04 -0400677 return 0;
678}
679
680static int rpcb_encode_getaddr(struct rpc_rqst *req, __be32 *p,
681 struct rpcbind_args *rpcb)
682{
Chuck Leverdb820d62008-09-25 11:57:05 -0400683 dprintk("RPC: encoding rpcb request (%u, %u, %s)\n",
Chuck Levera5090502007-03-29 16:48:04 -0400684 rpcb->r_prog, rpcb->r_vers, rpcb->r_addr);
685 *p++ = htonl(rpcb->r_prog);
686 *p++ = htonl(rpcb->r_vers);
687
688 p = xdr_encode_string(p, rpcb->r_netid);
689 p = xdr_encode_string(p, rpcb->r_addr);
690 p = xdr_encode_string(p, rpcb->r_owner);
691
692 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
693
694 return 0;
695}
696
697static int rpcb_decode_getaddr(struct rpc_rqst *req, __be32 *p,
698 unsigned short *portp)
699{
700 char *addr;
Chuck Leveradc24df2007-08-06 11:56:31 -0400701 u32 addr_len;
702 int c, i, f, first, val;
Chuck Levera5090502007-03-29 16:48:04 -0400703
704 *portp = 0;
Chuck Leveradc24df2007-08-06 11:56:31 -0400705 addr_len = ntohl(*p++);
Chuck Levera5090502007-03-29 16:48:04 -0400706
Chuck Levere65fe392007-09-11 18:00:31 -0400707 /*
708 * Simple sanity check. The smallest possible universal
709 * address is an IPv4 address string containing 11 bytes.
710 */
Chuck Lever0fb2b7e2007-12-10 14:56:46 -0500711 if (addr_len < 11 || addr_len > RPCBIND_MAXUADDRLEN)
Chuck Levere65fe392007-09-11 18:00:31 -0400712 goto out_err;
Chuck Levera5090502007-03-29 16:48:04 -0400713
Chuck Levere65fe392007-09-11 18:00:31 -0400714 /*
715 * Start at the end and walk backwards until the first dot
716 * is encountered. When the second dot is found, we have
717 * both parts of the port number.
718 */
Chuck Levera5090502007-03-29 16:48:04 -0400719 addr = (char *)p;
720 val = 0;
721 first = 1;
722 f = 1;
723 for (i = addr_len - 1; i > 0; i--) {
724 c = addr[i];
725 if (c >= '0' && c <= '9') {
726 val += (c - '0') * f;
727 f *= 10;
728 } else if (c == '.') {
729 if (first) {
730 *portp = val;
731 val = first = 0;
732 f = 1;
733 } else {
734 *portp |= (val << 8);
735 break;
736 }
737 }
738 }
739
Chuck Levere65fe392007-09-11 18:00:31 -0400740 /*
741 * Simple sanity check. If we never saw a dot in the reply,
742 * then this was probably just garbage.
743 */
744 if (first)
745 goto out_err;
746
Chuck Levera5090502007-03-29 16:48:04 -0400747 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp);
748 return 0;
Chuck Levere65fe392007-09-11 18:00:31 -0400749
750out_err:
751 dprintk("RPC: rpcbind server returned malformed reply\n");
752 return -EIO;
Chuck Levera5090502007-03-29 16:48:04 -0400753}
754
755#define RPCB_program_sz (1u)
756#define RPCB_version_sz (1u)
757#define RPCB_protocol_sz (1u)
758#define RPCB_port_sz (1u)
759#define RPCB_boolean_sz (1u)
760
\"Talpey, Thomas\4f40ee42007-09-10 13:42:38 -0400761#define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
Chuck Lever0fb2b7e2007-12-10 14:56:46 -0500762#define RPCB_addr_sz (1+XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
Chuck Levera5090502007-03-29 16:48:04 -0400763#define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
764
765#define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
766 RPCB_protocol_sz+RPCB_port_sz
767#define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
768 RPCB_netid_sz+RPCB_addr_sz+ \
769 RPCB_ownerstring_sz
770
771#define RPCB_setres_sz RPCB_boolean_sz
772#define RPCB_getportres_sz RPCB_port_sz
773
774/*
775 * Note that RFC 1833 does not put any size restrictions on the
776 * address string returned by the remote rpcbind database.
777 */
778#define RPCB_getaddrres_sz RPCB_addr_sz
779
780#define PROC(proc, argtype, restype) \
781 [RPCBPROC_##proc] = { \
782 .p_proc = RPCBPROC_##proc, \
783 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
784 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
785 .p_arglen = RPCB_##argtype##args_sz, \
786 .p_replen = RPCB_##restype##res_sz, \
787 .p_statidx = RPCBPROC_##proc, \
788 .p_timer = 0, \
789 .p_name = #proc, \
790 }
791
792/*
793 * Not all rpcbind procedures described in RFC 1833 are implemented
794 * since the Linux kernel RPC code requires only these.
795 */
796static struct rpc_procinfo rpcb_procedures2[] = {
797 PROC(SET, mapping, set),
798 PROC(UNSET, mapping, set),
Chuck Lever6a774052008-06-25 17:24:39 -0400799 PROC(GETPORT, mapping, getport),
Chuck Levera5090502007-03-29 16:48:04 -0400800};
801
802static struct rpc_procinfo rpcb_procedures3[] = {
Chuck Lever166b88d2008-07-14 16:03:26 -0400803 PROC(SET, getaddr, set),
804 PROC(UNSET, getaddr, set),
Chuck Levera5090502007-03-29 16:48:04 -0400805 PROC(GETADDR, getaddr, getaddr),
806};
807
808static struct rpc_procinfo rpcb_procedures4[] = {
Chuck Lever166b88d2008-07-14 16:03:26 -0400809 PROC(SET, getaddr, set),
810 PROC(UNSET, getaddr, set),
Chuck Lever88424132008-06-25 17:24:47 -0400811 PROC(GETADDR, getaddr, getaddr),
Chuck Levera5090502007-03-29 16:48:04 -0400812 PROC(GETVERSADDR, getaddr, getaddr),
813};
814
815static struct rpcb_info rpcb_next_version[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400816 {
817 .rpc_vers = RPCBVERS_2,
818 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
819 },
820 {
821 .rpc_proc = NULL,
822 },
Chuck Levera5090502007-03-29 16:48:04 -0400823};
824
Chuck Leverd5b64432007-08-06 11:57:18 -0400825static struct rpcb_info rpcb_next_version6[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400826 {
827 .rpc_vers = RPCBVERS_4,
Chuck Lever88424132008-06-25 17:24:47 -0400828 .rpc_proc = &rpcb_procedures4[RPCBPROC_GETADDR],
Chuck Leverfc200e72008-06-25 17:24:31 -0400829 },
830 {
831 .rpc_vers = RPCBVERS_3,
832 .rpc_proc = &rpcb_procedures3[RPCBPROC_GETADDR],
833 },
Chuck Leverfc200e72008-06-25 17:24:31 -0400834 {
835 .rpc_proc = NULL,
836 },
Chuck Leverd5b64432007-08-06 11:57:18 -0400837};
838
Chuck Levera5090502007-03-29 16:48:04 -0400839static struct rpc_version rpcb_version2 = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400840 .number = RPCBVERS_2,
Chuck Levera5090502007-03-29 16:48:04 -0400841 .nrprocs = RPCB_HIGHPROC_2,
842 .procs = rpcb_procedures2
843};
844
845static struct rpc_version rpcb_version3 = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400846 .number = RPCBVERS_3,
Chuck Levera5090502007-03-29 16:48:04 -0400847 .nrprocs = RPCB_HIGHPROC_3,
848 .procs = rpcb_procedures3
849};
850
851static struct rpc_version rpcb_version4 = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400852 .number = RPCBVERS_4,
Chuck Levera5090502007-03-29 16:48:04 -0400853 .nrprocs = RPCB_HIGHPROC_4,
854 .procs = rpcb_procedures4
855};
856
857static struct rpc_version *rpcb_version[] = {
858 NULL,
859 NULL,
860 &rpcb_version2,
861 &rpcb_version3,
862 &rpcb_version4
863};
864
865static struct rpc_stat rpcb_stats;
866
Adrian Bunk7f4adef2007-06-13 01:03:13 +0200867static struct rpc_program rpcb_program = {
Chuck Levera5090502007-03-29 16:48:04 -0400868 .name = "rpcbind",
869 .number = RPCBIND_PROGRAM,
870 .nrvers = ARRAY_SIZE(rpcb_version),
871 .version = rpcb_version,
872 .stats = &rpcb_stats,
873};