sunrpc/rpc_clntout.c

   1 /*
   2  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   3  * unrestricted use provided that this legend is included on all tape
   4  * media and as a part of the software program in whole or part.  Users
   5  * may copy or modify Sun RPC without charge, but are not authorized
   6  * to license or distribute it to anyone else except as part of a product or
   7  * program developed by the user or with the express written consent of
   8  * Sun Microsystems, Inc.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30
  31 /*
  32  * From: @(#)rpc_clntout.c 1.11 89/02/22 (C) 1987 SMI
  33  */
  34 char clntout_rcsid[] =
  35   "$Id$";
  36
  37 /*
  38  * rpc_clntout.c, Client-stub outputter for the RPC protocol compiler
  39  * Copyright (C) 1987, Sun Microsystems, Inc.
  40  */
  41 #include <stdio.h>
  42 #include <string.h>
  43 #include <rpc/types.h>
  44 #include "rpc_parse.h"
  45 #include "rpc_util.h"
  46 #include "proto.h"
  47
  48 #define DEFAULT_TIMEOUT 25      /* in seconds */
  49 static char RESULT[] = "clnt_res";
  50
  51 static void write_program(definition *def);
  52 static void printbody(proc_list *proc);
  53 static const char *ampr(const char *type);
  54 static void printbody(proc_list *proc);
  55
  56
  57 void
  58 write_stubs(void)
  59 {
  60         list *l;
  61         definition *def;
  62
  63         f_print(fout,
  64                 "\n/* Default timeout can be changed using clnt_control() */\n");
  65         f_print(fout, "static struct timeval TIMEOUT = { %d, 0 };\n",
  66                 DEFAULT_TIMEOUT);
  67         for (l = defined; l != NULL; l = l->next) {
  68                 def = (definition *) l->val;
  69                 if (def->def_kind == DEF_PROGRAM) {
  70                         write_program(def);
  71                 }
  72         }
  73 }
  74
  75 static void
  76 write_program(definition *def)
  77 {
  78         version_list *vp;
  79         proc_list *proc;
  80
  81         for (vp = def->def.pr.versions; vp != NULL; vp = vp->next) {
  82                 for (proc = vp->procs; proc != NULL; proc = proc->next) {
  83                         f_print(fout, "\n");
  84                         ptype(proc->res_prefix, proc->res_type, 1);
  85                         f_print(fout, "*\n");
  86                         pvname(proc->proc_name, vp->vers_num);
  87                         printarglist( proc, "clnt", "CLIENT *" );
  88                         f_print(fout, "{\n");
  89                         printbody(proc);
  90                         f_print(fout, "}\n");
  91                 }
  92         }
  93 }
  94
  95 /* Writes out declarations of procedure's argument list.
  96    In either ANSI C style, in one of old rpcgen style (pass by reference),
  97    or new rpcgen style (multiple arguments, pass by value);
  98    */
  99
 100 /* sample addargname = "clnt"; sample addargtype = "CLIENT * " */
 101
 102 void printarglist(proc_list *proc,
 103                   const char *addargname, const char *addargtype)
 104 {
 105
 106   decl_list *l;
 107
 108   if (!newstyle) {    /* old style: always pass argument by reference */
 109     if (Cflag) {      /* C++ style heading */
 110       f_print(fout, "(");
 111       ptype(proc->args.decls->decl.prefix, proc->args.decls->decl.type, 1);
 112       f_print(fout, "*argp, %s%s)\n", addargtype, addargname );
 113     }
 114     else {
 115       f_print(fout, "(argp, %s)\n", addargname);
 116       f_print(fout, "\t");
 117       ptype(proc->args.decls->decl.prefix, proc->args.decls->decl.type, 1);
 118       f_print(fout, "*argp;\n");
 119     }
 120   } else if (streq( proc->args.decls->decl.type, "void")) {
 121     /* newstyle, 0 argument */
 122     if( Cflag )
 123       f_print(fout, "(%s%s)\n", addargtype, addargname );
 124     else
 125       f_print(fout, "(%s)\n", addargname);
 126   } else {
 127     /* new style, 1 or multiple arguments */
 128     if( !Cflag ) {
 129       f_print(fout, "(");
 130       for (l = proc->args.decls;  l != NULL; l = l->next)
 131         f_print(fout, "%s, ", l->decl.name);
 132       f_print(fout, "%s)\n", addargname );
 133       for (l = proc->args.decls; l != NULL; l = l->next) {
 134         pdeclaration(proc->args.argname, &l->decl, 1, ";\n" );
 135       }
 136     } else {  /* C++ style header */
 137       f_print(fout, "(");
 138       for(l = proc->args.decls; l != NULL; l = l->next) {
 139         pdeclaration(proc->args.argname, &l->decl, 0, ", " );
 140       }
 141       f_print(fout, " %s%s)\n", addargtype, addargname );
 142     }
 143   }
 144
 145   if( !Cflag )
 146     f_print(fout, "\t%s%s;\n", addargtype, addargname );
 147 }
 148
 149
 150
 151 static
 152 const char *
 153 ampr(const char *type)
 154 {
 155         if (isvectordef(type, REL_ALIAS)) {
 156                 return ("");
 157         } else {
 158                 return ("&");
 159         }
 160 }
 161
 162 static void
 163 printbody(proc_list *proc)
 164 {
 165   decl_list *l;
 166   bool_t args2 = (proc->arg_num > 1);
 167 /*  int i; */
 168
 169   /* For new style with multiple arguments, need a structure in which
 170      to stuff the arguments. */
 171         if ( newstyle && args2) {
 172                 f_print(fout, "\t%s", proc->args.argname);
 173                 f_print(fout, " arg;\n");
 174         }
 175         f_print(fout, "\tstatic ");
 176         if (streq(proc->res_type, "void")) {
 177                 f_print(fout, "char ");
 178         } else {
 179                 ptype(proc->res_prefix, proc->res_type, 0);
 180         }
 181         f_print(fout, "%s;\n",RESULT);
 182         f_print(fout, "\n");
 183         f_print(fout, "\tmemset((char *)%s%s, 0, sizeof(%s));\n",
 184                 ampr(proc->res_type ), RESULT, RESULT);
 185         if (newstyle && !args2 && (streq( proc->args.decls->decl.type, "void"))) {
 186           /* newstyle, 0 arguments */
 187           f_print(fout,
 188                     "\tif (clnt_call(clnt, %s, xdr_void", proc->proc_name);
 189           f_print(fout,
 190                   ", NULL, xdr_%s, %s,%s, TIMEOUT) != RPC_SUCCESS) {\n",
 191                   stringfix(proc->res_type), ampr(proc->res_type), RESULT);
 192
 193         } else if ( newstyle && args2) {
 194           /* newstyle, multiple arguments:  stuff arguments into structure */
 195           for (l = proc->args.decls;  l != NULL; l = l->next) {
 196             f_print(fout, "\targ.%s = %s;\n",
 197                     l->decl.name, l->decl.name);
 198           }
 199           f_print(fout,
 200                   "\tif (clnt_call(clnt, %s, xdr_%s", proc->proc_name,
 201                   proc->args.argname);
 202           f_print(fout,
 203                       ", &arg, xdr_%s, %s%s, TIMEOUT) != RPC_SUCCESS) {\n",
 204                   stringfix(proc->res_type), ampr(proc->res_type), RESULT);
 205         } else {  /* single argument, new or old style */
 206               f_print(fout,
 207                       "\tif (clnt_call(clnt, %s, xdr_%s, %s%s, xdr_%s, %s%s, TIMEOUT) != RPC_SUCCESS) {\n",
 208                       proc->proc_name,
 209                       stringfix(proc->args.decls->decl.type),
 210                       (newstyle ? "&" : ""),
 211                       (newstyle ? proc->args.decls->decl.name : "argp"),
 212                       stringfix(proc->res_type), ampr(proc->res_type),RESULT);
 213             }
 214         f_print(fout, "\t\treturn (NULL);\n");
 215         f_print(fout, "\t}\n");
 216         if (streq(proc->res_type, "void")) {
 217                 f_print(fout, "\treturn ((void *)%s%s);\n",
 218                         ampr(proc->res_type),RESULT);
 219         } else {
 220                 f_print(fout, "\treturn (%s%s);\n", ampr(proc->res_type),RESULT);
 221         }
 222 }