tools/gras/unix_stub_generator.c

   1 /*      $Id$     */
   2
   3 /* gras_stub_generator - creates the main() to use a GRAS program           */
   4
   5 /* Copyright (c) 2003-2007 Martin Quinson, Arnaud Legrand, Malek Cherier.   */
   6 /* All rights reserved.                                                     */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 /* specific to Borland Compiler */
  12 #ifdef __BORLANDDC__
  13 #pragma hdrstop
  14 #endif
  15
  16 #include <stdio.h>
  17 #include "xbt/sysdep.h"
  18 #include "xbt/function_types.h"
  19 #include "xbt/log.h"
  20 #include "surf/surfxml_parse.h"
  21 #include "surf/surf.h"
  22 #include "portable.h"           /* Needed for the time of the SIMIX convertion */
  23 #include "gras_stub_generator.h"
  24
  25 #include <stdarg.h>
  26
  27 #ifdef __BORLANDC__
  28 /* stupid stubs so that it compiles on windows */
  29 void generate_sim(char *project)
  30 {
  31 }
  32
  33 void generate_rl(char *project)
  34 {
  35 }
  36
  37 void generate_makefile_local(char *project, char *deployment)
  38 {
  39 }
  40 #else
  41 /* real implementation */
  42 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(stubgen);
  43
  44
  45 #define WARN "/***********\n * DO NOT EDIT! THIS FILE HAS BEEN AUTOMATICALLY GENERATED FROM %s BY gras_stub_generator\n ***********/\n"
  46 #define SIM_SOURCENAME  "_%s_simulator.c"
  47 #define SIM_OBJNAME  "_%s_simulator.o"
  48 #define SIM_BINARYNAME  "%s_simulator"
  49 #define SIM_SOURCENAME_LDADD  "%s_simulator_LDADD"
  50 #define SIM_SOURCENAME_SOURCES  "%s_simulator_SOURCES"
  51 #define RL_SOURCENAME  "_%s_%s.c"
  52 #define RL_OBJNAME  "_%s_%s.o"
  53 #define RL_BINARYNAME  "%s_%s"
  54 #define RL_SOURCENAME_LDADD  "%s_%s_LDADD"
  55 #define RL_SOURCENAME_SOURCES  "%s_%s_SOURCES"
  56 #define MAKEFILE_FILENAME_AM  "%s.Makefile.am"
  57 #define MAKEFILE_FILENAME_LOCAL  "%s.mk"
  58 #define MAKEFILE_FILENAME_REMOTE  "%s.Makefile.remote"
  59 #define DEPLOYMENT  "%s.deploy.sh"
  60
  61 /**********************************************/
  62 /**** Generate the file for the simulator *****/
  63 /**********************************************/
  64
  65 const char *SIM_PREEMBULE =
  66     "/* specific to Borland Compiler */\n"
  67     "#ifdef __BORLANDC__\n"
  68     "#pragma hdrstop\n"
  69     "#endif\n\n"
  70     "#include <stdlib.h>\n"
  71     "#include <stdio.h>\n"
  72     "#include \"msg/msg.h\"\n"
  73     "#include <gras.h>\n" "\n" "char *gras_log=NULL;\n";
  74
  75
  76 #define SIM_LAUNCH_FUNC  \
  77 "int launch_%s(int argc, char **argv) {\n" \
  78 "  char **myargv=argv;\n" \
  79 "  int myargc=argc;\n" \
  80 "  int i;\n" \
  81 "  int retcode;\n"\
  82 "    \n"\
  83 "  if (gras_log) {\n"\
  84 "    myargv=malloc((argc+1) * sizeof(char**));\n" \
  85 "    for (i=0; i<argc; i++)\n" \
  86 "      myargv[i] = argv[i];\n" \
  87 "    myargv[myargc++] = gras_log;\n" \
  88 "  }\n" \
  89 "  retcode = %s(myargc,myargv);\n" \
  90 "  if (myargv != argv)\n" \
  91 "    free(myargv);\n" \
  92 "  return retcode;\n" \
  93 "}\n"
  94
  95 const char *SIM_MAIN_POSTEMBULE = "\n"
  96     "\n"
  97     "  gras_launch_application(argv[2]);\n"
  98     "\n"
  99     "  /*  Run the simulation */\n"
 100     "  gras_main();\n"
 101     "\n"
 102     "  /* cleanup the place */\n"
 103     "  gras_clean();\n"
 104     "  if (gras_log)\n" "    free(gras_log);\n" "  return 0;\n" "}\n";
 105
 106
 107
 108
 109 void generate_sim(char *project)
 110 {
 111   xbt_dict_cursor_t cursor = NULL;
 112   char *key = NULL;
 113   void *data = NULL;
 114   char *filename = NULL;
 115   FILE *FICOUT = NULL;
 116
 117   /* Output file: <projet>_simulator.c */
 118   filename = xbt_new(char, strlen(project) + strlen(SIM_SOURCENAME));
 119   sprintf(filename, SIM_SOURCENAME, project);
 120
 121   FICOUT = fopen(filename, "w");
 122
 123   xbt_assert(FICOUT, "Unable to open %s for writing", filename);
 124
 125   fprintf(FICOUT, "%s\n", warning);
 126   fprintf(FICOUT, "%s", SIM_PREEMBULE);
 127
 128   xbt_dict_foreach(process_function_set, cursor, key, data) {
 129     fprintf(FICOUT, "int %s(int argc,char *argv[]);\n", key);
 130   }
 131
 132   fprintf(FICOUT, "\n");
 133
 134   xbt_dict_foreach(process_function_set, cursor, key, data) {
 135     fprintf(FICOUT, "int launch_%s(int argc,char *argv[]);\n", key);
 136   }
 137
 138   fprintf(FICOUT, "\n%s\n", warning);
 139
 140   xbt_dict_foreach(process_function_set, cursor, key, data) {
 141     fprintf(FICOUT, SIM_LAUNCH_FUNC, key, key);
 142   }
 143   fprintf(FICOUT, "\n%s\n", warning);
 144
 145   fprintf(FICOUT, "%s", "/* specific to Borland Compiler */\n"
 146           "#ifdef __BORLANDDC__\n" "#pragma argsused\n" "#endif\n\n");
 147
 148   fprintf(FICOUT, "%s", "int main (int argc,char *argv[]) {\n"
 149           "\n"
 150           "  /*  Simulation setup */\n"
 151           "  gras_global_init(&argc,argv);\n"
 152           "  if (argc != 3) {\n"
 153           "    fprintf(stderr, \"Usage: %s platform.xml deployment.xml [--log=...]\\n\",argv[0]);\n"
 154           "    exit(1);\n" "  }\n" "\n");
 155   fprintf(FICOUT,
 156           "  gras_create_environment(argv[1]);\n"
 157           "\n" "  /*  Application deployment */\n");
 158   xbt_dict_foreach(process_function_set, cursor, key, data) {
 159     fprintf(FICOUT, "  gras_function_register(\"%s\", launch_%s);\n", key,
 160             key);
 161   }
 162   fprintf(FICOUT, "%s", SIM_MAIN_POSTEMBULE);
 163   fclose(FICOUT);
 164   free(filename);
 165 }
 166
 167 /**********************************************/
 168 /**** Generate the file for the real life *****/
 169 /**********************************************/
 170 void generate_rl(char *project)
 171 {
 172   xbt_dict_cursor_t cursor = NULL;
 173   char *key = NULL;
 174   void *data = NULL;
 175   char *filename = NULL;
 176   FILE *FICOUT = NULL;
 177
 178   xbt_dict_foreach(process_function_set, cursor, key, data) {
 179     filename =
 180         xbt_new(char,
 181                 strlen(project) + strlen(RL_SOURCENAME) + strlen(key));
 182
 183     sprintf(filename, RL_SOURCENAME, project, key);
 184
 185     FICOUT = fopen(filename, "w");
 186     xbt_assert(FICOUT, "Unable to open %s for writing", filename);
 187
 188     fprintf(FICOUT, "\n%s\n", warning);
 189     fprintf(FICOUT, "/* specific to Borland Compiler */\n"
 190             "#ifdef __BORLANDC__\n"
 191             "#pragma hdrstop\n"
 192             "#endif\n\n"
 193             "#include <stdio.h>\n"
 194             "#include <signal.h>\n"
 195             "#include <gras.h>\n"
 196             "\n"
 197             "XBT_PUBLIC_DATA(const char *) _gras_procname;\n"
 198             "/* user code */\n"
 199             "int %s(int argc, char *argv[]);\n"
 200             "\n"
 201             "/* specific to Borland Compiler */\n"
 202             "#ifdef __BORLANDC__\n"
 203             "#pragma argsused\n"
 204             "#endif\n\n"
 205             "int main(int argc, char *argv[]){\n"
 206             "  int errcode;\n"
 207             "\n"
 208             "  _gras_procname = \"%s\";\n"
 209             "  errcode=%s(argc,argv);\n"
 210             " \n" "  return errcode;\n" "}\n", key, key, key);
 211     fprintf(FICOUT, "\n%s\n", warning);
 212     fclose(FICOUT);
 213     free(filename);
 214   }
 215 }
 216
 217 void generate_makefile_am(char *project, char *deployment)
 218 {
 219   xbt_dict_cursor_t cursor = NULL;
 220   char *key = NULL;
 221   void *data = NULL;
 222   char *filename = NULL;
 223   FILE *FICOUT = NULL;
 224
 225   filename = xbt_new(char, strlen(project) + strlen(MAKEFILE_FILENAME_AM));
 226   sprintf(filename, MAKEFILE_FILENAME_AM, project);
 227
 228   FICOUT = fopen(filename, "w");
 229   xbt_assert(FICOUT, "Unable to open %s for writing", filename);
 230
 231   fprintf(FICOUT, "# AUTOMAKE variable definition\n");
 232   fprintf(FICOUT, "INCLUDES= @CFLAGS_SimGrid@\n\n");
 233   fprintf(FICOUT, "PROGRAMS=");
 234   fprintf(FICOUT, SIM_BINARYNAME, project);
 235
 236   xbt_dict_foreach(process_function_set, cursor, key, data) {
 237     fprintf(FICOUT, " ");
 238     fprintf(FICOUT, RL_BINARYNAME, project, key);
 239   }
 240
 241   fprintf(FICOUT, "\n\n");
 242   fprintf(FICOUT, SIM_SOURCENAME_SOURCES, project);
 243   fprintf(FICOUT, "=\t");
 244   fprintf(FICOUT, SIM_SOURCENAME, project);
 245   fprintf(FICOUT, " %s.c\n", project);
 246   fprintf(FICOUT, SIM_SOURCENAME_LDADD, project);
 247   fprintf(FICOUT, "=\tpath/to/libsimgrid.a\n\n");
 248
 249   xbt_dict_foreach(process_function_set, cursor, key, data) {
 250     fprintf(FICOUT, RL_SOURCENAME_SOURCES, project, key);
 251     fprintf(FICOUT, "=\t");
 252     fprintf(FICOUT, RL_SOURCENAME, project, key);
 253     fprintf(FICOUT, " %s.c\n", project);
 254     fprintf(FICOUT, RL_SOURCENAME_LDADD, project, key);
 255     fprintf(FICOUT, "=\tpath/to/libgras.a\n\n");
 256   }
 257
 258   fprintf(FICOUT,
 259           "\n# cleanup temps (allowing the user to add extra clean files)\n");
 260   fprintf(FICOUT, "CLEANFILES?= \n");
 261   fprintf(FICOUT, "CLEANFILES+= ");
 262   fprintf(FICOUT, SIM_SOURCENAME, project);
 263
 264   xbt_dict_foreach(process_function_set, cursor, key, data) {
 265     fprintf(FICOUT, " ");
 266     fprintf(FICOUT, RL_SOURCENAME, project, key);
 267   }
 268   fprintf(FICOUT, "\n");
 269
 270   fprintf(FICOUT, "\n# generate temps\n");
 271   fprintf(FICOUT,
 272           "\n# A rule to generate the source file each time the deployment file changes\n");
 273
 274   xbt_dict_foreach(process_function_set, cursor, key, data) {
 275     fprintf(FICOUT, RL_SOURCENAME, project, key);
 276     fprintf(FICOUT, " ");
 277   }
 278   fprintf(FICOUT, SIM_SOURCENAME, project);
 279   fprintf(FICOUT, ": %s\n", deployment);
 280   fprintf(FICOUT, "\tgras_stub_generator %s %s >/dev/null\n", project,
 281           deployment);
 282   fclose(FICOUT);
 283 }
 284
 285 void generate_makefile_local(char *project, char *deployment)
 286 {
 287   xbt_dict_cursor_t cursor = NULL;
 288   char *key = NULL;
 289   void *data = NULL;
 290   char *filename = NULL;
 291   FILE *FICOUT = NULL;
 292
 293   filename =
 294       xbt_new(char, strlen(project) + strlen(MAKEFILE_FILENAME_LOCAL));
 295   sprintf(filename, MAKEFILE_FILENAME_LOCAL, project);
 296
 297   FICOUT = fopen(filename, "w");
 298   xbt_assert(FICOUT, "Unable to open %s for writing", filename);
 299   free(filename);
 300
 301   fprintf(FICOUT,
 302           "\n"
 303           "####\n"
 304           "#### THIS FILE WAS GENERATED, DO NOT EDIT BEFORE RENAMING IT\n"
 305           "####\n\n\n");
 306
 307   fprintf(FICOUT, "## Variable declarations\n"
 308           "PROJECT_NAME=%s\n" "DISTDIR=gras-$(PROJECT_NAME)\n\n", project);
 309
 310   fprintf(FICOUT,
 311           "# Set the GRAS_ROOT environment variable to the path under which you installed SimGrid\n"
 312           "# Compilation will fail if you don't do so\n"
 313           "GRAS_ROOT?= $(shell if [ -e /usr/local/lib/libgras.so ] ; then echo /usr/local ; else echo \"\\\"<<<< GRAS_ROOT undefined !!! >>>>\\\"\"; fi)\n\n"
 314           "# You can fiddle the following to make it fit your taste\n"
 315           "INCLUDES = -I$(GRAS_ROOT)/include\n"
 316           "CFLAGS ?= -O3 -w -g -Wall\n"
 317           "LIBS_SIM = -lm  -L$(GRAS_ROOT)/lib/ -lsimgrid\n"
 318           "LIBS_RL = -lm  -L$(GRAS_ROOT)/lib/ -lgras\n" "LIBS = \n" "\n");
 319
 320   fprintf(FICOUT, "PRECIOUS_C_FILES ?= %s.c\n", project);
 321
 322   fprintf(FICOUT, "GENERATED_C_FILES = ");
 323   fprintf(FICOUT, SIM_SOURCENAME " ", project);
 324   xbt_dict_foreach(process_function_set, cursor, key, data) {
 325     fprintf(FICOUT, RL_SOURCENAME " ", project, key);
 326   }
 327   fprintf(FICOUT, "\n");
 328
 329   fprintf(FICOUT,
 330           "OBJ_FILES = $(patsubst %%.c,%%.o,$(PRECIOUS_C_FILES))\n");
 331
 332   fprintf(FICOUT, "BIN_FILES = ");
 333
 334   fprintf(FICOUT, SIM_BINARYNAME " ", project);
 335   xbt_dict_foreach(process_function_set, cursor, key, data) {
 336     fprintf(FICOUT, RL_BINARYNAME " ", project, key);
 337   }
 338   fprintf(FICOUT, "\n");
 339
 340   fprintf(FICOUT,
 341           "\n"
 342           "## By default, build all the binaries\n"
 343           "all: $(BIN_FILES)\n" "\n");
 344
 345   fprintf(FICOUT,
 346           "\n## generate temps: regenerate the source file each time the deployment file changes\n");
 347   xbt_dict_foreach(process_function_set, cursor, key, data) {
 348     fprintf(FICOUT, RL_SOURCENAME, project, key);
 349     fprintf(FICOUT, " ");
 350   }
 351   fprintf(FICOUT, SIM_SOURCENAME, project);
 352   fprintf(FICOUT, ": %s\n", deployment);
 353   fprintf(FICOUT, "\tgras_stub_generator %s %s >/dev/null\n", project,
 354           deployment);
 355
 356   fprintf(FICOUT, "\n## Generate the binaries\n");
 357   fprintf(FICOUT, SIM_BINARYNAME ": " SIM_OBJNAME " $(OBJ_FILES)\n",
 358           project, project);
 359   fprintf(FICOUT,
 360           "\t$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS_SIM) $(LIBS) $(LDADD) -o $@ \n");
 361   xbt_dict_foreach(process_function_set, cursor, key, data) {
 362     fprintf(FICOUT, RL_BINARYNAME " : " RL_OBJNAME " $(OBJ_FILES)\n",
 363             project, key, project, key);
 364     fprintf(FICOUT,
 365             "\t$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS_RL) $(LIBS) $(LDADD) -o $@ \n");
 366   }
 367   fprintf(FICOUT,
 368           "\n"
 369           "%%: %%.o\n"
 370           "\t$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@ \n"
 371           "\n"
 372           "%%.o: %%.c\n"
 373           "\t$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<\n" "\n");
 374
 375   fprintf(FICOUT,
 376           "## Rules for tarballs and cleaning\n"
 377           "DIST_FILES= $(EXTRA_DIST) $(GENERATED_C_FILES) $(PRECIOUS_C_FILES) "
 378           MAKEFILE_FILENAME_LOCAL " " /*MAKEFILE_FILENAME_REMOTE */ "\n"
 379           "distdir: $(DIST_FILES)\n" "\trm -rf $(DISTDIR)\n"
 380           "\tmkdir -p $(DISTDIR)\n" "\tcp $^ $(DISTDIR)\n" "\n"
 381           "dist: clean distdir\n"
 382           "\ttar c $(DISTDIR) | gzip -c9 > $(DISTDIR).tar.gz\n" "\n",
 383           project /*, project */ );
 384
 385   fprintf(FICOUT,
 386           "clean:\n"
 387           "\trm -f $(CLEANFILES) $(BIN_FILES) $(OBJ_FILES) *~ %s.o "
 388           SIM_OBJNAME, project, project);
 389   xbt_dict_foreach(process_function_set, cursor, key, data) {
 390     fprintf(FICOUT, " " RL_OBJNAME, project, key);
 391   }
 392   fprintf(FICOUT,
 393           "\n"
 394           "\trm -rf $(DISTDIR)\n"
 395           "\n" ".SUFFIXES:\n" ".PHONY : clean\n" "\n");
 396   /*
 397      fprintf(FICOUT, "############ REMOTE COMPILING #########\n");
 398      fprintf(FICOUT,
 399      "MACHINES ?= ");
 400      xbt_dict_foreach(machine_set,cursor,key,data) {
 401      fprintf(FICOUT, "%s ",key);
 402      }
 403      fprintf(FICOUT,"\n");
 404
 405      fprintf(FICOUT,
 406      "INSTALL_PATH ?='$$HOME/tmp/src' ### Has to be an absolute path !!! \n"
 407      "GRAS_ROOT ?='$(INSTALL_PATH)' ### Has to be an absolute path !!! \n"
 408      "SRCDIR ?= ./\n"
 409      "SIMGRID_URL ?=http://gcl.ucsd.edu/simgrid/dl/\n"
 410      "SIMGRID_VERSION ?=2.92\n"
 411      "GRAS_PROJECT ?= %s\n"
 412      "GRAS_PROJECT_URL ?= http://www-id.imag.fr/Laboratoire/Membres/Legrand_Arnaud/gras_test/\n"
 413      "\n"
 414      "remote:\n"
 415      "\t@echo;echo \"----[ Compile the package on remote hosts ]----\"\n"
 416      "\t@test -e $(SRCDIR)/buildlogs/ || mkdir -p $(SRCDIR)/buildlogs/\n"
 417      "\t for site in $(MACHINES) ; do \\\n"
 418      "\t   machine=`echo $$site |sed 's/^\\([^%%]*\\)%%.*$$/\\1/'`;\\\n"
 419      "\t   machine2=`echo $$site |sed 's/^\\([^%%]*\\)%%\\(.*\\)$$/\\2/'`;\\\n"
 420      "\t   cmd_mkdir=\"\\\"sh -c 'env INSTALL_PATH=$(INSTALL_PATH) GRAS_ROOT=$(GRAS_ROOT) \\\n"
 421      "\t                        SIMGRID_URL=$(SIMGRID_URL) SIMGRID_VERSION=$(SIMGRID_VERSION) GRAS_PROJECT=$(GRAS_PROJECT) \\\n"
 422      "\t                        GRAS_PROJECT_URL=$(GRAS_PROJECT_URL)  mkdir -p $(INSTALL_PATH) 2>&1'\\\"\";\\\n"
 423      "\t   cmd_make=\"\\\"sh -c 'env INSTALL_PATH=$(INSTALL_PATH) GRAS_ROOT=$(GRAS_ROOT) \\\n"
 424      "\t                        SIMGRID_URL=$(SIMGRID_URL) SIMGRID_VERSION=$(SIMGRID_VERSION) GRAS_PROJECT=$(GRAS_PROJECT) \\\n"
 425      "\t                        GRAS_PROJECT_URL=$(GRAS_PROJECT_URL)  make -C $(INSTALL_PATH) -f "MAKEFILE_FILENAME_REMOTE" $(ACTION) 2>&1'\\\"\";\\\n"
 426      "\t   if echo $$site | grep  '%%' >/dev/null ; then \\\n"
 427      "\t     echo \"----[ Compile on $$machine2 (behind $$machine) ]----\";\\\n"
 428      "\t   else \\\n"
 429      "\t     machine=$$site;\\\n"
 430      "\t     echo \"----[ Compile on $$machine ]----\";\\\n"
 431      "\t   fi;\\\n"
 432      "\t   if echo $$site | grep  '%%' >/dev/null ; then \\\n"
 433      "\t     if ssh $$machine \"ssh -A $$machine2 $$cmd_mkdir\" 2>&1 > $(SRCDIR)/buildlogs/$$site.log;\\\n"
 434      "\t     then true; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi;\\\n"
 435      "\t   else \\\n"
 436      "\t     if ssh $$machine \"eval $$cmd_mkdir\" 2>&1 > $(SRCDIR)/buildlogs/$$site.log ;\\\n"
 437      "\t     then true; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi; \\\n"
 438      "\t   fi;\\\n"
 439      "\t   echo \"-- Copy the data over\"; \\\n"
 440      "\t   scp "MAKEFILE_FILENAME_REMOTE" $$site:$(INSTALL_PATH) ;\\\n"
 441      "\t   echo \"-- Compiling... (the output gets into $(SRCDIR)/buildlogs/$$site.log)\"; \\\n"
 442      "\t   if echo $$site | grep  '%%' >/dev/null ; then \\\n"
 443      "\t     if ssh $$machine \"ssh -A $$machine2 $$cmd_make\" 2>&1 >> $(SRCDIR)/buildlogs/$$site.log;\\\n"
 444      "\t     then echo \"Sucessful\"; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi;echo; \\\n"
 445      "\t   else \\\n"
 446      "\t     if ssh $$machine \"eval $$cmd_make\" 2>&1 >> $(SRCDIR)/buildlogs/$$site.log ;\\\n"
 447      "\t     then echo \"Sucessful\"; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi;echo; \\\n"
 448      "\t   fi;\\\n"
 449      "\t done;\n",project,project,project);
 450    */
 451   fclose(FICOUT);
 452 }
 453
 454 static void print(void *p)
 455 {
 456   printf("%p", p);
 457 }
 458 #endif