177b0981e387962c00e1fdecc2fc9fd36f4a10e3
[openssl.git] / include / openssl / 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 /* ---------------------- NetWare ----------------------------------------- */
74 # if defined(NETWARE) && !defined(OPENSSL_SYS_NETWARE)
75 #  undef OPENSSL_SYS_UNIX
76 #  define OPENSSL_SYS_NETWARE
77 # endif
78
79 /* --------------------- Microsoft operating systems ---------------------- */
80
81 /*
82  * Note that MSDOS actually denotes 32-bit environments running on top of
83  * MS-DOS, such as DJGPP one.
84  */
85 # if defined(OPENSSL_SYS_MSDOS)
86 #  undef OPENSSL_SYS_UNIX
87 # endif
88
89 /*
90  * For 32 bit environment, there seems to be the CygWin environment and then
91  * all the others that try to do the same thing Microsoft does...
92  */
93 # if defined(OPENSSL_SYS_UWIN)
94 #  undef OPENSSL_SYS_UNIX
95 #  define OPENSSL_SYS_WIN32_UWIN
96 # else
97 #  if defined(__CYGWIN__) || defined(OPENSSL_SYS_CYGWIN)
98 #   undef OPENSSL_SYS_UNIX
99 #   define OPENSSL_SYS_WIN32_CYGWIN
100 #  else
101 #   if defined(_WIN32) || defined(OPENSSL_SYS_WIN32)
102 #    undef OPENSSL_SYS_UNIX
103 #    if !defined(OPENSSL_SYS_WIN32)
104 #     define OPENSSL_SYS_WIN32
105 #    endif
106 #   endif
107 #   if defined(_WIN64) || defined(OPENSSL_SYS_WIN64)
108 #    undef OPENSSL_SYS_UNIX
109 #    if !defined(OPENSSL_SYS_WIN64)
110 #     define OPENSSL_SYS_WIN64
111 #    endif
112 #   endif
113 #   if defined(OPENSSL_SYS_WINNT)
114 #    undef OPENSSL_SYS_UNIX
115 #   endif
116 #   if defined(OPENSSL_SYS_WINCE)
117 #    undef OPENSSL_SYS_UNIX
118 #   endif
119 #  endif
120 # endif
121
122 /* Anything that tries to look like Microsoft is "Windows" */
123 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WIN64) || 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 /*
132  * DLL settings.  This part is a bit tough, because it's up to the
133  * application implementor how he or she will link the application, so it
134  * requires some macro to be used.
135  */
136 # ifdef OPENSSL_SYS_WINDOWS
137 #  ifndef OPENSSL_OPT_WINDLL
138 #   if defined(_WINDLL)         /* This is used when building OpenSSL to
139                                  * indicate that DLL linkage should be used */
140 #    define OPENSSL_OPT_WINDLL
141 #   endif
142 #  endif
143 # endif
144
145 /* ------------------------------- OpenVMS -------------------------------- */
146 # if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYS_VMS)
147 #  if !defined(OPENSSL_SYS_VMS)
148 #   undef OPENSSL_SYS_UNIX
149 #  endif
150 #  define OPENSSL_SYS_VMS
151 #  if defined(__DECC)
152 #   define OPENSSL_SYS_VMS_DECC
153 #  elif defined(__DECCXX)
154 #   define OPENSSL_SYS_VMS_DECC
155 #   define OPENSSL_SYS_VMS_DECCXX
156 #  else
157 #   define OPENSSL_SYS_VMS_NODECC
158 #  endif
159 # endif
160
161 /* -------------------------------- OS/2 ---------------------------------- */
162 # if defined(__EMX__) || defined(__OS2__)
163 #  undef OPENSSL_SYS_UNIX
164 #  define OPENSSL_SYS_OS2
165 # endif
166
167 /* -------------------------------- Unix ---------------------------------- */
168 # ifdef OPENSSL_SYS_UNIX
169 #  if defined(linux) || defined(__linux__) && !defined(OPENSSL_SYS_LINUX)
170 #   define OPENSSL_SYS_LINUX
171 #  endif
172 #  if defined(_AIX) && !defined(OPENSSL_SYS_AIX)
173 #   define OPENSSL_SYS_AIX
174 #  endif
175 # endif
176
177 /* -------------------------------- VOS ----------------------------------- */
178 # if defined(__VOS__) && !defined(OPENSSL_SYS_VOS)
179 #  define OPENSSL_SYS_VOS
180 #  ifdef __HPPA__
181 #   define OPENSSL_SYS_VOS_HPPA
182 #  endif
183 #  ifdef __IA32__
184 #   define OPENSSL_SYS_VOS_IA32
185 #  endif
186 # endif
187
188 /**
189  * That's it for OS-specific stuff
190  *****************************************************************************/
191
192 /* Specials for I/O an exit */
193 # ifdef OPENSSL_SYS_MSDOS
194 #  define OPENSSL_UNISTD_IO <io.h>
195 #  define OPENSSL_DECLARE_EXIT extern void exit(int);
196 # else
197 #  define OPENSSL_UNISTD_IO OPENSSL_UNISTD
198 #  define OPENSSL_DECLARE_EXIT  /* declared in unistd.h */
199 # endif
200
201 /*-
202  * Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare
203  * certain global symbols that, with some compilers under VMS, have to be
204  * defined and declared explicitely with globaldef and globalref.
205  * Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare
206  * DLL exports and imports for compilers under Win32.  These are a little
207  * more complicated to use.  Basically, for any library that exports some
208  * global variables, the following code must be present in the header file
209  * that declares them, before OPENSSL_EXTERN is used:
210  *
211  * #ifdef SOME_BUILD_FLAG_MACRO
212  * # undef OPENSSL_EXTERN
213  * # define OPENSSL_EXTERN OPENSSL_EXPORT
214  * #endif
215  *
216  * The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL
217  * have some generally sensible values, and for OPENSSL_EXTERN to have the
218  * value OPENSSL_IMPORT.
219  */
220
221 # if defined(OPENSSL_SYS_VMS_NODECC)
222 #  define OPENSSL_EXPORT globalref
223 #  define OPENSSL_IMPORT globalref
224 #  define OPENSSL_GLOBAL globaldef
225 # elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
226 #  define OPENSSL_EXPORT extern __declspec(dllexport)
227 #  define OPENSSL_IMPORT extern __declspec(dllimport)
228 #  define OPENSSL_GLOBAL
229 # else
230 #  define OPENSSL_EXPORT extern
231 #  define OPENSSL_IMPORT extern
232 #  define OPENSSL_GLOBAL
233 # endif
234 # define OPENSSL_EXTERN OPENSSL_IMPORT
235
236 /*-
237  * Macros to allow global variables to be reached through function calls when
238  * required (if a shared library version requires it, for example.
239  * The way it's done allows definitions like this:
240  *
241  *      // in foobar.c
242  *      OPENSSL_IMPLEMENT_GLOBAL(int,foobar,0)
243  *      // in foobar.h
244  *      OPENSSL_DECLARE_GLOBAL(int,foobar);
245  *      #define foobar OPENSSL_GLOBAL_REF(foobar)
246  */
247 # ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
248 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value)                      \
249         type *_shadow_##name(void)                                      \
250         { static type _hide_##name=value; return &_hide_##name; }
251 #  define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
252 #  define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
253 # else
254 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) OPENSSL_GLOBAL type _shadow_##name=value;
255 #  define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
256 #  define OPENSSL_GLOBAL_REF(name) _shadow_##name
257 # endif
258
259 # ifdef OPENSSL_SYS_MSDOS
260 #  define ossl_ssize_t long
261 # endif
262
263 # if defined(__ultrix) && !defined(ssize_t)
264 #  define ossl_ssize_t int
265 # endif
266
267 # ifndef ossl_ssize_t
268 #  define ossl_ssize_t ssize_t
269 # endif
270
271 # ifdef DEBUG_UNUSED
272 #  define __owur __attribute__((__warn_unused_result__))
273 # else
274 #  define __owur
275 # endif
276
277 /* Standard integer types */
278 # if defined(__osf__) || defined(__sgi) || defined(__hpux) || defined(OPENSSL_SYS_VMS)
279 #  include <inttypes.h>
280 # elif defined(_MSC_VER) && _MSC_VER<=1500
281 /*
282  * minimally required typdefs for systems not supporting inttypes.h or
283  * stdint.h: currently just older VC++
284  */
285 typedef signed char int8_t;
286 typedef unsigned char uint8_t;
287 typedef short int16_t;
288 typedef unsigned short uint16_t;
289 typedef int int32_t;
290 typedef unsigned int uint32_t;
291 typedef __int64 int64_t;
292 typedef unsigned __int64 uint64_t;
293 # else
294 #  include <stdint.h>
295 # endif
296
297 #ifdef  __cplusplus
298 }
299 #endif
300 #endif