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"
12 #include "src/mc/mc_replay.h"
13 #include "src/surf/host_interface.hpp"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
18 static void SIMIX_execution_finish(smx_synchro_t synchro);
21 * \brief Internal function to create a SIMIX host.
22 * \param name name of the host to create
24 void SIMIX_host_create(sg_host_t host) // FIXME: braindead prototype. Take sg_host as parameter
26 smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
30 smx_host->process_list =
31 xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
33 /* Update global variables */
34 sg_host_simix_set(host, smx_host);
38 * \brief Start the host if it is off
41 void SIMIX_host_on(sg_host_t h)
43 smx_host_priv_t host = sg_host_simix(h);
45 xbt_assert((host != NULL), "Invalid parameters");
48 simgrid::surf::Host* surf_host = h->extension<simgrid::surf::Host>();
49 surf_host_turn_on(surf_host);
52 smx_process_arg_t arg;
53 xbt_dynar_foreach(host->boot_processes,cpt,arg) {
55 char** argv = xbt_new(char*, arg->argc);
56 for (int i=0; i<arg->argc; i++)
57 argv[i] = xbt_strdup(arg->argv[i]);
59 XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
60 if (simix_global->create_process_function) {
61 simix_global->create_process_function(argv[0],
72 simcall_process_create(arg->argv[0],
86 void simcall_HANDLER_host_off(smx_simcall_t simcall, sg_host_t h)
88 SIMIX_host_off(h, simcall->issuer);
92 * \brief Stop the host if it is on
95 void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
97 smx_host_priv_t host = sg_host_simix(h);
99 xbt_assert((host != NULL), "Invalid parameters");
102 simgrid::surf::Host* surf_host = h->extension<simgrid::surf::Host>();
103 surf_host_turn_off(surf_host);
105 /* Clean Simulator data */
106 if (xbt_swag_size(host->process_list) != 0) {
107 smx_process_t process = NULL;
108 xbt_swag_foreach(process, host->process_list) {
109 SIMIX_process_kill(process, issuer);
110 XBT_DEBUG("Killing %s on %s by %s", process->name, sg_host_get_name(process->host), issuer->name);
114 XBT_INFO("Host %s is already off",h->getName().c_str());
119 * \brief Internal function to destroy a SIMIX host.
121 * \param h the host to destroy (a sg_host_t)
123 void SIMIX_host_destroy(void *h)
125 smx_host_priv_t host = (smx_host_priv_t) h;
127 xbt_assert((host != NULL), "Invalid parameters");
129 /* Clean Simulator data */
130 if (xbt_swag_size(host->process_list) != 0) {
131 char *msg = xbt_strdup("Shutting down host, but it's not empty:");
133 smx_process_t process = NULL;
135 xbt_swag_foreach(process, host->process_list) {
136 tmp = bprintf("%s\n\t%s", msg, process->name);
140 SIMIX_display_process_status();
141 THROWF(arg_error, 0, "%s", msg);
143 xbt_dynar_free(&host->auto_restart_processes);
144 xbt_dynar_free(&host->boot_processes);
145 xbt_swag_free(host->process_list);
147 /* Clean host structure */
152 sg_host_t SIMIX_host_self(void)
154 smx_process_t process = SIMIX_process_self();
155 return (process == NULL) ? NULL : SIMIX_process_get_host(process);
158 /* needs to be public and without simcall because it is called
159 by exceptions and logging events */
160 const char* SIMIX_host_self_get_name(void)
162 sg_host_t host = SIMIX_host_self();
163 if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
166 return SIMIX_host_get_name(host);
169 xbt_dict_t SIMIX_host_get_properties(sg_host_t host){
170 return sg_host_get_properties(host);
174 xbt_swag_t SIMIX_host_get_process_list(sg_host_t host){
175 smx_host_priv_t host_priv = sg_host_simix(host);
177 return host_priv->process_list;
181 double SIMIX_host_get_current_power_peak(sg_host_t host) {
182 return surf_host_get_current_power_peak(host);
185 double SIMIX_host_get_power_peak_at(sg_host_t host, int pstate_index) {
186 return surf_host_get_power_peak_at(host, pstate_index);
189 void SIMIX_host_set_pstate(sg_host_t host, int pstate_index) {
190 surf_host_set_pstate(host, pstate_index);
192 double SIMIX_host_get_wattmin_at(sg_host_t host,int pstate) {
193 return surf_host_get_wattmin_at(host,pstate);
195 double SIMIX_host_get_wattmax_at(sg_host_t host,int pstate) {
196 return surf_host_get_wattmax_at(host,pstate);
199 void _SIMIX_host_free_process_arg(void *data)
201 smx_process_arg_t arg = *(smx_process_arg_t*)data;
203 for (i = 0; i < arg->argc; i++)
204 xbt_free(arg->argv[i]);
210 * \brief Add a process to the list of the processes that the host will restart when it comes back
211 * This function add a process to the list of the processes that will be restarted when the host comes
212 * back. It is expected that this function is called when the host is down.
213 * The processes will only be restarted once, meaning that you will have to register the process
214 * again to restart the process again.
216 void SIMIX_host_add_auto_restart_process(sg_host_t host,
218 xbt_main_func_t code,
220 const char *hostname,
222 int argc, char **argv,
223 xbt_dict_t properties,
226 if (!sg_host_simix(host)->auto_restart_processes) {
227 sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
229 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
230 arg->name = xbt_strdup(name);
233 arg->hostname = hostname;
234 arg->kill_time = kill_time;
237 arg->argv = xbt_new(char*,argc + 1);
240 for (i = 0; i < argc; i++) {
241 arg->argv[i] = xbt_strdup(argv[i]);
243 arg->argv[argc] = NULL;
245 arg->properties = properties;
246 arg->auto_restart = auto_restart;
248 if( ! sg_host_is_on(host)
249 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
250 xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,NULL);
251 XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
253 xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
256 * \brief Restart the list of processes that have been registered to the host
258 void SIMIX_host_restart_processes(sg_host_t host)
261 smx_process_arg_t arg;
262 xbt_dynar_t process_list = sg_host_simix(host)->auto_restart_processes;
266 xbt_dynar_foreach (process_list, cpt, arg) {
268 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
269 if (simix_global->create_process_function) {
270 simix_global->create_process_function(arg->argv[0],
281 simcall_process_create(arg->argv[0],
282 (xbt_main_func_t) arg->code,
292 /* arg->argv is used by the process created above. Hide it to
293 * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
298 xbt_dynar_reset(process_list);
301 void SIMIX_host_autorestart(sg_host_t host)
303 if(simix_global->autorestart)
304 simix_global->autorestart(host);
306 xbt_die("No function for simix_global->autorestart");
308 smx_synchro_t simcall_HANDLER_process_execute(smx_simcall_t simcall,
309 const char* name, double flops_amount, double priority, double bound, unsigned long affinity_mask) {
310 return SIMIX_process_execute(simcall->issuer, name,flops_amount,priority,bound,affinity_mask);
312 smx_synchro_t SIMIX_process_execute(smx_process_t issuer, const char *name,
313 double flops_amount, double priority, double bound, unsigned long affinity_mask){
315 /* alloc structures and initialize */
316 smx_synchro_t synchro = (smx_synchro_t) xbt_mallocator_get(simix_global->synchro_mallocator);
317 synchro->type = SIMIX_SYNC_EXECUTE;
318 synchro->name = xbt_strdup(name);
319 synchro->state = SIMIX_RUNNING;
320 synchro->execution.host = issuer->host;
321 synchro->category = NULL;
323 /* set surf's action */
324 if (!MC_is_active() && !MC_record_replay_is_active()) {
326 synchro->execution.surf_exec = surf_host_execute(issuer->host, flops_amount);
327 surf_action_set_data(synchro->execution.surf_exec, synchro);
328 surf_action_set_priority(synchro->execution.surf_exec, priority);
331 surf_cpu_action_set_bound(synchro->execution.surf_exec, bound);
333 if (affinity_mask != 0) {
334 /* just a double check to confirm that this host is the host where this task is running. */
335 xbt_assert(synchro->execution.host == issuer->host);
336 surf_cpu_action_set_affinity(synchro->execution.surf_exec, issuer->host, affinity_mask);
340 XBT_DEBUG("Create execute synchro %p: %s", synchro, synchro->name);
345 smx_synchro_t SIMIX_process_parallel_execute(const char *name,
346 int host_nb, sg_host_t *host_list,
347 double *flops_amount, double *bytes_amount,
348 double amount, double rate){
350 sg_host_t*host_list_cpy = NULL;
353 /* alloc structures and initialize */
354 smx_synchro_t synchro = (smx_synchro_t) xbt_mallocator_get(simix_global->synchro_mallocator);
355 synchro->type = SIMIX_SYNC_PARALLEL_EXECUTE;
356 synchro->name = xbt_strdup(name);
357 synchro->state = SIMIX_RUNNING;
358 synchro->execution.host = NULL; /* FIXME: do we need the list of hosts? */
359 synchro->category = NULL;
361 /* set surf's synchro */
362 host_list_cpy = xbt_new0(sg_host_t, host_nb);
363 for (i = 0; i < host_nb; i++)
364 host_list_cpy[i] = host_list[i];
367 /* FIXME: what happens if host_list contains VMs and PMs. If
368 * execute_parallel_task() does not change the state of the model, we can mix
370 surf_host_model_t ws_model = surf_host_get_model(host_list[0]);
371 for (i = 1; i < host_nb; i++) {
372 surf_host_model_t ws_model_tmp = surf_host_get_model(host_list[0]);
373 if (ws_model_tmp != ws_model) {
374 XBT_CRITICAL("mixing VMs and PMs is not supported");
379 /* set surf's synchro */
380 if (!MC_is_active() && !MC_record_replay_is_active()) {
381 synchro->execution.surf_exec =
382 surf_host_model_execute_parallel_task(surf_host_model,
383 host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
385 surf_action_set_data(synchro->execution.surf_exec, synchro);
387 XBT_DEBUG("Create parallel execute synchro %p", synchro);
392 void SIMIX_process_execution_destroy(smx_synchro_t synchro){
393 XBT_DEBUG("Destroy synchro %p", synchro);
395 if (synchro->execution.surf_exec) {
396 surf_action_unref(synchro->execution.surf_exec);
397 synchro->execution.surf_exec = NULL;
399 xbt_free(synchro->name);
400 xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
403 void SIMIX_process_execution_cancel(smx_synchro_t synchro){
404 XBT_DEBUG("Cancel synchro %p", synchro);
406 if (synchro->execution.surf_exec)
407 surf_action_cancel(synchro->execution.surf_exec);
410 double SIMIX_process_execution_get_remains(smx_synchro_t synchro){
413 if (synchro->state == SIMIX_RUNNING)
414 result = surf_action_get_remains(synchro->execution.surf_exec);
419 e_smx_state_t SIMIX_process_execution_get_state(smx_synchro_t synchro){
420 return synchro->state;
423 void SIMIX_process_execution_set_priority(smx_synchro_t synchro, double priority){
425 if(synchro->execution.surf_exec)
426 surf_action_set_priority(synchro->execution.surf_exec, priority);
429 void SIMIX_process_execution_set_bound(smx_synchro_t synchro, double bound){
431 if(synchro->execution.surf_exec)
432 surf_cpu_action_set_bound(synchro->execution.surf_exec, bound);
435 void SIMIX_process_execution_set_affinity(smx_synchro_t synchro, sg_host_t host, unsigned long mask){
436 xbt_assert(synchro->type == SIMIX_SYNC_EXECUTE);
438 if (synchro->execution.surf_exec) {
439 /* just a double check to confirm that this host is the host where this task is running. */
440 xbt_assert(synchro->execution.host == host);
441 surf_cpu_action_set_affinity(synchro->execution.surf_exec, host, mask);
445 void simcall_HANDLER_process_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro){
447 XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
449 /* Associate this simcall to the synchro */
450 xbt_fifo_push(synchro->simcalls, simcall);
451 simcall->issuer->waiting_synchro = synchro;
453 /* set surf's synchro */
454 if (MC_is_active() || MC_record_replay_is_active()) {
455 synchro->state = SIMIX_DONE;
456 SIMIX_execution_finish(synchro);
460 /* If the synchro is already finished then perform the error handling */
461 if (synchro->state != SIMIX_RUNNING)
462 SIMIX_execution_finish(synchro);
465 void SIMIX_host_execution_suspend(smx_synchro_t synchro)
467 if(synchro->execution.surf_exec)
468 surf_action_suspend(synchro->execution.surf_exec);
471 void SIMIX_host_execution_resume(smx_synchro_t synchro)
473 if(synchro->execution.surf_exec)
474 surf_action_resume(synchro->execution.surf_exec);
477 void SIMIX_execution_finish(smx_synchro_t synchro)
479 xbt_fifo_item_t item;
480 smx_simcall_t simcall;
482 xbt_fifo_foreach(synchro->simcalls, item, simcall, smx_simcall_t) {
484 switch (synchro->state) {
487 /* do nothing, synchro done */
488 XBT_DEBUG("SIMIX_execution_finished: execution successful");
492 XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_get_name(simcall->issuer->host));
493 simcall->issuer->context->iwannadie = 1;
494 SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
498 XBT_DEBUG("SIMIX_execution_finished: execution canceled");
499 SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
503 xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
504 (int)synchro->state);
506 /* check if the host is down */
507 if (simcall->issuer->host->isOff()) {
508 simcall->issuer->context->iwannadie = 1;
511 simcall->issuer->waiting_synchro = NULL;
512 simcall_process_execution_wait__set__result(simcall, synchro->state);
513 SIMIX_simcall_answer(simcall);
516 /* We no longer need it */
517 SIMIX_process_execution_destroy(synchro);
521 void SIMIX_post_host_execute(smx_synchro_t synchro)
523 if (synchro->type == SIMIX_SYNC_EXECUTE && /* FIMXE: handle resource failure
524 * for parallel tasks too */
525 synchro->execution.host->isOff()) {
526 /* If the host running the synchro failed, notice it so that the asking
527 * process can be killed if it runs on that host itself */
528 synchro->state = SIMIX_FAILED;
529 } else if (surf_action_get_state(synchro->execution.surf_exec) == SURF_ACTION_FAILED) {
530 /* If the host running the synchro didn't fail, then the synchro was
532 synchro->state = SIMIX_CANCELED;
534 synchro->state = SIMIX_DONE;
537 if (synchro->execution.surf_exec) {
538 surf_action_unref(synchro->execution.surf_exec);
539 synchro->execution.surf_exec = NULL;
542 /* If there are simcalls associated with the synchro, then answer them */
543 if (xbt_fifo_size(synchro->simcalls)) {
544 SIMIX_execution_finish(synchro);
549 void SIMIX_set_category(smx_synchro_t synchro, const char *category)
551 if (synchro->state != SIMIX_RUNNING) return;
552 if (synchro->type == SIMIX_SYNC_EXECUTE){
553 surf_action_set_category(synchro->execution.surf_exec, category);
554 }else if (synchro->type == SIMIX_SYNC_COMMUNICATE){
555 surf_action_set_category(synchro->comm.surf_comm, category);
560 * \brief Function to get the parameters of the given the SIMIX host.
562 * \param host the host to get_phys_host (a sg_host_t)
563 * \param param the parameter object space to be overwritten (a ws_params_t)
565 void SIMIX_host_get_params(sg_host_t ind_vm, vm_params_t params)
567 ind_vm->extension<simgrid::surf::Host>()->getParams(params);
570 void SIMIX_host_set_params(sg_host_t ind_vm, vm_params_t params)
572 ind_vm->extension<simgrid::surf::Host>()->setParams(params);
575 xbt_dict_t SIMIX_host_get_mounted_storage_list(sg_host_t host)
577 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
578 return host->extension<simgrid::surf::Host>()->getMountedStorageList();
581 xbt_dynar_t SIMIX_host_get_attached_storage_list(sg_host_t host)
583 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
584 return host->extension<simgrid::surf::Host>()->getAttachedStorageList();