1 /* Copyright (c) 2007, 2009-2016. The SimGrid Team.
2 * All rights reserved. */
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. */
10 #include "simgrid/s4u/host.hpp"
11 #include "smx_private.h"
12 #include "src/surf/xml/platf_private.hpp" // FIXME: KILLME. There must be a better way than mimicking XML here
15 #include "xbt/sysdep.h"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_deployment, simix, "Logging specific to SIMIX (deployment)");
20 extern int surf_parse_lineno;
22 void SIMIX_init_application()
29 * \brief An application deployer.
31 * Creates the process described in \a file.
32 * \param file a filename of a xml description of the application. This file
35 * \include surfxml.dtd
37 * Here is a small example of such a platform
39 * \include small_deployment.xml
42 void SIMIX_launch_application(const char *file)
44 XBT_ATTRIB_UNUSED int parse_status;
45 xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_launch_application.");
47 SIMIX_init_application();
49 surf_parse_open(file);
51 parse_status = surf_parse();
53 xbt_assert(!parse_status, "Parse error at %s:%d", file,surf_parse_lineno);
56 XBT_ERROR("Unrecoverable error at %s:%d. The full exception stack follows, in case it helps you to diagnose the problem.",
57 file, surf_parse_lineno);
62 // Wrap a main() function into a ActorCodeFactory:
63 static simgrid::simix::ActorCodeFactory toActorCodeFactory(xbt_main_func_t code)
65 return [code](std::vector<std::string> args) {
66 return simgrid::xbt::wrapMain(code, std::move(args));
71 * \brief Registers a #xbt_main_func_t code in a global table.
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
78 void SIMIX_function_register(const char *name, xbt_main_func_t code)
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);
86 * \brief Registers a #xbt_main_func_t code as default value.
88 * 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.
89 * \param code the function
91 void SIMIX_function_register_default(xbt_main_func_t code)
93 xbt_assert(simix_global, "SIMIX_global_init has to be called before SIMIX_function_register.");
94 simix_global->default_function = toActorCodeFactory(code);
98 * \brief Gets a #smx_actor_t code from the global table.
100 * Gets a code function from the global table. Returns nullptr if there are no function registered with the name.
101 * This table is then used by #SIMIX_launch_application.
102 * \param name the reference name of the function.
103 * \return The #smx_actor_t or nullptr.
105 simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const char *name)
107 xbt_assert(simix_global,
108 "SIMIX_global_init has to be called before SIMIX_get_actor_code_factory.");
110 auto i = simix_global->registered_functions.find(name);
111 if (i == simix_global->registered_functions.end())
112 return simix_global->default_function;
118 * \brief Bypass the parser, get arguments, and set function to each process
121 void SIMIX_process_set_function(const char *process_host,
122 const char *process_function,
123 xbt_dynar_t arguments,
124 double process_start_time,
125 double process_kill_time)
127 s_sg_platf_process_cbarg_t process;
128 memset(&process,0,sizeof(process));
130 sg_host_t host = sg_host_by_name(process_host);
132 THROWF(arg_error, 0, "Host '%s' unknown", process_host);
133 process.host = host->cname();
135 process.argc = 1 + xbt_dynar_length(arguments);
136 process.argv = (const char**)xbt_new(char *, process.argc + 1);
137 process.argv[0] = xbt_strdup(process_function);
141 xbt_dynar_foreach(arguments, i, arg) {
142 process.argv[i + 1] = xbt_strdup(arg);
144 process.argv[process.argc] = nullptr;
146 // Check we know how to handle this function name:
147 simgrid::simix::ActorCodeFactory& parse_code = SIMIX_get_actor_code_factory(process_function);
148 xbt_assert(parse_code, "Function '%s' unknown", process_function);
150 process.function = process_function;
151 process.host = process_host;
152 process.kill_time = process_kill_time;
153 process.start_time = process_start_time;
154 process.on_failure = SURF_PROCESS_ON_FAILURE_DIE;
155 sg_platf_new_process(&process);
161 void registerFunction(const char* name, ActorCodeFactory factory)
163 simix_global->registered_functions[name] = std::move(factory);