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/types.h>
16 #include <linux/socket.h>
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
20 #include <linux/sunrpc/clnt.h>
21 #include <linux/sunrpc/sched.h>
24 # define RPCDBG_FACILITY RPCDBG_BIND
27 #define RPCBIND_PROGRAM (100000u)
28 #define RPCBIND_PORT (111u)
35 RPCBPROC_GETADDR
= 3, /* alias for GETPORT */
38 RPCBPROC_BCAST
= 5, /* alias for CALLIT */
48 #define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
49 #define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
50 #define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
55 * Quoting RFC 3530, section 2.2:
57 * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the
62 * The prefix, "h1.h2.h3.h4", is the standard textual form for
63 * representing an IPv4 address, which is always four octets long.
64 * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively,
65 * the first through fourth octets each converted to ASCII-decimal.
66 * Assuming big-endian ordering, p1 and p2 are, respectively, the first
67 * and second octets each converted to ASCII-decimal. For example, if a
68 * host, in big-endian order, has an address of 0x0A010307 and there is
69 * a service listening on, in big endian order, port 0x020F (decimal
70 * 527), then the complete universal address is "10.1.3.7.2.15".
74 * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the
77 * x1:x2:x3:x4:x5:x6:x7:x8.p1.p2
79 * The suffix "p1.p2" is the service port, and is computed the same way
80 * as with universal addresses for TCP and UDP over IPv4. The prefix,
81 * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for
82 * representing an IPv6 address as defined in Section 2.2 of [RFC2373].
83 * Additionally, the two alternative forms specified in Section 2.2 of
84 * [RFC2373] are also acceptable.
86 * XXX: Currently this implementation does not explicitly convert the
87 * stored address to US-ASCII on non-ASCII systems.
89 #define RPCB_MAXADDRLEN (128u)
94 * Quoting RFC 3530, section 2.2:
96 * For TCP over IPv4 the value of r_netid is the string "tcp". For UDP
97 * over IPv4 the value of r_netid is the string "udp".
101 * For TCP over IPv6 the value of r_netid is the string "tcp6". For UDP
102 * over IPv6 the value of r_netid is the string "udp6".
104 #define RPCB_NETID_UDP "\165\144\160" /* "udp" */
105 #define RPCB_NETID_TCP "\164\143\160" /* "tcp" */
106 #define RPCB_NETID_UDP6 "\165\144\160\066" /* "udp6" */
107 #define RPCB_NETID_TCP6 "\164\143\160\066" /* "tcp6" */
109 #define RPCB_MAXNETIDLEN (4u)
114 * The "owner" is allowed to unset a service in the rpcbind database.
115 * We always use the following (arbitrary) fixed string.
117 #define RPCB_OWNER_STRING "rpcb"
118 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
120 static void rpcb_getport_done(struct rpc_task
*, void *);
121 extern struct rpc_program rpcb_program
;
123 struct rpcbind_args
{
124 struct rpc_xprt
* r_xprt
;
129 unsigned short r_port
;
131 char r_addr
[RPCB_MAXADDRLEN
];
135 static struct rpc_procinfo rpcb_procedures2
[];
136 static struct rpc_procinfo rpcb_procedures3
[];
138 static struct rpcb_info
{
140 struct rpc_procinfo
* rpc_proc
;
141 } rpcb_next_version
[];
143 static void rpcb_getport_prepare(struct rpc_task
*task
, void *calldata
)
145 struct rpcbind_args
*map
= calldata
;
146 struct rpc_xprt
*xprt
= map
->r_xprt
;
147 struct rpc_message msg
= {
148 .rpc_proc
= rpcb_next_version
[xprt
->bind_index
].rpc_proc
,
150 .rpc_resp
= &map
->r_port
,
153 rpc_call_setup(task
, &msg
, 0);
156 static void rpcb_map_release(void *data
)
158 struct rpcbind_args
*map
= data
;
160 xprt_put(map
->r_xprt
);
164 static const struct rpc_call_ops rpcb_getport_ops
= {
165 .rpc_call_prepare
= rpcb_getport_prepare
,
166 .rpc_call_done
= rpcb_getport_done
,
167 .rpc_release
= rpcb_map_release
,
170 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt
*xprt
, int status
)
172 xprt_clear_binding(xprt
);
173 rpc_wake_up_status(&xprt
->binding
, status
);
176 static struct rpc_clnt
*rpcb_create(char *hostname
, struct sockaddr
*srvaddr
,
177 int proto
, int version
, int privileged
)
179 struct rpc_create_args args
= {
182 .addrsize
= sizeof(struct sockaddr_in
),
183 .servername
= hostname
,
184 .program
= &rpcb_program
,
186 .authflavor
= RPC_AUTH_UNIX
,
187 .flags
= RPC_CLNT_CREATE_NOPING
,
190 ((struct sockaddr_in
*)srvaddr
)->sin_port
= htons(RPCBIND_PORT
);
192 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
193 return rpc_create(&args
);
197 * rpcb_register - set or unset a port registration with the local rpcbind svc
198 * @prog: RPC program number to bind
199 * @vers: RPC version number to bind
200 * @prot: transport protocol to use to make this request
201 * @port: port value to register
204 * port == 0 means unregister, port != 0 means register.
206 * This routine supports only rpcbind version 2.
208 int rpcb_register(u32 prog
, u32 vers
, int prot
, unsigned short port
, int *okay
)
210 struct sockaddr_in sin
= {
211 .sin_family
= AF_INET
,
212 .sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
),
214 struct rpcbind_args map
= {
220 struct rpc_message msg
= {
221 .rpc_proc
= &rpcb_procedures2
[port
?
222 RPCBPROC_SET
: RPCBPROC_UNSET
],
226 struct rpc_clnt
*rpcb_clnt
;
229 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
230 "rpcbind\n", (port
? "" : "un"),
231 prog
, vers
, prot
, port
);
233 rpcb_clnt
= rpcb_create("localhost", (struct sockaddr
*) &sin
,
235 if (IS_ERR(rpcb_clnt
))
236 return PTR_ERR(rpcb_clnt
);
238 error
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
240 rpc_shutdown_client(rpcb_clnt
);
242 printk(KERN_WARNING
"RPC: failed to contact local rpcbind "
243 "server (errno %d).\n", -error
);
244 dprintk("RPC: registration status %d/%d\n", error
, *okay
);
249 #ifdef CONFIG_ROOT_NFS
251 * rpcb_getport_external - obtain the port for an RPC service on a given host
252 * @sin: address of remote peer
253 * @prog: RPC program number to bind
254 * @vers: RPC version number to bind
255 * @prot: transport protocol to use to make this request
257 * Called from outside the RPC client in a synchronous task context.
259 * For now, this supports only version 2 queries, but is used only by
260 * mount_clnt for NFS_ROOT.
262 int rpcb_getport_external(struct sockaddr_in
*sin
, __u32 prog
,
263 __u32 vers
, int prot
)
265 struct rpcbind_args map
= {
271 struct rpc_message msg
= {
272 .rpc_proc
= &rpcb_procedures2
[RPCBPROC_GETPORT
],
274 .rpc_resp
= &map
.r_port
,
276 struct rpc_clnt
*rpcb_clnt
;
280 dprintk("RPC: rpcb_getport_external(%u.%u.%u.%u, %u, %u, %d)\n",
281 NIPQUAD(sin
->sin_addr
.s_addr
), prog
, vers
, prot
);
283 sprintf(hostname
, "%u.%u.%u.%u", NIPQUAD(sin
->sin_addr
.s_addr
));
284 rpcb_clnt
= rpcb_create(hostname
, (struct sockaddr
*)sin
, prot
, 2, 0);
285 if (IS_ERR(rpcb_clnt
))
286 return PTR_ERR(rpcb_clnt
);
288 status
= rpc_call_sync(rpcb_clnt
, &msg
, 0);
289 rpc_shutdown_client(rpcb_clnt
);
301 * rpcb_getport - obtain the port for a given RPC service on a given host
302 * @task: task that is waiting for portmapper request
304 * This one can be called for an ongoing RPC request, and can be used in
305 * an async (rpciod) context.
307 void rpcb_getport(struct rpc_task
*task
)
309 struct rpc_clnt
*clnt
= task
->tk_client
;
311 struct rpc_xprt
*xprt
= task
->tk_xprt
;
312 struct rpc_clnt
*rpcb_clnt
;
313 static struct rpcbind_args
*map
;
314 struct rpc_task
*child
;
315 struct sockaddr addr
;
318 dprintk("RPC: %5u rpcb_getport(%s, %u, %u, %d)\n",
319 task
->tk_pid
, clnt
->cl_server
,
320 clnt
->cl_prog
, clnt
->cl_vers
, xprt
->prot
);
322 /* Autobind on cloned rpc clients is discouraged */
323 BUG_ON(clnt
->cl_parent
!= clnt
);
325 if (xprt_test_and_set_binding(xprt
)) {
326 status
= -EACCES
; /* tell caller to check again */
327 dprintk("RPC: %5u rpcb_getport waiting for another binder\n",
332 /* Put self on queue before sending rpcbind request, in case
333 * rpcb_getport_done completes before we return from rpc_run_task */
334 rpc_sleep_on(&xprt
->binding
, task
, NULL
, NULL
);
336 /* Someone else may have bound if we slept */
337 if (xprt_bound(xprt
)) {
339 dprintk("RPC: %5u rpcb_getport already bound\n", task
->tk_pid
);
343 if (rpcb_next_version
[xprt
->bind_index
].rpc_proc
== NULL
) {
344 xprt
->bind_index
= 0;
345 status
= -EACCES
; /* tell caller to try again later */
346 dprintk("RPC: %5u rpcb_getport no more getport versions "
347 "available\n", task
->tk_pid
);
350 bind_version
= rpcb_next_version
[xprt
->bind_index
].rpc_vers
;
352 dprintk("RPC: %5u rpcb_getport trying rpcbind version %u\n",
353 task
->tk_pid
, bind_version
);
355 map
= kzalloc(sizeof(struct rpcbind_args
), GFP_ATOMIC
);
358 dprintk("RPC: %5u rpcb_getport no memory available\n",
362 map
->r_prog
= clnt
->cl_prog
;
363 map
->r_vers
= clnt
->cl_vers
;
364 map
->r_prot
= xprt
->prot
;
366 map
->r_xprt
= xprt_get(xprt
);
367 map
->r_netid
= (xprt
->prot
== IPPROTO_TCP
) ? RPCB_NETID_TCP
:
369 memcpy(&map
->r_addr
, rpc_peeraddr2str(clnt
, RPC_DISPLAY_ADDR
),
370 sizeof(map
->r_addr
));
371 map
->r_owner
= RPCB_OWNER_STRING
; /* ignored for GETADDR */
373 rpc_peeraddr(clnt
, (void *)&addr
, sizeof(addr
));
374 rpcb_clnt
= rpcb_create(clnt
->cl_server
, &addr
, xprt
->prot
, bind_version
, 0);
375 if (IS_ERR(rpcb_clnt
)) {
376 status
= PTR_ERR(rpcb_clnt
);
377 dprintk("RPC: %5u rpcb_getport rpcb_create failed, error %ld\n",
378 task
->tk_pid
, PTR_ERR(rpcb_clnt
));
382 child
= rpc_run_task(rpcb_clnt
, RPC_TASK_ASYNC
, &rpcb_getport_ops
, map
);
383 rpc_release_client(rpcb_clnt
);
386 dprintk("RPC: %5u rpcb_getport rpc_run_task failed\n",
392 task
->tk_xprt
->stat
.bind_count
++;
399 rpcb_wake_rpcbind_waiters(xprt
, status
);
401 task
->tk_status
= status
;
405 * Rpcbind child task calls this callback via tk_exit.
407 static void rpcb_getport_done(struct rpc_task
*child
, void *data
)
409 struct rpcbind_args
*map
= data
;
410 struct rpc_xprt
*xprt
= map
->r_xprt
;
411 int status
= child
->tk_status
;
413 /* rpcbind server doesn't support this rpcbind protocol version */
414 if (status
== -EPROTONOSUPPORT
)
418 /* rpcbind server not available on remote host? */
419 xprt
->ops
->set_port(xprt
, 0);
420 } else if (map
->r_port
== 0) {
421 /* Requested RPC service wasn't registered on remote host */
422 xprt
->ops
->set_port(xprt
, 0);
426 xprt
->ops
->set_port(xprt
, map
->r_port
);
427 xprt_set_bound(xprt
);
431 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
432 child
->tk_pid
, status
, map
->r_port
);
434 rpcb_wake_rpcbind_waiters(xprt
, status
);
437 static int rpcb_encode_mapping(struct rpc_rqst
*req
, __be32
*p
,
438 struct rpcbind_args
*rpcb
)
440 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
441 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_prot
, rpcb
->r_port
);
442 *p
++ = htonl(rpcb
->r_prog
);
443 *p
++ = htonl(rpcb
->r_vers
);
444 *p
++ = htonl(rpcb
->r_prot
);
445 *p
++ = htonl(rpcb
->r_port
);
447 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
451 static int rpcb_decode_getport(struct rpc_rqst
*req
, __be32
*p
,
452 unsigned short *portp
)
454 *portp
= (unsigned short) ntohl(*p
++);
455 dprintk("RPC: rpcb_decode_getport result %u\n",
460 static int rpcb_decode_set(struct rpc_rqst
*req
, __be32
*p
,
463 *boolp
= (unsigned int) ntohl(*p
++);
464 dprintk("RPC: rpcb_decode_set result %u\n",
469 static int rpcb_encode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
470 struct rpcbind_args
*rpcb
)
472 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
473 rpcb
->r_prog
, rpcb
->r_vers
, rpcb
->r_addr
);
474 *p
++ = htonl(rpcb
->r_prog
);
475 *p
++ = htonl(rpcb
->r_vers
);
477 p
= xdr_encode_string(p
, rpcb
->r_netid
);
478 p
= xdr_encode_string(p
, rpcb
->r_addr
);
479 p
= xdr_encode_string(p
, rpcb
->r_owner
);
481 req
->rq_slen
= xdr_adjust_iovec(req
->rq_svec
, p
);
486 static int rpcb_decode_getaddr(struct rpc_rqst
*req
, __be32
*p
,
487 unsigned short *portp
)
490 int addr_len
, c
, i
, f
, first
, val
;
493 addr_len
= (unsigned int) ntohl(*p
++);
494 if (addr_len
> RPCB_MAXADDRLEN
) /* sanity */
497 dprintk("RPC: rpcb_decode_getaddr returned string: '%s'\n",
504 for (i
= addr_len
- 1; i
> 0; i
--) {
506 if (c
>= '0' && c
<= '9') {
507 val
+= (c
- '0') * f
;
509 } else if (c
== '.') {
515 *portp
|= (val
<< 8);
521 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp
);
525 #define RPCB_program_sz (1u)
526 #define RPCB_version_sz (1u)
527 #define RPCB_protocol_sz (1u)
528 #define RPCB_port_sz (1u)
529 #define RPCB_boolean_sz (1u)
531 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCB_MAXNETIDLEN))
532 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCB_MAXADDRLEN))
533 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
535 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
536 RPCB_protocol_sz+RPCB_port_sz
537 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
538 RPCB_netid_sz+RPCB_addr_sz+ \
541 #define RPCB_setres_sz RPCB_boolean_sz
542 #define RPCB_getportres_sz RPCB_port_sz
545 * Note that RFC 1833 does not put any size restrictions on the
546 * address string returned by the remote rpcbind database.
548 #define RPCB_getaddrres_sz RPCB_addr_sz
550 #define PROC(proc, argtype, restype) \
551 [RPCBPROC_##proc] = { \
552 .p_proc = RPCBPROC_##proc, \
553 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
554 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
555 .p_arglen = RPCB_##argtype##args_sz, \
556 .p_replen = RPCB_##restype##res_sz, \
557 .p_statidx = RPCBPROC_##proc, \
563 * Not all rpcbind procedures described in RFC 1833 are implemented
564 * since the Linux kernel RPC code requires only these.
566 static struct rpc_procinfo rpcb_procedures2
[] = {
567 PROC(SET
, mapping
, set
),
568 PROC(UNSET
, mapping
, set
),
569 PROC(GETADDR
, mapping
, getport
),
572 static struct rpc_procinfo rpcb_procedures3
[] = {
573 PROC(SET
, mapping
, set
),
574 PROC(UNSET
, mapping
, set
),
575 PROC(GETADDR
, getaddr
, getaddr
),
578 static struct rpc_procinfo rpcb_procedures4
[] = {
579 PROC(SET
, mapping
, set
),
580 PROC(UNSET
, mapping
, set
),
581 PROC(GETVERSADDR
, getaddr
, getaddr
),
584 static struct rpcb_info rpcb_next_version
[] = {
585 #ifdef CONFIG_SUNRPC_BIND34
586 { 4, &rpcb_procedures4
[RPCBPROC_GETVERSADDR
] },
587 { 3, &rpcb_procedures3
[RPCBPROC_GETADDR
] },
589 { 2, &rpcb_procedures2
[RPCBPROC_GETPORT
] },
593 static struct rpc_version rpcb_version2
= {
595 .nrprocs
= RPCB_HIGHPROC_2
,
596 .procs
= rpcb_procedures2
599 static struct rpc_version rpcb_version3
= {
601 .nrprocs
= RPCB_HIGHPROC_3
,
602 .procs
= rpcb_procedures3
605 static struct rpc_version rpcb_version4
= {
607 .nrprocs
= RPCB_HIGHPROC_4
,
608 .procs
= rpcb_procedures4
611 static struct rpc_version
*rpcb_version
[] = {
619 static struct rpc_stat rpcb_stats
;
621 struct rpc_program rpcb_program
= {
623 .number
= RPCBIND_PROGRAM
,
624 .nrvers
= ARRAY_SIZE(rpcb_version
),
625 .version
= rpcb_version
,
626 .stats
= &rpcb_stats
,