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 "internal_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 int _surf_mc_visited=0;
  38
  39 /* Declare xbt_preinit and xbt_postexit as constructor/destructor of the library.
  40  * This is crude and rather compiler-specific, unfortunately.
  41  */
  42 static void xbt_preinit(void) _XBT_GNUC_CONSTRUCTOR(200);
  43 static void xbt_postexit(void);
  44
  45 #ifdef _XBT_WIN32
  46 # undef _XBT_NEED_INIT_PRAGMA
  47 #endif
  48
  49 #ifdef _XBT_NEED_INIT_PRAGMA
  50 #pragma init (xbt_preinit)
  51 #endif
  52
  53 #ifdef _XBT_WIN32
  54 #include <windows.h>
  55
  56 #ifndef __GNUC__
  57 /* Dummy prototype to make gcc happy */
  58 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  59                     LPVOID lpvReserved);
  60
  61 /* Should not be necessary but for some reason,
  62  * DllMain is called twice at attachment and
  63  * at detachment.*/
  64 static int xbt_dll_process_is_attached = 0;
  65
  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 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  69                     LPVOID lpvReserved)
  70 {
  71   if (fdwReason == DLL_PROCESS_ATTACH
  72       && xbt_dll_process_is_attached == 0) {
  73     xbt_dll_process_is_attached = 1;
  74     xbt_preinit();
  75   } else if (fdwReason == DLL_PROCESS_DETACH
  76       && xbt_dll_process_is_attached == 1) {
  77     xbt_dll_process_is_attached = 0;
  78   }
  79   return 1;
  80 }
  81 #endif
  82
  83 #endif
  84
  85 static void xbt_preinit(void)
  86 {
  87 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
  88   mmalloc_preinit();
  89 #endif
  90   xbt_log_preinit();
  91
  92   xbt_backtrace_preinit();
  93   xbt_os_thread_mod_preinit();
  94   xbt_fifo_preinit();
  95   xbt_dict_preinit();
  96
  97   atexit(xbt_postexit);
  98 }
  99
 100 static void xbt_postexit(void)
 101 {
 102   xbt_backtrace_postexit();
 103
 104   xbt_fifo_postexit();
 105   xbt_dict_postexit();
 106
 107   xbt_log_postexit();
 108   xbt_os_thread_mod_postexit();
 109
 110   free(xbt_binary_name);
 111 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
 112   mmalloc_postexit();
 113 #endif
 114 }
 115
 116 /** @brief Initialize the xbt mechanisms. */
 117 void xbt_init(int *argc, char **argv)
 118 {
 119   // FIXME it would be nice to assert that this function is called only once. But each gras process do call it...
 120   xbt_initialized++;
 121
 122   if (xbt_initialized > 1)
 123     return;
 124
 125   xbt_binary_name = xbt_strdup(argv[0]);
 126   srand((unsigned int) time(NULL));
 127
 128   xbt_log_init(argc, argv);
 129 }
 130
 131 /** @brief Finalize the xbt mechanisms.
 132  *  @warning this function is deprecated. Just don't call it, there is nothing more to do to finalize xbt*/
 133 void xbt_exit()
 134 {
 135   XBT_WARN("This function is deprecated, you shouldn't use it");
 136 }
 137
 138
 139 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
 140 /** @brief like free, but you can be sure that it is a function  */
 141 XBT_PUBLIC(void) xbt_free_f(void *p)
 142 {
 143   free(p);
 144 }
 145
 146 /** @brief should be given a pointer to pointer, and frees the second one */
 147 XBT_PUBLIC(void) xbt_free_ref(void *d)
 148 {
 149   free(*(void **) d);
 150 }