src/xbt/xbt_main.cpp

   1 /* module handling                                                          */
   2
   3 /* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #define XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL /* MSVC don't want it to be declared extern in headers and local here */
   9
  10 #include "simgrid/config.h"
  11 #include "simgrid/sg_config.hpp"
  12 #include "src/internal_config.h"
  13 #include "src/sthread/sthread.h" // sthread_inside_simgrid
  14 #include "xbt/config.hpp"
  15 #include "xbt/coverage.h"
  16 #include "xbt/dynar.h"
  17 #include "xbt/log.h"
  18 #include "xbt/log.hpp"
  19 #include "xbt/misc.h"
  20 #include "xbt/module.h" /* this module */
  21 #include "xbt/sysdep.h"
  22 #include "xbt/xbt_modinter.h" /* prototype of other module's init/exit in XBT */
  23
  24 #include <cmath>
  25 #include <cstdio>
  26 #ifdef _WIN32
  27 # include <csignal> /* To silence MSVC on abort() */
  28 #endif
  29 #if HAVE_UNISTD_H
  30 # include <unistd.h>
  31 #endif
  32 #include <string>
  33 #include <vector>
  34
  35 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(module, xbt, "module handling");
  36
  37 XBT_LOG_NEW_CATEGORY(smpi, "All SMPI categories"); /* lives here even if that's a bit odd to solve linking issues: this is used in xbt_log_file_appender to detect whether SMPI is used (and thus whether we should unbench the writing to disk) */
  38
  39 namespace simgrid::xbt {
  40 std::string binary_name;          /* Name of the system process containing us (mandatory to retrieve neat backtraces) */
  41 std::vector<std::string> cmdline; /* all we got in argv */
  42 } // namespace simgrid::xbt
  43
  44 int sthread_inside_simgrid = 0; // whether sthread should leave pthread operations or intercept them.
  45
  46 int xbt_initialized = 0;
  47 simgrid::config::Flag<bool> cfg_dbg_clean_atexit{
  48     "debug/clean-atexit",
  49     "Whether to cleanup SimGrid at exit. Disable it if your code segfaults after its end.",
  50     true};
  51
  52 int xbt_pagesize;
  53 int xbt_pagebits = 0;
  54
  55 /* Declare xbt_preinit and xbt_postexit as constructor/destructor of the library.
  56  * This is crude and rather compiler-specific, unfortunately.
  57  */
  58 static void xbt_preinit() XBT_ATTRIB_CONSTRUCTOR(200);
  59 static void xbt_postexit();
  60
  61 #ifdef _WIN32
  62 #include <windows.h>
  63
  64 #ifndef __GNUC__
  65 /* Should not be necessary but for some reason, DllMain is called twice at attachment and at detachment.*/
  66 /* see also http://msdn.microsoft.com/en-us/library/ms682583%28VS.85%29.aspx */
  67 /* and http://www.microsoft.com/whdc/driver/kernel/DLL_bestprac.mspx */
  68 static BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
  69 {
  70   static bool xbt_dll_process_is_attached = false;
  71   if (fdwReason == DLL_PROCESS_ATTACH && not xbt_dll_process_is_attached) {
  72     xbt_dll_process_is_attached = true;
  73     xbt_preinit();
  74   } else if (fdwReason == DLL_PROCESS_DETACH && xbt_dll_process_is_attached) {
  75     xbt_dll_process_is_attached = false;
  76   }
  77   return 1;
  78 }
  79 #endif
  80
  81 #endif
  82
  83 static void xbt_preinit()
  84 {
  85   sthread_inside_simgrid = 1;
  86 #ifdef _WIN32
  87   SYSTEM_INFO si;
  88   GetSystemInfo(&si);
  89   xbt_pagesize = si.dwPageSize;
  90 #elif HAVE_SYSCONF
  91   xbt_pagesize = static_cast<int>(sysconf(_SC_PAGESIZE));
  92 #else
  93 # error Cannot get page size.
  94 #endif
  95
  96   xbt_pagebits = static_cast<int>(log2(xbt_pagesize));
  97
  98 #ifdef _TWO_DIGIT_EXPONENT
  99   /* Even printf behaves differently on Windows... */
 100   _set_output_format(_TWO_DIGIT_EXPONENT);
 101 #endif
 102   xbt_log_preinit();
 103   xbt_dict_preinit();
 104   atexit(xbt_postexit);
 105   sthread_inside_simgrid = 0;
 106 }
 107
 108 static void xbt_postexit()
 109 {
 110   if (not cfg_dbg_clean_atexit)
 111     return;
 112   xbt_initialized--;
 113   xbt_dict_postexit();
 114   xbt_log_postexit();
 115 #if SIMGRID_HAVE_MC
 116   mmalloc_postexit();
 117 #endif
 118 }
 119
 120 /** @brief Initialize the xbt mechanisms. */
 121 void xbt_init(int *argc, char **argv)
 122 {
 123   xbt_initialized++;
 124   if (xbt_initialized > 1) {
 125     XBT_DEBUG("XBT has been initialized %d times.", xbt_initialized);
 126     return;
 127   }
 128
 129   simgrid::xbt::install_exception_handler();
 130
 131   if (*argc > 0)
 132     simgrid::xbt::binary_name = argv[0];
 133   for (int i = 0; i < *argc; i++)
 134     simgrid::xbt::cmdline.emplace_back(argv[i]);
 135
 136   xbt_log_init(argc, argv);
 137 }
 138
 139 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
 140 /** @brief like xbt_free, but you can be sure that it is a function  */
 141 void xbt_free_f(void* p) noexcept(noexcept(::free))
 142 {
 143   xbt_free(p);
 144 }
 145
 146 /** @brief should be given a pointer to pointer, and frees the second one */
 147 void xbt_free_ref(void* d) noexcept(noexcept(::free))
 148 {
 149   xbt_free(*(void**)d);
 150 }
 151
 152 /** @brief Kill the program in silence */
 153 void xbt_abort()
 154 {
 155   /* Call __gcov_flush on abort when compiling with coverage options. */
 156   coverage_checkpoint();
 157 #ifdef _WIN32
 158   /* We said *in silence*. We don't want to see the error message printed by Microsoft's implementation of abort(). */
 159   raise(SIGABRT);
 160   signal(SIGABRT, SIG_DFL);
 161   raise(SIGABRT);
 162 #endif
 163   abort();
 164 }
 165
 166 #ifndef HAVE_SMPI
 167 int SMPI_is_inited()
 168 {
 169   return false;
 170 }
 171 #endif