Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 1 | /* |
| 2 | * bitXXgen.h |
| 3 | * |
| 4 | * Copyright (C) 2014 Max <max.suraev@fairwaves.co> |
| 5 | * |
| 6 | * All Rights Reserved |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU General Public License as published by |
| 10 | * the Free Software Foundation; either version 2 of the License, or |
| 11 | * (at your option) any later version. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 17 | */ |
| 18 | |
| 19 | #pragma once |
| 20 | |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 21 | #include <osmocom/core/utils.h> |
| 22 | |
Neels Hofmeyr | f6db765 | 2020-09-14 00:39:37 +0200 | [diff] [blame] | 23 | /*! load unaligned n-byte integer (little-endian encoding) into uintXX_t, into the least significant octets. |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 24 | * \param[in] p Buffer where integer is stored |
| 25 | * \param[in] n Number of bytes stored in p |
| 26 | * \returns XX bit unsigned integer |
| 27 | */ |
| 28 | static inline uintXX_t osmo_loadXXle_ext(const void *p, uint8_t n) |
| 29 | { |
| 30 | uint8_t i; |
| 31 | uintXX_t r = 0; |
| 32 | const uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 33 | OSMO_ASSERT(n <= sizeof(r)); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 34 | for(i = 0; i < n; r |= ((uintXX_t)q[i] << (8 * i)), i++); |
| 35 | return r; |
| 36 | } |
| 37 | |
Neels Hofmeyr | f6db765 | 2020-09-14 00:39:37 +0200 | [diff] [blame] | 38 | /*! load unaligned n-byte integer (big-endian encoding) into uintXX_t, into the MOST significant octets. |
| 39 | * WARNING: for n < sizeof(uintXX_t), the result is not returned in the least significant octets, as one might expect. |
| 40 | * To always return the same value as fed to osmo_storeXXbe_ext() before, use osmo_loadXXbe_ext_2(). |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 41 | * \param[in] p Buffer where integer is stored |
| 42 | * \param[in] n Number of bytes stored in p |
| 43 | * \returns XX bit unsigned integer |
| 44 | */ |
| 45 | static inline uintXX_t osmo_loadXXbe_ext(const void *p, uint8_t n) |
| 46 | { |
| 47 | uint8_t i; |
| 48 | uintXX_t r = 0; |
| 49 | const uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 50 | OSMO_ASSERT(n <= sizeof(r)); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 51 | for(i = 0; i < n; r |= ((uintXX_t)q[i] << (XX - 8* (1 + i))), i++); |
| 52 | return r; |
| 53 | } |
| 54 | |
Neels Hofmeyr | f6db765 | 2020-09-14 00:39:37 +0200 | [diff] [blame] | 55 | /*! load unaligned n-byte integer (big-endian encoding) into uintXX_t, into the least significant octets. |
| 56 | * \param[in] p Buffer where integer is stored |
| 57 | * \param[in] n Number of bytes stored in p |
| 58 | * \returns XX bit unsigned integer |
| 59 | */ |
| 60 | static inline uintXX_t osmo_loadXXbe_ext_2(const void *p, uint8_t n) |
| 61 | { |
| 62 | uint8_t i; |
| 63 | uintXX_t r = 0; |
| 64 | const uint8_t *q = (uint8_t *)p; |
| 65 | OSMO_ASSERT(n <= sizeof(r)); |
| 66 | for(i = 0; i < n; r |= ((uintXX_t)q[i] << (XX - 8* (1 + i + (sizeof(r) - n)))), i++); |
| 67 | return r; |
| 68 | } |
| 69 | |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 70 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 71 | /*! store unaligned n-byte integer (little-endian encoding) from uintXX_t |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 72 | * \param[in] x unsigned XX bit integer |
| 73 | * \param[out] p Buffer to store integer |
| 74 | * \param[in] n Number of bytes to store |
| 75 | */ |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 76 | static inline void osmo_storeXXle_ext(uintXX_t x, void *p, uint8_t n) |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 77 | { |
| 78 | uint8_t i; |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 79 | uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 80 | OSMO_ASSERT(n <= sizeof(x)); |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 81 | for(i = 0; i < n; q[i] = (x >> i * 8) & 0xFF, i++); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 82 | } |
| 83 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 84 | /*! store unaligned n-byte integer (big-endian encoding) from uintXX_t |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 85 | * \param[in] x unsigned XX bit integer |
| 86 | * \param[out] p Buffer to store integer |
| 87 | * \param[in] n Number of bytes to store |
| 88 | */ |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 89 | static inline void osmo_storeXXbe_ext(uintXX_t x, void *p, uint8_t n) |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 90 | { |
| 91 | uint8_t i; |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 92 | uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 93 | OSMO_ASSERT(n <= sizeof(x)); |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 94 | for(i = 0; i < n; q[i] = (x >> ((n - 1 - i) * 8)) & 0xFF, i++); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | |
| 98 | /* Convenience function for most-used cases */ |
| 99 | |
| 100 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 101 | /*! load unaligned XX-bit integer (little-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 102 | static inline uintXX_t osmo_loadXXle(const void *p) |
| 103 | { |
| 104 | return osmo_loadXXle_ext(p, XX / 8); |
| 105 | } |
| 106 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 107 | /*! load unaligned XX-bit integer (big-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 108 | static inline uintXX_t osmo_loadXXbe(const void *p) |
| 109 | { |
| 110 | return osmo_loadXXbe_ext(p, XX / 8); |
| 111 | } |
| 112 | |
| 113 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 114 | /*! store unaligned XX-bit integer (little-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 115 | static inline void osmo_storeXXle(uintXX_t x, void *p) |
| 116 | { |
Sylvain Munaut | 5469ef8 | 2014-06-16 16:39:08 +0200 | [diff] [blame] | 117 | osmo_storeXXle_ext(x, p, XX / 8); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 118 | } |
| 119 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 120 | /*! store unaligned XX-bit integer (big-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 121 | static inline void osmo_storeXXbe(uintXX_t x, void *p) |
| 122 | { |
Sylvain Munaut | 5469ef8 | 2014-06-16 16:39:08 +0200 | [diff] [blame] | 123 | osmo_storeXXbe_ext(x, p, XX / 8); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 124 | } |