1 /* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved. */
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. */
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
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_deployment, simix, "Logging specific to SIMIX (deployment)");
16 extern int surf_parse_lineno;
18 void SIMIX_init_application()
25 * \brief An application deployer.
27 * Creates the process described in \a file.
28 * \param file a filename of a xml description of the application. This file
31 * \include surfxml.dtd
33 * Here is a small example of such a platform
35 * \include small_deployment.xml
38 void SIMIX_launch_application(std::string file)
40 XBT_ATTRIB_UNUSED int parse_status;
41 xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_launch_application.");
43 SIMIX_init_application();
45 surf_parse_open(file);
47 parse_status = surf_parse();
49 xbt_assert(not parse_status, "Parse error at %s:%d", file.c_str(), surf_parse_lineno);
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);
59 // Wrap a main() function into a ActorCodeFactory:
60 static simgrid::simix::ActorCodeFactory toActorCodeFactory(xbt_main_func_t code)
62 return [code](std::vector<std::string> args) { return simgrid::xbt::wrap_main(code, std::move(args)); };
66 * \brief Registers a #xbt_main_func_t code in a global table.
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
73 void SIMIX_function_register(std::string name, xbt_main_func_t code)
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);
81 * \brief Registers a #xbt_main_func_t code as default value.
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
86 void SIMIX_function_register_default(xbt_main_func_t code)
88 xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_function_register.");
89 simix_global->default_function = toActorCodeFactory(code);
93 * \brief Gets a #smx_actor_t code from the global table.
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.
100 simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(std::string name)
102 xbt_assert(simix_global,
103 "SIMIX_global_init has to be called before SIMIX_get_actor_code_factory.");
105 auto i = simix_global->registered_functions.find(name);
106 if (i == simix_global->registered_functions.end())
107 return simix_global->default_function;
113 * \brief Bypass the parser, get arguments, and set function to each process
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)
119 simgrid::kernel::routing::ActorCreationArgs actor;
121 sg_host_t host = sg_host_by_name(process_host);
123 THROWF(arg_error, 0, "Host '%s' unknown", process_host);
124 actor.host = process_host;
125 actor.args.push_back(process_function);
129 xbt_dynar_foreach(arguments, i, arg) {
130 actor.args.push_back(arg);
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);
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);
148 void register_function(std::string name, ActorCodeFactory factory)
150 simix_global->registered_functions[name] = std::move(factory);