src/simix/smx_deployment.cpp

   1 /* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <string>
   7 #include <vector>
   8
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "smx_private.hpp"
  11 #include "src/surf/xml/platf_private.hpp" // FIXME: KILLME. There must be a better way than mimicking XML here
  12 #include <xbt/ex.hpp>
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_deployment, simix, "Logging specific to SIMIX (deployment)");
  15
  16 extern int surf_parse_lineno;
  17
  18 void SIMIX_init_application()
  19 {
  20   sg_platf_exit();
  21   sg_platf_init();
  22 }
  23
  24 /**
  25  * \brief An application deployer.
  26  *
  27  * Creates the process described in \a file.
  28  * \param file a filename of a xml description of the application. This file
  29  * follows this DTD :
  30  *
  31  *     \include surfxml.dtd
  32  *
  33  * Here is a small example of such a platform
  34  *
  35  *     \include small_deployment.xml
  36  *
  37  */
  38 void SIMIX_launch_application(std::string file)
  39 {
  40   XBT_ATTRIB_UNUSED int parse_status;
  41   xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_launch_application.");
  42
  43   SIMIX_init_application();
  44
  45   surf_parse_open(file);
  46   try {
  47     parse_status = surf_parse();
  48     surf_parse_close();
  49     xbt_assert(not parse_status, "Parse error at %s:%d", file.c_str(), surf_parse_lineno);
  50   }
  51   catch (xbt_ex& e) {
  52     XBT_ERROR(
  53         "Unrecoverable error at %s:%d. The full exception stack follows, in case it helps you to diagnose the problem.",
  54         file.c_str(), surf_parse_lineno);
  55     throw;
  56   }
  57 }
  58
  59 void SIMIX_launch_application(const char* file)
  60 {
  61   SIMIX_launch_application(std::string(file));
  62 }
  63
  64 // Wrap a main() function into a ActorCodeFactory:
  65 static simgrid::simix::ActorCodeFactory toActorCodeFactory(xbt_main_func_t code)
  66 {
  67   return [code](std::vector<std::string> args) { return simgrid::xbt::wrap_main(code, std::move(args)); };
  68 }
  69
  70 /**
  71  * \brief Registers a #xbt_main_func_t code in a global table.
  72  *
  73  * Registers a code function in a global table.
  74  * This table is then used by #SIMIX_launch_application.
  75  * \param name the reference name of the function.
  76  * \param code the function
  77  */
  78 void SIMIX_function_register(std::string name, xbt_main_func_t code)
  79 {
  80   xbt_assert(simix_global,
  81     "SIMIX_global_init has to be called before SIMIX_function_register.");
  82   simix_global->registered_functions[name] = toActorCodeFactory(code);
  83 }
  84
  85 void SIMIX_function_register(const char* name, xbt_main_func_t code)
  86 {
  87   SIMIX_function_register(std::string(name), code);
  88 }
  89
  90 /**
  91  * \brief Registers a #xbt_main_func_t code as default value.
  92  *
  93  * 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.
  94  * \param code the function
  95  */
  96 void SIMIX_function_register_default(xbt_main_func_t code)
  97 {
  98   xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_function_register.");
  99   simix_global->default_function = toActorCodeFactory(code);
 100 }
 101
 102 /**
 103  * \brief Gets a #smx_actor_t code from the global table.
 104  *
 105  * Gets a code function from the global table. Returns nullptr if there are no function registered with the name.
 106  * This table is then used by #SIMIX_launch_application.
 107  * \param name the reference name of the function.
 108  * \return The #smx_actor_t or nullptr.
 109  */
 110 simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(std::string name)
 111 {
 112   xbt_assert(simix_global,
 113               "SIMIX_global_init has to be called before SIMIX_get_actor_code_factory.");
 114
 115   auto i = simix_global->registered_functions.find(name);
 116   if (i == simix_global->registered_functions.end())
 117     return simix_global->default_function;
 118   else
 119     return i->second;
 120 }
 121
 122 /**
 123  * \brief Bypass the parser, get arguments, and set function to each process
 124  */
 125
 126 void SIMIX_process_set_function(const char* process_host, const char* process_function, xbt_dynar_t arguments,
 127                                 double process_start_time, double process_kill_time)
 128 {
 129   simgrid::kernel::routing::ActorCreationArgs actor;
 130
 131   sg_host_t host = sg_host_by_name(process_host);
 132   if (not host)
 133     THROWF(arg_error, 0, "Host '%s' unknown", process_host);
 134   actor.host = process_host;
 135   actor.args.push_back(process_function);
 136   /* add arguments */
 137   unsigned int i;
 138   char *arg;
 139   xbt_dynar_foreach(arguments, i, arg) {
 140     actor.args.push_back(arg);
 141   }
 142
 143   // Check we know how to handle this function name:
 144   simgrid::simix::ActorCodeFactory& parse_code = SIMIX_get_actor_code_factory(process_function);
 145   xbt_assert(parse_code, "Function '%s' unknown", process_function);
 146
 147   actor.function   = process_function;
 148   actor.host       = process_host;
 149   actor.kill_time  = process_kill_time;
 150   actor.start_time = process_start_time;
 151   actor.on_failure = simgrid::kernel::routing::ActorOnFailure::DIE;
 152   sg_platf_new_actor(&actor);
 153 }
 154
 155 namespace simgrid {
 156 namespace simix {
 157
 158 void register_function(std::string name, ActorCodeFactory factory)
 159 {
 160   simix_global->registered_functions[name] = std::move(factory);
 161 }
 162
 163 }
 164 }