1 /* Copyright (c) 2007-2013. 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,
14 "Logging specific to SIMIX (hosts)");
16 static void SIMIX_execution_finish(smx_action_t action);
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->data = data;
32 smx_host->process_list =
33 xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
35 /* Update global variables */
36 xbt_lib_set(host_lib,name,SIMIX_HOST_LEVEL,smx_host);
38 return xbt_lib_get_or_null(host_lib, name, SIMIX_HOST_LEVEL);
42 * \brief Internal function to destroy a SIMIX host.
44 * \param h the host to destroy (a smx_host_t)
46 void SIMIX_host_destroy(void *h)
48 smx_host_priv_t host = (smx_host_priv_t) h;
50 xbt_assert((host != NULL), "Invalid parameters");
52 /* Clean Simulator data */
53 if (xbt_swag_size(host->process_list) != 0) {
54 char *msg = xbt_strdup("Shutting down host, but it's not empty:");
56 smx_process_t process = NULL;
58 xbt_swag_foreach(process, host->process_list) {
59 tmp = bprintf("%s\n\t%s", msg, process->name);
63 SIMIX_display_process_status();
64 THROWF(arg_error, 0, "%s", msg);
66 xbt_dynar_free(&host->auto_restart_processes);
67 xbt_swag_free(host->process_list);
69 /* Clean host structure */
75 // * \brief Returns a dict of all hosts.
77 // * \return List of all hosts (as a #xbt_dict_t)
79 //xbt_dict_t SIMIX_host_get_dict(void)
81 // xbt_dict_t host_dict = xbt_dict_new_homogeneous(NULL);
82 // xbt_lib_cursor_t cursor = NULL;
84 // void **host = NULL;
86 // xbt_lib_foreach(host_lib, cursor, name, host){
87 // if(host[SIMIX_HOST_LEVEL])
88 // xbt_dict_set(host_dict,name,host[SIMIX_HOST_LEVEL], NULL);
92 smx_host_t SIMIX_pre_host_get_by_name(smx_simcall_t simcall, const char *name){
93 return SIMIX_host_get_by_name(name);
95 smx_host_t SIMIX_host_get_by_name(const char *name){
96 xbt_assert(((simix_global != NULL)
97 && (host_lib != NULL)),
98 "Environment not set yet");
100 return xbt_lib_get_elm_or_null(host_lib, name);
103 smx_host_t SIMIX_host_self(void)
105 smx_process_t process = SIMIX_process_self();
106 return (process == NULL) ? NULL : SIMIX_process_get_host(process);
109 const char* SIMIX_pre_host_self_get_name(smx_simcall_t simcall){
110 return SIMIX_host_self_get_name();
112 /* needs to be public and without simcall because it is called
113 by exceptions and logging events */
114 const char* SIMIX_host_self_get_name(void)
116 smx_host_t host = SIMIX_host_self();
117 if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
120 return SIMIX_host_get_name(host);
123 const char* SIMIX_pre_host_get_name(smx_simcall_t simcall, smx_host_t host){
124 return SIMIX_host_get_name(host);
126 const char* SIMIX_host_get_name(smx_host_t host){
127 xbt_assert((host != NULL), "Invalid parameters");
129 return sg_host_name(host);
132 xbt_dict_t SIMIX_pre_host_get_properties(smx_simcall_t simcall, smx_host_t host){
133 return SIMIX_host_get_properties(host);
135 xbt_dict_t SIMIX_host_get_properties(smx_host_t host){
136 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
138 return surf_workstation_model->extension.workstation.get_properties(host);
141 double SIMIX_pre_host_get_speed(smx_simcall_t simcall, smx_host_t host){
142 return SIMIX_host_get_speed(host);
144 double SIMIX_host_get_speed(smx_host_t host){
145 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
147 return surf_workstation_model->extension.workstation.
148 get_speed(host, 1.0);
151 int SIMIX_pre_host_get_core(smx_simcall_t simcall, smx_host_t host){
152 return SIMIX_host_get_core(host);
154 int SIMIX_host_get_core(smx_host_t host){
155 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
157 return surf_workstation_model->extension.workstation.
161 xbt_swag_t SIMIX_pre_host_get_process_list(smx_simcall_t simcall, smx_host_t host){
162 return SIMIX_host_get_process_list(host);
165 xbt_swag_t SIMIX_host_get_process_list(smx_host_t host){
166 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
167 smx_host_priv_t host_priv = SIMIX_host_priv(host);
169 return host_priv->process_list;
173 double SIMIX_pre_host_get_available_speed(smx_simcall_t simcall, smx_host_t host){
174 return SIMIX_host_get_available_speed(host);
176 double SIMIX_host_get_available_speed(smx_host_t host){
177 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
179 return surf_workstation_model->extension.workstation.
180 get_available_speed(host);
183 double SIMIX_pre_host_get_current_power_peak(smx_simcall_t simcall, smx_host_t host){
184 return SIMIX_host_get_current_power_peak(host);
186 double SIMIX_host_get_current_power_peak(smx_host_t host) {
187 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
188 return surf_workstation_model->extension.workstation.
189 get_current_power_peak(host);
192 double SIMIX_pre_host_get_power_peak_at(smx_simcall_t simcall, smx_host_t host, int pstate_index){
193 return SIMIX_host_get_power_peak_at(host, pstate_index);
195 double SIMIX_host_get_power_peak_at(smx_host_t host, int pstate_index) {
196 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
198 return surf_workstation_model->extension.workstation.
199 get_power_peak_at(host, pstate_index);
202 int SIMIX_pre_host_get_nb_pstates(smx_simcall_t simcall, smx_host_t host){
203 return SIMIX_host_get_nb_pstates(host);
205 int SIMIX_host_get_nb_pstates(smx_host_t host) {
206 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
208 return surf_workstation_model->extension.workstation.
209 get_nb_pstates(host);
213 void SIMIX_pre_host_set_power_peak_at(smx_simcall_t simcall, smx_host_t host, int pstate_index){
214 SIMIX_host_set_power_peak_at(host, pstate_index);
216 void SIMIX_host_set_power_peak_at(smx_host_t host, int pstate_index) {
217 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
219 surf_workstation_model->extension.workstation.
220 set_power_peak_at(host, pstate_index);
223 double SIMIX_pre_host_get_consumed_energy(smx_simcall_t simcall, smx_host_t host){
224 return SIMIX_host_get_consumed_energy(host);
226 double SIMIX_host_get_consumed_energy(smx_host_t host) {
227 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
228 return surf_workstation_model->extension.workstation.
229 get_consumed_energy(host);
232 int SIMIX_pre_host_get_state(smx_simcall_t simcall, smx_host_t host){
233 return SIMIX_host_get_state(host);
235 int SIMIX_host_get_state(smx_host_t host){
236 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
238 return surf_workstation_model->extension.workstation.
242 void* SIMIX_pre_host_self_get_data(smx_simcall_t simcall){
243 return SIMIX_host_self_get_data();
245 void* SIMIX_host_self_get_data(void)
247 smx_host_t self = SIMIX_host_self();
248 return SIMIX_host_get_data(self);
251 void SIMIX_host_self_set_data(void *data)
253 smx_host_t self = SIMIX_host_self();
254 SIMIX_host_set_data(self, data);
257 void* SIMIX_pre_host_get_data(smx_simcall_t simcall,smx_host_t host){
258 return SIMIX_host_get_data(host);
260 void* SIMIX_host_get_data(smx_host_t host){
261 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
263 return SIMIX_host_priv(host)->data;
266 static void _SIMIX_host_free_process_arg(void *data)
268 smx_process_arg_t arg = *(void**)data;
270 for (i = 0; i < arg->argc; i++)
271 xbt_free(arg->argv[i]);
277 * \brief Add a process to the list of the processes that the host will restart when it comes back
278 * This function add a process to the list of the processes that will be restarted when the host comes
279 * back. It is expected that this function is called when the host is down.
280 * The processes will only be restarted once, meaning that you will have to register the process
281 * again to restart the process again.
283 void SIMIX_host_add_auto_restart_process(smx_host_t host,
285 xbt_main_func_t code,
287 const char *hostname,
289 int argc, char **argv,
290 xbt_dict_t properties,
293 if (!SIMIX_host_priv(host)->auto_restart_processes) {
294 SIMIX_host_priv(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
296 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
297 arg->name = xbt_strdup(name);
300 arg->hostname = hostname;
301 arg->kill_time = kill_time;
304 arg->argv = xbt_new(char*,argc + 1);
307 for (i = 0; i < argc; i++) {
308 arg->argv[i] = xbt_strdup(argv[i]);
310 arg->argv[argc] = NULL;
312 arg->properties = properties;
313 arg->auto_restart = auto_restart;
315 if( SIMIX_host_get_state(host) == SURF_RESOURCE_OFF
316 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_name(host))){
317 xbt_dict_set(watched_hosts_lib,sg_host_name(host),host,NULL);
318 XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_name(host));
320 xbt_dynar_push_as(SIMIX_host_priv(host)->auto_restart_processes,smx_process_arg_t,arg);
323 * \brief Restart the list of processes that have been registered to the host
325 void SIMIX_host_restart_processes(smx_host_t host)
328 smx_process_arg_t arg;
329 xbt_dynar_t process_list = SIMIX_host_priv(host)->auto_restart_processes;
333 xbt_dynar_foreach (process_list, cpt, arg) {
335 smx_process_t process;
337 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
338 if (simix_global->create_process_function) {
339 simix_global->create_process_function(&process,
350 simcall_process_create(&process,
362 /* arg->argv is used by the process created above. Hide it to
363 * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
368 xbt_dynar_reset(process_list);
371 void SIMIX_host_autorestart(smx_host_t host)
373 if(simix_global->autorestart)
374 simix_global->autorestart(host);
376 xbt_die("No function for simix_global->autorestart");
379 void SIMIX_pre_host_set_data(smx_simcall_t simcall, smx_host_t host, void *data) {
380 SIMIX_host_set_data(host, data);
382 void SIMIX_host_set_data(smx_host_t host, void *data){
383 xbt_assert((host != NULL), "Invalid parameters");
384 xbt_assert((SIMIX_host_priv(host)->data == NULL), "Data already set");
386 SIMIX_host_priv(host)->data = data;
389 smx_action_t SIMIX_pre_host_execute(smx_simcall_t simcall,const char *name,
390 smx_host_t host, double computation_amount, double priority){
391 return SIMIX_host_execute(name, host, computation_amount, priority);
393 smx_action_t SIMIX_host_execute(const char *name,
394 smx_host_t host, double computation_amount, double priority){
396 /* alloc structures and initialize */
397 smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
398 action->type = SIMIX_ACTION_EXECUTE;
399 action->name = xbt_strdup(name);
400 action->state = SIMIX_RUNNING;
401 action->execution.host = host;
404 action->category = NULL;
407 /* set surf's action */
408 if (!MC_is_active()) {
409 action->execution.surf_exec =
410 surf_workstation_model->extension.workstation.execute(host,
412 surf_workstation_model->action_data_set(action->execution.surf_exec, action);
413 surf_workstation_model->set_priority(action->execution.surf_exec, priority);
416 XBT_DEBUG("Create execute action %p", action);
421 smx_action_t SIMIX_pre_host_parallel_execute(smx_simcall_t simcall, const char *name,
422 int host_nb, smx_host_t *host_list,
423 double *computation_amount, double *communication_amount,
424 double amount, double rate){
425 return SIMIX_host_parallel_execute(name, host_nb, host_list, computation_amount,
426 communication_amount, amount, rate);
428 smx_action_t SIMIX_host_parallel_execute(const char *name,
429 int host_nb, smx_host_t *host_list,
430 double *computation_amount, double *communication_amount,
431 double amount, double rate){
433 void **workstation_list = NULL;
436 /* alloc structures and initialize */
437 smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
438 action->type = SIMIX_ACTION_PARALLEL_EXECUTE;
439 action->name = xbt_strdup(name);
440 action->state = SIMIX_RUNNING;
441 action->execution.host = NULL; /* FIXME: do we need the list of hosts? */
444 action->category = NULL;
447 /* set surf's action */
448 workstation_list = xbt_new0(void *, host_nb);
449 for (i = 0; i < host_nb; i++)
450 workstation_list[i] = host_list[i];
452 /* set surf's action */
453 if (!MC_is_active()) {
454 action->execution.surf_exec =
455 surf_workstation_model->extension.workstation.
456 execute_parallel_task(host_nb, workstation_list, computation_amount,
457 communication_amount, rate);
459 surf_workstation_model->action_data_set(action->execution.surf_exec, action);
461 XBT_DEBUG("Create parallel execute action %p", action);
466 void SIMIX_pre_host_execution_destroy(smx_simcall_t simcall, smx_action_t action){
467 SIMIX_host_execution_destroy(action);
469 void SIMIX_host_execution_destroy(smx_action_t action){
470 XBT_DEBUG("Destroy action %p", action);
472 if (action->execution.surf_exec) {
473 surf_workstation_model->action_unref(action->execution.surf_exec);
474 action->execution.surf_exec = NULL;
476 xbt_free(action->name);
477 xbt_mallocator_release(simix_global->action_mallocator, action);
480 void SIMIX_pre_host_execution_cancel(smx_simcall_t simcall, smx_action_t action){
481 SIMIX_host_execution_cancel(action);
483 void SIMIX_host_execution_cancel(smx_action_t action){
484 XBT_DEBUG("Cancel action %p", action);
486 if (action->execution.surf_exec)
487 surf_workstation_model->action_cancel(action->execution.surf_exec);
490 double SIMIX_pre_host_execution_get_remains(smx_simcall_t simcall, smx_action_t action){
491 return SIMIX_host_execution_get_remains(action);
493 double SIMIX_host_execution_get_remains(smx_action_t action){
496 if (action->state == SIMIX_RUNNING)
497 result = surf_workstation_model->get_remains(action->execution.surf_exec);
502 e_smx_state_t SIMIX_pre_host_execution_get_state(smx_simcall_t simcall, smx_action_t action){
503 return SIMIX_host_execution_get_state(action);
505 e_smx_state_t SIMIX_host_execution_get_state(smx_action_t action){
506 return action->state;
509 void SIMIX_pre_host_execution_set_priority(smx_simcall_t simcall, smx_action_t action,
511 return SIMIX_host_execution_set_priority(action, priority);
513 void SIMIX_host_execution_set_priority(smx_action_t action, double priority){
514 if(action->execution.surf_exec)
515 surf_workstation_model->set_priority(action->execution.surf_exec, priority);
518 void SIMIX_pre_host_execution_wait(smx_simcall_t simcall, smx_action_t action){
520 XBT_DEBUG("Wait for execution of action %p, state %d", action, (int)action->state);
522 /* Associate this simcall to the action */
523 xbt_fifo_push(action->simcalls, simcall);
524 simcall->issuer->waiting_action = action;
526 /* set surf's action */
527 if (MC_is_active()) {
528 action->state = SIMIX_DONE;
529 SIMIX_execution_finish(action);
533 /* If the action is already finished then perform the error handling */
534 if (action->state != SIMIX_RUNNING)
535 SIMIX_execution_finish(action);
538 void SIMIX_host_execution_suspend(smx_action_t action)
540 if(action->execution.surf_exec)
541 surf_workstation_model->suspend(action->execution.surf_exec);
544 void SIMIX_host_execution_resume(smx_action_t action)
546 if(action->execution.surf_exec)
547 surf_workstation_model->resume(action->execution.surf_exec);
550 void SIMIX_execution_finish(smx_action_t action)
552 xbt_fifo_item_t item;
553 smx_simcall_t simcall;
555 xbt_fifo_foreach(action->simcalls, item, simcall, smx_simcall_t) {
557 switch (action->state) {
560 /* do nothing, action done */
561 XBT_DEBUG("SIMIX_execution_finished: execution successful");
565 XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_name(simcall->issuer->smx_host));
566 simcall->issuer->context->iwannadie = 1;
567 SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
571 XBT_DEBUG("SIMIX_execution_finished: execution canceled");
572 SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
576 xbt_die("Internal error in SIMIX_execution_finish: unexpected action state %d",
579 /* check if the host is down */
580 if (surf_workstation_model->extension.
581 workstation.get_state(simcall->issuer->smx_host) != SURF_RESOURCE_ON) {
582 simcall->issuer->context->iwannadie = 1;
585 simcall->issuer->waiting_action = NULL;
586 simcall_host_execution_wait__set__result(simcall, action->state);
587 SIMIX_simcall_answer(simcall);
590 /* We no longer need it */
591 SIMIX_host_execution_destroy(action);
594 void SIMIX_post_host_execute(smx_action_t action)
596 if (action->type == SIMIX_ACTION_EXECUTE && /* FIMXE: handle resource failure
597 * for parallel tasks too */
598 surf_workstation_model->extension.workstation.get_state(action->execution.host) == SURF_RESOURCE_OFF) {
599 /* If the host running the action failed, notice it so that the asking
600 * process can be killed if it runs on that host itself */
601 action->state = SIMIX_FAILED;
602 } else if (surf_workstation_model->action_state_get(action->execution.surf_exec) == SURF_ACTION_FAILED) {
603 /* If the host running the action didn't fail, then the action was
605 action->state = SIMIX_CANCELED;
607 action->state = SIMIX_DONE;
610 if (action->execution.surf_exec) {
611 surf_workstation_model->action_unref(action->execution.surf_exec);
612 action->execution.surf_exec = NULL;
615 /* If there are simcalls associated with the action, then answer them */
616 if (xbt_fifo_size(action->simcalls)) {
617 SIMIX_execution_finish(action);
623 void SIMIX_pre_set_category(smx_simcall_t simcall, smx_action_t action,
624 const char *category){
625 SIMIX_set_category(action, category);
627 void SIMIX_set_category(smx_action_t action, const char *category)
629 if (action->state != SIMIX_RUNNING) return;
630 if (action->type == SIMIX_ACTION_EXECUTE){
631 surf_workstation_model->set_category(action->execution.surf_exec, category);
632 }else if (action->type == SIMIX_ACTION_COMMUNICATE){
633 surf_workstation_model->set_category(action->comm.surf_comm, category);
638 xbt_dict_t SIMIX_pre_host_get_storage_list(smx_simcall_t simcall, smx_host_t host){
639 return SIMIX_host_get_storage_list(host);
641 xbt_dict_t SIMIX_host_get_storage_list(smx_host_t host){
642 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
644 return surf_workstation_model->extension.workstation.get_storage_list(host);