blob: 34abc91058d84ebe5dd89ed481d9542b548c24a7 [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
Chuck Levera5090502007-03-29 16:48:04 -0400463/**
Chuck Lever45160d62007-07-01 12:13:17 -0400464 * rpcb_getport_async - obtain the port for a given RPC service on a given host
Chuck Levera5090502007-03-29 16:48:04 -0400465 * @task: task that is waiting for portmapper request
466 *
467 * This one can be called for an ongoing RPC request, and can be used in
468 * an async (rpciod) context.
469 */
Chuck Lever45160d62007-07-01 12:13:17 -0400470void rpcb_getport_async(struct rpc_task *task)
Chuck Levera5090502007-03-29 16:48:04 -0400471{
472 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebust803a9062008-07-01 15:20:55 -0400473 struct rpc_procinfo *proc;
Chuck Lever0a48f5d2007-12-10 14:56:38 -0500474 u32 bind_version;
Chuck Levera5090502007-03-29 16:48:04 -0400475 struct rpc_xprt *xprt = task->tk_xprt;
476 struct rpc_clnt *rpcb_clnt;
477 static struct rpcbind_args *map;
478 struct rpc_task *child;
Chuck Lever9f6ad262007-12-10 14:56:31 -0500479 struct sockaddr_storage addr;
480 struct sockaddr *sap = (struct sockaddr *)&addr;
481 size_t salen;
Chuck Levera5090502007-03-29 16:48:04 -0400482 int status;
483
Chuck Lever45160d62007-07-01 12:13:17 -0400484 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800485 task->tk_pid, __func__,
Chuck Lever45160d62007-07-01 12:13:17 -0400486 clnt->cl_server, clnt->cl_prog, clnt->cl_vers, xprt->prot);
Chuck Levera5090502007-03-29 16:48:04 -0400487
488 /* Autobind on cloned rpc clients is discouraged */
489 BUG_ON(clnt->cl_parent != clnt);
490
Trond Myklebust381ba742008-07-07 12:18:53 -0400491 /* Put self on the wait queue to ensure we get notified if
492 * some other task is already attempting to bind the port */
493 rpc_sleep_on(&xprt->binding, task, NULL);
494
Chuck Levera5090502007-03-29 16:48:04 -0400495 if (xprt_test_and_set_binding(xprt)) {
Chuck Lever45160d62007-07-01 12:13:17 -0400496 dprintk("RPC: %5u %s: waiting for another binder\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800497 task->tk_pid, __func__);
Trond Myklebust381ba742008-07-07 12:18:53 -0400498 return;
Chuck Levera5090502007-03-29 16:48:04 -0400499 }
500
Chuck Levera5090502007-03-29 16:48:04 -0400501 /* Someone else may have bound if we slept */
502 if (xprt_bound(xprt)) {
503 status = 0;
Chuck Lever45160d62007-07-01 12:13:17 -0400504 dprintk("RPC: %5u %s: already bound\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800505 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400506 goto bailout_nofree;
507 }
508
Chuck Lever9f6ad262007-12-10 14:56:31 -0500509 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
Chuck Leverd5b64432007-08-06 11:57:18 -0400510
511 /* Don't ever use rpcbind v2 for AF_INET6 requests */
Chuck Lever9f6ad262007-12-10 14:56:31 -0500512 switch (sap->sa_family) {
Chuck Leverd5b64432007-08-06 11:57:18 -0400513 case AF_INET:
Trond Myklebust803a9062008-07-01 15:20:55 -0400514 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
515 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400516 break;
517 case AF_INET6:
Trond Myklebust803a9062008-07-01 15:20:55 -0400518 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
519 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400520 break;
521 default:
522 status = -EAFNOSUPPORT;
523 dprintk("RPC: %5u %s: bad address family\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800524 task->tk_pid, __func__);
Chuck Leverd5b64432007-08-06 11:57:18 -0400525 goto bailout_nofree;
526 }
Trond Myklebust803a9062008-07-01 15:20:55 -0400527 if (proc == NULL) {
Chuck Levera5090502007-03-29 16:48:04 -0400528 xprt->bind_index = 0;
Chuck Lever906462a2007-09-11 18:00:47 -0400529 status = -EPFNOSUPPORT;
Chuck Lever45160d62007-07-01 12:13:17 -0400530 dprintk("RPC: %5u %s: no more getport versions available\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800531 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400532 goto bailout_nofree;
533 }
Chuck Levera5090502007-03-29 16:48:04 -0400534
Chuck Lever45160d62007-07-01 12:13:17 -0400535 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800536 task->tk_pid, __func__, bind_version);
Chuck Levera5090502007-03-29 16:48:04 -0400537
Chuck Lever9f6ad262007-12-10 14:56:31 -0500538 rpcb_clnt = rpcb_create(clnt->cl_server, sap, salen, xprt->prot,
Chuck Lever423d8b02008-07-14 16:03:28 -0400539 bind_version);
Chuck Lever143b6c42007-08-16 16:03:31 -0400540 if (IS_ERR(rpcb_clnt)) {
541 status = PTR_ERR(rpcb_clnt);
542 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800543 task->tk_pid, __func__, PTR_ERR(rpcb_clnt));
Chuck Lever143b6c42007-08-16 16:03:31 -0400544 goto bailout_nofree;
545 }
546
Chuck Levera5090502007-03-29 16:48:04 -0400547 map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
548 if (!map) {
549 status = -ENOMEM;
Chuck Lever45160d62007-07-01 12:13:17 -0400550 dprintk("RPC: %5u %s: no memory available\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800551 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400552 goto bailout_nofree;
553 }
554 map->r_prog = clnt->cl_prog;
555 map->r_vers = clnt->cl_vers;
556 map->r_prot = xprt->prot;
557 map->r_port = 0;
558 map->r_xprt = xprt_get(xprt);
Trond Myklebust86d61d82008-01-07 21:16:56 -0500559 map->r_netid = rpc_peeraddr2str(clnt, RPC_DISPLAY_NETID);
560 map->r_addr = rpc_peeraddr2str(rpcb_clnt, RPC_DISPLAY_UNIVERSAL_ADDR);
Chuck Levera5090502007-03-29 16:48:04 -0400561 map->r_owner = RPCB_OWNER_STRING; /* ignored for GETADDR */
Trond Myklebust381ba742008-07-07 12:18:53 -0400562 map->r_status = -EIO;
Chuck Levera5090502007-03-29 16:48:04 -0400563
Trond Myklebust803a9062008-07-01 15:20:55 -0400564 child = rpcb_call_async(rpcb_clnt, map, proc);
Trond Myklebust4c402b42007-06-14 16:40:32 -0400565 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400566 if (IS_ERR(child)) {
Trond Myklebust0d3a34b2008-07-07 12:18:52 -0400567 /* rpcb_map_release() has freed the arguments */
Chuck Lever45160d62007-07-01 12:13:17 -0400568 dprintk("RPC: %5u %s: rpc_run_task failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800569 task->tk_pid, __func__);
Trond Myklebust381ba742008-07-07 12:18:53 -0400570 return;
Chuck Levera5090502007-03-29 16:48:04 -0400571 }
572 rpc_put_task(child);
573
574 task->tk_xprt->stat.bind_count++;
575 return;
576
Chuck Levera5090502007-03-29 16:48:04 -0400577bailout_nofree:
578 rpcb_wake_rpcbind_waiters(xprt, status);
Chuck Levera5090502007-03-29 16:48:04 -0400579 task->tk_status = status;
580}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400581EXPORT_SYMBOL_GPL(rpcb_getport_async);
Chuck Levera5090502007-03-29 16:48:04 -0400582
583/*
584 * Rpcbind child task calls this callback via tk_exit.
585 */
586static void rpcb_getport_done(struct rpc_task *child, void *data)
587{
588 struct rpcbind_args *map = data;
589 struct rpc_xprt *xprt = map->r_xprt;
590 int status = child->tk_status;
591
Chuck Lever4784cb52007-09-11 18:00:36 -0400592 /* Garbage reply: retry with a lesser rpcbind version */
593 if (status == -EIO)
594 status = -EPROTONOSUPPORT;
595
Chuck Levera5090502007-03-29 16:48:04 -0400596 /* rpcbind server doesn't support this rpcbind protocol version */
597 if (status == -EPROTONOSUPPORT)
598 xprt->bind_index++;
599
600 if (status < 0) {
601 /* rpcbind server not available on remote host? */
602 xprt->ops->set_port(xprt, 0);
603 } else if (map->r_port == 0) {
604 /* Requested RPC service wasn't registered on remote host */
605 xprt->ops->set_port(xprt, 0);
606 status = -EACCES;
607 } else {
608 /* Succeeded */
609 xprt->ops->set_port(xprt, map->r_port);
610 xprt_set_bound(xprt);
611 status = 0;
612 }
613
614 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
615 child->tk_pid, status, map->r_port);
616
Trond Myklebust381ba742008-07-07 12:18:53 -0400617 map->r_status = status;
Chuck Levera5090502007-03-29 16:48:04 -0400618}
619
Chuck Lever166b88d2008-07-14 16:03:26 -0400620/*
621 * XDR functions for rpcbind
622 */
623
Chuck Levera5090502007-03-29 16:48:04 -0400624static int rpcb_encode_mapping(struct rpc_rqst *req, __be32 *p,
625 struct rpcbind_args *rpcb)
626{
Chuck Leverdb820d62008-09-25 11:57:05 -0400627 dprintk("RPC: encoding rpcb request (%u, %u, %d, %u)\n",
Chuck Levera5090502007-03-29 16:48:04 -0400628 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
629 *p++ = htonl(rpcb->r_prog);
630 *p++ = htonl(rpcb->r_vers);
631 *p++ = htonl(rpcb->r_prot);
632 *p++ = htonl(rpcb->r_port);
633
634 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
635 return 0;
636}
637
638static int rpcb_decode_getport(struct rpc_rqst *req, __be32 *p,
639 unsigned short *portp)
640{
641 *portp = (unsigned short) ntohl(*p++);
Chuck Leverdb820d62008-09-25 11:57:05 -0400642 dprintk("RPC: rpcb getport result: %u\n",
Chuck Levera5090502007-03-29 16:48:04 -0400643 *portp);
644 return 0;
645}
646
647static int rpcb_decode_set(struct rpc_rqst *req, __be32 *p,
648 unsigned int *boolp)
649{
650 *boolp = (unsigned int) ntohl(*p++);
Chuck Leverdb820d62008-09-25 11:57:05 -0400651 dprintk("RPC: rpcb set/unset call %s\n",
Chuck Lever877fcf12008-06-25 17:24:23 -0400652 (*boolp ? "succeeded" : "failed"));
Chuck Levera5090502007-03-29 16:48:04 -0400653 return 0;
654}
655
656static int rpcb_encode_getaddr(struct rpc_rqst *req, __be32 *p,
657 struct rpcbind_args *rpcb)
658{
Chuck Leverdb820d62008-09-25 11:57:05 -0400659 dprintk("RPC: encoding rpcb request (%u, %u, %s)\n",
Chuck Levera5090502007-03-29 16:48:04 -0400660 rpcb->r_prog, rpcb->r_vers, rpcb->r_addr);
661 *p++ = htonl(rpcb->r_prog);
662 *p++ = htonl(rpcb->r_vers);
663
664 p = xdr_encode_string(p, rpcb->r_netid);
665 p = xdr_encode_string(p, rpcb->r_addr);
666 p = xdr_encode_string(p, rpcb->r_owner);
667
668 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
669
670 return 0;
671}
672
673static int rpcb_decode_getaddr(struct rpc_rqst *req, __be32 *p,
674 unsigned short *portp)
675{
676 char *addr;
Chuck Leveradc24df2007-08-06 11:56:31 -0400677 u32 addr_len;
678 int c, i, f, first, val;
Chuck Levera5090502007-03-29 16:48:04 -0400679
680 *portp = 0;
Chuck Leveradc24df2007-08-06 11:56:31 -0400681 addr_len = ntohl(*p++);
Chuck Levera5090502007-03-29 16:48:04 -0400682
Chuck Levere65fe392007-09-11 18:00:31 -0400683 /*
684 * Simple sanity check. The smallest possible universal
685 * address is an IPv4 address string containing 11 bytes.
686 */
Chuck Lever0fb2b7e2007-12-10 14:56:46 -0500687 if (addr_len < 11 || addr_len > RPCBIND_MAXUADDRLEN)
Chuck Levere65fe392007-09-11 18:00:31 -0400688 goto out_err;
Chuck Levera5090502007-03-29 16:48:04 -0400689
Chuck Levere65fe392007-09-11 18:00:31 -0400690 /*
691 * Start at the end and walk backwards until the first dot
692 * is encountered. When the second dot is found, we have
693 * both parts of the port number.
694 */
Chuck Levera5090502007-03-29 16:48:04 -0400695 addr = (char *)p;
696 val = 0;
697 first = 1;
698 f = 1;
699 for (i = addr_len - 1; i > 0; i--) {
700 c = addr[i];
701 if (c >= '0' && c <= '9') {
702 val += (c - '0') * f;
703 f *= 10;
704 } else if (c == '.') {
705 if (first) {
706 *portp = val;
707 val = first = 0;
708 f = 1;
709 } else {
710 *portp |= (val << 8);
711 break;
712 }
713 }
714 }
715
Chuck Levere65fe392007-09-11 18:00:31 -0400716 /*
717 * Simple sanity check. If we never saw a dot in the reply,
718 * then this was probably just garbage.
719 */
720 if (first)
721 goto out_err;
722
Chuck Levera5090502007-03-29 16:48:04 -0400723 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp);
724 return 0;
Chuck Levere65fe392007-09-11 18:00:31 -0400725
726out_err:
727 dprintk("RPC: rpcbind server returned malformed reply\n");
728 return -EIO;
Chuck Levera5090502007-03-29 16:48:04 -0400729}
730
731#define RPCB_program_sz (1u)
732#define RPCB_version_sz (1u)
733#define RPCB_protocol_sz (1u)
734#define RPCB_port_sz (1u)
735#define RPCB_boolean_sz (1u)
736
\"Talpey, Thomas\4f40ee42007-09-10 13:42:38 -0400737#define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
Chuck Lever0fb2b7e2007-12-10 14:56:46 -0500738#define RPCB_addr_sz (1+XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
Chuck Levera5090502007-03-29 16:48:04 -0400739#define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
740
741#define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
742 RPCB_protocol_sz+RPCB_port_sz
743#define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
744 RPCB_netid_sz+RPCB_addr_sz+ \
745 RPCB_ownerstring_sz
746
747#define RPCB_setres_sz RPCB_boolean_sz
748#define RPCB_getportres_sz RPCB_port_sz
749
750/*
751 * Note that RFC 1833 does not put any size restrictions on the
752 * address string returned by the remote rpcbind database.
753 */
754#define RPCB_getaddrres_sz RPCB_addr_sz
755
756#define PROC(proc, argtype, restype) \
757 [RPCBPROC_##proc] = { \
758 .p_proc = RPCBPROC_##proc, \
759 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
760 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
761 .p_arglen = RPCB_##argtype##args_sz, \
762 .p_replen = RPCB_##restype##res_sz, \
763 .p_statidx = RPCBPROC_##proc, \
764 .p_timer = 0, \
765 .p_name = #proc, \
766 }
767
768/*
769 * Not all rpcbind procedures described in RFC 1833 are implemented
770 * since the Linux kernel RPC code requires only these.
771 */
772static struct rpc_procinfo rpcb_procedures2[] = {
773 PROC(SET, mapping, set),
774 PROC(UNSET, mapping, set),
Chuck Lever6a774052008-06-25 17:24:39 -0400775 PROC(GETPORT, mapping, getport),
Chuck Levera5090502007-03-29 16:48:04 -0400776};
777
778static struct rpc_procinfo rpcb_procedures3[] = {
Chuck Lever166b88d2008-07-14 16:03:26 -0400779 PROC(SET, getaddr, set),
780 PROC(UNSET, getaddr, set),
Chuck Levera5090502007-03-29 16:48:04 -0400781 PROC(GETADDR, getaddr, getaddr),
782};
783
784static struct rpc_procinfo rpcb_procedures4[] = {
Chuck Lever166b88d2008-07-14 16:03:26 -0400785 PROC(SET, getaddr, set),
786 PROC(UNSET, getaddr, set),
Chuck Lever88424132008-06-25 17:24:47 -0400787 PROC(GETADDR, getaddr, getaddr),
Chuck Levera5090502007-03-29 16:48:04 -0400788 PROC(GETVERSADDR, getaddr, getaddr),
789};
790
791static struct rpcb_info rpcb_next_version[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400792 {
793 .rpc_vers = RPCBVERS_2,
794 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
795 },
796 {
797 .rpc_proc = NULL,
798 },
Chuck Levera5090502007-03-29 16:48:04 -0400799};
800
Chuck Leverd5b64432007-08-06 11:57:18 -0400801static struct rpcb_info rpcb_next_version6[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400802 {
803 .rpc_vers = RPCBVERS_4,
Chuck Lever88424132008-06-25 17:24:47 -0400804 .rpc_proc = &rpcb_procedures4[RPCBPROC_GETADDR],
Chuck Leverfc200e72008-06-25 17:24:31 -0400805 },
806 {
807 .rpc_vers = RPCBVERS_3,
808 .rpc_proc = &rpcb_procedures3[RPCBPROC_GETADDR],
809 },
Chuck Leverfc200e72008-06-25 17:24:31 -0400810 {
811 .rpc_proc = NULL,
812 },
Chuck Leverd5b64432007-08-06 11:57:18 -0400813};
814
Chuck Levera5090502007-03-29 16:48:04 -0400815static struct rpc_version rpcb_version2 = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400816 .number = RPCBVERS_2,
Chuck Levera5090502007-03-29 16:48:04 -0400817 .nrprocs = RPCB_HIGHPROC_2,
818 .procs = rpcb_procedures2
819};
820
821static struct rpc_version rpcb_version3 = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400822 .number = RPCBVERS_3,
Chuck Levera5090502007-03-29 16:48:04 -0400823 .nrprocs = RPCB_HIGHPROC_3,
824 .procs = rpcb_procedures3
825};
826
827static struct rpc_version rpcb_version4 = {
Chuck Leverfc200e72008-06-25 17:24:31 -0400828 .number = RPCBVERS_4,
Chuck Levera5090502007-03-29 16:48:04 -0400829 .nrprocs = RPCB_HIGHPROC_4,
830 .procs = rpcb_procedures4
831};
832
833static struct rpc_version *rpcb_version[] = {
834 NULL,
835 NULL,
836 &rpcb_version2,
837 &rpcb_version3,
838 &rpcb_version4
839};
840
841static struct rpc_stat rpcb_stats;
842
Adrian Bunk7f4adef2007-06-13 01:03:13 +0200843static struct rpc_program rpcb_program = {
Chuck Levera5090502007-03-29 16:48:04 -0400844 .name = "rpcbind",
845 .number = RPCBIND_PROGRAM,
846 .nrvers = ARRAY_SIZE(rpcb_version),
847 .version = rpcb_version,
848 .stats = &rpcb_stats,
849};