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
  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     return result;
 116 }
 117
 118 static bool check_for_lost_load()
 119 {
 120     bool res = true;
 121     double total_init = process::get_total_load_init();
 122     double total_exit = process::get_total_load_exit();
 123     double lost = total_init - total_exit;
 124     double lost_ratio = 100.0 * lost / total_init;
 125     if (lost_ratio < -opt::load_ratio_threshold) {
 126         XBT_ERROR("Gained load at exit! %g (%g%%) <============",
 127                   -lost, -lost_ratio);
 128         res = false;
 129     } else if (lost_ratio > opt::load_ratio_threshold) {
 130         XBT_ERROR("Lost load at exit! %g (%g%%) <============",
 131                   lost, lost_ratio);
 132         res = false;
 133     } else
 134         XBT_VERB("Total load at exit looks good: %g (%g%%)", lost, lost_ratio);
 135
 136     double total_running = process::get_total_load_running();
 137     double running_ratio = 100.0 * total_running / total_init;
 138     if (running_ratio < -opt::load_ratio_threshold) {
 139         XBT_ERROR("Negative running load at exit! %g (%g%%) <============",
 140                   total_running, running_ratio);
 141         res = false;
 142     } else if (running_ratio > opt::load_ratio_threshold) {
 143         XBT_ERROR("Remaining running load at exit! %g (%g%%) <============",
 144                   total_running, running_ratio);
 145         res = false;
 146     } else
 147         XBT_VERB("Running load at exit looks good: %g (%g%%)",
 148                  total_running, running_ratio);
 149     return res;
 150 }
 151
 152 static void signal_handler(int /*sig*/)
 153 {
 154     if (!opt::exit_request) {
 155         XBT_CRITICAL(">>>>>>>>>>"
 156                      " caught CTRL-C: global exit requested "
 157                      "<<<<<<<<<<");
 158         opt::exit_request = 1;
 159     } else {
 160         XBT_CRITICAL(">>>>>>>>>>"
 161                      " caught CTRL-C for the 2nd time: exit immediately "
 162                      "<<<<<<<<<<");
 163         exit(EXIT_FAILURE_INTR);
 164     }
 165 }
 166
 167 static void install_signal_handler()
 168 {
 169     struct sigaction action;
 170     action.sa_handler = signal_handler;
 171     sigemptyset(&action.sa_mask);
 172     action.sa_flags = SA_RESTART;
 173     if (sigaction(SIGINT, &action, NULL) == -1) {
 174         std::cerr << "sigaction: " << strerror(errno) << "\n";
 175         exit(EXIT_FAILURE_OTHER);
 176     }
 177 }
 178
 179 #define PR_VALUE(descr, format, ...)                                    \
 180     XBT_INFO("| %.*s: " format, DATA_DESCR_WIDTH,                       \
 181              descr ".................................................", \
 182              __VA_ARGS__)
 183
 184 #define PR_STATS(descr, st)                                             \
 185     XBT_INFO("| %.*s: %g / %g / %g", DATA_DESCR_WIDTH,                  \
 186              descr " (sum/avg/dev)...................................", \
 187              st.get_sum(), st.get_mean(), st.get_stddev())
 188
 189 int main(int argc, char* argv[])
 190 {
 191     int exit_status = 0;   // global exit status
 192     double simulated_time = -1.0;
 193     timestamp elapsed_time(timestamp::wallclock_time);
 194     timestamp simulation_time(timestamp::cpu_time);
 195     MSG_error_t res;
 196
 197     elapsed_time.start();
 198     simulation_time.start();
 199
 200     // Set default logging parameters
 201     bool do_log_control_set = true;
 202     for (int i = 1 ; do_log_control_set && i < argc ; i++)
 203         do_log_control_set = !(argv[i][0] == '-' && argv[i][1] != '-' &&
 204                                strchr(argv[i] + 1, 'v'));
 205     if (do_log_control_set) {
 206         // xbt_log_control_set("simu.thres:verbose");
 207         xbt_log_control_set("simu.fmt:'[%h %r] [%c/%p] %m%n'");
 208         xbt_log_control_set("main.fmt:'[%c/%p] %m%n'");
 209     }
 210
 211     // Initialize some MSG internal data.
 212     MSG_global_init(&argc, argv);
 213     install_signal_handler();
 214
 215     // Parse global parameters
 216     bool parse_res = opt::parse_args(&argc, argv);
 217     if (!parse_res
 218         || opt::version_requested || opt::help_requested) {
 219         if (opt::version_requested)
 220             std::clog << version::name << " (" << opt::program_name << ")"
 221                       << " version " << version::num << "\n"
 222                       << version::copyright << "\n"
 223                 "Compiled on " << version::date << "\n\n";
 224         if (!parse_res || opt::help_requested)
 225             opt::usage();
 226         MSG_clean();
 227         exit(parse_res ? EXIT_NO_FAILURE : EXIT_FAILURE_ARGS);
 228     }
 229     XBT_INFO("%s v%s (%s)", opt::program_name.c_str(), version::num.c_str(),
 230           version::date.c_str());
 231     opt::print();
 232
 233     // Register the default function of an agent
 234     // MSG_function_register("simulation_main", simulation_main);
 235     MSG_function_register_default(simulation_main);
 236
 237     // Create the platform and the application.
 238     XBT_DEBUG("Loading platform file...");
 239     MSG_create_environment(opt::platform_file.c_str());
 240     XBT_DEBUG("Creating hostdata...");
 241     hostdata::create();
 242     XBT_INFO("Loaded description of %zd hosts.", hostdata::size());
 243     XBT_DEBUG("Deploying processes...");
 244     if (opt::auto_depl::enabled) {
 245         if (!opt::auto_depl::nhosts)
 246             opt::auto_depl::nhosts = hostdata::size();
 247         if (opt::auto_depl::nhosts > hostdata::size()) {
 248             XBT_WARN("%u hosts is too much: limiting to %zu",
 249                      opt::auto_depl::nhosts, hostdata::size());
 250             opt::auto_depl::nhosts = hostdata::size();
 251         }
 252         if (opt::auto_depl::load == 0.0) {
 253             XBT_WARN("Initial load is zero!  "
 254                      "Falling back on old behaviour (load = nhosts).");
 255             opt::auto_depl::load = opt::auto_depl::nhosts;
 256         } else if (opt::auto_depl::load < 0.0)
 257             opt::auto_depl::load =
 258                 -opt::auto_depl::load * opt::auto_depl::nhosts;
 259         double iload = std::trunc(opt::auto_depl::load);
 260         if (opt::integer_transfer && opt::auto_depl::load != iload) {
 261             XBT_WARN("Total load %g is not an integer.  Truncate it.",
 262                      opt::auto_depl::load);
 263             opt::auto_depl::load = iload;
 264         }
 265         MY_launch_application(); // it is already opt::* aware...
 266     } else {
 267         MSG_launch_application(opt::deployment_file.c_str());
 268     }
 269
 270     // Register tracing categories
 271     TRACE_category_with_color(TRACE_CAT_COMP, TRACE_COLOR_COMP);
 272     TRACE_category_with_color(TRACE_CAT_CTRL, TRACE_COLOR_CTRL);
 273     TRACE_category_with_color(TRACE_CAT_DATA, TRACE_COLOR_DATA);
 274
 275     proc_mutex = new mutex_t();
 276     proc_cond = new condition_t();
 277     process::set_proc_mutex(proc_mutex);
 278
 279     // Launch the MSG simulation.
 280     XBT_INFO("Starting simulation at %f...", MSG_get_clock());
 281     res = MSG_main();
 282     simulated_time = MSG_get_clock();
 283     XBT_INFO("Simulation ended at %f.", simulated_time);
 284
 285     process::set_proc_mutex(NULL);
 286     delete proc_cond;
 287     delete proc_mutex;
 288
 289     if (res == MSG_OK) {
 290         exit_status = EXIT_NO_FAILURE;
 291     } else {
 292         XBT_ERROR("MSG_main() failed with status %#x", res);
 293         exit_status = EXIT_FAILURE_SIMU;
 294     }
 295
 296     // Clean the MSG simulation.
 297     hostdata::destroy();
 298     res = MSG_clean();
 299     if (res != MSG_OK) {
 300         XBT_ERROR("MSG_clean() failed with status %#x", res);
 301         exit_status |= EXIT_FAILURE_CLEAN;
 302     }
 303
 304     // Report final simulation status.
 305     if (simulated_time >= 0.0) {
 306         simulation_time.stop();
 307         elapsed_time.stop();
 308         if (!check_for_lost_load())
 309             exit_status |= EXIT_FAILURE_LOAD;
 310
 311         XBT_INFO(",----[ Results ]");
 312         PR_STATS("Load", loads);
 313         PR_STATS("Computation", comps);
 314         PR_STATS("Comp. iterations", comp_iterations);
 315         PR_STATS("X-Comp. iterations", all_comp_iterations);
 316         PR_STATS("Data send amount", data_send_amount);
 317         PR_STATS("Data recv amount", data_recv_amount);
 318         PR_STATS("Data send count", data_send_count);
 319         PR_STATS("Data recv count", data_recv_count);
 320         PR_STATS("Ctrl send amount", ctrl_send_amount);
 321         PR_STATS("Ctrl recv amount", ctrl_recv_amount);
 322         PR_STATS("Ctrl send count", ctrl_send_count);
 323         PR_STATS("Ctrl recv count", ctrl_recv_count);
 324         PR_VALUE("Total simulated time", "%g", simulated_time);
 325         PR_VALUE("Total simulation time", "%g", simulation_time.duration());
 326         PR_VALUE("Elapsed (wall clock) time", "%g", elapsed_time.duration());
 327         XBT_INFO("`----");
 328
 329         double load_imbalance = 100.0 * loads.get_stddev() / loads.get_mean();
 330         double transfer_amount =
 331             data_send_amount.get_sum() / opt::comm_cost(loads.get_sum());
 332
 333         XBT_INFO(",----[ Useful metrics ]");
 334         PR_VALUE("Final load imbalance", "%g %s", load_imbalance,
 335                  "percent of the load average");
 336         PR_VALUE("Data transfer amount", "%g %s", transfer_amount,
 337                  "times the total amount of data");
 338         PR_VALUE("Number of hosts that converged", "%u / %u",
 339                  convergence.get_count(), loads.get_count());
 340         PR_VALUE("Times of convergence (min/max/avg/dev)", "%g / %g / %g / %g",
 341                  convergence.get_min(), convergence.get_max(),
 342                  convergence.get_mean(), convergence.get_stddev());
 343         PR_STATS("Idle duration", idle_duration);
 344         PR_STATS("Supernumer. comp. iter.", iter_deviation);
 345         XBT_INFO("`----");
 346
 347     }
 348     if (exit_status)
 349         XBT_ERROR("Simulation failed (%#x).", exit_status);
 350     else
 351         XBT_INFO("Simulation succeeded.");
 352
 353     return exit_status;
 354 }
 355
 356 // Local variables:
 357 // mode: c++
 358 // End: