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