1 /* Copyright (c) 2007-2014. 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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
16 static void SIMIX_execution_finish(smx_synchro_t synchro);
19 * \brief Internal function to create a SIMIX host.
20 * \param name name of the host to create
21 * \param workstation the SURF workstation to encapsulate
22 * \param data some user data (may be NULL)
24 smx_host_t SIMIX_host_create(const char *name,
25 void *workstation, void *data)
27 smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
31 smx_host->process_list =
32 xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
34 /* Update global variables */
35 xbt_lib_set(host_lib,name,SIMIX_HOST_LEVEL,smx_host);
37 return xbt_lib_get_elm_or_null(host_lib, name);
41 * \brief Start the host if it is off
44 void SIMIX_host_on(smx_host_t h)
46 smx_host_priv_t host = SIMIX_host_priv(h);
48 xbt_assert((host != NULL), "Invalid parameters");
50 if (surf_resource_get_state(surf_workstation_resource_priv(h))==SURF_RESOURCE_OFF) {
51 surf_resource_set_state(surf_workstation_resource_priv(h), SURF_RESOURCE_ON);
54 smx_process_arg_t arg;
55 xbt_dynar_foreach(host->boot_processes,cpt,arg) {
56 smx_process_t process;
58 char** argv = xbt_new(char*, arg->argc);
59 for (int i=0; i<arg->argc; i++)
60 argv[i] = xbt_strdup(arg->argv[i]);
62 XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
63 if (simix_global->create_process_function) {
64 simix_global->create_process_function(&process,
76 simcall_process_create(&process,
91 void simcall_HANDLER_host_off(smx_simcall_t simcall, smx_host_t h)
93 SIMIX_host_off(h, simcall->issuer);
97 * \brief Stop the host if it is on
100 void SIMIX_host_off(smx_host_t h, smx_process_t issuer)
102 smx_host_priv_t host = SIMIX_host_priv(h);
104 xbt_assert((host != NULL), "Invalid parameters");
106 if (surf_resource_get_state(surf_workstation_resource_priv(h))==SURF_RESOURCE_ON) {
107 surf_resource_set_state(surf_workstation_resource_priv(h), SURF_RESOURCE_OFF);
109 /* Clean Simulator data */
110 if (xbt_swag_size(host->process_list) != 0) {
111 smx_process_t process = NULL;
112 xbt_swag_foreach(process, host->process_list) {
113 SIMIX_process_kill(process, issuer);
114 XBT_DEBUG("Killing %s on %s by %s", process->name, sg_host_name(process->smx_host), issuer->name);
121 * \brief Internal function to destroy a SIMIX host.
123 * \param h the host to destroy (a smx_host_t)
125 void SIMIX_host_destroy(void *h)
127 smx_host_priv_t host = (smx_host_priv_t) h;
129 xbt_assert((host != NULL), "Invalid parameters");
131 /* Clean Simulator data */
132 if (xbt_swag_size(host->process_list) != 0) {
133 char *msg = xbt_strdup("Shutting down host, but it's not empty:");
135 smx_process_t process = NULL;
137 xbt_swag_foreach(process, host->process_list) {
138 tmp = bprintf("%s\n\t%s", msg, process->name);
142 SIMIX_display_process_status();
143 THROWF(arg_error, 0, "%s", msg);
145 xbt_dynar_free(&host->auto_restart_processes);
146 xbt_dynar_free(&host->boot_processes);
147 xbt_swag_free(host->process_list);
149 /* Clean host structure */
154 smx_host_t SIMIX_host_get_by_name(const char *name){
155 xbt_assert(((simix_global != NULL)
156 && (host_lib != NULL)),
157 "Environment not set yet");
159 return xbt_lib_get_elm_or_null(host_lib, name);
162 smx_host_t SIMIX_host_self(void)
164 smx_process_t process = SIMIX_process_self();
165 return (process == NULL) ? NULL : SIMIX_process_get_host(process);
168 /* needs to be public and without simcall because it is called
169 by exceptions and logging events */
170 const char* SIMIX_host_self_get_name(void)
172 smx_host_t host = SIMIX_host_self();
173 if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
176 return SIMIX_host_get_name(host);
179 const char* SIMIX_host_get_name(smx_host_t host){
180 xbt_assert((host != NULL), "Invalid parameters");
182 return sg_host_name(host);
185 xbt_dict_t SIMIX_host_get_properties(smx_host_t host){
186 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
188 return surf_resource_get_properties(surf_workstation_resource_priv(host));
191 double SIMIX_host_get_speed(smx_host_t host){
192 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
193 return surf_workstation_get_speed(host, 1.0);
196 int SIMIX_host_get_core(smx_host_t host){
197 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
199 return surf_workstation_get_core(host);
202 xbt_swag_t SIMIX_host_get_process_list(smx_host_t host){
203 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
204 smx_host_priv_t host_priv = SIMIX_host_priv(host);
206 return host_priv->process_list;
210 double SIMIX_host_get_available_speed(smx_host_t host){
211 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
213 return surf_workstation_get_available_speed(host);
216 double SIMIX_host_get_current_power_peak(smx_host_t host) {
217 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
218 return surf_workstation_get_current_power_peak(host);
221 double SIMIX_host_get_power_peak_at(smx_host_t host, int pstate_index) {
222 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
224 return surf_workstation_get_power_peak_at(host, pstate_index);
227 int SIMIX_host_get_nb_pstates(smx_host_t host) {
228 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
230 return surf_workstation_get_nb_pstates(host);
234 void SIMIX_host_set_power_peak_at(smx_host_t host, int pstate_index) {
235 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
237 surf_workstation_set_power_peak_at(host, pstate_index);
240 double SIMIX_host_get_consumed_energy(smx_host_t host) {
241 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
242 return surf_workstation_get_consumed_energy(host);
245 int SIMIX_host_get_state(smx_host_t host){
246 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
248 return surf_resource_get_state(surf_workstation_resource_priv(host));
251 void _SIMIX_host_free_process_arg(void *data)
253 smx_process_arg_t arg = *(void**)data;
255 for (i = 0; i < arg->argc; i++)
256 xbt_free(arg->argv[i]);
262 * \brief Add a process to the list of the processes that the host will restart when it comes back
263 * This function add a process to the list of the processes that will be restarted when the host comes
264 * back. It is expected that this function is called when the host is down.
265 * The processes will only be restarted once, meaning that you will have to register the process
266 * again to restart the process again.
268 void SIMIX_host_add_auto_restart_process(smx_host_t host,
270 xbt_main_func_t code,
272 const char *hostname,
274 int argc, char **argv,
275 xbt_dict_t properties,
278 if (!SIMIX_host_priv(host)->auto_restart_processes) {
279 SIMIX_host_priv(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
281 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
282 arg->name = xbt_strdup(name);
285 arg->hostname = hostname;
286 arg->kill_time = kill_time;
289 arg->argv = xbt_new(char*,argc + 1);
292 for (i = 0; i < argc; i++) {
293 arg->argv[i] = xbt_strdup(argv[i]);
295 arg->argv[argc] = NULL;
297 arg->properties = properties;
298 arg->auto_restart = auto_restart;
300 if( SIMIX_host_get_state(host) == SURF_RESOURCE_OFF
301 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_name(host))){
302 xbt_dict_set(watched_hosts_lib,sg_host_name(host),host,NULL);
303 XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_name(host));
305 xbt_dynar_push_as(SIMIX_host_priv(host)->auto_restart_processes,smx_process_arg_t,arg);
308 * \brief Restart the list of processes that have been registered to the host
310 void SIMIX_host_restart_processes(smx_host_t host)
313 smx_process_arg_t arg;
314 xbt_dynar_t process_list = SIMIX_host_priv(host)->auto_restart_processes;
318 xbt_dynar_foreach (process_list, cpt, arg) {
320 smx_process_t process;
322 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
323 if (simix_global->create_process_function) {
324 simix_global->create_process_function(&process,
336 simcall_process_create(&process,
348 /* arg->argv is used by the process created above. Hide it to
349 * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
354 xbt_dynar_reset(process_list);
357 void SIMIX_host_autorestart(smx_host_t host)
359 if(simix_global->autorestart)
360 simix_global->autorestart(host);
362 xbt_die("No function for simix_global->autorestart");
365 smx_synchro_t SIMIX_host_execute(const char *name,
366 smx_host_t host, double computation_amount, double priority, double bound, unsigned long affinity_mask){
368 /* alloc structures and initialize */
369 smx_synchro_t synchro = xbt_mallocator_get(simix_global->synchro_mallocator);
370 synchro->type = SIMIX_SYNC_EXECUTE;
371 synchro->name = xbt_strdup(name);
372 synchro->state = SIMIX_RUNNING;
373 synchro->execution.host = host;
376 synchro->category = NULL;
379 /* set surf's action */
380 if (!MC_is_active() && !MC_record_replay_is_active()) {
382 synchro->execution.surf_exec = surf_workstation_execute(host, computation_amount);
383 surf_action_set_data(synchro->execution.surf_exec, synchro);
384 surf_action_set_priority(synchro->execution.surf_exec, priority);
386 /* Note (hypervisor): for multicore, the bound value being passed to the
387 * surf layer should not be zero (i.e., unlimited). It should be the
388 * capacity of a CPU core. */
390 surf_cpu_action_set_bound(synchro->execution.surf_exec, SIMIX_host_get_speed(host));
392 surf_cpu_action_set_bound(synchro->execution.surf_exec, bound);
394 if (affinity_mask != 0) {
395 /* just a double check to confirm that this host is the host where this task is running. */
396 xbt_assert(synchro->execution.host == host);
397 surf_cpu_action_set_affinity(synchro->execution.surf_exec, host, affinity_mask);
401 XBT_DEBUG("Create execute synchro %p: %s", synchro, synchro->name);
406 smx_synchro_t SIMIX_host_parallel_execute(const char *name,
407 int host_nb, smx_host_t *host_list,
408 double *computation_amount, double *communication_amount,
409 double amount, double rate){
411 void **workstation_list = NULL;
414 /* alloc structures and initialize */
415 smx_synchro_t synchro = xbt_mallocator_get(simix_global->synchro_mallocator);
416 synchro->type = SIMIX_SYNC_PARALLEL_EXECUTE;
417 synchro->name = xbt_strdup(name);
418 synchro->state = SIMIX_RUNNING;
419 synchro->execution.host = NULL; /* FIXME: do we need the list of hosts? */
422 synchro->category = NULL;
425 /* set surf's synchro */
426 workstation_list = xbt_new0(void *, host_nb);
427 for (i = 0; i < host_nb; i++)
428 workstation_list[i] = surf_workstation_resource_priv(host_list[i]);
431 /* FIXME: what happens if host_list contains VMs and PMs. If
432 * execute_parallel_task() does not change the state of the model, we can mix
434 surf_model_t ws_model = surf_resource_model(host_list[0], SURF_WKS_LEVEL);
435 for (i = 1; i < host_nb; i++) {
436 surf_model_t ws_model_tmp = surf_resource_model(host_list[i], SURF_WKS_LEVEL);
437 if (ws_model_tmp != ws_model) {
438 XBT_CRITICAL("mixing VMs and PMs is not supported");
443 /* set surf's synchro */
444 if (!MC_is_active() && !MC_record_replay_is_active()) {
445 synchro->execution.surf_exec =
446 surf_workstation_model_execute_parallel_task((surf_workstation_model_t)surf_workstation_model,
447 host_nb, workstation_list, computation_amount, communication_amount, rate);
449 surf_action_set_data(synchro->execution.surf_exec, synchro);
451 XBT_DEBUG("Create parallel execute synchro %p", synchro);
456 void SIMIX_host_execution_destroy(smx_synchro_t synchro){
457 XBT_DEBUG("Destroy synchro %p", synchro);
459 if (synchro->execution.surf_exec) {
460 surf_action_unref(synchro->execution.surf_exec);
461 synchro->execution.surf_exec = NULL;
463 xbt_free(synchro->name);
464 xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
467 void SIMIX_host_execution_cancel(smx_synchro_t synchro){
468 XBT_DEBUG("Cancel synchro %p", synchro);
470 if (synchro->execution.surf_exec)
471 surf_action_cancel(synchro->execution.surf_exec);
474 double SIMIX_host_execution_get_remains(smx_synchro_t synchro){
477 if (synchro->state == SIMIX_RUNNING)
478 result = surf_action_get_remains(synchro->execution.surf_exec);
483 e_smx_state_t SIMIX_host_execution_get_state(smx_synchro_t synchro){
484 return synchro->state;
487 void SIMIX_host_execution_set_priority(smx_synchro_t synchro, double priority){
489 if(synchro->execution.surf_exec)
490 surf_action_set_priority(synchro->execution.surf_exec, priority);
493 void SIMIX_host_execution_set_bound(smx_synchro_t synchro, double bound){
495 if(synchro->execution.surf_exec)
496 surf_cpu_action_set_bound(synchro->execution.surf_exec, bound);
499 void SIMIX_host_execution_set_affinity(smx_synchro_t synchro, smx_host_t host, unsigned long mask){
500 xbt_assert(synchro->type == SIMIX_SYNC_EXECUTE);
502 if (synchro->execution.surf_exec) {
503 /* just a double check to confirm that this host is the host where this task is running. */
504 xbt_assert(synchro->execution.host == host);
505 surf_cpu_action_set_affinity(synchro->execution.surf_exec, host, mask);
509 void simcall_HANDLER_host_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro){
511 XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
513 /* Associate this simcall to the synchro */
514 xbt_fifo_push(synchro->simcalls, simcall);
515 simcall->issuer->waiting_synchro = synchro;
517 /* set surf's synchro */
518 if (MC_is_active() || MC_record_replay_is_active()) {
519 synchro->state = SIMIX_DONE;
520 SIMIX_execution_finish(synchro);
524 /* If the synchro is already finished then perform the error handling */
525 if (synchro->state != SIMIX_RUNNING)
526 SIMIX_execution_finish(synchro);
529 void SIMIX_host_execution_suspend(smx_synchro_t synchro)
531 if(synchro->execution.surf_exec)
532 surf_action_suspend(synchro->execution.surf_exec);
535 void SIMIX_host_execution_resume(smx_synchro_t synchro)
537 if(synchro->execution.surf_exec)
538 surf_action_resume(synchro->execution.surf_exec);
541 void SIMIX_execution_finish(smx_synchro_t synchro)
543 xbt_fifo_item_t item;
544 smx_simcall_t simcall;
546 xbt_fifo_foreach(synchro->simcalls, item, simcall, smx_simcall_t) {
548 switch (synchro->state) {
551 /* do nothing, synchro done */
552 XBT_DEBUG("SIMIX_execution_finished: execution successful");
556 XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_name(simcall->issuer->smx_host));
557 simcall->issuer->context->iwannadie = 1;
558 SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
562 XBT_DEBUG("SIMIX_execution_finished: execution canceled");
563 SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
567 xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
568 (int)synchro->state);
570 /* check if the host is down */
571 if (surf_resource_get_state(surf_workstation_resource_priv(simcall->issuer->smx_host)) != SURF_RESOURCE_ON) {
572 simcall->issuer->context->iwannadie = 1;
575 simcall->issuer->waiting_synchro = NULL;
576 simcall_host_execution_wait__set__result(simcall, synchro->state);
577 SIMIX_simcall_answer(simcall);
580 /* We no longer need it */
581 SIMIX_host_execution_destroy(synchro);
585 void SIMIX_post_host_execute(smx_synchro_t synchro)
587 if (synchro->type == SIMIX_SYNC_EXECUTE && /* FIMXE: handle resource failure
588 * for parallel tasks too */
589 surf_resource_get_state(surf_workstation_resource_priv(synchro->execution.host)) == SURF_RESOURCE_OFF) {
590 /* If the host running the synchro failed, notice it so that the asking
591 * process can be killed if it runs on that host itself */
592 synchro->state = SIMIX_FAILED;
593 } else if (surf_action_get_state(synchro->execution.surf_exec) == SURF_ACTION_FAILED) {
594 /* If the host running the synchro didn't fail, then the synchro was
596 synchro->state = SIMIX_CANCELED;
598 synchro->state = SIMIX_DONE;
601 if (synchro->execution.surf_exec) {
602 surf_action_unref(synchro->execution.surf_exec);
603 synchro->execution.surf_exec = NULL;
606 /* If there are simcalls associated with the synchro, then answer them */
607 if (xbt_fifo_size(synchro->simcalls)) {
608 SIMIX_execution_finish(synchro);
614 void SIMIX_set_category(smx_synchro_t synchro, const char *category)
616 if (synchro->state != SIMIX_RUNNING) return;
617 if (synchro->type == SIMIX_SYNC_EXECUTE){
618 surf_action_set_category(synchro->execution.surf_exec, category);
619 }else if (synchro->type == SIMIX_SYNC_COMMUNICATE){
620 surf_action_set_category(synchro->comm.surf_comm, category);
626 * \brief Function to get the parameters of the given the SIMIX host.
628 * \param host the host to get_phys_host (a smx_host_t)
629 * \param param the parameter object space to be overwritten (a ws_params_t)
631 void SIMIX_host_get_params(smx_host_t ind_vm, ws_params_t params)
633 /* jump to ws_get_params(). */
634 surf_workstation_get_params(ind_vm, params);
637 void SIMIX_host_set_params(smx_host_t ind_vm, ws_params_t params)
639 /* jump to ws_set_params(). */
640 surf_workstation_set_params(ind_vm, params);
643 xbt_dict_t SIMIX_host_get_mounted_storage_list(smx_host_t host){
644 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
646 return surf_workstation_get_mounted_storage_list(host);
649 xbt_dynar_t SIMIX_host_get_attached_storage_list(smx_host_t host){
650 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
652 return surf_workstation_get_attached_storage_list(host);