blob: 70b0e27d11239ac9736331e23743f8097082b12b [file] [log] [blame]
Harald Welteec8b4502010-02-20 20:34:29 +01001/* (C) 2009 by Harald Welte <laforge@gnumonks.org>
Maxa15f05f2016-01-26 10:43:15 +01002 * (C) 2012 Ivan Klyuchnikov
Harald Weltee08da972017-11-13 01:00:26 +09003 * (C) 2015 sysmocom - s.f.m.c. GmbH
Harald Welteec8b4502010-02-20 20:34:29 +01004 *
5 * All Rights Reserved
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
Harald Welteec8b4502010-02-20 20:34:29 +010017 */
18
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020019#pragma once
20
Harald Welteba6988b2011-08-17 12:46:48 +020021/*! \defgroup bitvec Bit vectors
22 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020023 * \file bitvec.h */
Harald Welteba6988b2011-08-17 12:46:48 +020024
Harald Weltecd623eb2011-05-29 15:37:38 +020025#include <stdint.h>
Harald Weltef2899c62017-01-15 17:54:11 +010026#include <osmocom/core/talloc.h>
Max0b3db502017-10-18 13:48:10 +020027#include <osmocom/core/defs.h>
Max0a59e982016-02-05 13:55:37 +010028#include <stdbool.h>
Harald Welteec8b4502010-02-20 20:34:29 +010029
Neels Hofmeyr87e45502017-06-20 00:17:59 +020030/*! A single GSM bit
Harald Welteba6988b2011-08-17 12:46:48 +020031 *
32 * In GSM mac blocks, every bit can be 0 or 1, or L or H. L/H are
Harald Welteec8b4502010-02-20 20:34:29 +010033 * defined relative to the 0x2b padding pattern */
34enum bit_value {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020035 ZERO = 0, /*!< A zero (0) bit */
36 ONE = 1, /*!< A one (1) bit */
37 L = 2, /*!< A CSN.1 "L" bit */
38 H = 3, /*!< A CSN.1 "H" bit */
Harald Welteec8b4502010-02-20 20:34:29 +010039};
40
Neels Hofmeyr87e45502017-06-20 00:17:59 +020041/*! structure describing a bit vector */
Harald Welteec8b4502010-02-20 20:34:29 +010042struct bitvec {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020043 unsigned int cur_bit; /*!< cursor to the next unused bit */
44 unsigned int data_len; /*!< length of data array in bytes */
45 uint8_t *data; /*!< pointer to data array */
Harald Welteec8b4502010-02-20 20:34:29 +010046};
47
Harald Welted9abf012010-03-06 11:28:49 +010048enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr);
Andreas.Eversberg0ebd6882010-05-09 09:36:54 +000049enum bit_value bitvec_get_bit_pos_high(const struct bitvec *bv,
50 unsigned int bitnr);
Harald Welted9abf012010-03-06 11:28:49 +010051unsigned int bitvec_get_nth_set_bit(const struct bitvec *bv, unsigned int n);
Harald Welteec8b4502010-02-20 20:34:29 +010052int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnum,
53 enum bit_value bit);
Harald Welteec8b4502010-02-20 20:34:29 +010054int bitvec_set_bit(struct bitvec *bv, enum bit_value bit);
Andreas.Eversberg0ebd6882010-05-09 09:36:54 +000055int bitvec_get_bit_high(struct bitvec *bv);
Harald Welte14bf28a2016-06-27 15:19:10 +020056int bitvec_set_bits(struct bitvec *bv, const enum bit_value *bits, unsigned int count);
Max0b3db502017-10-18 13:48:10 +020057int bitvec_set_u64(struct bitvec *bv, uint64_t v, uint8_t num_bits, bool use_lh);
Harald Welte449324b2017-01-15 17:55:32 +010058int bitvec_set_uint(struct bitvec *bv, unsigned int in, unsigned int count);
Maxe49af082016-01-22 16:46:56 +010059int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits);
Pablo Neira Ayuso36bdf2c2011-03-28 19:24:19 +020060int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, enum bit_value val);
Harald Welteec8b4502010-02-20 20:34:29 +010061int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit);
Maxe49af082016-01-22 16:46:56 +010062int bitvec_get_bytes(struct bitvec *bv, uint8_t *bytes, unsigned int count);
63int bitvec_set_bytes(struct bitvec *bv, const uint8_t *bytes, unsigned int count);
Maxa15f05f2016-01-26 10:43:15 +010064struct bitvec *bitvec_alloc(unsigned int size, TALLOC_CTX *bvctx);
65void bitvec_free(struct bitvec *bv);
66int bitvec_unhex(struct bitvec *bv, const char *src);
67unsigned int bitvec_pack(const struct bitvec *bv, uint8_t *buffer);
68unsigned int bitvec_unpack(struct bitvec *bv, const uint8_t *buffer);
Holger Hans Peter Freythera9301a12016-01-30 10:54:43 +010069uint64_t bitvec_read_field(struct bitvec *bv, unsigned int *read_index, unsigned int len);
70int bitvec_write_field(struct bitvec *bv, unsigned int *write_index, uint64_t val, unsigned int len);
Max0a59e982016-02-05 13:55:37 +010071int bitvec_fill(struct bitvec *bv, unsigned int num_bits, enum bit_value fill);
72char bit_value_to_char(enum bit_value v);
73void bitvec_to_string_r(const struct bitvec *bv, char *str);
74void bitvec_zero(struct bitvec *bv);
75unsigned bitvec_rl(const struct bitvec *bv, bool b);
Harald Weltec85aaed2022-01-09 11:56:19 +010076unsigned bitvec_rl_curbit(struct bitvec *bv, bool b, unsigned int max_bits);
Max0a59e982016-02-05 13:55:37 +010077void bitvec_shiftl(struct bitvec *bv, unsigned int n);
78int16_t bitvec_get_int16_msb(const struct bitvec *bv, unsigned int num_bits);
Maxd4793212016-03-17 11:51:08 +010079unsigned int bitvec_add_array(struct bitvec *bv, const uint32_t *array,
80 unsigned int array_len, bool dry_run,
81 unsigned int num_bits);
Harald Welteec8b4502010-02-20 20:34:29 +010082
Harald Welteae7966d2019-02-03 12:04:46 +010083/*! Return the number of bytes used within the bit vector */
84static inline unsigned int bitvec_used_bytes(const struct bitvec *bv)
85{
86 unsigned int bytes = bv->cur_bit/8;
87 if (bv->cur_bit%8)
88 bytes++;
89 return bytes;
90}
91
Harald Welteb0708d32019-02-04 12:09:05 +010092/*! Return the tailroom in number of unused bits remaining in the bit-vector */
93static inline unsigned int bitvec_tailroom_bits(const struct bitvec *bv)
94{
95 return bv->data_len*8 - bv->cur_bit;
96}
97
Sylvain Munautdca7d2c2012-04-18 21:53:23 +020098/*! @} */