SUNRPC: Use appropriate argument types in rpcb client
[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / net / sunrpc / rpcb_clnt.c
1 /*
2 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
3 * protocol
4 *
5 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
6 * RFC 3530: "Network File System (NFS) version 4 Protocol"
7 *
8 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
9 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
10 *
11 * Descended from net/sunrpc/pmap_clnt.c,
12 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
13 */
14
15 #include <linux/module.h>
16
17 #include <linux/types.h>
18 #include <linux/socket.h>
19 #include <linux/in.h>
20 #include <linux/in6.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23
24 #include <linux/sunrpc/clnt.h>
25 #include <linux/sunrpc/sched.h>
26 #include <linux/sunrpc/xprtsock.h>
27
28 #ifdef RPC_DEBUG
29 # define RPCDBG_FACILITY RPCDBG_BIND
30 #endif
31
32 #define RPCBIND_PROGRAM (100000u)
33 #define RPCBIND_PORT (111u)
34
35 enum {
36 RPCBPROC_NULL,
37 RPCBPROC_SET,
38 RPCBPROC_UNSET,
39 RPCBPROC_GETPORT,
40 RPCBPROC_GETADDR = 3, /* alias for GETPORT */
41 RPCBPROC_DUMP,
42 RPCBPROC_CALLIT,
43 RPCBPROC_BCAST = 5, /* alias for CALLIT */
44 RPCBPROC_GETTIME,
45 RPCBPROC_UADDR2TADDR,
46 RPCBPROC_TADDR2UADDR,
47 RPCBPROC_GETVERSADDR,
48 RPCBPROC_INDIRECT,
49 RPCBPROC_GETADDRLIST,
50 RPCBPROC_GETSTAT,
51 };
52
53 #define RPCB_HIGHPROC_2 RPCBPROC_CALLIT
54 #define RPCB_HIGHPROC_3 RPCBPROC_TADDR2UADDR
55 #define RPCB_HIGHPROC_4 RPCBPROC_GETSTAT
56
57 /*
58 * r_owner
59 *
60 * The "owner" is allowed to unset a service in the rpcbind database.
61 * We always use the following (arbitrary) fixed string.
62 */
63 #define RPCB_OWNER_STRING "rpcb"
64 #define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
65
66 static void rpcb_getport_done(struct rpc_task *, void *);
67 static struct rpc_program rpcb_program;
68
69 struct rpcbind_args {
70 struct rpc_xprt * r_xprt;
71
72 u32 r_prog;
73 u32 r_vers;
74 u32 r_prot;
75 unsigned short r_port;
76 const char * r_netid;
77 const char * r_addr;
78 const char * r_owner;
79 };
80
81 static struct rpc_procinfo rpcb_procedures2[];
82 static struct rpc_procinfo rpcb_procedures3[];
83
84 struct rpcb_info {
85 int rpc_vers;
86 struct rpc_procinfo * rpc_proc;
87 };
88
89 static struct rpcb_info rpcb_next_version[];
90 static struct rpcb_info rpcb_next_version6[];
91
92 static void rpcb_map_release(void *data)
93 {
94 struct rpcbind_args *map = data;
95
96 xprt_put(map->r_xprt);
97 kfree(map);
98 }
99
100 static const struct rpc_call_ops rpcb_getport_ops = {
101 .rpc_call_done = rpcb_getport_done,
102 .rpc_release = rpcb_map_release,
103 };
104
105 static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
106 {
107 xprt_clear_binding(xprt);
108 rpc_wake_up_status(&xprt->binding, status);
109 }
110
111 static struct rpc_clnt *rpcb_create(char *hostname, struct sockaddr *srvaddr,
112 size_t salen, int proto, u32 version,
113 int privileged)
114 {
115 struct rpc_create_args args = {
116 .protocol = proto,
117 .address = srvaddr,
118 .addrsize = salen,
119 .servername = hostname,
120 .program = &rpcb_program,
121 .version = version,
122 .authflavor = RPC_AUTH_UNIX,
123 .flags = (RPC_CLNT_CREATE_NOPING |
124 RPC_CLNT_CREATE_INTR),
125 };
126
127 switch (srvaddr->sa_family) {
128 case AF_INET:
129 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
130 break;
131 case AF_INET6:
132 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
133 break;
134 default:
135 return NULL;
136 }
137
138 if (!privileged)
139 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
140 return rpc_create(&args);
141 }
142
143 /**
144 * rpcb_register - set or unset a port registration with the local rpcbind svc
145 * @prog: RPC program number to bind
146 * @vers: RPC version number to bind
147 * @prot: transport protocol to use to make this request
148 * @port: port value to register
149 * @okay: result code
150 *
151 * port == 0 means unregister, port != 0 means register.
152 *
153 * This routine supports only rpcbind version 2.
154 */
155 int rpcb_register(u32 prog, u32 vers, int prot, unsigned short port, int *okay)
156 {
157 struct sockaddr_in sin = {
158 .sin_family = AF_INET,
159 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
160 };
161 struct rpcbind_args map = {
162 .r_prog = prog,
163 .r_vers = vers,
164 .r_prot = prot,
165 .r_port = port,
166 };
167 struct rpc_message msg = {
168 .rpc_proc = &rpcb_procedures2[port ?
169 RPCBPROC_SET : RPCBPROC_UNSET],
170 .rpc_argp = &map,
171 .rpc_resp = okay,
172 };
173 struct rpc_clnt *rpcb_clnt;
174 int error = 0;
175
176 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
177 "rpcbind\n", (port ? "" : "un"),
178 prog, vers, prot, port);
179
180 rpcb_clnt = rpcb_create("localhost", (struct sockaddr *) &sin,
181 sizeof(sin), XPRT_TRANSPORT_UDP, 2, 1);
182 if (IS_ERR(rpcb_clnt))
183 return PTR_ERR(rpcb_clnt);
184
185 error = rpc_call_sync(rpcb_clnt, &msg, 0);
186
187 rpc_shutdown_client(rpcb_clnt);
188 if (error < 0)
189 printk(KERN_WARNING "RPC: failed to contact local rpcbind "
190 "server (errno %d).\n", -error);
191 dprintk("RPC: registration status %d/%d\n", error, *okay);
192
193 return error;
194 }
195
196 /**
197 * rpcb_getport_sync - obtain the port for an RPC service on a given host
198 * @sin: address of remote peer
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 *
203 * Called from outside the RPC client in a synchronous task context.
204 * Uses default timeout parameters specified by underlying transport.
205 *
206 * XXX: Needs to support IPv6, and rpcbind versions 3 and 4
207 */
208 int rpcb_getport_sync(struct sockaddr_in *sin, u32 prog, u32 vers, int prot)
209 {
210 struct rpcbind_args map = {
211 .r_prog = prog,
212 .r_vers = vers,
213 .r_prot = prot,
214 .r_port = 0,
215 };
216 struct rpc_message msg = {
217 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
218 .rpc_argp = &map,
219 .rpc_resp = &map.r_port,
220 };
221 struct rpc_clnt *rpcb_clnt;
222 int status;
223
224 dprintk("RPC: %s(" NIPQUAD_FMT ", %u, %u, %d)\n",
225 __FUNCTION__, NIPQUAD(sin->sin_addr.s_addr), prog, vers, prot);
226
227 rpcb_clnt = rpcb_create(NULL, (struct sockaddr *)sin,
228 sizeof(sin), prot, 2, 0);
229 if (IS_ERR(rpcb_clnt))
230 return PTR_ERR(rpcb_clnt);
231
232 status = rpc_call_sync(rpcb_clnt, &msg, 0);
233 rpc_shutdown_client(rpcb_clnt);
234
235 if (status >= 0) {
236 if (map.r_port != 0)
237 return map.r_port;
238 status = -EACCES;
239 }
240 return status;
241 }
242 EXPORT_SYMBOL_GPL(rpcb_getport_sync);
243
244 static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt, struct rpcbind_args *map, int version)
245 {
246 struct rpc_message msg = {
247 .rpc_proc = rpcb_next_version[version].rpc_proc,
248 .rpc_argp = map,
249 .rpc_resp = &map->r_port,
250 };
251 struct rpc_task_setup task_setup_data = {
252 .rpc_client = rpcb_clnt,
253 .rpc_message = &msg,
254 .callback_ops = &rpcb_getport_ops,
255 .callback_data = map,
256 .flags = RPC_TASK_ASYNC,
257 };
258
259 return rpc_run_task(&task_setup_data);
260 }
261
262 /**
263 * rpcb_getport_async - obtain the port for a given RPC service on a given host
264 * @task: task that is waiting for portmapper request
265 *
266 * This one can be called for an ongoing RPC request, and can be used in
267 * an async (rpciod) context.
268 */
269 void rpcb_getport_async(struct rpc_task *task)
270 {
271 struct rpc_clnt *clnt = task->tk_client;
272 u32 bind_version;
273 struct rpc_xprt *xprt = task->tk_xprt;
274 struct rpc_clnt *rpcb_clnt;
275 static struct rpcbind_args *map;
276 struct rpc_task *child;
277 struct sockaddr_storage addr;
278 struct sockaddr *sap = (struct sockaddr *)&addr;
279 size_t salen;
280 int status;
281 struct rpcb_info *info;
282
283 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
284 task->tk_pid, __FUNCTION__,
285 clnt->cl_server, clnt->cl_prog, clnt->cl_vers, xprt->prot);
286
287 /* Autobind on cloned rpc clients is discouraged */
288 BUG_ON(clnt->cl_parent != clnt);
289
290 if (xprt_test_and_set_binding(xprt)) {
291 status = -EAGAIN; /* tell caller to check again */
292 dprintk("RPC: %5u %s: waiting for another binder\n",
293 task->tk_pid, __FUNCTION__);
294 goto bailout_nowake;
295 }
296
297 /* Put self on queue before sending rpcbind request, in case
298 * rpcb_getport_done completes before we return from rpc_run_task */
299 rpc_sleep_on(&xprt->binding, task, NULL, NULL);
300
301 /* Someone else may have bound if we slept */
302 if (xprt_bound(xprt)) {
303 status = 0;
304 dprintk("RPC: %5u %s: already bound\n",
305 task->tk_pid, __FUNCTION__);
306 goto bailout_nofree;
307 }
308
309 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
310
311 /* Don't ever use rpcbind v2 for AF_INET6 requests */
312 switch (sap->sa_family) {
313 case AF_INET:
314 info = rpcb_next_version;
315 break;
316 case AF_INET6:
317 info = rpcb_next_version6;
318 break;
319 default:
320 status = -EAFNOSUPPORT;
321 dprintk("RPC: %5u %s: bad address family\n",
322 task->tk_pid, __FUNCTION__);
323 goto bailout_nofree;
324 }
325 if (info[xprt->bind_index].rpc_proc == NULL) {
326 xprt->bind_index = 0;
327 status = -EPFNOSUPPORT;
328 dprintk("RPC: %5u %s: no more getport versions available\n",
329 task->tk_pid, __FUNCTION__);
330 goto bailout_nofree;
331 }
332 bind_version = info[xprt->bind_index].rpc_vers;
333
334 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
335 task->tk_pid, __FUNCTION__, bind_version);
336
337 rpcb_clnt = rpcb_create(clnt->cl_server, sap, salen, xprt->prot,
338 bind_version, 0);
339 if (IS_ERR(rpcb_clnt)) {
340 status = PTR_ERR(rpcb_clnt);
341 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
342 task->tk_pid, __FUNCTION__, PTR_ERR(rpcb_clnt));
343 goto bailout_nofree;
344 }
345
346 map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
347 if (!map) {
348 status = -ENOMEM;
349 dprintk("RPC: %5u %s: no memory available\n",
350 task->tk_pid, __FUNCTION__);
351 goto bailout_nofree;
352 }
353 map->r_prog = clnt->cl_prog;
354 map->r_vers = clnt->cl_vers;
355 map->r_prot = xprt->prot;
356 map->r_port = 0;
357 map->r_xprt = xprt_get(xprt);
358 map->r_netid = rpc_peeraddr2str(clnt, RPC_DISPLAY_NETID);
359 map->r_addr = rpc_peeraddr2str(rpcb_clnt, RPC_DISPLAY_UNIVERSAL_ADDR);
360 map->r_owner = RPCB_OWNER_STRING; /* ignored for GETADDR */
361
362 child = rpcb_call_async(rpcb_clnt, map, xprt->bind_index);
363 rpc_release_client(rpcb_clnt);
364 if (IS_ERR(child)) {
365 status = -EIO;
366 dprintk("RPC: %5u %s: rpc_run_task failed\n",
367 task->tk_pid, __FUNCTION__);
368 goto bailout;
369 }
370 rpc_put_task(child);
371
372 task->tk_xprt->stat.bind_count++;
373 return;
374
375 bailout:
376 kfree(map);
377 xprt_put(xprt);
378 bailout_nofree:
379 rpcb_wake_rpcbind_waiters(xprt, status);
380 bailout_nowake:
381 task->tk_status = status;
382 }
383 EXPORT_SYMBOL_GPL(rpcb_getport_async);
384
385 /*
386 * Rpcbind child task calls this callback via tk_exit.
387 */
388 static void rpcb_getport_done(struct rpc_task *child, void *data)
389 {
390 struct rpcbind_args *map = data;
391 struct rpc_xprt *xprt = map->r_xprt;
392 int status = child->tk_status;
393
394 /* Garbage reply: retry with a lesser rpcbind version */
395 if (status == -EIO)
396 status = -EPROTONOSUPPORT;
397
398 /* rpcbind server doesn't support this rpcbind protocol version */
399 if (status == -EPROTONOSUPPORT)
400 xprt->bind_index++;
401
402 if (status < 0) {
403 /* rpcbind server not available on remote host? */
404 xprt->ops->set_port(xprt, 0);
405 } else if (map->r_port == 0) {
406 /* Requested RPC service wasn't registered on remote host */
407 xprt->ops->set_port(xprt, 0);
408 status = -EACCES;
409 } else {
410 /* Succeeded */
411 xprt->ops->set_port(xprt, map->r_port);
412 xprt_set_bound(xprt);
413 status = 0;
414 }
415
416 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
417 child->tk_pid, status, map->r_port);
418
419 rpcb_wake_rpcbind_waiters(xprt, status);
420 }
421
422 static int rpcb_encode_mapping(struct rpc_rqst *req, __be32 *p,
423 struct rpcbind_args *rpcb)
424 {
425 dprintk("RPC: rpcb_encode_mapping(%u, %u, %d, %u)\n",
426 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
427 *p++ = htonl(rpcb->r_prog);
428 *p++ = htonl(rpcb->r_vers);
429 *p++ = htonl(rpcb->r_prot);
430 *p++ = htonl(rpcb->r_port);
431
432 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
433 return 0;
434 }
435
436 static int rpcb_decode_getport(struct rpc_rqst *req, __be32 *p,
437 unsigned short *portp)
438 {
439 *portp = (unsigned short) ntohl(*p++);
440 dprintk("RPC: rpcb_decode_getport result %u\n",
441 *portp);
442 return 0;
443 }
444
445 static int rpcb_decode_set(struct rpc_rqst *req, __be32 *p,
446 unsigned int *boolp)
447 {
448 *boolp = (unsigned int) ntohl(*p++);
449 dprintk("RPC: rpcb_decode_set result %u\n",
450 *boolp);
451 return 0;
452 }
453
454 static int rpcb_encode_getaddr(struct rpc_rqst *req, __be32 *p,
455 struct rpcbind_args *rpcb)
456 {
457 dprintk("RPC: rpcb_encode_getaddr(%u, %u, %s)\n",
458 rpcb->r_prog, rpcb->r_vers, rpcb->r_addr);
459 *p++ = htonl(rpcb->r_prog);
460 *p++ = htonl(rpcb->r_vers);
461
462 p = xdr_encode_string(p, rpcb->r_netid);
463 p = xdr_encode_string(p, rpcb->r_addr);
464 p = xdr_encode_string(p, rpcb->r_owner);
465
466 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
467
468 return 0;
469 }
470
471 static int rpcb_decode_getaddr(struct rpc_rqst *req, __be32 *p,
472 unsigned short *portp)
473 {
474 char *addr;
475 u32 addr_len;
476 int c, i, f, first, val;
477
478 *portp = 0;
479 addr_len = ntohl(*p++);
480
481 /*
482 * Simple sanity check. The smallest possible universal
483 * address is an IPv4 address string containing 11 bytes.
484 */
485 if (addr_len < 11 || addr_len > RPCBIND_MAXUADDRLEN)
486 goto out_err;
487
488 /*
489 * Start at the end and walk backwards until the first dot
490 * is encountered. When the second dot is found, we have
491 * both parts of the port number.
492 */
493 addr = (char *)p;
494 val = 0;
495 first = 1;
496 f = 1;
497 for (i = addr_len - 1; i > 0; i--) {
498 c = addr[i];
499 if (c >= '0' && c <= '9') {
500 val += (c - '0') * f;
501 f *= 10;
502 } else if (c == '.') {
503 if (first) {
504 *portp = val;
505 val = first = 0;
506 f = 1;
507 } else {
508 *portp |= (val << 8);
509 break;
510 }
511 }
512 }
513
514 /*
515 * Simple sanity check. If we never saw a dot in the reply,
516 * then this was probably just garbage.
517 */
518 if (first)
519 goto out_err;
520
521 dprintk("RPC: rpcb_decode_getaddr port=%u\n", *portp);
522 return 0;
523
524 out_err:
525 dprintk("RPC: rpcbind server returned malformed reply\n");
526 return -EIO;
527 }
528
529 #define RPCB_program_sz (1u)
530 #define RPCB_version_sz (1u)
531 #define RPCB_protocol_sz (1u)
532 #define RPCB_port_sz (1u)
533 #define RPCB_boolean_sz (1u)
534
535 #define RPCB_netid_sz (1+XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
536 #define RPCB_addr_sz (1+XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
537 #define RPCB_ownerstring_sz (1+XDR_QUADLEN(RPCB_MAXOWNERLEN))
538
539 #define RPCB_mappingargs_sz RPCB_program_sz+RPCB_version_sz+ \
540 RPCB_protocol_sz+RPCB_port_sz
541 #define RPCB_getaddrargs_sz RPCB_program_sz+RPCB_version_sz+ \
542 RPCB_netid_sz+RPCB_addr_sz+ \
543 RPCB_ownerstring_sz
544
545 #define RPCB_setres_sz RPCB_boolean_sz
546 #define RPCB_getportres_sz RPCB_port_sz
547
548 /*
549 * Note that RFC 1833 does not put any size restrictions on the
550 * address string returned by the remote rpcbind database.
551 */
552 #define RPCB_getaddrres_sz RPCB_addr_sz
553
554 #define PROC(proc, argtype, restype) \
555 [RPCBPROC_##proc] = { \
556 .p_proc = RPCBPROC_##proc, \
557 .p_encode = (kxdrproc_t) rpcb_encode_##argtype, \
558 .p_decode = (kxdrproc_t) rpcb_decode_##restype, \
559 .p_arglen = RPCB_##argtype##args_sz, \
560 .p_replen = RPCB_##restype##res_sz, \
561 .p_statidx = RPCBPROC_##proc, \
562 .p_timer = 0, \
563 .p_name = #proc, \
564 }
565
566 /*
567 * Not all rpcbind procedures described in RFC 1833 are implemented
568 * since the Linux kernel RPC code requires only these.
569 */
570 static struct rpc_procinfo rpcb_procedures2[] = {
571 PROC(SET, mapping, set),
572 PROC(UNSET, mapping, set),
573 PROC(GETADDR, mapping, getport),
574 };
575
576 static struct rpc_procinfo rpcb_procedures3[] = {
577 PROC(SET, mapping, set),
578 PROC(UNSET, mapping, set),
579 PROC(GETADDR, getaddr, getaddr),
580 };
581
582 static struct rpc_procinfo rpcb_procedures4[] = {
583 PROC(SET, mapping, set),
584 PROC(UNSET, mapping, set),
585 PROC(GETVERSADDR, getaddr, getaddr),
586 };
587
588 static struct rpcb_info rpcb_next_version[] = {
589 #ifdef CONFIG_SUNRPC_BIND34
590 { 4, &rpcb_procedures4[RPCBPROC_GETVERSADDR] },
591 { 3, &rpcb_procedures3[RPCBPROC_GETADDR] },
592 #endif
593 { 2, &rpcb_procedures2[RPCBPROC_GETPORT] },
594 { 0, NULL },
595 };
596
597 static struct rpcb_info rpcb_next_version6[] = {
598 #ifdef CONFIG_SUNRPC_BIND34
599 { 4, &rpcb_procedures4[RPCBPROC_GETVERSADDR] },
600 { 3, &rpcb_procedures3[RPCBPROC_GETADDR] },
601 #endif
602 { 0, NULL },
603 };
604
605 static struct rpc_version rpcb_version2 = {
606 .number = 2,
607 .nrprocs = RPCB_HIGHPROC_2,
608 .procs = rpcb_procedures2
609 };
610
611 static struct rpc_version rpcb_version3 = {
612 .number = 3,
613 .nrprocs = RPCB_HIGHPROC_3,
614 .procs = rpcb_procedures3
615 };
616
617 static struct rpc_version rpcb_version4 = {
618 .number = 4,
619 .nrprocs = RPCB_HIGHPROC_4,
620 .procs = rpcb_procedures4
621 };
622
623 static struct rpc_version *rpcb_version[] = {
624 NULL,
625 NULL,
626 &rpcb_version2,
627 &rpcb_version3,
628 &rpcb_version4
629 };
630
631 static struct rpc_stat rpcb_stats;
632
633 static struct rpc_program rpcb_program = {
634 .name = "rpcbind",
635 .number = RPCBIND_PROGRAM,
636 .nrvers = ARRAY_SIZE(rpcb_version),
637 .version = rpcb_version,
638 .stats = &rpcb_stats,
639 };