1 /* Copyright (c) 2007-2015. 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. */
7 #include "smx_private.h"
8 #include "xbt/sysdep.h"
10 #include "src/mc/mc_replay.h"
11 #include "src/surf/virtual_machine.hpp"
12 #include "src/surf/HostImpl.hpp"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
17 static void SIMIX_execution_finish(smx_synchro_t synchro);
20 * \brief Internal function to create a SIMIX host.
21 * \param name name of the host to create
23 void SIMIX_host_create(sg_host_t host) // FIXME: braindead prototype. Take sg_host as parameter
25 smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
29 smx_host->process_list = xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
31 /* Update global variables */
32 sg_host_simix_set(host, smx_host);
36 * \brief Start the host if it is off
39 void SIMIX_host_on(sg_host_t h)
41 smx_host_priv_t host = sg_host_simix(h);
43 xbt_assert((host != NULL), "Invalid parameters");
46 simgrid::surf::HostImpl* surf_host = h->extension<simgrid::surf::HostImpl>();
50 smx_process_arg_t arg;
51 xbt_dynar_foreach(host->boot_processes,cpt,arg) {
53 char** argv = xbt_new(char*, arg->argc);
54 for (int i=0; i<arg->argc; i++)
55 argv[i] = xbt_strdup(arg->argv[i]);
57 XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
58 if (simix_global->create_process_function) {
59 simix_global->create_process_function(argv[0],
70 simcall_process_create(arg->argv[0],
85 * \brief Stop the host if it is on
88 void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
90 smx_host_priv_t host = sg_host_simix(h);
92 xbt_assert((host != NULL), "Invalid parameters");
95 simgrid::surf::HostImpl* surf_host = h->extension<simgrid::surf::HostImpl>();
98 /* Clean Simulator data */
99 if (xbt_swag_size(host->process_list) != 0) {
100 smx_process_t process = NULL;
101 xbt_swag_foreach(process, host->process_list) {
102 SIMIX_process_kill(process, issuer);
103 XBT_DEBUG("Killing %s on %s by %s", process->name, sg_host_get_name(process->host), issuer->name);
107 XBT_INFO("Host %s is already off",h->name().c_str());
112 * \brief Internal function to destroy a SIMIX host.
114 * \param h the host to destroy (a sg_host_t)
116 void SIMIX_host_destroy(void *h)
118 smx_host_priv_t host = (smx_host_priv_t) h;
120 xbt_assert((host != NULL), "Invalid parameters");
122 /* Clean Simulator data */
123 if (xbt_swag_size(host->process_list) != 0) {
124 char *msg = xbt_strdup("Shutting down host, but it's not empty:");
126 smx_process_t process = NULL;
128 xbt_swag_foreach(process, host->process_list) {
129 tmp = bprintf("%s\n\t%s", msg, process->name);
133 SIMIX_display_process_status();
134 THROWF(arg_error, 0, "%s", msg);
136 xbt_dynar_free(&host->auto_restart_processes);
137 xbt_dynar_free(&host->boot_processes);
138 xbt_swag_free(host->process_list);
140 /* Clean host structure */
145 sg_host_t SIMIX_host_self(void)
147 smx_process_t process = SIMIX_process_self();
148 return (process == NULL) ? NULL : SIMIX_process_get_host(process);
151 /* needs to be public and without simcall because it is called
152 by exceptions and logging events */
153 const char* SIMIX_host_self_get_name(void)
155 sg_host_t host = SIMIX_host_self();
156 if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
159 return sg_host_get_name(host);
162 void _SIMIX_host_free_process_arg(void *data)
164 smx_process_arg_t arg = *(smx_process_arg_t*)data;
166 for (i = 0; i < arg->argc; i++)
167 xbt_free(arg->argv[i]);
173 * \brief Add a process to the list of the processes that the host will restart when it comes back
174 * This function add a process to the list of the processes that will be restarted when the host comes
175 * back. It is expected that this function is called when the host is down.
176 * The processes will only be restarted once, meaning that you will have to register the process
177 * again to restart the process again.
179 void SIMIX_host_add_auto_restart_process(sg_host_t host,
181 xbt_main_func_t code,
183 const char *hostname,
185 int argc, char **argv,
186 xbt_dict_t properties,
189 if (!sg_host_simix(host)->auto_restart_processes) {
190 sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
192 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
193 arg->name = xbt_strdup(name);
196 arg->hostname = hostname;
197 arg->kill_time = kill_time;
200 arg->argv = xbt_new(char*,argc + 1);
203 for (i = 0; i < argc; i++) {
204 arg->argv[i] = xbt_strdup(argv[i]);
206 arg->argv[argc] = NULL;
208 arg->properties = properties;
209 arg->auto_restart = auto_restart;
211 if( ! sg_host_is_on(host)
212 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
213 xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,NULL);
214 XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
216 xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
219 * \brief Restart the list of processes that have been registered to the host
221 void SIMIX_host_autorestart(sg_host_t host)
224 smx_process_arg_t arg;
225 xbt_dynar_t process_list = sg_host_simix(host)->auto_restart_processes;
229 xbt_dynar_foreach (process_list, cpt, arg) {
231 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
232 if (simix_global->create_process_function) {
233 simix_global->create_process_function(arg->argv[0],
244 simcall_process_create(arg->argv[0],
245 (xbt_main_func_t) arg->code,
255 /* arg->argv is used by the process created above. Hide it to
256 * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
261 xbt_dynar_reset(process_list);
264 smx_synchro_t simcall_HANDLER_execution_start(smx_simcall_t simcall,
265 const char* name, double flops_amount, double priority, double bound, unsigned long affinity_mask) {
266 return SIMIX_execution_start(simcall->issuer, name,flops_amount,priority,bound,affinity_mask);
268 smx_synchro_t SIMIX_execution_start(smx_process_t issuer, const char *name,
269 double flops_amount, double priority, double bound, unsigned long affinity_mask){
271 /* alloc structures and initialize */
272 smx_synchro_t synchro = (smx_synchro_t) xbt_mallocator_get(simix_global->synchro_mallocator);
273 synchro->type = SIMIX_SYNC_EXECUTE;
274 synchro->name = xbt_strdup(name);
275 synchro->state = SIMIX_RUNNING;
276 synchro->execution.host = issuer->host;
277 synchro->category = NULL;
279 /* set surf's action */
280 if (!MC_is_active() && !MC_record_replay_is_active()) {
282 synchro->execution.surf_exec = issuer->host->pimpl_cpu->execution_start(flops_amount);
283 synchro->execution.surf_exec->setData(synchro);
284 synchro->execution.surf_exec->setPriority(priority);
287 static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)
290 if (affinity_mask != 0) {
291 /* just a double check to confirm that this host is the host where this task is running. */
292 xbt_assert(synchro->execution.host == issuer->host);
293 static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)
294 ->setAffinity(issuer->host->pimpl_cpu, affinity_mask);
298 XBT_DEBUG("Create execute synchro %p: %s", synchro, synchro->name);
303 smx_synchro_t SIMIX_execution_parallel_start(const char *name,
304 int host_nb, sg_host_t *host_list,
305 double *flops_amount, double *bytes_amount,
306 double amount, double rate){
308 sg_host_t*host_list_cpy = NULL;
311 /* alloc structures and initialize */
312 smx_synchro_t synchro = (smx_synchro_t) xbt_mallocator_get(simix_global->synchro_mallocator);
313 synchro->type = SIMIX_SYNC_PARALLEL_EXECUTE;
314 synchro->name = xbt_strdup(name);
315 synchro->state = SIMIX_RUNNING;
316 synchro->execution.host = NULL; /* FIXME: do we need the list of hosts? */
317 synchro->category = NULL;
319 /* set surf's synchro */
320 host_list_cpy = xbt_new0(sg_host_t, host_nb);
321 for (i = 0; i < host_nb; i++)
322 host_list_cpy[i] = host_list[i];
324 /* Check that we are not mixing VMs and PMs in the parallel task */
325 simgrid::surf::HostImpl *host = host_list[0]->extension<simgrid::surf::HostImpl>();
326 bool is_a_vm = (nullptr != dynamic_cast<simgrid::surf::VirtualMachine*>(host));
327 for (i = 1; i < host_nb; i++) {
328 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::surf::VirtualMachine*>(host_list[i]->extension<simgrid::surf::HostImpl>()));
329 xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
332 /* set surf's synchro */
333 if (!MC_is_active() && !MC_record_replay_is_active()) {
334 synchro->execution.surf_exec =
335 surf_host_model->executeParallelTask(
336 host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
338 synchro->execution.surf_exec->setData(synchro);
340 XBT_DEBUG("Create parallel execute synchro %p", synchro);
345 void SIMIX_execution_destroy(smx_synchro_t synchro)
347 XBT_DEBUG("Destroy synchro %p", synchro);
349 if (synchro->execution.surf_exec) {
350 synchro->execution.surf_exec->unref();
351 synchro->execution.surf_exec = NULL;
353 xbt_free(synchro->name);
354 xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
357 void SIMIX_execution_cancel(smx_synchro_t synchro)
359 XBT_DEBUG("Cancel synchro %p", synchro);
361 if (synchro->execution.surf_exec)
362 synchro->execution.surf_exec->cancel();
365 double SIMIX_execution_get_remains(smx_synchro_t synchro)
369 if (synchro->state == SIMIX_RUNNING)
370 result = synchro->execution.surf_exec->getRemains();
375 e_smx_state_t SIMIX_execution_get_state(smx_synchro_t synchro)
377 return synchro->state;
380 void SIMIX_execution_set_priority(smx_synchro_t synchro, double priority)
382 if(synchro->execution.surf_exec)
383 synchro->execution.surf_exec->setPriority(priority);
386 void SIMIX_execution_set_bound(smx_synchro_t synchro, double bound)
388 if(synchro->execution.surf_exec)
389 static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)->setBound(bound);
392 void SIMIX_execution_set_affinity(smx_synchro_t synchro, sg_host_t host, unsigned long mask)
394 xbt_assert(synchro->type == SIMIX_SYNC_EXECUTE);
396 if (synchro->execution.surf_exec) {
397 /* just a double check to confirm that this host is the host where this task is running. */
398 xbt_assert(synchro->execution.host == host);
399 static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)
400 ->setAffinity(host->pimpl_cpu, mask);
404 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro)
407 XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
409 /* Associate this simcall to the synchro */
410 xbt_fifo_push(synchro->simcalls, simcall);
411 simcall->issuer->waiting_synchro = synchro;
413 /* set surf's synchro */
414 if (MC_is_active() || MC_record_replay_is_active()) {
415 synchro->state = SIMIX_DONE;
416 SIMIX_execution_finish(synchro);
420 /* If the synchro is already finished then perform the error handling */
421 if (synchro->state != SIMIX_RUNNING)
422 SIMIX_execution_finish(synchro);
425 void SIMIX_execution_suspend(smx_synchro_t synchro)
427 if(synchro->execution.surf_exec)
428 synchro->execution.surf_exec->suspend();
431 void SIMIX_execution_resume(smx_synchro_t synchro)
433 if(synchro->execution.surf_exec)
434 synchro->execution.surf_exec->resume();
437 void SIMIX_execution_finish(smx_synchro_t synchro)
439 xbt_fifo_item_t item;
440 smx_simcall_t simcall;
442 xbt_fifo_foreach(synchro->simcalls, item, simcall, smx_simcall_t) {
444 switch (synchro->state) {
447 /* do nothing, synchro done */
448 XBT_DEBUG("SIMIX_execution_finished: execution successful");
452 XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_get_name(simcall->issuer->host));
453 simcall->issuer->context->iwannadie = 1;
454 SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
458 XBT_DEBUG("SIMIX_execution_finished: execution canceled");
459 SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
463 xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
464 (int)synchro->state);
466 /* check if the host is down */
467 if (simcall->issuer->host->isOff()) {
468 simcall->issuer->context->iwannadie = 1;
471 simcall->issuer->waiting_synchro = NULL;
472 simcall_execution_wait__set__result(simcall, synchro->state);
473 SIMIX_simcall_answer(simcall);
476 /* We no longer need it */
477 SIMIX_execution_destroy(synchro);
481 void SIMIX_post_host_execute(smx_synchro_t synchro)
483 if (synchro->type == SIMIX_SYNC_EXECUTE && /* FIMXE: handle resource failure
484 * for parallel tasks too */
485 synchro->execution.host->isOff()) {
486 /* If the host running the synchro failed, notice it so that the asking
487 * process can be killed if it runs on that host itself */
488 synchro->state = SIMIX_FAILED;
489 } else if (synchro->execution.surf_exec->getState() == SURF_ACTION_FAILED) {
490 /* If the host running the synchro didn't fail, then the synchro was
492 synchro->state = SIMIX_CANCELED;
494 synchro->state = SIMIX_DONE;
497 if (synchro->execution.surf_exec) {
498 synchro->execution.surf_exec->unref();
499 synchro->execution.surf_exec = NULL;
502 /* If there are simcalls associated with the synchro, then answer them */
503 if (xbt_fifo_size(synchro->simcalls)) {
504 SIMIX_execution_finish(synchro);
509 void SIMIX_set_category(smx_synchro_t synchro, const char *category)
511 if (synchro->state != SIMIX_RUNNING) return;
512 if (synchro->type == SIMIX_SYNC_EXECUTE){
513 synchro->execution.surf_exec->setCategory(category);
514 }else if (synchro->type == SIMIX_SYNC_COMMUNICATE){
515 synchro->comm.surf_comm->setCategory(category);