src/simix/smx_global.c

   1 /* Copyright (c) 2007-2014. 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 "smx_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 #include "mc/mc.h"
  14 #include "simgrid/sg_config.h"
  15
  16 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
  18                                 "Logging specific to SIMIX (kernel)");
  19
  20 smx_global_t simix_global = NULL;
  21 static xbt_heap_t simix_timers = NULL;
  22
  23 static void* SIMIX_action_mallocator_new_f(void);
  24 static void SIMIX_action_mallocator_free_f(void* action);
  25 static void SIMIX_action_mallocator_reset_f(void* action);
  26
  27 static void SIMIX_clean(void);
  28
  29 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
  30 #include <signal.h>
  31
  32 int _sg_do_verbose_exit = 1;
  33 static void _XBT_CALL inthandler(int ignored)
  34 {
  35   if ( _sg_do_verbose_exit ) {
  36      XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
  37      SIMIX_display_process_status();
  38   }
  39   else {
  40      XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
  41   }
  42   exit(1);
  43 }
  44
  45 /********************************* SIMIX **************************************/
  46
  47 XBT_INLINE double SIMIX_timer_next(void)
  48 {
  49   return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
  50 }
  51
  52 /**
  53  * \ingroup SIMIX_API
  54  * \brief Initialize SIMIX internal data.
  55  *
  56  * \param argc Argc
  57  * \param argv Argv
  58  */
  59 void SIMIX_global_init(int *argc, char **argv)
  60 {
  61   s_smx_process_t proc;
  62
  63   if (!simix_global) {
  64     simix_global = xbt_new0(s_smx_global_t, 1);
  65
  66 #ifdef TIME_BENCH_AMDAHL
  67     simix_global->timer_seq = xbt_os_timer_new();
  68     simix_global->timer_par = xbt_os_timer_new();
  69     xbt_os_cputimer_start(simix_global->timer_seq);
  70 #endif
  71     simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
  72     simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
  73     simix_global->process_list =
  74         xbt_swag_new(xbt_swag_offset(proc, process_hookup));
  75     simix_global->process_to_destroy =
  76         xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
  77
  78     simix_global->maestro_process = NULL;
  79     simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
  80
  81     simix_global->create_process_function = SIMIX_process_create;
  82     simix_global->kill_process_function = SIMIX_process_kill;
  83     simix_global->cleanup_process_function = SIMIX_process_cleanup;
  84     simix_global->action_mallocator = xbt_mallocator_new(65536,
  85         SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
  86         SIMIX_action_mallocator_reset_f);
  87     simix_global->autorestart = SIMIX_host_restart_processes;
  88
  89     surf_init(argc, argv);      /* Initialize SURF structures */
  90     SIMIX_context_mod_init();
  91     SIMIX_create_maestro_process();
  92
  93     /* context exception handlers */
  94     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
  95     __xbt_ex_terminate = SIMIX_process_exception_terminate;
  96
  97     SIMIX_network_init();
  98
  99     /* Prepare to display some more info when dying on Ctrl-C pressing */
 100     signal(SIGINT, inthandler);
 101
 102     /* register a function to be called by SURF after the environment creation */
 103     sg_platf_init();
 104     sg_platf_postparse_add_cb(SIMIX_post_create_environment);
 105
 106   }
 107   if (!simix_timers) {
 108     simix_timers = xbt_heap_new(8, &free);
 109   }
 110
 111   SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
 112   SIMIX_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, SIMIX_storage_destroy);
 113
 114   if (sg_cfg_get_boolean("clean_atexit"))
 115     atexit(SIMIX_clean);
 116
 117   if (_sg_cfg_exit_asap)
 118     exit(0);
 119 }
 120
 121 /**
 122  * \ingroup SIMIX_API
 123  * \brief Clean the SIMIX simulation
 124  *
 125  * This functions remove the memory used by SIMIX
 126  */
 127 static void SIMIX_clean(void)
 128 {
 129 #ifdef TIME_BENCH_PER_SR
 130   smx_ctx_raw_new_sr();
 131 #endif
 132
 133   /* Kill everyone (except maestro) */
 134   SIMIX_process_killall(simix_global->maestro_process, 1);
 135
 136   /* Exit the SIMIX network module */
 137   SIMIX_network_exit();
 138
 139   xbt_heap_free(simix_timers);
 140   simix_timers = NULL;
 141   /* Free the remaining data structures */
 142   xbt_dynar_free(&simix_global->process_to_run);
 143   xbt_dynar_free(&simix_global->process_that_ran);
 144   xbt_swag_free(simix_global->process_to_destroy);
 145   xbt_swag_free(simix_global->process_list);
 146   simix_global->process_list = NULL;
 147   simix_global->process_to_destroy = NULL;
 148   xbt_dict_free(&(simix_global->registered_functions));
 149
 150   /* Let's free maestro now */
 151   SIMIX_context_free(simix_global->maestro_process->context);
 152   xbt_free(simix_global->maestro_process->running_ctx);
 153   xbt_free(simix_global->maestro_process);
 154   simix_global->maestro_process = NULL;
 155
 156   /* Restore the default exception setup */
 157   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 158   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 159
 160   /* Finish context module and SURF */
 161   SIMIX_context_mod_exit();
 162
 163   surf_exit();
 164
 165 #ifdef TIME_BENCH_AMDAHL
 166   xbt_os_cputimer_stop(simix_global->timer_seq);
 167   XBT_INFO("Amdahl timing informations. Sequential time: %f; Parallel time: %f",
 168            xbt_os_timer_elapsed(simix_global->timer_seq),
 169            xbt_os_timer_elapsed(simix_global->timer_par));
 170   xbt_os_timer_free(simix_global->timer_seq);
 171   xbt_os_timer_free(simix_global->timer_par);
 172 #endif
 173
 174   xbt_mallocator_free(simix_global->action_mallocator);
 175   xbt_free(simix_global);
 176   simix_global = NULL;
 177
 178   return;
 179 }
 180
 181
 182 /**
 183  * \ingroup SIMIX_API
 184  * \brief A clock (in second).
 185  *
 186  * \return Return the clock.
 187  */
 188 XBT_INLINE double SIMIX_get_clock(void)
 189 {
 190   if(MC_is_active()){
 191     return MC_process_clock_get(SIMIX_process_self());
 192   }else{
 193     return surf_get_clock();
 194   }
 195 }
 196
 197 static int process_syscall_color(void *p)
 198 {
 199   switch ((*(smx_process_t *)p)->simcall.call) {
 200   case SIMCALL_NONE:
 201   case SIMCALL_PROCESS_KILL:
 202     return 2;
 203   case SIMCALL_PROCESS_RESUME:
 204     return 1;
 205   default:
 206     return 0;
 207   }
 208 }
 209
 210 /**
 211  * \ingroup SIMIX_API
 212  * \brief Run the main simulation loop.
 213  */
 214 void SIMIX_run(void)
 215 {
 216   double time = 0;
 217   smx_process_t process;
 218   surf_action_t action;
 219   smx_timer_t timer;
 220   surf_model_t model;
 221   unsigned int iter;
 222
 223   do {
 224     XBT_DEBUG("New Schedule Round; size(queue)=%lu",
 225         xbt_dynar_length(simix_global->process_to_run));
 226 #ifdef TIME_BENCH_PER_SR
 227     smx_ctx_raw_new_sr();
 228 #endif
 229     while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 230       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
 231               xbt_dynar_length(simix_global->process_to_run));
 232
 233       /* Run all processes that are ready to run, possibly in parallel */
 234 #ifdef TIME_BENCH_AMDAHL
 235       xbt_os_cputimer_stop(simix_global->timer_seq);
 236       xbt_os_cputimer_resume(simix_global->timer_par);
 237 #endif
 238       SIMIX_process_runall();
 239 #ifdef TIME_BENCH_AMDAHL
 240       xbt_os_cputimer_stop(simix_global->timer_par);
 241       xbt_os_cputimer_resume(simix_global->timer_seq);
 242 #endif
 243
 244       /* Move all killing processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
 245       xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
 246
 247       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
 248
 249       /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
 250
 251       /* Here, the order is ok because:
 252        *
 253        *   Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
 254        *
 255        *   Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
 256        *
 257        *   - if there is no kill during the simulation, processes remain sorted according by their PID.
 258        *     rational: This can be proved inductively.
 259        *        Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
 260        *        Let's show that it is still so at the end of this round.
 261        *        - if a process is added when being created, that's from maestro. It can be either at startup
 262        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
 263        *          in arbitrary order (inductive hypothesis), we are fine.
 264        *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
 265        *        - If a process gets added to process_to_run because one of their blocking action constituting the meat
 266        *          of a simcall terminates, we're still good. Proof:
 267        *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
 268        *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
 269        *          - For communications, this function is called from SIMIX_comm_finish().
 270        *            This function itself don't mess with the order since simcalls are handled in FIFO order.
 271        *            The function is called:
 272        *            - before the comm starts (invalid parameters, or resource already dead or whatever).
 273        *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
 274        *            - because the communication failed or were canceled after startup. In this case, it's called from the function
 275        *              we are in, by the chunk:
 276        *                       set = model->states.failed_action_set;
 277        *                       while ((action = xbt_swag_extract(set)))
 278        *                          SIMIX_simcall_post((smx_action_t) action->data);
 279        *              This order is also fixed because it depends of the order in which the surf actions were
 280        *              added to the system, and only maestro can add stuff this way, through simcalls.
 281        *              We thus use the inductive hypothesis once again to conclude that the order in which actions are
 282        *              poped out of the swag does not depend on the user code's execution order.
 283        *            - because the communication terminated. In this case, actions are served in the order given by
 284        *                       set = model->states.done_action_set;
 285        *                       while ((action = xbt_swag_extract(set)))
 286        *                          SIMIX_simcall_post((smx_action_t) action->data);
 287        *              and the argument is very similar to the previous one.
 288        *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
 289        *          So, in any cases, the orders of processes within process_to_run do not depend on the order in which user processes were executed previously.
 290        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
 291        *   - If there is some process killings, the order is changed by this decision that comes from user-land
 292        *     But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
 293        *     So, even the order change induced by the process killing is perfectly reproducible.
 294        *
 295        *   So science works, bitches [http://xkcd.com/54/].
 296        *
 297        *   We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
 298        *   (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
 299        *   That would thus be a pure waste of time.
 300        */
 301
 302       xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
 303         if (process->simcall.call != SIMCALL_NONE) {
 304           SIMIX_simcall_pre(&process->simcall, 0);
 305         }
 306       }
 307     }
 308
 309     time = SIMIX_timer_next();
 310     if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
 311       time = surf_solve(time);
 312
 313     /* Notify all the hosts that have failed */
 314     /* FIXME: iterate through the list of failed host and mark each of them */
 315     /* as failed. On each host, signal all the running processes with host_fail */
 316
 317     /* Handle any pending timer */
 318     while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
 319        //FIXME: make the timers being real callbacks
 320        // (i.e. provide dispatchers that read and expand the args)
 321        timer = xbt_heap_pop(simix_timers);
 322        if (timer->func)
 323          ((void (*)(void*))timer->func)(timer->args);
 324        xbt_free(timer);
 325     }
 326
 327     /* Wake up all processes waiting for a Surf action to finish */
 328     xbt_dynar_foreach(model_list, iter, model) {
 329       while ((action = surf_model_extract_failed_action_set(model)))
 330         SIMIX_simcall_post((smx_action_t) surf_action_get_data(action));
 331
 332       while ((action = surf_model_extract_done_action_set(model)))
 333         if (surf_action_get_data(action) == NULL)
 334           XBT_DEBUG("probably vcpu's action %p, skip", action);
 335         else
 336           SIMIX_simcall_post((smx_action_t) surf_action_get_data(action));
 337     }
 338
 339     /* Autorestart all process */
 340     if(host_that_restart) {
 341       char *hostname = NULL;
 342       xbt_dynar_foreach(host_that_restart,iter,hostname) {
 343         XBT_INFO("Restart processes on host: %s",hostname);
 344         SIMIX_host_autorestart(SIMIX_host_get_by_name(hostname));
 345       }
 346       xbt_dynar_reset(host_that_restart);
 347     }
 348
 349     /* Clean processes to destroy */
 350     SIMIX_process_empty_trash();
 351
 352
 353     XBT_DEBUG("### time %f, empty %d", time, xbt_dynar_is_empty(simix_global->process_to_run));
 354     // !(time == -1.0 && xbt_dynar_is_empty())
 355
 356
 357   } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
 358
 359   if (xbt_swag_size(simix_global->process_list) != 0) {
 360
 361 #ifdef HAVE_TRACING
 362     TRACE_end();
 363 #endif
 364
 365     XBT_CRITICAL("Oops ! Deadlock or code not perfectly clean.");
 366     SIMIX_display_process_status();
 367     xbt_abort();
 368   }
 369 }
 370
 371 /**
 372  *   \brief Set the date to execute a function
 373  *
 374  * Set the date to execute the function on the surf.
 375  *   \param date Date to execute function
 376  *   \param function Function to be executed
 377  *   \param arg Parameters of the function
 378  *
 379  */
 380 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 381 {
 382   smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 383
 384   timer->date = date;
 385   timer->func = function;
 386   timer->args = arg;
 387   xbt_heap_push(simix_timers, timer, date);
 388 }
 389
 390 /**
 391  * \brief Registers a function to create a process.
 392  *
 393  * This function registers a function to be called
 394  * when a new process is created. The function has
 395  * to call SIMIX_process_create().
 396  * \param function create process function
 397  */
 398 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
 399                                                        function)
 400 {
 401   simix_global->create_process_function = function;
 402 }
 403
 404 /**
 405  * \brief Registers a function to kill a process.
 406  *
 407  * This function registers a function to be called when a
 408  * process is killed. The function has to call the SIMIX_process_kill().
 409  *
 410  * \param function Kill process function
 411  */
 412 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t_smxprocess_t
 413                                                      function)
 414 {
 415   simix_global->kill_process_function = function;
 416 }
 417
 418 /**
 419  * \brief Registers a function to cleanup a process.
 420  *
 421  * This function registers a user function to be called when
 422  * a process ends properly.
 423  *
 424  * \param function cleanup process function
 425  */
 426 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
 427                                                         function)
 428 {
 429   simix_global->cleanup_process_function = function;
 430 }
 431
 432
 433 void SIMIX_display_process_status(void)
 434 {
 435   if (simix_global->process_list == NULL) {
 436     return;
 437   }
 438
 439   smx_process_t process = NULL;
 440   int nbprocess = xbt_swag_size(simix_global->process_list);
 441
 442   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
 443   /*  List the process and their state */
 444   XBT_INFO
 445     ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
 446   xbt_swag_foreach(process, simix_global->process_list) {
 447
 448     if (process->waiting_action) {
 449
 450       const char* action_description = "unknown";
 451       switch (process->waiting_action->type) {
 452
 453       case SIMIX_ACTION_EXECUTE:
 454         action_description = "execution";
 455         break;
 456
 457       case SIMIX_ACTION_PARALLEL_EXECUTE:
 458         action_description = "parallel execution";
 459         break;
 460
 461       case SIMIX_ACTION_COMMUNICATE:
 462         action_description = "communication";
 463         break;
 464
 465       case SIMIX_ACTION_SLEEP:
 466         action_description = "sleeping";
 467         break;
 468
 469       case SIMIX_ACTION_SYNCHRO:
 470         action_description = "synchronization";
 471         break;
 472
 473       case SIMIX_ACTION_IO:
 474         action_description = "I/O";
 475         break;
 476       /* **************************************/
 477       /* TUTORIAL: New API                    */
 478       case SIMIX_ACTION_NEW_API:
 479         action_description = "NEW API";
 480       /* **************************************/
 481
 482         break;
 483       }
 484       XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
 485           process->pid, process->name, sg_host_name(process->smx_host),
 486           action_description, process->waiting_action,
 487           process->waiting_action->name, (int)process->waiting_action->state);
 488     }
 489     else {
 490       XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, sg_host_name(process->smx_host));
 491     }
 492   }
 493 }
 494
 495 static void* SIMIX_action_mallocator_new_f(void) {
 496   smx_action_t action = xbt_new(s_smx_action_t, 1);
 497   action->simcalls = xbt_fifo_new();
 498   return action;
 499 }
 500
 501 static void SIMIX_action_mallocator_free_f(void* action) {
 502   xbt_fifo_free(((smx_action_t) action)->simcalls);
 503   xbt_free(action);
 504 }
 505
 506 static void SIMIX_action_mallocator_reset_f(void* action) {
 507
 508   // we also recycle the simcall list
 509   xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
 510   xbt_fifo_reset(fifo);
 511   memset(action, 0, sizeof(s_smx_action_t));
 512   ((smx_action_t) action)->simcalls = fifo;
 513 }
 514
 515 xbt_dict_t SIMIX_pre_asr_get_properties(smx_simcall_t simcall, const char *name){
 516   return SIMIX_asr_get_properties(name);
 517 }
 518 xbt_dict_t SIMIX_asr_get_properties(const char *name)
 519 {
 520   return xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
 521 }
 522