rpc_sample.c revision 149682 
1/*
2 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3 * unrestricted use provided that this legend is included on all tape
4 * media and as a part of the software program in whole or part.  Users
5 * may copy or modify Sun RPC without charge, but are not authorized
6 * to license or distribute it to anyone else except as part of a product or
7 * program developed by the user.
8 *
9 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
10 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
11 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
12 *
13 * Sun RPC is provided with no support and without any obligation on the
14 * part of Sun Microsystems, Inc. to assist in its use, correction,
15 * modification or enhancement.
16 *
17 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
18 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
19 * OR ANY PART THEREOF.
20 *
21 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
22 * or profits or other special, indirect and consequential damages, even if
23 * Sun has been advised of the possibility of such damages.
24 *
25 * Sun Microsystems, Inc.
26 * 2550 Garcia Avenue
27 * Mountain View, California  94043
28 */
29
30/* #pragma ident	"@(#)rpc_sample.c	1.9	94/04/25 SMI" */
31
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD: head/usr.bin/rpcgen/rpc_sample.c 149682 2005-08-31 20:45:15Z stefanf $");
34
35/*
36 * rpc_sample.c, Sample client-server code outputter for the RPC protocol compiler
37 * Copyright (C) 1987, Sun Microsystems, Inc.
38 */
39
40#include <stdio.h>
41#include <string.h>
42#include "rpc_parse.h"
43#include "rpc_scan.h"
44#include "rpc_util.h"
45
46
47static char RQSTP[] = "rqstp";
48
49extern void printarglist( proc_list *, char *, char *, char *);
50static void write_sample_client( char *, version_list * );
51static void write_sample_server( definition * );
52static void return_type( proc_list * );
53
54void
55write_sample_svc(def)
56     definition *def;
57{
58
59	if (def->def_kind != DEF_PROGRAM)
60	  return;
61	write_sample_server(def);
62}
63
64
65int
66write_sample_clnt(def)
67     definition *def;
68{
69        version_list *vp;
70	int count = 0;
71
72	if (def->def_kind != DEF_PROGRAM)
73	  return(0);
74	/* generate sample code for each version */
75	for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
76	  write_sample_client(def->def_name, vp);
77	  ++count;
78	}
79	return(count);
80}
81
82
83static void
84write_sample_client(program_name, vp)
85     char *program_name;
86     version_list *vp;
87{
88	proc_list *proc;
89	int i;
90	decl_list *l;
91
92	f_print(fout, "\n\nvoid\n");
93	pvname(program_name, vp->vers_num);
94	if(Cflag)
95		f_print(fout,"(char *host)\n{\n");
96	else
97		f_print(fout, "(host)\n\tchar *host;\n{\n");
98	f_print(fout, "\tCLIENT *clnt;\n");
99
100	i = 0;
101	for (proc = vp->procs; proc != NULL; proc = proc->next) {
102		f_print(fout, "\t");
103		if (mtflag) {
104			f_print(fout, "enum clnt_stat retval_%d;\n\t", ++i);
105			ptype(proc->res_prefix, proc->res_type, 1);
106			f_print(fout, "result_%d;\n", i);
107		} else {
108			ptype(proc->res_prefix, proc->res_type, 1);
109			f_print(fout, " *result_%d;\n",++i);
110		}
111		/* print out declarations for arguments */
112		if(proc->arg_num < 2 && !newstyle) {
113			f_print(fout, "\t");
114			if(!streq(proc->args.decls->decl.type, "void"))
115				ptype(proc->args.decls->decl.prefix,
116				      proc->args.decls->decl.type, 1);
117			else
118				f_print(fout, "char * "); /* cannot have "void" type */
119			f_print(fout, " ");
120			pvname(proc->proc_name, vp->vers_num);
121			f_print(fout, "_arg;\n");
122		} else if (!streq(proc->args.decls->decl.type, "void")) {
123			for (l = proc->args.decls; l != NULL; l = l->next) {
124				f_print(fout, "\t");
125				ptype(l->decl.prefix, l->decl.type, 1);
126				if (strcmp(l->decl.type,"string") == 1)
127				    f_print(fout, " ");
128				pvname(proc->proc_name, vp->vers_num);
129				f_print(fout, "_%s;\n", l->decl.name);
130			}
131		}
132	}
133
134	/* generate creation of client handle */
135	f_print(fout, "\n#ifndef\tDEBUG\n");
136	f_print(fout, "\tclnt = clnt_create(host, %s, %s, \"%s\");\n",
137		program_name, vp->vers_name, tirpcflag? "netpath" : "udp");
138	f_print(fout, "\tif (clnt == (CLIENT *) NULL) {\n");
139	f_print(fout, "\t\tclnt_pcreateerror(host);\n");
140	f_print(fout, "\t\texit(1);\n\t}\n");
141	f_print(fout, "#endif\t/* DEBUG */\n\n");
142
143	/* generate calls to procedures */
144	i = 0;
145	for (proc = vp->procs; proc != NULL; proc = proc->next) {
146		if (mtflag)
147			f_print(fout, "\tretval_%d = ",++i);
148		else
149			f_print(fout, "\tresult_%d = ",++i);
150		pvname(proc->proc_name, vp->vers_num);
151		if (proc->arg_num < 2 && !newstyle) {
152			f_print(fout, "(");
153			if(streq(proc->args.decls->decl.type, "void"))
154				/* cast to void * */
155				f_print(fout, "(void *)");
156			f_print(fout, "&");
157			pvname(proc->proc_name, vp->vers_num);
158			if (mtflag)
159				f_print(fout, "_arg, &result_%d, clnt);\n",
160					i);
161			else
162				f_print(fout, "_arg, clnt);\n");
163
164		} else if (streq(proc->args.decls->decl.type, "void")) {
165			if (mtflag)
166				f_print(fout, "(&result_%d, clnt);\n", i);
167			else
168				f_print(fout, "(clnt);\n");
169		}
170		else {
171			f_print(fout, "(");
172			for (l = proc->args.decls;  l != NULL; l = l->next) {
173				pvname(proc->proc_name, vp->vers_num);
174				f_print(fout, "_%s, ", l->decl.name);
175			}
176			if (mtflag)
177				f_print(fout, "&result_%d, ", i);
178
179			f_print(fout, "clnt);\n");
180		}
181		if (mtflag) {
182			f_print(fout, "\tif (retval_%d != RPC_SUCCESS) {\n", i);
183
184		} else {
185			f_print(fout, "\tif (result_%d == (", i);
186			ptype(proc->res_prefix, proc->res_type, 1);
187			f_print(fout, "*) NULL) {\n");
188		}
189		f_print(fout, "\t\tclnt_perror(clnt, \"call failed\");\n");
190		f_print(fout, "\t}\n");
191	}
192
193	f_print(fout, "#ifndef\tDEBUG\n");
194	f_print(fout, "\tclnt_destroy(clnt);\n");
195	f_print(fout, "#endif\t	/* DEBUG */\n");
196	f_print(fout, "}\n");
197}
198
199static void
200write_sample_server(def)
201	definition *def;
202{
203	version_list *vp;
204	proc_list *proc;
205
206	for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
207		for (proc = vp->procs; proc != NULL; proc = proc->next) {
208			f_print(fout, "\n");
209			if (!mtflag) {
210				return_type(proc);
211				f_print(fout, "*\n");
212			} else
213				f_print(fout, "bool_t\n");
214			if (Cflag || mtflag)
215				pvname_svc(proc->proc_name, vp->vers_num);
216			else
217				pvname(proc->proc_name, vp->vers_num);
218			printarglist(proc, "result", RQSTP, "struct svc_req *");
219
220			f_print(fout, "{\n");
221			if (!mtflag) {
222				f_print(fout, "\tstatic ");
223				if(!streq(proc->res_type, "void"))
224					return_type(proc);
225				else
226					f_print(fout, "char *");
227				/* cannot have void type */
228				f_print(fout, " result;\n");
229			}
230			else
231				f_print(fout, "\tbool_t retval;\n");
232			f_print(fout,
233				"\n\t/*\n\t * insert server code here\n\t */\n\n");
234
235			if (!mtflag)
236				if(!streq(proc->res_type, "void"))
237					f_print(fout, "\treturn (&result);\n}\n");
238				else /* cast back to void * */
239					f_print(fout, "\treturn((void *) &result);\n}\n");
240			else
241				f_print(fout, "\treturn (retval);\n}\n");
242		}
243		/* put in sample freeing routine */
244		if (mtflag) {
245		f_print(fout, "\nint\n");
246		pvname(def->def_name, vp->vers_num);
247		if (Cflag)
248			f_print(fout,"_freeresult(SVCXPRT *transp, xdrproc_t xdr_result, caddr_t result)\n");
249		else {
250			f_print(fout,"_freeresult(transp, xdr_result, result)\n");
251			f_print(fout,"\tSVCXPRT *transp;\n");
252			f_print(fout,"\txdrproc_t xdr_result;\n");
253			f_print(fout,"\tcaddr_t result;\n");
254		}
255		f_print(fout, "{\n");
256		f_print(fout, "\t(void) xdr_free(xdr_result, result);\n");
257		f_print(fout,
258			"\n\t/*\n\t * Insert additional freeing code here, if needed\n\t */\n");
259		f_print(fout, "\n}\n");
260
261
262	}
263	}
264}
265
266
267
268static void
269return_type(plist)
270	proc_list *plist;
271{
272  ptype(plist->res_prefix, plist->res_type, 1);
273}
274
275void
276add_sample_msg()
277{
278	f_print(fout, "/*\n");
279	f_print(fout, " * This is sample code generated by rpcgen.\n");
280	f_print(fout, " * These are only templates and you can use them\n");
281	f_print(fout, " * as a guideline for developing your own functions.\n");
282	f_print(fout, " */\n\n");
283}
284
285void
286write_sample_clnt_main()
287{
288	list *l;
289	definition *def;
290	version_list *vp;
291
292	f_print(fout, "\n\n");
293	if(Cflag)
294		f_print(fout,"main(int argc, char *argv[])\n{\n");
295	else
296		f_print(fout, "main(argc, argv)\n\tint argc;\n\tchar *argv[];\n{\n");
297
298	f_print(fout, "\tchar *host;");
299	f_print(fout, "\n\n\tif (argc < 2) {");
300	f_print(fout, "\n\t\tprintf(\"usage:  %%s server_host\\n\", argv[0]);\n");
301	f_print(fout, "\t\texit(1);\n\t}");
302	f_print(fout, "\n\thost = argv[1];\n");
303
304	for (l = defined; l != NULL; l = l->next) {
305		def = l->val;
306		if (def->def_kind != DEF_PROGRAM) {
307			continue;
308		}
309		for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
310		        f_print(fout, "\t");
311			pvname(def->def_name, vp->vers_num);
312			f_print(fout, "(host);\n");
313		}
314	}
315	f_print(fout, "}\n");
316}
317