2 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
5 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
6 * RFC 3530: "Network File System (NFS) version 4 Protocol"
8 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
9 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
11 * Descended from net/sunrpc/pmap_clnt.c,
12 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
15 #include <linux/module.h>
17 #include <linux/types.h>
18 #include <linux/socket.h>
20 #include <linux/in6.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
24 #include <linux/sunrpc/clnt.h>
25 #include <linux/sunrpc/sched.h>
26 #include <linux/sunrpc/xprtsock.h>
29 # define RPCDBG_FACILITY RPCDBG_BIND
32 #define RPCBIND_PROGRAM (100000u)
33 #define RPCBIND_PORT (111u)
40 RPCBPROC_GETADDR
= 3, /* alias for GETPORT */
43 RPCBPROC_BCAST
= 5, /* alias for CALLIT */
53 #define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
54 #define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
55 #define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
60 * Quoting RFC 3530, section 2.2:
62 * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the
67 * The prefix, "h1.h2.h3.h4", is the standard textual form for
68 * representing an IPv4 address, which is always four octets long.
69 * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively,
70 * the first through fourth octets each converted to ASCII-decimal.
71 * Assuming big-endian ordering, p1 and p2 are, respectively, the first
72 * and second octets each converted to ASCII-decimal. For example, if a
73 * host, in big-endian order, has an address of 0x0A010307 and there is
74 * a service listening on, in big endian order, port 0x020F (decimal
75 * 527), then the complete universal address is "10.1.3.7.2.15".
79 * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the
82 * x1:x2:x3:x4:x5:x6:x7:x8.p1.p2
84 * The suffix "p1.p2" is the service port, and is computed the same way
85 * as with universal addresses for TCP and UDP over IPv4. The prefix,
86 * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for
87 * representing an IPv6 address as defined in Section 2.2 of [RFC2373].
88 * Additionally, the two alternative forms specified in Section 2.2 of
89 * [RFC2373] are also acceptable.
91 * XXX: Currently this implementation does not explicitly convert the
92 * stored address to US-ASCII on non-ASCII systems.
94 #define RPCB_MAXADDRLEN (128u)
99 * The "owner" is allowed to unset a service in the rpcbind database.
100 * We always use the following (arbitrary) fixed string.
102 #define RPCB_OWNER_STRING "rpcb"
103 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
105 static void rpcb_getport_done(struct rpc_task
*, void *);
106 static struct rpc_program rpcb_program
;
108 struct rpcbind_args
{
109 struct rpc_xprt
* r_xprt
;
114 unsigned short r_port
;
116 char r_addr
[RPCB_MAXADDRLEN
];
120 static struct rpc_procinfo rpcb_procedures2
[];
121 static struct rpc_procinfo rpcb_procedures3
[];
125 struct rpc_procinfo
* rpc_proc
;
128 static struct rpcb_info rpcb_next_version
[];
129 static struct rpcb_info rpcb_next_version6
[];
131 static void rpcb_map_release(void *data
)
133 struct rpcbind_args
*map
= data
;
135 xprt_put(map
->r_xprt
);
139 static const struct rpc_call_ops rpcb_getport_ops
= {
140 .rpc_call_done
= rpcb_getport_done
,
141 .rpc_release
= rpcb_map_release
,
144 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt
*xprt
, int status
)
146 xprt_clear_binding(xprt
);
147 rpc_wake_up_status(&xprt
->binding
, status
);
150 static struct rpc_clnt
*rpcb_create(char *hostname
, struct sockaddr
*srvaddr
,
151 size_t salen
, int proto
, u32 version
,
154 struct rpc_create_args args
= {
158 .servername
= hostname
,
159 .program
= &rpcb_program
,
161 .authflavor
= RPC_AUTH_UNIX
,
162 .flags
= (RPC_CLNT_CREATE_NOPING
|
163 RPC_CLNT_CREATE_INTR
),
166 switch (srvaddr
->sa_family
) {
168 ((struct sockaddr_in
*)srvaddr
)->sin_port
= htons(RPCBIND_PORT
);
171 ((struct sockaddr_in6
*)srvaddr
)->sin6_port
= htons(RPCBIND_PORT
);
178 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
179 return rpc_create(&args
);
183 * rpcb_register - set or unset a port registration with the local rpcbind svc
184 * @prog: RPC program number to bind
185 * @vers: RPC version number to bind
186 * @prot: transport protocol to use to make this request
187 * @port: port value to register
190 * port == 0 means unregister, port != 0 means register.
192 * This routine supports only rpcbind version 2.
194 int rpcb_register(u32 prog
, u32 vers
, int prot
, unsigned short port
, int *okay
)
196 struct sockaddr_in sin
= {
197 .sin_family
= AF_INET
,
198 .sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
),
200 struct rpcbind_args map
= {
206 struct rpc_message msg
= {
207 .rpc_proc
= &rpcb_procedures2
[port
?
208 RPCBPROC_SET
: RPCBPROC_UNSET
],
212 struct rpc_clnt
*rpcb_clnt
;
215 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
216 "rpcbind\n", (port
? "" : "un"),
217 prog
, vers
, prot
, port
);
219 rpcb_clnt
= rpcb_create("localhost", (struct sockaddr
*) &sin
,
220 sizeof(sin
), XPRT_TRANSPORT_UDP
, 2, 1);
221 if (IS_ERR(rpcb_clnt
))
222 return PTR_ERR(rpcb_clnt
);
224 error
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
226 rpc_shutdown_client(rpcb_clnt
);
228 printk(KERN_WARNING
"RPC: failed to contact local rpcbind "
229 "server (errno %d).\n", -error
);
230 dprintk("RPC: registration status %d/%d\n", error
, *okay
);
236 * rpcb_getport_sync - obtain the port for an RPC service on a given host
237 * @sin: address of remote peer
238 * @prog: RPC program number to bind
239 * @vers: RPC version number to bind
240 * @prot: transport protocol to use to make this request
242 * Called from outside the RPC client in a synchronous task context.
243 * Uses default timeout parameters specified by underlying transport.
245 * XXX: Needs to support IPv6, and rpcbind versions 3 and 4
247 int rpcb_getport_sync(struct sockaddr_in
*sin
, __u32 prog
,
248 __u32 vers
, int prot
)
250 struct rpcbind_args map
= {
256 struct rpc_message msg
= {
257 .rpc_proc
= &rpcb_procedures2
[RPCBPROC_GETPORT
],
259 .rpc_resp
= &map
.r_port
,
261 struct rpc_clnt
*rpcb_clnt
;
265 dprintk("RPC: %s(" NIPQUAD_FMT
", %u, %u, %d)\n",
266 __FUNCTION__
, NIPQUAD(sin
->sin_addr
.s_addr
), prog
, vers
, prot
);
268 sprintf(hostname
, NIPQUAD_FMT
, NIPQUAD(sin
->sin_addr
.s_addr
));
269 rpcb_clnt
= rpcb_create(hostname
, (struct sockaddr
*)sin
,
270 sizeof(sin
), prot
, 2, 0);
271 if (IS_ERR(rpcb_clnt
))
272 return PTR_ERR(rpcb_clnt
);
274 status
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
275 rpc_shutdown_client(rpcb_clnt
);
284 EXPORT_SYMBOL_GPL(rpcb_getport_sync
);
286 static struct rpc_task
*rpcb_call_async(struct rpc_clnt
*rpcb_clnt
, struct rpcbind_args
*map
, int version
)
288 struct rpc_message msg
= {
289 .rpc_proc
= rpcb_next_version
[version
].rpc_proc
,
291 .rpc_resp
= &map
->r_port
,
293 struct rpc_task_setup task_setup_data
= {
294 .rpc_client
= rpcb_clnt
,
296 .callback_ops
= &rpcb_getport_ops
,
297 .callback_data
= map
,
298 .flags
= RPC_TASK_ASYNC
,
301 return rpc_run_task(&task_setup_data
);
305 * rpcb_getport_async - obtain the port for a given RPC service on a given host
306 * @task: task that is waiting for portmapper request
308 * This one can be called for an ongoing RPC request, and can be used in
309 * an async (rpciod) context.
311 void rpcb_getport_async(struct rpc_task
*task
)
313 struct rpc_clnt
*clnt
= task
->tk_client
;
315 struct rpc_xprt
*xprt
= task
->tk_xprt
;
316 struct rpc_clnt
*rpcb_clnt
;
317 static struct rpcbind_args
*map
;
318 struct rpc_task
*child
;
319 struct sockaddr_storage addr
;
320 struct sockaddr
*sap
= (struct sockaddr
*)&addr
;
323 struct rpcb_info
*info
;
325 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
326 task
->tk_pid
, __FUNCTION__
,
327 clnt
->cl_server
, clnt
->cl_prog
, clnt
->cl_vers
, xprt
->prot
);
329 /* Autobind on cloned rpc clients is discouraged */
330 BUG_ON(clnt
->cl_parent
!= clnt
);
332 if (xprt_test_and_set_binding(xprt
)) {
333 status
= -EAGAIN
; /* tell caller to check again */
334 dprintk("RPC: %5u %s: waiting for another binder\n",
335 task
->tk_pid
, __FUNCTION__
);
339 /* Put self on queue before sending rpcbind request, in case
340 * rpcb_getport_done completes before we return from rpc_run_task */
341 rpc_sleep_on(&xprt
->binding
, task
, NULL
, NULL
);
343 /* Someone else may have bound if we slept */
344 if (xprt_bound(xprt
)) {
346 dprintk("RPC: %5u %s: already bound\n",
347 task
->tk_pid
, __FUNCTION__
);
351 salen
= rpc_peeraddr(clnt
, sap
, sizeof(addr
));
353 /* Don't ever use rpcbind v2 for AF_INET6 requests */
354 switch (sap
->sa_family
) {
356 info
= rpcb_next_version
;
359 info
= rpcb_next_version6
;
362 status
= -EAFNOSUPPORT
;
363 dprintk("RPC: %5u %s: bad address family\n",
364 task
->tk_pid
, __FUNCTION__
);
367 if (info
[xprt
->bind_index
].rpc_proc
== NULL
) {
368 xprt
->bind_index
= 0;
369 status
= -EPFNOSUPPORT
;
370 dprintk("RPC: %5u %s: no more getport versions available\n",
371 task
->tk_pid
, __FUNCTION__
);
374 bind_version
= info
[xprt
->bind_index
].rpc_vers
;
376 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
377 task
->tk_pid
, __FUNCTION__
, bind_version
);
379 rpcb_clnt
= rpcb_create(clnt
->cl_server
, sap
, salen
, xprt
->prot
,
381 if (IS_ERR(rpcb_clnt
)) {
382 status
= PTR_ERR(rpcb_clnt
);
383 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
384 task
->tk_pid
, __FUNCTION__
, PTR_ERR(rpcb_clnt
));
388 map
= kzalloc(sizeof(struct rpcbind_args
), GFP_ATOMIC
);
391 dprintk("RPC: %5u %s: no memory available\n",
392 task
->tk_pid
, __FUNCTION__
);
395 map
->r_prog
= clnt
->cl_prog
;
396 map
->r_vers
= clnt
->cl_vers
;
397 map
->r_prot
= xprt
->prot
;
399 map
->r_xprt
= xprt_get(xprt
);
400 map
->r_netid
= rpc_peeraddr2str(clnt
, RPC_DISPLAY_NETID
);
402 rpc_peeraddr2str(rpcb_clnt
, RPC_DISPLAY_UNIVERSAL_ADDR
),
403 sizeof(map
->r_addr
));
404 map
->r_owner
= RPCB_OWNER_STRING
; /* ignored for GETADDR */
406 child
= rpcb_call_async(rpcb_clnt
, map
, xprt
->bind_index
);
407 rpc_release_client(rpcb_clnt
);
410 dprintk("RPC: %5u %s: rpc_run_task failed\n",
411 task
->tk_pid
, __FUNCTION__
);
416 task
->tk_xprt
->stat
.bind_count
++;
423 rpcb_wake_rpcbind_waiters(xprt
, status
);
425 task
->tk_status
= status
;
427 EXPORT_SYMBOL_GPL(rpcb_getport_async
);
430 * Rpcbind child task calls this callback via tk_exit.
432 static void rpcb_getport_done(struct rpc_task
*child
, void *data
)
434 struct rpcbind_args
*map
= data
;
435 struct rpc_xprt
*xprt
= map
->r_xprt
;
436 int status
= child
->tk_status
;
438 /* Garbage reply: retry with a lesser rpcbind version */
440 status
= -EPROTONOSUPPORT
;
442 /* rpcbind server doesn't support this rpcbind protocol version */
443 if (status
== -EPROTONOSUPPORT
)
447 /* rpcbind server not available on remote host? */
448 xprt
->ops
->set_port(xprt
, 0);
449 } else if (map
->r_port
== 0) {
450 /* Requested RPC service wasn't registered on remote host */
451 xprt
->ops
->set_port(xprt
, 0);
455 xprt
->ops
->set_port(xprt
, map
->r_port
);
456 xprt_set_bound(xprt
);
460 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
461 child
->tk_pid
, status
, map
->r_port
);
463 rpcb_wake_rpcbind_waiters(xprt
, status
);
466 static int rpcb_encode_mapping(struct rpc_rqst
*req
, __be32
*p
,
467 struct rpcbind_args
*rpcb
)
469 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
470 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_prot
, rpcb
->r_port
);
471 *p
++ = htonl(rpcb
->r_prog
);
472 *p
++ = htonl(rpcb
->r_vers
);
473 *p
++ = htonl(rpcb
->r_prot
);
474 *p
++ = htonl(rpcb
->r_port
);
476 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
480 static int rpcb_decode_getport(struct rpc_rqst
*req
, __be32
*p
,
481 unsigned short *portp
)
483 *portp
= (unsigned short) ntohl(*p
++);
484 dprintk("RPC: rpcb_decode_getport result %u\n",
489 static int rpcb_decode_set(struct rpc_rqst
*req
, __be32
*p
,
492 *boolp
= (unsigned int) ntohl(*p
++);
493 dprintk("RPC: rpcb_decode_set result %u\n",
498 static int rpcb_encode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
499 struct rpcbind_args
*rpcb
)
501 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
502 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_addr
);
503 *p
++ = htonl(rpcb
->r_prog
);
504 *p
++ = htonl(rpcb
->r_vers
);
506 p
= xdr_encode_string(p
, rpcb
->r_netid
);
507 p
= xdr_encode_string(p
, rpcb
->r_addr
);
508 p
= xdr_encode_string(p
, rpcb
->r_owner
);
510 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
515 static int rpcb_decode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
516 unsigned short *portp
)
520 int c
, i
, f
, first
, val
;
523 addr_len
= ntohl(*p
++);
526 * Simple sanity check. The smallest possible universal
527 * address is an IPv4 address string containing 11 bytes.
529 if (addr_len
< 11 || addr_len
> RPCB_MAXADDRLEN
)
533 * Start at the end and walk backwards until the first dot
534 * is encountered. When the second dot is found, we have
535 * both parts of the port number.
541 for (i
= addr_len
- 1; i
> 0; i
--) {
543 if (c
>= '0' && c
<= '9') {
544 val
+= (c
- '0') * f
;
546 } else if (c
== '.') {
552 *portp
|= (val
<< 8);
559 * Simple sanity check. If we never saw a dot in the reply,
560 * then this was probably just garbage.
565 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp
);
569 dprintk("RPC: rpcbind server returned malformed reply\n");
573 #define RPCB_program_sz (1u)
574 #define RPCB_version_sz (1u)
575 #define RPCB_protocol_sz (1u)
576 #define RPCB_port_sz (1u)
577 #define RPCB_boolean_sz (1u)
579 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
580 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCB_MAXADDRLEN))
581 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
583 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
584 RPCB_protocol_sz+RPCB_port_sz
585 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
586 RPCB_netid_sz+RPCB_addr_sz+ \
589 #define RPCB_setres_sz RPCB_boolean_sz
590 #define RPCB_getportres_sz RPCB_port_sz
593 * Note that RFC 1833 does not put any size restrictions on the
594 * address string returned by the remote rpcbind database.
596 #define RPCB_getaddrres_sz RPCB_addr_sz
598 #define PROC(proc, argtype, restype) \
599 [RPCBPROC_##proc] = { \
600 .p_proc = RPCBPROC_##proc, \
601 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
602 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
603 .p_arglen = RPCB_##argtype##args_sz, \
604 .p_replen = RPCB_##restype##res_sz, \
605 .p_statidx = RPCBPROC_##proc, \
611 * Not all rpcbind procedures described in RFC 1833 are implemented
612 * since the Linux kernel RPC code requires only these.
614 static struct rpc_procinfo rpcb_procedures2
[] = {
615 PROC(SET
, mapping
, set
),
616 PROC(UNSET
, mapping
, set
),
617 PROC(GETADDR
, mapping
, getport
),
620 static struct rpc_procinfo rpcb_procedures3
[] = {
621 PROC(SET
, mapping
, set
),
622 PROC(UNSET
, mapping
, set
),
623 PROC(GETADDR
, getaddr
, getaddr
),
626 static struct rpc_procinfo rpcb_procedures4
[] = {
627 PROC(SET
, mapping
, set
),
628 PROC(UNSET
, mapping
, set
),
629 PROC(GETVERSADDR
, getaddr
, getaddr
),
632 static struct rpcb_info rpcb_next_version
[] = {
633 #ifdef CONFIG_SUNRPC_BIND34
634 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
635 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
637 { 2, &rpcb_procedures2
[RPCBPROC_GETPORT
] },
641 static struct rpcb_info rpcb_next_version6
[] = {
642 #ifdef CONFIG_SUNRPC_BIND34
643 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
644 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
649 static struct rpc_version rpcb_version2
= {
651 .nrprocs
= RPCB_HIGHPROC_2
,
652 .procs
= rpcb_procedures2
655 static struct rpc_version rpcb_version3
= {
657 .nrprocs
= RPCB_HIGHPROC_3
,
658 .procs
= rpcb_procedures3
661 static struct rpc_version rpcb_version4
= {
663 .nrprocs
= RPCB_HIGHPROC_4
,
664 .procs
= rpcb_procedures4
667 static struct rpc_version
*rpcb_version
[] = {
675 static struct rpc_stat rpcb_stats
;
677 static struct rpc_program rpcb_program
= {
679 .number
= RPCBIND_PROGRAM
,
680 .nrvers
= ARRAY_SIZE(rpcb_version
),
681 .version
= rpcb_version
,
682 .stats
= &rpcb_stats
,