src/simix/smx_deployment.cpp

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