1 /* Copyright (c) 2007-2012. 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_elm_or_null(host_lib, name);
41 void SIMIX_pre_host_on(smx_simcall_t simcall, smx_host_t h)
47 * \brief Start the host if it is off
50 void SIMIX_host_on(smx_host_t h)
52 smx_host_priv_t host = SIMIX_host_priv(h);
54 xbt_assert((host != NULL), "Invalid parameters");
56 surf_model_t ws_model = surf_resource_model(h, SURF_WKS_LEVEL);
57 if (ws_model->extension.workstation.get_state(h)==SURF_RESOURCE_OFF) {
58 ws_model->extension.workstation.set_state(h, SURF_RESOURCE_ON);
60 smx_process_arg_t arg;
61 xbt_dynar_foreach(host->boot_processes,cpt,arg) {
62 smx_process_t process;
64 XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
65 if (simix_global->create_process_function) {
66 simix_global->create_process_function(&process,
78 simcall_process_create(&process,
93 void SIMIX_pre_host_off(smx_simcall_t simcall, smx_host_t h)
95 SIMIX_host_off(h, simcall->issuer);
99 * \brief Stop the host if it is on
102 void SIMIX_host_off(smx_host_t h, smx_process_t issuer)
104 smx_host_priv_t host = SIMIX_host_priv(h);
106 xbt_assert((host != NULL), "Invalid parameters");
108 surf_model_t ws_model = surf_resource_model(h, SURF_WKS_LEVEL);
109 if (ws_model->extension.workstation.get_state(h)==SURF_RESOURCE_ON) {
110 ws_model->extension.workstation.set_state(h, SURF_RESOURCE_OFF);
112 /* Clean Simulator data */
113 if (xbt_swag_size(host->process_list) != 0) {
114 smx_process_t process = NULL;
115 xbt_swag_foreach(process, host->process_list) {
116 SIMIX_process_kill(process, issuer);
117 XBT_DEBUG("Killing %s on %s by %s", process->name, sg_host_name(process->smx_host), issuer->name);
124 * \brief Internal function to destroy a SIMIX host.
126 * \param h the host to destroy (a smx_host_t)
128 void SIMIX_host_destroy(void *h)
130 smx_host_priv_t host = (smx_host_priv_t) h;
132 xbt_assert((host != NULL), "Invalid parameters");
134 /* Clean Simulator data */
135 if (xbt_swag_size(host->process_list) != 0) {
136 char *msg = xbt_strdup("Shutting down host, but it's not empty:");
138 smx_process_t process = NULL;
140 xbt_swag_foreach(process, host->process_list) {
141 tmp = bprintf("%s\n\t%s", msg, process->name);
145 SIMIX_display_process_status();
146 THROWF(arg_error, 0, "%s", msg);
148 xbt_dynar_free(&host->auto_restart_processes);
149 xbt_dynar_free(&host->boot_processes);
150 xbt_swag_free(host->process_list);
152 /* Clean host structure */
158 // * \brief Returns a dict of all hosts.
160 // * \return List of all hosts (as a #xbt_dict_t)
162 //xbt_dict_t SIMIX_host_get_dict(void)
164 // xbt_dict_t host_dict = xbt_dict_new_homogeneous(NULL);
165 // xbt_lib_cursor_t cursor = NULL;
166 // char *name = NULL;
167 // void **host = NULL;
169 // xbt_lib_foreach(host_lib, cursor, name, host){
170 // if(host[SIMIX_HOST_LEVEL])
171 // xbt_dict_set(host_dict,name,host[SIMIX_HOST_LEVEL], NULL);
175 smx_host_t SIMIX_pre_host_get_by_name(smx_simcall_t simcall, const char *name){
176 return SIMIX_host_get_by_name(name);
178 smx_host_t SIMIX_host_get_by_name(const char *name){
179 xbt_assert(((simix_global != NULL)
180 && (host_lib != NULL)),
181 "Environment not set yet");
183 return xbt_lib_get_elm_or_null(host_lib, name);
186 smx_host_t SIMIX_host_self(void)
188 smx_process_t process = SIMIX_process_self();
189 return (process == NULL) ? NULL : SIMIX_process_get_host(process);
192 const char* SIMIX_pre_host_self_get_name(smx_simcall_t simcall){
193 return SIMIX_host_self_get_name();
195 /* needs to be public and without simcall because it is called
196 by exceptions and logging events */
197 const char* SIMIX_host_self_get_name(void)
199 smx_host_t host = SIMIX_host_self();
200 if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
203 return SIMIX_host_get_name(host);
206 const char* SIMIX_pre_host_get_name(smx_simcall_t simcall, smx_host_t host){
207 return SIMIX_host_get_name(host);
209 const char* SIMIX_host_get_name(smx_host_t host){
210 xbt_assert((host != NULL), "Invalid parameters");
212 return sg_host_name(host);
215 xbt_dict_t SIMIX_pre_host_get_properties(smx_simcall_t simcall, smx_host_t host){
216 return SIMIX_host_get_properties(host);
218 xbt_dict_t SIMIX_host_get_properties(smx_host_t host){
219 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
221 surf_model_t ws_model = surf_resource_model(host, SURF_WKS_LEVEL);
222 return ws_model->extension.workstation.get_properties(host);
225 double SIMIX_pre_host_get_speed(smx_simcall_t simcall, smx_host_t host){
226 return SIMIX_host_get_speed(host);
228 double SIMIX_host_get_speed(smx_host_t host){
229 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
231 surf_model_t ws_model = surf_resource_model(host, SURF_WKS_LEVEL);
232 return ws_model->extension.workstation.get_speed(host, 1.0);
235 int SIMIX_pre_host_get_core(smx_simcall_t simcall, smx_host_t host){
236 return SIMIX_host_get_core(host);
238 int SIMIX_host_get_core(smx_host_t host){
239 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
241 return surf_workstation_model->extension.workstation.
247 double SIMIX_pre_host_get_available_speed(smx_simcall_t simcall, smx_host_t host){
248 return SIMIX_host_get_available_speed(host);
250 double SIMIX_host_get_available_speed(smx_host_t host){
251 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
253 surf_model_t ws_model = surf_resource_model(host, SURF_WKS_LEVEL);
254 return ws_model->extension.workstation.get_available_speed(host);
257 int SIMIX_pre_host_get_state(smx_simcall_t simcall, smx_host_t host){
258 return SIMIX_host_get_state(host);
260 int SIMIX_host_get_state(smx_host_t host){
261 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
263 surf_model_t ws_model = surf_resource_model(host, SURF_WKS_LEVEL);
264 return ws_model->extension.workstation.get_state(host);
267 void* SIMIX_pre_host_self_get_data(smx_simcall_t simcall){
268 return SIMIX_host_self_get_data();
270 void* SIMIX_host_self_get_data(void)
272 smx_host_t self = SIMIX_host_self();
273 return SIMIX_host_get_data(self);
276 void SIMIX_host_self_set_data(void *data)
278 smx_host_t self = SIMIX_host_self();
279 SIMIX_host_set_data(self, data);
282 void* SIMIX_pre_host_get_data(smx_simcall_t simcall,smx_host_t host){
283 return SIMIX_host_get_data(host);
285 void* SIMIX_host_get_data(smx_host_t host){
286 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
288 return SIMIX_host_priv(host)->data;
291 void _SIMIX_host_free_process_arg(void *data)
293 smx_process_arg_t arg = *(void**)data;
298 * \brief Add a process to the list of the processes that the host will restart when it comes back
299 * This function add a process to the list of the processes that will be restarted when the host comes
300 * back. It is expected that this function is called when the host is down.
301 * The processes will only be restarted once, meaning that you will have to register the process
302 * again to restart the process again.
304 void SIMIX_host_add_auto_restart_process(smx_host_t host,
306 xbt_main_func_t code,
308 const char *hostname,
310 int argc, char **argv,
311 xbt_dict_t properties,
314 if (!SIMIX_host_priv(host)->auto_restart_processes) {
315 SIMIX_host_priv(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
317 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
318 arg->name = xbt_strdup(name);
321 arg->hostname = hostname;
322 arg->kill_time = kill_time;
325 arg->argv = xbt_new(char*,argc + 1);
328 for (i = 0; i < argc; i++) {
329 arg->argv[i] = xbt_strdup(argv[i]);
331 arg->argv[argc] = NULL;
333 arg->properties = properties;
334 arg->auto_restart = auto_restart;
336 if( SIMIX_host_get_state(host) == SURF_RESOURCE_OFF
337 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_name(host))){
338 xbt_dict_set(watched_hosts_lib,sg_host_name(host),host,NULL);
339 XBT_DEBUG("Have push host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_name(host));
341 xbt_dynar_push_as(SIMIX_host_priv(host)->auto_restart_processes,smx_process_arg_t,arg);
344 * \brief Restart the list of processes that have been registered to the host
346 void SIMIX_host_restart_processes(smx_host_t host)
349 smx_process_arg_t arg;
350 xbt_dynar_foreach(SIMIX_host_priv(host)->auto_restart_processes,cpt,arg) {
352 smx_process_t process;
354 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
355 if (simix_global->create_process_function) {
356 simix_global->create_process_function(&process,
368 simcall_process_create(&process,
381 xbt_dynar_reset(SIMIX_host_priv(host)->auto_restart_processes);
384 void SIMIX_host_autorestart(smx_host_t host)
386 if(simix_global->autorestart)
387 simix_global->autorestart(host);
389 xbt_die("No function for simix_global->autorestart");
392 void SIMIX_pre_host_set_data(smx_simcall_t simcall, smx_host_t host, void *data) {
393 SIMIX_host_set_data(host, data);
395 void SIMIX_host_set_data(smx_host_t host, void *data){
396 xbt_assert((host != NULL), "Invalid parameters");
397 xbt_assert((SIMIX_host_priv(host)->data == NULL), "Data already set");
399 SIMIX_host_priv(host)->data = data;
402 smx_action_t SIMIX_pre_host_execute(smx_simcall_t simcall,const char *name,
403 smx_host_t host, double computation_amount, double priority, double bound, unsigned long affinity_mask){
404 return SIMIX_host_execute(name, host, computation_amount, priority, bound, affinity_mask);
406 smx_action_t SIMIX_host_execute(const char *name,
407 smx_host_t host, double computation_amount, double priority, double bound, unsigned long affinity_mask){
409 /* alloc structures and initialize */
410 smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
411 action->type = SIMIX_ACTION_EXECUTE;
412 action->name = xbt_strdup(name);
413 action->state = SIMIX_RUNNING;
414 action->execution.host = host;
417 action->category = NULL;
420 surf_model_t ws_model = surf_resource_model(host, SURF_WKS_LEVEL);
421 /* set surf's action */
422 if (!MC_is_active()) {
423 action->execution.surf_exec = ws_model->extension.workstation.execute(host, computation_amount);
424 ws_model->action_data_set(action->execution.surf_exec, action);
425 ws_model->set_priority(action->execution.surf_exec, priority);
427 /* Note (hypervisor): for multicore, the bound value being passed to the
428 * surf layer should not be zero (i.e., unlimited). It should be the
429 * capacity of a CPU core. */
431 ws_model->set_bound(action->execution.surf_exec, SIMIX_host_get_speed(host));
433 ws_model->set_bound(action->execution.surf_exec, bound);
435 if (affinity_mask != 0) {
436 /* just a double check to confirm that this host is the host where this task is running. */
437 xbt_assert(action->execution.host == host);
438 ws_model->set_affinity(action->execution.surf_exec, host, affinity_mask);
442 XBT_DEBUG("Create execute action %p", action);
447 smx_action_t SIMIX_pre_host_parallel_execute(smx_simcall_t simcall, const char *name,
448 int host_nb, smx_host_t *host_list,
449 double *computation_amount, double *communication_amount,
450 double amount, double rate){
451 return SIMIX_host_parallel_execute(name, host_nb, host_list, computation_amount,
452 communication_amount, amount, rate);
454 smx_action_t SIMIX_host_parallel_execute(const char *name,
455 int host_nb, smx_host_t *host_list,
456 double *computation_amount, double *communication_amount,
457 double amount, double rate){
459 void **workstation_list = NULL;
462 /* alloc structures and initialize */
463 smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
464 action->type = SIMIX_ACTION_PARALLEL_EXECUTE;
465 action->name = xbt_strdup(name);
466 action->state = SIMIX_RUNNING;
467 action->execution.host = NULL; /* FIXME: do we need the list of hosts? */
470 action->category = NULL;
473 /* set surf's action */
474 workstation_list = xbt_new0(void *, host_nb);
475 for (i = 0; i < host_nb; i++)
476 workstation_list[i] = host_list[i];
479 /* FIXME: what happens if host_list contains VMs and PMs. If
480 * execute_parallel_task() does not change the state of the model, we can mix
482 surf_model_t ws_model = surf_resource_model(host_list[0], SURF_WKS_LEVEL);
483 for (i = 1; i < host_nb; i++) {
484 surf_model_t ws_model_tmp = surf_resource_model(host_list[i], SURF_WKS_LEVEL);
485 if (ws_model_tmp != ws_model) {
486 XBT_CRITICAL("mixing VMs and PMs is not supported");
491 /* set surf's action */
492 if (!MC_is_active()) {
493 action->execution.surf_exec =
494 ws_model->extension.workstation.
495 execute_parallel_task(host_nb, workstation_list, computation_amount,
496 communication_amount, rate);
498 ws_model->action_data_set(action->execution.surf_exec, action);
500 XBT_DEBUG("Create parallel execute action %p", action);
505 static surf_model_t get_ws_model_from_action(smx_action_t action)
507 xbt_assert(action->type == SIMIX_ACTION_EXECUTE);
508 smx_host_t host = action->execution.host;
509 surf_model_t model = surf_resource_model(host, SURF_WKS_LEVEL);
511 xbt_assert((model == surf_workstation_model) || (model == surf_vm_workstation_model));
516 void SIMIX_pre_host_execution_destroy(smx_simcall_t simcall, smx_action_t action){
517 SIMIX_host_execution_destroy(action);
519 void SIMIX_host_execution_destroy(smx_action_t action){
520 XBT_DEBUG("Destroy action %p", action);
522 surf_model_t ws_model = get_ws_model_from_action(action);
524 if (action->execution.surf_exec) {
525 ws_model->action_unref(action->execution.surf_exec);
526 action->execution.surf_exec = NULL;
528 xbt_free(action->name);
529 xbt_mallocator_release(simix_global->action_mallocator, action);
532 void SIMIX_pre_host_execution_cancel(smx_simcall_t simcall, smx_action_t action){
533 SIMIX_host_execution_cancel(action);
535 void SIMIX_host_execution_cancel(smx_action_t action){
536 XBT_DEBUG("Cancel action %p", action);
538 surf_model_t ws_model = get_ws_model_from_action(action);
540 if (action->execution.surf_exec)
541 ws_model->action_cancel(action->execution.surf_exec);
544 double SIMIX_pre_host_execution_get_remains(smx_simcall_t simcall, smx_action_t action){
545 return SIMIX_host_execution_get_remains(action);
547 double SIMIX_host_execution_get_remains(smx_action_t action){
549 surf_model_t ws_model = get_ws_model_from_action(action);
551 if (action->state == SIMIX_RUNNING)
552 result = ws_model->get_remains(action->execution.surf_exec);
557 e_smx_state_t SIMIX_pre_host_execution_get_state(smx_simcall_t simcall, smx_action_t action){
558 return SIMIX_host_execution_get_state(action);
560 e_smx_state_t SIMIX_host_execution_get_state(smx_action_t action){
561 return action->state;
564 void SIMIX_pre_host_execution_set_priority(smx_simcall_t simcall, smx_action_t action,
566 SIMIX_host_execution_set_priority(action, priority);
568 void SIMIX_host_execution_set_priority(smx_action_t action, double priority){
569 surf_model_t ws_model = get_ws_model_from_action(action);
571 if(action->execution.surf_exec)
572 ws_model->set_priority(action->execution.surf_exec, priority);
575 void SIMIX_pre_host_execution_set_bound(smx_simcall_t simcall, smx_action_t action,
577 SIMIX_host_execution_set_bound(action, bound);
579 void SIMIX_host_execution_set_bound(smx_action_t action, double bound){
580 surf_model_t ws_model = get_ws_model_from_action(action);
582 if(action->execution.surf_exec)
583 ws_model->set_bound(action->execution.surf_exec, bound);
586 void SIMIX_pre_host_execution_set_affinity(smx_simcall_t simcall,
587 smx_action_t action, smx_host_t host, unsigned long mask){
588 SIMIX_host_execution_set_affinity(action, host, mask);
590 void SIMIX_host_execution_set_affinity(smx_action_t action, smx_host_t host, unsigned long mask){
591 surf_model_t ws_model = get_ws_model_from_action(action);
593 xbt_assert(action->type == SIMIX_ACTION_EXECUTE);
595 if (action->execution.surf_exec) {
596 /* just a double check to confirm that this host is the host where this task is running. */
597 xbt_assert(action->execution.host == host);
598 ws_model->set_affinity(action->execution.surf_exec, host, mask);
602 void SIMIX_pre_host_execution_wait(smx_simcall_t simcall, smx_action_t action){
604 XBT_DEBUG("Wait for execution of action %p, state %d", action, (int)action->state);
606 /* Associate this simcall to the action */
607 xbt_fifo_push(action->simcalls, simcall);
608 simcall->issuer->waiting_action = action;
610 /* set surf's action */
611 if (MC_is_active()) {
612 action->state = SIMIX_DONE;
613 SIMIX_execution_finish(action);
617 /* If the action is already finished then perform the error handling */
618 if (action->state != SIMIX_RUNNING)
619 SIMIX_execution_finish(action);
622 void SIMIX_host_execution_suspend(smx_action_t action)
624 surf_model_t ws_model = get_ws_model_from_action(action);
626 if(action->execution.surf_exec)
627 ws_model->suspend(action->execution.surf_exec);
630 void SIMIX_host_execution_resume(smx_action_t action)
632 surf_model_t ws_model = get_ws_model_from_action(action);
634 if(action->execution.surf_exec)
635 ws_model->resume(action->execution.surf_exec);
638 void SIMIX_execution_finish(smx_action_t action)
640 xbt_fifo_item_t item;
641 smx_simcall_t simcall;
642 surf_model_t ws_model = get_ws_model_from_action(action);
644 xbt_fifo_foreach(action->simcalls, item, simcall, smx_simcall_t) {
646 switch (action->state) {
649 /* do nothing, action done */
650 XBT_DEBUG("SIMIX_execution_finished: execution successful");
654 XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_name(simcall->issuer->smx_host));
655 simcall->issuer->context->iwannadie = 1;
656 //SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
660 XBT_DEBUG("SIMIX_execution_finished: execution canceled");
661 SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
665 xbt_die("Internal error in SIMIX_execution_finish: unexpected action state %d",
668 /* check if the host is down */
669 if (ws_model->extension.workstation.get_state(simcall->issuer->smx_host) != SURF_RESOURCE_ON) {
670 simcall->issuer->context->iwannadie = 1;
673 simcall->issuer->waiting_action = NULL;
674 simcall_host_execution_wait__set__result(simcall, action->state);
675 SIMIX_simcall_answer(simcall);
678 /* We no longer need it */
679 SIMIX_host_execution_destroy(action);
683 void SIMIX_post_host_execute(smx_action_t action)
685 surf_model_t ws_model = get_ws_model_from_action(action);
687 if (action->type == SIMIX_ACTION_EXECUTE && /* FIMXE: handle resource failure
688 * for parallel tasks too */
689 ws_model->extension.workstation.get_state(action->execution.host) == SURF_RESOURCE_OFF) {
690 /* If the host running the action failed, notice it so that the asking
691 * process can be killed if it runs on that host itself */
692 action->state = SIMIX_FAILED;
693 } else if (ws_model->action_state_get(action->execution.surf_exec) == SURF_ACTION_FAILED) {
694 /* If the host running the action didn't fail, then the action was
696 action->state = SIMIX_CANCELED;
698 action->state = SIMIX_DONE;
701 if (action->execution.surf_exec) {
702 ws_model->action_unref(action->execution.surf_exec);
703 action->execution.surf_exec = NULL;
706 /* If there are simcalls associated with the action, then answer them */
707 if (xbt_fifo_size(action->simcalls)) {
708 SIMIX_execution_finish(action);
714 void SIMIX_pre_set_category(smx_simcall_t simcall, smx_action_t action,
715 const char *category){
716 SIMIX_set_category(action, category);
718 void SIMIX_set_category(smx_action_t action, const char *category)
720 surf_model_t ws_model = get_ws_model_from_action(action);
722 if (action->state != SIMIX_RUNNING) return;
723 if (action->type == SIMIX_ACTION_EXECUTE){
724 ws_model->set_category(action->execution.surf_exec, category);
725 }else if (action->type == SIMIX_ACTION_COMMUNICATE){
726 ws_model->set_category(action->comm.surf_comm, category);
733 * \brief Function to get the parameters of the given the SIMIX host.
735 * \param host the host to get_phys_host (a smx_host_t)
736 * \param param the parameter object space to be overwritten (a ws_params_t)
738 void SIMIX_host_get_params(smx_host_t ind_vm, ws_params_t params)
740 /* jump to ws_get_params(). */
741 surf_workstation_model->extension.workstation.get_params(ind_vm, params);
744 void SIMIX_pre_host_get_params(smx_simcall_t simcall, smx_host_t ind_vm, ws_params_t params)
746 SIMIX_host_get_params(ind_vm, params);
749 void SIMIX_host_set_params(smx_host_t ind_vm, ws_params_t params)
751 /* jump to ws_set_params(). */
752 surf_workstation_model->extension.workstation.set_params(ind_vm, params);
755 void SIMIX_pre_host_set_params(smx_simcall_t simcall, smx_host_t ind_vm, ws_params_t params)
757 SIMIX_host_set_params(ind_vm, params);