src/xbt/xbt_main.c

   1 /* module handling                                                          */
   2
   3 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. 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"     /*HAVE_MMAP _XBT_WIN32 */
  11 #include "gras_config.h"        /* MMALLOC_WANT_OVERRIDE_LEGACY */
  12 #include "time.h"               /* to seed the random generator */
  13
  14 #include "xbt/sysdep.h"
  15 #include "xbt/log.h"
  16 #include "xbt/dynar.h"
  17 #include "xbt/config.h"
  18
  19 #include "xbt/module.h"         /* this module */
  20
  21 #include "xbt_modinter.h"       /* prototype of other module's init/exit in XBT */
  22
  23 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(module, xbt, "module handling");
  25
  26 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) */
  27
  28
  29 char *xbt_binary_name = NULL;   /* Mandatory to retrieve neat backtraces */
  30 int xbt_initialized = 0;
  31
  32 int _surf_do_model_check = 0;
  33 int _surf_mc_checkpoint=0;
  34 char* _surf_mc_property_file=NULL;
  35 int _surf_mc_timeout=0;
  36 int _surf_mc_max_depth=1000;
  37
  38 /* Declare xbt_preinit and xbt_postexit as constructor/destructor of the library.
  39  * This is crude and rather compiler-specific, unfortunately.
  40  */
  41 static void xbt_preinit(void) _XBT_GNUC_CONSTRUCTOR(200);
  42 static void xbt_postexit(void);
  43
  44 #ifdef _XBT_WIN32
  45 # undef _XBT_NEED_INIT_PRAGMA
  46 #endif
  47
  48 #ifdef _XBT_NEED_INIT_PRAGMA
  49 #pragma init (xbt_preinit)
  50 #endif
  51
  52 #ifdef _XBT_WIN32
  53 #include <windows.h>
  54
  55 #ifndef __GNUC__
  56 /* Dummy prototype to make gcc happy */
  57 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  58                     LPVOID lpvReserved);
  59
  60 /* Should not be necessary but for some reason,
  61  * DllMain is called twice at attachment and
  62  * at detachment.*/
  63 static int xbt_dll_process_is_attached = 0;
  64
  65 /* see also http://msdn.microsoft.com/en-us/library/ms682583%28VS.85%29.aspx */
  66 /* and http://www.microsoft.com/whdc/driver/kernel/DLL_bestprac.mspx */
  67 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  68                     LPVOID lpvReserved)
  69 {
  70   if (fdwReason == DLL_PROCESS_ATTACH
  71       && xbt_dll_process_is_attached == 0) {
  72     xbt_dll_process_is_attached = 1;
  73     xbt_preinit();
  74   } else if (fdwReason == DLL_PROCESS_DETACH
  75       && xbt_dll_process_is_attached == 1) {
  76     xbt_dll_process_is_attached = 0;
  77   }
  78   return 1;
  79 }
  80 #endif
  81
  82 #endif
  83
  84 static void xbt_preinit(void)
  85 {
  86 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
  87   mmalloc_preinit();
  88 #endif
  89   xbt_log_preinit();
  90
  91   xbt_backtrace_preinit();
  92   xbt_os_thread_mod_preinit();
  93   xbt_fifo_preinit();
  94   xbt_dict_preinit();
  95   xbt_datadesc_preinit();
  96   xbt_trp_preinit();
  97
  98   atexit(xbt_postexit);
  99 }
 100
 101 static void xbt_postexit(void)
 102 {
 103   xbt_trp_postexit();
 104   xbt_datadesc_postexit();
 105
 106   xbt_backtrace_postexit();
 107
 108   xbt_fifo_postexit();
 109   xbt_dict_postexit();
 110
 111   xbt_log_postexit();
 112   xbt_os_thread_mod_postexit();
 113
 114   free(xbt_binary_name);
 115 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
 116   mmalloc_postexit();
 117 #endif
 118 }
 119
 120 /** @brief Initialize the xbt mechanisms. */
 121 void xbt_init(int *argc, char **argv)
 122 {
 123   // FIXME it would be nice to assert that this function is called only once. But each gras process do call it...
 124   xbt_initialized++;
 125
 126   if (xbt_initialized > 1)
 127     return;
 128
 129   xbt_binary_name = xbt_strdup(argv[0]);
 130   srand((unsigned int) time(NULL));
 131
 132   xbt_log_init(argc, argv);
 133 }
 134
 135 /** @brief Finalize the xbt mechanisms. */
 136 void xbt_exit()
 137 {
 138   XBT_WARN("This function is deprecated, you shouldn't use it");
 139 }
 140
 141
 142 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
 143 /** @brief like free, but you can be sure that it is a function  */
 144 XBT_PUBLIC(void) xbt_free_f(void *p)
 145 {
 146   free(p);
 147 }
 148
 149 /** @brief should be given a pointer to pointer, and frees the second one */
 150 XBT_PUBLIC(void) xbt_free_ref(void *d)
 151 {
 152   free(*(void **) d);
 153 }