xref: /freebsd/lib/libc/rpc/svc_simple.c (revision 7cc42f6d25ef2e19059d088fa7d4853fe9afefb5)
1 /*	$NetBSD: svc_simple.c,v 1.20 2000/07/06 03:10:35 christos Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 2009, Sun Microsystems, Inc.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are met:
11  * - Redistributions of source code must retain the above copyright notice,
12  *   this list of conditions and the following disclaimer.
13  * - Redistributions in binary form must reproduce the above copyright notice,
14  *   this list of conditions and the following disclaimer in the documentation
15  *   and/or other materials provided with the distribution.
16  * - Neither the name of Sun Microsystems, 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 "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*
33  * Copyright (c) 1986-1991 by Sun Microsystems Inc.
34  */
35 
36 /* #pragma ident	"@(#)svc_simple.c	1.18	94/04/24 SMI" */
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39 
40 /*
41  * svc_simple.c
42  * Simplified front end to rpc.
43  */
44 
45 /*
46  * This interface creates a virtual listener for all the services
47  * started through rpc_reg(). It listens on the same endpoint for
48  * all the services and then executes the corresponding service
49  * for the given prognum and procnum.
50  */
51 
52 #include "namespace.h"
53 #include "reentrant.h"
54 #include <sys/types.h>
55 #include <rpc/rpc.h>
56 #include <rpc/nettype.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <err.h>
61 #include "un-namespace.h"
62 
63 #include "rpc_com.h"
64 #include "mt_misc.h"
65 
66 static void universal(struct svc_req *, SVCXPRT *);
67 
68 static struct proglst {
69 	char *(*p_progname)(char *);
70 	rpcprog_t p_prognum;
71 	rpcvers_t p_versnum;
72 	rpcproc_t p_procnum;
73 	SVCXPRT *p_transp;
74 	char *p_netid;
75 	char *p_xdrbuf;
76 	int p_recvsz;
77 	xdrproc_t p_inproc, p_outproc;
78 	struct proglst *p_nxt;
79 } *proglst;
80 
81 static const char rpc_reg_err[] = "%s: %s";
82 static const char rpc_reg_msg[] = "rpc_reg: ";
83 static const char __reg_err1[] = "can't find appropriate transport";
84 static const char __reg_err2[] = "can't get protocol info";
85 static const char __reg_err3[] = "unsupported transport size";
86 static const char __no_mem_str[] = "out of memory";
87 
88 /*
89  * For simplified, easy to use kind of rpc interfaces.
90  * nettype indicates the type of transport on which the service will be
91  * listening. Used for conservation of the system resource. Only one
92  * handle is created for all the services (actually one of each netid)
93  * and same xdrbuf is used for same netid. The size of the arguments
94  * is also limited by the recvsize for that transport, even if it is
95  * a COTS transport. This may be wrong, but for cases like these, they
96  * should not use the simplified interfaces like this.
97  *
98  * prognum - program number
99  * versnum - version number
100  * procnum - procedure number
101  * progname - Server routine
102  * inproc, outproc - in/out XDR procedures
103  * nettype - nettype
104  */
105 int
106 rpc_reg(rpcprog_t prognum, rpcvers_t versnum, rpcproc_t procnum,
107     char *(*progname)(char *), xdrproc_t inproc, xdrproc_t outproc,
108     char *nettype)
109 {
110 	struct netconfig *nconf;
111 	int done = FALSE;
112 	void *handle;
113 
114 
115 	if (procnum == NULLPROC) {
116 		warnx("%s can't reassign procedure number %u", rpc_reg_msg,
117 			NULLPROC);
118 		return (-1);
119 	}
120 
121 	if (nettype == NULL)
122 		nettype = "netpath";		/* The default behavior */
123 	if ((handle = __rpc_setconf(nettype)) == NULL) {
124 		warnx(rpc_reg_err, rpc_reg_msg, __reg_err1);
125 		return (-1);
126 	}
127 /* VARIABLES PROTECTED BY proglst_lock: proglst */
128 	mutex_lock(&proglst_lock);
129 	while ((nconf = __rpc_getconf(handle)) != NULL) {
130 		struct proglst *pl;
131 		SVCXPRT *svcxprt;
132 		int madenow;
133 		u_int recvsz;
134 		char *xdrbuf;
135 		char *netid;
136 
137 		madenow = FALSE;
138 		svcxprt = NULL;
139 		recvsz = 0;
140 		xdrbuf = netid = NULL;
141 		for (pl = proglst; pl; pl = pl->p_nxt) {
142 			if (strcmp(pl->p_netid, nconf->nc_netid) == 0) {
143 				svcxprt = pl->p_transp;
144 				xdrbuf = pl->p_xdrbuf;
145 				recvsz = pl->p_recvsz;
146 				netid = pl->p_netid;
147 				break;
148 			}
149 		}
150 
151 		if (svcxprt == NULL) {
152 			struct __rpc_sockinfo si;
153 
154 			svcxprt = svc_tli_create(RPC_ANYFD, nconf, NULL, 0, 0);
155 			if (svcxprt == NULL)
156 				continue;
157 			if (!__rpc_fd2sockinfo(svcxprt->xp_fd, &si)) {
158 				warnx(rpc_reg_err, rpc_reg_msg, __reg_err2);
159 				SVC_DESTROY(svcxprt);
160 				continue;
161 			}
162 			recvsz = __rpc_get_t_size(si.si_af, si.si_proto, 0);
163 			if (recvsz == 0) {
164 				warnx(rpc_reg_err, rpc_reg_msg, __reg_err3);
165 				SVC_DESTROY(svcxprt);
166 				continue;
167 			}
168 			if (((xdrbuf = malloc((unsigned)recvsz)) == NULL) ||
169 				((netid = strdup(nconf->nc_netid)) == NULL)) {
170 				warnx(rpc_reg_err, rpc_reg_msg, __no_mem_str);
171 				free(xdrbuf);
172 				free(netid);
173 				SVC_DESTROY(svcxprt);
174 				break;
175 			}
176 			madenow = TRUE;
177 		}
178 		/*
179 		 * Check if this (program, version, netid) had already been
180 		 * registered.  The check may save a few RPC calls to rpcbind
181 		 */
182 		for (pl = proglst; pl; pl = pl->p_nxt)
183 			if ((pl->p_prognum == prognum) &&
184 				(pl->p_versnum == versnum) &&
185 				(strcmp(pl->p_netid, netid) == 0))
186 				break;
187 		if (pl == NULL) { /* Not yet */
188 			(void) rpcb_unset(prognum, versnum, nconf);
189 		} else {
190 			/* so that svc_reg does not call rpcb_set() */
191 			nconf = NULL;
192 		}
193 
194 		if (!svc_reg(svcxprt, prognum, versnum, universal, nconf)) {
195 			warnx("%s couldn't register prog %u vers %u for %s",
196 				rpc_reg_msg, (unsigned)prognum,
197 				(unsigned)versnum, netid);
198 			if (madenow) {
199 				SVC_DESTROY(svcxprt);
200 				free(xdrbuf);
201 				free(netid);
202 			}
203 			continue;
204 		}
205 
206 		pl = malloc(sizeof (struct proglst));
207 		if (pl == NULL) {
208 			warnx(rpc_reg_err, rpc_reg_msg, __no_mem_str);
209 			if (madenow) {
210 				SVC_DESTROY(svcxprt);
211 				free(xdrbuf);
212 				free(netid);
213 			}
214 			break;
215 		}
216 		pl->p_progname = progname;
217 		pl->p_prognum = prognum;
218 		pl->p_versnum = versnum;
219 		pl->p_procnum = procnum;
220 		pl->p_inproc = inproc;
221 		pl->p_outproc = outproc;
222 		pl->p_transp = svcxprt;
223 		pl->p_xdrbuf = xdrbuf;
224 		pl->p_recvsz = recvsz;
225 		pl->p_netid = netid;
226 		pl->p_nxt = proglst;
227 		proglst = pl;
228 		done = TRUE;
229 	}
230 	__rpc_endconf(handle);
231 	mutex_unlock(&proglst_lock);
232 
233 	if (done == FALSE) {
234 		warnx("%s can't find suitable transport for %s",
235 			rpc_reg_msg, nettype);
236 		return (-1);
237 	}
238 	return (0);
239 }
240 
241 /*
242  * The universal handler for the services registered using registerrpc.
243  * It handles both the connectionless and the connection oriented cases.
244  */
245 
246 static void
247 universal(struct svc_req *rqstp, SVCXPRT *transp)
248 {
249 	rpcprog_t prog;
250 	rpcvers_t vers;
251 	rpcproc_t proc;
252 	char *outdata;
253 	char *xdrbuf;
254 	struct proglst *pl;
255 
256 	/*
257 	 * enforce "procnum 0 is echo" convention
258 	 */
259 	if (rqstp->rq_proc == NULLPROC) {
260 		if (svc_sendreply(transp, (xdrproc_t) xdr_void, NULL) ==
261 		    FALSE) {
262 			warnx("svc_sendreply failed");
263 		}
264 		return;
265 	}
266 	prog = rqstp->rq_prog;
267 	vers = rqstp->rq_vers;
268 	proc = rqstp->rq_proc;
269 	mutex_lock(&proglst_lock);
270 	for (pl = proglst; pl; pl = pl->p_nxt)
271 		if (pl->p_prognum == prog && pl->p_procnum == proc &&
272 			pl->p_versnum == vers &&
273 			(strcmp(pl->p_netid, transp->xp_netid) == 0)) {
274 			/* decode arguments into a CLEAN buffer */
275 			xdrbuf = pl->p_xdrbuf;
276 			/* Zero the arguments: reqd ! */
277 			(void) memset(xdrbuf, 0, (size_t)pl->p_recvsz);
278 			/*
279 			 * Assuming that sizeof (xdrbuf) would be enough
280 			 * for the arguments; if not then the program
281 			 * may bomb. BEWARE!
282 			 */
283 			if (!svc_getargs(transp, pl->p_inproc, xdrbuf)) {
284 				svcerr_decode(transp);
285 				mutex_unlock(&proglst_lock);
286 				return;
287 			}
288 			outdata = (*(pl->p_progname))(xdrbuf);
289 			if (outdata == NULL &&
290 				pl->p_outproc != (xdrproc_t) xdr_void){
291 				/* there was an error */
292 				mutex_unlock(&proglst_lock);
293 				return;
294 			}
295 			if (!svc_sendreply(transp, pl->p_outproc, outdata)) {
296 				warnx(
297 			"rpc: rpc_reg trouble replying to prog %u vers %u",
298 				(unsigned)prog, (unsigned)vers);
299 				mutex_unlock(&proglst_lock);
300 				return;
301 			}
302 			/* free the decoded arguments */
303 			(void)svc_freeargs(transp, pl->p_inproc, xdrbuf);
304 			mutex_unlock(&proglst_lock);
305 			return;
306 		}
307 	mutex_unlock(&proglst_lock);
308 	/* This should never happen */
309 	warnx("rpc: rpc_reg: never registered prog %u vers %u",
310 		(unsigned)prog, (unsigned)vers);
311 	return;
312 }
313