Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename the plugins from the command line, and document it
[simgrid.git] / src / xbt / xbt_main.cpp
1 /* module handling                                                          */
2
3 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #define XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL /* MSVC don't want it to be declared extern in headers and local here */
9
10 #include "simgrid_config.h"
11 #include "xbt/config.hpp"
12 #include "xbt/dynar.h"
13 #include "xbt/log.h"
14 #include "xbt/log.hpp"
15 #include "xbt/misc.h"
16 #include "xbt/sysdep.h"
17 #include <cmath>
18
19 #include "xbt/module.h"         /* this module */
20
21 #include "src/xbt_modinter.h"       /* prototype of other module's init/exit in XBT */
22
23 #include "simgrid/sg_config.hpp"
24
25 #include "src/internal_config.h"
26 #include <cstdio>
27 #ifdef _WIN32
28 # include <csignal> /* To silence MSVC on abort() */
29 #endif
30 #if HAVE_UNISTD_H
31 # include <unistd.h>
32 #endif
33
34 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(module, xbt, "module handling");
35
36 XBT_LOG_NEW_CATEGORY(smpi, "All SMPI categories"); /* lives here even if that's a bit odd to solve linking issues: this is used in xbt_log_file_appender to detect whether SMPI is used (and thus whether we should unbench the writing to disk) */
37
38 char *xbt_binary_name = NULL;   /* Name of the system process containing us (mandatory to retrieve neat backtraces) */
39 xbt_dynar_t xbt_cmdline = NULL; /* all we got in argv */
40
41 int xbt_initialized = 0;
42 bool _sg_do_clean_atexit = true;
43
44 int xbt_pagesize;
45 int xbt_pagebits = 0;
46
47 /* Declare xbt_preinit and xbt_postexit as constructor/destructor of the library.
48  * This is crude and rather compiler-specific, unfortunately.
49  */
50 static void xbt_preinit() XBT_ATTRIB_CONSTRUCTOR(200);
51 static void xbt_postexit();
52
53 #ifdef _WIN32
54 #include <windows.h>
55
56 #ifndef __GNUC__
57 /* Should not be necessary but for some reason, DllMain is called twice at attachment and at detachment.*/
58 static int xbt_dll_process_is_attached = 0;
59
60 /* see also http://msdn.microsoft.com/en-us/library/ms682583%28VS.85%29.aspx */
61 /* and http://www.microsoft.com/whdc/driver/kernel/DLL_bestprac.mspx */
62 static BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, 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   }
72   return 1;
73 }
74 #endif
75
76 #endif
77
78 static void xbt_preinit()
79 {
80   unsigned int seed = 2147483647;
81 #ifdef _WIN32
82   SYSTEM_INFO si;
83   GetSystemInfo(&si);
84   xbt_pagesize = si.dwPageSize;
85 #elif HAVE_SYSCONF
86   xbt_pagesize = sysconf(_SC_PAGESIZE);
87 #else
88 # error Cannot get page size.
89 #endif
90
91   xbt_pagebits = log2(xbt_pagesize);
92
93 #ifdef _TWO_DIGIT_EXPONENT
94   /* Even printf behaves differently on Windows... */
95   _set_output_format(_TWO_DIGIT_EXPONENT);
96 #endif
97   xbt_log_preinit();
98   xbt_os_thread_mod_preinit();
99   xbt_dict_preinit();
100
101   srand(seed);
102 #ifndef _WIN32
103   srand48(seed);
104 #endif
105   atexit(xbt_postexit);
106 }
107
108 static void xbt_postexit()
109 {
110   if (not _sg_do_clean_atexit)
111     return;
112   xbt_initialized--;
113   xbt_dict_postexit();
114   xbt_os_thread_mod_postexit();
115   xbt_dynar_free(&xbt_cmdline);
116   xbt_log_postexit();
117 #if SIMGRID_HAVE_MC
118   mmalloc_postexit();
119 #endif
120 }
121
122 /** @brief Initialize the xbt mechanisms. */
123 void xbt_init(int *argc, char **argv)
124 {
125   simgrid::xbt::installExceptionHandler();
126
127   xbt_initialized++;
128   if (xbt_initialized > 1) {
129     XBT_DEBUG("XBT has been initialized %d times.", xbt_initialized);
130     return;
131   }
132
133   xbt_binary_name = argv[0];
134   xbt_cmdline     = xbt_dynar_new(sizeof(char*), NULL);
135   for (int i = 0; i < *argc; i++)
136     xbt_dynar_push(xbt_cmdline,&(argv[i]));
137
138   xbt_log_init(argc, argv);
139 }
140
141 /* these two functions belong to xbt/sysdep.h, which have no corresponding .c file */
142 /** @brief like xbt_free, but you can be sure that it is a function  */
143 void xbt_free_f(void *p)
144 {
145   xbt_free(p);
146 }
147
148 /** @brief should be given a pointer to pointer, and frees the second one */
149 void xbt_free_ref(void *d)
150 {
151   xbt_free(*(void**)d);
152 }
153
154 /** @brief Kill the program in silence */
155 void xbt_abort()
156 {
157 #ifdef COVERAGE
158   /* Call __gcov_flush on abort when compiling with coverage options. */
159   extern void __gcov_flush();
160   __gcov_flush();
161 #endif
162 #ifdef _WIN32
163   /* We said *in silence*. We don't want to see the error message printed by Microsoft's implementation of abort(). */
164   raise(SIGABRT);
165   signal(SIGABRT, SIG_DFL);
166   raise(SIGABRT);
167 #endif
168   abort();
169 }