Add the possibility for option macros and start using it to indicate
[openssl.git] / e_os2.h
1 /* e_os2.h */
2 /* ====================================================================
3  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55
56 #include <openssl/opensslconf.h>
57
58 #ifndef HEADER_E_OS2_H
59 #define HEADER_E_OS2_H
60
61 #ifdef  __cplusplus
62 extern "C" {
63 #endif
64
65 /******************************************************************************
66  * Detect operating systems.  This probably needs completing.
67  * The result is that at least one OPENSSL_SYS_os macro should be defined.
68  * However, if none is defined, Unix is assumed.
69  **/
70
71 #define OPENSSL_SYS_UNIX
72
73 /* ----------------------- Macintosh, before MacOS X ----------------------- */
74 #if defined(__MWERKS__) && defined(macintosh) || defined(OPENSSL_SYSNAME_MAC)
75 # undef OPENSSL_SYS_UNIX
76 # define OPENSSL_SYS_MACINTOSH_CLASSIC
77 #endif
78
79 /* ---------------------- Microsoft operating systems ---------------------- */
80
81 /* The 16 bit environments are pretty straightforward */
82 #if defined(OPENSSL_SYSNAME_WIN16) || defined(OPENSSL_SYSNAME_MSDOS)
83 # undef OPENSSL_SYS_UNIX
84 # define OPENSSL_SYS_MSDOS
85 #endif
86 #if defined(OPENSSL_SYSNAME_WIN16)
87 # undef OPENSSL_SYS_UNIX
88 # define OPENSSL_SYS_WIN16
89 #endif
90
91 /* For 32 bit environment, there seems to be the CygWin environment and then
92    all the others that try to do the same thing Microsoft does... */
93 #if defined(__CYGWIN32__) || defined(OPENSSL_SYSNAME_CYGWIN32)
94 # undef OPENSSL_SYS_UNIX
95 # define OPENSSL_SYS_WIN32_CYGWIN
96 #else
97 # if defined(_WIN32) || defined(OPENSSL_SYSNAME_WIN32)
98 #  undef OPENSSL_SYS_UNIX
99 #  define OPENSSL_SYS_WIN32
100 # endif
101 # if defined(OPENSSL_SYSNAME_WINNT)
102 #  undef OPENSSL_SYS_UNIX
103 #  define OPENSSL_SYS_WINNT
104 # endif
105 #endif
106
107 /* Anything that tries to look like Microsoft is "Windows" */
108 #if defined(OPENSSL_SYS_WIN16) || defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINNT)
109 # undef OPENSSL_SYS_UNIX
110 # define OPENSSL_SYS_WINDOWS
111 # ifndef OPENSSL_SYS_MSDOS
112 #  define OPENSSL_SYS_MSDOS
113 # endif
114 #endif
115
116 /* DLL settings.  This part is a bit tough, because it's up to the application
117    implementor how he or she will link the application, so it requires some
118    macro to be used. */
119 #ifdef OPENSSL_SYS_WINDOWS
120 # ifndef OPENSSL_OPT_WINDLL
121 #  if defined(_WINDLL) /* This is used when building OpenSSL to indicate that
122                           DLL linkage should be used */
123 #   define OPENSSL_OPT_WINDLL
124 #  elif defined(_DLL) /* This one is used quite much in the VC++ header
125                          files */
126 #   define OPENSSL_OPT_WINDLL
127 #  endif
128 # endif
129 #endif
130
131 /* -------------------------------- OpenVMS -------------------------------- */
132 #if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYSNAME_VMS)
133 # undef OPENSSL_SYS_UNIX
134 # define OPENSSL_SYS_VMS
135 # if defined(__DECC)
136 #  define OPENSSL_SYS_VMS_DECC
137 # else
138 #  define OPENSSL_SYS_VMS_NODECC
139 # endif
140 #endif
141
142 /* --------------------------------- Unix ---------------------------------- */
143 #ifdef OPENSSL_SYS_UNIX
144 # if defined(linus) || defined(OPENSSL_SYSNAME_LINUX)
145 #  define OPENSSL_SYS_LINUX
146 # endif
147 # ifdef OPENSSL_SYSNAME_MPE
148 #  define OPENSSL_SYS_MPE
149 # endif
150 # ifdef OPENSSL_SYSNAME_SNI
151 #  define OPENSSL_SYS_SNI
152 # endif
153 # ifdef OPENSSL_SYSNAME_ULTRASPARC
154 #  define OPENSSL_SYS_ULTRASPARC
155 # endif
156 # ifdef OPENSSL_SYSNAME_NEWS4
157 #  define OPENSSL_SYS_NEWS4
158 # endif
159 # ifdef OPENSSL_SYSNAME_MACOSX
160 #  define OPENSSL_SYS_MACOSX
161 # endif
162 # if defined(_CRAY) || defined(OPENSSL_SYSNAME_CRAY)
163 #  define OPENSSL_SYS_CRAY
164 # endif
165 # if defined(_AIX) || defined(OPENSSL_SYSNAME_AIX)
166 #  define OPENSSL_SYS_AIX
167 # endif
168 #endif
169
170 /**
171  * That's it for OS-specific stuff
172  *****************************************************************************/
173
174
175 /* Specials for I/O an exit */
176 #ifdef OPENSSL_SYS_MSDOS
177 # define OPENSSL_UNISTD_IO <io.h>
178 # define OPENSSL_DECLARE_EXIT extern void exit(int);
179 #else
180 # define OPENSSL_UNISTD_IO OPENSSL_UNISTD
181 # define OPENSSL_DECLARE_EXIT /* declared in unistd.h */
182 #endif
183
184 /* Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare
185    certain global symbols that, with some compilers under VMS, have to be
186    defined and declared explicitely with globaldef and globalref.
187    Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare
188    DLL exports and imports for compilers under Win32.  These are a little
189    more complicated to use.  Basically, for any library that exports some
190    global variables, the following code must be present in the header file
191    that declares them, before OPENSSL_EXTERN is used:
192
193    #ifdef SOME_BUILD_FLAG_MACRO
194    # undef OPENSSL_EXTERN
195    # define OPENSSL_EXTERN OPENSSL_EXPORT
196    #endif
197
198    The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL
199    have some generally sensible values, and for OPENSSL_EXTERN to have the
200    value OPENSSL_IMPORT.
201 */
202
203 #if defined(OPENSSL_SYS_VMS_NODECC)
204 # define OPENSSL_EXPORT globalref
205 # define OPENSSL_IMPORT globalref
206 # define OPENSSL_GLOBAL globaldef
207 #elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
208 # define OPENSSL_EXPORT extern _declspec(dllexport)
209 # define OPENSSL_IMPORT extern _declspec(dllimport)
210 # define OPENSSL_GLOBAL
211 #else
212 # define OPENSSL_EXPORT extern
213 # define OPENSSL_IMPORT extern
214 # define OPENSSL_GLOBAL
215 #endif
216 #define OPENSSL_EXTERN OPENSSL_IMPORT
217
218 /* Macros to allow global variables to be reached through function calls when
219    required (if a shared library version requvres it, for example.
220    The way it's done allows definitions like this:
221
222         // in foobar.c
223         OPENSSL_IMPLEMENT_GLOBAL(int,foobar) = 0;
224         // in foobar.h
225         OPENSSL_DECLARE_GLOBAL(int,foobar);
226         #define foobar OPENSSL_GLOBAL_REF(foobar)
227 */
228 #ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
229 # define OPENSSL_IMPLEMENT_GLOBAL(type,name) extern static type _hide_##name; \
230         type *_shadow_##name(void) { static type local_var; return &local_var; } \
231         static type _hide_##name
232 # define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
233 # define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
234 #else
235 # define OPENSSL_IMPLEMENT_GLOBAL(type,name) OPENSSL_GLOBAL type _shadow_##name
236 # define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
237 # define OPENSSL_GLOBAL_REF(name) _shadow_##name
238 #endif
239
240 #ifdef  __cplusplus
241 }
242 #endif
243 #endif