Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
split SMPI documentation into a specific file (no real change)
[simgrid.git] / include / simgrid_config.h.in
1 /* simgrid_config.h - Results of the configure made visible to user code    */
2
3 /* Copyright (c) 2009-2012. Da 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 #include "xbt/misc.h"           /* XBT_PUBLIC */
9 #include "xbt/dynar.h"          /* sg_commandline */
10
11 #ifndef SIMGRID_PUBLIC_CONFIG_H
12 #define SIMGRID_PUBLIC_CONFIG_H
13 SG_BEGIN_DECL()
14
15
16 /** Define the version numbers of the used header files. 
17     sg_version() can be used to retrieve the version of the dynamic library.
18     But actually, if these numbers don't match, SimGrid refuses to start (so you shouldn't have to care about sg_version() yourself) */
19
20 #define SIMGRID_VERSION_MAJOR @SIMGRID_VERSION_MAJOR@
21 #define SIMGRID_VERSION_MINOR @SIMGRID_VERSION_MINOR@
22 #define SIMGRID_VERSION_PATCH @SIMGRID_VERSION_PATCH@
23
24 /* Version X.Y.Z will get version number XYZ: all digits concatenated without dots
25  * (with Y and Z must be on two positions)*/
26
27 #define MAKE_SIMGRID_VERSION(major, minor, patch)       \
28   (100UL * (100UL * (major) + (minor)) + (patch))
29 #define SIMGRID_VERSION MAKE_SIMGRID_VERSION(SIMGRID_VERSION_MAJOR, \
30                                              SIMGRID_VERSION_MINOR, \
31                                              SIMGRID_VERSION_PATCH)
32
33 /** Retrieves the version numbers of the used dynamic library (so, DLL or dynlib) , while
34     SIMGRID_VERSION_MAJOR and friends give the version numbers of the used header files */
35 XBT_PUBLIC(void) sg_version(int *major,int *minor,int *patch);
36
37 /** Contains all the parameters we got from the command line */
38 XBT_PUBLIC_DATA(xbt_dynar_t) sg_cmdline;
39
40 /* take care of DLL usage madness */
41
42 #ifdef _XBT_DLL_EXPORT
43         #ifndef DLL_EXPORT
44                 #define DLL_EXPORT
45         #endif
46 #else
47         #ifdef _XBT_DLL_STATIC
48                 #ifndef DLL_STATIC
49                         #define DLL_STATIC
50                 #endif
51         #else
52                 #ifndef DLL_EXPORT
53                         #define DLL_IMPORT
54                 #endif
55         #endif
56 #endif
57
58 #cmakedefine _XBT_WIN32 @_XBT_WIN32@    /*this variable is set if it is a windows platform*/
59 #cmakedefine _WIN32 @_WIN32@                    /*this variable is set if it is a 32 bits windows platform*/
60 #cmakedefine _WIN64 @_WIN64@                    /*this variable is set if it is a 64 bits  windows platform*/
61 #cmakedefine __VISUALC__ @__VISUALC__@
62 #cmakedefine __BORLANDC__ @__BORLANDC__@
63 #ifdef _XBT_WIN32
64         #ifndef __GNUC__
65                 #cmakedefine __GNUC__ @__GNUC__@
66         #endif
67 #endif
68
69
70 /* Define to 1 if you have the `mmap' function. */
71 #cmakedefine HAVE_MMAP @HAVE_MMAP@
72
73 /* Get the config */
74 #undef SIMGRID_NEED_ASPRINTF
75 #undef SIMGRID_NEED_VASPRINTF
76 @simgrid_need_asprintf@
77 @simgrid_need_vasprintf@
78
79 #include <stdarg.h>
80
81 /* snprintf related functions */
82 /** @addtogroup XBT_str
83   * @{ */
84 /** @brief print to allocated string (reimplemented when not provided by the system)
85  *
86  * The functions asprintf() and vasprintf() are analogues of
87  * sprintf() and vsprintf(), except that they allocate a string large
88  * enough to hold the output including the terminating null byte, and
89  * return a pointer to it via the first parameter.  This pointer
90  * should be passed to free(3) to release the allocated storage when
91  * it is no longer needed.
92  */
93 #if defined(SIMGRID_NEED_ASPRINTF)||defined(DOXYGEN)
94 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
95                          ...) _XBT_GNUC_PRINTF(2, 3);
96 #endif
97 /** @brief print to allocated string (reimplemented when not provided by the system)
98  *
99  * See asprintf()
100  */
101 #if defined(SIMGRID_NEED_VASPRINTF)||defined(DOXYGEN)
102 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
103 #endif
104 /** @brief print to allocated string
105  *
106  * Works just like vasprintf(), but returns a pointer to the newly
107  * created string, or aborts on error.
108  */
109 XBT_PUBLIC(char *) bvprintf(const char *fmt, va_list ap);
110 /** @brief print to allocated string
111  *
112  * Works just like asprintf(), but returns a pointer to the newly
113  * created string, or aborts on error.
114  */
115 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
116 /** @} */
117
118 /* Whether mallocators were enabled in ccmake or not. */
119 #define MALLOCATOR_COMPILED_IN @MALLOCATOR_IS_WANTED@
120
121 /* Define if xbt contexts are based on our threads implementation or not */
122 #cmakedefine CONTEXT_THREADS @CONTEXT_THREADS@
123
124 /* Tracing SimGrid */
125 #cmakedefine HAVE_TRACING @HAVE_TRACING@
126
127 /* Jedule output  */
128 #cmakedefine HAVE_JEDULE @HAVE_JEDULE@
129
130 /* Tracking of latency bound */
131 #cmakedefine HAVE_LATENCY_BOUND_TRACKING @HAVE_LATENCY_BOUND_TRACKING@
132
133 /* If __thread is available */
134 #cmakedefine HAVE_THREAD_LOCAL_STORAGE @HAVE_THREAD_LOCAL_STORAGE@
135
136 /* If Model-Checking support was requested */
137 #cmakedefine HAVE_MC @HAVE_MC@
138
139 SG_END_DECL()
140 #endif /* SIMGRID_PUBLIC_CONFIG_H */