xref: /onnv-gate/usr/src/lib/libntfs/common/include/ntfs/endians.h (revision 9663:ace9a2ac3683)
1*9663SMark.Logan@Sun.COM /*
2*9663SMark.Logan@Sun.COM  * endians.h - Definitions related to handling of byte ordering. Part of the
3*9663SMark.Logan@Sun.COM  *	       Linux-NTFS project.
4*9663SMark.Logan@Sun.COM  *
5*9663SMark.Logan@Sun.COM  * Copyright (c) 2000-2005 Anton Altaparmakov
6*9663SMark.Logan@Sun.COM  * Copyright (c)      2007 Yura Pakhuchiy
7*9663SMark.Logan@Sun.COM  *
8*9663SMark.Logan@Sun.COM  * This program/include file is free software; you can redistribute it and/or
9*9663SMark.Logan@Sun.COM  * modify it under the terms of the GNU General Public License as published
10*9663SMark.Logan@Sun.COM  * by the Free Software Foundation; either version 2 of the License, or
11*9663SMark.Logan@Sun.COM  * (at your option) any later version.
12*9663SMark.Logan@Sun.COM  *
13*9663SMark.Logan@Sun.COM  * This program/include file is distributed in the hope that it will be
14*9663SMark.Logan@Sun.COM  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15*9663SMark.Logan@Sun.COM  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16*9663SMark.Logan@Sun.COM  * GNU General Public License for more details.
17*9663SMark.Logan@Sun.COM  *
18*9663SMark.Logan@Sun.COM  * You should have received a copy of the GNU General Public License
19*9663SMark.Logan@Sun.COM  * along with this program (in the main directory of the Linux-NTFS
20*9663SMark.Logan@Sun.COM  * distribution in the file COPYING); if not, write to the Free Software
21*9663SMark.Logan@Sun.COM  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22*9663SMark.Logan@Sun.COM  */
23*9663SMark.Logan@Sun.COM 
24*9663SMark.Logan@Sun.COM #ifndef _NTFS_ENDIANS_H
25*9663SMark.Logan@Sun.COM #define _NTFS_ENDIANS_H
26*9663SMark.Logan@Sun.COM 
27*9663SMark.Logan@Sun.COM #ifdef HAVE_CONFIG_H
28*9663SMark.Logan@Sun.COM #include "config.h"
29*9663SMark.Logan@Sun.COM #endif
30*9663SMark.Logan@Sun.COM 
31*9663SMark.Logan@Sun.COM /*
32*9663SMark.Logan@Sun.COM  * Notes:
33*9663SMark.Logan@Sun.COM  *	We define the conversion functions including typecasts since the
34*9663SMark.Logan@Sun.COM  * defaults don't necessarily perform appropriate typecasts.
35*9663SMark.Logan@Sun.COM  *	Also, using our own functions means that we can change them if it
36*9663SMark.Logan@Sun.COM  * turns out that we do need to use the unaligned access macros on
37*9663SMark.Logan@Sun.COM  * architectures requiring aligned memory accesses...
38*9663SMark.Logan@Sun.COM  */
39*9663SMark.Logan@Sun.COM 
40*9663SMark.Logan@Sun.COM #ifdef HAVE_ENDIAN_H
41*9663SMark.Logan@Sun.COM #include <endian.h>
42*9663SMark.Logan@Sun.COM #endif
43*9663SMark.Logan@Sun.COM #ifdef HAVE_SYS_ENDIAN_H
44*9663SMark.Logan@Sun.COM #include <sys/endian.h>
45*9663SMark.Logan@Sun.COM #endif
46*9663SMark.Logan@Sun.COM #ifdef HAVE_MACHINE_ENDIAN_H
47*9663SMark.Logan@Sun.COM #include <machine/endian.h>
48*9663SMark.Logan@Sun.COM #endif
49*9663SMark.Logan@Sun.COM #ifdef HAVE_SYS_BYTEORDER_H
50*9663SMark.Logan@Sun.COM #include <sys/byteorder.h>
51*9663SMark.Logan@Sun.COM #endif
52*9663SMark.Logan@Sun.COM #ifdef HAVE_SYS_PARAM_H
53*9663SMark.Logan@Sun.COM #include <sys/param.h>
54*9663SMark.Logan@Sun.COM #endif
55*9663SMark.Logan@Sun.COM 
56*9663SMark.Logan@Sun.COM #ifndef __BYTE_ORDER
57*9663SMark.Logan@Sun.COM #	if defined(_BYTE_ORDER)
58*9663SMark.Logan@Sun.COM #		define __BYTE_ORDER _BYTE_ORDER
59*9663SMark.Logan@Sun.COM #		define __LITTLE_ENDIAN _LITTLE_ENDIAN
60*9663SMark.Logan@Sun.COM #		define __BIG_ENDIAN _BIG_ENDIAN
61*9663SMark.Logan@Sun.COM #	elif defined(BYTE_ORDER)
62*9663SMark.Logan@Sun.COM #		define __BYTE_ORDER BYTE_ORDER
63*9663SMark.Logan@Sun.COM #		define __LITTLE_ENDIAN LITTLE_ENDIAN
64*9663SMark.Logan@Sun.COM #		define __BIG_ENDIAN BIG_ENDIAN
65*9663SMark.Logan@Sun.COM #	elif defined(__BYTE_ORDER__)
66*9663SMark.Logan@Sun.COM #		define __BYTE_ORDER __BYTE_ORDER__
67*9663SMark.Logan@Sun.COM #		define __LITTLE_ENDIAN __LITTLE_ENDIAN__
68*9663SMark.Logan@Sun.COM #		define __BIG_ENDIAN __BIG_ENDIAN__
69*9663SMark.Logan@Sun.COM #	elif (defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)) || \
70*9663SMark.Logan@Sun.COM 			defined(WORDS_LITTLEENDIAN)
71*9663SMark.Logan@Sun.COM #		define __BYTE_ORDER 1
72*9663SMark.Logan@Sun.COM #		define __LITTLE_ENDIAN 1
73*9663SMark.Logan@Sun.COM #		define __BIG_ENDIAN 0
74*9663SMark.Logan@Sun.COM #	elif (!defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN)) || \
75*9663SMark.Logan@Sun.COM 			defined(WORDS_BIGENDIAN)
76*9663SMark.Logan@Sun.COM #		define __BYTE_ORDER 0
77*9663SMark.Logan@Sun.COM #		define __LITTLE_ENDIAN 1
78*9663SMark.Logan@Sun.COM #		define __BIG_ENDIAN 0
79*9663SMark.Logan@Sun.COM #	else
80*9663SMark.Logan@Sun.COM #		error "__BYTE_ORDER is not defined."
81*9663SMark.Logan@Sun.COM #	endif
82*9663SMark.Logan@Sun.COM #endif
83*9663SMark.Logan@Sun.COM 
84*9663SMark.Logan@Sun.COM #define __ntfs_bswap_constant_16(x)		\
85*9663SMark.Logan@Sun.COM 	  (u16)((((u16)(x) & 0xff00) >> 8) |	\
86*9663SMark.Logan@Sun.COM 		(((u16)(x) & 0x00ff) << 8))
87*9663SMark.Logan@Sun.COM 
88*9663SMark.Logan@Sun.COM #define __ntfs_bswap_constant_32(x)			\
89*9663SMark.Logan@Sun.COM 	  (u32)((((u32)(x) & 0xff000000u) >> 24) |	\
90*9663SMark.Logan@Sun.COM 		(((u32)(x) & 0x00ff0000u) >>  8) |	\
91*9663SMark.Logan@Sun.COM 		(((u32)(x) & 0x0000ff00u) <<  8) |	\
92*9663SMark.Logan@Sun.COM 		(((u32)(x) & 0x000000ffu) << 24))
93*9663SMark.Logan@Sun.COM 
94*9663SMark.Logan@Sun.COM #define __ntfs_bswap_constant_64(x)				\
95*9663SMark.Logan@Sun.COM 	  (u64)((((u64)(x) & 0xff00000000000000ull) >> 56) |	\
96*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x00ff000000000000ull) >> 40) |	\
97*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x0000ff0000000000ull) >> 24) |	\
98*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x000000ff00000000ull) >>  8) |	\
99*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x00000000ff000000ull) <<  8) |	\
100*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x0000000000ff0000ull) << 24) |	\
101*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x000000000000ff00ull) << 40) |	\
102*9663SMark.Logan@Sun.COM 		(((u64)(x) & 0x00000000000000ffull) << 56))
103*9663SMark.Logan@Sun.COM 
104*9663SMark.Logan@Sun.COM #ifdef HAVE_BYTESWAP_H
105*9663SMark.Logan@Sun.COM #	include <byteswap.h>
106*9663SMark.Logan@Sun.COM #else
107*9663SMark.Logan@Sun.COM #	define bswap_16(x) __ntfs_bswap_constant_16(x)
108*9663SMark.Logan@Sun.COM #	define bswap_32(x) __ntfs_bswap_constant_32(x)
109*9663SMark.Logan@Sun.COM #	define bswap_64(x) __ntfs_bswap_constant_64(x)
110*9663SMark.Logan@Sun.COM #endif
111*9663SMark.Logan@Sun.COM 
112*9663SMark.Logan@Sun.COM #if defined(__LITTLE_ENDIAN) && (__BYTE_ORDER == __LITTLE_ENDIAN)
113*9663SMark.Logan@Sun.COM 
114*9663SMark.Logan@Sun.COM #define __le16_to_cpu(x) ((__force u16)(x))
115*9663SMark.Logan@Sun.COM #define __le32_to_cpu(x) ((__force u32)(x))
116*9663SMark.Logan@Sun.COM #define __le64_to_cpu(x) ((__force u64)(x))
117*9663SMark.Logan@Sun.COM 
118*9663SMark.Logan@Sun.COM #define __cpu_to_le16(x) ((__force le16)(x))
119*9663SMark.Logan@Sun.COM #define __cpu_to_le32(x) ((__force le32)(x))
120*9663SMark.Logan@Sun.COM #define __cpu_to_le64(x) ((__force le64)(x))
121*9663SMark.Logan@Sun.COM 
122*9663SMark.Logan@Sun.COM #define __constant_le16_to_cpu(x) ((__force u16)(x))
123*9663SMark.Logan@Sun.COM #define __constant_le32_to_cpu(x) ((__force u32)(x))
124*9663SMark.Logan@Sun.COM #define __constant_le64_to_cpu(x) ((__force u64)(x))
125*9663SMark.Logan@Sun.COM 
126*9663SMark.Logan@Sun.COM #define __constant_cpu_to_le16(x) ((__force le16)(x))
127*9663SMark.Logan@Sun.COM #define __constant_cpu_to_le32(x) ((__force le32)(x))
128*9663SMark.Logan@Sun.COM #define __constant_cpu_to_le64(x) ((__force le64)(x))
129*9663SMark.Logan@Sun.COM 
130*9663SMark.Logan@Sun.COM #elif defined(__BIG_ENDIAN) && (__BYTE_ORDER == __BIG_ENDIAN)
131*9663SMark.Logan@Sun.COM 
132*9663SMark.Logan@Sun.COM #define __le16_to_cpu(x) bswap_16((__force u16)(x))
133*9663SMark.Logan@Sun.COM #define __le32_to_cpu(x) bswap_32((__force u16)(x))
134*9663SMark.Logan@Sun.COM #define __le64_to_cpu(x) bswap_64((__force u16)(x))
135*9663SMark.Logan@Sun.COM 
136*9663SMark.Logan@Sun.COM #define __cpu_to_le16(x) (__force le16)bswap_16((__force u16)(x))
137*9663SMark.Logan@Sun.COM #define __cpu_to_le32(x) (__force le32)bswap_32((__force u32)(x))
138*9663SMark.Logan@Sun.COM #define __cpu_to_le64(x) (__force le64)bswap_64((__force u64)(x))
139*9663SMark.Logan@Sun.COM 
140*9663SMark.Logan@Sun.COM #define __constant_le16_to_cpu(x) __ntfs_bswap_constant_16((__force u16)(x))
141*9663SMark.Logan@Sun.COM #define __constant_le32_to_cpu(x) __ntfs_bswap_constant_32((__force u32)(x))
142*9663SMark.Logan@Sun.COM #define __constant_le64_to_cpu(x) __ntfs_bswap_constant_64((__force u64)(x))
143*9663SMark.Logan@Sun.COM 
144*9663SMark.Logan@Sun.COM #define __constant_cpu_to_le16(x) \
145*9663SMark.Logan@Sun.COM 	(__force le16)__ntfs_bswap_constant_16((__force u16)(x))
146*9663SMark.Logan@Sun.COM #define __constant_cpu_to_le32(x) \
147*9663SMark.Logan@Sun.COM 	(__force le32)__ntfs_bswap_constant_32((__force u32)(x))
148*9663SMark.Logan@Sun.COM #define __constant_cpu_to_le64(x) \
149*9663SMark.Logan@Sun.COM 	(__force le64)__ntfs_bswap_constant_64((__force u64)(x))
150*9663SMark.Logan@Sun.COM 
151*9663SMark.Logan@Sun.COM #else
152*9663SMark.Logan@Sun.COM 
153*9663SMark.Logan@Sun.COM #error "You must define __BYTE_ORDER to be __LITTLE_ENDIAN or __BIG_ENDIAN."
154*9663SMark.Logan@Sun.COM 
155*9663SMark.Logan@Sun.COM #endif
156*9663SMark.Logan@Sun.COM 
157*9663SMark.Logan@Sun.COM /* Unsigned from LE to CPU conversion. */
158*9663SMark.Logan@Sun.COM 
159*9663SMark.Logan@Sun.COM #define le16_to_cpu(x)		(u16)__le16_to_cpu((le16)(x))
160*9663SMark.Logan@Sun.COM #define le32_to_cpu(x)		(u32)__le32_to_cpu((le32)(x))
161*9663SMark.Logan@Sun.COM #define le64_to_cpu(x)		(u64)__le64_to_cpu((le64)(x))
162*9663SMark.Logan@Sun.COM 
163*9663SMark.Logan@Sun.COM #define le16_to_cpup(x)		(u16)__le16_to_cpu(*(const le16*)(x))
164*9663SMark.Logan@Sun.COM #define le32_to_cpup(x)		(u32)__le32_to_cpu(*(const le32*)(x))
165*9663SMark.Logan@Sun.COM #define le64_to_cpup(x)		(u64)__le64_to_cpu(*(const le64*)(x))
166*9663SMark.Logan@Sun.COM 
167*9663SMark.Logan@Sun.COM /* Signed from LE to CPU conversion. */
168*9663SMark.Logan@Sun.COM 
169*9663SMark.Logan@Sun.COM #define sle16_to_cpu(x)		(s16)__le16_to_cpu((sle16)(x))
170*9663SMark.Logan@Sun.COM #define sle32_to_cpu(x)		(s32)__le32_to_cpu((sle32)(x))
171*9663SMark.Logan@Sun.COM #define sle64_to_cpu(x)		(s64)__le64_to_cpu((sle64)(x))
172*9663SMark.Logan@Sun.COM 
173*9663SMark.Logan@Sun.COM #define sle16_to_cpup(x)	(s16)__le16_to_cpu(*(const sle16*)(x))
174*9663SMark.Logan@Sun.COM #define sle32_to_cpup(x)	(s32)__le32_to_cpu(*(const sle32*)(x))
175*9663SMark.Logan@Sun.COM #define sle64_to_cpup(x)	(s64)__le64_to_cpu(*(const sle64*)(x))
176*9663SMark.Logan@Sun.COM 
177*9663SMark.Logan@Sun.COM /* Unsigned from CPU to LE conversion. */
178*9663SMark.Logan@Sun.COM 
179*9663SMark.Logan@Sun.COM #define cpu_to_le16(x)		(le16)__cpu_to_le16((u16)(x))
180*9663SMark.Logan@Sun.COM #define cpu_to_le32(x)		(le32)__cpu_to_le32((u32)(x))
181*9663SMark.Logan@Sun.COM #define cpu_to_le64(x)		(le64)__cpu_to_le64((u64)(x))
182*9663SMark.Logan@Sun.COM 
183*9663SMark.Logan@Sun.COM #define cpu_to_le16p(x)		(le16)__cpu_to_le16(*(const u16*)(x))
184*9663SMark.Logan@Sun.COM #define cpu_to_le32p(x)		(le32)__cpu_to_le32(*(const u32*)(x))
185*9663SMark.Logan@Sun.COM #define cpu_to_le64p(x)		(le64)__cpu_to_le64(*(const u64*)(x))
186*9663SMark.Logan@Sun.COM 
187*9663SMark.Logan@Sun.COM /* Signed from CPU to LE conversion. */
188*9663SMark.Logan@Sun.COM 
189*9663SMark.Logan@Sun.COM #define cpu_to_sle16(x)		(__force sle16)__cpu_to_le16((s16)(x))
190*9663SMark.Logan@Sun.COM #define cpu_to_sle32(x)		(__force sle32)__cpu_to_le32((s32)(x))
191*9663SMark.Logan@Sun.COM #define cpu_to_sle64(x)		(__force sle64)__cpu_to_le64((s64)(x))
192*9663SMark.Logan@Sun.COM 
193*9663SMark.Logan@Sun.COM #define cpu_to_sle16p(x)	(__force sle16)__cpu_to_le16(*(const s16*)(x))
194*9663SMark.Logan@Sun.COM #define cpu_to_sle32p(x)	(__force sle32)__cpu_to_le32(*(const s32*)(x))
195*9663SMark.Logan@Sun.COM #define cpu_to_sle64p(x)	(__force sle64)__cpu_to_le64(*(const s64*)(x))
196*9663SMark.Logan@Sun.COM 
197*9663SMark.Logan@Sun.COM /* Constant endianness conversion defines. */
198*9663SMark.Logan@Sun.COM 
199*9663SMark.Logan@Sun.COM #define const_le16_to_cpu(x)	(u16)__constant_le16_to_cpu((le16)(x))
200*9663SMark.Logan@Sun.COM #define const_le32_to_cpu(x)	(u32)__constant_le32_to_cpu((le32)(x))
201*9663SMark.Logan@Sun.COM #define const_le64_to_cpu(x)	(u64)__constant_le64_to_cpu((le64)(x))
202*9663SMark.Logan@Sun.COM 
203*9663SMark.Logan@Sun.COM #define const_cpu_to_le16(x)	(le16)__constant_cpu_to_le16((u16)(x))
204*9663SMark.Logan@Sun.COM #define const_cpu_to_le32(x)	(le32)__constant_cpu_to_le32((u32)(x))
205*9663SMark.Logan@Sun.COM #define const_cpu_to_le64(x)	(le64)__constant_cpu_to_le64((u64)(x))
206*9663SMark.Logan@Sun.COM 
207*9663SMark.Logan@Sun.COM #ifdef __CHECKER__
ntfs_endian_self_test(void)208*9663SMark.Logan@Sun.COM static void ntfs_endian_self_test(void)
209*9663SMark.Logan@Sun.COM {
210*9663SMark.Logan@Sun.COM 	/* Should not generate warnings. */
211*9663SMark.Logan@Sun.COM 	(le16)cpu_to_le16((u16)1);
212*9663SMark.Logan@Sun.COM 	(le32)cpu_to_le32((u32)1);
213*9663SMark.Logan@Sun.COM 	(le64)cpu_to_le64((u64)1);
214*9663SMark.Logan@Sun.COM 	(sle16)cpu_to_sle16((s16)1);
215*9663SMark.Logan@Sun.COM 	(sle32)cpu_to_sle32((s32)1);
216*9663SMark.Logan@Sun.COM 	(sle64)cpu_to_sle64((s64)1);
217*9663SMark.Logan@Sun.COM 	(u16)le16_to_cpu((__force le16)1);
218*9663SMark.Logan@Sun.COM 	(u32)le32_to_cpu((__force le32)1);
219*9663SMark.Logan@Sun.COM 	(u64)le64_to_cpu((__force le64)1);
220*9663SMark.Logan@Sun.COM 	(s16)sle16_to_cpu((__force sle16)1);
221*9663SMark.Logan@Sun.COM 	(s32)sle32_to_cpu((__force sle32)1);
222*9663SMark.Logan@Sun.COM 	(s64)sle64_to_cpu((__force sle64)1);
223*9663SMark.Logan@Sun.COM 	(le16)const_cpu_to_le16((u16)1);
224*9663SMark.Logan@Sun.COM 	(le32)const_cpu_to_le32((u32)1);
225*9663SMark.Logan@Sun.COM 	(le64)const_cpu_to_le64((u64)1);
226*9663SMark.Logan@Sun.COM 	(u16)const_le16_to_cpu((__force le16)1);
227*9663SMark.Logan@Sun.COM 	(u32)const_le32_to_cpu((__force le32)1);
228*9663SMark.Logan@Sun.COM 	(u64)const_le64_to_cpu((__force le64)1);
229*9663SMark.Logan@Sun.COM 
230*9663SMark.Logan@Sun.COM 	/*
231*9663SMark.Logan@Sun.COM 	 * TODO: Need some how to test that warnings are actually generated,
232*9663SMark.Logan@Sun.COM 	 * but without flooding output with them and vice-versa print warning
233*9663SMark.Logan@Sun.COM 	 * in case if some one warning is not triggered, but should.  (Yura)
234*9663SMark.Logan@Sun.COM 	 *
235*9663SMark.Logan@Sun.COM 	 * I think it can only be done in  a ./configure like script / shell
236*9663SMark.Logan@Sun.COM 	 * script that will compile known good  and known bad code and pipe the
237*9663SMark.Logan@Sun.COM 	 * output from sparse to a file, then  grep the file for the wanted
238*9663SMark.Logan@Sun.COM 	 * warnings/lack thereof and then it would  say "Tests: PASS " or
239*9663SMark.Logan@Sun.COM 	 * "Tests: FAILED" or whatever.  And you can then  hook that into a
240*9663SMark.Logan@Sun.COM 	 * "make test" make target or similar so it is only  done when one
241*9663SMark.Logan@Sun.COM 	 * wants to do it...  (Anton)
242*9663SMark.Logan@Sun.COM 	 *
243*9663SMark.Logan@Sun.COM 	 * Also we can look on sparse self test script.  (Yura)
244*9663SMark.Logan@Sun.COM 	 */
245*9663SMark.Logan@Sun.COM }
246*9663SMark.Logan@Sun.COM #endif
247*9663SMark.Logan@Sun.COM 
248*9663SMark.Logan@Sun.COM #endif /* defined _NTFS_ENDIANS_H */
249