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