src/simix/smx_global.c

   1 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "private.h"
   8 #include "xbt/heap.h"
   9 #include "xbt/sysdep.h"
  10 #include "xbt/log.h"
  11 #include "xbt/str.h"
  12 #include "xbt/ex.h"             /* ex_backtrace_display */
  13
  14 XBT_LOG_EXTERNAL_CATEGORY(simix);
  15 XBT_LOG_EXTERNAL_CATEGORY(simix_action);
  16 XBT_LOG_EXTERNAL_CATEGORY(simix_deployment);
  17 XBT_LOG_EXTERNAL_CATEGORY(simix_environment);
  18 XBT_LOG_EXTERNAL_CATEGORY(simix_host);
  19 XBT_LOG_EXTERNAL_CATEGORY(simix_process);
  20 XBT_LOG_EXTERNAL_CATEGORY(simix_synchro);
  21 XBT_LOG_EXTERNAL_CATEGORY(simix_context);
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
  23                                 "Logging specific to SIMIX (kernel)");
  24
  25 SIMIX_Global_t simix_global = NULL;
  26 static xbt_heap_t simix_timers = NULL;
  27
  28 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
  29 #include <signal.h>
  30
  31 static void _XBT_CALL inthandler(int ignored)
  32 {
  33   INFO0("CTRL-C pressed. Displaying status and bailing out");
  34   SIMIX_display_process_status();
  35   exit(1);
  36 }
  37
  38 /********************************* SIMIX **************************************/
  39
  40 /**
  41  * \brief Initialize SIMIX internal data.
  42  *
  43  * \param argc Argc
  44  * \param argv Argv
  45  */
  46 void SIMIX_global_init(int *argc, char **argv)
  47 {
  48   s_smx_process_t proc;
  49
  50   if (!simix_global) {
  51     /* Connect our log channels: that must be done manually under windows */
  52     XBT_LOG_CONNECT(simix_action, simix);
  53     XBT_LOG_CONNECT(simix_deployment, simix);
  54     XBT_LOG_CONNECT(simix_environment, simix);
  55     XBT_LOG_CONNECT(simix_host, simix);
  56     XBT_LOG_CONNECT(simix_kernel, simix);
  57     XBT_LOG_CONNECT(simix_process, simix);
  58     XBT_LOG_CONNECT(simix_synchro, simix);
  59     XBT_LOG_CONNECT(simix_context, simix);
  60
  61     simix_global = xbt_new0(s_SIMIX_Global_t, 1);
  62
  63     simix_global->host = xbt_dict_new();
  64     simix_global->process_to_run =
  65         xbt_swag_new(xbt_swag_offset(proc, synchro_hookup));
  66     simix_global->process_list =
  67         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
  68     simix_global->process_to_destroy =
  69         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
  70
  71     simix_global->current_process = NULL;
  72     simix_global->maestro_process = NULL;
  73     simix_global->registered_functions = xbt_dict_new();
  74
  75     simix_global->create_process_function = NULL;
  76     simix_global->kill_process_function = NULL;
  77     simix_global->cleanup_process_function = SIMIX_process_cleanup;
  78
  79 #ifdef HAVE_LATENCY_BOUND_TRACKING
  80     simix_global->latency_limited_dict = xbt_dict_new();
  81 #endif
  82
  83     SIMIX_context_mod_init();
  84     SIMIX_create_maestro_process();
  85
  86     /* context exception handlers */
  87     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
  88     __xbt_ex_terminate = SIMIX_process_exception_terminate;
  89
  90     /* Initialize request mechanism */
  91     SIMIX_request_init();
  92
  93     /* Initialize the SIMIX network module */
  94     SIMIX_network_init();
  95
  96     /* Prepare to display some more info when dying on Ctrl-C pressing */
  97     signal(SIGINT, inthandler);
  98     surf_init(argc, argv);      /* Initialize SURF structures */
  99   }
 100   if (!simix_timers) {
 101     simix_timers = xbt_heap_new(8, &free);
 102   }
 103 }
 104
 105 /**
 106  * \brief Clean the SIMIX simulation
 107  *
 108  * This functions remove the memory used by SIMIX
 109  */
 110 void SIMIX_clean(void)
 111 {
 112   /* Kill everyone (except maestro) */
 113   SIMIX_process_killall();
 114
 115   /* Exit the SIMIX network module */
 116   SIMIX_network_exit();
 117
 118   /* Exit request mechanism */
 119   SIMIX_request_destroy();
 120
 121   xbt_heap_free(simix_timers);
 122   /* Free the remaining data structures */
 123   xbt_swag_free(simix_global->process_to_run);
 124   xbt_swag_free(simix_global->process_to_destroy);
 125   xbt_swag_free(simix_global->process_list);
 126   simix_global->process_list = NULL;
 127   simix_global->process_to_destroy = NULL;
 128   xbt_dict_free(&(simix_global->registered_functions));
 129   xbt_dict_free(&(simix_global->host));
 130
 131 #ifdef HAVE_LATENCY_BOUND_TRACKING
 132   xbt_dict_free(&(simix_global->latency_limited_dict));
 133 #endif
 134
 135   /* Let's free maestro now */
 136   SIMIX_context_free(simix_global->maestro_process->context);
 137   xbt_free(simix_global->maestro_process->running_ctx);
 138   xbt_free(simix_global->maestro_process);
 139   simix_global->maestro_process = NULL;
 140
 141   /* Restore the default exception setup */
 142   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 143   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 144
 145   /* Finish context module and SURF */
 146   SIMIX_context_mod_exit();
 147
 148   surf_exit();
 149
 150   xbt_free(simix_global);
 151   simix_global = NULL;
 152
 153   return;
 154 }
 155
 156
 157 /**
 158  * \brief A clock (in second).
 159  *
 160  * \return Return the clock.
 161  */
 162 XBT_INLINE double SIMIX_get_clock(void)
 163 {
 164   return surf_get_clock();
 165 }
 166
 167 void SIMIX_run(void)
 168 {
 169   double time = 0;
 170   smx_req_t req;
 171   xbt_swag_t set;
 172   surf_action_t action;
 173   smx_timer_t timer;
 174   surf_model_t model;
 175   unsigned int iter;
 176
 177   do {
 178     do {
 179       DEBUG0("New Schedule Round");
 180       SIMIX_context_runall(simix_global->process_to_run);
 181       while((req = SIMIX_request_pop())){
 182         DEBUG1("Handling request %p", req);
 183         SIMIX_request_pre(req);
 184       }
 185     } while (xbt_swag_size(simix_global->process_to_run));
 186
 187     time = surf_solve(SIMIX_timer_next());
 188
 189     /* Notify all the hosts that have failed */
 190     /* FIXME: iterate through the list of failed host and mark each of them */
 191     /* as failed. On each host, signal all the running processes with host_fail */
 192
 193     /* Handle any pending timer */
 194     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 195        //FIXME: make the timers being real callbacks
 196        // (i.e. provide dispatchers that read and expand the args)
 197        timer = xbt_heap_pop(simix_timers);
 198        if (timer->func)
 199          ((void (*)(void*))timer->func)(timer->args);
 200     }
 201     /* Wake up all process waiting for the action finish */
 202     xbt_dynar_foreach(model_list, iter, model) {
 203       for(set = model->states.failed_action_set;
 204           set;
 205           set = (set == model->states.failed_action_set)
 206                 ? model->states.done_action_set
 207                 : NULL) {
 208         while ((action = xbt_swag_extract(set)))
 209           SIMIX_request_post((smx_action_t)action->data);
 210       }
 211     }
 212   } while(time != -1.0);
 213
 214 }
 215
 216
 217 /**
 218  *      \brief Does a turn of the simulation
 219  *
 220  *      Executes a step in the surf simulation, adding to the two lists all the actions that finished on this turn. Schedules all processus in the process_to_run list.
 221  *      \param actions_done List of actions done
 222  *      \param actions_failed List of actions failed
 223  *      \return The time spent to execute the simulation or -1 if the simulation ended
 224  */
 225 /* FIXME: this function is now deprecated, remove it */
 226 #if 0
 227 double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
 228 {
 229
 230   smx_process_t process = NULL;
 231   unsigned int iter;
 232   double elapsed_time = 0.0;
 233   static int state_modifications = 1;
 234   int actions_on_system = 0;
 235   smx_timer_t timer;
 236
 237   SIMIX_process_empty_trash();
 238   if (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug) &&
 239       xbt_swag_size(simix_global->process_to_run) && (elapsed_time > 0)) {
 240     DEBUG0("**************************************************");
 241   }
 242
 243   while ((process = xbt_swag_extract(simix_global->process_to_run))) {
 244     DEBUG2("Scheduling %s on %s", process->name, process->smx_host->name);
 245     /*SIMIX_process_schedule(process);*/
 246   }
 247
 248   {
 249     surf_action_t action = NULL;
 250     surf_model_t model = NULL;
 251     smx_action_t smx_action = NULL;
 252
 253     void *fun = NULL;
 254     void *arg = NULL;
 255
 256     xbt_dynar_foreach(model_list, iter, model) {
 257       if (xbt_swag_size(model->states.failed_action_set)
 258           || xbt_swag_size(model->states.done_action_set)) {
 259         state_modifications = 1;
 260         break;
 261       }
 262       if (xbt_swag_size(model->states.running_action_set)
 263           || xbt_swag_size(model->states.ready_action_set)) {
 264         actions_on_system = 1;
 265       }
 266     }
 267     if (xbt_heap_size(simix_timers) > 0) {
 268       actions_on_system = 1;
 269     }
 270
 271     /* only calls surf_solve if there are actions to run */
 272     if (!state_modifications && actions_on_system) {
 273       DEBUG1("Calling surf_solve(%f)", SIMIX_timer_next());
 274       elapsed_time = surf_solve(SIMIX_timer_next());
 275       DEBUG1("Elapsed time %f", elapsed_time);
 276     }
 277
 278     actions_on_system = 0;
 279     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 280       timer = xbt_heap_pop(simix_timers);
 281       fun = timer->func;
 282       arg = timer->args;
 283       free(timer);
 284       /* change in process, don't quit */
 285       actions_on_system = 1;
 286       DEBUG3("got %p %p at %f", fun, arg, timer->date);
 287       if (fun == SIMIX_process_create) {
 288         smx_process_arg_t args = arg;
 289         DEBUG2("Launching %s on %s", args->name, args->hostname);
 290         process = SIMIX_process_create(args->name, args->code,
 291                                        args->data, args->hostname,
 292                                        args->argc, args->argv,
 293                                        args->properties);
 294         /* verify if process has been created */
 295         if (!process) {
 296           xbt_free(args);
 297           continue;
 298         }
 299
 300         if (args->kill_time > SIMIX_get_clock()) {
 301           SIMIX_timer_set(args->kill_time, &SIMIX_process_kill, process);
 302         }
 303         xbt_free(args);
 304       } else if (fun == simix_global->create_process_function) {
 305         smx_process_arg_t args = arg;
 306         DEBUG2("Launching %s on %s", args->name, args->hostname);
 307         process =
 308             (*simix_global->create_process_function) (args->name,
 309                                                       args->code,
 310                                                       args->data,
 311                                                       args->hostname,
 312                                                       args->argc,
 313                                                       args->argv,
 314                                                       args->properties);
 315         /* verify if process has been created */
 316         if (!process) {
 317           xbt_free(args);
 318           continue;
 319         }
 320         if (args->kill_time > SIMIX_get_clock()) {
 321           if (simix_global->kill_process_function)
 322             SIMIX_timer_set(args->kill_time, simix_global->kill_process_function, process);
 323           else
 324             SIMIX_timer_set(args->kill_time, &SIMIX_process_kill, process);
 325         }
 326         xbt_free(args);
 327       } else if (fun == SIMIX_process_kill) {
 328         process = arg;
 329         DEBUG2("Killing %s on %s", process->name, process->smx_host->name);
 330         SIMIX_process_kill(process, SIMIX_process_self());
 331       } else if (fun == simix_global->kill_process_function) {
 332         process = arg;
 333         (*simix_global->kill_process_function) (process);
 334       } else {
 335         //FIXME: ((void (*)(void*))fun)(arg);
 336         THROW_IMPOSSIBLE;
 337       }
 338     }
 339
 340     /* Wake up all process waiting for the action finish */
 341     xbt_dynar_foreach(model_list, iter, model) {
 342       /* stop simulation case there are no actions to run */
 343       if ((xbt_swag_size(model->states.running_action_set)) ||
 344           (xbt_swag_size(model->states.ready_action_set)) ||
 345           (xbt_swag_size(model->states.done_action_set)) ||
 346           (xbt_swag_size(model->states.failed_action_set)))
 347         actions_on_system = 1;
 348
 349       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
 350         smx_action = action->data;
 351         if (smx_action) {
 352 //          SIMIX_action_signal_all(smx_action);
 353         }
 354       }
 355       while ((action = xbt_swag_extract(model->states.done_action_set))) {
 356         smx_action = action->data;
 357         if (smx_action) {
 358 //          SIMIX_action_signal_all(smx_action);
 359         }
 360       }
 361     }
 362   }
 363
 364   if (xbt_heap_size(simix_timers) > 0) {
 365     actions_on_system = 1;
 366   }
 367
 368   state_modifications = 0;
 369   if (!actions_on_system)
 370     elapsed_time = -1;
 371
 372   if (elapsed_time == -1) {
 373     if (xbt_swag_size(simix_global->process_list) == 0) {
 374 /*                      INFO0("Congratulations ! Simulation terminated : all processes are over"); */
 375     } else {
 376       INFO0("Oops ! Deadlock or code not perfectly clean.");
 377       SIMIX_display_process_status();
 378       if (XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
 379           XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
 380         DEBUG0("Aborting!");
 381         xbt_abort();
 382       }
 383       INFO0("Return a Warning.");
 384     }
 385   }
 386
 387   DEBUG1("SIMIX_solve() finished, elapsed_time = %f", elapsed_time);
 388   return elapsed_time;
 389 }
 390 #endif
 391
 392 /**
 393  *      \brief Set the date to execute a function
 394  *
 395  * Set the date to execute the function on the surf.
 396  *      \param date Date to execute function
 397  *      \param function Function to be executed
 398  *      \param arg Parameters of the function
 399  *
 400  */
 401 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 402 {
 403   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 404
 405   timer->date = date;
 406   timer->func = function;
 407   timer->args = arg;
 408   xbt_heap_push(simix_timers, timer, date);
 409 }
 410
 411 XBT_INLINE double SIMIX_timer_next(void)
 412 {
 413   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
 414 }
 415
 416 /**
 417  *      \brief Registers a function to create a process.
 418  *
 419  *      This function registers an user function to be called when a new process is created. The user function have to call the SIMIX_create_process function.
 420  *      \param function Create process function
 421  *
 422  */
 423 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 424                                                        function)
 425 {
 426   xbt_assert0((simix_global->create_process_function == NULL),
 427               "Data already set");
 428
 429   simix_global->create_process_function = function;
 430 }
 431
 432 /**
 433  *      \brief Registers a function to kill a process.
 434  *
 435  *      This function registers an user function to be called when a new process is killed. The user function have to call the SIMIX_kill_process function.
 436  *      \param function Kill process function
 437  *
 438  */
 439 XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
 440                                                      function)
 441 {
 442   xbt_assert0((simix_global->kill_process_function == NULL),
 443               "Data already set");
 444
 445   simix_global->kill_process_function = function;
 446 }
 447
 448 /**
 449  *      \brief Registers a function to cleanup a process.
 450  *
 451  *      This function registers an user function to be called when a new process ends properly.
 452  *      \param function cleanup process function
 453  *
 454  */
 455 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 456                                                         function)
 457 {
 458   simix_global->cleanup_process_function = function;
 459 }
 460
 461
 462 void SIMIX_display_process_status(void)
 463 {
 464   if (simix_global->process_list == NULL) {
 465     return;
 466   }
 467
 468   smx_process_t process = NULL;
 469   /*xbt_fifo_item_t item = NULL;
 470   smx_action_t act;*/
 471   int nbprocess = xbt_swag_size(simix_global->process_list);
 472
 473   INFO1("%d processes are still running, waiting for something.", nbprocess);
 474   /*  List the process and their state */
 475   INFO0
 476     ("Legend of the following listing: \"<process> on <host>: <status>.\"");
 477   xbt_swag_foreach(process, simix_global->process_list) {
 478     char *who, *who2;
 479
 480     asprintf(&who, "%s on %s: %s",
 481              process->name,
 482              process->smx_host->name,
 483              (process->blocked) ? "[BLOCKED] "
 484              : ((process->suspended) ? "[SUSPENDED] " : ""));
 485
 486     if (process->waiting_action) {
 487       who2 = bprintf("Waiting for action %p to finish", process->waiting_action);
 488     }
 489
 490       /*
 491     if (process->mutex) {
 492       who2 =
 493         bprintf("%s Blocked on mutex %p", who,
 494                 (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 495                 process->mutex : (void *) 0xdead);
 496       free(who);
 497       who = who2;
 498     } else if (process->cond) {
 499       who2 =
 500         bprintf
 501         ("%s Blocked on condition %p; Waiting for the following actions:",
 502          who,
 503          (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 504          process->cond : (void *) 0xdead);
 505       free(who);
 506       who = who2;
 507       xbt_fifo_foreach(process->cond->actions, item, act, smx_action_t) {
 508         who2 =
 509           bprintf("%s '%s'(%p)", who, act->name,
 510                   (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
 511                   ? act : (void *) 0xdead);
 512         free(who);
 513         who = who2;
 514       }
 515     } else if (process->sem) {
 516       who2 =
 517         bprintf
 518         ("%s Blocked on semaphore %p; Waiting for the following actions:",
 519          who,
 520          (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
 521          process->sem : (void *) 0xdead);
 522       free(who);
 523       who = who2;
 524       xbt_fifo_foreach(process->sem->actions, item, act, smx_action_t) {
 525         who2 =
 526           bprintf("%s '%s'(%p)", who, act->name,
 527                   (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
 528                   ? act : (void *) 0xdead);
 529         free(who);
 530         who = who2;
 531       }
 532
 533     } else {
 534       who2 =
 535         bprintf
 536         ("%s Blocked in an unknown status (please report this bug)", who);
 537       free(who);
 538       who = who2;
 539     }
 540     */
 541     INFO1("%s.", who);
 542     free(who);
 543   }
 544 }