main.cpp

   1 #include <cerrno>
   2 #include <cmath>
   3 #include <csignal>
   4 #include <cstring>              // strchr
   5 #include <iostream>
   6 #include <stdexcept>
   7 #include <msg/msg.h>
   8 #include <xbt/log.h>
   9
  10 // Creates log categories
  11 XBT_LOG_NEW_CATEGORY(simu, "Root of simulation messages");
  12 XBT_LOG_NEW_SUBCATEGORY(main, simu, "Messages from global infrastructure");
  13 XBT_LOG_NEW_SUBCATEGORY(depl, main, "Messages from auto deployment");
  14 XBT_LOG_NEW_SUBCATEGORY(comm, simu, "Messages from asynchronous pipes");
  15 XBT_LOG_NEW_SUBCATEGORY(proc, simu, "Messages from base process class");
  16 XBT_LOG_NEW_SUBCATEGORY(loba, simu, "Messages from load-balancer");
  17 XBT_LOG_NEW_SUBCATEGORY(thrd, simu, "Messages from thread wrapper class");
  18
  19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
  20
  21 #include "deployment.h"
  22 #include "hostdata.h"
  23 #include "misc.h"
  24 #include "options.h"
  25 #include "process.h"
  26 #include "statistics.h"
  27 #include "synchro.h"
  28 #include "timer.h"
  29 #include "tracing.h"
  30 #include "version.h"
  31
  32 #define DATA_DESCR_WIDTH 39
  33
  34 namespace {
  35     // Failure exit status
  36     enum {
  37         EXIT_NO_FAILURE    = 0x00,  // no error
  38         EXIT_FAILURE_ARGS  = 0x01,  // bad arguments
  39         EXIT_FAILURE_INIT  = 0x02,  // failed to initialize simulator
  40         EXIT_FAILURE_SIMU  = 0x04,  // simulation failed
  41         EXIT_FAILURE_CLEAN = 0x08,  // error at cleanup
  42         EXIT_FAILURE_INTR  = 0x10,  // interrupted by user
  43         EXIT_FAILURE_LOAD  = 0x20,  // lost load on exit
  44         EXIT_FAILURE_OTHER = 0x40,  // other error
  45     };
  46
  47     // Cannot be globally initialized...
  48     mutex_t* proc_mutex;
  49     condition_t* proc_cond;
  50     unsigned proc_counter = 0;
  51
  52     statistics loads;
  53     statistics comps;
  54     statistics comp_iterations;
  55     statistics all_comp_iterations;
  56     statistics data_send_amount;
  57     statistics data_recv_amount;
  58     statistics data_send_count;
  59     statistics data_recv_count;
  60     statistics ctrl_send_amount;
  61     statistics ctrl_recv_amount;
  62     statistics ctrl_send_count;
  63     statistics ctrl_recv_count;
  64     statistics convergence;
  65
  66 }
  67
  68 static int simulation_main(int argc, char* argv[])
  69 {
  70     int result;
  71     process* proc;
  72     try {
  73         proc = opt::loba_algorithms.new_instance(opt::loba_algo, argc, argv);
  74
  75         proc_mutex->acquire();
  76         ++proc_counter;
  77         proc_mutex->release();
  78
  79         result = proc->run();
  80
  81         proc_mutex->acquire();
  82         loads.push(proc->get_real_load());
  83         comps.push(proc->get_comp_amount());
  84         comp_iterations.push(proc->get_comp_iter());
  85         all_comp_iterations.push(proc->get_all_comp_iter());
  86         data_send_amount.push(proc->get_data_send_amount());
  87         data_recv_amount.push(proc->get_data_recv_amount());
  88         data_send_count.push(proc->get_data_send_count());
  89         data_recv_count.push(proc->get_data_recv_count());
  90         ctrl_send_amount.push(proc->get_ctrl_send_amount());
  91         ctrl_recv_amount.push(proc->get_ctrl_recv_amount());
  92         ctrl_send_count.push(proc->get_ctrl_send_count());
  93         ctrl_recv_count.push(proc->get_ctrl_recv_count());
  94         double c = proc->get_convergence();
  95         if (c != -1)
  96             convergence.push(c);
  97
  98         // Synchronization barrier...
  99         // The goal is to circumvent a limitation in SimGrid (at least
 100         // in version 3.5): a process must be alive when another one
 101         // destroys a communication they had together.
 102
 103         --proc_counter;
 104         proc_cond->broadcast();
 105         while (proc_counter > 0)
 106             proc_cond->wait(*proc_mutex);
 107         proc_mutex->release();
 108
 109         delete proc;
 110     }
 111     catch (const std::invalid_argument& e) {
 112         THROWF(arg_error, 0, "%s", e.what());
 113     }
 114     catch (const std::exception& e) {
 115         THROWF(0, 0, "%s", e.what());
 116     }
 117     return result;
 118 }
 119
 120 static bool check_for_lost_load()
 121 {
 122     bool res = true;
 123     double total_init = process::get_total_load_init();
 124     double total_exit = process::get_total_load_exit();
 125     double lost = total_init - total_exit;
 126     double lost_ratio = 100.0 * lost / total_init;
 127     if (lost_ratio < -opt::load_ratio_threshold) {
 128         XBT_ERROR("Gained load at exit! %g (%g%%) <============",
 129                   -lost, -lost_ratio);
 130         res = false;
 131     } else if (lost_ratio > opt::load_ratio_threshold) {
 132         XBT_ERROR("Lost load at exit! %g (%g%%) <============",
 133                   lost, lost_ratio);
 134         res = false;
 135     } else
 136         XBT_VERB("Total load at exit looks good: %g (%g%%)", lost, lost_ratio);
 137
 138     double total_running = process::get_total_load_running();
 139     double running_ratio = 100.0 * total_running / total_init;
 140     if (running_ratio < -opt::load_ratio_threshold) {
 141         XBT_ERROR("Negative running load at exit! %g (%g%%) <============",
 142                   total_running, running_ratio);
 143         res = false;
 144     } else if (running_ratio > opt::load_ratio_threshold) {
 145         XBT_ERROR("Remaining running load at exit! %g (%g%%) <============",
 146                   total_running, running_ratio);
 147         res = false;
 148     } else
 149         XBT_VERB("Running load at exit looks good: %g (%g%%)",
 150                  total_running, running_ratio);
 151     return res;
 152 }
 153
 154 static void signal_handler(int /*sig*/)
 155 {
 156     if (!opt::exit_request) {
 157         XBT_CRITICAL(">>>>>>>>>>"
 158                      " caught CTRL-C: global exit requested "
 159                      "<<<<<<<<<<");
 160         opt::exit_request = 1;
 161     } else {
 162         XBT_CRITICAL(">>>>>>>>>>"
 163                      " caught CTRL-C for the 2nd time: exit immediately "
 164                      "<<<<<<<<<<");
 165         exit(EXIT_FAILURE_INTR);
 166     }
 167 }
 168
 169 static void install_signal_handler()
 170 {
 171     struct sigaction action;
 172     action.sa_handler = signal_handler;
 173     sigemptyset(&action.sa_mask);
 174     action.sa_flags = SA_RESTART;
 175     if (sigaction(SIGINT, &action, NULL) == -1) {
 176         std::cerr << "sigaction: " << strerror(errno) << "\n";
 177         exit(EXIT_FAILURE_OTHER);
 178     }
 179 }
 180
 181 #define PR_VALUE(descr, format, ...)                                    \
 182     XBT_INFO("| %.*s: " format, DATA_DESCR_WIDTH,                       \
 183              descr ".................................................", \
 184              __VA_ARGS__)
 185
 186 #define PR_STATS(descr, st)                                             \
 187     XBT_INFO("| %.*s: %g / %g / %g", DATA_DESCR_WIDTH,                  \
 188              descr " (total/avg./stddev).............................", \
 189              st.get_sum(), st.get_mean(), st.get_stddev())
 190
 191 int main(int argc, char* argv[])
 192 {
 193     // Note: variables used after THROW must be declared as volatile.
 194     volatile int exit_status = 0;   // global exit status
 195     volatile double simulated_time = -1.0;
 196     timestamp elapsed_time(timestamp::wallclock_time);
 197     timestamp simulation_time(timestamp::cpu_time);
 198     xbt_ex_t ex;
 199     MSG_error_t res;
 200
 201     elapsed_time.start();
 202     simulation_time.start();
 203
 204     // Set default logging parameters
 205     bool do_log_control_set = true;
 206     for (int i = 1 ; do_log_control_set && i < argc ; i++)
 207         do_log_control_set = !(argv[i][0] == '-' && argv[i][1] != '-' &&
 208                                strchr(argv[i] + 1, 'v'));
 209     if (do_log_control_set) {
 210         // xbt_log_control_set("simu.thres:verbose");
 211         xbt_log_control_set("simu.fmt:'[%h %r] [%c/%p] %m%n'");
 212         xbt_log_control_set("main.fmt:'[%c/%p] %m%n'");
 213     }
 214
 215     // Initialize some MSG internal data.
 216     // Note: MSG_global_init() may throw an exception, but it seems
 217     // impossible to catch it correctly :-(
 218     MSG_global_init(&argc, argv);
 219     install_signal_handler();
 220
 221     // Parse global parameters
 222     bool parse_res = opt::parse_args(&argc, argv);
 223     if (!parse_res
 224         || opt::version_requested || opt::help_requested) {
 225         if (opt::version_requested)
 226             std::clog << version::name << " (" << opt::program_name << ")"
 227                       << " version " << version::num << "\n"
 228                       << version::copyright << "\n"
 229                 "Compiled on " << version::date << "\n\n";
 230         if (!parse_res || opt::help_requested)
 231             opt::usage();
 232         MSG_clean();
 233         exit(parse_res ? EXIT_NO_FAILURE : EXIT_FAILURE_ARGS);
 234     }
 235     XBT_INFO("%s v%s (%s)", opt::program_name.c_str(), version::num.c_str(),
 236           version::date.c_str());
 237     opt::print();
 238
 239     TRY {
 240         exit_status = EXIT_FAILURE_INIT; // =====
 241
 242         // Register the default function of an agent
 243         // MSG_function_register("simulation_main", simulation_main);
 244         MSG_function_register_default(simulation_main);
 245
 246         // Create the platform and the application.
 247         XBT_DEBUG("Loading platform file...");
 248         MSG_create_environment(opt::platform_file.c_str());
 249         XBT_DEBUG("Creating hostdata...");
 250         hostdata::create();
 251         XBT_INFO("Loaded description of %zd hosts.", hostdata::size());
 252         XBT_DEBUG("Deploying processes...");
 253         if (opt::auto_depl::enabled) {
 254             if (!opt::auto_depl::nhosts)
 255                 opt::auto_depl::nhosts = hostdata::size();
 256             if (opt::auto_depl::nhosts > hostdata::size()) {
 257                 XBT_WARN("%u hosts is too much: limiting to %zu",
 258                          opt::auto_depl::nhosts, hostdata::size());
 259                 opt::auto_depl::nhosts = hostdata::size();
 260             }
 261             if (opt::auto_depl::load == 0.0) {
 262                 XBT_WARN("Initial load is zero!  "
 263                          "Falling back on old behaviour (load = nhosts).");
 264                 opt::auto_depl::load = opt::auto_depl::nhosts;
 265             } else if (opt::auto_depl::load < 0.0)
 266                 opt::auto_depl::load =
 267                     -opt::auto_depl::load * opt::auto_depl::nhosts;
 268             double iload = std::trunc(opt::auto_depl::load);
 269             if (opt::integer_transfer && opt::auto_depl::load != iload) {
 270                 XBT_WARN("Total load %g is not an integer.  Truncate it.",
 271                          opt::auto_depl::load);
 272                 opt::auto_depl::load = iload;
 273             }
 274             MY_launch_application(); // it is already opt::* aware...
 275         } else {
 276             MSG_launch_application(opt::deployment_file.c_str());
 277         }
 278
 279         // Register tracing categories
 280         TRACE_category_with_color(TRACE_CAT_COMP, TRACE_COLOR_COMP);
 281         TRACE_category_with_color(TRACE_CAT_CTRL, TRACE_COLOR_CTRL);
 282         TRACE_category_with_color(TRACE_CAT_DATA, TRACE_COLOR_DATA);
 283
 284         exit_status = EXIT_FAILURE_SIMU; // =====
 285
 286         proc_mutex = new mutex_t();
 287         proc_cond = new condition_t();
 288
 289         // Launch the MSG simulation.
 290         XBT_INFO("Starting simulation at %f...", MSG_get_clock());
 291         res = MSG_main();
 292         simulated_time = MSG_get_clock();
 293         XBT_INFO("Simulation ended at %f.", simulated_time);
 294
 295         delete proc_cond;
 296         delete proc_mutex;
 297
 298         if (res != MSG_OK)
 299             THROWF(0, 0, "MSG_main() failed with status %#x", res);
 300
 301         exit_status = EXIT_NO_FAILURE; // =====
 302     }
 303     CATCH (ex) {
 304         int len = strlen(ex.msg);
 305         if (len > 0 && ex.msg[len - 1] == '\n')
 306             ex.msg[len - 1] = '\0'; // strip the ending '\n'
 307         XBT_ERROR("%s", ex.msg);
 308         XBT_DEBUG("Error from %s() in %s:%d", ex.func, ex.file, ex.line);
 309         xbt_ex_free(ex);
 310     }
 311
 312     // Clean the MSG simulation.
 313     hostdata::destroy();
 314     res = MSG_clean();
 315     if (res != MSG_OK) {
 316         XBT_ERROR("MSG_clean() failed with status %#x", res);
 317         exit_status |= EXIT_FAILURE_CLEAN;
 318     }
 319
 320     // Report final simulation status.
 321     if (simulated_time >= 0.0) {
 322         simulation_time.stop();
 323         elapsed_time.stop();
 324         if (!check_for_lost_load())
 325             exit_status |= EXIT_FAILURE_LOAD;
 326
 327         XBT_INFO(",----[ Results ]");
 328         PR_STATS("Load", loads);
 329         PR_STATS("Computation", comps);
 330         PR_STATS("Comp. iterations", comp_iterations);
 331         PR_STATS("X-Comp. iterations", all_comp_iterations);
 332         PR_STATS("Data send amount", data_send_amount);
 333         PR_STATS("Data recv amount", data_recv_amount);
 334         PR_STATS("Data send count", data_send_count);
 335         PR_STATS("Data recv count", data_recv_count);
 336         PR_STATS("Ctrl send amount", ctrl_send_amount);
 337         PR_STATS("Ctrl recv amount", ctrl_recv_amount);
 338         PR_STATS("Ctrl send count", ctrl_send_count);
 339         PR_STATS("Ctrl recv count", ctrl_recv_count);
 340         PR_VALUE("Total simulated time", "%g", simulated_time);
 341         PR_VALUE("Total simulation time", "%g", simulation_time.duration());
 342         PR_VALUE("Elapsed (wall clock) time", "%g", elapsed_time.duration());
 343         XBT_INFO("`----");
 344
 345         double load_imbalance = 100.0 * loads.get_stddev() / loads.get_mean();
 346         double transfer_amount =
 347             data_send_amount.get_sum() / opt::comm_cost(loads.get_sum());
 348
 349         XBT_INFO(",----[ Useful metrics ]");
 350         PR_VALUE("Final load imbalance", "%g %s", load_imbalance,
 351                  "percent of the load average");
 352         PR_VALUE("Data transfer amount", "%g %s", transfer_amount,
 353                  "times the total amount of data");
 354         PR_VALUE("Number of hosts that converged", "%u / %u",
 355                  convergence.get_count(), loads.get_count());
 356         PR_VALUE("Date of first host convergence", "%g", convergence.get_min());
 357         PR_VALUE("Date of last host convergence", "%g", convergence.get_max());
 358         XBT_INFO("`----");
 359
 360     }
 361     if (exit_status)
 362         XBT_ERROR("Simulation failed (%#x).", exit_status);
 363     else
 364         XBT_INFO("Simulation succeeded.");
 365
 366     return exit_status;
 367 }
 368
 369 // Local variables:
 370 // mode: c++
 371 // End: