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