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     if (simix_global->create_process_function)
  67       surf_timer_model->extension.timer.set(start_time, (void *)
  68                                             simix_global->create_process_function,
  69                                             arg);
  70     else
  71       surf_timer_model->extension.timer.set(start_time, (void *)
  72                                             &SIMIX_process_create, arg);
  73
  74   } else { // start_time <= SIMIX_get_clock()
  75     DEBUG2("Starting Process %s(%s) right now", parse_argv[0], parse_host);
  76
  77     if (simix_global->create_process_function)
  78       process =
  79         (*simix_global->create_process_function) (parse_argv[0], parse_code,
  80                                                   NULL, parse_host,
  81                                                   parse_argc, parse_argv,
  82                                                   /*the props */
  83                                                   current_property_set);
  84     else
  85       process = SIMIX_process_create(parse_argv[0], parse_code, NULL, parse_host, parse_argc, parse_argv,       /*the props */
  86                                      current_property_set);
  87     /* verify if process has been created (won't be the case if the host is currently dead, but that's fine) */
  88     if (!process) {
  89       xbt_free(parse_host);
  90       return;
  91     }
  92     if (kill_time > SIMIX_get_clock()) {
  93         if (simix_global->kill_process_function)
  94                 surf_timer_model->extension.timer.set(start_time, (void *)
  95                                               simix_global->kill_process_function,
  96                                               process);
  97         else
  98                 surf_timer_model->extension.timer.set(kill_time, (void *)
  99                                               &SIMIX_process_kill,
 100                                               (void *) process);
 101     }
 102     xbt_free(parse_host);
 103   }
 104 }
 105
 106 /**
 107  * \brief An application deployer.
 108  *
 109  * Creates the process described in \a file.
 110  * \param file a filename of a xml description of the application. This file
 111  * follows this DTD :
 112  *
 113  *     \include surfxml.dtd
 114  *
 115  * Here is a small example of such a platform
 116  *
 117  *     \include small_deployment.xml
 118  *
 119  */
 120 void SIMIX_launch_application(const char *file)
 121 {
 122   xbt_assert0(simix_global,
 123               "SIMIX_global_init has to be called before SIMIX_launch_application.");
 124   surf_parse_reset_parser();
 125   surfxml_add_callback(STag_surfxml_process_cb_list, parse_process_init);
 126   surfxml_add_callback(ETag_surfxml_argument_cb_list, parse_argument);
 127   surfxml_add_callback(STag_surfxml_prop_cb_list, parse_properties);
 128   surfxml_add_callback(ETag_surfxml_process_cb_list, parse_process_finalize);
 129
 130   surf_parse_open(file);
 131   xbt_assert1((!surf_parse()), "Parse error in %s", file);
 132   surf_parse_close();
 133 }
 134
 135 /**
 136  * \brief Registers a #smx_process_code_t code in a global table.
 137  *
 138  * Registers a code function in a global table.
 139  * This table is then used by #SIMIX_launch_application.
 140  * \param name the reference name of the function.
 141  * \param code the function
 142  */
 143 XBT_INLINE void SIMIX_function_register(const char *name, xbt_main_func_t code)
 144 {
 145   xbt_assert0(simix_global,
 146               "SIMIX_global_init has to be called before SIMIX_function_register.");
 147
 148   xbt_dict_set(simix_global->registered_functions, name, code, NULL);
 149 }
 150
 151 static xbt_main_func_t default_function = NULL;
 152 /**
 153  * \brief Registers a #smx_process_code_t code as default value.
 154  *
 155  * 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.
 156  * \param code the function
 157  */
 158 void SIMIX_function_register_default(xbt_main_func_t code)
 159 {
 160   xbt_assert0(simix_global,
 161               "SIMIX_global_init has to be called before SIMIX_function_register.");
 162
 163   default_function = code;
 164 }
 165
 166 /**
 167  * \brief Gets a #smx_process_t code from the global table.
 168  *
 169  * Gets a code function from the global table. Returns NULL if there are no function registered with the name.
 170  * This table is then used by #SIMIX_launch_application.
 171  * \param name the reference name of the function.
 172  * \return The #smx_process_t or NULL.
 173  */
 174 xbt_main_func_t SIMIX_get_registered_function(const char *name)
 175 {
 176         xbt_main_func_t res = NULL;
 177   xbt_assert0(simix_global,
 178               "SIMIX_global_init has to be called before SIMIX_get_registered_function.");
 179
 180   res = xbt_dict_get_or_null(simix_global->registered_functions, name);
 181   return res ? res : default_function;
 182 }