xref: /freebsd/usr.bin/rpcgen/rpc_sample.c (revision d0cc804bba69cab19f4455c5d40bb9685b4f22ae)
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 
49d3cb5dedSWarner Losh extern void printarglist( proc_list *, char *, char *, char *);
50d3cb5dedSWarner Losh static void write_sample_client( char *, version_list * );
51d3cb5dedSWarner Losh static void write_sample_server( definition * );
52d3cb5dedSWarner Losh static void return_type( proc_list * );
53ee4f614eSBill Paul 
54ee4f614eSBill Paul void
55ee4f614eSBill Paul write_sample_svc(def)
56ee4f614eSBill Paul      definition *def;
57ee4f614eSBill Paul {
58ee4f614eSBill Paul 
59ee4f614eSBill Paul 	if (def->def_kind != DEF_PROGRAM)
60ee4f614eSBill Paul 	  return;
61ee4f614eSBill Paul 	write_sample_server(def);
62ee4f614eSBill Paul }
63ee4f614eSBill Paul 
64ee4f614eSBill Paul 
65ee4f614eSBill Paul int
66ee4f614eSBill Paul write_sample_clnt(def)
67ee4f614eSBill Paul      definition *def;
68ee4f614eSBill Paul {
69ee4f614eSBill Paul         version_list *vp;
70ee4f614eSBill Paul 	int count = 0;
71ee4f614eSBill Paul 
72ee4f614eSBill Paul 	if (def->def_kind != DEF_PROGRAM)
73ee4f614eSBill Paul 	  return(0);
74ee4f614eSBill Paul 	/* generate sample code for each version */
75ee4f614eSBill Paul 	for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
76ee4f614eSBill Paul 	  write_sample_client(def->def_name, vp);
77ee4f614eSBill Paul 	  ++count;
78ee4f614eSBill Paul 	}
79ee4f614eSBill Paul 	return(count);
80ee4f614eSBill Paul }
81ee4f614eSBill Paul 
82ee4f614eSBill Paul 
83526195adSJordan K. Hubbard static void
84ee4f614eSBill Paul write_sample_client(program_name, vp)
85ee4f614eSBill Paul      char *program_name;
86ee4f614eSBill Paul      version_list *vp;
87ee4f614eSBill Paul {
88ee4f614eSBill Paul 	proc_list *proc;
89ee4f614eSBill Paul 	int i;
90ee4f614eSBill Paul 	decl_list *l;
91ee4f614eSBill Paul 
92ee4f614eSBill Paul 	f_print(fout, "\n\nvoid\n");
93ee4f614eSBill Paul 	pvname(program_name, vp->vers_num);
94ee4f614eSBill Paul 	if(Cflag)
95ee4f614eSBill Paul 		f_print(fout,"(char *host)\n{\n");
96ee4f614eSBill Paul 	else
97ee4f614eSBill Paul 		f_print(fout, "(host)\n\tchar *host;\n{\n");
98ee4f614eSBill Paul 	f_print(fout, "\tCLIENT *clnt;\n");
99ee4f614eSBill Paul 
100ee4f614eSBill Paul 	i = 0;
101ee4f614eSBill Paul 	for (proc = vp->procs; proc != NULL; proc = proc->next) {
102ee4f614eSBill Paul 		f_print(fout, "\t");
103ee4f614eSBill Paul 		if (mtflag) {
104ee4f614eSBill Paul 			f_print(fout, "enum clnt_stat retval_%d;\n\t", ++i);
105ee4f614eSBill Paul 			ptype(proc->res_prefix, proc->res_type, 1);
106ee4f614eSBill Paul 			f_print(fout, "result_%d;\n", i);
107ee4f614eSBill Paul 		} else {
108ee4f614eSBill Paul 			ptype(proc->res_prefix, proc->res_type, 1);
109ee4f614eSBill Paul 			f_print(fout, " *result_%d;\n",++i);
110ee4f614eSBill Paul 		}
111ee4f614eSBill Paul 		/* print out declarations for arguments */
112ee4f614eSBill Paul 		if(proc->arg_num < 2 && !newstyle) {
113ee4f614eSBill Paul 			f_print(fout, "\t");
114ee4f614eSBill Paul 			if(!streq(proc->args.decls->decl.type, "void"))
115ee4f614eSBill Paul 				ptype(proc->args.decls->decl.prefix,
116ee4f614eSBill Paul 				      proc->args.decls->decl.type, 1);
117ee4f614eSBill Paul 			else
118ee4f614eSBill Paul 				f_print(fout, "char * "); /* cannot have "void" type */
119ee4f614eSBill Paul 			f_print(fout, " ");
120ee4f614eSBill Paul 			pvname(proc->proc_name, vp->vers_num);
121ee4f614eSBill Paul 			f_print(fout, "_arg;\n");
122ee4f614eSBill Paul 		} else if (!streq(proc->args.decls->decl.type, "void")) {
123ee4f614eSBill Paul 			for (l = proc->args.decls; l != NULL; l = l->next) {
124ee4f614eSBill Paul 				f_print(fout, "\t");
125ee4f614eSBill Paul 				ptype(l->decl.prefix, l->decl.type, 1);
126ee4f614eSBill Paul 				if (strcmp(l->decl.type,"string") == 1)
127ee4f614eSBill Paul 				    f_print(fout, " ");
128ee4f614eSBill Paul 				pvname(proc->proc_name, vp->vers_num);
129ee4f614eSBill Paul 				f_print(fout, "_%s;\n", l->decl.name);
130ee4f614eSBill Paul 			}
131ee4f614eSBill Paul 		}
132ee4f614eSBill Paul 	}
133ee4f614eSBill Paul 
134ee4f614eSBill Paul 	/* generate creation of client handle */
135ee4f614eSBill Paul 	f_print(fout, "\n#ifndef\tDEBUG\n");
136ee4f614eSBill Paul 	f_print(fout, "\tclnt = clnt_create(host, %s, %s, \"%s\");\n",
137ee4f614eSBill Paul 		program_name, vp->vers_name, tirpcflag? "netpath" : "udp");
138ee4f614eSBill Paul 	f_print(fout, "\tif (clnt == (CLIENT *) NULL) {\n");
139ee4f614eSBill Paul 	f_print(fout, "\t\tclnt_pcreateerror(host);\n");
140ee4f614eSBill Paul 	f_print(fout, "\t\texit(1);\n\t}\n");
141ee4f614eSBill Paul 	f_print(fout, "#endif\t/* DEBUG */\n\n");
142ee4f614eSBill Paul 
143ee4f614eSBill Paul 	/* generate calls to procedures */
144ee4f614eSBill Paul 	i = 0;
145ee4f614eSBill Paul 	for (proc = vp->procs; proc != NULL; proc = proc->next) {
146ee4f614eSBill Paul 		if (mtflag)
147ee4f614eSBill Paul 			f_print(fout, "\tretval_%d = ",++i);
148ee4f614eSBill Paul 		else
149ee4f614eSBill Paul 			f_print(fout, "\tresult_%d = ",++i);
150ee4f614eSBill Paul 		pvname(proc->proc_name, vp->vers_num);
151ee4f614eSBill Paul 		if (proc->arg_num < 2 && !newstyle) {
152ee4f614eSBill Paul 			f_print(fout, "(");
153ee4f614eSBill Paul 			if(streq(proc->args.decls->decl.type, "void"))
154ee4f614eSBill Paul 				/* cast to void * */
155ee4f614eSBill Paul 				f_print(fout, "(void *)");
156ee4f614eSBill Paul 			f_print(fout, "&");
157ee4f614eSBill Paul 			pvname(proc->proc_name, vp->vers_num);
158ee4f614eSBill Paul 			if (mtflag)
159ee4f614eSBill Paul 				f_print(fout, "_arg, &result_%d, clnt);\n",
160ee4f614eSBill Paul 					i);
161ee4f614eSBill Paul 			else
162ee4f614eSBill Paul 				f_print(fout, "_arg, clnt);\n");
163ee4f614eSBill Paul 
164ee4f614eSBill Paul 		} else if (streq(proc->args.decls->decl.type, "void")) {
165ee4f614eSBill Paul 			if (mtflag)
166ee4f614eSBill Paul 				f_print(fout, "(&result_%d, clnt);\n", i);
167ee4f614eSBill Paul 			else
168ee4f614eSBill Paul 				f_print(fout, "(clnt);\n");
169ee4f614eSBill Paul 		}
170ee4f614eSBill Paul 		else {
171ee4f614eSBill Paul 			f_print(fout, "(");
172ee4f614eSBill Paul 			for (l = proc->args.decls;  l != NULL; l = l->next) {
173ee4f614eSBill Paul 				pvname(proc->proc_name, vp->vers_num);
174ee4f614eSBill Paul 				f_print(fout, "_%s, ", l->decl.name);
175ee4f614eSBill Paul 			}
176ee4f614eSBill Paul 			if (mtflag)
177ee4f614eSBill Paul 				f_print(fout, "&result_%d, ", i);
178ee4f614eSBill Paul 
179ee4f614eSBill Paul 			f_print(fout, "clnt);\n");
180ee4f614eSBill Paul 		}
181ee4f614eSBill Paul 		if (mtflag) {
182ee4f614eSBill Paul 			f_print(fout, "\tif (retval_%d != RPC_SUCCESS) {\n", i);
183ee4f614eSBill Paul 
184ee4f614eSBill Paul 		} else {
185ee4f614eSBill Paul 			f_print(fout, "\tif (result_%d == (", i);
186ee4f614eSBill Paul 			ptype(proc->res_prefix, proc->res_type, 1);
187ee4f614eSBill Paul 			f_print(fout, "*) NULL) {\n");
188ee4f614eSBill Paul 		}
189ee4f614eSBill Paul 		f_print(fout, "\t\tclnt_perror(clnt, \"call failed\");\n");
190ee4f614eSBill Paul 		f_print(fout, "\t}\n");
191ee4f614eSBill Paul 	}
192ee4f614eSBill Paul 
193ee4f614eSBill Paul 	f_print(fout, "#ifndef\tDEBUG\n");
194ee4f614eSBill Paul 	f_print(fout, "\tclnt_destroy(clnt);\n");
195ee4f614eSBill Paul 	f_print(fout, "#endif\t	/* DEBUG */\n");
196ee4f614eSBill Paul 	f_print(fout, "}\n");
197ee4f614eSBill Paul }
198ee4f614eSBill Paul 
199526195adSJordan K. Hubbard static void
200ee4f614eSBill Paul write_sample_server(def)
201ee4f614eSBill Paul 	definition *def;
202ee4f614eSBill Paul {
203ee4f614eSBill Paul 	version_list *vp;
204ee4f614eSBill Paul 	proc_list *proc;
205ee4f614eSBill Paul 
206ee4f614eSBill Paul 	for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
207ee4f614eSBill Paul 		for (proc = vp->procs; proc != NULL; proc = proc->next) {
208ee4f614eSBill Paul 			f_print(fout, "\n");
209ee4f614eSBill Paul 			if (!mtflag) {
210ee4f614eSBill Paul 				return_type(proc);
211ee4f614eSBill Paul 				f_print(fout, "*\n");
212ee4f614eSBill Paul 			} else
213ee4f614eSBill Paul 				f_print(fout, "bool_t\n");
214ee4f614eSBill Paul 			if (Cflag || mtflag)
215ee4f614eSBill Paul 				pvname_svc(proc->proc_name, vp->vers_num);
216ee4f614eSBill Paul 			else
217ee4f614eSBill Paul 				pvname(proc->proc_name, vp->vers_num);
218ee4f614eSBill Paul 			printarglist(proc, "result", RQSTP, "struct svc_req *");
219ee4f614eSBill Paul 
220ee4f614eSBill Paul 			f_print(fout, "{\n");
221ee4f614eSBill Paul 			if (!mtflag) {
222ee4f614eSBill Paul 				f_print(fout, "\tstatic ");
223ee4f614eSBill Paul 				if(!streq(proc->res_type, "void"))
224ee4f614eSBill Paul 					return_type(proc);
225ee4f614eSBill Paul 				else
226ee4f614eSBill Paul 					f_print(fout, "char *");
227ee4f614eSBill Paul 				/* cannot have void type */
228c513aafeSBruce Evans 				f_print(fout, " result;\n");
229ee4f614eSBill Paul 			}
230ee4f614eSBill Paul 			else
231ee4f614eSBill Paul 				f_print(fout, "\tbool_t retval;\n");
232ee4f614eSBill Paul 			f_print(fout,
233ee4f614eSBill Paul 				"\n\t/*\n\t * insert server code here\n\t */\n\n");
234ee4f614eSBill Paul 
235ee4f614eSBill Paul 			if (!mtflag)
236ee4f614eSBill Paul 				if(!streq(proc->res_type, "void"))
237ee4f614eSBill Paul 					f_print(fout, "\treturn (&result);\n}\n");
238ee4f614eSBill Paul 				else /* cast back to void * */
239ee4f614eSBill Paul 					f_print(fout, "\treturn((void *) &result);\n}\n");
240ee4f614eSBill Paul 			else
241ee4f614eSBill Paul 				f_print(fout, "\treturn (retval);\n}\n");
242ee4f614eSBill Paul 		}
243ee4f614eSBill Paul 		/* put in sample freeing routine */
244ee4f614eSBill Paul 		if (mtflag) {
245ee4f614eSBill Paul 		f_print(fout, "\nint\n");
246ee4f614eSBill Paul 		pvname(def->def_name, vp->vers_num);
247ee4f614eSBill Paul 		if (Cflag)
248ee4f614eSBill Paul 			f_print(fout,"_freeresult(SVCXPRT *transp, xdrproc_t xdr_result, caddr_t result)\n");
249ee4f614eSBill Paul 		else {
250ee4f614eSBill Paul 			f_print(fout,"_freeresult(transp, xdr_result, result)\n");
251ee4f614eSBill Paul 			f_print(fout,"\tSVCXPRT *transp;\n");
252ee4f614eSBill Paul 			f_print(fout,"\txdrproc_t xdr_result;\n");
253ee4f614eSBill Paul 			f_print(fout,"\tcaddr_t result;\n");
254ee4f614eSBill Paul 		}
255ee4f614eSBill Paul 		f_print(fout, "{\n");
256ee4f614eSBill Paul 		f_print(fout, "\t(void) xdr_free(xdr_result, result);\n");
257ee4f614eSBill Paul 		f_print(fout,
258ee4f614eSBill Paul 			"\n\t/*\n\t * Insert additional freeing code here, if needed\n\t */\n");
259ee4f614eSBill Paul 		f_print(fout, "\n}\n");
260ee4f614eSBill Paul 
261ee4f614eSBill Paul 
262ee4f614eSBill Paul 	}
263ee4f614eSBill Paul 	}
264ee4f614eSBill Paul }
265ee4f614eSBill Paul 
266ee4f614eSBill Paul 
267ee4f614eSBill Paul 
268526195adSJordan K. Hubbard static void
269ee4f614eSBill Paul return_type(plist)
270ee4f614eSBill Paul 	proc_list *plist;
271ee4f614eSBill Paul {
272ee4f614eSBill Paul   ptype(plist->res_prefix, plist->res_type, 1);
273ee4f614eSBill Paul }
274ee4f614eSBill Paul 
275526195adSJordan K. Hubbard void
276ee4f614eSBill Paul add_sample_msg()
277ee4f614eSBill Paul {
278ee4f614eSBill Paul 	f_print(fout, "/*\n");
279ee4f614eSBill Paul 	f_print(fout, " * This is sample code generated by rpcgen.\n");
280ee4f614eSBill Paul 	f_print(fout, " * These are only templates and you can use them\n");
281ee4f614eSBill Paul 	f_print(fout, " * as a guideline for developing your own functions.\n");
282ee4f614eSBill Paul 	f_print(fout, " */\n\n");
283ee4f614eSBill Paul }
284ee4f614eSBill Paul 
285ee4f614eSBill Paul void
286ee4f614eSBill Paul write_sample_clnt_main()
287ee4f614eSBill Paul {
288ee4f614eSBill Paul 	list *l;
289ee4f614eSBill Paul 	definition *def;
290ee4f614eSBill Paul 	version_list *vp;
291ee4f614eSBill Paul 
292ee4f614eSBill Paul 	f_print(fout, "\n\n");
293ee4f614eSBill Paul 	if(Cflag)
294ee4f614eSBill Paul 		f_print(fout,"main(int argc, char *argv[])\n{\n");
295ee4f614eSBill Paul 	else
296ee4f614eSBill Paul 		f_print(fout, "main(argc, argv)\n\tint argc;\n\tchar *argv[];\n{\n");
297ee4f614eSBill Paul 
298ee4f614eSBill Paul 	f_print(fout, "\tchar *host;");
299ee4f614eSBill Paul 	f_print(fout, "\n\n\tif (argc < 2) {");
300ee4f614eSBill Paul 	f_print(fout, "\n\t\tprintf(\"usage:  %%s server_host\\n\", argv[0]);\n");
301ee4f614eSBill Paul 	f_print(fout, "\t\texit(1);\n\t}");
302ee4f614eSBill Paul 	f_print(fout, "\n\thost = argv[1];\n");
303ee4f614eSBill Paul 
304ee4f614eSBill Paul 	for (l = defined; l != NULL; l = l->next) {
305ee4f614eSBill Paul 		def = l->val;
306ee4f614eSBill Paul 		if (def->def_kind != DEF_PROGRAM) {
307ee4f614eSBill Paul 			continue;
308ee4f614eSBill Paul 		}
309ee4f614eSBill Paul 		for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
310ee4f614eSBill Paul 		        f_print(fout, "\t");
311ee4f614eSBill Paul 			pvname(def->def_name, vp->vers_num);
312ee4f614eSBill Paul 			f_print(fout, "(host);\n");
313ee4f614eSBill Paul 		}
314ee4f614eSBill Paul 	}
315ee4f614eSBill Paul 	f_print(fout, "}\n");
316ee4f614eSBill Paul }
317