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)
35 #define RPCBVERS_2 (2u)
36 #define RPCBVERS_3 (3u)
37 #define RPCBVERS_4 (4u)
44 RPCBPROC_GETADDR
= 3, /* alias for GETPORT */
47 RPCBPROC_BCAST
= 5, /* alias for CALLIT */
57 #define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
58 #define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
59 #define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
64 * The "owner" is allowed to unset a service in the rpcbind database.
65 * We always use the following (arbitrary) fixed string.
67 #define RPCB_OWNER_STRING "rpcb"
68 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
70 static void rpcb_getport_done(struct rpc_task
*, void *);
71 static struct rpc_program rpcb_program
;
74 struct rpc_xprt
* r_xprt
;
79 unsigned short r_port
;
85 static struct rpc_procinfo rpcb_procedures2
[];
86 static struct rpc_procinfo rpcb_procedures3
[];
90 struct rpc_procinfo
* rpc_proc
;
93 static struct rpcb_info rpcb_next_version
[];
94 static struct rpcb_info rpcb_next_version6
[];
96 static void rpcb_map_release(void *data
)
98 struct rpcbind_args
*map
= data
;
100 xprt_put(map
->r_xprt
);
104 static const struct rpc_call_ops rpcb_getport_ops
= {
105 .rpc_call_done
= rpcb_getport_done
,
106 .rpc_release
= rpcb_map_release
,
109 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt
*xprt
, int status
)
111 xprt_clear_binding(xprt
);
112 rpc_wake_up_status(&xprt
->binding
, status
);
115 static struct rpc_clnt
*rpcb_create(char *hostname
, struct sockaddr
*srvaddr
,
116 size_t salen
, int proto
, u32 version
,
119 struct rpc_create_args args
= {
123 .servername
= hostname
,
124 .program
= &rpcb_program
,
126 .authflavor
= RPC_AUTH_UNIX
,
127 .flags
= RPC_CLNT_CREATE_NOPING
,
130 switch (srvaddr
->sa_family
) {
132 ((struct sockaddr_in
*)srvaddr
)->sin_port
= htons(RPCBIND_PORT
);
135 ((struct sockaddr_in6
*)srvaddr
)->sin6_port
= htons(RPCBIND_PORT
);
142 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
143 return rpc_create(&args
);
147 * rpcb_register - set or unset a port registration with the local rpcbind svc
148 * @prog: RPC program number to bind
149 * @vers: RPC version number to bind
150 * @prot: transport protocol to use to make this request
151 * @port: port value to register
154 * port == 0 means unregister, port != 0 means register.
156 * This routine supports only rpcbind version 2.
158 int rpcb_register(u32 prog
, u32 vers
, int prot
, unsigned short port
, int *okay
)
160 struct sockaddr_in sin
= {
161 .sin_family
= AF_INET
,
162 .sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
),
164 struct rpcbind_args map
= {
170 struct rpc_message msg
= {
171 .rpc_proc
= &rpcb_procedures2
[port
?
172 RPCBPROC_SET
: RPCBPROC_UNSET
],
176 struct rpc_clnt
*rpcb_clnt
;
179 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
180 "rpcbind\n", (port
? "" : "un"),
181 prog
, vers
, prot
, port
);
183 rpcb_clnt
= rpcb_create("localhost", (struct sockaddr
*) &sin
,
184 sizeof(sin
), XPRT_TRANSPORT_UDP
, RPCBVERS_2
, 1);
185 if (IS_ERR(rpcb_clnt
))
186 return PTR_ERR(rpcb_clnt
);
188 error
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
190 rpc_shutdown_client(rpcb_clnt
);
192 printk(KERN_WARNING
"RPC: failed to contact local rpcbind "
193 "server (errno %d).\n", -error
);
194 dprintk("RPC: registration status %d/%d\n", error
, *okay
);
200 * rpcb_getport_sync - obtain the port for an RPC service on a given host
201 * @sin: address of remote peer
202 * @prog: RPC program number to bind
203 * @vers: RPC version number to bind
204 * @prot: transport protocol to use to make this request
206 * Return value is the requested advertised port number,
207 * or a negative errno value.
209 * Called from outside the RPC client in a synchronous task context.
210 * Uses default timeout parameters specified by underlying transport.
212 * XXX: Needs to support IPv6
214 int rpcb_getport_sync(struct sockaddr_in
*sin
, u32 prog
, u32 vers
, int prot
)
216 struct rpcbind_args map
= {
222 struct rpc_message msg
= {
223 .rpc_proc
= &rpcb_procedures2
[RPCBPROC_GETPORT
],
225 .rpc_resp
= &map
.r_port
,
227 struct rpc_clnt
*rpcb_clnt
;
230 dprintk("RPC: %s(" NIPQUAD_FMT
", %u, %u, %d)\n",
231 __func__
, NIPQUAD(sin
->sin_addr
.s_addr
), prog
, vers
, prot
);
233 rpcb_clnt
= rpcb_create(NULL
, (struct sockaddr
*)sin
,
234 sizeof(*sin
), prot
, RPCBVERS_2
, 0);
235 if (IS_ERR(rpcb_clnt
))
236 return PTR_ERR(rpcb_clnt
);
238 status
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
239 rpc_shutdown_client(rpcb_clnt
);
248 EXPORT_SYMBOL_GPL(rpcb_getport_sync
);
250 static struct rpc_task
*rpcb_call_async(struct rpc_clnt
*rpcb_clnt
, struct rpcbind_args
*map
, struct rpc_procinfo
*proc
)
252 struct rpc_message msg
= {
255 .rpc_resp
= &map
->r_port
,
257 struct rpc_task_setup task_setup_data
= {
258 .rpc_client
= rpcb_clnt
,
260 .callback_ops
= &rpcb_getport_ops
,
261 .callback_data
= map
,
262 .flags
= RPC_TASK_ASYNC
,
265 return rpc_run_task(&task_setup_data
);
269 * rpcb_getport_async - obtain the port for a given RPC service on a given host
270 * @task: task that is waiting for portmapper request
272 * This one can be called for an ongoing RPC request, and can be used in
273 * an async (rpciod) context.
275 void rpcb_getport_async(struct rpc_task
*task
)
277 struct rpc_clnt
*clnt
= task
->tk_client
;
278 struct rpc_procinfo
*proc
;
280 struct rpc_xprt
*xprt
= task
->tk_xprt
;
281 struct rpc_clnt
*rpcb_clnt
;
282 static struct rpcbind_args
*map
;
283 struct rpc_task
*child
;
284 struct sockaddr_storage addr
;
285 struct sockaddr
*sap
= (struct sockaddr
*)&addr
;
289 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
290 task
->tk_pid
, __func__
,
291 clnt
->cl_server
, clnt
->cl_prog
, clnt
->cl_vers
, xprt
->prot
);
293 /* Autobind on cloned rpc clients is discouraged */
294 BUG_ON(clnt
->cl_parent
!= clnt
);
296 if (xprt_test_and_set_binding(xprt
)) {
297 status
= -EAGAIN
; /* tell caller to check again */
298 dprintk("RPC: %5u %s: waiting for another binder\n",
299 task
->tk_pid
, __func__
);
303 /* Put self on queue before sending rpcbind request, in case
304 * rpcb_getport_done completes before we return from rpc_run_task */
305 rpc_sleep_on(&xprt
->binding
, task
, NULL
);
307 /* Someone else may have bound if we slept */
308 if (xprt_bound(xprt
)) {
310 dprintk("RPC: %5u %s: already bound\n",
311 task
->tk_pid
, __func__
);
315 salen
= rpc_peeraddr(clnt
, sap
, sizeof(addr
));
317 /* Don't ever use rpcbind v2 for AF_INET6 requests */
318 switch (sap
->sa_family
) {
320 proc
= rpcb_next_version
[xprt
->bind_index
].rpc_proc
;
321 bind_version
= rpcb_next_version
[xprt
->bind_index
].rpc_vers
;
324 proc
= rpcb_next_version6
[xprt
->bind_index
].rpc_proc
;
325 bind_version
= rpcb_next_version6
[xprt
->bind_index
].rpc_vers
;
328 status
= -EAFNOSUPPORT
;
329 dprintk("RPC: %5u %s: bad address family\n",
330 task
->tk_pid
, __func__
);
334 xprt
->bind_index
= 0;
335 status
= -EPFNOSUPPORT
;
336 dprintk("RPC: %5u %s: no more getport versions available\n",
337 task
->tk_pid
, __func__
);
341 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
342 task
->tk_pid
, __func__
, bind_version
);
344 rpcb_clnt
= rpcb_create(clnt
->cl_server
, sap
, salen
, xprt
->prot
,
346 if (IS_ERR(rpcb_clnt
)) {
347 status
= PTR_ERR(rpcb_clnt
);
348 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
349 task
->tk_pid
, __func__
, PTR_ERR(rpcb_clnt
));
353 map
= kzalloc(sizeof(struct rpcbind_args
), GFP_ATOMIC
);
356 dprintk("RPC: %5u %s: no memory available\n",
357 task
->tk_pid
, __func__
);
360 map
->r_prog
= clnt
->cl_prog
;
361 map
->r_vers
= clnt
->cl_vers
;
362 map
->r_prot
= xprt
->prot
;
364 map
->r_xprt
= xprt_get(xprt
);
365 map
->r_netid
= rpc_peeraddr2str(clnt
, RPC_DISPLAY_NETID
);
366 map
->r_addr
= rpc_peeraddr2str(rpcb_clnt
, RPC_DISPLAY_UNIVERSAL_ADDR
);
367 map
->r_owner
= RPCB_OWNER_STRING
; /* ignored for GETADDR */
369 child
= rpcb_call_async(rpcb_clnt
, map
, proc
);
370 rpc_release_client(rpcb_clnt
);
373 /* rpcb_map_release() has freed the arguments */
374 dprintk("RPC: %5u %s: rpc_run_task failed\n",
375 task
->tk_pid
, __func__
);
380 task
->tk_xprt
->stat
.bind_count
++;
384 rpcb_wake_rpcbind_waiters(xprt
, status
);
386 task
->tk_status
= status
;
388 EXPORT_SYMBOL_GPL(rpcb_getport_async
);
391 * Rpcbind child task calls this callback via tk_exit.
393 static void rpcb_getport_done(struct rpc_task
*child
, void *data
)
395 struct rpcbind_args
*map
= data
;
396 struct rpc_xprt
*xprt
= map
->r_xprt
;
397 int status
= child
->tk_status
;
399 /* Garbage reply: retry with a lesser rpcbind version */
401 status
= -EPROTONOSUPPORT
;
403 /* rpcbind server doesn't support this rpcbind protocol version */
404 if (status
== -EPROTONOSUPPORT
)
408 /* rpcbind server not available on remote host? */
409 xprt
->ops
->set_port(xprt
, 0);
410 } else if (map
->r_port
== 0) {
411 /* Requested RPC service wasn't registered on remote host */
412 xprt
->ops
->set_port(xprt
, 0);
416 xprt
->ops
->set_port(xprt
, map
->r_port
);
417 xprt_set_bound(xprt
);
421 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
422 child
->tk_pid
, status
, map
->r_port
);
424 rpcb_wake_rpcbind_waiters(xprt
, status
);
427 static int rpcb_encode_mapping(struct rpc_rqst
*req
, __be32
*p
,
428 struct rpcbind_args
*rpcb
)
430 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
431 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_prot
, rpcb
->r_port
);
432 *p
++ = htonl(rpcb
->r_prog
);
433 *p
++ = htonl(rpcb
->r_vers
);
434 *p
++ = htonl(rpcb
->r_prot
);
435 *p
++ = htonl(rpcb
->r_port
);
437 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
441 static int rpcb_decode_getport(struct rpc_rqst
*req
, __be32
*p
,
442 unsigned short *portp
)
444 *portp
= (unsigned short) ntohl(*p
++);
445 dprintk("RPC: rpcb_decode_getport result %u\n",
450 static int rpcb_decode_set(struct rpc_rqst
*req
, __be32
*p
,
453 *boolp
= (unsigned int) ntohl(*p
++);
454 dprintk("RPC: rpcb_decode_set: call %s\n",
455 (*boolp
? "succeeded" : "failed"));
459 static int rpcb_encode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
460 struct rpcbind_args
*rpcb
)
462 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
463 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_addr
);
464 *p
++ = htonl(rpcb
->r_prog
);
465 *p
++ = htonl(rpcb
->r_vers
);
467 p
= xdr_encode_string(p
, rpcb
->r_netid
);
468 p
= xdr_encode_string(p
, rpcb
->r_addr
);
469 p
= xdr_encode_string(p
, rpcb
->r_owner
);
471 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
476 static int rpcb_decode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
477 unsigned short *portp
)
481 int c
, i
, f
, first
, val
;
484 addr_len
= ntohl(*p
++);
487 * Simple sanity check. The smallest possible universal
488 * address is an IPv4 address string containing 11 bytes.
490 if (addr_len
< 11 || addr_len
> RPCBIND_MAXUADDRLEN
)
494 * Start at the end and walk backwards until the first dot
495 * is encountered. When the second dot is found, we have
496 * both parts of the port number.
502 for (i
= addr_len
- 1; i
> 0; i
--) {
504 if (c
>= '0' && c
<= '9') {
505 val
+= (c
- '0') * f
;
507 } else if (c
== '.') {
513 *portp
|= (val
<< 8);
520 * Simple sanity check. If we never saw a dot in the reply,
521 * then this was probably just garbage.
526 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp
);
530 dprintk("RPC: rpcbind server returned malformed reply\n");
534 #define RPCB_program_sz (1u)
535 #define RPCB_version_sz (1u)
536 #define RPCB_protocol_sz (1u)
537 #define RPCB_port_sz (1u)
538 #define RPCB_boolean_sz (1u)
540 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
541 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
542 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
544 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
545 RPCB_protocol_sz+RPCB_port_sz
546 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
547 RPCB_netid_sz+RPCB_addr_sz+ \
550 #define RPCB_setres_sz RPCB_boolean_sz
551 #define RPCB_getportres_sz RPCB_port_sz
554 * Note that RFC 1833 does not put any size restrictions on the
555 * address string returned by the remote rpcbind database.
557 #define RPCB_getaddrres_sz RPCB_addr_sz
559 #define PROC(proc, argtype, restype) \
560 [RPCBPROC_##proc] = { \
561 .p_proc = RPCBPROC_##proc, \
562 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
563 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
564 .p_arglen = RPCB_##argtype##args_sz, \
565 .p_replen = RPCB_##restype##res_sz, \
566 .p_statidx = RPCBPROC_##proc, \
572 * Not all rpcbind procedures described in RFC 1833 are implemented
573 * since the Linux kernel RPC code requires only these.
575 static struct rpc_procinfo rpcb_procedures2
[] = {
576 PROC(SET
, mapping
, set
),
577 PROC(UNSET
, mapping
, set
),
578 PROC(GETADDR
, mapping
, getport
),
581 static struct rpc_procinfo rpcb_procedures3
[] = {
582 PROC(SET
, mapping
, set
),
583 PROC(UNSET
, mapping
, set
),
584 PROC(GETADDR
, getaddr
, getaddr
),
587 static struct rpc_procinfo rpcb_procedures4
[] = {
588 PROC(SET
, mapping
, set
),
589 PROC(UNSET
, mapping
, set
),
590 PROC(GETVERSADDR
, getaddr
, getaddr
),
593 static struct rpcb_info rpcb_next_version
[] = {
594 #ifdef CONFIG_SUNRPC_BIND34
596 .rpc_vers
= RPCBVERS_4
,
597 .rpc_proc
= &rpcb_procedures4
[RPCBPROC_GETVERSADDR
],
600 .rpc_vers
= RPCBVERS_3
,
601 .rpc_proc
= &rpcb_procedures3
[RPCBPROC_GETADDR
],
605 .rpc_vers
= RPCBVERS_2
,
606 .rpc_proc
= &rpcb_procedures2
[RPCBPROC_GETPORT
],
613 static struct rpcb_info rpcb_next_version6
[] = {
614 #ifdef CONFIG_SUNRPC_BIND34
616 .rpc_vers
= RPCBVERS_4
,
617 .rpc_proc
= &rpcb_procedures4
[RPCBPROC_GETVERSADDR
],
620 .rpc_vers
= RPCBVERS_3
,
621 .rpc_proc
= &rpcb_procedures3
[RPCBPROC_GETADDR
],
629 static struct rpc_version rpcb_version2
= {
630 .number
= RPCBVERS_2
,
631 .nrprocs
= RPCB_HIGHPROC_2
,
632 .procs
= rpcb_procedures2
635 static struct rpc_version rpcb_version3
= {
636 .number
= RPCBVERS_3
,
637 .nrprocs
= RPCB_HIGHPROC_3
,
638 .procs
= rpcb_procedures3
641 static struct rpc_version rpcb_version4
= {
642 .number
= RPCBVERS_4
,
643 .nrprocs
= RPCB_HIGHPROC_4
,
644 .procs
= rpcb_procedures4
647 static struct rpc_version
*rpcb_version
[] = {
655 static struct rpc_stat rpcb_stats
;
657 static struct rpc_program rpcb_program
= {
659 .number
= RPCBIND_PROGRAM
,
660 .nrvers
= ARRAY_SIZE(rpcb_version
),
661 .version
= rpcb_version
,
662 .stats
= &rpcb_stats
,