xref: /openbsd/sys/lib/libkern/milieu.h (revision 09467b48)
1 /*	$OpenBSD: milieu.h,v 1.3 2008/06/26 05:42:20 ray Exp $	*/
2 /*	$NetBSD: milieu.h,v 1.1 2001/04/26 03:10:47 ross Exp $	*/
3 
4 /* This is a derivative work. */
5 
6 /*-
7  * Copyright (c) 2001 The NetBSD Foundation, Inc.
8  * All rights reserved.
9  *
10  * This code is derived from software contributed to The NetBSD Foundation
11  * by Ross Harvey.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 /*
36 ===============================================================================
37 
38 This C header file is part of TestFloat, Release 2a, a package of programs
39 for testing the correctness of floating-point arithmetic complying to the
40 IEC/IEEE Standard for Floating-Point.
41 
42 Written by John R. Hauser.  More information is available through the Web
43 page `http://HTTP.CS.Berkeley.EDU/~jhauser/arithmetic/TestFloat.html'.
44 
45 THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE.  Although reasonable
46 effort has been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT
47 WILL AT TIMES RESULT IN INCORRECT BEHAVIOR.  USE OF THIS SOFTWARE IS
48 RESTRICTED TO PERSONS AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL
49 RESPONSIBILITY FOR ALL LOSSES, COSTS, OR OTHER PROBLEMS ARISING FROM
50 THEIR OWN USE OF THE SOFTWARE, AND WHO ALSO EFFECTIVELY INDEMNIFY
51 (possibly via similar legal warning) JOHN HAUSER AND THE INTERNATIONAL
52 COMPUTER SCIENCE INSTITUTE AGAINST ALL LOSSES, COSTS, OR OTHER PROBLEMS
53 ARISING FROM THE USE OF THE SOFTWARE BY THEIR CUSTOMERS AND CLIENTS.
54 
55 Derivative works are acceptable, even for commercial purposes, so long as
56 (1) they include prominent notice that the work is derivative, and (2) they
57 include prominent notice akin to these four paragraphs for those parts of
58 this code that are retained.
59 
60 ===============================================================================
61 */
62 
63 #ifndef MILIEU_H
64 #define MILIEU_H
65 
66 #include <sys/types.h>
67 #include <sys/endian.h>
68 
69 enum {
70     FALSE = 0,
71     TRUE  = 1
72 };
73 
74 
75 /*
76 -------------------------------------------------------------------------------
77 One of the macros `BIGENDIAN' or `LITTLEENDIAN' must be defined.
78 -------------------------------------------------------------------------------
79 */
80 
81 #if _BYTE_ORDER == _LITTLE_ENDIAN
82 #define LITTLEENDIAN
83 #else
84 #define BIGENDIAN
85 #endif
86 
87 #define BITS64
88 
89 /*
90 -------------------------------------------------------------------------------
91 Each of the following `typedef's defines the most convenient type that holds
92 integers of at least as many bits as specified.  For example, `uint8' should
93 be the most convenient type that can hold unsigned integers of as many as
94 8 bits.  The `flag' type must be able to hold either a 0 or 1.  For most
95 implementations of C, `flag', `uint8', and `int8' should all be `typedef'ed
96 to the same as `int'.
97 -------------------------------------------------------------------------------
98 */
99 typedef int flag;
100 typedef unsigned int uint8;
101 typedef signed int int8;
102 typedef unsigned int uint16;
103 typedef int int16;
104 typedef unsigned int uint32;
105 typedef signed int int32;
106 #ifdef BITS64
107 typedef uint64_t uint64;
108 typedef int64_t int64;
109 #endif
110 
111 /*
112 -------------------------------------------------------------------------------
113 Each of the following `typedef's defines a type that holds integers
114 of _exactly_ the number of bits specified.  For instance, for most
115 implementation of C, `bits16' and `sbits16' should be `typedef'ed to
116 `unsigned short int' and `signed short int' (or `short int'), respectively.
117 -------------------------------------------------------------------------------
118 */
119 typedef uint8_t bits8;
120 typedef int8_t sbits8;
121 typedef uint16_t bits16;
122 typedef int16_t sbits16;
123 typedef uint32_t bits32;
124 typedef int32_t sbits32;
125 #ifdef BITS64
126 typedef uint64_t bits64;
127 typedef int64_t sbits64;
128 #endif
129 
130 #ifdef BITS64
131 /*
132 -------------------------------------------------------------------------------
133 The `LIT64' macro takes as its argument a textual integer literal and
134 if necessary ``marks'' the literal as having a 64-bit integer type.
135 For example, the GNU C Compiler (`gcc') requires that 64-bit literals be
136 appended with the letters `LL' standing for `long long', which is `gcc's
137 name for the 64-bit integer type.  Some compilers may allow `LIT64' to be
138 defined as the identity macro:  `#define LIT64( a ) a'.
139 -------------------------------------------------------------------------------
140 */
141 #define LIT64( a ) a##LL
142 #endif
143 
144 /*
145 -------------------------------------------------------------------------------
146 The macro `INLINE' can be used before functions that should be inlined.  If
147 a compiler does not support explicit inlining, this macro should be defined
148 to be `static'.
149 -------------------------------------------------------------------------------
150 */
151 #define INLINE static inline
152 
153 #endif
154