src/simix/smx_deployment.c

   1 /* Copyright (c) 2007, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7
   8 #include "private.h"
   9 #include "xbt/sysdep.h"
  10 #include "xbt/log.h"
  11 #include "xbt/dict.h"
  12 #include "surf/surfxml_parse_private.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_deployment, simix,
  15                                 "Logging specific to SIMIX (deployment)");
  16 static int parse_argc = -1;
  17 static char **parse_argv = NULL;
  18 static xbt_main_func_t parse_code = NULL;
  19 static char *parse_host = NULL;
  20 static double start_time = 0.0;
  21 static double kill_time = -1.0;
  22
  23 static void parse_process_init(void)
  24 {
  25   parse_host = xbt_strdup(A_surfxml_process_host);
  26   xbt_assert1(SIMIX_host_get_by_name(parse_host),
  27               "Host '%s' unknown", parse_host);
  28   parse_code = SIMIX_get_registered_function(A_surfxml_process_function);
  29   xbt_assert1(parse_code, "Function '%s' unknown",
  30               A_surfxml_process_function);
  31   parse_argc = 0;
  32   parse_argv = NULL;
  33   parse_argc++;
  34   parse_argv = xbt_realloc(parse_argv, (parse_argc) * sizeof(char *));
  35   parse_argv[(parse_argc) - 1] = xbt_strdup(A_surfxml_process_function);
  36   surf_parse_get_double(&start_time, A_surfxml_process_start_time);
  37   surf_parse_get_double(&kill_time, A_surfxml_process_kill_time);
  38
  39   current_property_set = xbt_dict_new();
  40 }
  41
  42 static void parse_argument(void)
  43 {
  44   parse_argc++;
  45   parse_argv = xbt_realloc(parse_argv, (parse_argc) * sizeof(char *));
  46   parse_argv[(parse_argc) - 1] = xbt_strdup(A_surfxml_argument_value);
  47 }
  48
  49 static void parse_process_finalize(void)
  50 {
  51   smx_process_arg_t arg = NULL;
  52   void *process = NULL;
  53   if (start_time > SIMIX_get_clock()) {
  54     arg = xbt_new0(s_smx_process_arg_t, 1);
  55     arg->name = parse_argv[0];
  56     arg->code = parse_code;
  57     arg->data = NULL;
  58     arg->hostname = parse_host;
  59     arg->argc = parse_argc;
  60     arg->argv = parse_argv;
  61     arg->kill_time = kill_time;
  62     arg->properties = current_property_set;
  63
  64     DEBUG3("Process %s(%s) will be started at time %f", arg->name,
  65            arg->hostname, start_time);
  66     SIMIX_timer_set(start_time, &SIMIX_process_create_from_wrapper, arg);
  67   } else {                      // start_time <= SIMIX_get_clock()
  68     DEBUG2("Starting Process %s(%s) right now", parse_argv[0], parse_host);
  69
  70     if (simix_global->create_process_function)
  71       process =
  72           (*simix_global->create_process_function) (parse_argv[0],
  73                                                     parse_code, NULL,
  74                                                     parse_host, parse_argc,
  75                                                     parse_argv,
  76                                                     /*the props */
  77                                                     current_property_set);
  78     else
  79       process = SIMIX_process_create(parse_argv[0], parse_code, NULL, parse_host, parse_argc, parse_argv,       /*the props */
  80                                      current_property_set);
  81     /* verify if process has been created (won't be the case if the host is currently dead, but that's fine) */
  82     if (!process) {
  83       xbt_free(parse_host);
  84       return;
  85     }
  86     if (kill_time > SIMIX_get_clock()) {
  87       if (simix_global->kill_process_function)
  88         SIMIX_timer_set(start_time, simix_global->kill_process_function, process);
  89       else
  90         SIMIX_timer_set(start_time, &SIMIX_process_kill, process);
  91     }
  92     xbt_free(parse_host);
  93   }
  94 }
  95
  96 /**
  97  * \brief An application deployer.
  98  *
  99  * Creates the process described in \a file.
 100  * \param file a filename of a xml description of the application. This file
 101  * follows this DTD :
 102  *
 103  *     \include surfxml.dtd
 104  *
 105  * Here is a small example of such a platform
 106  *
 107  *     \include small_deployment.xml
 108  *
 109  */
 110 void SIMIX_launch_application(const char *file)
 111 {
 112   int parse_status;
 113   xbt_assert0(simix_global,
 114               "SIMIX_global_init has to be called before SIMIX_launch_application.");
 115   surf_parse_reset_parser();
 116   surfxml_add_callback(STag_surfxml_process_cb_list, parse_process_init);
 117   surfxml_add_callback(ETag_surfxml_argument_cb_list, parse_argument);
 118   surfxml_add_callback(STag_surfxml_prop_cb_list, parse_properties);
 119   surfxml_add_callback(ETag_surfxml_process_cb_list,
 120                        parse_process_finalize);
 121
 122   surf_parse_open(file);
 123   parse_status = surf_parse();
 124   surf_parse_close();
 125   xbt_assert1(!parse_status, "Parse error in %s", file);
 126 }
 127
 128 /**
 129  * \brief Registers a #smx_process_code_t code in a global table.
 130  *
 131  * Registers a code function in a global table.
 132  * This table is then used by #SIMIX_launch_application.
 133  * \param name the reference name of the function.
 134  * \param code the function
 135  */
 136 XBT_INLINE void SIMIX_function_register(const char *name,
 137                                         xbt_main_func_t code)
 138 {
 139   xbt_assert0(simix_global,
 140               "SIMIX_global_init has to be called before SIMIX_function_register.");
 141
 142   xbt_dict_set(simix_global->registered_functions, name, code, NULL);
 143 }
 144
 145 static xbt_main_func_t default_function = NULL;
 146 /**
 147  * \brief Registers a #smx_process_code_t code as default value.
 148  *
 149  * Registers a code function as being the default value. This function will get used by SIMIX_launch_application() when there is no registered function of the requested name in.
 150  * \param code the function
 151  */
 152 void SIMIX_function_register_default(xbt_main_func_t code)
 153 {
 154   xbt_assert0(simix_global,
 155               "SIMIX_global_init has to be called before SIMIX_function_register.");
 156
 157   default_function = code;
 158 }
 159
 160 /**
 161  * \brief Gets a #smx_process_t code from the global table.
 162  *
 163  * Gets a code function from the global table. Returns NULL if there are no function registered with the name.
 164  * This table is then used by #SIMIX_launch_application.
 165  * \param name the reference name of the function.
 166  * \return The #smx_process_t or NULL.
 167  */
 168 xbt_main_func_t SIMIX_get_registered_function(const char *name)
 169 {
 170   xbt_main_func_t res = NULL;
 171   xbt_assert0(simix_global,
 172               "SIMIX_global_init has to be called before SIMIX_get_registered_function.");
 173
 174   res = xbt_dict_get_or_null(simix_global->registered_functions, name);
 175   return res ? res : default_function;
 176 }
 177
 178
 179 /**
 180  * \brief Bypass the parser, get arguments, and set function to each process
 181  */
 182
 183 void SIMIX_process_set_function(const char *process_host,
 184                                 const char *process_function,
 185                                 xbt_dynar_t arguments,
 186                                 double process_start_time,
 187                                 double process_kill_time)
 188 {
 189   unsigned int i;
 190   char *arg;
 191
 192   /* init process */
 193   parse_host = xbt_strdup(process_host);
 194   xbt_assert1(SIMIX_host_get_by_name(parse_host),
 195               "Host '%s' unknown", parse_host);
 196   parse_code = SIMIX_get_registered_function(process_function);
 197   xbt_assert1(parse_code, "Function '%s' unknown", process_function);
 198
 199   parse_argc = 0;
 200   parse_argv = NULL;
 201   parse_argc++;
 202   parse_argv = xbt_realloc(parse_argv, (parse_argc) * sizeof(char *));
 203   parse_argv[(parse_argc) - 1] = xbt_strdup(process_function);
 204   start_time = process_start_time;
 205   kill_time = process_kill_time;
 206   current_property_set = xbt_dict_new();
 207
 208   /* add arguments */
 209   xbt_dynar_foreach(arguments, i, arg) {
 210     parse_argc++;
 211     parse_argv = xbt_realloc(parse_argv, (parse_argc) * sizeof(char *));
 212     parse_argv[(parse_argc) - 1] = xbt_strdup(arg);
 213   }
 214
 215   /*finalize */
 216   parse_process_finalize();
 217
 218 }