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