1f8219a746500fa5a858575a637d0985d46ba969
[openssl.git] / include / openssl / e_os2.h
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef HEADER_E_OS2_H
11 # define HEADER_E_OS2_H
12
13 # include <openssl/opensslconf.h>
14
15 #ifdef  __cplusplus
16 extern "C" {
17 #endif
18
19 /******************************************************************************
20  * Detect operating systems.  This probably needs completing.
21  * The result is that at least one OPENSSL_SYS_os macro should be defined.
22  * However, if none is defined, Unix is assumed.
23  **/
24
25 # define OPENSSL_SYS_UNIX
26
27 /* --------------------- Microsoft operating systems ---------------------- */
28
29 /*
30  * Note that MSDOS actually denotes 32-bit environments running on top of
31  * MS-DOS, such as DJGPP one.
32  */
33 # if defined(OPENSSL_SYS_MSDOS)
34 #  undef OPENSSL_SYS_UNIX
35 # endif
36
37 /*
38  * For 32 bit environment, there seems to be the CygWin environment and then
39  * all the others that try to do the same thing Microsoft does...
40  */
41 /*
42  * UEFI lives here because it might be built with a Microsoft toolchain and
43  * we need to avoid the false positive match on Windows.
44  */
45 # if defined(OPENSSL_SYS_UEFI)
46 #  undef OPENSSL_SYS_UNIX
47 # elif defined(OPENSSL_SYS_UWIN)
48 #  undef OPENSSL_SYS_UNIX
49 #  define OPENSSL_SYS_WIN32_UWIN
50 # else
51 #  if defined(__CYGWIN__) || defined(OPENSSL_SYS_CYGWIN)
52 #   define OPENSSL_SYS_WIN32_CYGWIN
53 #  else
54 #   if defined(_WIN32) || defined(OPENSSL_SYS_WIN32)
55 #    undef OPENSSL_SYS_UNIX
56 #    if !defined(OPENSSL_SYS_WIN32)
57 #     define OPENSSL_SYS_WIN32
58 #    endif
59 #   endif
60 #   if defined(_WIN64) || defined(OPENSSL_SYS_WIN64)
61 #    undef OPENSSL_SYS_UNIX
62 #    if !defined(OPENSSL_SYS_WIN64)
63 #     define OPENSSL_SYS_WIN64
64 #    endif
65 #   endif
66 #   if defined(OPENSSL_SYS_WINNT)
67 #    undef OPENSSL_SYS_UNIX
68 #   endif
69 #   if defined(OPENSSL_SYS_WINCE)
70 #    undef OPENSSL_SYS_UNIX
71 #   endif
72 #  endif
73 # endif
74
75 /* Anything that tries to look like Microsoft is "Windows" */
76 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WIN64) || defined(OPENSSL_SYS_WINNT) || defined(OPENSSL_SYS_WINCE)
77 #  undef OPENSSL_SYS_UNIX
78 #  define OPENSSL_SYS_WINDOWS
79 #  ifndef OPENSSL_SYS_MSDOS
80 #   define OPENSSL_SYS_MSDOS
81 #  endif
82 # endif
83
84 /*
85  * DLL settings.  This part is a bit tough, because it's up to the
86  * application implementor how he or she will link the application, so it
87  * requires some macro to be used.
88  */
89 # ifdef OPENSSL_SYS_WINDOWS
90 #  ifndef OPENSSL_OPT_WINDLL
91 #   if defined(_WINDLL)         /* This is used when building OpenSSL to
92                                  * indicate that DLL linkage should be used */
93 #    define OPENSSL_OPT_WINDLL
94 #   endif
95 #  endif
96 # endif
97
98 /* ------------------------------- OpenVMS -------------------------------- */
99 # if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYS_VMS)
100 #  if !defined(OPENSSL_SYS_VMS)
101 #   undef OPENSSL_SYS_UNIX
102 #  endif
103 #  define OPENSSL_SYS_VMS
104 #  if defined(__DECC)
105 #   define OPENSSL_SYS_VMS_DECC
106 #  elif defined(__DECCXX)
107 #   define OPENSSL_SYS_VMS_DECC
108 #   define OPENSSL_SYS_VMS_DECCXX
109 #  else
110 #   define OPENSSL_SYS_VMS_NODECC
111 #  endif
112 # endif
113
114 /* -------------------------------- Unix ---------------------------------- */
115 # ifdef OPENSSL_SYS_UNIX
116 #  if defined(linux) || defined(__linux__) && !defined(OPENSSL_SYS_LINUX)
117 #   define OPENSSL_SYS_LINUX
118 #  endif
119 #  if defined(_AIX) && !defined(OPENSSL_SYS_AIX)
120 #   define OPENSSL_SYS_AIX
121 #  endif
122 # endif
123
124 /* -------------------------------- VOS ----------------------------------- */
125 # if defined(__VOS__) && !defined(OPENSSL_SYS_VOS)
126 #  define OPENSSL_SYS_VOS
127 #  ifdef __HPPA__
128 #   define OPENSSL_SYS_VOS_HPPA
129 #  endif
130 #  ifdef __IA32__
131 #   define OPENSSL_SYS_VOS_IA32
132 #  endif
133 # endif
134
135 /**
136  * That's it for OS-specific stuff
137  *****************************************************************************/
138
139 /* Specials for I/O an exit */
140 # ifdef OPENSSL_SYS_MSDOS
141 #  define OPENSSL_UNISTD_IO <io.h>
142 #  define OPENSSL_DECLARE_EXIT extern void exit(int);
143 # else
144 #  define OPENSSL_UNISTD_IO OPENSSL_UNISTD
145 #  define OPENSSL_DECLARE_EXIT  /* declared in unistd.h */
146 # endif
147
148 /*-
149  * OPENSSL_EXTERN is normally used to declare a symbol with possible extra
150  * attributes to handle its presence in a shared library.
151  * OPENSSL_EXPORT is used to define a symbol with extra possible attributes
152  * to make it visible in a shared library.
153  * Care needs to be taken when a header file is used both to declare and
154  * define symbols.  Basically, for any library that exports some global
155  * variables, the following code must be present in the header file that
156  * declares them, before OPENSSL_EXTERN is used:
157  *
158  * #ifdef SOME_BUILD_FLAG_MACRO
159  * # undef OPENSSL_EXTERN
160  * # define OPENSSL_EXTERN OPENSSL_EXPORT
161  * #endif
162  *
163  * The default is to have OPENSSL_EXPORT and OPENSSL_EXTERN
164  * have some generally sensible values.
165  */
166
167 # if defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
168 #  define OPENSSL_EXPORT extern __declspec(dllexport)
169 #  define OPENSSL_EXTERN extern __declspec(dllimport)
170 # else
171 #  define OPENSSL_EXPORT extern
172 #  define OPENSSL_EXTERN extern
173 # endif
174
175 /*-
176  * Macros to allow global variables to be reached through function calls when
177  * required (if a shared library version requires it, for example.
178  * The way it's done allows definitions like this:
179  *
180  *      // in foobar.c
181  *      OPENSSL_IMPLEMENT_GLOBAL(int,foobar,0)
182  *      // in foobar.h
183  *      OPENSSL_DECLARE_GLOBAL(int,foobar);
184  *      #define foobar OPENSSL_GLOBAL_REF(foobar)
185  */
186 # ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
187 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value)                      \
188         type *_shadow_##name(void)                                      \
189         { static type _hide_##name=value; return &_hide_##name; }
190 #  define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
191 #  define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
192 # else
193 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) type _shadow_##name=value;
194 #  define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
195 #  define OPENSSL_GLOBAL_REF(name) _shadow_##name
196 # endif
197
198 # ifdef _WIN32
199 #  ifdef _WIN64
200 #   define ossl_ssize_t __int64
201 #   define OSSL_SSIZE_MAX _I64_MAX
202 #  else
203 #   define ossl_ssize_t int
204 #   define OSSL_SSIZE_MAX INT_MAX
205 #  endif
206 # endif
207
208 # if defined(OPENSSL_SYS_UEFI) && !defined(ossl_ssize_t)
209 #  define ossl_ssize_t INTN
210 #  define OSSL_SSIZE_MAX MAX_INTN
211 # endif
212
213 # ifndef ossl_ssize_t
214 #  define ossl_ssize_t ssize_t
215 #  if defined(SSIZE_MAX)
216 #   define OSSL_SSIZE_MAX SSIZE_MAX
217 #  elif defined(_POSIX_SSIZE_MAX)
218 #   define OSSL_SSIZE_MAX _POSIX_SSIZE_MAX
219 #  else
220 #   define OSSL_SSIZE_MAX ((ssize_t)(SIZE_MAX>>1))
221 #  endif
222 # endif
223
224 # ifdef DEBUG_UNUSED
225 #  define __owur __attribute__((__warn_unused_result__))
226 # else
227 #  define __owur
228 # endif
229
230 /* Standard integer types */
231 # if defined(OPENSSL_SYS_UEFI)
232 typedef INT8 int8_t;
233 typedef UINT8 uint8_t;
234 typedef INT16 int16_t;
235 typedef UINT16 uint16_t;
236 typedef INT32 int32_t;
237 typedef UINT32 uint32_t;
238 typedef INT64 int64_t;
239 typedef UINT64 uint64_t;
240 # elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
241      defined(__osf__) || defined(__sgi) || defined(__hpux) || \
242      defined(OPENSSL_SYS_VMS) || defined (__OpenBSD__)
243 #  include <inttypes.h>
244 # elif defined(_MSC_VER) && _MSC_VER<=1500
245 /*
246  * minimally required typdefs for systems not supporting inttypes.h or
247  * stdint.h: currently just older VC++
248  */
249 typedef signed char int8_t;
250 typedef unsigned char uint8_t;
251 typedef short int16_t;
252 typedef unsigned short uint16_t;
253 typedef int int32_t;
254 typedef unsigned int uint32_t;
255 typedef __int64 int64_t;
256 typedef unsigned __int64 uint64_t;
257 # else
258 #  include <stdint.h>
259 # endif
260
261 /* ossl_inline: portable inline definition usable in public headers */
262 # if !defined(inline) && !defined(__cplusplus)
263 #  if defined(__STDC_VERSION__) && __STDC_VERSION__>=199901L
264    /* just use inline */
265 #   define ossl_inline inline
266 #  elif defined(__GNUC__) && __GNUC__>=2
267 #   define ossl_inline __inline__
268 #  elif defined(_MSC_VER)
269   /*
270    * Visual Studio: inline is available in C++ only, however
271    * __inline is available for C, see
272    * http://msdn.microsoft.com/en-us/library/z8y1yy88.aspx
273    */
274 #   define ossl_inline __inline
275 #  else
276 #   define ossl_inline
277 #  endif
278 # else
279 #  define ossl_inline inline
280 # endif
281
282 # if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
283 #  define ossl_noreturn _Noreturn
284 # elif defined(__GNUC__) && __GNUC__ >= 2
285 #  define ossl_noreturn __attribute__((noreturn))
286 # else
287 #  define ossl_noreturn
288 # endif
289
290 /* ossl_unused: portable unused attribute for use in public headers */
291 # if defined(__GNUC__)
292 #  define ossl_unused __attribute__((unused))
293 # else
294 #  define ossl_unused
295 # endif
296
297 #ifdef  __cplusplus
298 }
299 #endif
300 #endif