ui_compat cleanup; makefiles and vms
[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 /* ---------------------- 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(OPENSSL_SYS_WINNT)
108 #    undef OPENSSL_SYS_UNIX
109 #   endif
110 #   if defined(OPENSSL_SYS_WINCE)
111 #    undef OPENSSL_SYS_UNIX
112 #   endif
113 #  endif
114 # endif
115
116 /* Anything that tries to look like Microsoft is "Windows" */
117 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINNT) || defined(OPENSSL_SYS_WINCE)
118 #  undef OPENSSL_SYS_UNIX
119 #  define OPENSSL_SYS_WINDOWS
120 #  ifndef OPENSSL_SYS_MSDOS
121 #   define OPENSSL_SYS_MSDOS
122 #  endif
123 # endif
124
125 /*
126  * DLL settings.  This part is a bit tough, because it's up to the
127  * application implementor how he or she will link the application, so it
128  * requires some macro to be used.
129  */
130 # ifdef OPENSSL_SYS_WINDOWS
131 #  ifndef OPENSSL_OPT_WINDLL
132 #   if defined(_WINDLL)         /* This is used when building OpenSSL to
133                                  * indicate that DLL linkage should be used */
134 #    define OPENSSL_OPT_WINDLL
135 #   endif
136 #  endif
137 # endif
138
139 /* ------------------------------- OpenVMS -------------------------------- */
140 # if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYS_VMS)
141 #  if !defined(OPENSSL_SYS_VMS)
142 #   undef OPENSSL_SYS_UNIX
143 #  endif
144 #  define OPENSSL_SYS_VMS
145 #  if defined(__DECC)
146 #   define OPENSSL_SYS_VMS_DECC
147 #  elif defined(__DECCXX)
148 #   define OPENSSL_SYS_VMS_DECC
149 #   define OPENSSL_SYS_VMS_DECCXX
150 #  else
151 #   define OPENSSL_SYS_VMS_NODECC
152 #  endif
153 # endif
154
155 /* -------------------------------- OS/2 ---------------------------------- */
156 # if defined(__EMX__) || defined(__OS2__)
157 #  undef OPENSSL_SYS_UNIX
158 #  define OPENSSL_SYS_OS2
159 # endif
160
161 /* -------------------------------- Unix ---------------------------------- */
162 # ifdef OPENSSL_SYS_UNIX
163 #  if defined(linux) || defined(__linux__) && !defined(OPENSSL_SYS_LINUX)
164 #   define OPENSSL_SYS_LINUX
165 #  endif
166 #  if defined(_AIX) && !defined(OPENSSL_SYS_AIX)
167 #   define OPENSSL_SYS_AIX
168 #  endif
169 # endif
170
171 /* -------------------------------- VOS ----------------------------------- */
172 # if defined(__VOS__) && !defined(OPENSSL_SYS_VOS)
173 #  define OPENSSL_SYS_VOS
174 #  ifdef __HPPA__
175 #   define OPENSSL_SYS_VOS_HPPA
176 #  endif
177 #  ifdef __IA32__
178 #   define OPENSSL_SYS_VOS_IA32
179 #  endif
180 # endif
181
182 /**
183  * That's it for OS-specific stuff
184  *****************************************************************************/
185
186 /* Specials for I/O an exit */
187 # ifdef OPENSSL_SYS_MSDOS
188 #  define OPENSSL_UNISTD_IO <io.h>
189 #  define OPENSSL_DECLARE_EXIT extern void exit(int);
190 # else
191 #  define OPENSSL_UNISTD_IO OPENSSL_UNISTD
192 #  define OPENSSL_DECLARE_EXIT  /* declared in unistd.h */
193 # endif
194
195 /*-
196  * Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare
197  * certain global symbols that, with some compilers under VMS, have to be
198  * defined and declared explicitely with globaldef and globalref.
199  * Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare
200  * DLL exports and imports for compilers under Win32.  These are a little
201  * more complicated to use.  Basically, for any library that exports some
202  * global variables, the following code must be present in the header file
203  * that declares them, before OPENSSL_EXTERN is used:
204  *
205  * #ifdef SOME_BUILD_FLAG_MACRO
206  * # undef OPENSSL_EXTERN
207  * # define OPENSSL_EXTERN OPENSSL_EXPORT
208  * #endif
209  *
210  * The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL
211  * have some generally sensible values, and for OPENSSL_EXTERN to have the
212  * value OPENSSL_IMPORT.
213  */
214
215 # if defined(OPENSSL_SYS_VMS_NODECC)
216 #  define OPENSSL_EXPORT globalref
217 #  define OPENSSL_IMPORT globalref
218 #  define OPENSSL_GLOBAL globaldef
219 # elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
220 #  define OPENSSL_EXPORT extern __declspec(dllexport)
221 #  define OPENSSL_IMPORT extern __declspec(dllimport)
222 #  define OPENSSL_GLOBAL
223 # else
224 #  define OPENSSL_EXPORT extern
225 #  define OPENSSL_IMPORT extern
226 #  define OPENSSL_GLOBAL
227 # endif
228 # define OPENSSL_EXTERN OPENSSL_IMPORT
229
230 /*-
231  * Macros to allow global variables to be reached through function calls when
232  * required (if a shared library version requires it, for example.
233  * The way it's done allows definitions like this:
234  *
235  *      // in foobar.c
236  *      OPENSSL_IMPLEMENT_GLOBAL(int,foobar,0)
237  *      // in foobar.h
238  *      OPENSSL_DECLARE_GLOBAL(int,foobar);
239  *      #define foobar OPENSSL_GLOBAL_REF(foobar)
240  */
241 # ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
242 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value)                      \
243         type *_shadow_##name(void)                                      \
244         { static type _hide_##name=value; return &_hide_##name; }
245 #  define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
246 #  define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
247 # else
248 #  define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) OPENSSL_GLOBAL type _shadow_##name=value;
249 #  define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
250 #  define OPENSSL_GLOBAL_REF(name) _shadow_##name
251 # endif
252
253 # ifdef OPENSSL_SYS_MSDOS
254 #  define ossl_ssize_t long
255 # endif
256
257 # if defined(__ultrix) && !defined(ssize_t)
258 #  define ossl_ssize_t int
259 # endif
260
261 # ifndef ossl_ssize_t
262 #  define ossl_ssize_t ssize_t
263 # endif
264
265 # ifdef DEBUG_UNUSED
266 #  define __owur __attribute__((__warn_unused_result__))
267 # else
268 #  define __owur
269 # endif
270
271 #ifdef  __cplusplus
272 }
273 #endif
274 #endif