tools/genmodule/writestubs.c

   1 /*
   2     Copyright © 1995-2014, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Function to write module stubs. Part of genmodule.
   6
   7     Stubs are agregated differently into objects files based on STACK vs REG
   8     convention.
   9
  10     Linker will always put a whole object file from archive into
  11     executable. If all stubs are in one object file, all stubs are present
  12     in executable, inflating its size, even if they are not used.
  13
  14     In majority of cases REG call function stubs will be handled be inlines
  15     or defines while STACK call function stubs will be linked from linklib.
  16
  17     Based on above paragraphs, putting stubs of STACK functions into separate
  18     object files will allow for linker to only include required function stubs.
  19 */
  20
  21 #include "genmodule.h"
  22
  23 static void writeheader(struct config *cfg, int is_rel, FILE *out);
  24 static void writefuncstub(struct config *cfg, int is_rel, FILE *out, struct functionhead *funclistit);
  25
  26 void writestubs(struct config *cfg, int is_rel)
  27 {
  28     FILE *out;
  29     char line[256];
  30     struct functionhead *funclistit;
  31
  32     /* Build STACKCALL - each stub in separate object file */
  33     for (funclistit = cfg->funclist;
  34          funclistit!=NULL;
  35          funclistit = funclistit->next
  36     )
  37     {
  38         if (funclistit->lvo >= cfg->firstlvo && funclistit->libcall == STACK)
  39         {
  40
  41             snprintf(line, 255, "%s/%s_%s_%sstub.c", cfg->gendir, cfg->modulename, funclistit->name, is_rel ? "rel" : "");
  42             out = fopen(line, "w");
  43
  44             if (out == NULL)
  45             {
  46                 perror(line);
  47                 exit(20);
  48             }
  49
  50             writeheader(cfg, is_rel, out);
  51             writefuncstub(cfg, is_rel, out, funclistit);
  52
  53             fclose(out);
  54         }
  55     }
  56
  57     /* Build REGCALL - all stusb in one object file */
  58     snprintf(line, 255, "%s/%s_regcall_%sstubs.c", cfg->gendir, cfg->modulename, is_rel ? "rel" : "");
  59     out = fopen(line, "w");
  60
  61     if (out == NULL)
  62     {
  63         perror(line);
  64         exit(20);
  65     }
  66
  67     writeheader(cfg, is_rel, out);
  68
  69     for (funclistit = cfg->funclist;
  70          funclistit!=NULL;
  71          funclistit = funclistit->next
  72     )
  73     {
  74         if (funclistit->lvo >= cfg->firstlvo && funclistit->libcall != STACK)
  75         {
  76             writefuncstub(cfg, is_rel, out, funclistit);
  77         }
  78     }
  79     fclose(out);
  80
  81 }
  82
  83 static void writeheader(struct config *cfg, int is_rel, FILE *out)
  84 {
  85     struct stringlist *linelistit;
  86     char *banner;
  87
  88     banner = getBanner(cfg);
  89     if (is_rel) {
  90         fprintf
  91         (
  92             out,
  93             "%s"
  94             "#undef  NOLIBINLINE\n"
  95             "#undef  NOLIBDEFINES\n"
  96             "#define NOLIBINLINE\n"
  97             "#define NOLIBDEFINES\n"
  98             "char *__aros_getoffsettable(void);\n"
  99             "#ifndef __%s_NOLIBBASE__\n"
 100             "/* Do not include the libbase */\n"
 101             "#define __%s_NOLIBBASE__\n"
 102             "#endif\n",
 103             banner, cfg->includenameupper, cfg->includenameupper
 104         );
 105     } else {
 106         fprintf
 107         (
 108             out,
 109             "%s"
 110             "#undef  NOLIBINLINE\n"
 111             "#undef  NOLIBDEFINES\n"
 112             "#define NOLIBINLINE\n"
 113             "#define NOLIBDEFINES\n"
 114             "/* Be sure that the libbases are included in the stubs file */\n"
 115             "#undef __NOLIBBASE__\n"
 116             "#undef __%s_NOLIBBASE__\n",
 117             banner, cfg->includenameupper
 118         );
 119     }
 120     freeBanner(banner);
 121
 122     if (!(cfg->options & OPTION_NOINCLUDES))
 123     {
 124         if (is_rel)
 125             fprintf(out, "#define __%s_RELLIBBASE__\n", cfg->includenameupper);
 126         fprintf(out, "#include <proto/%s.h>\n", cfg->includename);
 127     }
 128     else
 129     {
 130         fprintf(out,
 131             "#include <exec/types.h>\n"
 132             "#include <aros/system.h>\n\n"
 133         );
 134
 135         for (linelistit = cfg->cdefprivatelines; linelistit!=NULL; linelistit = linelistit->next)
 136             fprintf(out, "%s\n", linelistit->s);
 137
 138         fprintf(out,
 139             "\n"
 140             "%s__aros_getbase_%s(void);\n"
 141             "\n",
 142             cfg->libbasetypeptrextern, cfg->libbase
 143         );
 144     }
 145
 146     fprintf
 147     (
 148         out,
 149         "#include <stddef.h>\n"
 150         "\n"
 151         "#include <aros/cpu.h>\n"
 152         "#include <aros/genmodule.h>\n"
 153         "#include <aros/libcall.h>\n"
 154         "#include <aros/symbolsets.h>\n"
 155         "\n"
 156     );
 157 }
 158
 159 static void writefuncstub(struct config *cfg, int is_rel, FILE *out, struct functionhead *funclistit)
 160 {
 161     struct stringlist *aliasesit;
 162     struct functionarg *arglistit;
 163     char *type, *name;
 164
 165     if (funclistit->libcall != STACK)
 166     {
 167         int nargs = 0, nquad = 0;
 168         int isvoid = strcmp(funclistit->type, "void") == 0
 169             || strcmp(funclistit->type, "VOID") == 0;
 170
 171         fprintf(out,
 172                 "\n"
 173                 "%s %s(",
 174                 funclistit->type, funclistit->name
 175         );
 176         for (arglistit = funclistit->arguments;
 177              arglistit!=NULL;
 178              arglistit = arglistit->next
 179         )
 180         {
 181             if (arglistit != funclistit->arguments)
 182                 fprintf(out, ", ");
 183             fprintf(out, "%s", arglistit->arg);
 184             if (strchr(arglistit->reg, '/')) {
 185                 nquad++;
 186             } else {
 187                 nargs++;
 188             }
 189         }
 190
 191         fprintf(out,
 192                 ")\n"
 193                 "{\n"
 194         );
 195         if (nquad == 0) {
 196             fprintf(out,
 197                     "    %sAROS_LC%d%s(%s, %s,\n",
 198                     (isvoid) ? "" : "return ",
 199                     funclistit->argcount, (isvoid) ? "NR" : "",
 200                     funclistit->type, funclistit->name
 201             );
 202
 203             for (arglistit = funclistit->arguments;
 204                  arglistit!=NULL;
 205                  arglistit = arglistit->next
 206             )
 207             {
 208                 type = getargtype(arglistit);
 209                 name = getargname(arglistit);
 210                 assert(type != NULL && name != NULL);
 211
 212                 fprintf(out, "                    AROS_LCA(%s,%s,%s),\n",
 213                         type, name, arglistit->reg
 214                 );
 215                 free(type);
 216                 free(name);
 217             }
 218         }
 219         else /* nquad != 0 */
 220         {
 221             if (nargs == 0) {
 222                 fprintf(out,
 223                         "    %sAROS_LCQUAD%d%s(%s, %s, \\\n",
 224                         (isvoid) ? "" : "return ",
 225                         funclistit->argcount, (isvoid) ? "NR" : "",
 226                         funclistit->type, funclistit->name
 227                 );
 228             }
 229             else
 230             {
 231                 fprintf(out,
 232                         "    %sAROS_LC%dQUAD%d%s(%s, %s, \\\n",
 233                         (isvoid) ? "" : "return ",
 234                         nargs, nquad, (isvoid) ? "NR" : "",
 235                         funclistit->type, funclistit->name
 236                 );
 237             }
 238
 239             for (arglistit = funclistit->arguments;
 240                  arglistit != NULL;
 241                  arglistit = arglistit->next
 242             )
 243             {
 244                 char *quad2 = strchr(arglistit->reg, '/');
 245
 246                 type = getargtype(arglistit);
 247                 name = getargname(arglistit);
 248                 assert(type != NULL && name != NULL);
 249
 250                 if (quad2) {
 251                     *quad2 = 0;
 252                     fprintf(out,
 253                             "         AROS_LCAQUAD(%s, %s, %s, %s), \\\n",
 254                             type, name, arglistit->reg, quad2+1
 255                     );
 256                     *quad2 = '/';
 257                 }
 258                 else
 259                 {
 260                     fprintf(out,
 261                             "         AROS_LCA(%s, %s, %s), \\\n",
 262                             type, name, arglistit->reg
 263                     );
 264                 }
 265                 free(type);
 266                 free(name);
 267             }
 268         }
 269
 270         fprintf(out, "                    %s, __aros_getbase_%s(), %u, %s);\n}\n",
 271                 cfg->libbasetypeptrextern, cfg->libbase, funclistit->lvo, cfg->basename
 272         );
 273     }
 274     else /* libcall==STACK */
 275     {
 276         /* Library version requirement added only for stack call functions
 277          * since each function is in separate compilation unit. Reg call
 278          * functions are all in one compilation unit. In such case highest
 279          * version would alway be required even if function for that version
 280          * is not used.
 281          */
 282         fprintf(out, "void __%s_%s_libreq(){ AROS_LIBREQ(%s,%d); }\n",
 283                 funclistit->name, cfg->libbase, cfg->libbase, funclistit->version
 284         );
 285
 286         fprintf(out, "AROS_GM_%sLIBFUNCSTUB(%s, %s, %d)\n",
 287                 is_rel ? "REL" : "",
 288                 funclistit->name, cfg->libbase, funclistit->lvo
 289         );
 290     }
 291
 292     for (aliasesit = funclistit->aliases;
 293          aliasesit != NULL;
 294          aliasesit = aliasesit->next
 295     )
 296     {
 297         fprintf(out, "AROS_GM_LIBFUNCALIAS(%s, %s)\n",
 298                 funclistit->name, aliasesit->s
 299         );
 300     }
 301 }