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"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
17 static void SIMIX_execution_finish(smx_synchro_t synchro);
20 * \brief Internal function to create a SIMIX host.
21 * \param name name of the host to create
23 void SIMIX_host_create(sg_host_t host) // FIXME: braindead prototype. Take sg_host as parameter
25 smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
29 smx_host->process_list =
30 xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
32 /* Update global variables */
33 sg_host_simix_set(host, smx_host);
37 * \brief Start the host if it is off
40 void SIMIX_host_on(sg_host_t h)
42 smx_host_priv_t host = sg_host_simix(h);
44 xbt_assert((host != NULL), "Invalid parameters");
46 if (surf_host_get_state(surf_host_resource_priv(h))==SURF_RESOURCE_OFF) {
47 surf_host_set_state(surf_host_resource_priv(h), SURF_RESOURCE_ON);
50 smx_process_arg_t arg;
51 xbt_dynar_foreach(host->boot_processes,cpt,arg) {
53 char** argv = xbt_new(char*, arg->argc);
54 for (int i=0; i<arg->argc; i++)
55 argv[i] = xbt_strdup(arg->argv[i]);
57 XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
58 if (simix_global->create_process_function) {
59 simix_global->create_process_function(argv[0],
70 simcall_process_create(arg->argv[0],
84 void simcall_HANDLER_host_off(smx_simcall_t simcall, sg_host_t h)
86 SIMIX_host_off(h, simcall->issuer);
90 * \brief Stop the host if it is on
93 void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
95 smx_host_priv_t host = sg_host_simix(h);
97 xbt_assert((host != NULL), "Invalid parameters");
99 if (surf_host_get_state(surf_host_resource_priv(h))==SURF_RESOURCE_ON) {
100 surf_host_set_state(surf_host_resource_priv(h), SURF_RESOURCE_OFF);
102 /* Clean Simulator data */
103 if (xbt_swag_size(host->process_list) != 0) {
104 smx_process_t process = NULL;
105 xbt_swag_foreach(process, host->process_list) {
106 SIMIX_process_kill(process, issuer);
107 XBT_DEBUG("Killing %s on %s by %s", process->name, sg_host_get_name(process->host), issuer->name);
114 * \brief Internal function to destroy a SIMIX host.
116 * \param h the host to destroy (a sg_host_t)
118 void SIMIX_host_destroy(void *h)
120 smx_host_priv_t host = (smx_host_priv_t) h;
122 xbt_assert((host != NULL), "Invalid parameters");
124 /* Clean Simulator data */
125 if (xbt_swag_size(host->process_list) != 0) {
126 char *msg = xbt_strdup("Shutting down host, but it's not empty:");
128 smx_process_t process = NULL;
130 xbt_swag_foreach(process, host->process_list) {
131 tmp = bprintf("%s\n\t%s", msg, process->name);
135 SIMIX_display_process_status();
136 THROWF(arg_error, 0, "%s", msg);
138 xbt_dynar_free(&host->auto_restart_processes);
139 xbt_dynar_free(&host->boot_processes);
140 xbt_swag_free(host->process_list);
142 /* Clean host structure */
147 sg_host_t SIMIX_host_self(void)
149 smx_process_t process = SIMIX_process_self();
150 return (process == NULL) ? NULL : SIMIX_process_get_host(process);
153 /* needs to be public and without simcall because it is called
154 by exceptions and logging events */
155 const char* SIMIX_host_self_get_name(void)
157 sg_host_t host = SIMIX_host_self();
158 if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
161 return SIMIX_host_get_name(host);
164 xbt_dict_t SIMIX_host_get_properties(sg_host_t host){
165 return surf_host_get_properties(surf_host_resource_priv(host));
169 xbt_swag_t SIMIX_host_get_process_list(sg_host_t host){
170 smx_host_priv_t host_priv = sg_host_simix(host);
172 return host_priv->process_list;
176 double SIMIX_host_get_current_power_peak(sg_host_t host) {
177 return surf_host_get_current_power_peak(host);
180 double SIMIX_host_get_power_peak_at(sg_host_t host, int pstate_index) {
181 return surf_host_get_power_peak_at(host, pstate_index);
184 void SIMIX_host_set_pstate(sg_host_t host, int pstate_index) {
185 surf_host_set_pstate(host, pstate_index);
187 double SIMIX_host_get_wattmin_at(sg_host_t host,int pstate) {
188 return surf_host_get_wattmin_at(host,pstate);
190 double SIMIX_host_get_wattmax_at(sg_host_t host,int pstate) {
191 return surf_host_get_wattmax_at(host,pstate);
194 void _SIMIX_host_free_process_arg(void *data)
196 smx_process_arg_t arg = *(void**)data;
198 for (i = 0; i < arg->argc; i++)
199 xbt_free(arg->argv[i]);
205 * \brief Add a process to the list of the processes that the host will restart when it comes back
206 * This function add a process to the list of the processes that will be restarted when the host comes
207 * back. It is expected that this function is called when the host is down.
208 * The processes will only be restarted once, meaning that you will have to register the process
209 * again to restart the process again.
211 void SIMIX_host_add_auto_restart_process(sg_host_t host,
213 xbt_main_func_t code,
215 const char *hostname,
217 int argc, char **argv,
218 xbt_dict_t properties,
221 if (!sg_host_simix(host)->auto_restart_processes) {
222 sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
224 smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
225 arg->name = xbt_strdup(name);
228 arg->hostname = hostname;
229 arg->kill_time = kill_time;
232 arg->argv = xbt_new(char*,argc + 1);
235 for (i = 0; i < argc; i++) {
236 arg->argv[i] = xbt_strdup(argv[i]);
238 arg->argv[argc] = NULL;
240 arg->properties = properties;
241 arg->auto_restart = auto_restart;
243 if( sg_host_get_state(host) == SURF_RESOURCE_OFF
244 && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
245 xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,NULL);
246 XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
248 xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
251 * \brief Restart the list of processes that have been registered to the host
253 void SIMIX_host_restart_processes(sg_host_t host)
256 smx_process_arg_t arg;
257 xbt_dynar_t process_list = sg_host_simix(host)->auto_restart_processes;
261 xbt_dynar_foreach (process_list, cpt, arg) {
263 XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
264 if (simix_global->create_process_function) {
265 simix_global->create_process_function(arg->argv[0],
276 simcall_process_create(arg->argv[0],
287 /* arg->argv is used by the process created above. Hide it to
288 * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
293 xbt_dynar_reset(process_list);
296 void SIMIX_host_autorestart(sg_host_t host)
298 if(simix_global->autorestart)
299 simix_global->autorestart(host);
301 xbt_die("No function for simix_global->autorestart");
303 smx_synchro_t simcall_HANDLER_process_execute(smx_simcall_t simcall,
304 const char* name, double flops_amount, double priority, double bound, unsigned long affinity_mask) {
305 return SIMIX_process_execute(simcall->issuer, name,flops_amount,priority,bound,affinity_mask);
307 smx_synchro_t SIMIX_process_execute(smx_process_t issuer, const char *name,
308 double flops_amount, double priority, double bound, unsigned long affinity_mask){
310 /* alloc structures and initialize */
311 smx_synchro_t synchro = xbt_mallocator_get(simix_global->synchro_mallocator);
312 synchro->type = SIMIX_SYNC_EXECUTE;
313 synchro->name = xbt_strdup(name);
314 synchro->state = SIMIX_RUNNING;
315 synchro->execution.host = issuer->host;
316 synchro->category = NULL;
318 /* set surf's action */
319 if (!MC_is_active() && !MC_record_replay_is_active()) {
321 synchro->execution.surf_exec = surf_host_execute(issuer->host, flops_amount);
322 surf_action_set_data(synchro->execution.surf_exec, synchro);
323 surf_action_set_priority(synchro->execution.surf_exec, priority);
325 /* Note (hypervisor): for multicore, the bound value being passed to the
326 * surf layer should not be zero (i.e., unlimited). It should be the
327 * capacity of a CPU core. */
329 surf_cpu_action_set_bound(synchro->execution.surf_exec, sg_host_get_speed(issuer->host));
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 = 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_model_t ws_model = surf_resource_model(host_list[0], SURF_HOST_LEVEL);
371 for (i = 1; i < host_nb; i++) {
372 surf_model_t ws_model_tmp = surf_resource_model(host_list[i], SURF_HOST_LEVEL);
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 (surf_host_get_state(surf_host_resource_priv(simcall->issuer->host)) != SURF_RESOURCE_ON) {
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 surf_host_get_state(surf_host_resource_priv(synchro->execution.host)) == SURF_RESOURCE_OFF) {
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 /* jump to ws_get_params(). */
568 surf_host_get_params(ind_vm, params);
571 void SIMIX_host_set_params(sg_host_t ind_vm, vm_params_t params)
573 /* jump to ws_set_params(). */
574 surf_host_set_params(ind_vm, params);
577 xbt_dict_t SIMIX_host_get_mounted_storage_list(sg_host_t host){
578 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
580 return surf_host_get_mounted_storage_list(host);
583 xbt_dynar_t SIMIX_host_get_attached_storage_list(sg_host_t host){
584 xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
586 return surf_host_get_attached_storage_list(host);