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>
28 # define RPCDBG_FACILITY RPCDBG_BIND
31 #define RPCBIND_PROGRAM (100000u)
32 #define RPCBIND_PORT (111u)
39 RPCBPROC_GETADDR
= 3, /* alias for GETPORT */
42 RPCBPROC_BCAST
= 5, /* alias for CALLIT */
52 #define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
53 #define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
54 #define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
59 * Quoting RFC 3530, section 2.2:
61 * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the
66 * The prefix, "h1.h2.h3.h4", is the standard textual form for
67 * representing an IPv4 address, which is always four octets long.
68 * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively,
69 * the first through fourth octets each converted to ASCII-decimal.
70 * Assuming big-endian ordering, p1 and p2 are, respectively, the first
71 * and second octets each converted to ASCII-decimal. For example, if a
72 * host, in big-endian order, has an address of 0x0A010307 and there is
73 * a service listening on, in big endian order, port 0x020F (decimal
74 * 527), then the complete universal address is "10.1.3.7.2.15".
78 * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the
81 * x1:x2:x3:x4:x5:x6:x7:x8.p1.p2
83 * The suffix "p1.p2" is the service port, and is computed the same way
84 * as with universal addresses for TCP and UDP over IPv4. The prefix,
85 * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for
86 * representing an IPv6 address as defined in Section 2.2 of [RFC2373].
87 * Additionally, the two alternative forms specified in Section 2.2 of
88 * [RFC2373] are also acceptable.
90 * XXX: Currently this implementation does not explicitly convert the
91 * stored address to US-ASCII on non-ASCII systems.
93 #define RPCB_MAXADDRLEN (128u)
98 * The "owner" is allowed to unset a service in the rpcbind database.
99 * We always use the following (arbitrary) fixed string.
101 #define RPCB_OWNER_STRING "rpcb"
102 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
104 static void rpcb_getport_done(struct rpc_task
*, void *);
105 extern struct rpc_program rpcb_program
;
107 struct rpcbind_args
{
108 struct rpc_xprt
* r_xprt
;
113 unsigned short r_port
;
115 char r_addr
[RPCB_MAXADDRLEN
];
119 static struct rpc_procinfo rpcb_procedures2
[];
120 static struct rpc_procinfo rpcb_procedures3
[];
124 struct rpc_procinfo
* rpc_proc
;
127 static struct rpcb_info rpcb_next_version
[];
128 static struct rpcb_info rpcb_next_version6
[];
130 static void rpcb_getport_prepare(struct rpc_task
*task
, void *calldata
)
132 struct rpcbind_args
*map
= calldata
;
133 struct rpc_xprt
*xprt
= map
->r_xprt
;
134 struct rpc_message msg
= {
135 .rpc_proc
= rpcb_next_version
[xprt
->bind_index
].rpc_proc
,
137 .rpc_resp
= &map
->r_port
,
140 rpc_call_setup(task
, &msg
, 0);
143 static void rpcb_map_release(void *data
)
145 struct rpcbind_args
*map
= data
;
147 xprt_put(map
->r_xprt
);
151 static const struct rpc_call_ops rpcb_getport_ops
= {
152 .rpc_call_prepare
= rpcb_getport_prepare
,
153 .rpc_call_done
= rpcb_getport_done
,
154 .rpc_release
= rpcb_map_release
,
157 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt
*xprt
, int status
)
159 xprt_clear_binding(xprt
);
160 rpc_wake_up_status(&xprt
->binding
, status
);
163 static struct rpc_clnt
*rpcb_create(char *hostname
, struct sockaddr
*srvaddr
,
164 int proto
, int version
, int privileged
)
166 struct rpc_create_args args
= {
169 .addrsize
= sizeof(struct sockaddr_in
),
170 .servername
= hostname
,
171 .program
= &rpcb_program
,
173 .authflavor
= RPC_AUTH_UNIX
,
174 .flags
= (RPC_CLNT_CREATE_NOPING
|
175 RPC_CLNT_CREATE_INTR
),
178 switch (srvaddr
->sa_family
) {
180 ((struct sockaddr_in
*)srvaddr
)->sin_port
= htons(RPCBIND_PORT
);
183 ((struct sockaddr_in6
*)srvaddr
)->sin6_port
= htons(RPCBIND_PORT
);
190 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
191 return rpc_create(&args
);
195 * rpcb_register - set or unset a port registration with the local rpcbind svc
196 * @prog: RPC program number to bind
197 * @vers: RPC version number to bind
198 * @prot: transport protocol to use to make this request
199 * @port: port value to register
202 * port == 0 means unregister, port != 0 means register.
204 * This routine supports only rpcbind version 2.
206 int rpcb_register(u32 prog
, u32 vers
, int prot
, unsigned short port
, int *okay
)
208 struct sockaddr_in sin
= {
209 .sin_family
= AF_INET
,
210 .sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
),
212 struct rpcbind_args map
= {
218 struct rpc_message msg
= {
219 .rpc_proc
= &rpcb_procedures2
[port
?
220 RPCBPROC_SET
: RPCBPROC_UNSET
],
224 struct rpc_clnt
*rpcb_clnt
;
227 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
228 "rpcbind\n", (port
? "" : "un"),
229 prog
, vers
, prot
, port
);
231 rpcb_clnt
= rpcb_create("localhost", (struct sockaddr
*) &sin
,
233 if (IS_ERR(rpcb_clnt
))
234 return PTR_ERR(rpcb_clnt
);
236 error
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
238 rpc_shutdown_client(rpcb_clnt
);
240 printk(KERN_WARNING
"RPC: failed to contact local rpcbind "
241 "server (errno %d).\n", -error
);
242 dprintk("RPC: registration status %d/%d\n", error
, *okay
);
248 * rpcb_getport_sync - obtain the port for an RPC service on a given host
249 * @sin: address of remote peer
250 * @prog: RPC program number to bind
251 * @vers: RPC version number to bind
252 * @prot: transport protocol to use to make this request
254 * Called from outside the RPC client in a synchronous task context.
255 * Uses default timeout parameters specified by underlying transport.
257 * XXX: Needs to support IPv6, and rpcbind versions 3 and 4
259 int rpcb_getport_sync(struct sockaddr_in
*sin
, __u32 prog
,
260 __u32 vers
, int prot
)
262 struct rpcbind_args map
= {
268 struct rpc_message msg
= {
269 .rpc_proc
= &rpcb_procedures2
[RPCBPROC_GETPORT
],
271 .rpc_resp
= &map
.r_port
,
273 struct rpc_clnt
*rpcb_clnt
;
277 dprintk("RPC: %s(" NIPQUAD_FMT
", %u, %u, %d)\n",
278 __FUNCTION__
, NIPQUAD(sin
->sin_addr
.s_addr
), prog
, vers
, prot
);
280 sprintf(hostname
, NIPQUAD_FMT
, NIPQUAD(sin
->sin_addr
.s_addr
));
281 rpcb_clnt
= rpcb_create(hostname
, (struct sockaddr
*)sin
, prot
, 2, 0);
282 if (IS_ERR(rpcb_clnt
))
283 return PTR_ERR(rpcb_clnt
);
285 status
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
286 rpc_shutdown_client(rpcb_clnt
);
295 EXPORT_SYMBOL_GPL(rpcb_getport_sync
);
298 * rpcb_getport_async - obtain the port for a given RPC service on a given host
299 * @task: task that is waiting for portmapper request
301 * This one can be called for an ongoing RPC request, and can be used in
302 * an async (rpciod) context.
304 void rpcb_getport_async(struct rpc_task
*task
)
306 struct rpc_clnt
*clnt
= task
->tk_client
;
308 struct rpc_xprt
*xprt
= task
->tk_xprt
;
309 struct rpc_clnt
*rpcb_clnt
;
310 static struct rpcbind_args
*map
;
311 struct rpc_task
*child
;
312 struct sockaddr addr
;
314 struct rpcb_info
*info
;
316 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
317 task
->tk_pid
, __FUNCTION__
,
318 clnt
->cl_server
, clnt
->cl_prog
, clnt
->cl_vers
, xprt
->prot
);
320 /* Autobind on cloned rpc clients is discouraged */
321 BUG_ON(clnt
->cl_parent
!= clnt
);
323 if (xprt_test_and_set_binding(xprt
)) {
324 status
= -EAGAIN
; /* tell caller to check again */
325 dprintk("RPC: %5u %s: waiting for another binder\n",
326 task
->tk_pid
, __FUNCTION__
);
330 /* Put self on queue before sending rpcbind request, in case
331 * rpcb_getport_done completes before we return from rpc_run_task */
332 rpc_sleep_on(&xprt
->binding
, task
, NULL
, NULL
);
334 /* Someone else may have bound if we slept */
335 if (xprt_bound(xprt
)) {
337 dprintk("RPC: %5u %s: already bound\n",
338 task
->tk_pid
, __FUNCTION__
);
342 rpc_peeraddr(clnt
, (void *)&addr
, sizeof(addr
));
344 /* Don't ever use rpcbind v2 for AF_INET6 requests */
345 switch (addr
.sa_family
) {
347 info
= rpcb_next_version
;
350 info
= rpcb_next_version6
;
353 status
= -EAFNOSUPPORT
;
354 dprintk("RPC: %5u %s: bad address family\n",
355 task
->tk_pid
, __FUNCTION__
);
358 if (info
[xprt
->bind_index
].rpc_proc
== NULL
) {
359 xprt
->bind_index
= 0;
360 status
= -EPFNOSUPPORT
;
361 dprintk("RPC: %5u %s: no more getport versions available\n",
362 task
->tk_pid
, __FUNCTION__
);
365 bind_version
= info
[xprt
->bind_index
].rpc_vers
;
367 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
368 task
->tk_pid
, __FUNCTION__
, bind_version
);
370 rpcb_clnt
= rpcb_create(clnt
->cl_server
, &addr
, xprt
->prot
,
372 if (IS_ERR(rpcb_clnt
)) {
373 status
= PTR_ERR(rpcb_clnt
);
374 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
375 task
->tk_pid
, __FUNCTION__
, PTR_ERR(rpcb_clnt
));
379 map
= kzalloc(sizeof(struct rpcbind_args
), GFP_ATOMIC
);
382 dprintk("RPC: %5u %s: no memory available\n",
383 task
->tk_pid
, __FUNCTION__
);
386 map
->r_prog
= clnt
->cl_prog
;
387 map
->r_vers
= clnt
->cl_vers
;
388 map
->r_prot
= xprt
->prot
;
390 map
->r_xprt
= xprt_get(xprt
);
391 map
->r_netid
= rpc_peeraddr2str(clnt
, RPC_DISPLAY_NETID
);
393 rpc_peeraddr2str(rpcb_clnt
, RPC_DISPLAY_UNIVERSAL_ADDR
),
394 sizeof(map
->r_addr
));
395 map
->r_owner
= RPCB_OWNER_STRING
; /* ignored for GETADDR */
397 child
= rpc_run_task(rpcb_clnt
, RPC_TASK_ASYNC
, &rpcb_getport_ops
, map
);
398 rpc_release_client(rpcb_clnt
);
401 dprintk("RPC: %5u %s: rpc_run_task failed\n",
402 task
->tk_pid
, __FUNCTION__
);
407 task
->tk_xprt
->stat
.bind_count
++;
414 rpcb_wake_rpcbind_waiters(xprt
, status
);
416 task
->tk_status
= status
;
420 * Rpcbind child task calls this callback via tk_exit.
422 static void rpcb_getport_done(struct rpc_task
*child
, void *data
)
424 struct rpcbind_args
*map
= data
;
425 struct rpc_xprt
*xprt
= map
->r_xprt
;
426 int status
= child
->tk_status
;
428 /* Garbage reply: retry with a lesser rpcbind version */
430 status
= -EPROTONOSUPPORT
;
432 /* rpcbind server doesn't support this rpcbind protocol version */
433 if (status
== -EPROTONOSUPPORT
)
437 /* rpcbind server not available on remote host? */
438 xprt
->ops
->set_port(xprt
, 0);
439 } else if (map
->r_port
== 0) {
440 /* Requested RPC service wasn't registered on remote host */
441 xprt
->ops
->set_port(xprt
, 0);
445 xprt
->ops
->set_port(xprt
, map
->r_port
);
446 xprt_set_bound(xprt
);
450 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
451 child
->tk_pid
, status
, map
->r_port
);
453 rpcb_wake_rpcbind_waiters(xprt
, status
);
456 static int rpcb_encode_mapping(struct rpc_rqst
*req
, __be32
*p
,
457 struct rpcbind_args
*rpcb
)
459 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
460 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_prot
, rpcb
->r_port
);
461 *p
++ = htonl(rpcb
->r_prog
);
462 *p
++ = htonl(rpcb
->r_vers
);
463 *p
++ = htonl(rpcb
->r_prot
);
464 *p
++ = htonl(rpcb
->r_port
);
466 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
470 static int rpcb_decode_getport(struct rpc_rqst
*req
, __be32
*p
,
471 unsigned short *portp
)
473 *portp
= (unsigned short) ntohl(*p
++);
474 dprintk("RPC: rpcb_decode_getport result %u\n",
479 static int rpcb_decode_set(struct rpc_rqst
*req
, __be32
*p
,
482 *boolp
= (unsigned int) ntohl(*p
++);
483 dprintk("RPC: rpcb_decode_set result %u\n",
488 static int rpcb_encode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
489 struct rpcbind_args
*rpcb
)
491 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
492 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_addr
);
493 *p
++ = htonl(rpcb
->r_prog
);
494 *p
++ = htonl(rpcb
->r_vers
);
496 p
= xdr_encode_string(p
, rpcb
->r_netid
);
497 p
= xdr_encode_string(p
, rpcb
->r_addr
);
498 p
= xdr_encode_string(p
, rpcb
->r_owner
);
500 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
505 static int rpcb_decode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
506 unsigned short *portp
)
510 int c
, i
, f
, first
, val
;
513 addr_len
= ntohl(*p
++);
516 * Simple sanity check. The smallest possible universal
517 * address is an IPv4 address string containing 11 bytes.
519 if (addr_len
< 11 || addr_len
> RPCB_MAXADDRLEN
)
523 * Start at the end and walk backwards until the first dot
524 * is encountered. When the second dot is found, we have
525 * both parts of the port number.
531 for (i
= addr_len
- 1; i
> 0; i
--) {
533 if (c
>= '0' && c
<= '9') {
534 val
+= (c
- '0') * f
;
536 } else if (c
== '.') {
542 *portp
|= (val
<< 8);
549 * Simple sanity check. If we never saw a dot in the reply,
550 * then this was probably just garbage.
555 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp
);
559 dprintk("RPC: rpcbind server returned malformed reply\n");
563 #define RPCB_program_sz (1u)
564 #define RPCB_version_sz (1u)
565 #define RPCB_protocol_sz (1u)
566 #define RPCB_port_sz (1u)
567 #define RPCB_boolean_sz (1u)
569 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
570 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCB_MAXADDRLEN))
571 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
573 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
574 RPCB_protocol_sz+RPCB_port_sz
575 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
576 RPCB_netid_sz+RPCB_addr_sz+ \
579 #define RPCB_setres_sz RPCB_boolean_sz
580 #define RPCB_getportres_sz RPCB_port_sz
583 * Note that RFC 1833 does not put any size restrictions on the
584 * address string returned by the remote rpcbind database.
586 #define RPCB_getaddrres_sz RPCB_addr_sz
588 #define PROC(proc, argtype, restype) \
589 [RPCBPROC_##proc] = { \
590 .p_proc = RPCBPROC_##proc, \
591 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
592 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
593 .p_arglen = RPCB_##argtype##args_sz, \
594 .p_replen = RPCB_##restype##res_sz, \
595 .p_statidx = RPCBPROC_##proc, \
601 * Not all rpcbind procedures described in RFC 1833 are implemented
602 * since the Linux kernel RPC code requires only these.
604 static struct rpc_procinfo rpcb_procedures2
[] = {
605 PROC(SET
, mapping
, set
),
606 PROC(UNSET
, mapping
, set
),
607 PROC(GETADDR
, mapping
, getport
),
610 static struct rpc_procinfo rpcb_procedures3
[] = {
611 PROC(SET
, mapping
, set
),
612 PROC(UNSET
, mapping
, set
),
613 PROC(GETADDR
, getaddr
, getaddr
),
616 static struct rpc_procinfo rpcb_procedures4
[] = {
617 PROC(SET
, mapping
, set
),
618 PROC(UNSET
, mapping
, set
),
619 PROC(GETVERSADDR
, getaddr
, getaddr
),
622 static struct rpcb_info rpcb_next_version
[] = {
623 #ifdef CONFIG_SUNRPC_BIND34
624 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
625 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
627 { 2, &rpcb_procedures2
[RPCBPROC_GETPORT
] },
631 static struct rpcb_info rpcb_next_version6
[] = {
632 #ifdef CONFIG_SUNRPC_BIND34
633 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
634 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
639 static struct rpc_version rpcb_version2
= {
641 .nrprocs
= RPCB_HIGHPROC_2
,
642 .procs
= rpcb_procedures2
645 static struct rpc_version rpcb_version3
= {
647 .nrprocs
= RPCB_HIGHPROC_3
,
648 .procs
= rpcb_procedures3
651 static struct rpc_version rpcb_version4
= {
653 .nrprocs
= RPCB_HIGHPROC_4
,
654 .procs
= rpcb_procedures4
657 static struct rpc_version
*rpcb_version
[] = {
665 static struct rpc_stat rpcb_stats
;
667 struct rpc_program rpcb_program
= {
669 .number
= RPCBIND_PROGRAM
,
670 .nrvers
= ARRAY_SIZE(rpcb_version
),
671 .version
= rpcb_version
,
672 .stats
= &rpcb_stats
,