src/xbt/xbt_main.c

   1 /* module handling                                                          */
   2
   3 /* Copyright (c) 2006-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "xbt/misc.h"
  10 #include "simgrid_config.h"     /* _XBT_WIN32 */
  11 #include "internal_config.h"    /* MMALLOC_WANT_OVERRIDE_LEGACY */
  12 #include "portable.h"
  13 #include "xbt/sysdep.h"
  14 #include "xbt/log.h"
  15 #include "xbt/dynar.h"
  16 #include "xbt/config.h"
  17
  18 #include "xbt/module.h"         /* this module */
  19
  20 #include "xbt_modinter.h"       /* prototype of other module's init/exit in XBT */
  21
  22 #include "simgrid/sg_config.h"
  23
  24 #include <stdio.h>
  25 #ifdef _XBT_WIN32
  26 #include <signal.h>
  27 #endif
  28
  29 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
  30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(module, xbt, "module handling");
  31
  32 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) */
  33
  34
  35 char *xbt_binary_name = NULL;   /* Name of the system process containing us (mandatory to retrieve neat backtraces) */
  36 xbt_dynar_t xbt_cmdline = NULL; /* all we got in argv */
  37
  38 int xbt_initialized = 0;
  39 int _sg_do_clean_atexit = 1;
  40
  41 int xbt_pagesize;
  42 int xbt_pagebits = 0;
  43
  44 /* Declare xbt_preinit and xbt_postexit as constructor/destructor of the library.
  45  * This is crude and rather compiler-specific, unfortunately.
  46  */
  47 static void xbt_preinit(void) _XBT_GNUC_CONSTRUCTOR(200);
  48 static void xbt_postexit(void);
  49
  50 #ifdef _XBT_WIN32
  51 # undef _XBT_NEED_INIT_PRAGMA
  52 #endif
  53
  54 #ifdef _XBT_NEED_INIT_PRAGMA
  55 #pragma init (xbt_preinit)
  56 #endif
  57
  58 #ifdef _XBT_WIN32
  59 #include <windows.h>
  60
  61 #ifndef __GNUC__
  62 /* Dummy prototype to make gcc happy */
  63 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  64                     LPVOID lpvReserved);
  65
  66 /* Should not be necessary but for some reason,
  67  * DllMain is called twice at attachment and
  68  * at detachment.*/
  69 static int xbt_dll_process_is_attached = 0;
  70
  71 /* see also http://msdn.microsoft.com/en-us/library/ms682583%28VS.85%29.aspx */
  72 /* and http://www.microsoft.com/whdc/driver/kernel/DLL_bestprac.mspx */
  73 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  74                     LPVOID lpvReserved)
  75 {
  76   if (fdwReason == DLL_PROCESS_ATTACH
  77       && xbt_dll_process_is_attached == 0) {
  78     xbt_dll_process_is_attached = 1;
  79     xbt_preinit();
  80   } else if (fdwReason == DLL_PROCESS_DETACH
  81       && xbt_dll_process_is_attached == 1) {
  82     xbt_dll_process_is_attached = 0;
  83   }
  84   return 1;
  85 }
  86 #endif
  87
  88 #endif
  89
  90 static void xbt_preinit(void) {
  91   unsigned int seed = 2147483647;
  92 #ifndef WIN32
  93   xbt_pagesize = sysconf(_SC_PAGESIZE);
  94 #else
  95   SYSTEM_INFO si;
  96   GetSystemInfo(&si);
  97   xbt_pagesize = si.dwPageSize;
  98 #endif
  99
 100   xbt_pagebits = 0;
 101   int x = xbt_pagesize;
 102   while(x >>= 1) {
 103     ++xbt_pagebits;
 104   }
 105
 106 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
 107   mmalloc_preinit();
 108 #endif
 109 #ifdef _TWO_DIGIT_EXPONENT
 110   /* Even printf behaves differently on Windows... */
 111   _set_output_format(_TWO_DIGIT_EXPONENT);
 112 #endif
 113   xbt_log_preinit();
 114   xbt_backtrace_preinit();
 115   xbt_os_thread_mod_preinit();
 116   xbt_fifo_preinit();
 117   xbt_dict_preinit();
 118
 119   srand(seed);
 120 #ifndef _WIN32
 121   srand48(seed);
 122 #endif
 123   atexit(xbt_postexit);
 124 }
 125
 126 static void xbt_postexit(void)
 127 {
 128   if(!_sg_do_clean_atexit) return;
 129   xbt_backtrace_postexit();
 130   xbt_fifo_postexit();
 131   xbt_dict_postexit();
 132   xbt_os_thread_mod_postexit();
 133   xbt_dynar_free(&xbt_cmdline);
 134   xbt_log_postexit();
 135   free(xbt_binary_name);
 136 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
 137   mmalloc_postexit();
 138 #endif
 139 }
 140
 141 /** @brief Initialize the xbt mechanisms. */
 142 void xbt_init(int *argc, char **argv)
 143 {
 144   if (xbt_initialized++) {
 145     XBT_DEBUG("XBT was initialized %d times.", xbt_initialized);
 146     return;
 147   }
 148
 149   xbt_binary_name = xbt_strdup(argv[0]);
 150   xbt_cmdline = xbt_dynar_new(sizeof(char*),NULL);
 151   int i;
 152   for (i=0;i<*argc;i++) {
 153     xbt_dynar_push(xbt_cmdline,&(argv[i]));
 154   }
 155
 156   xbt_log_init(argc, argv);
 157 }
 158
 159 /** @brief Finalize the xbt mechanisms.
 160  *  @warning this function is deprecated. Just don't call it, there is nothing more to do to finalize xbt*/
 161 void xbt_exit()
 162 {
 163   XBT_WARN("This function is deprecated, you shouldn't use it");
 164 }
 165
 166
 167 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
 168 /** @brief like free, but you can be sure that it is a function  */
 169 void xbt_free_f(void *p)
 170 {
 171   free(p);
 172 }
 173
 174 /** @brief should be given a pointer to pointer, and frees the second one */
 175 void xbt_free_ref(void *d)
 176 {
 177   free(*(void **) d);
 178 }
 179
 180 /** @brief Kill the program in silence */
 181 void xbt_abort(void)
 182 {
 183 #ifdef COVERAGE
 184   /* Call __gcov_flush on abort when compiling with coverage options. */
 185   extern void __gcov_flush(void);
 186   __gcov_flush();
 187 #endif
 188 #ifdef _XBT_WIN32
 189   /* It was said *in silence*.  We don't want to see the error message printed
 190    * by the Microsoft's implementation of abort(). */
 191   raise(SIGABRT);
 192   signal(SIGABRT, SIG_DFL);
 193   raise(SIGABRT);
 194 #endif
 195   abort();
 196 }