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