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;
265 void _SIMIX_host_free_process_arg(void *);
266 void _SIMIX_host_free_process_arg(void *data)
268 smx_process_arg_t arg = *(void**)data;
273 * \brief Add a process to the list of the processes that the host will restart when it comes back
274 * This function add a process to the list of the processes that will be restarted when the host comes
275 * back. It is expected that this function is called when the host is down.
276 * The processes will only be restarted once, meaning that you will have to register the process
277 * again to restart the process again.
279 void SIMIX_host_add_auto_restart_process(smx_host_t host,
281 xbt_main_func_t code,
283 const char *hostname,
285 int argc, char **argv,
286 xbt_dict_t properties,
289 if (!SIMIX_host_priv(host)->auto_restart_processes) {
290 SIMIX_host_priv(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
292 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
293 arg->name = xbt_strdup(name);
296 arg->hostname = hostname;
297 arg->kill_time = kill_time;
300 arg->argv = xbt_new(char*,argc + 1);
303 for (i = 0; i < argc; i++) {
304 arg->argv[i] = xbt_strdup(argv[i]);
306 arg->argv[argc] = NULL;
308 arg->properties = properties;
309 arg->auto_restart = auto_restart;
311 if( SIMIX_host_get_state(host) == SURF_RESOURCE_OFF
312 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_name(host))){
313 xbt_dict_set(watched_hosts_lib,sg_host_name(host),host,NULL);
314 XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_name(host));
316 xbt_dynar_push_as(SIMIX_host_priv(host)->auto_restart_processes,smx_process_arg_t,arg);
319 * \brief Restart the list of processes that have been registered to the host
321 void SIMIX_host_restart_processes(smx_host_t host)
324 smx_process_arg_t arg;
325 xbt_dynar_t process_list = SIMIX_host_priv(host)->auto_restart_processes;
326 if(!process_list) return;
328 xbt_dynar_foreach(process_list,cpt,arg) {
330 smx_process_t process;
332 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
333 if (simix_global->create_process_function) {
334 simix_global->create_process_function(&process,
346 simcall_process_create(&process,
359 xbt_dynar_reset(process_list);
362 void SIMIX_host_autorestart(smx_host_t host)
364 if(simix_global->autorestart)
365 simix_global->autorestart(host);
367 xbt_die("No function for simix_global->autorestart");
370 void SIMIX_pre_host_set_data(smx_simcall_t simcall, smx_host_t host, void *data) {
371 SIMIX_host_set_data(host, data);
373 void SIMIX_host_set_data(smx_host_t host, void *data){
374 xbt_assert((host != NULL), "Invalid parameters");
375 xbt_assert((SIMIX_host_priv(host)->data == NULL), "Data already set");
377 SIMIX_host_priv(host)->data = data;
380 smx_action_t SIMIX_pre_host_execute(smx_simcall_t simcall,const char *name,
381 smx_host_t host, double computation_amount, double priority){
382 return SIMIX_host_execute(name, host, computation_amount, priority);
384 smx_action_t SIMIX_host_execute(const char *name,
385 smx_host_t host, double computation_amount, double priority){
387 /* alloc structures and initialize */
388 smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
389 action->type = SIMIX_ACTION_EXECUTE;
390 action->name = xbt_strdup(name);
391 action->state = SIMIX_RUNNING;
392 action->execution.host = host;
395 action->category = NULL;
398 /* set surf's action */
399 if (!MC_is_active()) {
400 action->execution.surf_exec =
401 surf_workstation_model->extension.workstation.execute(host,
403 surf_workstation_model->action_data_set(action->execution.surf_exec, action);
404 surf_workstation_model->set_priority(action->execution.surf_exec, priority);
407 XBT_DEBUG("Create execute action %p", action);
412 smx_action_t SIMIX_pre_host_parallel_execute(smx_simcall_t simcall, const char *name,
413 int host_nb, smx_host_t *host_list,
414 double *computation_amount, double *communication_amount,
415 double amount, double rate){
416 return SIMIX_host_parallel_execute(name, host_nb, host_list, computation_amount,
417 communication_amount, amount, rate);
419 smx_action_t SIMIX_host_parallel_execute(const char *name,
420 int host_nb, smx_host_t *host_list,
421 double *computation_amount, double *communication_amount,
422 double amount, double rate){
424 void **workstation_list = NULL;
427 /* alloc structures and initialize */
428 smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
429 action->type = SIMIX_ACTION_PARALLEL_EXECUTE;
430 action->name = xbt_strdup(name);
431 action->state = SIMIX_RUNNING;
432 action->execution.host = NULL; /* FIXME: do we need the list of hosts? */
435 action->category = NULL;
438 /* set surf's action */
439 workstation_list = xbt_new0(void *, host_nb);
440 for (i = 0; i < host_nb; i++)
441 workstation_list[i] = host_list[i];
443 /* set surf's action */
444 if (!MC_is_active()) {
445 action->execution.surf_exec =
446 surf_workstation_model->extension.workstation.
447 execute_parallel_task(host_nb, workstation_list, computation_amount,
448 communication_amount, rate);
450 surf_workstation_model->action_data_set(action->execution.surf_exec, action);
452 XBT_DEBUG("Create parallel execute action %p", action);
457 void SIMIX_pre_host_execution_destroy(smx_simcall_t simcall, smx_action_t action){
458 SIMIX_host_execution_destroy(action);
460 void SIMIX_host_execution_destroy(smx_action_t action){
461 XBT_DEBUG("Destroy action %p", action);
463 if (action->execution.surf_exec) {
464 surf_workstation_model->action_unref(action->execution.surf_exec);
465 action->execution.surf_exec = NULL;
467 xbt_free(action->name);
468 xbt_mallocator_release(simix_global->action_mallocator, action);
471 void SIMIX_pre_host_execution_cancel(smx_simcall_t simcall, smx_action_t action){
472 SIMIX_host_execution_cancel(action);
474 void SIMIX_host_execution_cancel(smx_action_t action){
475 XBT_DEBUG("Cancel action %p", action);
477 if (action->execution.surf_exec)
478 surf_workstation_model->action_cancel(action->execution.surf_exec);
481 double SIMIX_pre_host_execution_get_remains(smx_simcall_t simcall, smx_action_t action){
482 return SIMIX_host_execution_get_remains(action);
484 double SIMIX_host_execution_get_remains(smx_action_t action){
487 if (action->state == SIMIX_RUNNING)
488 result = surf_workstation_model->get_remains(action->execution.surf_exec);
493 e_smx_state_t SIMIX_pre_host_execution_get_state(smx_simcall_t simcall, smx_action_t action){
494 return SIMIX_host_execution_get_state(action);
496 e_smx_state_t SIMIX_host_execution_get_state(smx_action_t action){
497 return action->state;
500 void SIMIX_pre_host_execution_set_priority(smx_simcall_t simcall, smx_action_t action,
502 return SIMIX_host_execution_set_priority(action, priority);
504 void SIMIX_host_execution_set_priority(smx_action_t action, double priority){
505 if(action->execution.surf_exec)
506 surf_workstation_model->set_priority(action->execution.surf_exec, priority);
509 void SIMIX_pre_host_execution_wait(smx_simcall_t simcall, smx_action_t action){
511 XBT_DEBUG("Wait for execution of action %p, state %d", action, (int)action->state);
513 /* Associate this simcall to the action */
514 xbt_fifo_push(action->simcalls, simcall);
515 simcall->issuer->waiting_action = action;
517 /* set surf's action */
518 if (MC_is_active()) {
519 action->state = SIMIX_DONE;
520 SIMIX_execution_finish(action);
524 /* If the action is already finished then perform the error handling */
525 if (action->state != SIMIX_RUNNING)
526 SIMIX_execution_finish(action);
529 void SIMIX_host_execution_suspend(smx_action_t action)
531 if(action->execution.surf_exec)
532 surf_workstation_model->suspend(action->execution.surf_exec);
535 void SIMIX_host_execution_resume(smx_action_t action)
537 if(action->execution.surf_exec)
538 surf_workstation_model->resume(action->execution.surf_exec);
541 void SIMIX_execution_finish(smx_action_t action)
543 xbt_fifo_item_t item;
544 smx_simcall_t simcall;
546 xbt_fifo_foreach(action->simcalls, item, simcall, smx_simcall_t) {
548 switch (action->state) {
551 /* do nothing, action 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 action state %d",
570 /* check if the host is down */
571 if (surf_workstation_model->extension.
572 workstation.get_state(simcall->issuer->smx_host) != SURF_RESOURCE_ON) {
573 simcall->issuer->context->iwannadie = 1;
576 simcall->issuer->waiting_action = NULL;
577 simcall_host_execution_wait__set__result(simcall, action->state);
578 SIMIX_simcall_answer(simcall);
581 /* We no longer need it */
582 SIMIX_host_execution_destroy(action);
585 void SIMIX_post_host_execute(smx_action_t action)
587 if (action->type == SIMIX_ACTION_EXECUTE && /* FIMXE: handle resource failure
588 * for parallel tasks too */
589 surf_workstation_model->extension.workstation.get_state(action->execution.host) == SURF_RESOURCE_OFF) {
590 /* If the host running the action failed, notice it so that the asking
591 * process can be killed if it runs on that host itself */
592 action->state = SIMIX_FAILED;
593 } else if (surf_workstation_model->action_state_get(action->execution.surf_exec) == SURF_ACTION_FAILED) {
594 /* If the host running the action didn't fail, then the action was
596 action->state = SIMIX_CANCELED;
598 action->state = SIMIX_DONE;
601 if (action->execution.surf_exec) {
602 surf_workstation_model->action_unref(action->execution.surf_exec);
603 action->execution.surf_exec = NULL;
606 /* If there are simcalls associated with the action, then answer them */
607 if (xbt_fifo_size(action->simcalls)) {
608 SIMIX_execution_finish(action);
614 void SIMIX_pre_set_category(smx_simcall_t simcall, smx_action_t action,
615 const char *category){
616 SIMIX_set_category(action, category);
618 void SIMIX_set_category(smx_action_t action, const char *category)
620 if (action->state != SIMIX_RUNNING) return;
621 if (action->type == SIMIX_ACTION_EXECUTE){
622 surf_workstation_model->set_category(action->execution.surf_exec, category);
623 }else if (action->type == SIMIX_ACTION_COMMUNICATE){
624 surf_workstation_model->set_category(action->comm.surf_comm, category);
629 xbt_dynar_t SIMIX_pre_host_get_storage_list(smx_simcall_t simcall, smx_host_t host){
630 return SIMIX_host_get_storage_list(host);
632 xbt_dynar_t SIMIX_host_get_storage_list(smx_host_t host){
633 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
635 return surf_workstation_model->extension.workstation.get_storage_list(host);