c1a9ad7c25318330f9080c059470782fbfc236cb
[openssl.git] / include / openssl / e_os2.h
1 /*
2  * Copyright 1995-2016 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 #   undef OPENSSL_SYS_UNIX
53 #   define OPENSSL_SYS_WIN32_CYGWIN
54 #  else
55 #   if defined(_WIN32) || defined(OPENSSL_SYS_WIN32)
56 #    undef OPENSSL_SYS_UNIX
57 #    if !defined(OPENSSL_SYS_WIN32)
58 #     define OPENSSL_SYS_WIN32
59 #    endif
60 #   endif
61 #   if defined(_WIN64) || defined(OPENSSL_SYS_WIN64)
62 #    undef OPENSSL_SYS_UNIX
63 #    if !defined(OPENSSL_SYS_WIN64)
64 #     define OPENSSL_SYS_WIN64
65 #    endif
66 #   endif
67 #   if defined(OPENSSL_SYS_WINNT)
68 #    undef OPENSSL_SYS_UNIX
69 #   endif
70 #   if defined(OPENSSL_SYS_WINCE)
71 #    undef OPENSSL_SYS_UNIX
72 #   endif
73 #  endif
74 # endif
75
76 /* Anything that tries to look like Microsoft is "Windows" */
77 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WIN64) || defined(OPENSSL_SYS_WINNT) || defined(OPENSSL_SYS_WINCE)
78 #  undef OPENSSL_SYS_UNIX
79 #  define OPENSSL_SYS_WINDOWS
80 #  ifndef OPENSSL_SYS_MSDOS
81 #   define OPENSSL_SYS_MSDOS
82 #  endif
83 # endif
84
85 /*
86  * DLL settings.  This part is a bit tough, because it's up to the
87  * application implementor how he or she will link the application, so it
88  * requires some macro to be used.
89  */
90 # ifdef OPENSSL_SYS_WINDOWS
91 #  ifndef OPENSSL_OPT_WINDLL
92 #   if defined(_WINDLL)         /* This is used when building OpenSSL to
93                                  * indicate that DLL linkage should be used */
94 #    define OPENSSL_OPT_WINDLL
95 #   endif
96 #  endif
97 # endif
98
99 /* ------------------------------- OpenVMS -------------------------------- */
100 # if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYS_VMS)
101 #  if !defined(OPENSSL_SYS_VMS)
102 #   undef OPENSSL_SYS_UNIX
103 #  endif
104 #  define OPENSSL_SYS_VMS
105 #  if defined(__DECC)
106 #   define OPENSSL_SYS_VMS_DECC
107 #  elif defined(__DECCXX)
108 #   define OPENSSL_SYS_VMS_DECC
109 #   define OPENSSL_SYS_VMS_DECCXX
110 #  else
111 #   define OPENSSL_SYS_VMS_NODECC
112 #  endif
113 # endif
114
115 /* -------------------------------- Unix ---------------------------------- */
116 # ifdef OPENSSL_SYS_UNIX
117 #  if defined(linux) || defined(__linux__) && !defined(OPENSSL_SYS_LINUX)
118 #   define OPENSSL_SYS_LINUX
119 #  endif
120 #  if defined(_AIX) && !defined(OPENSSL_SYS_AIX)
121 #   define OPENSSL_SYS_AIX
122 #  endif
123 # endif
124
125 /* -------------------------------- VOS ----------------------------------- */
126 # if defined(__VOS__) && !defined(OPENSSL_SYS_VOS)
127 #  define OPENSSL_SYS_VOS
128 #  ifdef __HPPA__
129 #   define OPENSSL_SYS_VOS_HPPA
130 #  endif
131 #  ifdef __IA32__
132 #   define OPENSSL_SYS_VOS_IA32
133 #  endif
134 # endif
135
136 /**
137  * That's it for OS-specific stuff
138  *****************************************************************************/
139
140 /* Specials for I/O an exit */
141 # ifdef OPENSSL_SYS_MSDOS
142 #  define OPENSSL_UNISTD_IO <io.h>
143 #  define OPENSSL_DECLARE_EXIT extern void exit(int);
144 # else
145 #  define OPENSSL_UNISTD_IO OPENSSL_UNISTD
146 #  define OPENSSL_DECLARE_EXIT  /* declared in unistd.h */
147 # endif
148
149 /*-
150  * OPENSSL_EXTERN is normally used to declare a symbol with possible extra
151  * attributes to handle its presence in a shared library.
152  * OPENSSL_EXPORT is used to define a symbol with extra possible attributes
153  * to make it visible in a shared library.
154  * Care needs to be taken when a header file is used both to declare and
155  * define symbols.  Basically, for any library that exports some global
156  * variables, the following code must be present in the header file that
157  * declares them, before OPENSSL_EXTERN is used:
158  *
159  * #ifdef SOME_BUILD_FLAG_MACRO
160  * # undef OPENSSL_EXTERN
161  * # define OPENSSL_EXTERN OPENSSL_EXPORT
162  * #endif
163  *
164  * The default is to have OPENSSL_EXPORT and OPENSSL_EXTERN
165  * have some generally sensible values.
166  */
167
168 # if defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
169 #  define OPENSSL_EXPORT extern __declspec(dllexport)
170 #  define OPENSSL_EXTERN extern __declspec(dllimport)
171 # else
172 #  define OPENSSL_EXPORT extern
173 #  define OPENSSL_EXTERN extern
174 # endif
175
176 /*-
177  * Macros to allow global variables to be reached through function calls when
178  * required (if a shared library version requires it, for example.
179  * The way it's done allows definitions like this:
180  *
181  *      // in foobar.c
182  *      OPENSSL_IMPLEMENT_GLOBAL(int,foobar,0)
183  *      // in foobar.h
184  *      OPENSSL_DECLARE_GLOBAL(int,foobar);
185  *      #define foobar OPENSSL_GLOBAL_REF(foobar)
186  */
187 # ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
188 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value)                      \
189         type *_shadow_##name(void)                                      \
190         { static type _hide_##name=value; return &_hide_##name; }
191 #  define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
192 #  define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
193 # else
194 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) type _shadow_##name=value;
195 #  define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
196 #  define OPENSSL_GLOBAL_REF(name) _shadow_##name
197 # endif
198
199 # ifdef _WIN32
200 #  ifdef _WIN64
201 #   define ossl_ssize_t __int64
202 #   define OSSL_SSIZE_MAX _I64_MAX
203 #  else
204 #   define ossl_ssize_t int
205 #   define OSSL_SSIZE_MAX INT_MAX
206 #  endif
207 # endif
208
209 # if defined(OPENSSL_SYS_UEFI) && !defined(ssize_t)
210 #  define ossl_ssize_t int
211 #  define OSSL_SSIZE_MAX INT_MAX
212 # endif
213
214 # ifndef ossl_ssize_t
215 #  define ossl_ssize_t ssize_t
216 #  if defined(SSIZE_MAX)
217 #   define OSSL_SSIZE_MAX SSIZE_MAX
218 #  elif defined(_POSIX_SSIZE_MAX)
219 #   define OSSL_SSIZE_MAX _POSIX_SSIZE_MAX
220 #  endif
221 # endif
222
223 # ifdef DEBUG_UNUSED
224 #  define __owur __attribute__((__warn_unused_result__))
225 # else
226 #  define __owur
227 # endif
228
229 /* Standard integer types */
230 # if defined(OPENSSL_SYS_UEFI)
231 typedef INT8 int8_t;
232 typedef UINT8 uint8_t;
233 typedef INT16 int16_t;
234 typedef UINT16 uint16_t;
235 typedef INT32 int32_t;
236 typedef UINT32 uint32_t;
237 typedef INT64 int64_t;
238 typedef UINT64 uint64_t;
239 #  define PRIu64 "%Lu"
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 #ifdef  __cplusplus
291 }
292 #endif
293 #endif