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 * The "owner" is allowed to unset a service in the rpcbind database.
61 * We always use the following (arbitrary) fixed string.
63 #define RPCB_OWNER_STRING "rpcb"
64 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
66 static void rpcb_getport_done(struct rpc_task
*, void *);
67 static struct rpc_program rpcb_program
;
70 struct rpc_xprt
* r_xprt
;
75 unsigned short r_port
;
81 static struct rpc_procinfo rpcb_procedures2
[];
82 static struct rpc_procinfo rpcb_procedures3
[];
86 struct rpc_procinfo
* rpc_proc
;
89 static struct rpcb_info rpcb_next_version
[];
90 static struct rpcb_info rpcb_next_version6
[];
92 static void rpcb_map_release(void *data
)
94 struct rpcbind_args
*map
= data
;
96 xprt_put(map
->r_xprt
);
100 static const struct rpc_call_ops rpcb_getport_ops
= {
101 .rpc_call_done
= rpcb_getport_done
,
102 .rpc_release
= rpcb_map_release
,
105 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt
*xprt
, int status
)
107 xprt_clear_binding(xprt
);
108 rpc_wake_up_status(&xprt
->binding
, status
);
111 static struct rpc_clnt
*rpcb_create(char *hostname
, struct sockaddr
*srvaddr
,
112 size_t salen
, int proto
, u32 version
,
115 struct rpc_create_args args
= {
119 .servername
= hostname
,
120 .program
= &rpcb_program
,
122 .authflavor
= RPC_AUTH_UNIX
,
123 .flags
= RPC_CLNT_CREATE_NOPING
,
126 switch (srvaddr
->sa_family
) {
128 ((struct sockaddr_in
*)srvaddr
)->sin_port
= htons(RPCBIND_PORT
);
131 ((struct sockaddr_in6
*)srvaddr
)->sin6_port
= htons(RPCBIND_PORT
);
138 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
139 return rpc_create(&args
);
143 * rpcb_register - set or unset a port registration with the local rpcbind svc
144 * @prog: RPC program number to bind
145 * @vers: RPC version number to bind
146 * @prot: transport protocol to use to make this request
147 * @port: port value to register
150 * port == 0 means unregister, port != 0 means register.
152 * This routine supports only rpcbind version 2.
154 int rpcb_register(u32 prog
, u32 vers
, int prot
, unsigned short port
, int *okay
)
156 struct sockaddr_in sin
= {
157 .sin_family
= AF_INET
,
158 .sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
),
160 struct rpcbind_args map
= {
166 struct rpc_message msg
= {
167 .rpc_proc
= &rpcb_procedures2
[port
?
168 RPCBPROC_SET
: RPCBPROC_UNSET
],
172 struct rpc_clnt
*rpcb_clnt
;
175 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
176 "rpcbind\n", (port
? "" : "un"),
177 prog
, vers
, prot
, port
);
179 rpcb_clnt
= rpcb_create("localhost", (struct sockaddr
*) &sin
,
180 sizeof(sin
), XPRT_TRANSPORT_UDP
, 2, 1);
181 if (IS_ERR(rpcb_clnt
))
182 return PTR_ERR(rpcb_clnt
);
184 error
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
186 rpc_shutdown_client(rpcb_clnt
);
188 printk(KERN_WARNING
"RPC: failed to contact local rpcbind "
189 "server (errno %d).\n", -error
);
190 dprintk("RPC: registration status %d/%d\n", error
, *okay
);
196 * rpcb_getport_sync - obtain the port for an RPC service on a given host
197 * @sin: address of remote peer
198 * @prog: RPC program number to bind
199 * @vers: RPC version number to bind
200 * @prot: transport protocol to use to make this request
202 * Return value is the requested advertised port number,
203 * or a negative errno value.
205 * Called from outside the RPC client in a synchronous task context.
206 * Uses default timeout parameters specified by underlying transport.
208 * XXX: Needs to support IPv6
210 int rpcb_getport_sync(struct sockaddr_in
*sin
, u32 prog
, u32 vers
, int prot
)
212 struct rpcbind_args map
= {
218 struct rpc_message msg
= {
219 .rpc_proc
= &rpcb_procedures2
[RPCBPROC_GETPORT
],
221 .rpc_resp
= &map
.r_port
,
223 struct rpc_clnt
*rpcb_clnt
;
226 dprintk("RPC: %s(" NIPQUAD_FMT
", %u, %u, %d)\n",
227 __FUNCTION__
, NIPQUAD(sin
->sin_addr
.s_addr
), prog
, vers
, prot
);
229 rpcb_clnt
= rpcb_create(NULL
, (struct sockaddr
*)sin
,
230 sizeof(*sin
), prot
, 2, 0);
231 if (IS_ERR(rpcb_clnt
))
232 return PTR_ERR(rpcb_clnt
);
234 status
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
235 rpc_shutdown_client(rpcb_clnt
);
244 EXPORT_SYMBOL_GPL(rpcb_getport_sync
);
246 static struct rpc_task
*rpcb_call_async(struct rpc_clnt
*rpcb_clnt
, struct rpcbind_args
*map
, int version
)
248 struct rpc_message msg
= {
249 .rpc_proc
= rpcb_next_version
[version
].rpc_proc
,
251 .rpc_resp
= &map
->r_port
,
253 struct rpc_task_setup task_setup_data
= {
254 .rpc_client
= rpcb_clnt
,
256 .callback_ops
= &rpcb_getport_ops
,
257 .callback_data
= map
,
258 .flags
= RPC_TASK_ASYNC
,
261 return rpc_run_task(&task_setup_data
);
265 * rpcb_getport_async - obtain the port for a given RPC service on a given host
266 * @task: task that is waiting for portmapper request
268 * This one can be called for an ongoing RPC request, and can be used in
269 * an async (rpciod) context.
271 void rpcb_getport_async(struct rpc_task
*task
)
273 struct rpc_clnt
*clnt
= task
->tk_client
;
275 struct rpc_xprt
*xprt
= task
->tk_xprt
;
276 struct rpc_clnt
*rpcb_clnt
;
277 static struct rpcbind_args
*map
;
278 struct rpc_task
*child
;
279 struct sockaddr_storage addr
;
280 struct sockaddr
*sap
= (struct sockaddr
*)&addr
;
283 struct rpcb_info
*info
;
285 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
286 task
->tk_pid
, __FUNCTION__
,
287 clnt
->cl_server
, clnt
->cl_prog
, clnt
->cl_vers
, xprt
->prot
);
289 /* Autobind on cloned rpc clients is discouraged */
290 BUG_ON(clnt
->cl_parent
!= clnt
);
292 if (xprt_test_and_set_binding(xprt
)) {
293 status
= -EAGAIN
; /* tell caller to check again */
294 dprintk("RPC: %5u %s: waiting for another binder\n",
295 task
->tk_pid
, __FUNCTION__
);
299 /* Put self on queue before sending rpcbind request, in case
300 * rpcb_getport_done completes before we return from rpc_run_task */
301 rpc_sleep_on(&xprt
->binding
, task
, NULL
, NULL
);
303 /* Someone else may have bound if we slept */
304 if (xprt_bound(xprt
)) {
306 dprintk("RPC: %5u %s: already bound\n",
307 task
->tk_pid
, __FUNCTION__
);
311 salen
= rpc_peeraddr(clnt
, sap
, sizeof(addr
));
313 /* Don't ever use rpcbind v2 for AF_INET6 requests */
314 switch (sap
->sa_family
) {
316 info
= rpcb_next_version
;
319 info
= rpcb_next_version6
;
322 status
= -EAFNOSUPPORT
;
323 dprintk("RPC: %5u %s: bad address family\n",
324 task
->tk_pid
, __FUNCTION__
);
327 if (info
[xprt
->bind_index
].rpc_proc
== NULL
) {
328 xprt
->bind_index
= 0;
329 status
= -EPFNOSUPPORT
;
330 dprintk("RPC: %5u %s: no more getport versions available\n",
331 task
->tk_pid
, __FUNCTION__
);
334 bind_version
= info
[xprt
->bind_index
].rpc_vers
;
336 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
337 task
->tk_pid
, __FUNCTION__
, bind_version
);
339 rpcb_clnt
= rpcb_create(clnt
->cl_server
, sap
, salen
, xprt
->prot
,
341 if (IS_ERR(rpcb_clnt
)) {
342 status
= PTR_ERR(rpcb_clnt
);
343 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
344 task
->tk_pid
, __FUNCTION__
, PTR_ERR(rpcb_clnt
));
348 map
= kzalloc(sizeof(struct rpcbind_args
), GFP_ATOMIC
);
351 dprintk("RPC: %5u %s: no memory available\n",
352 task
->tk_pid
, __FUNCTION__
);
355 map
->r_prog
= clnt
->cl_prog
;
356 map
->r_vers
= clnt
->cl_vers
;
357 map
->r_prot
= xprt
->prot
;
359 map
->r_xprt
= xprt_get(xprt
);
360 map
->r_netid
= rpc_peeraddr2str(clnt
, RPC_DISPLAY_NETID
);
361 map
->r_addr
= rpc_peeraddr2str(rpcb_clnt
, RPC_DISPLAY_UNIVERSAL_ADDR
);
362 map
->r_owner
= RPCB_OWNER_STRING
; /* ignored for GETADDR */
364 child
= rpcb_call_async(rpcb_clnt
, map
, xprt
->bind_index
);
365 rpc_release_client(rpcb_clnt
);
368 dprintk("RPC: %5u %s: rpc_run_task failed\n",
369 task
->tk_pid
, __FUNCTION__
);
374 task
->tk_xprt
->stat
.bind_count
++;
381 rpcb_wake_rpcbind_waiters(xprt
, status
);
383 task
->tk_status
= status
;
385 EXPORT_SYMBOL_GPL(rpcb_getport_async
);
388 * Rpcbind child task calls this callback via tk_exit.
390 static void rpcb_getport_done(struct rpc_task
*child
, void *data
)
392 struct rpcbind_args
*map
= data
;
393 struct rpc_xprt
*xprt
= map
->r_xprt
;
394 int status
= child
->tk_status
;
396 /* Garbage reply: retry with a lesser rpcbind version */
398 status
= -EPROTONOSUPPORT
;
400 /* rpcbind server doesn't support this rpcbind protocol version */
401 if (status
== -EPROTONOSUPPORT
)
405 /* rpcbind server not available on remote host? */
406 xprt
->ops
->set_port(xprt
, 0);
407 } else if (map
->r_port
== 0) {
408 /* Requested RPC service wasn't registered on remote host */
409 xprt
->ops
->set_port(xprt
, 0);
413 xprt
->ops
->set_port(xprt
, map
->r_port
);
414 xprt_set_bound(xprt
);
418 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
419 child
->tk_pid
, status
, map
->r_port
);
421 rpcb_wake_rpcbind_waiters(xprt
, status
);
424 static int rpcb_encode_mapping(struct rpc_rqst
*req
, __be32
*p
,
425 struct rpcbind_args
*rpcb
)
427 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
428 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_prot
, rpcb
->r_port
);
429 *p
++ = htonl(rpcb
->r_prog
);
430 *p
++ = htonl(rpcb
->r_vers
);
431 *p
++ = htonl(rpcb
->r_prot
);
432 *p
++ = htonl(rpcb
->r_port
);
434 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
438 static int rpcb_decode_getport(struct rpc_rqst
*req
, __be32
*p
,
439 unsigned short *portp
)
441 *portp
= (unsigned short) ntohl(*p
++);
442 dprintk("RPC: rpcb_decode_getport result %u\n",
447 static int rpcb_decode_set(struct rpc_rqst
*req
, __be32
*p
,
450 *boolp
= (unsigned int) ntohl(*p
++);
451 dprintk("RPC: rpcb_decode_set result %u\n",
456 static int rpcb_encode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
457 struct rpcbind_args
*rpcb
)
459 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
460 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_addr
);
461 *p
++ = htonl(rpcb
->r_prog
);
462 *p
++ = htonl(rpcb
->r_vers
);
464 p
= xdr_encode_string(p
, rpcb
->r_netid
);
465 p
= xdr_encode_string(p
, rpcb
->r_addr
);
466 p
= xdr_encode_string(p
, rpcb
->r_owner
);
468 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
473 static int rpcb_decode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
474 unsigned short *portp
)
478 int c
, i
, f
, first
, val
;
481 addr_len
= ntohl(*p
++);
484 * Simple sanity check. The smallest possible universal
485 * address is an IPv4 address string containing 11 bytes.
487 if (addr_len
< 11 || addr_len
> RPCBIND_MAXUADDRLEN
)
491 * Start at the end and walk backwards until the first dot
492 * is encountered. When the second dot is found, we have
493 * both parts of the port number.
499 for (i
= addr_len
- 1; i
> 0; i
--) {
501 if (c
>= '0' && c
<= '9') {
502 val
+= (c
- '0') * f
;
504 } else if (c
== '.') {
510 *portp
|= (val
<< 8);
517 * Simple sanity check. If we never saw a dot in the reply,
518 * then this was probably just garbage.
523 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp
);
527 dprintk("RPC: rpcbind server returned malformed reply\n");
531 #define RPCB_program_sz (1u)
532 #define RPCB_version_sz (1u)
533 #define RPCB_protocol_sz (1u)
534 #define RPCB_port_sz (1u)
535 #define RPCB_boolean_sz (1u)
537 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
538 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
539 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
541 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
542 RPCB_protocol_sz+RPCB_port_sz
543 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
544 RPCB_netid_sz+RPCB_addr_sz+ \
547 #define RPCB_setres_sz RPCB_boolean_sz
548 #define RPCB_getportres_sz RPCB_port_sz
551 * Note that RFC 1833 does not put any size restrictions on the
552 * address string returned by the remote rpcbind database.
554 #define RPCB_getaddrres_sz RPCB_addr_sz
556 #define PROC(proc, argtype, restype) \
557 [RPCBPROC_##proc] = { \
558 .p_proc = RPCBPROC_##proc, \
559 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
560 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
561 .p_arglen = RPCB_##argtype##args_sz, \
562 .p_replen = RPCB_##restype##res_sz, \
563 .p_statidx = RPCBPROC_##proc, \
569 * Not all rpcbind procedures described in RFC 1833 are implemented
570 * since the Linux kernel RPC code requires only these.
572 static struct rpc_procinfo rpcb_procedures2
[] = {
573 PROC(SET
, mapping
, set
),
574 PROC(UNSET
, mapping
, set
),
575 PROC(GETADDR
, mapping
, getport
),
578 static struct rpc_procinfo rpcb_procedures3
[] = {
579 PROC(SET
, mapping
, set
),
580 PROC(UNSET
, mapping
, set
),
581 PROC(GETADDR
, getaddr
, getaddr
),
584 static struct rpc_procinfo rpcb_procedures4
[] = {
585 PROC(SET
, mapping
, set
),
586 PROC(UNSET
, mapping
, set
),
587 PROC(GETVERSADDR
, getaddr
, getaddr
),
590 static struct rpcb_info rpcb_next_version
[] = {
591 #ifdef CONFIG_SUNRPC_BIND34
592 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
593 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
595 { 2, &rpcb_procedures2
[RPCBPROC_GETPORT
] },
599 static struct rpcb_info rpcb_next_version6
[] = {
600 #ifdef CONFIG_SUNRPC_BIND34
601 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
602 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
607 static struct rpc_version rpcb_version2
= {
609 .nrprocs
= RPCB_HIGHPROC_2
,
610 .procs
= rpcb_procedures2
613 static struct rpc_version rpcb_version3
= {
615 .nrprocs
= RPCB_HIGHPROC_3
,
616 .procs
= rpcb_procedures3
619 static struct rpc_version rpcb_version4
= {
621 .nrprocs
= RPCB_HIGHPROC_4
,
622 .procs
= rpcb_procedures4
625 static struct rpc_version
*rpcb_version
[] = {
633 static struct rpc_stat rpcb_stats
;
635 static struct rpc_program rpcb_program
= {
637 .number
= RPCBIND_PROGRAM
,
638 .nrvers
= ARRAY_SIZE(rpcb_version
),
639 .version
= rpcb_version
,
640 .stats
= &rpcb_stats
,