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