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. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License along |
| 19 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 20 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 21 | */ |
| 22 | |
| 23 | #pragma once |
| 24 | |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 25 | #include <osmocom/core/utils.h> |
| 26 | |
Neels Hofmeyr | f6db765 | 2020-09-14 00:39:37 +0200 | [diff] [blame] | 27 | /*! 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] | 28 | * \param[in] p Buffer where integer is stored |
| 29 | * \param[in] n Number of bytes stored in p |
| 30 | * \returns XX bit unsigned integer |
| 31 | */ |
| 32 | static inline uintXX_t osmo_loadXXle_ext(const void *p, uint8_t n) |
| 33 | { |
| 34 | uint8_t i; |
| 35 | uintXX_t r = 0; |
| 36 | const uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 37 | OSMO_ASSERT(n <= sizeof(r)); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 38 | for(i = 0; i < n; r |= ((uintXX_t)q[i] << (8 * i)), i++); |
| 39 | return r; |
| 40 | } |
| 41 | |
Neels Hofmeyr | f6db765 | 2020-09-14 00:39:37 +0200 | [diff] [blame] | 42 | /*! load unaligned n-byte integer (big-endian encoding) into uintXX_t, into the MOST significant octets. |
| 43 | * WARNING: for n < sizeof(uintXX_t), the result is not returned in the least significant octets, as one might expect. |
| 44 | * 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] | 45 | * \param[in] p Buffer where integer is stored |
| 46 | * \param[in] n Number of bytes stored in p |
| 47 | * \returns XX bit unsigned integer |
| 48 | */ |
| 49 | static inline uintXX_t osmo_loadXXbe_ext(const void *p, uint8_t n) |
| 50 | { |
| 51 | uint8_t i; |
| 52 | uintXX_t r = 0; |
| 53 | const uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 54 | OSMO_ASSERT(n <= sizeof(r)); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 55 | for(i = 0; i < n; r |= ((uintXX_t)q[i] << (XX - 8* (1 + i))), i++); |
| 56 | return r; |
| 57 | } |
| 58 | |
Neels Hofmeyr | f6db765 | 2020-09-14 00:39:37 +0200 | [diff] [blame] | 59 | /*! load unaligned n-byte integer (big-endian encoding) into uintXX_t, into the least significant octets. |
| 60 | * \param[in] p Buffer where integer is stored |
| 61 | * \param[in] n Number of bytes stored in p |
| 62 | * \returns XX bit unsigned integer |
| 63 | */ |
| 64 | static inline uintXX_t osmo_loadXXbe_ext_2(const void *p, uint8_t n) |
| 65 | { |
| 66 | uint8_t i; |
| 67 | uintXX_t r = 0; |
| 68 | const uint8_t *q = (uint8_t *)p; |
| 69 | OSMO_ASSERT(n <= sizeof(r)); |
| 70 | for(i = 0; i < n; r |= ((uintXX_t)q[i] << (XX - 8* (1 + i + (sizeof(r) - n)))), i++); |
| 71 | return r; |
| 72 | } |
| 73 | |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 74 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 75 | /*! store unaligned n-byte integer (little-endian encoding) from uintXX_t |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 76 | * \param[in] x unsigned XX bit integer |
| 77 | * \param[out] p Buffer to store integer |
| 78 | * \param[in] n Number of bytes to store |
| 79 | */ |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 80 | 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] | 81 | { |
| 82 | uint8_t i; |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 83 | uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 84 | OSMO_ASSERT(n <= sizeof(x)); |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 85 | for(i = 0; i < n; q[i] = (x >> i * 8) & 0xFF, i++); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 86 | } |
| 87 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 88 | /*! store unaligned n-byte integer (big-endian encoding) from uintXX_t |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 89 | * \param[in] x unsigned XX bit integer |
| 90 | * \param[out] p Buffer to store integer |
| 91 | * \param[in] n Number of bytes to store |
| 92 | */ |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 93 | 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] | 94 | { |
| 95 | uint8_t i; |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 96 | uint8_t *q = (uint8_t *)p; |
Neels Hofmeyr | c0ac4e3 | 2020-09-14 00:20:24 +0200 | [diff] [blame] | 97 | OSMO_ASSERT(n <= sizeof(x)); |
Sylvain Munaut | 3baa0d6 | 2014-06-16 16:38:31 +0200 | [diff] [blame] | 98 | 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] | 99 | } |
| 100 | |
| 101 | |
| 102 | /* Convenience function for most-used cases */ |
| 103 | |
| 104 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 105 | /*! load unaligned XX-bit integer (little-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 106 | static inline uintXX_t osmo_loadXXle(const void *p) |
| 107 | { |
| 108 | return osmo_loadXXle_ext(p, XX / 8); |
| 109 | } |
| 110 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 111 | /*! load unaligned XX-bit integer (big-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 112 | static inline uintXX_t osmo_loadXXbe(const void *p) |
| 113 | { |
| 114 | return osmo_loadXXbe_ext(p, XX / 8); |
| 115 | } |
| 116 | |
| 117 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 118 | /*! store unaligned XX-bit integer (little-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 119 | static inline void osmo_storeXXle(uintXX_t x, void *p) |
| 120 | { |
Sylvain Munaut | 5469ef8 | 2014-06-16 16:39:08 +0200 | [diff] [blame] | 121 | osmo_storeXXle_ext(x, p, XX / 8); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 122 | } |
| 123 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 124 | /*! store unaligned XX-bit integer (big-endian encoding) */ |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 125 | static inline void osmo_storeXXbe(uintXX_t x, void *p) |
| 126 | { |
Sylvain Munaut | 5469ef8 | 2014-06-16 16:39:08 +0200 | [diff] [blame] | 127 | osmo_storeXXbe_ext(x, p, XX / 8); |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 128 | } |