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
  65 }
  66
  67 static int simulation_main(int argc, char* argv[])
  68 {
  69     int result;
  70     process* proc;
  71     try {
  72         proc = opt::loba_algorithms.new_instance(opt::loba_algo, argc, argv);
  73
  74         proc_mutex->acquire();
  75         ++proc_counter;
  76         proc_mutex->release();
  77
  78         result = proc->run();
  79
  80         proc_mutex->acquire();
  81         loads.push(proc->get_real_load());
  82         comps.push(proc->get_comp_amount());
  83         comp_iterations.push(proc->get_comp_iter());
  84         all_comp_iterations.push(proc->get_all_comp_iter());
  85         data_send_amount.push(proc->get_data_send_amount());
  86         data_recv_amount.push(proc->get_data_recv_amount());
  87         data_send_count.push(proc->get_data_send_count());
  88         data_recv_count.push(proc->get_data_recv_count());
  89         ctrl_send_amount.push(proc->get_ctrl_send_amount());
  90         ctrl_recv_amount.push(proc->get_ctrl_recv_amount());
  91         ctrl_send_count.push(proc->get_ctrl_send_count());
  92         ctrl_recv_count.push(proc->get_ctrl_recv_count());
  93
  94         // Synchronization barrier...
  95         // The goal is to circumvent a limitation in SimGrid (at least
  96         // in version 3.5): a process must be alive when another one
  97         // destroys a communication they had together.
  98
  99         --proc_counter;
 100         proc_cond->broadcast();
 101         while (proc_counter > 0)
 102             proc_cond->wait(*proc_mutex);
 103         proc_mutex->release();
 104
 105         delete proc;
 106     }
 107     catch (const std::invalid_argument& e) {
 108         THROWF(arg_error, 0, "%s", e.what());
 109     }
 110     catch (const std::exception& e) {
 111         THROWF(0, 0, "%s", e.what());
 112     }
 113     return result;
 114 }
 115
 116 static bool check_for_lost_load()
 117 {
 118     bool res = true;
 119     double total_init = process::get_total_load_init();
 120     double total_exit = process::get_total_load_exit();
 121     double lost = total_init - total_exit;
 122     double lost_ratio = 100.0 * lost / total_init;
 123     if (lost_ratio < -opt::load_ratio_threshold) {
 124         XBT_ERROR("Gained load at exit! %g (%g%%) <============",
 125                   -lost, -lost_ratio);
 126         res = false;
 127     } else if (lost_ratio > opt::load_ratio_threshold) {
 128         XBT_ERROR("Lost load at exit! %g (%g%%) <============",
 129                   lost, lost_ratio);
 130         res = false;
 131     } else
 132         XBT_VERB("Total load at exit looks good: %g (%g%%)", lost, lost_ratio);
 133
 134     double total_running = process::get_total_load_running();
 135     double running_ratio = 100.0 * total_running / total_init;
 136     if (running_ratio < -opt::load_ratio_threshold) {
 137         XBT_ERROR("Negative running load at exit! %g (%g%%) <============",
 138                   total_running, running_ratio);
 139         res = false;
 140     } else if (running_ratio > opt::load_ratio_threshold) {
 141         XBT_ERROR("Remaining running load at exit! %g (%g%%) <============",
 142                   total_running, running_ratio);
 143         res = false;
 144     } else
 145         XBT_VERB("Running load at exit looks good: %g (%g%%)",
 146                  total_running, running_ratio);
 147     return res;
 148 }
 149
 150 static void signal_handler(int /*sig*/)
 151 {
 152     if (!opt::exit_request) {
 153         XBT_CRITICAL(">>>>>>>>>>"
 154                      " caught CTRL-C: global exit requested "
 155                      "<<<<<<<<<<");
 156         opt::exit_request = 1;
 157     } else {
 158         XBT_CRITICAL(">>>>>>>>>>"
 159                      " caught CTRL-C for the 2nd time: exit immediately "
 160                      "<<<<<<<<<<");
 161         exit(EXIT_FAILURE_INTR);
 162     }
 163 }
 164
 165 static void install_signal_handler()
 166 {
 167     struct sigaction action;
 168     action.sa_handler = signal_handler;
 169     sigemptyset(&action.sa_mask);
 170     action.sa_flags = SA_RESTART;
 171     if (sigaction(SIGINT, &action, NULL) == -1) {
 172         std::cerr << "sigaction: " << strerror(errno) << "\n";
 173         exit(EXIT_FAILURE_OTHER);
 174     }
 175 }
 176
 177 #define PR_VALUE(descr, format, ...)                                    \
 178     XBT_INFO("| %.*s: " format, DATA_DESCR_WIDTH,                       \
 179              descr ".................................................", \
 180              __VA_ARGS__)
 181
 182 #define PR_STATS(descr, st)                                             \
 183     XBT_INFO("| %.*s: %g / %g / %g", DATA_DESCR_WIDTH,                  \
 184              descr " (total/avg./stddev).............................", \
 185              st.get_sum(), st.get_mean(), st.get_stddev())
 186
 187 int main(int argc, char* argv[])
 188 {
 189     // Note: variables used after THROW must be declared as volatile.
 190     volatile int exit_status = 0;   // global exit status
 191     volatile double simulated_time = -1.0;
 192     timestamp elapsed_time(timestamp::wallclock_time);
 193     timestamp simulation_time(timestamp::cpu_time);
 194     xbt_ex_t ex;
 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     // Note: MSG_global_init() may throw an exception, but it seems
 213     // impossible to catch it correctly :-(
 214     MSG_global_init(&argc, argv);
 215     install_signal_handler();
 216
 217     // Parse global parameters
 218     bool parse_res = opt::parse_args(&argc, argv);
 219     if (!parse_res
 220         || opt::version_requested || opt::help_requested) {
 221         if (opt::version_requested)
 222             std::clog << version::name << " (" << opt::program_name << ")"
 223                       << " version " << version::num << "\n"
 224                       << version::copyright << "\n"
 225                 "Compiled on " << version::date << "\n\n";
 226         if (!parse_res || opt::help_requested)
 227             opt::usage();
 228         MSG_clean();
 229         exit(parse_res ? EXIT_NO_FAILURE : EXIT_FAILURE_ARGS);
 230     }
 231     XBT_INFO("%s v%s (%s)", opt::program_name.c_str(), version::num.c_str(),
 232           version::date.c_str());
 233     opt::print();
 234
 235     TRY {
 236         exit_status = EXIT_FAILURE_INIT; // =====
 237
 238         // Register the default function of an agent
 239         // MSG_function_register("simulation_main", simulation_main);
 240         MSG_function_register_default(simulation_main);
 241
 242         // Create the platform and the application.
 243         XBT_DEBUG("Loading platform file...");
 244         MSG_create_environment(opt::platform_file.c_str());
 245         XBT_DEBUG("Creating hostdata...");
 246         hostdata::create();
 247         XBT_INFO("Loaded description of %zd hosts.", hostdata::size());
 248         XBT_DEBUG("Deploying processes...");
 249         if (opt::auto_depl::enabled) {
 250             if (!opt::auto_depl::nhosts)
 251                 opt::auto_depl::nhosts = hostdata::size();
 252             if (opt::auto_depl::nhosts > hostdata::size()) {
 253                 XBT_WARN("%u hosts is too much: limiting to %zu",
 254                          opt::auto_depl::nhosts, hostdata::size());
 255                 opt::auto_depl::nhosts = hostdata::size();
 256             }
 257             if (opt::auto_depl::load == 0.0) {
 258                 XBT_WARN("Initial load is zero!  "
 259                          "Falling back on old behaviour (load = nhosts).");
 260                 opt::auto_depl::load = opt::auto_depl::nhosts;
 261             } else if (opt::auto_depl::load < 0.0)
 262                 opt::auto_depl::load =
 263                     -opt::auto_depl::load * opt::auto_depl::nhosts;
 264             double iload = std::trunc(opt::auto_depl::load);
 265             if (opt::integer_transfer && opt::auto_depl::load != iload) {
 266                 XBT_WARN("Total load %g is not an integer.  Truncate it.",
 267                          opt::auto_depl::load);
 268                 opt::auto_depl::load = iload;
 269             }
 270             MY_launch_application(); // it is already opt::* aware...
 271         } else {
 272             MSG_launch_application(opt::deployment_file.c_str());
 273         }
 274
 275         // Register tracing categories
 276         TRACE_category_with_color(TRACE_CAT_COMP, TRACE_COLOR_COMP);
 277         TRACE_category_with_color(TRACE_CAT_CTRL, TRACE_COLOR_CTRL);
 278         TRACE_category_with_color(TRACE_CAT_DATA, TRACE_COLOR_DATA);
 279
 280         exit_status = EXIT_FAILURE_SIMU; // =====
 281
 282         proc_mutex = new mutex_t();
 283         proc_cond = new condition_t();
 284
 285         // Launch the MSG simulation.
 286         XBT_INFO("Starting simulation at %f...", MSG_get_clock());
 287         res = MSG_main();
 288         simulated_time = MSG_get_clock();
 289         XBT_INFO("Simulation ended at %f.", simulated_time);
 290
 291         delete proc_cond;
 292         delete proc_mutex;
 293
 294         if (res != MSG_OK)
 295             THROWF(0, 0, "MSG_main() failed with status %#x", res);
 296
 297         exit_status = EXIT_NO_FAILURE; // =====
 298     }
 299     CATCH (ex) {
 300         int len = strlen(ex.msg);
 301         if (len > 0 && ex.msg[len - 1] == '\n')
 302             ex.msg[len - 1] = '\0'; // strip the ending '\n'
 303         XBT_ERROR("%s", ex.msg);
 304         XBT_DEBUG("Error from %s() in %s:%d", ex.func, ex.file, ex.line);
 305         xbt_ex_free(ex);
 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         XBT_INFO("`----");
 351
 352     }
 353     if (exit_status)
 354         XBT_ERROR("Simulation failed (%#x).", exit_status);
 355     else
 356         XBT_INFO("Simulation succeeded.");
 357
 358     return exit_status;
 359 }
 360
 361 // Local variables:
 362 // mode: c++
 363 // End: