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