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