Document -no_explicit
[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 /*
88  * Note that MSDOS actually denotes 32-bit environments running on top of
89  * MS-DOS, such as DJGPP one.
90  */
91 # if defined(OPENSSL_SYSNAME_MSDOS)
92 #  undef OPENSSL_SYS_UNIX
93 #  define OPENSSL_SYS_MSDOS
94 # endif
95
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  */
100 # if defined(OPENSSL_SYSNAME_UWIN)
101 #  undef OPENSSL_SYS_UNIX
102 #  define OPENSSL_SYS_WIN32_UWIN
103 # else
104 #  if defined(__CYGWIN32__) || defined(OPENSSL_SYSNAME_CYGWIN32)
105 #   undef OPENSSL_SYS_UNIX
106 #   define OPENSSL_SYS_WIN32_CYGWIN
107 #  else
108 #   if defined(_WIN32) || defined(OPENSSL_SYSNAME_WIN32)
109 #    undef OPENSSL_SYS_UNIX
110 #    define OPENSSL_SYS_WIN32
111 #   endif
112 #   if defined(OPENSSL_SYSNAME_WINNT)
113 #    undef OPENSSL_SYS_UNIX
114 #    define OPENSSL_SYS_WINNT
115 #   endif
116 #   if defined(OPENSSL_SYSNAME_WINCE)
117 #    undef OPENSSL_SYS_UNIX
118 #    define OPENSSL_SYS_WINCE
119 #   endif
120 #  endif
121 # endif
122
123 /* Anything that tries to look like Microsoft is "Windows" */
124 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINNT) || defined(OPENSSL_SYS_WINCE)
125 #  undef OPENSSL_SYS_UNIX
126 #  define OPENSSL_SYS_WINDOWS
127 #  ifndef OPENSSL_SYS_MSDOS
128 #   define OPENSSL_SYS_MSDOS
129 #  endif
130 # endif
131
132 /*
133  * DLL settings.  This part is a bit tough, because it's up to the
134  * application implementor how he or she will link the application, so it
135  * requires some macro to be used.
136  */
137 # ifdef OPENSSL_SYS_WINDOWS
138 #  ifndef OPENSSL_OPT_WINDLL
139 #   if defined(_WINDLL)         /* This is used when building OpenSSL to
140                                  * indicate that DLL linkage should be used */
141 #    define OPENSSL_OPT_WINDLL
142 #   endif
143 #  endif
144 # endif
145
146 /* ------------------------------- OpenVMS -------------------------------- */
147 # if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYSNAME_VMS)
148 #  undef OPENSSL_SYS_UNIX
149 #  define OPENSSL_SYS_VMS
150 #  if defined(__DECC)
151 #   define OPENSSL_SYS_VMS_DECC
152 #  elif defined(__DECCXX)
153 #   define OPENSSL_SYS_VMS_DECC
154 #   define OPENSSL_SYS_VMS_DECCXX
155 #  else
156 #   define OPENSSL_SYS_VMS_NODECC
157 #  endif
158 # endif
159
160 /* -------------------------------- OS/2 ---------------------------------- */
161 # if defined(__EMX__) || defined(__OS2__)
162 #  undef OPENSSL_SYS_UNIX
163 #  define OPENSSL_SYS_OS2
164 # endif
165
166 /* -------------------------------- Unix ---------------------------------- */
167 # ifdef OPENSSL_SYS_UNIX
168 #  if defined(linux) || defined(__linux__) || defined(OPENSSL_SYSNAME_LINUX)
169 #   define OPENSSL_SYS_LINUX
170 #  endif
171 #  ifdef OPENSSL_SYSNAME_MPE
172 #   define OPENSSL_SYS_MPE
173 #  endif
174 #  ifdef OPENSSL_SYSNAME_SNI
175 #   define OPENSSL_SYS_SNI
176 #  endif
177 #  ifdef OPENSSL_SYSNAME_ULTRASPARC
178 #   define OPENSSL_SYS_ULTRASPARC
179 #  endif
180 #  ifdef OPENSSL_SYSNAME_NEWS4
181 #   define OPENSSL_SYS_NEWS4
182 #  endif
183 #  ifdef OPENSSL_SYSNAME_MACOSX
184 #   define OPENSSL_SYS_MACOSX
185 #  endif
186 #  ifdef OPENSSL_SYSNAME_MACOSX_RHAPSODY
187 #   define OPENSSL_SYS_MACOSX_RHAPSODY
188 #   define OPENSSL_SYS_MACOSX
189 #  endif
190 #  ifdef OPENSSL_SYSNAME_SUNOS
191 #   define OPENSSL_SYS_SUNOS
192 #  endif
193 #  if defined(_CRAY) || defined(OPENSSL_SYSNAME_CRAY)
194 #   define OPENSSL_SYS_CRAY
195 #  endif
196 #  if defined(_AIX) || defined(OPENSSL_SYSNAME_AIX)
197 #   define OPENSSL_SYS_AIX
198 #  endif
199 # endif
200
201 /* -------------------------------- VOS ----------------------------------- */
202 # if defined(__VOS__) || defined(OPENSSL_SYSNAME_VOS)
203 #  define OPENSSL_SYS_VOS
204 #  ifdef __HPPA__
205 #   define OPENSSL_SYS_VOS_HPPA
206 #  endif
207 #  ifdef __IA32__
208 #   define OPENSSL_SYS_VOS_IA32
209 #  endif
210 # endif
211
212 /* ------------------------------ VxWorks --------------------------------- */
213 # ifdef OPENSSL_SYSNAME_VXWORKS
214 #  define OPENSSL_SYS_VXWORKS
215 # endif
216
217 /* -------------------------------- BeOS ---------------------------------- */
218 # if defined(__BEOS__)
219 #  define OPENSSL_SYS_BEOS
220 #  include <sys/socket.h>
221 #  if defined(BONE_VERSION)
222 #   define OPENSSL_SYS_BEOS_BONE
223 #  else
224 #   define OPENSSL_SYS_BEOS_R5
225 #  endif
226 # endif
227
228 /**
229  * That's it for OS-specific stuff
230  *****************************************************************************/
231
232 /* Specials for I/O an exit */
233 # ifdef OPENSSL_SYS_MSDOS
234 #  define OPENSSL_UNISTD_IO <io.h>
235 #  define OPENSSL_DECLARE_EXIT extern void exit(int);
236 # else
237 #  define OPENSSL_UNISTD_IO OPENSSL_UNISTD
238 #  define OPENSSL_DECLARE_EXIT  /* declared in unistd.h */
239 # endif
240
241 /*-
242  * Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare
243  * certain global symbols that, with some compilers under VMS, have to be
244  * defined and declared explicitely with globaldef and globalref.
245  * Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare
246  * DLL exports and imports for compilers under Win32.  These are a little
247  * more complicated to use.  Basically, for any library that exports some
248  * global variables, the following code must be present in the header file
249  * that declares them, before OPENSSL_EXTERN is used:
250  *
251  * #ifdef SOME_BUILD_FLAG_MACRO
252  * # undef OPENSSL_EXTERN
253  * # define OPENSSL_EXTERN OPENSSL_EXPORT
254  * #endif
255  *
256  * The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL
257  * have some generally sensible values, and for OPENSSL_EXTERN to have the
258  * value OPENSSL_IMPORT.
259  */
260
261 # if defined(OPENSSL_SYS_VMS_NODECC)
262 #  define OPENSSL_EXPORT globalref
263 #  define OPENSSL_IMPORT globalref
264 #  define OPENSSL_GLOBAL globaldef
265 # elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
266 #  define OPENSSL_EXPORT extern __declspec(dllexport)
267 #  define OPENSSL_IMPORT extern __declspec(dllimport)
268 #  define OPENSSL_GLOBAL
269 # else
270 #  define OPENSSL_EXPORT extern
271 #  define OPENSSL_IMPORT extern
272 #  define OPENSSL_GLOBAL
273 # endif
274 # define OPENSSL_EXTERN OPENSSL_IMPORT
275
276 /*-
277  * Macros to allow global variables to be reached through function calls when
278  * required (if a shared library version requires it, for example.
279  * The way it's done allows definitions like this:
280  *
281  *      // in foobar.c
282  *      OPENSSL_IMPLEMENT_GLOBAL(int,foobar,0)
283  *      // in foobar.h
284  *      OPENSSL_DECLARE_GLOBAL(int,foobar);
285  *      #define foobar OPENSSL_GLOBAL_REF(foobar)
286  */
287 # ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
288 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value)                      \
289         type *_shadow_##name(void)                                      \
290         { static type _hide_##name=value; return &_hide_##name; }
291 #  define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
292 #  define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
293 # else
294 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) OPENSSL_GLOBAL type _shadow_##name=value;
295 #  define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
296 #  define OPENSSL_GLOBAL_REF(name) _shadow_##name
297 # endif
298
299 # if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && macintosh==1 && !defined(MAC_OS_GUSI_SOURCE)
300 #  define ossl_ssize_t long
301 # endif
302
303 # ifdef OPENSSL_SYS_MSDOS
304 #  define ossl_ssize_t long
305 # endif
306
307 # if defined(NeXT) || defined(OPENSSL_SYS_NEWS4) || defined(OPENSSL_SYS_SUNOS)
308 #  define ssize_t int
309 # endif
310
311 # if defined(__ultrix) && !defined(ssize_t)
312 #  define ossl_ssize_t int
313 # endif
314
315 # ifndef ossl_ssize_t
316 #  define ossl_ssize_t ssize_t
317 # endif
318
319 #ifdef  __cplusplus
320 }
321 #endif
322 #endif