main.cpp

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