Home | History | Annotate | Line # | Download | only in rpc
svc_simple.c revision 1.29
      1 /*	$NetBSD: svc_simple.c,v 1.29 2006/03/21 23:58:24 christos Exp $	*/
      2 
      3 /*
      4  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
      5  * unrestricted use provided that this legend is included on all tape
      6  * media and as a part of the software program in whole or part.  Users
      7  * may copy or modify Sun RPC without charge, but are not authorized
      8  * to license or distribute it to anyone else except as part of a product or
      9  * program developed by the user.
     10  *
     11  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
     12  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
     13  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
     14  *
     15  * Sun RPC is provided with no support and without any obligation on the
     16  * part of Sun Microsystems, Inc. to assist in its use, correction,
     17  * modification or enhancement.
     18  *
     19  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
     20  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
     21  * OR ANY PART THEREOF.
     22  *
     23  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
     24  * or profits or other special, indirect and consequential damages, even if
     25  * Sun has been advised of the possibility of such damages.
     26  *
     27  * Sun Microsystems, Inc.
     28  * 2550 Garcia Avenue
     29  * Mountain View, California  94043
     30  */
     31 /*
     32  * Copyright (c) 1986-1991 by Sun Microsystems Inc.
     33  */
     34 
     35 /* #pragma ident	"@(#)svc_simple.c	1.18	94/04/24 SMI" */
     36 
     37 /*
     38  * svc_simple.c
     39  * Simplified front end to rpc.
     40  */
     41 
     42 /*
     43  * This interface creates a virtual listener for all the services
     44  * started thru rpc_reg(). It listens on the same endpoint for
     45  * all the services and then executes the corresponding service
     46  * for the given prognum and procnum.
     47  */
     48 
     49 #include <sys/cdefs.h>
     50 #if defined(LIBC_SCCS) && !defined(lint)
     51 __RCSID("$NetBSD: svc_simple.c,v 1.29 2006/03/21 23:58:24 christos Exp $");
     52 #endif
     53 
     54 #include "namespace.h"
     55 #include "reentrant.h"
     56 #include <sys/types.h>
     57 #include <rpc/rpc.h>
     58 #include <rpc/nettype.h>
     59 #include <assert.h>
     60 #include <err.h>
     61 #include <stdio.h>
     62 #include <stdlib.h>
     63 #include <string.h>
     64 
     65 #include "rpc_internal.h"
     66 
     67 #ifdef __weak_alias
     68 __weak_alias(rpc_reg,_rpc_reg)
     69 #endif
     70 
     71 static void universal __P((struct svc_req *, SVCXPRT *));
     72 
     73 static struct proglst {
     74 	char *(*p_progname) __P((char *));
     75 	rpcprog_t p_prognum;
     76 	rpcvers_t p_versnum;
     77 	rpcproc_t p_procnum;
     78 	SVCXPRT *p_transp;
     79 	char *p_netid;
     80 	char *p_xdrbuf;
     81 	int p_recvsz;
     82 	xdrproc_t p_inproc, p_outproc;
     83 	struct proglst *p_nxt;
     84 } *proglst;
     85 
     86 static const char rpc_reg_err[] = "%s: %s";
     87 static const char rpc_reg_msg[] = "rpc_reg: ";
     88 static const char __reg_err1[] = "can't find appropriate transport";
     89 static const char __reg_err2[] = "can't get protocol info";
     90 static const char __reg_err3[] = "unsupported transport size";
     91 static const char __no_mem_str[] = "out of memory";
     92 
     93 /*
     94  * For simplified, easy to use kind of rpc interfaces.
     95  * nettype indicates the type of transport on which the service will be
     96  * listening. Used for conservation of the system resource. Only one
     97  * handle is created for all the services (actually one of each netid)
     98  * and same xdrbuf is used for same netid. The size of the arguments
     99  * is also limited by the recvsize for that transport, even if it is
    100  * a COTS transport. This may be wrong, but for cases like these, they
    101  * should not use the simplified interfaces like this.
    102  */
    103 
    104 int
    105 rpc_reg(prognum, versnum, procnum, progname, inproc, outproc, nettype)
    106 	rpcprog_t prognum;			/* program number */
    107 	rpcvers_t versnum;			/* version number */
    108 	rpcproc_t procnum;			/* procedure number */
    109 	char *(*progname) __P((char *)); /* Server routine */
    110 	xdrproc_t inproc, outproc;	/* in/out XDR procedures */
    111 	char *nettype;			/* nettype */
    112 {
    113 	struct netconfig *nconf;
    114 	int done = FALSE;
    115 	void *handle;
    116 #ifdef _REENTRANT
    117 	extern mutex_t proglst_lock;
    118 #endif
    119 
    120 	if (procnum == NULLPROC) {
    121 		warnx("%s can't reassign procedure number %u", rpc_reg_msg,
    122 			NULLPROC);
    123 		return (-1);
    124 	}
    125 
    126 	if (nettype == NULL)
    127 		nettype = __UNCONST("netpath");	/* The default behavior */
    128 	if ((handle = __rpc_setconf(nettype)) == NULL) {
    129 		warnx(rpc_reg_err, rpc_reg_msg, __reg_err1);
    130 		return (-1);
    131 	}
    132 /* VARIABLES PROTECTED BY proglst_lock: proglst */
    133 	mutex_lock(&proglst_lock);
    134 	while ((nconf = __rpc_getconf(handle)) != NULL) {
    135 		struct proglst *pl;
    136 		SVCXPRT *svcxprt;
    137 		int madenow;
    138 		u_int recvsz;
    139 		char *xdrbuf;
    140 		char *netid;
    141 
    142 		madenow = FALSE;
    143 		svcxprt = NULL;
    144 		recvsz = 0;
    145 		xdrbuf = NULL;
    146 		netid = NULL;
    147 		for (pl = proglst; pl; pl = pl->p_nxt)
    148 			if (strcmp(pl->p_netid, nconf->nc_netid) == 0) {
    149 				svcxprt = pl->p_transp;
    150 				xdrbuf = pl->p_xdrbuf;
    151 				recvsz = pl->p_recvsz;
    152 				netid = pl->p_netid;
    153 				break;
    154 			}
    155 
    156 		if (svcxprt == NULL) {
    157 			struct __rpc_sockinfo si;
    158 
    159 			svcxprt = svc_tli_create(RPC_ANYFD, nconf, NULL, 0, 0);
    160 			if (svcxprt == NULL)
    161 				continue;
    162 			if (!__rpc_fd2sockinfo(svcxprt->xp_fd, &si)) {
    163 				warnx(rpc_reg_err, rpc_reg_msg, __reg_err2);
    164 				SVC_DESTROY(svcxprt);
    165 				continue;
    166 			}
    167 			recvsz = __rpc_get_t_size(si.si_af, si.si_proto, 0);
    168 			if (recvsz == 0) {
    169 				warnx(rpc_reg_err, rpc_reg_msg, __reg_err3);
    170 				SVC_DESTROY(svcxprt);
    171 				continue;
    172 			}
    173 			if (((xdrbuf = malloc((unsigned)recvsz)) == NULL) ||
    174 				((netid = strdup(nconf->nc_netid)) == NULL)) {
    175 				warnx(rpc_reg_err, rpc_reg_msg, __no_mem_str);
    176 				if (xdrbuf != NULL)
    177 					free(xdrbuf);
    178 				if (netid != NULL)
    179 					free(netid);
    180 				SVC_DESTROY(svcxprt);
    181 				break;
    182 			}
    183 			madenow = TRUE;
    184 		}
    185 		/*
    186 		 * Check if this (program, version, netid) had already been
    187 		 * registered.  The check may save a few RPC calls to rpcbind
    188 		 */
    189 		for (pl = proglst; pl; pl = pl->p_nxt)
    190 			if ((pl->p_prognum == prognum) &&
    191 				(pl->p_versnum == versnum) &&
    192 				(strcmp(pl->p_netid, netid) == 0))
    193 				break;
    194 		if (pl == NULL) { /* Not yet */
    195 			(void) rpcb_unset(prognum, versnum, nconf);
    196 		} else {
    197 			/* so that svc_reg does not call rpcb_set() */
    198 			nconf = NULL;
    199 		}
    200 
    201 		if (!svc_reg(svcxprt, prognum, versnum, universal, nconf)) {
    202 			warnx("%s couldn't register prog %u vers %u for %s",
    203 				rpc_reg_msg, (unsigned)prognum,
    204 				(unsigned)versnum, netid);
    205 			if (madenow) {
    206 				SVC_DESTROY(svcxprt);
    207 				free(xdrbuf);
    208 				free(netid);
    209 			}
    210 			continue;
    211 		}
    212 
    213 		pl = malloc(sizeof (struct proglst));
    214 		if (pl == NULL) {
    215 			warnx(rpc_reg_err, rpc_reg_msg, __no_mem_str);
    216 			if (madenow) {
    217 				SVC_DESTROY(svcxprt);
    218 				free(xdrbuf);
    219 				free(netid);
    220 			}
    221 			break;
    222 		}
    223 		pl->p_progname = progname;
    224 		pl->p_prognum = prognum;
    225 		pl->p_versnum = versnum;
    226 		pl->p_procnum = procnum;
    227 		pl->p_inproc = inproc;
    228 		pl->p_outproc = outproc;
    229 		pl->p_transp = svcxprt;
    230 		pl->p_xdrbuf = xdrbuf;
    231 		pl->p_recvsz = recvsz;
    232 		pl->p_netid = netid;
    233 		pl->p_nxt = proglst;
    234 		proglst = pl;
    235 		done = TRUE;
    236 	}
    237 	__rpc_endconf(handle);
    238 	mutex_unlock(&proglst_lock);
    239 
    240 	if (done == FALSE) {
    241 		warnx("%s cant find suitable transport for %s",
    242 			rpc_reg_msg, nettype);
    243 		return (-1);
    244 	}
    245 	return (0);
    246 }
    247 
    248 /*
    249  * The universal handler for the services registered using registerrpc.
    250  * It handles both the connectionless and the connection oriented cases.
    251  */
    252 
    253 static void
    254 universal(rqstp, transp)
    255 	struct svc_req *rqstp;
    256 	SVCXPRT *transp;
    257 {
    258 	rpcprog_t prog;
    259 	rpcvers_t vers;
    260 	rpcproc_t proc;
    261 	char *outdata;
    262 	char *xdrbuf;
    263 	struct proglst *pl;
    264 #ifdef _REENTRANT
    265 	extern mutex_t proglst_lock;
    266 #endif
    267 
    268 	_DIAGASSERT(rqstp != NULL);
    269 	_DIAGASSERT(transp != NULL);
    270 
    271 	/*
    272 	 * enforce "procnum 0 is echo" convention
    273 	 */
    274 	if (rqstp->rq_proc == NULLPROC) {
    275 		if (svc_sendreply(transp, (xdrproc_t) xdr_void, NULL) ==
    276 		    FALSE) {
    277 			warnx("svc_sendreply failed");
    278 		}
    279 		return;
    280 	}
    281 	prog = rqstp->rq_prog;
    282 	vers = rqstp->rq_vers;
    283 	proc = rqstp->rq_proc;
    284 	mutex_lock(&proglst_lock);
    285 	for (pl = proglst; pl; pl = pl->p_nxt)
    286 		if (pl->p_prognum == prog && pl->p_procnum == proc &&
    287 			pl->p_versnum == vers &&
    288 			(strcmp(pl->p_netid, transp->xp_netid) == 0)) {
    289 			/* decode arguments into a CLEAN buffer */
    290 			xdrbuf = pl->p_xdrbuf;
    291 			/* Zero the arguments: reqd ! */
    292 			(void) memset(xdrbuf, 0, (size_t)pl->p_recvsz);
    293 			/*
    294 			 * Assuming that sizeof (xdrbuf) would be enough
    295 			 * for the arguments; if not then the program
    296 			 * may bomb. BEWARE!
    297 			 */
    298 			if (!svc_getargs(transp, pl->p_inproc, xdrbuf)) {
    299 				svcerr_decode(transp);
    300 				mutex_unlock(&proglst_lock);
    301 				return;
    302 			}
    303 			outdata = (*(pl->p_progname))(xdrbuf);
    304 			if (outdata == NULL &&
    305 				pl->p_outproc != (xdrproc_t) xdr_void){
    306 				/* there was an error */
    307 				mutex_unlock(&proglst_lock);
    308 				return;
    309 			}
    310 			if (!svc_sendreply(transp, pl->p_outproc, outdata)) {
    311 				warnx(
    312 			"rpc: rpc_reg trouble replying to prog %u vers %u",
    313 				(unsigned)prog, (unsigned)vers);
    314 				mutex_unlock(&proglst_lock);
    315 				return;
    316 			}
    317 			/* free the decoded arguments */
    318 			(void) svc_freeargs(transp, pl->p_inproc, xdrbuf);
    319 			mutex_unlock(&proglst_lock);
    320 			return;
    321 		}
    322 	mutex_unlock(&proglst_lock);
    323 	/* This should never happen */
    324 	warnx("rpc: rpc_reg: never registered prog %u vers %u",
    325 		(unsigned)prog, (unsigned)vers);
    326 	return;
    327 }
    328