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