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_DEFAULT_SUBCATEGORY(module, xbt, "module handling");
  24
  25 char *xbt_binary_name = NULL;   /* Mandatory to retrieve neat backtraces */
  26 int xbt_initialized = 0;
  27
  28 XBT_LOG_EXTERNAL_CATEGORY(graphxml_parse);
  29 XBT_LOG_EXTERNAL_CATEGORY(log);
  30 XBT_LOG_EXTERNAL_CATEGORY(module);
  31 XBT_LOG_EXTERNAL_CATEGORY(peer);
  32 XBT_LOG_EXTERNAL_CATEGORY(strbuff);
  33 XBT_LOG_EXTERNAL_CATEGORY(xbt_cfg);
  34 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
  35 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict_cursor);
  36 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict_elm);
  37 #ifdef XBT_USE_DEPRECATED
  38 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict_multi);
  39 #endif
  40 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
  41 XBT_LOG_EXTERNAL_CATEGORY(xbt_ex);
  42 XBT_LOG_EXTERNAL_CATEGORY(xbt_fifo);
  43 XBT_LOG_EXTERNAL_CATEGORY(xbt_graph);
  44 XBT_LOG_EXTERNAL_CATEGORY(xbt_matrix);
  45 XBT_LOG_EXTERNAL_CATEGORY(xbt_queue);
  46 XBT_LOG_EXTERNAL_CATEGORY(xbt_set);
  47 XBT_LOG_EXTERNAL_CATEGORY(xbt_sync_os);
  48 XBT_LOG_EXTERNAL_CATEGORY(xbt_parmap);
  49 XBT_LOG_EXTERNAL_CATEGORY(xbt_parmap_unit);
  50 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt);
  51 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt_cbps);
  52 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt_convert);
  53 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt_create);
  54 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt_exchange);
  55 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt_lexer);
  56 XBT_LOG_EXTERNAL_CATEGORY(xbt_ddt_parse);
  57 XBT_LOG_EXTERNAL_CATEGORY(xbt_trp);
  58 XBT_LOG_EXTERNAL_CATEGORY(xbt_trp_meas);
  59
  60 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) */
  61
  62 /* Declare xbt_preinit and xbt_postexit as constructor/destructor of the library.
  63  * This is crude and rather compiler-specific, unfortunately.
  64  */
  65 static void xbt_preinit(void) _XBT_GNUC_CONSTRUCTOR;
  66 static void xbt_postexit(void) _XBT_GNUC_DESTRUCTOR;
  67
  68 #ifdef _XBT_WIN32
  69 # undef _XBT_NEED_INIT_PRAGMA
  70 #endif
  71
  72 #ifdef _XBT_NEED_INIT_PRAGMA
  73 #pragma init (xbt_preinit)
  74 #pragma fini (xbt_postexit)
  75 #endif
  76
  77 #ifdef _XBT_WIN32
  78 #include <windows.h>
  79
  80 #ifndef __GNUC__
  81 /* Dummy prototype to make gcc happy */
  82 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  83                     LPVOID lpvReserved);
  84
  85 /* Should not be necessary but for some reason,
  86  * DllMain is called twice at attachment and
  87  * at detachment.*/
  88 static int xbt_dll_process_is_attached = 0;
  89
  90 /* see also http://msdn.microsoft.com/en-us/library/ms682583%28VS.85%29.aspx */
  91 /* and http://www.microsoft.com/whdc/driver/kernel/DLL_bestprac.mspx */
  92 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason,
  93                     LPVOID lpvReserved)
  94 {
  95   if (fdwReason == DLL_PROCESS_ATTACH
  96                   && xbt_dll_process_is_attached == 0) {
  97           xbt_dll_process_is_attached = 1;
  98           xbt_preinit();
  99   } else if (fdwReason == DLL_PROCESS_DETACH
 100                   && xbt_dll_process_is_attached == 1) {
 101           xbt_dll_process_is_attached = 0;
 102       xbt_postexit();
 103   }
 104   return 1;
 105 }
 106 #endif
 107
 108 #endif
 109
 110 static void xbt_preinit(void)
 111 {
 112 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
 113   mmalloc_preinit();
 114 #endif
 115   xbt_log_preinit();
 116
 117   /* Connect our log channels: that must be done manually under windows */
 118   XBT_LOG_CONNECT(graphxml_parse, xbt);
 119   XBT_LOG_CONNECT(log, xbt);
 120   XBT_LOG_CONNECT(module, xbt);
 121   XBT_LOG_CONNECT(peer, xbt);
 122   XBT_LOG_CONNECT(strbuff, xbt);
 123   XBT_LOG_CONNECT(xbt_cfg, xbt);
 124   XBT_LOG_CONNECT(xbt_dict, xbt);
 125   XBT_LOG_CONNECT(xbt_dict_cursor, xbt_dict);
 126   XBT_LOG_CONNECT(xbt_dict_elm, xbt_dict);
 127 #ifdef XBT_USE_DEPRECATED
 128   XBT_LOG_CONNECT(xbt_dict_multi, xbt_dict);
 129 #endif
 130   XBT_LOG_CONNECT(xbt_dyn, xbt);
 131   XBT_LOG_CONNECT(xbt_ex, xbt);
 132   XBT_LOG_CONNECT(xbt_fifo, xbt);
 133   XBT_LOG_CONNECT(xbt_graph, xbt);
 134   XBT_LOG_CONNECT(xbt_matrix, xbt);
 135   XBT_LOG_CONNECT(xbt_queue, xbt);
 136   XBT_LOG_CONNECT(xbt_set, xbt);
 137   XBT_LOG_CONNECT(xbt_sync_os, xbt);
 138   XBT_LOG_CONNECT(xbt_parmap,xbt);
 139   XBT_LOG_CONNECT(xbt_parmap_unit,xbt_parmap);
 140   XBT_LOG_CONNECT(xbt_ddt, xbt);
 141   XBT_LOG_CONNECT(xbt_ddt_cbps, xbt_ddt);
 142   XBT_LOG_CONNECT(xbt_ddt_convert, xbt_ddt);
 143   XBT_LOG_CONNECT(xbt_ddt_create, xbt_ddt);
 144   XBT_LOG_CONNECT(xbt_ddt_exchange, xbt_ddt);
 145   XBT_LOG_CONNECT(xbt_ddt_lexer, xbt_ddt_parse);
 146   XBT_LOG_CONNECT(xbt_ddt_parse, xbt_ddt);
 147   XBT_LOG_CONNECT(xbt_trp, xbt);
 148   XBT_LOG_CONNECT(xbt_trp_meas, xbt_trp);
 149
 150   xbt_backtrace_preinit();
 151   xbt_os_thread_mod_preinit();
 152   xbt_fifo_preinit();
 153   xbt_dict_preinit();
 154   xbt_datadesc_preinit();
 155   xbt_trp_preinit();
 156 }
 157
 158 static void xbt_postexit(void)
 159 {
 160   xbt_trp_postexit();
 161   xbt_datadesc_postexit();
 162
 163   xbt_backtrace_postexit();
 164
 165   xbt_fifo_postexit();
 166   xbt_dict_postexit();
 167
 168   xbt_log_postexit();
 169   xbt_os_thread_mod_postexit();
 170
 171   free(xbt_binary_name);
 172 #ifdef MMALLOC_WANT_OVERRIDE_LEGACY
 173   mmalloc_postexit();
 174 #endif
 175 }
 176
 177 /** @brief Initialize the xbt mechanisms. */
 178 void xbt_init(int *argc, char **argv)
 179 {
 180   // FIXME it would be nice to assert that this function is called only once. But each gras process do call it...
 181   xbt_initialized++;
 182
 183   if (xbt_initialized > 1)
 184     return;
 185
 186   xbt_binary_name = xbt_strdup(argv[0]);
 187   srand((unsigned int) time(NULL));
 188
 189   xbt_log_init(argc, argv);
 190 }
 191
 192 /** @brief Finalize the xbt mechanisms. */
 193 void xbt_exit()
 194 {
 195   XBT_WARN("This function is deprecated, you shouldn't use it");
 196 }
 197
 198
 199 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
 200 /** @brief like free, but you can be sure that it is a function  */
 201 XBT_PUBLIC(void) xbt_free_f(void *p)
 202 {
 203   free(p);
 204 }
 205
 206 /** @brief should be given a pointer to pointer, and frees the second one */
 207 XBT_PUBLIC(void) xbt_free_ref(void *d)
 208 {
 209   free(*(void **) d);
 210 }