rpc_hout.c revision 146833
1257378Sbdrewery/*
2257378Sbdrewery * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3257378Sbdrewery * unrestricted use provided that this legend is included on all tape
4257378Sbdrewery * media and as a part of the software program in whole or part.  Users
5257378Sbdrewery * may copy or modify Sun RPC without charge, but are not authorized
6257378Sbdrewery * to license or distribute it to anyone else except as part of a product or
7257378Sbdrewery * program developed by the user.
8257378Sbdrewery *
9257378Sbdrewery * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
10257378Sbdrewery * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
11257378Sbdrewery * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
12257378Sbdrewery *
13257378Sbdrewery * Sun RPC is provided with no support and without any obligation on the
14257378Sbdrewery * part of Sun Microsystems, Inc. to assist in its use, correction,
15257378Sbdrewery * modification or enhancement.
16257378Sbdrewery *
17257378Sbdrewery * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
18257378Sbdrewery * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
19257378Sbdrewery * OR ANY PART THEREOF.
20257378Sbdrewery *
21257378Sbdrewery * In no event will Sun Microsystems, Inc. be liable for any lost revenue
22257378Sbdrewery * or profits or other special, indirect and consequential damages, even if
23257378Sbdrewery * Sun has been advised of the possibility of such damages.
24257378Sbdrewery *
25257378Sbdrewery * Sun Microsystems, Inc.
26257378Sbdrewery * 2550 Garcia Avenue
27259266Sbdrewery * Mountain View, California  94043
28257378Sbdrewery */
29257378Sbdrewery
30257378Sbdrewery#if 0
31257378Sbdrewery#ifndef lint
32257400Sjoel#ident	"@(#)rpc_hout.c	1.16	94/04/25 SMI"
33257378Sbdrewerystatic char sccsid[] = "@(#)rpc_hout.c 1.12 89/02/22 (C) 1987 SMI";
34257378Sbdrewery#endif
35257378Sbdrewery#endif
36257378Sbdrewery
37257378Sbdrewery#include <sys/cdefs.h>
38257505Sbdrewery__FBSDID("$FreeBSD: head/usr.bin/rpcgen/rpc_hout.c 146833 2005-05-31 20:00:29Z stefanf $");
39257378Sbdrewery
40257378Sbdrewery/*
41257378Sbdrewery * rpc_hout.c, Header file outputter for the RPC protocol compiler
42257378Sbdrewery * Copyright (C) 1987, Sun Microsystems, Inc.
43257378Sbdrewery */
44257505Sbdrewery#include <stdio.h>
45257378Sbdrewery#include <ctype.h>
46257378Sbdrewery#include "rpc_parse.h"
47257378Sbdrewery#include "rpc_util.h"
48257378Sbdrewery
49257378Sbdreweryvoid storexdrfuncdecl( char *, int );
50257378Sbdrewerystatic void pconstdef( definition * );
51257378Sbdrewerystatic void pstructdef( definition * );
52257378Sbdrewerystatic void puniondef( definition * );
53257378Sbdrewerystatic void pprogramdef( definition * );
54257378Sbdrewerystatic void pstructdef( definition * );
55257378Sbdrewerystatic void penumdef( definition * );
56257378Sbdrewerystatic void ptypedef( definition * );
57257378Sbdrewerystatic void pdefine( char *, char * );
58257378Sbdrewerystatic int undefined2( char *, char * );
59257378Sbdrewerystatic void parglist( proc_list *, char * );
60257505Sbdrewerystatic void pprocdef( proc_list *, version_list *, char *, int, int );
61257378Sbdreweryvoid pdeclaration( char *, declaration *, int, char * );
62257378Sbdrewery
63257378Sbdrewery/*
64257378Sbdrewery * Print the C-version of an xdr definition
65257378Sbdrewery */
66257378Sbdreweryvoid
67257378Sbdreweryprint_datadef(def)
68257505Sbdrewery	definition *def;
69257378Sbdrewery{
70257378Sbdrewery
71257378Sbdrewery	if (def->def_kind == DEF_PROGRAM)  /* handle data only */
72257378Sbdrewery		return;
73257378Sbdrewery
74257378Sbdrewery	if (def->def_kind != DEF_CONST) {
75257378Sbdrewery		f_print(fout, "\n");
76257378Sbdrewery	}
77257505Sbdrewery	switch (def->def_kind) {
78257505Sbdrewery	case DEF_STRUCT:
79257505Sbdrewery		pstructdef(def);
80257505Sbdrewery		break;
81257505Sbdrewery	case DEF_UNION:
82257378Sbdrewery		puniondef(def);
83257378Sbdrewery		break;
84257378Sbdrewery	case DEF_ENUM:
85257378Sbdrewery		penumdef(def);
86257378Sbdrewery		break;
87257378Sbdrewery	case DEF_TYPEDEF:
88257505Sbdrewery		ptypedef(def);
89257378Sbdrewery		break;
90257378Sbdrewery	case DEF_PROGRAM:
91257378Sbdrewery		pprogramdef(def);
92257505Sbdrewery		break;
93257505Sbdrewery	case DEF_CONST:
94257505Sbdrewery		pconstdef(def);
95257505Sbdrewery		break;
96257505Sbdrewery	}
97257378Sbdrewery	if (def->def_kind != DEF_PROGRAM && def->def_kind != DEF_CONST) {
98257378Sbdrewery	    storexdrfuncdecl(def->def_name,
99257378Sbdrewery			     def->def_kind != DEF_TYPEDEF ||
100257378Sbdrewery			     !isvectordef(def->def.ty.old_type,
101257378Sbdrewery					  def->def.ty.rel));
102257378Sbdrewery	}
103257378Sbdrewery}
104257378Sbdrewery
105257378Sbdrewery
106257378Sbdreweryvoid
107257378Sbdreweryprint_funcdef(def)
108257378Sbdrewery	definition *def;
109257378Sbdrewery{
110257378Sbdrewery	switch (def->def_kind) {
111258348Sbdrewery	case DEF_PROGRAM:
112257378Sbdrewery		f_print(fout, "\n");
113257378Sbdrewery		pprogramdef(def);
114257378Sbdrewery		break;
115257378Sbdrewery	default:
116257378Sbdrewery		break;
117257378Sbdrewery	}
118257378Sbdrewery}
119257378Sbdrewery
120257378Sbdrewery/* store away enough information to allow the XDR functions to be spat
121257378Sbdrewery    out at the end of the file */
122257378Sbdrewery
123257378Sbdreweryvoid
124257378Sbdrewerystorexdrfuncdecl(name, pointerp)
125257378Sbdrewerychar *name;
126257378Sbdreweryint pointerp;
127257378Sbdrewery{
128257378Sbdrewery	xdrfunc * xdrptr;
129257378Sbdrewery
130257378Sbdrewery	xdrptr = XALLOC(struct xdrfunc);
131257378Sbdrewery
132257378Sbdrewery	xdrptr->name = name;
133257378Sbdrewery	xdrptr->pointerp = pointerp;
134257378Sbdrewery	xdrptr->next = NULL;
135257378Sbdrewery
136257378Sbdrewery	if (xdrfunc_tail == NULL){
137257378Sbdrewery		xdrfunc_head = xdrptr;
138257378Sbdrewery		xdrfunc_tail = xdrptr;
139257378Sbdrewery	} else {
140257378Sbdrewery		xdrfunc_tail->next = xdrptr;
141257378Sbdrewery		xdrfunc_tail = xdrptr;
142257378Sbdrewery	}
143257378Sbdrewery
144257378Sbdrewery
145257378Sbdrewery}
146257378Sbdrewery
147257378Sbdreweryvoid
148257378Sbdreweryprint_xdr_func_def(name, pointerp, i)
149257378Sbdrewerychar* name;
150257668Sbdreweryint pointerp;
151257378Sbdreweryint i;
152257378Sbdrewery{
153257378Sbdrewery	if (i == 2) {
154257378Sbdrewery		f_print(fout, "extern bool_t xdr_%s();\n", name);
155259266Sbdrewery		return;
156257378Sbdrewery	}
157257400Sjoel	else
158257378Sbdrewery		f_print(fout, "extern  bool_t xdr_%s(XDR *, %s%s);\n", name,
159257378Sbdrewery			name, pointerp ? "*" : "");
160257378Sbdrewery
161257378Sbdrewery
162257378Sbdrewery}
163257378Sbdrewery
164257378Sbdrewery
165257378Sbdrewerystatic void
166257378Sbdrewerypconstdef(def)
167257378Sbdrewery	definition *def;
168257378Sbdrewery{
169257378Sbdrewery	pdefine(def->def_name, def->def.co);
170257378Sbdrewery}
171257378Sbdrewery
172257378Sbdrewery/* print out the definitions for the arguments of functions in the
173257378Sbdrewery    header file
174257378Sbdrewery*/
175257378Sbdrewerystatic void
176257378Sbdrewerypargdef(def)
177257378Sbdrewery	definition *def;
178257378Sbdrewery{
179257378Sbdrewery	decl_list *l;
180257378Sbdrewery	version_list *vers;
181257378Sbdrewery	char *name;
182257378Sbdrewery	proc_list *plist;
183257378Sbdrewery
184257378Sbdrewery
185257378Sbdrewery	for (vers = def->def.pr.versions; vers != NULL; vers = vers->next) {
186257378Sbdrewery			for (plist = vers->procs; plist != NULL;
187257378Sbdrewery			    plist = plist->next) {
188257378Sbdrewery
189257378Sbdrewery				if (!newstyle || plist->arg_num < 2) {
190257378Sbdrewery					continue; /* old style or single args */
191257378Sbdrewery				}
192257378Sbdrewery				name = plist->args.argname;
193257378Sbdrewery				f_print(fout, "struct %s {\n", name);
194257378Sbdrewery				for (l = plist->args.decls;
195257378Sbdrewery				    l != NULL; l = l->next) {
196257378Sbdrewery					pdeclaration(name, &l->decl, 1,
197257378Sbdrewery						     ";\n");
198259266Sbdrewery				}
199259266Sbdrewery				f_print(fout, "};\n");
200259266Sbdrewery				f_print(fout, "typedef struct %s %s;\n",
201257378Sbdrewery					name, name);
202257378Sbdrewery				storexdrfuncdecl(name, 1);
203257378Sbdrewery				f_print(fout, "\n");
204259266Sbdrewery			}
205259266Sbdrewery		}
206259266Sbdrewery}
207257378Sbdrewery
208257378Sbdrewery
209257378Sbdrewerystatic void
210257378Sbdrewerypstructdef(def)
211259266Sbdrewery	definition *def;
212257378Sbdrewery{
213257378Sbdrewery	decl_list *l;
214257378Sbdrewery	char *name = def->def_name;
215257378Sbdrewery
216257378Sbdrewery	f_print(fout, "struct %s {\n", name);
217257378Sbdrewery	for (l = def->def.st.decls; l != NULL; l = l->next) {
218257378Sbdrewery		pdeclaration(name, &l->decl, 1, ";\n");
219257378Sbdrewery	}
220257378Sbdrewery	f_print(fout, "};\n");
221257378Sbdrewery	f_print(fout, "typedef struct %s %s;\n", name, name);
222257378Sbdrewery}
223257378Sbdrewery
224257378Sbdrewerystatic void
225257378Sbdrewerypuniondef(def)
226257378Sbdrewery	definition *def;
227257378Sbdrewery{
228257378Sbdrewery	case_list *l;
229257378Sbdrewery	char *name = def->def_name;
230257378Sbdrewery	declaration *decl;
231257378Sbdrewery
232257378Sbdrewery	f_print(fout, "struct %s {\n", name);
233257378Sbdrewery	decl = &def->def.un.enum_decl;
234257378Sbdrewery	if (streq(decl->type, "bool")) {
235257378Sbdrewery		f_print(fout, "\tbool_t %s;\n", decl->name);
236257378Sbdrewery	} else {
237257378Sbdrewery		f_print(fout, "\t%s %s;\n", decl->type, decl->name);
238257378Sbdrewery	}
239257378Sbdrewery	f_print(fout, "\tunion {\n");
240257378Sbdrewery	for (l = def->def.un.cases; l != NULL; l = l->next) {
241257378Sbdrewery	    if (l->contflag == 0)
242257378Sbdrewery		pdeclaration(name, &l->case_decl, 2, ";\n");
243257378Sbdrewery	}
244257378Sbdrewery	decl = def->def.un.default_decl;
245257378Sbdrewery	if (decl && !streq(decl->type, "void")) {
246257378Sbdrewery		pdeclaration(name, decl, 2, ";\n");
247257378Sbdrewery	}
248257378Sbdrewery	f_print(fout, "\t} %s_u;\n", name);
249257378Sbdrewery	f_print(fout, "};\n");
250257378Sbdrewery	f_print(fout, "typedef struct %s %s;\n", name, name);
251257378Sbdrewery}
252257378Sbdrewery
253257378Sbdrewerystatic void
254257378Sbdrewerypdefine(name, num)
255257378Sbdrewery	char *name;
256257378Sbdrewery	char *num;
257257378Sbdrewery{
258257378Sbdrewery	f_print(fout, "#define\t%s %s\n", name, num);
259257378Sbdrewery}
260257378Sbdrewery
261257378Sbdrewerystatic void
262257378Sbdrewerypuldefine(name, num)
263257378Sbdrewery	char *name;
264257378Sbdrewery	char *num;
265257378Sbdrewery{
266257378Sbdrewery	f_print(fout, "#define\t%s ((unsigned long)(%s))\n", name, num);
267257378Sbdrewery}
268257400Sjoel
269257400Sjoelstatic int
270257378Sbdrewerydefine_printed(stop, start)
271257378Sbdrewery	proc_list *stop;
272257378Sbdrewery	version_list *start;
273257378Sbdrewery{
274257378Sbdrewery	version_list *vers;
275257378Sbdrewery	proc_list *proc;
276257378Sbdrewery
277257378Sbdrewery	for (vers = start; vers != NULL; vers = vers->next) {
278257378Sbdrewery		for (proc = vers->procs; proc != NULL; proc = proc->next) {
279257378Sbdrewery			if (proc == stop) {
280257378Sbdrewery				return (0);
281257378Sbdrewery			} else if (streq(proc->proc_name, stop->proc_name)) {
282				return (1);
283			}
284		}
285	}
286	abort();
287	/* NOTREACHED */
288}
289
290static void
291pfreeprocdef(char * name, char *vers, int mode)
292{
293	f_print(fout, "extern int ");
294	pvname(name, vers);
295	if (mode == 1)
296		f_print(fout,"_freeresult(SVCXPRT *, xdrproc_t, caddr_t);\n");
297	else
298		f_print(fout,"_freeresult();\n");
299
300
301}
302
303static void
304pdispatch(char * name, char *vers, int mode)
305{
306
307	f_print(fout, "void ");
308	pvname(name, vers);
309	if (mode == 1)
310		f_print(fout,
311		    "(struct svc_req *rqstp, register SVCXPRT *transp);\n");
312	else
313		f_print(fout,"();\n");
314
315}
316
317static void
318pprogramdef(def)
319	definition *def;
320{
321	version_list *vers;
322	proc_list *proc;
323	int i;
324	char *ext;
325
326	pargdef(def);
327
328	puldefine(def->def_name, def->def.pr.prog_num);
329	for (vers = def->def.pr.versions; vers != NULL; vers = vers->next) {
330		if (tblflag) {
331			f_print(fout,
332				"extern struct rpcgen_table %s_%s_table[];\n",
333				locase(def->def_name), vers->vers_num);
334			f_print(fout,
335				"extern %s_%s_nproc;\n",
336				locase(def->def_name), vers->vers_num);
337		}
338		puldefine(vers->vers_name, vers->vers_num);
339
340		/*
341		 * Print out 2 definitions, one for ANSI-C, another for
342		 * old K & R C
343		 */
344
345		if(!Cflag){
346			ext = "extern  ";
347			f_print(fout, "%s", ext);
348			pdispatch(def->def_name, vers->vers_num, 2);
349			for (proc = vers->procs; proc != NULL;
350			     proc = proc->next) {
351				if (!define_printed(proc,
352						    def->def.pr.versions)) {
353					puldefine(proc->proc_name,
354						  proc->proc_num);
355				}
356				f_print(fout, "%s", ext);
357				pprocdef(proc, vers, NULL, 0, 2);
358
359				if (mtflag) {
360					f_print(fout, "%s", ext);
361					pprocdef(proc, vers, NULL, 1, 2);
362				}
363			}
364			pfreeprocdef(def->def_name, vers->vers_num, 2);
365
366		} else {
367			for (i = 1; i < 3; i++){
368				if (i == 1){
369					f_print(fout, "\n#if defined(__STDC__) || defined(__cplusplus)\n");
370					ext = "extern  ";
371				}else{
372					f_print(fout, "\n#else /* K&R C */\n");
373					ext = "extern  ";
374				}
375
376				f_print(fout, "%s", ext);
377				pdispatch(def->def_name, vers->vers_num, i);
378				for (proc = vers->procs; proc != NULL;
379				     proc = proc->next) {
380					if (!define_printed(proc,
381							    def->def.pr.versions)) {
382						puldefine(proc->proc_name,
383							  proc->proc_num);
384					}
385					f_print(fout, "%s", ext);
386					pprocdef(proc, vers, "CLIENT *", 0, i);
387					f_print(fout, "%s", ext);
388					pprocdef(proc, vers, "struct svc_req *", 1, i);
389				}
390			pfreeprocdef(def->def_name, vers->vers_num, i);
391			}
392			f_print(fout, "#endif /* K&R C */\n");
393		}
394	}
395}
396
397static void
398pprocdef(proc, vp, addargtype, server_p, mode)
399	proc_list *proc;
400	version_list *vp;
401	char* addargtype;
402	int server_p;
403	int mode;
404{
405	if (mtflag) {/* Print MT style stubs */
406		if (server_p)
407			f_print(fout, "bool_t ");
408		else
409			f_print(fout, "enum clnt_stat ");
410	} else {
411		ptype(proc->res_prefix, proc->res_type, 1);
412		f_print(fout, "* ");
413	}
414	if (server_p)
415		pvname_svc(proc->proc_name, vp->vers_num);
416	else
417		pvname(proc->proc_name, vp->vers_num);
418
419	/*
420	 *  mode  1 = ANSI-C, mode 2 = K&R C
421	 */
422	if ( mode == 1)
423		parglist(proc, addargtype);
424	else
425		f_print(fout, "();\n");
426}
427
428
429
430/* print out argument list of procedure */
431static void
432parglist(proc, addargtype)
433	proc_list *proc;
434    char* addargtype;
435{
436	decl_list *dl;
437
438	f_print(fout, "(");
439	if (proc->arg_num < 2 && newstyle &&
440	    streq(proc->args.decls->decl.type, "void")) {
441		/* 0 argument in new style:  do nothing*/
442	}
443	else {
444		for (dl = proc->args.decls; dl != NULL; dl = dl->next) {
445			ptype(dl->decl.prefix, dl->decl.type, 1);
446			if (!newstyle)
447				f_print(fout, "*");
448			/* old style passes by reference */
449			f_print(fout, ", ");
450		}
451	}
452
453	if (mtflag)  {
454		ptype(proc->res_prefix, proc->res_type, 1);
455		f_print(fout, "*, ");
456	}
457
458	f_print(fout, "%s);\n", addargtype);
459
460}
461
462static void
463penumdef(def)
464	definition *def;
465{
466	char *name = def->def_name;
467	enumval_list *l;
468	char *last = NULL;
469	int count = 0;
470
471	f_print(fout, "enum %s {\n", name);
472	for (l = def->def.en.vals; l != NULL; l = l->next) {
473		f_print(fout, "\t%s", l->name);
474		if (l->assignment) {
475			f_print(fout, " = %s", l->assignment);
476			last = l->assignment;
477			count = 1;
478		} else {
479			if (last == NULL) {
480				f_print(fout, " = %d", count++);
481			} else {
482				f_print(fout, " = %s + %d", last, count++);
483			}
484		}
485		if (l->next)
486			f_print(fout, ",\n");
487		else
488			f_print(fout, "\n");
489	}
490	f_print(fout, "};\n");
491	f_print(fout, "typedef enum %s %s;\n", name, name);
492}
493
494static void
495ptypedef(def)
496	definition *def;
497{
498	char *name = def->def_name;
499	char *old = def->def.ty.old_type;
500	char prefix[8];	/* enough to contain "struct ", including NUL */
501	relation rel = def->def.ty.rel;
502
503
504	if (!streq(name, old)) {
505		if (streq(old, "string")) {
506			old = "char";
507			rel = REL_POINTER;
508		} else if (streq(old, "opaque")) {
509			old = "char";
510		} else if (streq(old, "bool")) {
511			old = "bool_t";
512		}
513		if (undefined2(old, name) && def->def.ty.old_prefix) {
514			s_print(prefix, "%s ", def->def.ty.old_prefix);
515		} else {
516			prefix[0] = 0;
517		}
518		f_print(fout, "typedef ");
519		switch (rel) {
520		case REL_ARRAY:
521			f_print(fout, "struct {\n");
522			f_print(fout, "\tu_int %s_len;\n", name);
523			f_print(fout, "\t%s%s *%s_val;\n", prefix, old, name);
524			f_print(fout, "} %s", name);
525			break;
526		case REL_POINTER:
527			f_print(fout, "%s%s *%s", prefix, old, name);
528			break;
529		case REL_VECTOR:
530			f_print(fout, "%s%s %s[%s]", prefix, old, name,
531				def->def.ty.array_max);
532			break;
533		case REL_ALIAS:
534			f_print(fout, "%s%s %s", prefix, old, name);
535			break;
536		}
537		f_print(fout, ";\n");
538	}
539}
540
541void
542pdeclaration(name, dec, tab, separator)
543	char *name;
544	declaration *dec;
545	int tab;
546	char *separator;
547{
548	char buf[8];	/* enough to hold "struct ", include NUL */
549	char *prefix;
550	char *type;
551
552	if (streq(dec->type, "void")) {
553		return;
554	}
555	tabify(fout, tab);
556	if (streq(dec->type, name) && !dec->prefix) {
557		f_print(fout, "struct ");
558	}
559	if (streq(dec->type, "string")) {
560		f_print(fout, "char *%s", dec->name);
561	} else {
562		prefix = "";
563		if (streq(dec->type, "bool")) {
564			type = "bool_t";
565		} else if (streq(dec->type, "opaque")) {
566			type = "char";
567		} else {
568			if (dec->prefix) {
569				s_print(buf, "%s ", dec->prefix);
570				prefix = buf;
571			}
572			type = dec->type;
573		}
574		switch (dec->rel) {
575		case REL_ALIAS:
576			f_print(fout, "%s%s %s", prefix, type, dec->name);
577			break;
578		case REL_VECTOR:
579			f_print(fout, "%s%s %s[%s]", prefix, type, dec->name,
580				dec->array_max);
581			break;
582		case REL_POINTER:
583			f_print(fout, "%s%s *%s", prefix, type, dec->name);
584			break;
585		case REL_ARRAY:
586			f_print(fout, "struct {\n");
587			tabify(fout, tab);
588			f_print(fout, "\tu_int %s_len;\n", dec->name);
589			tabify(fout, tab);
590			f_print(fout,
591				"\t%s%s *%s_val;\n", prefix, type, dec->name);
592			tabify(fout, tab);
593			f_print(fout, "} %s", dec->name);
594			break;
595		}
596	}
597	f_print(fout, separator);
598}
599
600static int
601undefined2(type, stop)
602	char *type;
603	char *stop;
604{
605	list *l;
606	definition *def;
607
608	for (l = defined; l != NULL; l = l->next) {
609		def = (definition *) l->val;
610		if (def->def_kind != DEF_PROGRAM) {
611			if (streq(def->def_name, stop)) {
612				return (1);
613			} else if (streq(def->def_name, type)) {
614				return (0);
615			}
616		}
617	}
618	return (1);
619}
620