Nils Larsch reported that this include is required. Strange that this had
[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 /* ----------------------- NetWare ----------------------------------------- */
80 #if defined(NETWARE) || defined(OPENSSL_SYSNAME_NETWARE)
81 # undef OPENSSL_SYS_UNIX
82 # define OPENSSL_SYS_NETWARE
83 #endif
84
85 /* ---------------------- Microsoft operating systems ---------------------- */
86
87 /* The 16 bit environments are pretty straightforward */
88 #if defined(OPENSSL_SYSNAME_WIN16) || defined(OPENSSL_SYSNAME_MSDOS)
89 # undef OPENSSL_SYS_UNIX
90 # define OPENSSL_SYS_MSDOS
91 #endif
92 #if defined(OPENSSL_SYSNAME_WIN16)
93 # undef OPENSSL_SYS_UNIX
94 # define OPENSSL_SYS_WIN16
95 #endif
96
97 /* For 32 bit environment, there seems to be the CygWin environment and then
98    all the others that try to do the same thing Microsoft does... */
99 #if defined(OPENSSL_SYSNAME_UWIN)
100 # undef OPENSSL_SYS_UNIX
101 # define OPENSSL_SYS_WIN32_UWIN
102 #else
103 # if defined(__CYGWIN32__) || defined(OPENSSL_SYSNAME_CYGWIN32)
104 #  undef OPENSSL_SYS_UNIX
105 #  define OPENSSL_SYS_WIN32_CYGWIN
106 # else
107 #  if defined(_WIN32) || defined(OPENSSL_SYSNAME_WIN32)
108 #   undef OPENSSL_SYS_UNIX
109 #   define OPENSSL_SYS_WIN32
110 #  endif
111 #  if defined(OPENSSL_SYSNAME_WINNT)
112 #   undef OPENSSL_SYS_UNIX
113 #   define OPENSSL_SYS_WINNT
114 #  endif
115 #  if defined(OPENSSL_SYSNAME_WINCE)
116 #   undef OPENSSL_SYS_UNIX
117 #   define OPENSSL_SYS_WINCE
118 #  endif
119 # endif
120 #endif
121
122 /* Anything that tries to look like Microsoft is "Windows" */
123 #if defined(OPENSSL_SYS_WIN16) || defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINNT) || defined(OPENSSL_SYS_WINCE)
124 # undef OPENSSL_SYS_UNIX
125 # define OPENSSL_SYS_WINDOWS
126 # ifndef OPENSSL_SYS_MSDOS
127 #  define OPENSSL_SYS_MSDOS
128 # endif
129 #endif
130
131 /* DLL settings.  This part is a bit tough, because it's up to the application
132    implementor how he or she will link the application, so it requires some
133    macro to be used. */
134 #ifdef OPENSSL_SYS_WINDOWS
135 # ifndef OPENSSL_OPT_WINDLL
136 #  if defined(_WINDLL) /* This is used when building OpenSSL to indicate that
137                           DLL linkage should be used */
138 #   define OPENSSL_OPT_WINDLL
139 #  endif
140 # endif
141 #endif
142
143 /* -------------------------------- OpenVMS -------------------------------- */
144 #if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYSNAME_VMS)
145 # undef OPENSSL_SYS_UNIX
146 # define OPENSSL_SYS_VMS
147 # if defined(__DECC)
148 #  define OPENSSL_SYS_VMS_DECC
149 # elif defined(__DECCXX)
150 #  define OPENSSL_SYS_VMS_DECC
151 #  define OPENSSL_SYS_VMS_DECCXX
152 # else
153 #  define OPENSSL_SYS_VMS_NODECC
154 # endif
155 #endif
156
157 /* --------------------------------- OS/2 ---------------------------------- */
158 #if defined(__EMX__) || defined(__OS2__)
159 # undef OPENSSL_SYS_UNIX
160 # define OPENSSL_SYS_OS2
161 #endif
162
163 /* --------------------------------- Unix ---------------------------------- */
164 #ifdef OPENSSL_SYS_UNIX
165 # if defined(linux) || defined(__linux__) || defined(OPENSSL_SYSNAME_LINUX)
166 #  define OPENSSL_SYS_LINUX
167 # endif
168 # ifdef OPENSSL_SYSNAME_MPE
169 #  define OPENSSL_SYS_MPE
170 # endif
171 # ifdef OPENSSL_SYSNAME_SNI
172 #  define OPENSSL_SYS_SNI
173 # endif
174 # ifdef OPENSSL_SYSNAME_ULTRASPARC
175 #  define OPENSSL_SYS_ULTRASPARC
176 # endif
177 # ifdef OPENSSL_SYSNAME_NEWS4
178 #  define OPENSSL_SYS_NEWS4
179 # endif
180 # ifdef OPENSSL_SYSNAME_MACOSX
181 #  define OPENSSL_SYS_MACOSX
182 # endif
183 # ifdef OPENSSL_SYSNAME_MACOSX_RHAPSODY
184 #  define OPENSSL_SYS_MACOSX_RHAPSODY
185 #  define OPENSSL_SYS_MACOSX
186 # endif
187 # ifdef OPENSSL_SYSNAME_SUNOS
188 #  define OPENSSL_SYS_SUNOS
189 #endif
190 # if defined(_CRAY) || defined(OPENSSL_SYSNAME_CRAY)
191 #  define OPENSSL_SYS_CRAY
192 # endif
193 # if defined(_AIX) || defined(OPENSSL_SYSNAME_AIX)
194 #  define OPENSSL_SYS_AIX
195 # endif
196 #endif
197
198 /* --------------------------------- VOS ----------------------------------- */
199 #ifdef OPENSSL_SYSNAME_VOS
200 # define OPENSSL_SYS_VOS
201 #endif
202
203 /* ------------------------------- VxWorks --------------------------------- */
204 #ifdef OPENSSL_SYSNAME_VXWORKS
205 # define OPENSSL_SYS_VXWORKS
206 #endif
207
208 /**
209  * That's it for OS-specific stuff
210  *****************************************************************************/
211
212
213 /* Specials for I/O an exit */
214 #ifdef OPENSSL_SYS_WIN16
215 # define OPENSSL_NO_FP_API
216 #endif
217 #ifdef OPENSSL_SYS_MSDOS
218 # define OPENSSL_UNISTD_IO <io.h>
219 # define OPENSSL_DECLARE_EXIT extern void exit(int);
220 #else
221 # define OPENSSL_UNISTD_IO OPENSSL_UNISTD
222 # define OPENSSL_DECLARE_EXIT /* declared in unistd.h */
223 #endif
224
225 /* Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare
226    certain global symbols that, with some compilers under VMS, have to be
227    defined and declared explicitely with globaldef and globalref.
228    Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare
229    DLL exports and imports for compilers under Win32.  These are a little
230    more complicated to use.  Basically, for any library that exports some
231    global variables, the following code must be present in the header file
232    that declares them, before OPENSSL_EXTERN is used:
233
234    #ifdef SOME_BUILD_FLAG_MACRO
235    # undef OPENSSL_EXTERN
236    # define OPENSSL_EXTERN OPENSSL_EXPORT
237    #endif
238
239    The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL
240    have some generally sensible values, and for OPENSSL_EXTERN to have the
241    value OPENSSL_IMPORT.
242 */
243
244 #if defined(OPENSSL_SYS_VMS_NODECC)
245 # define OPENSSL_EXPORT globalref
246 # define OPENSSL_IMPORT globalref
247 # define OPENSSL_GLOBAL globaldef
248 #elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
249 # define OPENSSL_EXPORT extern _declspec(dllexport)
250 # define OPENSSL_IMPORT extern _declspec(dllimport)
251 # define OPENSSL_GLOBAL
252 #else
253 # define OPENSSL_EXPORT extern
254 # define OPENSSL_IMPORT extern
255 # define OPENSSL_GLOBAL
256 #endif
257 #define OPENSSL_EXTERN OPENSSL_IMPORT
258
259 /* Macros to allow global variables to be reached through function calls when
260    required (if a shared library version requvres it, for example.
261    The way it's done allows definitions like this:
262
263         // in foobar.c
264         OPENSSL_IMPLEMENT_GLOBAL(int,foobar) = 0;
265         // in foobar.h
266         OPENSSL_DECLARE_GLOBAL(int,foobar);
267         #define foobar OPENSSL_GLOBAL_REF(foobar)
268 */
269 #ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
270 # define OPENSSL_IMPLEMENT_GLOBAL(type,name)                         \
271         extern static type _hide_##name;                             \
272         type *_shadow_##name(void) { return &_hide_##name; }         \
273         static type _hide_##name
274 # define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
275 # define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
276 #else
277 # define OPENSSL_IMPLEMENT_GLOBAL(type,name) OPENSSL_GLOBAL type _shadow_##name
278 # define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
279 # define OPENSSL_GLOBAL_REF(name) _shadow_##name
280 #endif
281
282 #ifdef  __cplusplus
283 }
284 #endif
285 #endif