tools/gras/stub_generator.c

   1 /*      $Id$     */
   2
   3 /* gras_stub_generator - creates the main() to use a GRAS program           */
   4
   5 /* Copyright (c) 2003,2004,2005 Martin Quinson, Arnaud Legrand.
   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 #include"xbt/sysdep.h"
  12 #include"xbt/dict.h"
  13 #include"xbt/error.h"
  14 #include "surf/surf_parse.h"
  15 #include "surf/surf.h"
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(stubgen,gras,"Stub generator");
  18
  19 #define WARN "/***********\n * DO NOT EDIT! THIS FILE HAS BEEN AUTOMATICALLY GENERATED FROM %s BY gras_stub_generator\n ***********/\n"
  20 #define SIM_SOURCENAME  "_%s_simulator.c"
  21 #define SIM_OBJNAME  "_%s_simulator.o"
  22 #define SIM_BINARYNAME  "%s_simulator"
  23 #define SIM_SOURCENAME_LDADD  "%s_simulator_LDADD"
  24 #define SIM_SOURCENAME_SOURCES  "%s_simulator_SOURCES"
  25 #define RL_SOURCENAME  "_%s_%s.c"
  26 #define RL_OBJNAME  "_%s_%s.o"
  27 #define RL_BINARYNAME  "%s_%s"
  28 #define RL_SOURCENAME_LDADD  "%s_%s_LDADD"
  29 #define RL_SOURCENAME_SOURCES  "%s_%s_SOURCES"
  30 #define MAKEFILE_FILENAME_AM  "%s.Makefile.am"
  31 #define MAKEFILE_FILENAME_LOCAL  "%s.Makefile.local"
  32 #define MAKEFILE_FILENAME_REMOTE  "%s.Makefile.remote"
  33
  34 char *warning = NULL;
  35
  36 /**********************************************/
  37 /**** Generate the file for the simulator *****/
  38 /**********************************************/
  39
  40 const char *SIM_PREEMBULE =
  41 "#include <stdlib.h>\n"
  42 "#include <stdio.h>\n"
  43 "#include \"msg/msg.h\"\n"
  44 "#include <gras.h>\n"
  45 "\n"
  46 "char *gras_log=NULL;\n";
  47
  48
  49 #define SIM_LAUNCH_FUNC  \
  50 "int launch_%s(int argc, char **argv) {\n" \
  51 "  char **myargv=argv;\n" \
  52 "  int myargc=argc;\n" \
  53 "  int i;\n" \
  54 "  int retcode;\n"\
  55 "    \n"\
  56 "  if (gras_log) {\n"\
  57 "    myargv=malloc((argc+1) * sizeof(char**));\n" \
  58 "    for (i=0; i<argc; i++)\n" \
  59 "      myargv[i] = argv[i];\n" \
  60 "    myargv[myargc++] = gras_log;\n" \
  61 "  }\n" \
  62 "  retcode = %s(myargc,myargv);\n" \
  63 "  if (myargv != argv)\n" \
  64 "    free(myargv);\n" \
  65 "  return retcode;\n" \
  66 "}\n"
  67
  68 const char* SIM_MAIN_PREEMBULE =
  69 "int main (int argc,char *argv[]) {\n"
  70 "  int i,j;\n"
  71 "\n"
  72 "  /*  Simulation setup */\n"
  73 "  MSG_global_init_args(&argc,argv);\n"
  74 "  if (argc != 3) {\n"
  75 "    fprintf(stderr, \"Usage: %s platform_file application_description.txt [--gras-log=...]\\n\",argv[0]);\n"
  76 "    exit(1);\n"
  77 "  }\n"
  78 "\n"
  79 "  MSG_set_channel_number(10); // GRAS_MAX_CHANNEL hardcoded since Alvin killed its definition\n"
  80 "  MSG_create_environment(argv[1]);\n"
  81 "\n"
  82 "  /*  Application deployment */\n";
  83
  84 const char *SIM_MAIN_POSTEMBULE = "\n"
  85 "\n"
  86 "  MSG_launch_application(argv[2]);\n"
  87 "\n"
  88 "  /*  Run the simulation */\n"
  89 "  MSG_main();\n"
  90 "\n"
  91 "  /* cleanup the place */\n"
  92 "  MSG_clean();\n"
  93 "  if (gras_log)\n"
  94 "    free(gras_log);\n"
  95 "  return 0;\n"
  96 "}\n";
  97
  98 /**********************************************/
  99 /**** Generate the file for the real life *****/
 100 /**********************************************/
 101
 102 #define RL_CODE \
 103 "#include <stdio.h>\n" \
 104 "#include <signal.h>\n" \
 105 "#include <gras.h>\n" \
 106 "\n" \
 107 "/* user code */\n" \
 108 "int %s(int argc, char *argv[]);\n" \
 109 "\n" \
 110 "int main(int argc, char *argv[]){\n" \
 111 "  int errcode;\n" \
 112 "\n" \
 113 "  errcode=%s(argc,argv);\n"\
 114 " \n" \
 115 "  return errcode;\n"\
 116 "}\n"
 117
 118 /**********************************************/
 119 /********* Parse XML deployment file **********/
 120 /**********************************************/
 121 xbt_dict_t process_function_set = NULL;
 122
 123 static void parse_process_init(void)
 124 {
 125   void *p = (void *) 1234;
 126   xbt_dict_set(process_function_set, A_process_function, p, NULL);
 127 }
 128
 129 static void generate_sim(char *project)
 130 {
 131   xbt_dict_cursor_t cursor=NULL;
 132   char *key = NULL;
 133   void *data = NULL;
 134   char *filename = NULL;
 135   FILE *OUT = NULL;
 136   filename = xbt_new(char,strlen(project) + strlen(SIM_SOURCENAME));
 137   sprintf(filename,SIM_SOURCENAME,project);
 138
 139   OUT=fopen(filename,"w");
 140   xbt_assert1(OUT, "Unable to open %s for writing",filename);
 141
 142   fprintf(OUT, "%s\n",warning);
 143   fprintf(OUT, "%s", SIM_PREEMBULE);
 144   xbt_dict_foreach(process_function_set,cursor,key,data) {
 145     fprintf(OUT,"int %s(int argc,char *argv[]);\n",key);
 146   }
 147   fprintf(OUT,"\n");
 148   xbt_dict_foreach(process_function_set,cursor,key,data) {
 149     fprintf(OUT,"int launch_%s(int argc,char *argv[]);\n",key);
 150   }
 151   fprintf(OUT, "\n%s\n",warning);
 152   xbt_dict_foreach(process_function_set,cursor,key,data) {
 153     fprintf(OUT,SIM_LAUNCH_FUNC,key,key);
 154   }
 155   fprintf(OUT, "\n%s\n",warning);
 156
 157   fprintf(OUT, "%s", SIM_MAIN_PREEMBULE);
 158   xbt_dict_foreach(process_function_set,cursor,key,data) {
 159     fprintf(OUT,"  MSG_function_register(\"%s\", launch_%s);\n",key,key);
 160   }
 161   fprintf(OUT, "%s", SIM_MAIN_POSTEMBULE);
 162   fclose(OUT);
 163   free(filename);
 164 }
 165
 166 static void generate_rl(char *project)
 167 {
 168   xbt_dict_cursor_t cursor=NULL;
 169   char *key = NULL;
 170   void *data = NULL;
 171   char *filename = NULL;
 172   FILE *OUT = NULL;
 173
 174   xbt_dict_foreach(process_function_set,cursor,key,data) {
 175     filename = xbt_new(char,strlen(project) + strlen(RL_SOURCENAME) + strlen(key));
 176     sprintf(filename,RL_SOURCENAME,project,key);
 177
 178     OUT=fopen(filename,"w");
 179     xbt_assert1(OUT, "Unable to open %s for writing",filename);
 180
 181     fprintf(OUT, "\n%s\n",warning);
 182     fprintf(OUT, RL_CODE, key,key);
 183     fprintf(OUT, "\n%s\n",warning);
 184     fclose(OUT);
 185     free(filename);
 186   }
 187 }
 188
 189 static void generate_makefile_am(char *project, char *deployment)
 190 {
 191   xbt_dict_cursor_t cursor=NULL;
 192   char *key = NULL;
 193   void *data = NULL;
 194   char *filename = NULL;
 195   FILE *OUT = NULL;
 196
 197   filename = xbt_new(char,strlen(project) + strlen(MAKEFILE_FILENAME_AM));
 198   sprintf(filename,MAKEFILE_FILENAME_AM, project);
 199
 200   OUT=fopen(filename,"w");
 201   xbt_assert1(OUT, "Unable to open %s for writing",filename);
 202
 203   fprintf(OUT, "# AUTOMAKE variable definition\n");
 204   fprintf(OUT, "INCLUDES= @CFLAGS_SimGrid@\n\n");
 205   fprintf(OUT, "PROGRAMS=");
 206   fprintf(OUT, SIM_BINARYNAME,project);
 207
 208   xbt_dict_foreach(process_function_set,cursor,key,data) {
 209     fprintf(OUT, " ");
 210     fprintf(OUT, RL_BINARYNAME, project, key);
 211   }
 212
 213   fprintf(OUT, "\n\n");
 214   fprintf(OUT, SIM_SOURCENAME_SOURCES,project);
 215   fprintf(OUT, "=\t");
 216   fprintf(OUT, SIM_SOURCENAME,project);
 217   fprintf(OUT, " %s.c\n", project);
 218   fprintf(OUT, SIM_SOURCENAME_LDADD, project);
 219   fprintf(OUT, "=\tpath/to/libsimgrid.a\n\n");
 220
 221   xbt_dict_foreach(process_function_set,cursor,key,data) {
 222     fprintf(OUT, RL_SOURCENAME_SOURCES, project,key);
 223     fprintf(OUT, "=\t");
 224     fprintf(OUT, RL_SOURCENAME, project,key);
 225     fprintf(OUT, " %s.c\n", project);
 226     fprintf(OUT, RL_SOURCENAME_LDADD, project, key);
 227     fprintf(OUT, "=\tpath/to/libgras.a\n\n");
 228   }
 229
 230   fprintf(OUT, "\n# cleanup temps\n");
 231   fprintf(OUT, "CLEANFILES= ");
 232   fprintf(OUT, SIM_SOURCENAME, project);
 233
 234   xbt_dict_foreach(process_function_set,cursor,key,data) {
 235     fprintf(OUT, " ");
 236     fprintf(OUT, RL_SOURCENAME, project,key);
 237   }
 238   fprintf(OUT, "\n");
 239
 240   fprintf(OUT, "\n# generate temps\n");
 241   fprintf(OUT, "\n# A rule to generate the source file each time the deployment file changes\n");
 242
 243   xbt_dict_foreach(process_function_set,cursor,key,data) {
 244     fprintf(OUT, RL_SOURCENAME, project,key);
 245     fprintf(OUT, " ");
 246   }
 247   fprintf(OUT, SIM_SOURCENAME, project);
 248   fprintf(OUT, ": %s\n", deployment);
 249   fprintf(OUT, "\tstub_generator %s %s >/dev/null\n", project, deployment);
 250   fclose(OUT);
 251 }
 252
 253
 254 static void generate_makefile_local(char *project, char *deployment)
 255 {
 256   xbt_dict_cursor_t cursor=NULL;
 257   char *key = NULL;
 258   void *data = NULL;
 259   char *filename = NULL;
 260   FILE *OUT = NULL;
 261
 262   filename = xbt_new(char,strlen(project) + strlen(MAKEFILE_FILENAME_LOCAL));
 263   sprintf(filename,MAKEFILE_FILENAME_LOCAL, project);
 264
 265   OUT=fopen(filename,"w");
 266   xbt_assert1(OUT, "Unable to open %s for writing",filename);
 267
 268   fprintf(OUT, "############ PROJECT COMPILING AND ARCHIVING #########\n");
 269   fprintf(OUT, "PROJECT_NAME=%s\n",project);
 270   fprintf(OUT,
 271           "DISTDIR=gras-$(PROJECT_NAME)\n\n"
 272           "SIMGRID_INSTALL_PATH?= $(shell echo \"\\\"<<<< SIMGRID_INSTALL_PATH undefined !!! >>>>\\\"\")\n"
 273           "CFLAGS = -O3 -w\n"
 274           "INCLUDES = -I$(SIMGRID_INSTALL_PATH)/include\n"
 275           "LIBS = -lm  -L$(SIMGRID_INSTALL_PATH)/lib/ -lsimgrid\n"
 276           "\n");
 277
 278   fprintf(OUT, "C_FILES = ");
 279   fprintf(OUT, SIM_SOURCENAME" ",project);
 280   xbt_dict_foreach(process_function_set,cursor,key,data) {
 281     fprintf(OUT, RL_SOURCENAME " ",project, key);
 282   }
 283   fprintf(OUT, "%s.c\n", project);
 284
 285   fprintf(OUT,"OBJ_FILES = \n");
 286
 287   fprintf(OUT, "BIN_FILES = ");
 288
 289   fprintf(OUT, SIM_BINARYNAME " ",project);
 290   xbt_dict_foreach(process_function_set,cursor,key,data) {
 291     fprintf(OUT, RL_BINARYNAME " ", project, key);
 292   }
 293   fprintf(OUT, "\n");
 294
 295   fprintf(OUT,
 296           "\n"
 297           "all: $(BIN_FILES)\n"
 298           "\n");
 299   fprintf(OUT, SIM_BINARYNAME ": " SIM_OBJNAME " %s.c\n",project, project, project);
 300   xbt_dict_foreach(process_function_set,cursor,key,data) {
 301     fprintf(OUT, RL_BINARYNAME " : " RL_OBJNAME " %s.c\n", project, key, project, key, project);
 302   }
 303   fprintf(OUT,
 304           "\n"
 305           "%%: %%.o\n"
 306           "\t$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@ \n"
 307           "\n"
 308           "%%.o: %%.c\n"
 309           "\t$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<\n"
 310           "\n"
 311           "DIST_FILES= $(C_FILES) "MAKEFILE_FILENAME_LOCAL" "MAKEFILE_FILENAME_REMOTE"\n"
 312           "distdir: $(DIST_FILES)\n"
 313           "\trm -rf $(DISTDIR)\n"
 314           "\tmkdir -p $(DISTDIR)\n"
 315           "\tcp $^ $(DISTDIR)\n"
 316           "\n"
 317           "dist: clean distdir\n"
 318           "\ttar c $(DISTDIR) | gzip -c > $(DISTDIR).tar.gz\n"
 319           "\n"
 320           "clean:\n"
 321           "\trm -f $(BIN_FILES) $(OBJ_FILES) *~\n"
 322           "\trm -rf $(DISTDIR)\n"
 323           "\n"
 324           ".SUFFIXES:\n"
 325           ".PHONY : clean\n"
 326           "\n", project, project);
 327
 328   fprintf(OUT, "############ REMOTE COMPILING #########\n");
 329   fprintf(OUT,
 330           "MACHINES ?= varekai.ucsd.edu sideshow.ucsd.edu dralion.ucsd.edu\n"
 331           "INSTALL_PATH ?='$$HOME/tmp/src' ### Has to be an absolute path !!! \n"
 332           "SRCDIR ?= ./\n"
 333           "SIMGRID_VERSION ?=2.91\n"
 334           "GRAS_PROJECT ?= %s\n"
 335           "GRAS_PROJECT_URL ?= http://www-id.imag.fr/Laboratoire/Membres/Legrand_Arnaud/gras_test/\n"
 336           "\n"
 337           "remote:\n"
 338           "\t@echo;echo \"----[ Compile the package on remote hosts ]----\"\n"
 339           "\t@test -e $(SRCDIR)/buildlogs/ || mkdir -p $(SRCDIR)/buildlogs/\n"
 340           "\t for site in $(MACHINES) ; do \\\n"
 341           "\t   machine=`echo $$site |sed 's/^\\([^%%]*\\)%%.*$$/\\1/'`;\\\n"
 342           "\t   machine2=`echo $$site |sed 's/^\\([^%%]*\\)%%\\(.*\\)$$/\\2/'`;\\\n"
 343           "\t   cmd_mkdir=\"\\\"sh -c 'env INSTALL_PATH=$(INSTALL_PATH) SIMGRID_INSTALL_PATH=$(INSTALL_PATH) \\\n"
 344           "\t                        SIMGRID_VERSION=$(SIMGRID_VERSION) GRAS_PROJECT=$(GRAS_PROJECT) \\\n"
 345           "\t                        GRAS_PROJECT_URL=$(GRAS_PROJECT_URL)  mkdir -p $(INSTALL_PATH) 2>&1'\\\"\";\\\n"
 346           "\t   cmd_make=\"\\\"sh -c 'env INSTALL_PATH=$(INSTALL_PATH) SIMGRID_INSTALL_PATH=$(INSTALL_PATH) \\\n"
 347           "\t                        SIMGRID_VERSION=$(SIMGRID_VERSION) GRAS_PROJECT=$(GRAS_PROJECT) \\\n"
 348           "\t                        GRAS_PROJECT_URL=$(GRAS_PROJECT_URL)  make -C $(INSTALL_PATH) -f "MAKEFILE_FILENAME_REMOTE" $(ACTION) 2>&1'\\\"\";\\\n"
 349           "\t   if echo $$site | grep  '%%' >/dev/null ; then \\\n"
 350           "\t     echo \"----[ Compile on $$machine2 (behind $$machine) ]----\";\\\n"
 351           "\t   else \\\n"
 352           "\t     machine=$$site;\\\n"
 353           "\t     echo \"----[ Compile on $$machine ]----\";\\\n"
 354           "\t   fi;\\\n"
 355           "\t   if echo $$site | grep  '%%' >/dev/null ; then \\\n"
 356           "\t     if ssh $$machine \"ssh -A $$machine2 $$cmd_mkdir\" 2>&1 > $(SRCDIR)/buildlogs/$$site.log;\\\n"
 357           "\t     then true; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi;\\\n"
 358           "\t   else \\\n"
 359           "\t     if ssh $$machine \"eval $$cmd_mkdir\" 2>&1 > $(SRCDIR)/buildlogs/$$site.log ;\\\n"
 360           "\t     then true; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi; \\\n"
 361           "\t   fi;\\\n"
 362           "\t   echo \"-- Copy the data over\"; \\\n"
 363           "\t   scp "MAKEFILE_FILENAME_REMOTE" $$site:$(INSTALL_PATH) ;\\\n"
 364           "\t   echo \"-- Compiling... (the output gets into $(SRCDIR)/buildlogs/$$site.log)\"; \\\n"
 365           "\t   if echo $$site | grep  '%%' >/dev/null ; then \\\n"
 366           "\t     if ssh $$machine \"ssh -A $$machine2 $$cmd_make\" 2>&1 >> $(SRCDIR)/buildlogs/$$site.log;\\\n"
 367           "\t     then echo \"Sucessful\"; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi;echo; \\\n"
 368           "\t   else \\\n"
 369           "\t     if ssh $$machine \"eval $$cmd_make\" 2>&1 >> $(SRCDIR)/buildlogs/$$site.log ;\\\n"
 370           "\t     then echo \"Sucessful\"; else failed=1;echo \"Failed (check $(SRCDIR)/buildlogs/$$site.log)\"; fi;echo; \\\n"
 371           "\t   fi;\\\n"
 372           "\t done;\n",project,project,project);
 373
 374   fclose(OUT);
 375 }
 376
 377 static void generate_makefile_remote(char *project, char *deployment)
 378 {
 379   xbt_dict_cursor_t cursor=NULL;
 380   char *key = NULL;
 381   void *data = NULL;
 382   char *filename = NULL;
 383   FILE *OUT = NULL;
 384
 385   filename = xbt_new(char,strlen(project) + strlen(MAKEFILE_FILENAME_REMOTE));
 386   sprintf(filename,MAKEFILE_FILENAME_REMOTE, project);
 387
 388   OUT=fopen(filename,"w");
 389   xbt_assert1(OUT, "Unable to open %s for writing",filename);
 390
 391   fprintf(OUT,
 392           "INSTALL_PATH ?= $(shell pwd)\n"
 393           "\n"
 394           "simgrid-$(SIMGRID_VERSION).tar.gz:\n"
 395           "\twget -N http://gcl.ucsd.edu/simgrid/dl/simgrid-$(SIMGRID_VERSION).tar.gz\n"
 396           "simgrid-$(SIMGRID_VERSION)/: simgrid-$(SIMGRID_VERSION).tar.gz\n"
 397           "\ttar zxf $<\n"
 398           "\tcd simgrid-$(SIMGRID_VERSION)/; \\\n"
 399           "\t   ./configure --prefix=$(INSTALL_PATH) ; \\\n"
 400           "\t   make all install\n"
 401           "compile-simgrid: simgrid-$(SIMGRID_VERSION)\n"
 402           "\n"
 403           "gras-$(GRAS_PROJECT).tar.gz:\n"
 404           "\twget -N $(GRAS_PROJECT_URL)/gras-$(GRAS_PROJECT).tar.gz\n"
 405           "gras-$(GRAS_PROJECT)/: gras-$(GRAS_PROJECT).tar.gz\n"
 406           "\ttar zxf $<\n"
 407           "\tmake -C gras-$(GRAS_PROJECT)/ -f $(GRAS_PROJECT).Makefile.local all\n"
 408           "compile-gras compile-gras-$(GRAS_PROJECT): gras-$(GRAS_PROJECT) compile-simgrid\n"
 409           "\n"
 410           "clean-simgrid:\n"
 411           "\trm -rf simgrid-$(SIMGRID_VERSION)*\n"
 412           "clean-gras clean-gras-$(GRAS_PROJECT):\n"
 413           "\trm -rf gras-$(GRAS_PROJECT)*\n"
 414           "clean: clean-simgrid clean-gras-$(GRAS_PROJECT)\n"
 415           "\n"
 416           ".PHONY: clean clean-simgrid clean-gras-$(GRAS_PROJECT) compile-simgrid compile-gras-$(GRAS_PROJECT)\n"
 417           "\n");
 418   fclose(OUT);
 419 }
 420
 421 static void print(void *p)
 422 {
 423   printf("%p",p);
 424 }
 425
 426 int main(int argc, char *argv[])
 427 {
 428   char *project_name = NULL;
 429   char *deployment_file = NULL;
 430
 431   surf_init(&argc, argv);
 432
 433   xbt_assert1((argc ==3),"Usage: %s project_name deployment_file\n",argv[0]);
 434
 435   project_name = argv[1];
 436   deployment_file = argv[2];
 437
 438   process_function_set = xbt_dict_new();
 439
 440   STag_process_fun = parse_process_init;
 441   surf_parse_open(deployment_file);
 442   if(surf_parse()) xbt_assert1(0,"Parse error in %s",deployment_file);
 443   surf_parse_close();
 444
 445   warning = xbt_new(char,strlen(WARN)+strlen(deployment_file)+10);
 446   sprintf(warning,WARN,deployment_file);
 447
 448   if(XBT_LOG_ISENABLED(stubgen, xbt_log_priority_debug)) {
 449     xbt_dict_cursor_t cursor=NULL;
 450     char *key = NULL;
 451     void *data = NULL;
 452
 453     for (cursor=NULL, xbt_dict_cursor_first((process_function_set),&(cursor)) ;
 454          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));
 455          xbt_dict_cursor_step(cursor) ) {
 456       DEBUG1("Function %s", key);
 457     }
 458
 459     xbt_dict_dump(process_function_set,print);
 460   }
 461
 462   generate_sim(project_name);
 463   generate_rl(project_name);
 464   generate_makefile_local(project_name, deployment_file);
 465   generate_makefile_remote(project_name, deployment_file);
 466
 467   free(warning);
 468   return 0;
 469 }