1 .\" Copyright (C) 2009, Linux Foundation, written by Michael Kerrisk
2 .\" <mtk.manpages@gmail.com>
3 .\" a few pieces remain from an earlier version
4 .\" Copyright (C) 2008, Nanno Langstraat <nal@ii.nl>
6 .\" %%%LICENSE_START(VERBATIM)
7 .\" Permission is granted to make and distribute verbatim copies of this
8 .\" manual provided the copyright notice and this permission notice are
9 .\" preserved on all copies.
11 .\" Permission is granted to copy and distribute modified versions of this
12 .\" manual under the conditions for verbatim copying, provided that the
13 .\" entire resulting derived work is distributed under the terms of a
14 .\" permission notice identical to this one.
16 .\" Since the Linux kernel and libraries are constantly changing, this
17 .\" manual page may be incorrect or out-of-date. The author(s) assume no
18 .\" responsibility for errors or omissions, or for damages resulting from
19 .\" the use of the information contained herein. The author(s) may not
20 .\" have taken the same level of care in the production of this manual,
21 .\" which is licensed free of charge, as they might when working
24 .\" Formatted or processed versions of this manual, if unaccompanied by
25 .\" the source, must acknowledge the copyright and authors of this work.
28 .TH ENDIAN 3 2017-09-15 "GNU" "Linux Programmer's Manual"
30 htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh, le32toh,
31 htobe64, htole64, be64toh, le64toh \-
32 convert values between host and big-/little-endian byte order
35 .B #include <endian.h>
37 .BI "uint16_t htobe16(uint16_t " host_16bits );
38 .BI "uint16_t htole16(uint16_t " host_16bits );
39 .BI "uint16_t be16toh(uint16_t " big_endian_16bits );
40 .BI "uint16_t le16toh(uint16_t " little_endian_16bits );
42 .BI "uint32_t htobe32(uint32_t " host_32bits );
43 .BI "uint32_t htole32(uint32_t " host_32bits );
44 .BI "uint32_t be32toh(uint32_t " big_endian_32bits );
45 .BI "uint32_t le32toh(uint32_t " little_endian_32bits );
47 .BI "uint64_t htobe64(uint64_t " host_64bits );
48 .BI "uint64_t htole64(uint64_t " host_64bits );
49 .BI "uint64_t be64toh(uint64_t " big_endian_64bits );
50 .BI "uint64_t le64toh(uint64_t " little_endian_64bits );
54 Feature Test Macro Requirements for glibc (see
55 .BR feature_test_macros (7)):
73 In glibc up to and including 2.19:
77 These functions convert the byte encoding of integer values from
78 the byte order that the current CPU (the "host") uses,
79 to and from little-endian and big-endian byte order.
83 in the name of each function indicates the size of
84 integer handled by the function, either 16, 32, or 64 bits.
86 The functions with names of the form "htobe\fInn\fP" convert
87 from host byte order to big-endian order.
89 The functions with names of the form "htole\fInn\fP" convert
90 from host byte order to little-endian order.
92 The functions with names of the form "be\fInn\fPtoh" convert
93 from big-endian order to host byte order.
95 The functions with names of the form "le\fInn\fPtoh" convert
96 from little-endian order to host byte order.
98 These functions were added to glibc in version 2.9.
100 These functions are nonstandard.
101 Similar functions are present on the BSDs,
102 where the required header file is
107 NetBSD, FreeBSD, and glibc haven't followed the original
108 OpenBSD naming convention for these functions,
111 component always appears at the end of the function name
112 (thus, for example, in NetBSD, FreeBSD, and glibc,
113 the equivalent of OpenBSDs "betoh32" is "be32toh").
115 These functions are similar to the older
125 functions is that they are standard functions available
127 On the other hand, the fact that they were designed
128 for use in the context of TCP/IP means that
129 they lack the 64-bit and little-endian variants described in this page.
131 The program below display the results of converting an integer
132 from host byte order to both little-endian and big-endian byte order.
133 Since host byte order is either little-endian or big-endian,
134 only one of these conversions will have an effect.
135 When we run this program on a little-endian system such as x86-32,
136 we see the following:
142 htole32(x.u32) = 0x44332211
143 htobe32(x.u32) = 0x11223344
155 main(int argc, char *argv[])
162 x.arr[0] = 0x11; /* Lowest-address byte */
165 x.arr[3] = 0x44; /* Highest-address byte */
167 printf("x.u32 = 0x%x\\n", x.u32);
168 printf("htole32(x.u32) = 0x%x\\n", htole32(x.u32));
169 printf("htobe32(x.u32) = 0x%x\\n", htobe32(x.u32));