Logo AND Algorithmique Numérique Distribuée

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