src/xbt/xbt_main.cpp

   1 /* module handling                                                          */
   2
   3 /* Copyright (c) 2006-2019. 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/xbt_modinter.h" /* prototype of other module's init/exit in XBT */
  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
  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 {
  39 namespace 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 xbt
  43 } // namespace simgrid
  44
  45 int xbt_initialized = 0;
  46 simgrid::config::Flag<bool> cfg_dbg_clean_atexit{
  47     "debug/clean-atexit",
  48     {"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 #ifdef _WIN32
  86   SYSTEM_INFO si;
  87   GetSystemInfo(&si);
  88   xbt_pagesize = si.dwPageSize;
  89 #elif HAVE_SYSCONF
  90   xbt_pagesize = sysconf(_SC_PAGESIZE);
  91 #else
  92 # error Cannot get page size.
  93 #endif
  94
  95   xbt_pagebits = log2(xbt_pagesize);
  96
  97 #ifdef _TWO_DIGIT_EXPONENT
  98   /* Even printf behaves differently on Windows... */
  99   _set_output_format(_TWO_DIGIT_EXPONENT);
 100 #endif
 101   xbt_log_preinit();
 102   xbt_dict_preinit();
 103   atexit(xbt_postexit);
 104 }
 105
 106 static void xbt_postexit()
 107 {
 108   if (not cfg_dbg_clean_atexit)
 109     return;
 110   xbt_initialized--;
 111   xbt_dict_postexit();
 112   xbt_log_postexit();
 113 #if SIMGRID_HAVE_MC
 114   mmalloc_postexit();
 115 #endif
 116 }
 117
 118 /** @brief Initialize the xbt mechanisms. */
 119 void xbt_init(int *argc, char **argv)
 120 {
 121   xbt_initialized++;
 122   if (xbt_initialized > 1) {
 123     XBT_DEBUG("XBT has been initialized %d times.", xbt_initialized);
 124     return;
 125   }
 126
 127   simgrid::xbt::install_exception_handler();
 128
 129   simgrid::xbt::binary_name = argv[0];
 130   for (int i = 0; i < *argc; i++)
 131     simgrid::xbt::cmdline.push_back(argv[i]);
 132
 133   xbt_log_init(argc, argv);
 134 }
 135
 136 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
 137 /** @brief like xbt_free, but you can be sure that it is a function  */
 138 void xbt_free_f(void* p) noexcept(noexcept(::free))
 139 {
 140   xbt_free(p);
 141 }
 142
 143 /** @brief should be given a pointer to pointer, and frees the second one */
 144 void xbt_free_ref(void* d) noexcept(noexcept(::free))
 145 {
 146   xbt_free(*(void**)d);
 147 }
 148
 149 /** @brief Kill the program in silence */
 150 void xbt_abort()
 151 {
 152   /* Call __gcov_flush on abort when compiling with coverage options. */
 153   coverage_checkpoint();
 154 #ifdef _WIN32
 155   /* We said *in silence*. We don't want to see the error message printed by Microsoft's implementation of abort(). */
 156   raise(SIGABRT);
 157   signal(SIGABRT, SIG_DFL);
 158   raise(SIGABRT);
 159 #endif
 160   abort();
 161 }