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 |
188 RPC_CLNT_CREATE_INTR),
191 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
193 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
194 return rpc_create(&args);
198 * rpcb_register - set or unset a port registration with the local rpcbind svc
199 * @prog: RPC program number to bind
200 * @vers: RPC version number to bind
201 * @prot: transport protocol to use to make this request
202 * @port: port value to register
205 * port == 0 means unregister, port != 0 means register.
207 * This routine supports only rpcbind version 2.
209 int rpcb_register(u32 prog, u32 vers, int prot, unsigned short port, int *okay)
211 struct sockaddr_in sin = {
212 .sin_family = AF_INET,
213 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
215 struct rpcbind_args map = {
221 struct rpc_message msg = {
222 .rpc_proc = &rpcb_procedures2[port ?
223 RPCBPROC_SET : RPCBPROC_UNSET],
227 struct rpc_clnt *rpcb_clnt;
230 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
231 "rpcbind\n", (port ? "" : "un"),
232 prog, vers, prot, port);
234 rpcb_clnt = rpcb_create("localhost", (struct sockaddr *) &sin,
236 if (IS_ERR(rpcb_clnt))
237 return PTR_ERR(rpcb_clnt);
239 error = rpc_call_sync(rpcb_clnt, &msg, 0);
241 rpc_shutdown_client(rpcb_clnt);
243 printk(KERN_WARNING "RPC: failed to contact local rpcbind "
244 "server (errno %d).\n", -error);
245 dprintk("RPC: registration status %d/%d\n", error, *okay);
250 #ifdef CONFIG_ROOT_NFS
252 * rpcb_getport_external - obtain the port for an RPC service on a given host
253 * @sin: address of remote peer
254 * @prog: RPC program number to bind
255 * @vers: RPC version number to bind
256 * @prot: transport protocol to use to make this request
258 * Called from outside the RPC client in a synchronous task context.
260 * For now, this supports only version 2 queries, but is used only by
261 * mount_clnt for NFS_ROOT.
263 int rpcb_getport_external(struct sockaddr_in *sin, __u32 prog,
264 __u32 vers, int prot)
266 struct rpcbind_args map = {
272 struct rpc_message msg = {
273 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
275 .rpc_resp = &map.r_port,
277 struct rpc_clnt *rpcb_clnt;
281 dprintk("RPC: rpcb_getport_external(%u.%u.%u.%u, %u, %u, %d)\n",
282 NIPQUAD(sin->sin_addr.s_addr), prog, vers, prot);
284 sprintf(hostname, "%u.%u.%u.%u", NIPQUAD(sin->sin_addr.s_addr));
285 rpcb_clnt = rpcb_create(hostname, (struct sockaddr *)sin, prot, 2, 0);
286 if (IS_ERR(rpcb_clnt))
287 return PTR_ERR(rpcb_clnt);
289 status = rpc_call_sync(rpcb_clnt, &msg, 0);
290 rpc_shutdown_client(rpcb_clnt);
302 * rpcb_getport - obtain the port for a given RPC service on a given host
303 * @task: task that is waiting for portmapper request
305 * This one can be called for an ongoing RPC request, and can be used in
306 * an async (rpciod) context.
308 void rpcb_getport(struct rpc_task *task)
310 struct rpc_clnt *clnt = task->tk_client;
312 struct rpc_xprt *xprt = task->tk_xprt;
313 struct rpc_clnt *rpcb_clnt;
314 static struct rpcbind_args *map;
315 struct rpc_task *child;
316 struct sockaddr addr;
319 dprintk("RPC: %5u rpcb_getport(%s, %u, %u, %d)\n",
320 task->tk_pid, clnt->cl_server,
321 clnt->cl_prog, clnt->cl_vers, xprt->prot);
323 /* Autobind on cloned rpc clients is discouraged */
324 BUG_ON(clnt->cl_parent != clnt);
326 if (xprt_test_and_set_binding(xprt)) {
327 status = -EACCES; /* tell caller to check again */
328 dprintk("RPC: %5u rpcb_getport waiting for another binder\n",
333 /* Put self on queue before sending rpcbind request, in case
334 * rpcb_getport_done completes before we return from rpc_run_task */
335 rpc_sleep_on(&xprt->binding, task, NULL, NULL);
337 /* Someone else may have bound if we slept */
338 if (xprt_bound(xprt)) {
340 dprintk("RPC: %5u rpcb_getport already bound\n", task->tk_pid);
344 if (rpcb_next_version[xprt->bind_index].rpc_proc == NULL) {
345 xprt->bind_index = 0;
346 status = -EACCES; /* tell caller to try again later */
347 dprintk("RPC: %5u rpcb_getport no more getport versions "
348 "available\n", task->tk_pid);
351 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
353 dprintk("RPC: %5u rpcb_getport trying rpcbind version %u\n",
354 task->tk_pid, bind_version);
356 map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
359 dprintk("RPC: %5u rpcb_getport no memory available\n",
363 map->r_prog = clnt->cl_prog;
364 map->r_vers = clnt->cl_vers;
365 map->r_prot = xprt->prot;
367 map->r_xprt = xprt_get(xprt);
368 map->r_netid = (xprt->prot == IPPROTO_TCP) ? RPCB_NETID_TCP :
370 memcpy(&map->r_addr, rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR),
371 sizeof(map->r_addr));
372 map->r_owner = RPCB_OWNER_STRING; /* ignored for GETADDR */
374 rpc_peeraddr(clnt, (void *)&addr, sizeof(addr));
375 rpcb_clnt = rpcb_create(clnt->cl_server, &addr, xprt->prot, bind_version, 0);
376 if (IS_ERR(rpcb_clnt)) {
377 status = PTR_ERR(rpcb_clnt);
378 dprintk("RPC: %5u rpcb_getport rpcb_create failed, error %ld\n",
379 task->tk_pid, PTR_ERR(rpcb_clnt));
383 child = rpc_run_task(rpcb_clnt, RPC_TASK_ASYNC, &rpcb_getport_ops, map);
384 rpc_release_client(rpcb_clnt);
387 dprintk("RPC: %5u rpcb_getport rpc_run_task failed\n",
393 task->tk_xprt->stat.bind_count++;
400 rpcb_wake_rpcbind_waiters(xprt, status);
402 task->tk_status = status;
406 * Rpcbind child task calls this callback via tk_exit.
408 static void rpcb_getport_done(struct rpc_task *child, void *data)
410 struct rpcbind_args *map = data;
411 struct rpc_xprt *xprt = map->r_xprt;
412 int status = child->tk_status;
414 /* rpcbind server doesn't support this rpcbind protocol version */
415 if (status == -EPROTONOSUPPORT)
419 /* rpcbind server not available on remote host? */
420 xprt->ops->set_port(xprt, 0);
421 } else if (map->r_port == 0) {
422 /* Requested RPC service wasn't registered on remote host */
423 xprt->ops->set_port(xprt, 0);
427 xprt->ops->set_port(xprt, map->r_port);
428 xprt_set_bound(xprt);
432 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
433 child->tk_pid, status, map->r_port);
435 rpcb_wake_rpcbind_waiters(xprt, status);
438 static int rpcb_encode_mapping(struct rpc_rqst *req, __be32 *p,
439 struct rpcbind_args *rpcb)
441 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
442 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
443 *p++ = htonl(rpcb->r_prog);
444 *p++ = htonl(rpcb->r_vers);
445 *p++ = htonl(rpcb->r_prot);
446 *p++ = htonl(rpcb->r_port);
448 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
452 static int rpcb_decode_getport(struct rpc_rqst *req, __be32 *p,
453 unsigned short *portp)
455 *portp = (unsigned short) ntohl(*p++);
456 dprintk("RPC: rpcb_decode_getport result %u\n",
461 static int rpcb_decode_set(struct rpc_rqst *req, __be32 *p,
464 *boolp = (unsigned int) ntohl(*p++);
465 dprintk("RPC: rpcb_decode_set result %u\n",
470 static int rpcb_encode_getaddr(struct rpc_rqst *req, __be32 *p,
471 struct rpcbind_args *rpcb)
473 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
474 rpcb->r_prog, rpcb->r_vers, rpcb->r_addr);
475 *p++ = htonl(rpcb->r_prog);
476 *p++ = htonl(rpcb->r_vers);
478 p = xdr_encode_string(p, rpcb->r_netid);
479 p = xdr_encode_string(p, rpcb->r_addr);
480 p = xdr_encode_string(p, rpcb->r_owner);
482 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
487 static int rpcb_decode_getaddr(struct rpc_rqst *req, __be32 *p,
488 unsigned short *portp)
491 int addr_len, c, i, f, first, val;
494 addr_len = (unsigned int) ntohl(*p++);
495 if (addr_len > RPCB_MAXADDRLEN) /* sanity */
498 dprintk("RPC: rpcb_decode_getaddr returned string: '%s'\n",
505 for (i = addr_len - 1; i > 0; i--) {
507 if (c >= '0' && c <= '9') {
508 val += (c - '0') * f;
510 } else if (c == '.') {
516 *portp |= (val << 8);
522 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp);
526 #define RPCB_program_sz (1u)
527 #define RPCB_version_sz (1u)
528 #define RPCB_protocol_sz (1u)
529 #define RPCB_port_sz (1u)
530 #define RPCB_boolean_sz (1u)
532 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCB_MAXNETIDLEN))
533 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCB_MAXADDRLEN))
534 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
536 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
537 RPCB_protocol_sz+RPCB_port_sz
538 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
539 RPCB_netid_sz+RPCB_addr_sz+ \
542 #define RPCB_setres_sz RPCB_boolean_sz
543 #define RPCB_getportres_sz RPCB_port_sz
546 * Note that RFC 1833 does not put any size restrictions on the
547 * address string returned by the remote rpcbind database.
549 #define RPCB_getaddrres_sz RPCB_addr_sz
551 #define PROC(proc, argtype, restype) \
552 [RPCBPROC_##proc] = { \
553 .p_proc = RPCBPROC_##proc, \
554 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
555 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
556 .p_arglen = RPCB_##argtype##args_sz, \
557 .p_replen = RPCB_##restype##res_sz, \
558 .p_statidx = RPCBPROC_##proc, \
564 * Not all rpcbind procedures described in RFC 1833 are implemented
565 * since the Linux kernel RPC code requires only these.
567 static struct rpc_procinfo rpcb_procedures2[] = {
568 PROC(SET, mapping, set),
569 PROC(UNSET, mapping, set),
570 PROC(GETADDR, mapping, getport),
573 static struct rpc_procinfo rpcb_procedures3[] = {
574 PROC(SET, mapping, set),
575 PROC(UNSET, mapping, set),
576 PROC(GETADDR, getaddr, getaddr),
579 static struct rpc_procinfo rpcb_procedures4[] = {
580 PROC(SET, mapping, set),
581 PROC(UNSET, mapping, set),
582 PROC(GETVERSADDR, getaddr, getaddr),
585 static struct rpcb_info rpcb_next_version[] = {
586 #ifdef CONFIG_SUNRPC_BIND34
587 { 4, &rpcb_procedures4[RPCBPROC_GETVERSADDR] },
588 { 3, &rpcb_procedures3[RPCBPROC_GETADDR] },
590 { 2, &rpcb_procedures2[RPCBPROC_GETPORT] },
594 static struct rpc_version rpcb_version2 = {
596 .nrprocs = RPCB_HIGHPROC_2,
597 .procs = rpcb_procedures2
600 static struct rpc_version rpcb_version3 = {
602 .nrprocs = RPCB_HIGHPROC_3,
603 .procs = rpcb_procedures3
606 static struct rpc_version rpcb_version4 = {
608 .nrprocs = RPCB_HIGHPROC_4,
609 .procs = rpcb_procedures4
612 static struct rpc_version *rpcb_version[] = {
620 static struct rpc_stat rpcb_stats;
622 struct rpc_program rpcb_program = {
624 .number = RPCBIND_PROGRAM,
625 .nrvers = ARRAY_SIZE(rpcb_version),
626 .version = rpcb_version,
627 .stats = &rpcb_stats,