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 // 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
  65 /**
  66  * \brief Registers a #xbt_main_func_t code in a global table.
  67  *
  68  * Registers a code function in a global table.
  69  * This table is then used by #SIMIX_launch_application.
  70  * \param name the reference name of the function.
  71  * \param code the function
  72  */
  73 void SIMIX_function_register(std::string name, xbt_main_func_t code)
  74 {
  75   xbt_assert(simix_global,
  76     "SIMIX_global_init has to be called before SIMIX_function_register.");
  77   simix_global->registered_functions[name] = toActorCodeFactory(code);
  78 }
  79
  80 /**
  81  * \brief Registers a #xbt_main_func_t code as default value.
  82  *
  83  * 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.
  84  * \param code the function
  85  */
  86 void SIMIX_function_register_default(xbt_main_func_t code)
  87 {
  88   xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_function_register.");
  89   simix_global->default_function = toActorCodeFactory(code);
  90 }
  91
  92 /**
  93  * \brief Gets a #smx_actor_t code from the global table.
  94  *
  95  * Gets a code function from the global table. Returns nullptr if there are no function registered with the name.
  96  * This table is then used by #SIMIX_launch_application.
  97  * \param name the reference name of the function.
  98  * \return The #smx_actor_t or nullptr.
  99  */
 100 simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(std::string name)
 101 {
 102   xbt_assert(simix_global,
 103               "SIMIX_global_init has to be called before SIMIX_get_actor_code_factory.");
 104
 105   auto i = simix_global->registered_functions.find(name);
 106   if (i == simix_global->registered_functions.end())
 107     return simix_global->default_function;
 108   else
 109     return i->second;
 110 }
 111
 112 /**
 113  * \brief Bypass the parser, get arguments, and set function to each process
 114  */
 115
 116 void SIMIX_process_set_function(const char* process_host, const char* process_function, xbt_dynar_t arguments,
 117                                 double process_start_time, double process_kill_time)
 118 {
 119   simgrid::kernel::routing::ActorCreationArgs actor;
 120
 121   sg_host_t host = sg_host_by_name(process_host);
 122   if (not host)
 123     THROWF(arg_error, 0, "Host '%s' unknown", process_host);
 124   actor.host = process_host;
 125   actor.args.push_back(process_function);
 126   /* add arguments */
 127   unsigned int i;
 128   char *arg;
 129   xbt_dynar_foreach(arguments, i, arg) {
 130     actor.args.push_back(arg);
 131   }
 132
 133   // Check we know how to handle this function name:
 134   simgrid::simix::ActorCodeFactory& parse_code = SIMIX_get_actor_code_factory(process_function);
 135   xbt_assert(parse_code, "Function '%s' unknown", process_function);
 136
 137   actor.function   = process_function;
 138   actor.host       = process_host;
 139   actor.kill_time  = process_kill_time;
 140   actor.start_time = process_start_time;
 141   actor.on_failure = simgrid::kernel::routing::ActorOnFailure::DIE;
 142   sg_platf_new_actor(&actor);
 143 }
 144
 145 namespace simgrid {
 146 namespace simix {
 147
 148 void register_function(std::string name, ActorCodeFactory factory)
 149 {
 150   simix_global->registered_functions[name] = std::move(factory);
 151 }
 152
 153 }
 154 }