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