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