xref: /netbsd-src/lib/libc/rpc/rpc_soc.c (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1 /*	$NetBSD: rpc_soc.c,v 1.23 2015/11/13 15:23:17 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 2010, Oracle America, Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  *       copyright notice, this list of conditions and the following
14  *       disclaimer in the documentation and/or other materials
15  *       provided with the distribution.
16  *     * Neither the name of the "Oracle America, Inc." nor the names of its
17  *       contributors may be used to endorse or promote products derived
18  *       from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27  *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30  *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /* #ident	"@(#)rpc_soc.c	1.17	94/04/24 SMI" */
35 
36 /*
37  * Copyright (c) 1986-1991 by Sun Microsystems Inc.
38  * In addition, portions of such source code were derived from Berkeley
39  * 4.3 BSD under license from the Regents of the University of
40  * California.
41  */
42 
43 #include <sys/cdefs.h>
44 #if defined(LIBC_SCCS) && !defined(lint)
45 #if 0
46 static char sccsid[] = "@(#)rpc_soc.c 1.41 89/05/02 Copyr 1988 Sun Micro";
47 #else
48 __RCSID("$NetBSD: rpc_soc.c,v 1.23 2015/11/13 15:23:17 christos Exp $");
49 #endif
50 #endif
51 
52 #ifdef PORTMAP
53 /*
54  * rpc_soc.c
55  *
56  * The backward compatibility routines for the earlier implementation
57  * of RPC, where the only transports supported were tcp/ip and udp/ip.
58  * Based on berkeley socket abstraction, now implemented on the top
59  * of TLI/Streams
60  */
61 
62 #include "namespace.h"
63 #include "reentrant.h"
64 #include <sys/types.h>
65 #include <sys/socket.h>
66 #include <stdio.h>
67 #include <rpc/rpc.h>
68 #include <rpc/pmap_clnt.h>
69 #include <rpc/pmap_prot.h>
70 #include <rpc/nettype.h>
71 #include <netinet/in.h>
72 #include <assert.h>
73 #include <errno.h>
74 #include <netdb.h>
75 #include <stdlib.h>
76 #include <string.h>
77 #include <syslog.h>
78 #include <unistd.h>
79 
80 #include "svc_fdset.h"
81 #include "rpc_internal.h"
82 
83 #ifdef __weak_alias
84 __weak_alias(clntudp_bufcreate,_clntudp_bufcreate)
85 __weak_alias(clntudp_create,_clntudp_create)
86 __weak_alias(clnttcp_create,_clnttcp_create)
87 __weak_alias(clntraw_create,_clntraw_create)
88 __weak_alias(get_myaddress,_get_myaddress)
89 __weak_alias(svcfd_create,_svcfd_create)
90 __weak_alias(svcudp_bufcreate,_svcudp_bufcreate)
91 __weak_alias(svcudp_create,_svcudp_create)
92 __weak_alias(svctcp_create,_svctcp_create)
93 __weak_alias(svcraw_create,_svcraw_create)
94 __weak_alias(callrpc,_callrpc)
95 __weak_alias(registerrpc,_registerrpc)
96 __weak_alias(clnt_broadcast,_clnt_broadcast)
97 #endif
98 
99 #ifdef _REENTRANT
100 extern mutex_t	rpcsoc_lock;
101 #endif
102 
103 static CLIENT *clnt_com_create(struct sockaddr_in *, rpcprog_t, rpcvers_t,
104 				    int *, u_int, u_int, const char *);
105 static SVCXPRT *svc_com_create(int, u_int, u_int, const char *);
106 static bool_t rpc_wrap_bcast(char *, struct netbuf *, struct netconfig *);
107 
108 /*
109  * A common clnt create routine
110  */
111 static CLIENT *
112 clnt_com_create(struct sockaddr_in *raddr, rpcprog_t prog, rpcvers_t vers,
113 	int *sockp, u_int sendsz, u_int recvsz, const char *tp)
114 {
115 	CLIENT *cl;
116 	int madefd = FALSE;
117 	int fd;
118 	struct netconfig *nconf;
119 	struct netbuf bindaddr;
120 
121 	_DIAGASSERT(raddr != NULL);
122 	_DIAGASSERT(sockp != NULL);
123 	_DIAGASSERT(tp != NULL);
124 
125 	fd = *sockp;
126 
127 	mutex_lock(&rpcsoc_lock);
128 	if ((nconf = __rpc_getconfip(tp)) == NULL) {
129 		rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
130 		mutex_unlock(&rpcsoc_lock);
131 		return (NULL);
132 	}
133 	if (fd == RPC_ANYSOCK) {
134 		fd = __rpc_nconf2fd(nconf);
135 		if (fd == -1)
136 			goto syserror;
137 		madefd = TRUE;
138 	}
139 
140 	if (raddr->sin_port == 0) {
141 		u_int proto;
142 		u_short sport;
143 
144 		mutex_unlock(&rpcsoc_lock);	/* pmap_getport is recursive */
145 		proto = strcmp(tp, "udp") == 0 ? IPPROTO_UDP : IPPROTO_TCP;
146 		sport = pmap_getport(raddr, (u_long)prog, (u_long)vers,
147 		    proto);
148 		if (sport == 0) {
149 			goto err;
150 		}
151 		raddr->sin_port = htons(sport);
152 		mutex_lock(&rpcsoc_lock);	/* pmap_getport is recursive */
153 	}
154 
155 	/* Transform sockaddr_in to netbuf */
156 	bindaddr.maxlen = bindaddr.len =  sizeof (struct sockaddr_in);
157 	bindaddr.buf = raddr;
158 
159 	(void)bindresvport(fd, NULL);
160 	cl = clnt_tli_create(fd, nconf, &bindaddr, prog, vers,
161 				sendsz, recvsz);
162 	if (cl) {
163 		if (madefd == TRUE) {
164 			/*
165 			 * The fd should be closed while destroying the handle.
166 			 */
167 			(void) CLNT_CONTROL(cl, CLSET_FD_CLOSE, NULL);
168 			*sockp = fd;
169 		}
170 		(void) freenetconfigent(nconf);
171 		mutex_unlock(&rpcsoc_lock);
172 		return (cl);
173 	}
174 	goto err;
175 
176 syserror:
177 	rpc_createerr.cf_stat = RPC_SYSTEMERROR;
178 	rpc_createerr.cf_error.re_errno = errno;
179 
180 err:	if (madefd == TRUE)
181 		(void) close(fd);
182 	(void) freenetconfigent(nconf);
183 	mutex_unlock(&rpcsoc_lock);
184 	return (NULL);
185 }
186 
187 CLIENT *
188 clntudp_bufcreate(struct sockaddr_in *raddr, u_long prog, u_long vers, struct timeval wait, int *sockp, u_int sendsz, u_int recvsz)
189 {
190 	CLIENT *cl;
191 
192 	_DIAGASSERT(raddr != NULL);
193 	_DIAGASSERT(sockp != NULL);
194 
195 	cl = clnt_com_create(raddr, (rpcprog_t)prog, (rpcvers_t)vers, sockp,
196 	    sendsz, recvsz, "udp");
197 	if (cl == NULL) {
198 		return (NULL);
199 	}
200 	(void) CLNT_CONTROL(cl, CLSET_RETRY_TIMEOUT, (char *)(void *)&wait);
201 	return (cl);
202 }
203 
204 CLIENT *
205 clntudp_create(struct sockaddr_in *raddr, u_long program, u_long version,
206     struct timeval wait, int *sockp)
207 {
208 	return clntudp_bufcreate(raddr, program, version, wait, sockp,
209 					UDPMSGSIZE, UDPMSGSIZE);
210 }
211 
212 CLIENT *
213 clnttcp_create(struct sockaddr_in *raddr, u_long prog, u_long vers, int *sockp,
214     u_int sendsz, u_int recvsz)
215 {
216 	return clnt_com_create(raddr, (rpcprog_t)prog, (rpcvers_t)vers, sockp,
217 	    sendsz, recvsz, "tcp");
218 }
219 
220 CLIENT *
221 clntraw_create(u_long prog, u_long vers)
222 {
223 	return clnt_raw_create((rpcprog_t)prog, (rpcvers_t)vers);
224 }
225 
226 /*
227  * A common server create routine
228  */
229 static SVCXPRT *
230 svc_com_create(int fd, u_int sendsize, u_int recvsize, const char *netid)
231 {
232 	struct netconfig *nconf;
233 	SVCXPRT *svc;
234 	int madefd = FALSE;
235 	int port;
236 	struct sockaddr_in sccsin;
237 
238 	_DIAGASSERT(netid != NULL);
239 
240 	if ((nconf = __rpc_getconfip(netid)) == NULL) {
241 		(void) syslog(LOG_ERR, "Could not get %s transport", netid);
242 		return (NULL);
243 	}
244 	if (fd == RPC_ANYSOCK) {
245 		fd = __rpc_nconf2fd(nconf);
246 		if (fd == -1) {
247 			(void) freenetconfigent(nconf);
248 			(void) syslog(LOG_ERR,
249 			"svc%s_create: could not open connection", netid);
250 			return (NULL);
251 		}
252 		madefd = TRUE;
253 	}
254 
255 	memset(&sccsin, 0, sizeof sccsin);
256 	sccsin.sin_family = AF_INET;
257 	(void)bindresvport(fd, &sccsin);
258 
259 	switch (nconf->nc_semantics) {
260 	case NC_TPI_COTS:
261 	case NC_TPI_COTS_ORD:
262 		if (listen(fd, SOMAXCONN) == -1) {
263 			(void) syslog(LOG_ERR,
264 			    "svc%s_create: listen(2) failed: %s",
265 			    netid, strerror(errno));
266 			(void) freenetconfigent(nconf);
267 			goto out;
268 		}
269 		break;
270 	default:
271 		break;
272 	}
273 
274 	svc = svc_tli_create(fd, nconf, NULL, sendsize, recvsize);
275 	(void) freenetconfigent(nconf);
276 	if (svc == NULL)
277 		goto out;
278 	port = (((struct sockaddr_in *)svc->xp_ltaddr.buf)->sin_port);
279 	svc->xp_port = ntohs(port);
280 	return svc;
281 out:
282 	if (madefd)
283 		(void) close(fd);
284 	return NULL;
285 }
286 
287 SVCXPRT *
288 svctcp_create(int fd, u_int sendsize, u_int recvsize)
289 {
290 	return svc_com_create(fd, sendsize, recvsize, "tcp");
291 }
292 
293 SVCXPRT *
294 svcudp_bufcreate(int fd, u_int sendsz, u_int recvsz)
295 {
296 	return svc_com_create(fd, sendsz, recvsz, "udp");
297 }
298 
299 SVCXPRT *
300 svcfd_create(int fd, u_int sendsize, u_int recvsize)
301 {
302 	return svc_fd_create(fd, sendsize, recvsize);
303 }
304 
305 
306 SVCXPRT *
307 svcudp_create(int fd)
308 {
309 	return svc_com_create(fd, UDPMSGSIZE, UDPMSGSIZE, "udp");
310 }
311 
312 SVCXPRT *
313 svcraw_create(void)
314 {
315 	return svc_raw_create();
316 }
317 
318 int
319 get_myaddress(struct sockaddr_in *addr)
320 {
321 
322 	_DIAGASSERT(addr != NULL);
323 
324 	memset((void *) addr, 0, sizeof(*addr));
325 	addr->sin_family = AF_INET;
326 	addr->sin_port = htons(PMAPPORT);
327 	addr->sin_addr.s_addr = htonl(INADDR_LOOPBACK);
328 	return (0);
329 }
330 
331 /*
332  * For connectionless "udp" transport. Obsoleted by rpc_call().
333  */
334 int
335 callrpc(char *host, int prognum, int versnum, int procnum,
336 	xdrproc_t inproc, char *in, xdrproc_t outproc, char *out)
337 {
338 	return (int)rpc_call(host, (rpcprog_t)prognum, (rpcvers_t)versnum,
339 	    (rpcproc_t)procnum, inproc, in, outproc, out, "udp");
340 }
341 
342 /*
343  * For connectionless kind of transport. Obsoleted by rpc_reg()
344  */
345 int
346 registerrpc(int prognum, int versnum, int procnum,
347 	char *(*progname)(char [UDPMSGSIZE]),
348 	xdrproc_t inproc, xdrproc_t outproc)
349 {
350 	return rpc_reg((rpcprog_t)prognum, (rpcvers_t)versnum,
351 	    (rpcproc_t)procnum, progname, inproc, outproc, __UNCONST("udp"));
352 }
353 
354 /*
355  * All the following clnt_broadcast stuff is convulated; it supports
356  * the earlier calling style of the callback function
357  */
358 #ifdef _REENTRANT
359 static thread_key_t	clnt_broadcast_key;
360 #endif
361 static resultproc_t	clnt_broadcast_result_main;
362 
363 /*
364  * Need to translate the netbuf address into sockaddr_in address.
365  * Dont care about netid here.
366  */
367 /* ARGSUSED */
368 static bool_t
369 rpc_wrap_bcast(
370 	char *resultp,		/* results of the call */
371 	struct netbuf *addr,	/* address of the guy who responded */
372 	struct netconfig *nconf) /* Netconf of the transport */
373 {
374 	resultproc_t clnt_broadcast_result;
375 
376 	_DIAGASSERT(resultp != NULL);
377 	_DIAGASSERT(addr != NULL);
378 	_DIAGASSERT(nconf != NULL);
379 
380 	if (strcmp(nconf->nc_netid, "udp"))
381 		return (FALSE);
382 #ifdef _REENTRANT
383 	if (__isthreaded == 0)
384 		clnt_broadcast_result = clnt_broadcast_result_main;
385 	else
386 		clnt_broadcast_result = thr_getspecific(clnt_broadcast_key);
387 #else
388 	clnt_broadcast_result = clnt_broadcast_result_main;
389 #endif
390 	return (*clnt_broadcast_result)(resultp,
391 				(struct sockaddr_in *)addr->buf);
392 }
393 
394 #ifdef _REENTRANT
395 static once_t clnt_broadcast_once = ONCE_INITIALIZER;
396 
397 static void
398 clnt_broadcast_setup(void)
399 {
400 
401 	thr_keycreate(&clnt_broadcast_key, free);
402 }
403 #endif
404 
405 /*
406  * Broadcasts on UDP transport. Obsoleted by rpc_broadcast().
407  */
408 enum clnt_stat
409 clnt_broadcast(
410 	u_long		prog,		/* program number */
411 	u_long		vers,		/* version number */
412 	u_long		proc,		/* procedure number */
413 	xdrproc_t	xargs,		/* xdr routine for args */
414 	caddr_t		argsp,		/* pointer to args */
415 	xdrproc_t	xresults,	/* xdr routine for results */
416 	caddr_t		resultsp,	/* pointer to results */
417 	resultproc_t	eachresult)	/* call with each result obtained */
418 {
419 #ifdef _REENTRANT
420 	if (__isthreaded == 0)
421 		clnt_broadcast_result_main = eachresult;
422 	else {
423 		thr_once(&clnt_broadcast_once, clnt_broadcast_setup);
424 		thr_setspecific(clnt_broadcast_key, (void *) eachresult);
425 	}
426 #else
427 	clnt_broadcast_result_main = eachresult;
428 #endif
429 	return rpc_broadcast((rpcprog_t)prog, (rpcvers_t)vers,
430 	    (rpcproc_t)proc, xargs, argsp, xresults, resultsp,
431 	    (resultproc_t) rpc_wrap_bcast, "udp");
432 }
433 
434 #endif /* PORTMAP */
435