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