Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 1 | /* bit vector utility routines */ |
| 2 | |
| 3 | /* (C) 2009 by Harald Welte <laforge@gnumonks.org> |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 4 | * (C) 2012 Ivan Klyuchnikov |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 5 | * (C) 2015 by Sysmocom s.f.m.c. GmbH |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 6 | * |
| 7 | * All Rights Reserved |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License as published by |
| 11 | * the Free Software Foundation; either version 2 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License along |
| 20 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 22 | * |
| 23 | */ |
| 24 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 25 | /*! \addtogroup bitvec |
| 26 | * @{ |
| 27 | */ |
| 28 | |
| 29 | /*! \file bitvec.c |
| 30 | * \brief Osmocom bit vector abstraction |
| 31 | */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 32 | |
| 33 | #include <errno.h> |
| 34 | #include <stdint.h> |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 35 | #include <string.h> |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 36 | #include <stdio.h> |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 37 | #include <stdbool.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 38 | |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 39 | #include <osmocom/core/bits.h> |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 40 | #include <osmocom/core/bitvec.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 41 | |
| 42 | #define BITNUM_FROM_COMP(byte, bit) ((byte*8)+bit) |
| 43 | |
| 44 | static inline unsigned int bytenum_from_bitnum(unsigned int bitnum) |
| 45 | { |
| 46 | unsigned int bytenum = bitnum / 8; |
| 47 | |
| 48 | return bytenum; |
| 49 | } |
| 50 | |
| 51 | /* convert ZERO/ONE/L/H to a bitmask at given pos in a byte */ |
| 52 | static uint8_t bitval2mask(enum bit_value bit, uint8_t bitnum) |
| 53 | { |
| 54 | int bitval; |
| 55 | |
| 56 | switch (bit) { |
| 57 | case ZERO: |
| 58 | bitval = (0 << bitnum); |
| 59 | break; |
| 60 | case ONE: |
| 61 | bitval = (1 << bitnum); |
| 62 | break; |
| 63 | case L: |
| 64 | bitval = ((0x2b ^ (0 << bitnum)) & (1 << bitnum)); |
| 65 | break; |
| 66 | case H: |
| 67 | bitval = ((0x2b ^ (1 << bitnum)) & (1 << bitnum)); |
| 68 | break; |
| 69 | default: |
| 70 | return 0; |
| 71 | } |
| 72 | return bitval; |
| 73 | } |
| 74 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 75 | /*! \brief check if the bit is 0 or 1 for a given position inside a bitvec |
| 76 | * \param[in] bv the bit vector on which to check |
| 77 | * \param[in] bitnr the bit number inside the bit vector to check |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 78 | * \return value of the requested bit |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 79 | */ |
Harald Welte | d9abf01 | 2010-03-06 11:28:49 +0100 | [diff] [blame] | 80 | enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 81 | { |
| 82 | unsigned int bytenum = bytenum_from_bitnum(bitnr); |
| 83 | unsigned int bitnum = 7 - (bitnr % 8); |
| 84 | uint8_t bitval; |
| 85 | |
| 86 | if (bytenum >= bv->data_len) |
| 87 | return -EINVAL; |
| 88 | |
| 89 | bitval = bitval2mask(ONE, bitnum); |
| 90 | |
| 91 | if (bv->data[bytenum] & bitval) |
| 92 | return ONE; |
| 93 | |
| 94 | return ZERO; |
| 95 | } |
| 96 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 97 | /*! \brief check if the bit is L or H for a given position inside a bitvec |
| 98 | * \param[in] bv the bit vector on which to check |
| 99 | * \param[in] bitnr the bit number inside the bit vector to check |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 100 | * \return value of the requested bit |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 101 | */ |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 102 | enum bit_value bitvec_get_bit_pos_high(const struct bitvec *bv, |
| 103 | unsigned int bitnr) |
| 104 | { |
| 105 | unsigned int bytenum = bytenum_from_bitnum(bitnr); |
| 106 | unsigned int bitnum = 7 - (bitnr % 8); |
| 107 | uint8_t bitval; |
| 108 | |
| 109 | if (bytenum >= bv->data_len) |
| 110 | return -EINVAL; |
| 111 | |
| 112 | bitval = bitval2mask(H, bitnum); |
| 113 | |
Andreas.Eversberg | dc0ebdf | 2010-10-24 11:59:33 +0200 | [diff] [blame] | 114 | if ((bv->data[bytenum] & (1 << bitnum)) == bitval) |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 115 | return H; |
| 116 | |
| 117 | return L; |
| 118 | } |
| 119 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 120 | /*! \brief get the Nth set bit inside the bit vector |
| 121 | * \param[in] bv the bit vector to use |
| 122 | * \param[in] n the bit number to get |
| 123 | * \returns the bit number (offset) of the Nth set bit in \a bv |
| 124 | */ |
Harald Welte | d9abf01 | 2010-03-06 11:28:49 +0100 | [diff] [blame] | 125 | unsigned int bitvec_get_nth_set_bit(const struct bitvec *bv, unsigned int n) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 126 | { |
| 127 | unsigned int i, k = 0; |
| 128 | |
| 129 | for (i = 0; i < bv->data_len*8; i++) { |
| 130 | if (bitvec_get_bit_pos(bv, i) == ONE) { |
| 131 | k++; |
| 132 | if (k == n) |
| 133 | return i; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | return 0; |
| 138 | } |
| 139 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 140 | /*! \brief set a bit at given position in a bit vector |
| 141 | * \param[in] bv bit vector on which to operate |
Katerina Barone-Adesi | c28c6a0 | 2013-02-15 13:27:59 +0100 | [diff] [blame] | 142 | * \param[in] bitnr number of bit to be set |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 143 | * \param[in] bit value to which the bit is to be set |
Max | 912bc6f | 2016-01-28 12:07:12 +0100 | [diff] [blame] | 144 | * \returns 0 on success, negative value on error |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 145 | */ |
Holger Hans Peter Freyther | 511b448 | 2016-07-13 12:26:10 +0200 | [diff] [blame] | 146 | inline int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnr, |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 147 | enum bit_value bit) |
| 148 | { |
| 149 | unsigned int bytenum = bytenum_from_bitnum(bitnr); |
| 150 | unsigned int bitnum = 7 - (bitnr % 8); |
| 151 | uint8_t bitval; |
| 152 | |
| 153 | if (bytenum >= bv->data_len) |
| 154 | return -EINVAL; |
| 155 | |
| 156 | /* first clear the bit */ |
| 157 | bitval = bitval2mask(ONE, bitnum); |
| 158 | bv->data[bytenum] &= ~bitval; |
| 159 | |
| 160 | /* then set it to desired value */ |
| 161 | bitval = bitval2mask(bit, bitnum); |
| 162 | bv->data[bytenum] |= bitval; |
| 163 | |
| 164 | return 0; |
| 165 | } |
| 166 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 167 | /*! \brief set the next bit inside a bitvec |
| 168 | * \param[in] bv bit vector to be used |
| 169 | * \param[in] bit value of the bit to be set |
Max | 912bc6f | 2016-01-28 12:07:12 +0100 | [diff] [blame] | 170 | * \returns 0 on success, negative value on error |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 171 | */ |
Holger Hans Peter Freyther | 511b448 | 2016-07-13 12:26:10 +0200 | [diff] [blame] | 172 | inline int bitvec_set_bit(struct bitvec *bv, enum bit_value bit) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 173 | { |
| 174 | int rc; |
| 175 | |
| 176 | rc = bitvec_set_bit_pos(bv, bv->cur_bit, bit); |
| 177 | if (!rc) |
| 178 | bv->cur_bit++; |
| 179 | |
| 180 | return rc; |
| 181 | } |
| 182 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 183 | /*! \brief get the next bit (low/high) inside a bitvec |
| 184 | * \return value of th next bit in the vector */ |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 185 | int bitvec_get_bit_high(struct bitvec *bv) |
| 186 | { |
| 187 | int rc; |
| 188 | |
| 189 | rc = bitvec_get_bit_pos_high(bv, bv->cur_bit); |
| 190 | if (rc >= 0) |
| 191 | bv->cur_bit++; |
| 192 | |
| 193 | return rc; |
| 194 | } |
| 195 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 196 | /*! \brief set multiple bits (based on array of bitvals) at current pos |
| 197 | * \param[in] bv bit vector |
| 198 | * \param[in] bits array of \ref bit_value |
| 199 | * \param[in] count number of bits to set |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 200 | * \return 0 on success; negative in case of error */ |
Harald Welte | 14bf28a | 2016-06-27 15:19:10 +0200 | [diff] [blame] | 201 | int bitvec_set_bits(struct bitvec *bv, const enum bit_value *bits, unsigned int count) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 202 | { |
| 203 | int i, rc; |
| 204 | |
| 205 | for (i = 0; i < count; i++) { |
| 206 | rc = bitvec_set_bit(bv, bits[i]); |
| 207 | if (rc) |
| 208 | return rc; |
| 209 | } |
| 210 | |
| 211 | return 0; |
| 212 | } |
| 213 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 214 | /*! \brief set multiple bits (based on numeric value) at current pos |
| 215 | * \return 0 in case of success; negative in case of error */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 216 | int bitvec_set_uint(struct bitvec *bv, unsigned int ui, unsigned int num_bits) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 217 | { |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 218 | int rc; |
| 219 | unsigned i; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 220 | for (i = 0; i < num_bits; i++) { |
| 221 | int bit = 0; |
Holger Hans Peter Freyther | ab0eb96 | 2016-02-18 20:28:25 +0100 | [diff] [blame] | 222 | if (ui & (1u << (num_bits - i - 1))) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 223 | bit = 1; |
| 224 | rc = bitvec_set_bit(bv, bit); |
| 225 | if (rc) |
| 226 | return rc; |
| 227 | } |
| 228 | |
| 229 | return 0; |
| 230 | } |
| 231 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 232 | /*! \brief get multiple bits (num_bits) from beginning of vector (MSB side) |
| 233 | * \return 16bit signed integer retrieved from bit vector */ |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 234 | int16_t bitvec_get_int16_msb(const struct bitvec *bv, unsigned int num_bits) |
| 235 | { |
| 236 | if (num_bits > 15 || bv->cur_bit < num_bits) |
| 237 | return -EINVAL; |
| 238 | |
| 239 | if (num_bits < 9) |
| 240 | return bv->data[0] >> (8 - num_bits); |
| 241 | |
| 242 | return osmo_load16be(bv->data) >> (16 - num_bits); |
| 243 | } |
| 244 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 245 | /*! \brief get multiple bits (based on numeric value) from current pos |
| 246 | * \return integer value retrieved from bit vector */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 247 | int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits) |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 248 | { |
| 249 | int i; |
| 250 | unsigned int ui = 0; |
| 251 | |
| 252 | for (i = 0; i < num_bits; i++) { |
| 253 | int bit = bitvec_get_bit_pos(bv, bv->cur_bit); |
| 254 | if (bit < 0) |
| 255 | return bit; |
| 256 | if (bit) |
| 257 | ui |= (1 << (num_bits - i - 1)); |
| 258 | bv->cur_bit++; |
| 259 | } |
| 260 | |
| 261 | return ui; |
| 262 | } |
| 263 | |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 264 | /*! \brief fill num_bits with \fill starting from the current position |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 265 | * \return 0 on success; negative otherwise (out of vector boundary) |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 266 | */ |
| 267 | int bitvec_fill(struct bitvec *bv, unsigned int num_bits, enum bit_value fill) |
| 268 | { |
| 269 | unsigned i, stop = bv->cur_bit + num_bits; |
| 270 | for (i = bv->cur_bit; i < stop; i++) |
| 271 | if (bitvec_set_bit(bv, fill) < 0) |
| 272 | return -EINVAL; |
| 273 | |
| 274 | return 0; |
| 275 | } |
| 276 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 277 | /*! \brief pad all remaining bits up to num_bits |
| 278 | * \return 0 on success; negative otherwise */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 279 | int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit) |
| 280 | { |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 281 | int n = up_to_bit - bv->cur_bit + 1; |
| 282 | if (n < 1) |
| 283 | return 0; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 284 | |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 285 | return bitvec_fill(bv, n, L); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 286 | } |
Pablo Neira Ayuso | 36bdf2c | 2011-03-28 19:24:19 +0200 | [diff] [blame] | 287 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 288 | /*! \brief find first bit set in bit vector |
| 289 | * \return 0 on success; negative otherwise */ |
Pablo Neira Ayuso | 36bdf2c | 2011-03-28 19:24:19 +0200 | [diff] [blame] | 290 | int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, |
| 291 | enum bit_value val) |
| 292 | { |
| 293 | unsigned int i; |
| 294 | |
| 295 | for (i = n; i < bv->data_len*8; i++) { |
| 296 | if (bitvec_get_bit_pos(bv, i) == val) |
| 297 | return i; |
| 298 | } |
| 299 | |
| 300 | return -1; |
| 301 | } |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 302 | |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 303 | /*! \brief get multiple bytes from current pos |
| 304 | * Assumes MSB first encoding. |
| 305 | * \param[in] bv bit vector |
| 306 | * \param[in] bytes array |
| 307 | * \param[in] count number of bytes to copy |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 308 | * \return 0 on success; negative otherwise |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 309 | */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 310 | int bitvec_get_bytes(struct bitvec *bv, uint8_t *bytes, unsigned int count) |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 311 | { |
| 312 | int byte_offs = bytenum_from_bitnum(bv->cur_bit); |
| 313 | int bit_offs = bv->cur_bit % 8; |
| 314 | uint8_t c, last_c; |
| 315 | int i; |
| 316 | uint8_t *src; |
| 317 | |
| 318 | if (byte_offs + count + (bit_offs ? 1 : 0) > bv->data_len) |
| 319 | return -EINVAL; |
| 320 | |
| 321 | if (bit_offs == 0) { |
| 322 | memcpy(bytes, bv->data + byte_offs, count); |
| 323 | } else { |
| 324 | src = bv->data + byte_offs; |
| 325 | last_c = *(src++); |
| 326 | for (i = count; i > 0; i--) { |
| 327 | c = *(src++); |
| 328 | *(bytes++) = |
| 329 | (last_c << bit_offs) | |
| 330 | (c >> (8 - bit_offs)); |
| 331 | last_c = c; |
| 332 | } |
| 333 | } |
| 334 | |
| 335 | bv->cur_bit += count * 8; |
| 336 | return 0; |
| 337 | } |
| 338 | |
| 339 | /*! \brief set multiple bytes at current pos |
| 340 | * Assumes MSB first encoding. |
| 341 | * \param[in] bv bit vector |
| 342 | * \param[in] bytes array |
| 343 | * \param[in] count number of bytes to copy |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 344 | * \return 0 on success; negative otherwise |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 345 | */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 346 | int bitvec_set_bytes(struct bitvec *bv, const uint8_t *bytes, unsigned int count) |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 347 | { |
| 348 | int byte_offs = bytenum_from_bitnum(bv->cur_bit); |
| 349 | int bit_offs = bv->cur_bit % 8; |
| 350 | uint8_t c, last_c; |
| 351 | int i; |
| 352 | uint8_t *dst; |
| 353 | |
| 354 | if (byte_offs + count + (bit_offs ? 1 : 0) > bv->data_len) |
| 355 | return -EINVAL; |
| 356 | |
| 357 | if (bit_offs == 0) { |
| 358 | memcpy(bv->data + byte_offs, bytes, count); |
| 359 | } else if (count > 0) { |
| 360 | dst = bv->data + byte_offs; |
| 361 | /* Get lower bits of first dst byte */ |
| 362 | last_c = *dst >> (8 - bit_offs); |
| 363 | for (i = count; i > 0; i--) { |
| 364 | c = *(bytes++); |
| 365 | *(dst++) = |
| 366 | (last_c << (8 - bit_offs)) | |
| 367 | (c >> bit_offs); |
| 368 | last_c = c; |
| 369 | } |
| 370 | /* Overwrite lower bits of N+1 dst byte */ |
| 371 | *dst = (*dst & ((1 << (8 - bit_offs)) - 1)) | |
| 372 | (last_c << (8 - bit_offs)); |
| 373 | } |
| 374 | |
| 375 | bv->cur_bit += count * 8; |
| 376 | return 0; |
| 377 | } |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 378 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 379 | /*! \brief Allocate a bit vector |
| 380 | * \param[in] size Number of bits in the vector |
| 381 | * \param[in] ctx Context from which to allocate |
| 382 | * \return pointer to allocated vector; NULL in case of error */ |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 383 | struct bitvec *bitvec_alloc(unsigned int size, TALLOC_CTX *ctx) |
| 384 | { |
| 385 | struct bitvec *bv = talloc_zero(ctx, struct bitvec); |
| 386 | if (!bv) |
| 387 | return NULL; |
| 388 | |
| 389 | bv->data = talloc_zero_array(bv, uint8_t, size); |
| 390 | if (!(bv->data)) { |
| 391 | talloc_free(bv); |
| 392 | return NULL; |
| 393 | } |
| 394 | |
| 395 | bv->data_len = size; |
| 396 | bv->cur_bit = 0; |
| 397 | return bv; |
| 398 | } |
| 399 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 400 | /*! \brief Free a bit vector (release its memory) |
| 401 | * \param[in] bit vector to free */ |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 402 | void bitvec_free(struct bitvec *bv) |
| 403 | { |
| 404 | talloc_free(bv->data); |
| 405 | talloc_free(bv); |
| 406 | } |
| 407 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 408 | /*! \brief Export a bit vector to a buffer |
| 409 | * \param[in] bitvec (unpacked bits) |
| 410 | * \param[out] buffer for the unpacked bits |
| 411 | * \return number of bytes (= bits) copied */ |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 412 | unsigned int bitvec_pack(const struct bitvec *bv, uint8_t *buffer) |
| 413 | { |
| 414 | unsigned int i = 0; |
| 415 | for (i = 0; i < bv->data_len; i++) |
| 416 | buffer[i] = bv->data[i]; |
| 417 | |
| 418 | return i; |
| 419 | } |
| 420 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 421 | /*! \brief Copy buffer of unpacked bits into bit vector |
| 422 | * \param[in] buffer unpacked input bits |
| 423 | * \param[out] bv unpacked bit vector |
| 424 | * \return number of bytes (= bits) copied */ |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 425 | unsigned int bitvec_unpack(struct bitvec *bv, const uint8_t *buffer) |
| 426 | { |
| 427 | unsigned int i = 0; |
| 428 | for (i = 0; i < bv->data_len; i++) |
| 429 | bv->data[i] = buffer[i]; |
| 430 | |
| 431 | return i; |
| 432 | } |
| 433 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 434 | /*! \brief read hexadecimap string into a bit vector |
| 435 | * \param[in] src string containing hex digits |
| 436 | * \param[out] bv unpacked bit vector |
| 437 | * \return 0 in case of success; 1 in case of error |
| 438 | */ |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 439 | int bitvec_unhex(struct bitvec *bv, const char *src) |
| 440 | { |
Holger Hans Peter Freyther | 2745b48 | 2016-01-27 17:08:02 +0100 | [diff] [blame] | 441 | unsigned i; |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 442 | unsigned val; |
| 443 | unsigned write_index = 0; |
| 444 | unsigned digits = bv->data_len * 2; |
Holger Hans Peter Freyther | 2745b48 | 2016-01-27 17:08:02 +0100 | [diff] [blame] | 445 | |
| 446 | for (i = 0; i < digits; i++) { |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 447 | if (sscanf(src + i, "%1x", &val) < 1) { |
| 448 | return 1; |
| 449 | } |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 450 | bitvec_write_field(bv, &write_index, val, 4); |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 451 | } |
| 452 | return 0; |
| 453 | } |
| 454 | |
Max | 912bc6f | 2016-01-28 12:07:12 +0100 | [diff] [blame] | 455 | /*! \brief read part of the vector |
| 456 | * \param[in] bv The boolean vector to work on |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 457 | * \param[in,out] read_index Where reading supposed to start in the vector |
Max | 912bc6f | 2016-01-28 12:07:12 +0100 | [diff] [blame] | 458 | * \param[in] len How many bits to read from vector |
| 459 | * \returns read bits or negative value on error |
| 460 | */ |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 461 | uint64_t bitvec_read_field(struct bitvec *bv, unsigned int *read_index, unsigned int len) |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 462 | { |
| 463 | unsigned int i; |
| 464 | uint64_t ui = 0; |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 465 | bv->cur_bit = *read_index; |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 466 | |
| 467 | for (i = 0; i < len; i++) { |
| 468 | int bit = bitvec_get_bit_pos((const struct bitvec *)bv, bv->cur_bit); |
| 469 | if (bit < 0) |
| 470 | return bit; |
| 471 | if (bit) |
| 472 | ui |= ((uint64_t)1 << (len - i - 1)); |
| 473 | bv->cur_bit++; |
| 474 | } |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 475 | *read_index += len; |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 476 | return ui; |
| 477 | } |
| 478 | |
Max | 912bc6f | 2016-01-28 12:07:12 +0100 | [diff] [blame] | 479 | /*! \brief write into the vector |
| 480 | * \param[in] bv The boolean vector to work on |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 481 | * \param[in,out] write_index Where writing supposed to start in the vector |
Max | 912bc6f | 2016-01-28 12:07:12 +0100 | [diff] [blame] | 482 | * \param[in] len How many bits to write |
| 483 | * \returns next write index or negative value on error |
| 484 | */ |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 485 | int bitvec_write_field(struct bitvec *bv, unsigned int *write_index, uint64_t val, unsigned int len) |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 486 | { |
| 487 | unsigned int i; |
| 488 | int rc; |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 489 | bv->cur_bit = *write_index; |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 490 | for (i = 0; i < len; i++) { |
| 491 | int bit = 0; |
| 492 | if (val & ((uint64_t)1 << (len - i - 1))) |
| 493 | bit = 1; |
| 494 | rc = bitvec_set_bit(bv, bit); |
| 495 | if (rc) |
| 496 | return rc; |
| 497 | } |
Holger Hans Peter Freyther | a9301a1 | 2016-01-30 10:54:43 +0100 | [diff] [blame] | 498 | *write_index += len; |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame] | 499 | return 0; |
| 500 | } |
| 501 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 502 | /*! \brief convert enum to corresponding character |
| 503 | * \param v input value (bit) |
| 504 | * \return single character, either 0, 1, L or H */ |
Max | 0a59e98 | 2016-02-05 13:55:37 +0100 | [diff] [blame] | 505 | char bit_value_to_char(enum bit_value v) |
| 506 | { |
| 507 | switch (v) { |
| 508 | case ZERO: return '0'; |
| 509 | case ONE: return '1'; |
| 510 | case L: return 'L'; |
| 511 | case H: return 'H'; |
| 512 | default: abort(); |
| 513 | } |
| 514 | } |
| 515 | |
| 516 | /*! \brief prints bit vector to provided string |
| 517 | * It's caller's responsibility to ensure that we won't shoot him in the foot: |
| 518 | * the provided buffer should be at lest cur_bit + 1 bytes long |
| 519 | */ |
| 520 | void bitvec_to_string_r(const struct bitvec *bv, char *str) |
| 521 | { |
| 522 | unsigned i, pos = 0; |
| 523 | char *cur = str; |
| 524 | for (i = 0; i < bv->cur_bit; i++) { |
| 525 | if (0 == i % 8) |
| 526 | *cur++ = ' '; |
| 527 | *cur++ = bit_value_to_char(bitvec_get_bit_pos(bv, i)); |
| 528 | pos++; |
| 529 | } |
| 530 | *cur = 0; |
| 531 | } |
| 532 | |
| 533 | /* we assume that x have at least 1 non-b bit */ |
| 534 | static inline unsigned leading_bits(uint8_t x, bool b) |
| 535 | { |
| 536 | if (b) { |
| 537 | if (x < 0x80) return 0; |
| 538 | if (x < 0xC0) return 1; |
| 539 | if (x < 0xE0) return 2; |
| 540 | if (x < 0xF0) return 3; |
| 541 | if (x < 0xF8) return 4; |
| 542 | if (x < 0xFC) return 5; |
| 543 | if (x < 0xFE) return 6; |
| 544 | } else { |
| 545 | if (x > 0x7F) return 0; |
| 546 | if (x > 0x3F) return 1; |
| 547 | if (x > 0x1F) return 2; |
| 548 | if (x > 0xF) return 3; |
| 549 | if (x > 7) return 4; |
| 550 | if (x > 3) return 5; |
| 551 | if (x > 1) return 6; |
| 552 | } |
| 553 | return 7; |
| 554 | } |
| 555 | /*! \brief force bit vector to all 0 and current bit to the beginnig of the vector */ |
| 556 | void bitvec_zero(struct bitvec *bv) |
| 557 | { |
| 558 | bv->cur_bit = 0; |
| 559 | memset(bv->data, 0, bv->data_len); |
| 560 | } |
| 561 | |
| 562 | /*! \brief Return number (bits) of uninterrupted bit run in vector starting from the MSB |
| 563 | * \param[in] bv The boolean vector to work on |
| 564 | * \param[in] b The boolean, sequence of which is looked at from the vector start |
| 565 | * \returns Number of consecutive bits of \p b in \p bv |
| 566 | */ |
| 567 | unsigned bitvec_rl(const struct bitvec *bv, bool b) |
| 568 | { |
| 569 | unsigned i; |
| 570 | for (i = 0; i < (bv->cur_bit % 8 ? bv->cur_bit / 8 + 1 : bv->cur_bit / 8); i++) { |
| 571 | if ( (b ? 0xFF : 0) != bv->data[i]) |
| 572 | return i * 8 + leading_bits(bv->data[i], b); |
| 573 | } |
| 574 | |
| 575 | return bv->cur_bit; |
| 576 | } |
| 577 | |
| 578 | /*! \brief Shifts bitvec to the left, n MSB bits lost */ |
| 579 | void bitvec_shiftl(struct bitvec *bv, unsigned n) |
| 580 | { |
| 581 | if (0 == n) |
| 582 | return; |
| 583 | if (n >= bv->cur_bit) { |
| 584 | bitvec_zero(bv); |
| 585 | return; |
| 586 | } |
| 587 | |
| 588 | memmove(bv->data, bv->data + n / 8, bv->data_len - n / 8); |
| 589 | |
| 590 | uint8_t tmp[2]; |
| 591 | unsigned i; |
| 592 | for (i = 0; i < bv->data_len - 2; i++) { |
| 593 | uint16_t t = osmo_load16be(bv->data + i); |
| 594 | osmo_store16be(t << (n % 8), &tmp); |
| 595 | bv->data[i] = tmp[0]; |
| 596 | } |
| 597 | |
| 598 | bv->data[bv->data_len - 1] <<= (n % 8); |
| 599 | bv->cur_bit -= n; |
| 600 | } |
| 601 | |
Max | d479321 | 2016-03-17 11:51:08 +0100 | [diff] [blame] | 602 | /*! \brief Add given array to bitvec |
| 603 | * \param[in,out] bv bit vector to work with |
| 604 | * \param[in] array elements to be added |
| 605 | * \param[in] array_len length of array |
| 606 | * \param[in] dry_run indicates whether to return number of bits required |
| 607 | * instead of adding anything to bv for real |
| 608 | * \param[in] num_bits number of bits to consider in each element of array |
| 609 | * \returns number of bits necessary to add array elements if dry_run is true, |
| 610 | * 0 otherwise (only in this case bv is actually changed) |
| 611 | * |
| 612 | * N. B: no length checks are performed on bv - it's caller's job to ensure |
| 613 | * enough space is available - for example by calling with dry_run = true first. |
| 614 | * |
| 615 | * Useful for common pattern in CSN.1 spec which looks like: |
| 616 | * { 1 < XXX : bit (num_bits) > } ** 0 |
| 617 | * which means repeat any times (between 0 and infinity), |
| 618 | * start each repetition with 1, mark end of repetitions with 0 bit |
| 619 | * see app. note in 3GPP TS 24.007 ยง B.2.1 Rule A2 |
| 620 | */ |
| 621 | unsigned int bitvec_add_array(struct bitvec *bv, const uint32_t *array, |
| 622 | unsigned int array_len, bool dry_run, |
| 623 | unsigned int num_bits) |
| 624 | { |
| 625 | unsigned i, bits = 1; /* account for stop bit */ |
| 626 | for (i = 0; i < array_len; i++) { |
| 627 | if (dry_run) { |
| 628 | bits += (1 + num_bits); |
| 629 | } else { |
| 630 | bitvec_set_bit(bv, 1); |
| 631 | bitvec_set_uint(bv, array[i], num_bits); |
| 632 | } |
| 633 | } |
| 634 | |
| 635 | if (dry_run) |
| 636 | return bits; |
| 637 | |
| 638 | bitvec_set_bit(bv, 0); /* stop bit - end of the sequence */ |
| 639 | return 0; |
| 640 | } |
| 641 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 642 | /*! @} */ |