FreeBSD/Linux Kernel Cross Reference
sys/sys/_endian.h
1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1987, 1991 Regents of the University of California.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32 #ifndef _SYS__ENDIAN_H_
33 #define _SYS__ENDIAN_H_
34
35 #if !defined(_MACHINE_ENDIAN_H_) && !defined(_BYTESWAP_H_) && !defined(_ENDIAN_H_)
36 #error "sys/_endian.h should not be included directly"
37 #endif
38
39 /* BSD Compatiblity */
40 #define _BYTE_ORDER __BYTE_ORDER__
41
42 /*
43 * Definitions for byte order, according to byte significance from low
44 * address to high.
45 */
46 #define _LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__ /* LSB first: 1234 */
47 #define _BIG_ENDIAN __ORDER_BIG_ENDIAN__ /* MSB first: 4321 */
48 #define _PDP_ENDIAN __ORDER_PDP_ENDIAN__ /* LSB first in word,
49 * MSW first in long: 3412 */
50
51 /*
52 * Define the order of 32-bit words in 64-bit words.
53 */
54 #if _BYTE_ORDER == _LITTLE_ENDIAN
55 #define _QUAD_HIGHWORD 1
56 #define _QUAD_LOWWORD 0
57 #elif _BYTE_ORDER == _BIG_ENDIAN
58 #define _QUAD_HIGHWORD 0
59 #define _QUAD_LOWWORD 1
60 #else
61 #error "Unsupported endian"
62 #endif
63
64 /*
65 * Deprecated variants that don't have enough underscores to be useful in more
66 * strict namespaces.
67 */
68 #if __BSD_VISIBLE
69 #define LITTLE_ENDIAN _LITTLE_ENDIAN
70 #define BIG_ENDIAN _BIG_ENDIAN
71 #define PDP_ENDIAN _PDP_ENDIAN
72 #define BYTE_ORDER _BYTE_ORDER
73 #endif
74
75 /* bswap primitives, based on compiler builtins */
76 #define __bswap16(x) __builtin_bswap16(x)
77 #define __bswap32(x) __builtin_bswap32(x)
78 #define __bswap64(x) __builtin_bswap64(x)
79
80 #if _BYTE_ORDER == _LITTLE_ENDIAN
81 #define __ntohl(x) (__bswap32(x))
82 #define __ntohs(x) (__bswap16(x))
83 #define __htonl(x) (__bswap32(x))
84 #define __htons(x) (__bswap16(x))
85 #elif _BYTE_ORDER == _BIG_ENDIAN
86 #define __htonl(x) ((__uint32_t)(x))
87 #define __htons(x) ((__uint16_t)(x))
88 #define __ntohl(x) ((__uint32_t)(x))
89 #define __ntohs(x) ((__uint16_t)(x))
90 #endif
91
92 /*
93 * Host to big endian, host to little endian, big endian to host, and little
94 * endian to host byte order functions as detailed in byteorder(9).
95 */
96 #if _BYTE_ORDER == _LITTLE_ENDIAN
97 #define htobe16(x) __bswap16((x))
98 #define htobe32(x) __bswap32((x))
99 #define htobe64(x) __bswap64((x))
100 #define htole16(x) ((uint16_t)(x))
101 #define htole32(x) ((uint32_t)(x))
102 #define htole64(x) ((uint64_t)(x))
103
104 #define be16toh(x) __bswap16((x))
105 #define be32toh(x) __bswap32((x))
106 #define be64toh(x) __bswap64((x))
107 #define le16toh(x) ((uint16_t)(x))
108 #define le32toh(x) ((uint32_t)(x))
109 #define le64toh(x) ((uint64_t)(x))
110 #else /* _BYTE_ORDER != _LITTLE_ENDIAN */
111 #define htobe16(x) ((uint16_t)(x))
112 #define htobe32(x) ((uint32_t)(x))
113 #define htobe64(x) ((uint64_t)(x))
114 #define htole16(x) __bswap16((x))
115 #define htole32(x) __bswap32((x))
116 #define htole64(x) __bswap64((x))
117
118 #define be16toh(x) ((uint16_t)(x))
119 #define be32toh(x) ((uint32_t)(x))
120 #define be64toh(x) ((uint64_t)(x))
121 #define le16toh(x) __bswap16((x))
122 #define le32toh(x) __bswap32((x))
123 #define le64toh(x) __bswap64((x))
124 #endif /* _BYTE_ORDER == _LITTLE_ENDIAN */
125
126 #endif /* _SYS__ENDIAN_H_ */
Cache object: 3ed5e71786fef6245d6b2342f728a53b
|