chiark / gitweb /
Fix for new Automake.
[mLib] / bits.h
CommitLineData
6b033bc4 1/* -*-c-*-
2 *
5892fd39 3 * $Id$
6b033bc4 4 *
5 * Portable bit-level manipulation macros
6 *
7 * (c) 1998 Straylight/Edgeware
8 */
9
10/*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of the mLib utilities library.
13 *
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
18 *
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
23 *
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27 * MA 02111-1307, USA.
28 */
29
c6e0eaf0 30#ifndef MLIB_BITS_H
31#define MLIB_BITS_H
6b033bc4 32
33#ifdef __cplusplus
34 extern "C" {
35#endif
36
37/*----- Header files ------------------------------------------------------*/
38
39#include <limits.h>
40#include <stddef.h>
a6f4a484 41#if __STDC_VERSION__ >= 199900l
42# include <stdint.h>
43#endif
6b033bc4 44
45/*----- Decide on some types ----------------------------------------------*/
46
1f175471 47/* --- Make GNU C shut up --- */
48
49#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 91)
50# define MLIB_BITS_EXTENSION __extension__
51#else
52# define MLIB_BITS_EXTENSION
53#endif
54
6b033bc4 55/* --- Decide on a 32-bit type --- *
56 *
57 * I want a type which is capable of expressing 32-bit numbers. Because some
58 * implementations have 64-bit @long@s (infinitely preferable to the abortion
59 * that is @long long@), using @unsigned long@ regardless is wasteful. So,
60 * if @int@ appears to be good enough, then I'll go with that.
61 */
62
63#if UINT_MAX >= 0xffffffffu
64 typedef unsigned int uint32;
65#else
66 typedef unsigned long uint32;
67#endif
68
a6f4a484 69/* --- Decide on a 64-bit type --- *
70 *
71 * The test is quite subtle. Think about it. Note that (at least on my
72 * machine), the 32-bit macros are *much* faster than GCC's @long long@
73 * support.
74 */
75
76#if defined(ULONG_LONG_MAX) && !defined(ULLONG_MAX)
77# define ULLONG_MAX ULONG_LONG_MAX
78#endif
79
80#if UINT_MAX >> 31 > 0xffffffff
1f175471 81# define HAVE_UINT64
82 typedef unsigned int uint64;
a6f4a484 83#elif ULONG_MAX >> 31 > 0xffffffff
1f175471 84# define HAVE_UINT64
85 typedef unsigned long uint64;
a6f4a484 86#elif defined(ULLONG_MAX)
1f175471 87# define HAVE_UINT64
88 MLIB_BITS_EXTENSION typedef unsigned long long uint64;
a6f4a484 89#endif
90
91#ifdef DEBUG64
92# undef HAVE_UINT64
93#endif
94
95#ifdef HAVE_UINT64
96 typedef struct { uint64 i; } kludge64;
97#else
98 typedef struct { uint32 hi, lo; } kludge64;
99#endif
100
6a0129ea 101/* --- Decide on a 24-bit type --- */
102
103#if UINT_MAX >= 0x00ffffffu
104 typedef unsigned int uint24;
105#else
106 typedef unsigned long uint24;
107#endif
108
6b033bc4 109/* --- Decide on 16-bit and 8-bit types --- *
110 *
111 * This is more for brevity than anything else.
112 */
113
114typedef unsigned short uint16;
115typedef unsigned char octet;
116
117/* --- WARNING! --- *
118 *
119 * Never lose sight of the fact that the above types may be wider than the
120 * names suggest. Some architectures have 32-bit @short@s for example.
121 */
122
123/*----- Macros ------------------------------------------------------------*/
124
125/* --- Useful masks --- */
126
127#define MASK8 0xffu
128#define MASK16 0xffffu
6a0129ea 129#define MASK24 0xffffffu
6b033bc4 130#define MASK32 0xffffffffu
131
a6f4a484 132#ifdef HAVE_UINT64
1f175471 133# define MASK64 MLIB_BITS_EXTENSION 0xffffffffffffffffu
a6f4a484 134#endif
135
6b033bc4 136/* --- Type coercions --- */
137
138#define U8(x) ((octet)((x) & MASK8))
139#define U16(x) ((uint16)((x) & MASK16))
6a0129ea 140#define U24(x) ((uint24)((x) & MASK24))
6b033bc4 141#define U32(x) ((uint32)((x) & MASK32))
142
a6f4a484 143#ifdef HAVE_UINT64
144# define U64(x) ((uint64)(x) & MASK64)
145# define U64_(d, x) ((d).i = U64(x).i)
146#else
147# define U64_(d, x) ((d).hi = U32((x).hi), (d).lo = U32((x).lo))
148#endif
149
6b033bc4 150/* --- Safe shifting macros --- */
151
bc9f60b6 152#define LSL8(v, s) U8(U8(v) << ((s) & 7u))
153#define LSR8(v, s) U8(U8(v) >> ((s) & 7u))
154#define LSL16(v, s) U16(U16(v) << ((s) & 15u))
155#define LSR16(v, s) U16(U16(v) >> ((s) & 15u))
6a0129ea 156#define LSL24(v, s) U24(U24(v) << ((s) % 24u))
157#define LSR24(v, s) U24(U24(v) >> ((s) % 24u))
bc9f60b6 158#define LSL32(v, s) U32(U32(v) << ((s) & 31u))
159#define LSR32(v, s) U32(U32(v) >> ((s) & 31u))
6b033bc4 160
a6f4a484 161#ifdef HAVE_UINT64
162# define LSL64(v, s) U64(U64(v) << ((s) & 63u))
163# define LSR64(v, s) U64(U64(v) >> ((s) & 63u))
164# define LSL64_(d, v, s) ((d).i = LSL64((v).i, (s)))
165# define LSR64_(d, v, s) ((d).i = LSR64((v).i, (s)))
166#else
167# define LSL64_(d, v, s) do { \
168 unsigned _s = (s) & 63u; \
169 uint32 _l = (v).lo, _h = (v).hi; \
170 kludge64 *_d = &(d); \
171 if (_s >= 32) { \
172 _d->hi = LSL32(_l, _s - 32u); \
173 _d->lo = 0; \
174 } else if (!_s) { \
175 _d->lo = _l; \
176 _d->hi = _h; \
177 } else { \
178 _d->hi = LSL32(_h, _s) | LSR32(_l, 32u - _s); \
179 _d->lo = LSL32(_l, _s); \
180 } \
181 } while (0)
182# define LSR64_(d, v, s) do { \
183 unsigned _s = (s) & 63u; \
184 uint32 _l = (v).lo, _h = (v).hi; \
185 kludge64 *_d = &(d); \
186 if (_s >= 32) { \
187 _d->lo = LSR32(_h, _s - 32u); \
188 _d->hi = 0; \
189 } else if (!_s) { \
190 _d->lo = _l; \
191 _d->hi = _h; \
192 } else { \
193 _d->lo = LSR32(_l, _s) | LSL32(_h, 32u - _s); \
194 _d->hi = LSR32(_h, _s); \
195 } \
196 } while (0)
197#endif
198
6b033bc4 199/* --- Rotation macros --- */
200
bc9f60b6 201#define ROL8(v, s) (LSL8((v), (s)) | (LSR8((v), 8u - (s))))
202#define ROR8(v, s) (LSR8((v), (s)) | (LSL8((v), 8u - (s))))
203#define ROL16(v, s) (LSL16((v), (s)) | (LSR16((v), 16u - (s))))
204#define ROR16(v, s) (LSR16((v), (s)) | (LSL16((v), 16u - (s))))
6a0129ea 205#define ROL24(v, s) (LSL24((v), (s)) | (LSR24((v), 24u - (s))))
206#define ROR24(v, s) (LSR24((v), (s)) | (LSL24((v), 24u - (s))))
bc9f60b6 207#define ROL32(v, s) (LSL32((v), (s)) | (LSR32((v), 32u - (s))))
208#define ROR32(v, s) (LSR32((v), (s)) | (LSL32((v), 32u - (s))))
6b033bc4 209
a6f4a484 210#ifdef HAVE_UINT64
211# define ROL64(v, s) (LSL64((v), (s)) | (LSR64((v), 64u - (s))))
212# define ROR64(v, s) (LSR64((v), (s)) | (LSL64((v), 64u - (s))))
213# define ROL64_(d, v, s) ((d).i = ROL64((v).i, (s)))
214# define ROR64_(d, v, s) ((d).i = ROR64((v).i, (s)))
215#else
216# define ROL64_(d, v, s) do { \
217 unsigned _s = (s) & 63u; \
218 uint32 _l = (v).lo, _h = (v).hi; \
219 kludge64 *_d = &(d); \
5892fd39 220 if (_s > 32) { \
a6f4a484 221 _d->hi = LSL32(_l, _s - 32u) | LSR32(_h, 64u - _s); \
222 _d->lo = LSL32(_h, _s - 32u) | LSR32(_l, 64u - _s); \
223 } else if (!_s) { \
224 _d->lo = _l; \
225 _d->hi = _h; \
5892fd39 226 } else if (_s == 32) { \
227 _d->lo = _h; \
228 _d->hi = _l; \
a6f4a484 229 } else { \
230 _d->hi = LSL32(_h, _s) | LSR32(_l, 32u - _s); \
231 _d->lo = LSL32(_l, _s) | LSR32(_h, 32u - _s); \
232 } \
233 } while (0)
234# define ROR64_(d, v, s) do { \
235 unsigned _s = (s) & 63u; \
236 uint32 _l = (v).lo, _h = (v).hi; \
237 kludge64 *_d = &(d); \
5892fd39 238 if (_s > 32) { \
a6f4a484 239 _d->hi = LSR32(_l, _s - 32u) | LSL32(_h, 64u - _s); \
240 _d->lo = LSR32(_h, _s - 32u) | LSL32(_l, 64u - _s); \
241 } else if (!_s) { \
242 _d->lo = _l; \
243 _d->hi = _h; \
5892fd39 244 } else if (_s == 32) { \
245 _d->lo = _h; \
246 _d->hi = _l; \
a6f4a484 247 } else { \
248 _d->hi = LSR32(_h, _s) | LSL32(_l, 32u - _s); \
249 _d->lo = LSR32(_l, _s) | LSL32(_h, 32u - _s); \
250 } \
251 } while (0)
252#endif
253
6b033bc4 254/* --- Storage and retrieval --- */
255
256#define GETBYTE(p, o) (((octet *)(p))[o] & MASK8)
257#define PUTBYTE(p, o, v) (((octet *)(p))[o] = U8((v)))
258
259#define LOAD8(p) (GETBYTE((p), 0))
260#define STORE8(p, v) (PUTBYTE((p), 0, (v)))
261
0d4e268a 262#define LOAD16_B(p) \
263 (((uint16)GETBYTE((p), 0) << 8) | \
264 ((uint16)GETBYTE((p), 1) << 0))
265#define LOAD16_L(p) \
266 (((uint16)GETBYTE((p), 0) << 0) | \
267 ((uint16)GETBYTE((p), 1) << 8))
6b033bc4 268#define LOAD16(p) LOAD16_B((p))
269
0d4e268a 270#define STORE16_B(p, v) \
271 (PUTBYTE((p), 0, (uint16)(v) >> 8), \
272 PUTBYTE((p), 1, (uint16)(v) >> 0))
273#define STORE16_L(p, v) \
274 (PUTBYTE((p), 0, (uint16)(v) >> 0), \
275 PUTBYTE((p), 1, (uint16)(v) >> 8))
6b033bc4 276#define STORE16(p, v) STORE16_B((p), (v))
277
6a0129ea 278#define LOAD24_B(p) \
279 (((uint24)GETBYTE((p), 0) << 16) | \
280 ((uint24)GETBYTE((p), 1) << 8) | \
281 ((uint24)GETBYTE((p), 2) << 0))
282#define LOAD24_L(p) \
283 (((uint24)GETBYTE((p), 0) << 0) | \
284 ((uint24)GETBYTE((p), 1) << 8) | \
285 ((uint24)GETBYTE((p), 2) << 16))
286#define LOAD24(p) LOAD24_B((p))
287
288#define STORE24_B(p, v) \
289 (PUTBYTE((p), 0, (uint24)(v) >> 16), \
290 PUTBYTE((p), 1, (uint24)(v) >> 8), \
291 PUTBYTE((p), 2, (uint24)(v) >> 0))
292#define STORE24_L(p, v) \
293 (PUTBYTE((p), 0, (uint24)(v) >> 0), \
294 PUTBYTE((p), 1, (uint24)(v) >> 8), \
295 PUTBYTE((p), 2, (uint24)(v) >> 16))
296#define STORE24(p, v) STORE24_B((p), (v))
297
6b033bc4 298#define LOAD32_B(p) \
0d4e268a 299 (((uint32)GETBYTE((p), 0) << 24) | \
300 ((uint32)GETBYTE((p), 1) << 16) | \
301 ((uint32)GETBYTE((p), 2) << 8) | \
302 ((uint32)GETBYTE((p), 3) << 0))
6b033bc4 303#define LOAD32_L(p) \
0d4e268a 304 (((uint32)GETBYTE((p), 0) << 0) | \
305 ((uint32)GETBYTE((p), 1) << 8) | \
306 ((uint32)GETBYTE((p), 2) << 16) | \
307 ((uint32)GETBYTE((p), 3) << 24))
6b033bc4 308#define LOAD32(p) LOAD32_B((p))
309
310#define STORE32_B(p, v) \
0d4e268a 311 (PUTBYTE((p), 0, (uint32)(v) >> 24), \
312 PUTBYTE((p), 1, (uint32)(v) >> 16), \
313 PUTBYTE((p), 2, (uint32)(v) >> 8), \
314 PUTBYTE((p), 3, (uint32)(v) >> 0))
6b033bc4 315#define STORE32_L(p, v) \
0d4e268a 316 (PUTBYTE((p), 0, (uint32)(v) >> 0), \
317 PUTBYTE((p), 1, (uint32)(v) >> 8), \
318 PUTBYTE((p), 2, (uint32)(v) >> 16), \
319 PUTBYTE((p), 3, (uint32)(v) >> 24))
6b033bc4 320#define STORE32(p, v) STORE32_B((p), (v))
321
a6f4a484 322#ifdef HAVE_UINT64
323
324# define LOAD64_B(p) \
325 (((uint64)GETBYTE((p), 0) << 56) | \
326 ((uint64)GETBYTE((p), 1) << 48) | \
327 ((uint64)GETBYTE((p), 2) << 40) | \
328 ((uint64)GETBYTE((p), 3) << 32) | \
329 ((uint64)GETBYTE((p), 4) << 24) | \
330 ((uint64)GETBYTE((p), 5) << 16) | \
331 ((uint64)GETBYTE((p), 6) << 8) | \
332 ((uint64)GETBYTE((p), 7) << 0))
333# define LOAD64_L(p) \
334 (((uint64)GETBYTE((p), 0) << 0) | \
335 ((uint64)GETBYTE((p), 1) << 8) | \
336 ((uint64)GETBYTE((p), 2) << 16) | \
337 ((uint64)GETBYTE((p), 3) << 24) | \
338 ((uint64)GETBYTE((p), 4) << 32) | \
339 ((uint64)GETBYTE((p), 5) << 40) | \
340 ((uint64)GETBYTE((p), 6) << 48) | \
341 ((uint64)GETBYTE((p), 7) << 56))
342# define LOAD64(p) LOAD64_B((p))
343# define LOAD64_B_(d, p) ((d).i = LOAD64_B((p)))
344# define LOAD64_L_(d, p) ((d).i = LOAD64_L((p)))
345# define LOAD64_(d, p) LOAD64_B_((d), (p))
346
347# define STORE64_B(p, v) \
348 (PUTBYTE((p), 0, (uint64)(v) >> 56), \
349 PUTBYTE((p), 1, (uint64)(v) >> 48), \
350 PUTBYTE((p), 2, (uint64)(v) >> 40), \
351 PUTBYTE((p), 3, (uint64)(v) >> 32), \
352 PUTBYTE((p), 4, (uint64)(v) >> 24), \
353 PUTBYTE((p), 5, (uint64)(v) >> 16), \
354 PUTBYTE((p), 6, (uint64)(v) >> 8), \
355 PUTBYTE((p), 7, (uint64)(v) >> 0))
356# define STORE64_L(p, v) \
357 (PUTBYTE((p), 0, (uint64)(v) >> 0), \
358 PUTBYTE((p), 1, (uint64)(v) >> 8), \
359 PUTBYTE((p), 2, (uint64)(v) >> 16), \
360 PUTBYTE((p), 3, (uint64)(v) >> 24), \
361 PUTBYTE((p), 4, (uint64)(v) >> 32), \
362 PUTBYTE((p), 5, (uint64)(v) >> 40), \
363 PUTBYTE((p), 6, (uint64)(v) >> 48), \
364 PUTBYTE((p), 7, (uint64)(v) >> 56))
365# define STORE64(p, v) STORE64_B((p), (v))
366# define STORE64_B_(p, v) STORE64_B((p), (v).i)
367# define STORE64_L_(p, v) STORE64_L((p), (v).i)
368# define STORE64_(p, v) STORE64_B_((p), (v))
369
370#else
371
372# define LOAD64_B_(d, p) \
373 ((d).hi = LOAD32_B((octet *)(p) + 0), \
374 (d).lo = LOAD32_B((octet *)(p) + 4))
375# define LOAD64_L_(d, p) \
376 ((d).lo = LOAD32_L((octet *)(p) + 0), \
377 (d).hi = LOAD32_L((octet *)(p) + 4))
378# define LOAD64_(d, p) LOAD64_B_((d), (p))
379
380# define STORE64_B_(p, v) \
381 (STORE32_B((octet *)(p) + 0, (v).hi), \
382 STORE32_B((octet *)(p) + 4, (v).lo))
383# define STORE64_L_(p, v) \
384 (STORE32_L((octet *)(p) + 0, (v).lo), \
385 STORE32_L((octet *)(p) + 4, (v).hi))
386# define STORE64_(p, v) STORE64_B_((p), (v))
387
388#endif
389
390/* --- Other operations on 64-bit integers --- */
391
392#ifdef HAVE_UINT64
393# define SET64(d, h, l) ((d).i = (U64((h)) << 32) | U64((l)))
394# define ASSIGN64(d, x) ((d).i = U64((x)))
395# define HI64(x) U32((x).i >> 32)
396# define LO64(x) U32((x).i)
3b7cea93 397# define GET64(t, x) ((t)(x).i)
a6f4a484 398#else
399# define SET64(d, h, l) ((d).hi = U32(h), (d).lo = U32(l))
400# define ASSIGN64(d, x) \
401 ((d).hi = ((x & ~MASK32) >> 16) >> 16, (d).lo = U32(x))
402# define HI64(x) U32((x).hi)
403# define LO64(x) U32((x).lo)
3b7cea93 404# define GET64(t, x) (((((t)HI64(x) << 16) << 16) & ~MASK32) | (t)LO64(x))
a6f4a484 405#endif
406
407#ifdef HAVE_UINT64
408# define AND64(d, x, y) ((d).i = (x).i & (y).i)
409# define OR64(d, x, y) ((d).i = (x).i | (y).i)
410# define XOR64(d, x, y) ((d).i = (x).i ^ (y).i)
411# define CPL64(d, x) ((d).i = ~(x).i)
412# define ADD64(d, x, y) ((d).i = (x).i + (y).i)
413# define SUB64(d, x, y) ((d).i = (x).i - (y).i)
414# define CMP64(x, op, y) ((x).i op (y).i)
415# define ZERO64(x) ((x) == 0)
416#else
417# define AND64(d, x, y) ((d).lo = (x).lo & (y).lo, (d).hi = (x).hi & (y).hi)
418# define OR64(d, x, y) ((d).lo = (x).lo | (y).lo, (d).hi = (x).hi | (y).hi)
419# define XOR64(d, x, y) ((d).lo = (x).lo ^ (y).lo, (d).hi = (x).hi ^ (y).hi)
420# define CPL64(d, x) ((d).lo = ~(x).lo, (d).hi = ~(x).hi)
421# define ADD64(d, x, y) do { \
422 uint32 _x = U32((x).lo + (y).lo); \
423 (d).hi = (x).hi + (y).hi + (_x < (x).lo); \
424 (d).lo = _x; \
425 } while (0)
426# define SUB64(d, x, y) do { \
427 uint32 _x = U32((x).lo - (y).lo); \
428 (d).hi = (x).hi - (y).hi - (_x > (x).lo); \
429 (d).lo = _x; \
430 } while (0)
431# define CMP64(x, op, y) \
432 ((x).hi == (y).hi ? (x).lo op (y).lo : (x).hi op (y).hi)
433# define ZERO64(x) ((x).lo == 0 && (x).hi == 0)
434#endif
435
91928c79 436/* --- Storing integers in tables --- */
437
438#ifdef HAVE_UINT64
439# define X64(x, y) { 0x##x##y }
440#else
441# define X64(x, y) { 0x##x, 0x##y }
442#endif
443
6b033bc4 444/*----- That's all, folks -------------------------------------------------*/
445
446#ifdef __cplusplus
447 }
448#endif
449
450#endif