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