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