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> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 37 | |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 38 | #include <osmocom/core/bitvec.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 39 | |
| 40 | #define BITNUM_FROM_COMP(byte, bit) ((byte*8)+bit) |
| 41 | |
| 42 | static inline unsigned int bytenum_from_bitnum(unsigned int bitnum) |
| 43 | { |
| 44 | unsigned int bytenum = bitnum / 8; |
| 45 | |
| 46 | return bytenum; |
| 47 | } |
| 48 | |
| 49 | /* convert ZERO/ONE/L/H to a bitmask at given pos in a byte */ |
| 50 | static uint8_t bitval2mask(enum bit_value bit, uint8_t bitnum) |
| 51 | { |
| 52 | int bitval; |
| 53 | |
| 54 | switch (bit) { |
| 55 | case ZERO: |
| 56 | bitval = (0 << bitnum); |
| 57 | break; |
| 58 | case ONE: |
| 59 | bitval = (1 << bitnum); |
| 60 | break; |
| 61 | case L: |
| 62 | bitval = ((0x2b ^ (0 << bitnum)) & (1 << bitnum)); |
| 63 | break; |
| 64 | case H: |
| 65 | bitval = ((0x2b ^ (1 << bitnum)) & (1 << bitnum)); |
| 66 | break; |
| 67 | default: |
| 68 | return 0; |
| 69 | } |
| 70 | return bitval; |
| 71 | } |
| 72 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 73 | /*! \brief check if the bit is 0 or 1 for a given position inside a bitvec |
| 74 | * \param[in] bv the bit vector on which to check |
| 75 | * \param[in] bitnr the bit number inside the bit vector to check |
| 76 | * \returns |
| 77 | */ |
Harald Welte | d9abf01 | 2010-03-06 11:28:49 +0100 | [diff] [blame] | 78 | 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] | 79 | { |
| 80 | unsigned int bytenum = bytenum_from_bitnum(bitnr); |
| 81 | unsigned int bitnum = 7 - (bitnr % 8); |
| 82 | uint8_t bitval; |
| 83 | |
| 84 | if (bytenum >= bv->data_len) |
| 85 | return -EINVAL; |
| 86 | |
| 87 | bitval = bitval2mask(ONE, bitnum); |
| 88 | |
| 89 | if (bv->data[bytenum] & bitval) |
| 90 | return ONE; |
| 91 | |
| 92 | return ZERO; |
| 93 | } |
| 94 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 95 | /*! \brief check if the bit is L or H for a given position inside a bitvec |
| 96 | * \param[in] bv the bit vector on which to check |
| 97 | * \param[in] bitnr the bit number inside the bit vector to check |
| 98 | */ |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 99 | enum bit_value bitvec_get_bit_pos_high(const struct bitvec *bv, |
| 100 | unsigned int bitnr) |
| 101 | { |
| 102 | unsigned int bytenum = bytenum_from_bitnum(bitnr); |
| 103 | unsigned int bitnum = 7 - (bitnr % 8); |
| 104 | uint8_t bitval; |
| 105 | |
| 106 | if (bytenum >= bv->data_len) |
| 107 | return -EINVAL; |
| 108 | |
| 109 | bitval = bitval2mask(H, bitnum); |
| 110 | |
Andreas.Eversberg | dc0ebdf | 2010-10-24 11:59:33 +0200 | [diff] [blame] | 111 | if ((bv->data[bytenum] & (1 << bitnum)) == bitval) |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 112 | return H; |
| 113 | |
| 114 | return L; |
| 115 | } |
| 116 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 117 | /*! \brief get the Nth set bit inside the bit vector |
| 118 | * \param[in] bv the bit vector to use |
| 119 | * \param[in] n the bit number to get |
| 120 | * \returns the bit number (offset) of the Nth set bit in \a bv |
| 121 | */ |
Harald Welte | d9abf01 | 2010-03-06 11:28:49 +0100 | [diff] [blame] | 122 | 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] | 123 | { |
| 124 | unsigned int i, k = 0; |
| 125 | |
| 126 | for (i = 0; i < bv->data_len*8; i++) { |
| 127 | if (bitvec_get_bit_pos(bv, i) == ONE) { |
| 128 | k++; |
| 129 | if (k == n) |
| 130 | return i; |
| 131 | } |
| 132 | } |
| 133 | |
| 134 | return 0; |
| 135 | } |
| 136 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 137 | /*! \brief set a bit at given position in a bit vector |
| 138 | * \param[in] bv bit vector on which to operate |
Katerina Barone-Adesi | c28c6a0 | 2013-02-15 13:27:59 +0100 | [diff] [blame] | 139 | * \param[in] bitnr number of bit to be set |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 140 | * \param[in] bit value to which the bit is to be set |
| 141 | */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 142 | int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnr, |
| 143 | enum bit_value bit) |
| 144 | { |
| 145 | unsigned int bytenum = bytenum_from_bitnum(bitnr); |
| 146 | unsigned int bitnum = 7 - (bitnr % 8); |
| 147 | uint8_t bitval; |
| 148 | |
| 149 | if (bytenum >= bv->data_len) |
| 150 | return -EINVAL; |
| 151 | |
| 152 | /* first clear the bit */ |
| 153 | bitval = bitval2mask(ONE, bitnum); |
| 154 | bv->data[bytenum] &= ~bitval; |
| 155 | |
| 156 | /* then set it to desired value */ |
| 157 | bitval = bitval2mask(bit, bitnum); |
| 158 | bv->data[bytenum] |= bitval; |
| 159 | |
| 160 | return 0; |
| 161 | } |
| 162 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 163 | /*! \brief set the next bit inside a bitvec |
| 164 | * \param[in] bv bit vector to be used |
| 165 | * \param[in] bit value of the bit to be set |
| 166 | */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 167 | int bitvec_set_bit(struct bitvec *bv, enum bit_value bit) |
| 168 | { |
| 169 | int rc; |
| 170 | |
| 171 | rc = bitvec_set_bit_pos(bv, bv->cur_bit, bit); |
| 172 | if (!rc) |
| 173 | bv->cur_bit++; |
| 174 | |
| 175 | return rc; |
| 176 | } |
| 177 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 178 | /*! \brief get the next bit (low/high) inside a bitvec */ |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 179 | int bitvec_get_bit_high(struct bitvec *bv) |
| 180 | { |
| 181 | int rc; |
| 182 | |
| 183 | rc = bitvec_get_bit_pos_high(bv, bv->cur_bit); |
| 184 | if (rc >= 0) |
| 185 | bv->cur_bit++; |
| 186 | |
| 187 | return rc; |
| 188 | } |
| 189 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 190 | /*! \brief set multiple bits (based on array of bitvals) at current pos |
| 191 | * \param[in] bv bit vector |
| 192 | * \param[in] bits array of \ref bit_value |
| 193 | * \param[in] count number of bits to set |
| 194 | */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 195 | int bitvec_set_bits(struct bitvec *bv, enum bit_value *bits, unsigned int count) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 196 | { |
| 197 | int i, rc; |
| 198 | |
| 199 | for (i = 0; i < count; i++) { |
| 200 | rc = bitvec_set_bit(bv, bits[i]); |
| 201 | if (rc) |
| 202 | return rc; |
| 203 | } |
| 204 | |
| 205 | return 0; |
| 206 | } |
| 207 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 208 | /*! \brief set multiple bits (based on numeric value) at current pos */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 209 | 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] | 210 | { |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 211 | int rc; |
| 212 | unsigned i; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 213 | for (i = 0; i < num_bits; i++) { |
| 214 | int bit = 0; |
| 215 | if (ui & (1 << (num_bits - i - 1))) |
| 216 | bit = 1; |
| 217 | rc = bitvec_set_bit(bv, bit); |
| 218 | if (rc) |
| 219 | return rc; |
| 220 | } |
| 221 | |
| 222 | return 0; |
| 223 | } |
| 224 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 225 | /*! \brief get multiple bits (based on numeric value) from current pos */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 226 | int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits) |
Andreas.Eversberg | 0ebd688 | 2010-05-09 09:36:54 +0000 | [diff] [blame] | 227 | { |
| 228 | int i; |
| 229 | unsigned int ui = 0; |
| 230 | |
| 231 | for (i = 0; i < num_bits; i++) { |
| 232 | int bit = bitvec_get_bit_pos(bv, bv->cur_bit); |
| 233 | if (bit < 0) |
| 234 | return bit; |
| 235 | if (bit) |
| 236 | ui |= (1 << (num_bits - i - 1)); |
| 237 | bv->cur_bit++; |
| 238 | } |
| 239 | |
| 240 | return ui; |
| 241 | } |
| 242 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 243 | /*! \brief pad all remaining bits up to num_bits */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 244 | int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit) |
| 245 | { |
| 246 | unsigned int i; |
| 247 | |
| 248 | for (i = bv->cur_bit; i <= up_to_bit; i++) |
| 249 | bitvec_set_bit(bv, L); |
| 250 | |
| 251 | return 0; |
| 252 | } |
Pablo Neira Ayuso | 36bdf2c | 2011-03-28 19:24:19 +0200 | [diff] [blame] | 253 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 254 | /*! \brief find first bit set in bit vector */ |
Pablo Neira Ayuso | 36bdf2c | 2011-03-28 19:24:19 +0200 | [diff] [blame] | 255 | int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, |
| 256 | enum bit_value val) |
| 257 | { |
| 258 | unsigned int i; |
| 259 | |
| 260 | for (i = n; i < bv->data_len*8; i++) { |
| 261 | if (bitvec_get_bit_pos(bv, i) == val) |
| 262 | return i; |
| 263 | } |
| 264 | |
| 265 | return -1; |
| 266 | } |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 267 | |
Jacob Erlbeck | 5f349be | 2015-12-21 16:04:03 +0100 | [diff] [blame] | 268 | /*! \brief get multiple bytes from current pos |
| 269 | * Assumes MSB first encoding. |
| 270 | * \param[in] bv bit vector |
| 271 | * \param[in] bytes array |
| 272 | * \param[in] count number of bytes to copy |
| 273 | */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 274 | 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] | 275 | { |
| 276 | int byte_offs = bytenum_from_bitnum(bv->cur_bit); |
| 277 | int bit_offs = bv->cur_bit % 8; |
| 278 | uint8_t c, last_c; |
| 279 | int i; |
| 280 | uint8_t *src; |
| 281 | |
| 282 | if (byte_offs + count + (bit_offs ? 1 : 0) > bv->data_len) |
| 283 | return -EINVAL; |
| 284 | |
| 285 | if (bit_offs == 0) { |
| 286 | memcpy(bytes, bv->data + byte_offs, count); |
| 287 | } else { |
| 288 | src = bv->data + byte_offs; |
| 289 | last_c = *(src++); |
| 290 | for (i = count; i > 0; i--) { |
| 291 | c = *(src++); |
| 292 | *(bytes++) = |
| 293 | (last_c << bit_offs) | |
| 294 | (c >> (8 - bit_offs)); |
| 295 | last_c = c; |
| 296 | } |
| 297 | } |
| 298 | |
| 299 | bv->cur_bit += count * 8; |
| 300 | return 0; |
| 301 | } |
| 302 | |
| 303 | /*! \brief set multiple bytes at 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 |
| 308 | */ |
Max | e49af08 | 2016-01-22 16:46:56 +0100 | [diff] [blame] | 309 | 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] | 310 | { |
| 311 | int byte_offs = bytenum_from_bitnum(bv->cur_bit); |
| 312 | int bit_offs = bv->cur_bit % 8; |
| 313 | uint8_t c, last_c; |
| 314 | int i; |
| 315 | uint8_t *dst; |
| 316 | |
| 317 | if (byte_offs + count + (bit_offs ? 1 : 0) > bv->data_len) |
| 318 | return -EINVAL; |
| 319 | |
| 320 | if (bit_offs == 0) { |
| 321 | memcpy(bv->data + byte_offs, bytes, count); |
| 322 | } else if (count > 0) { |
| 323 | dst = bv->data + byte_offs; |
| 324 | /* Get lower bits of first dst byte */ |
| 325 | last_c = *dst >> (8 - bit_offs); |
| 326 | for (i = count; i > 0; i--) { |
| 327 | c = *(bytes++); |
| 328 | *(dst++) = |
| 329 | (last_c << (8 - bit_offs)) | |
| 330 | (c >> bit_offs); |
| 331 | last_c = c; |
| 332 | } |
| 333 | /* Overwrite lower bits of N+1 dst byte */ |
| 334 | *dst = (*dst & ((1 << (8 - bit_offs)) - 1)) | |
| 335 | (last_c << (8 - bit_offs)); |
| 336 | } |
| 337 | |
| 338 | bv->cur_bit += count * 8; |
| 339 | return 0; |
| 340 | } |
Max | a15f05f | 2016-01-26 10:43:15 +0100 | [diff] [blame^] | 341 | |
| 342 | struct bitvec *bitvec_alloc(unsigned int size, TALLOC_CTX *ctx) |
| 343 | { |
| 344 | struct bitvec *bv = talloc_zero(ctx, struct bitvec); |
| 345 | if (!bv) |
| 346 | return NULL; |
| 347 | |
| 348 | bv->data = talloc_zero_array(bv, uint8_t, size); |
| 349 | if (!(bv->data)) { |
| 350 | talloc_free(bv); |
| 351 | return NULL; |
| 352 | } |
| 353 | |
| 354 | bv->data_len = size; |
| 355 | bv->cur_bit = 0; |
| 356 | return bv; |
| 357 | } |
| 358 | |
| 359 | void bitvec_free(struct bitvec *bv) |
| 360 | { |
| 361 | talloc_free(bv->data); |
| 362 | talloc_free(bv); |
| 363 | } |
| 364 | |
| 365 | unsigned int bitvec_pack(const struct bitvec *bv, uint8_t *buffer) |
| 366 | { |
| 367 | unsigned int i = 0; |
| 368 | for (i = 0; i < bv->data_len; i++) |
| 369 | buffer[i] = bv->data[i]; |
| 370 | |
| 371 | return i; |
| 372 | } |
| 373 | |
| 374 | unsigned int bitvec_unpack(struct bitvec *bv, const uint8_t *buffer) |
| 375 | { |
| 376 | unsigned int i = 0; |
| 377 | for (i = 0; i < bv->data_len; i++) |
| 378 | bv->data[i] = buffer[i]; |
| 379 | |
| 380 | return i; |
| 381 | } |
| 382 | |
| 383 | |
| 384 | int bitvec_unhex(struct bitvec *bv, const char *src) |
| 385 | { |
| 386 | unsigned val; |
| 387 | unsigned write_index = 0; |
| 388 | unsigned digits = bv->data_len * 2; |
| 389 | for (unsigned i = 0; i < digits; i++) { |
| 390 | if (sscanf(src + i, "%1x", &val) < 1) { |
| 391 | return 1; |
| 392 | } |
| 393 | bitvec_write_field(bv, write_index,val, 4); |
| 394 | } |
| 395 | return 0; |
| 396 | } |
| 397 | |
| 398 | uint64_t bitvec_read_field(struct bitvec *bv, unsigned int read_index, unsigned int len) |
| 399 | { |
| 400 | unsigned int i; |
| 401 | uint64_t ui = 0; |
| 402 | bv->cur_bit = read_index; |
| 403 | |
| 404 | for (i = 0; i < len; i++) { |
| 405 | int bit = bitvec_get_bit_pos((const struct bitvec *)bv, bv->cur_bit); |
| 406 | if (bit < 0) |
| 407 | return bit; |
| 408 | if (bit) |
| 409 | ui |= ((uint64_t)1 << (len - i - 1)); |
| 410 | bv->cur_bit++; |
| 411 | } |
| 412 | read_index += len; |
| 413 | return ui; |
| 414 | } |
| 415 | |
| 416 | |
| 417 | int bitvec_write_field(struct bitvec *bv, unsigned int write_index, uint64_t val, unsigned int len) |
| 418 | { |
| 419 | unsigned int i; |
| 420 | int rc; |
| 421 | bv->cur_bit = write_index; |
| 422 | for (i = 0; i < len; i++) { |
| 423 | int bit = 0; |
| 424 | if (val & ((uint64_t)1 << (len - i - 1))) |
| 425 | bit = 1; |
| 426 | rc = bitvec_set_bit(bv, bit); |
| 427 | if (rc) |
| 428 | return rc; |
| 429 | } |
| 430 | write_index += len; |
| 431 | return 0; |
| 432 | } |
| 433 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 434 | /*! @} */ |