libosmocore  0.9.6.311-c977
Osmocom core library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
bitvec.h
Go to the documentation of this file.
1 /* (C) 2009 by Harald Welte <laforge@gnumonks.org>
2  * (C) 2012 Ivan Klyuchnikov
3  * (C) 2015 Sysmocom s.f.m.c. GmbH
4  *
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  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  */
22 
23 #pragma once
24 
29 #include <stdint.h>
30 #include <osmocom/core/talloc.h>
31 #include <stdbool.h>
32 
37 enum bit_value {
38  ZERO = 0,
39  ONE = 1,
40  L = 2,
41  H = 3,
42 };
43 
45 struct bitvec {
46  unsigned int cur_bit;
47  unsigned int data_len;
48  uint8_t *data;
49 };
50 
51 enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr);
52 enum bit_value bitvec_get_bit_pos_high(const struct bitvec *bv,
53  unsigned int bitnr);
54 unsigned int bitvec_get_nth_set_bit(const struct bitvec *bv, unsigned int n);
55 int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnum,
56  enum bit_value bit);
57 int bitvec_set_bit(struct bitvec *bv, enum bit_value bit);
58 int bitvec_get_bit_high(struct bitvec *bv);
59 int bitvec_set_bits(struct bitvec *bv, const enum bit_value *bits, unsigned int count);
60 int bitvec_set_uint(struct bitvec *bv, unsigned int in, unsigned int count);
61 int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits);
62 int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, enum bit_value val);
63 int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit);
64 int bitvec_get_bytes(struct bitvec *bv, uint8_t *bytes, unsigned int count);
65 int bitvec_set_bytes(struct bitvec *bv, const uint8_t *bytes, unsigned int count);
66 struct bitvec *bitvec_alloc(unsigned int size, TALLOC_CTX *bvctx);
67 void bitvec_free(struct bitvec *bv);
68 int bitvec_unhex(struct bitvec *bv, const char *src);
69 unsigned int bitvec_pack(const struct bitvec *bv, uint8_t *buffer);
70 unsigned int bitvec_unpack(struct bitvec *bv, const uint8_t *buffer);
71 uint64_t bitvec_read_field(struct bitvec *bv, unsigned int *read_index, unsigned int len);
72 int bitvec_write_field(struct bitvec *bv, unsigned int *write_index, uint64_t val, unsigned int len);
73 int bitvec_fill(struct bitvec *bv, unsigned int num_bits, enum bit_value fill);
74 char bit_value_to_char(enum bit_value v);
75 void bitvec_to_string_r(const struct bitvec *bv, char *str);
76 void bitvec_zero(struct bitvec *bv);
77 unsigned bitvec_rl(const struct bitvec *bv, bool b);
78 unsigned bitvec_rl_curbit(struct bitvec *bv, bool b, int max_bits);
79 void bitvec_shiftl(struct bitvec *bv, unsigned int n);
80 int16_t bitvec_get_int16_msb(const struct bitvec *bv, unsigned int num_bits);
81 unsigned int bitvec_add_array(struct bitvec *bv, const uint32_t *array,
82  unsigned int array_len, bool dry_run,
83  unsigned int num_bits);
84 
unsigned bitvec_rl(const struct bitvec *bv, bool b)
Return number (bits) of uninterrupted bit run in vector starting from the MSB.
Definition: bitvec.c:571
unsigned int bitvec_unpack(struct bitvec *bv, const uint8_t *buffer)
Copy buffer of unpacked bits into bit vector.
Definition: bitvec.c:429
int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits)
get multiple bits (based on numeric value) from current pos
Definition: bitvec.c:251
int bitvec_set_bytes(struct bitvec *bv, const uint8_t *bytes, unsigned int count)
set multiple bytes at current pos Assumes MSB first encoding.
Definition: bitvec.c:350
unsigned bitvec_rl_curbit(struct bitvec *bv, bool b, int max_bits)
Return number (bits) of uninterrupted bit run in vector starting from the current bit...
Definition: bitvec.c:590
int bitvec_get_bit_high(struct bitvec *bv)
get the next bit (low/high) inside a bitvec
Definition: bitvec.c:189
A CSN.1 "L" bit.
Definition: bitvec.h:40
int bitvec_unhex(struct bitvec *bv, const char *src)
read hexadecimap string into a bit vector
Definition: bitvec.c:443
int bitvec_set_bits(struct bitvec *bv, const enum bit_value *bits, unsigned int count)
set multiple bits (based on array of bitvals) at current pos
Definition: bitvec.c:205
Convenience wrapper.
int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnum, enum bit_value bit)
set a bit at given position in a bit vector
Definition: bitvec.c:150
unsigned int data_len
length of data array in bytes
Definition: bitvec.h:47
A one (1) bit.
Definition: bitvec.h:39
int bitvec_write_field(struct bitvec *bv, unsigned int *write_index, uint64_t val, unsigned int len)
write into the vector
Definition: bitvec.c:489
void bitvec_free(struct bitvec *bv)
Free a bit vector (release its memory)
Definition: bitvec.c:406
int16_t bitvec_get_int16_msb(const struct bitvec *bv, unsigned int num_bits)
get multiple bits (num_bits) from beginning of vector (MSB side)
Definition: bitvec.c:238
bit_value
A single GSM bit.
Definition: bitvec.h:37
int bitvec_get_bytes(struct bitvec *bv, uint8_t *bytes, unsigned int count)
get multiple bytes from current pos Assumes MSB first encoding.
Definition: bitvec.c:314
structure describing a bit vector
Definition: bitvec.h:45
void bitvec_zero(struct bitvec *bv)
force bit vector to all 0 and current bit to the beginnig of the vector
Definition: bitvec.c:560
enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr)
check if the bit is 0 or 1 for a given position inside a bitvec
Definition: bitvec.c:84
unsigned int bitvec_add_array(struct bitvec *bv, const uint32_t *array, unsigned int array_len, bool dry_run, unsigned int num_bits)
Add given array to bitvec.
Definition: bitvec.c:670
unsigned int cur_bit
cursor to the next unused bit
Definition: bitvec.h:46
unsigned int bitvec_pack(const struct bitvec *bv, uint8_t *buffer)
Export a bit vector to a buffer.
Definition: bitvec.c:416
uint64_t bitvec_read_field(struct bitvec *bv, unsigned int *read_index, unsigned int len)
read part of the vector
Definition: bitvec.c:465
int bitvec_set_bit(struct bitvec *bv, enum bit_value bit)
set the next bit inside a bitvec
Definition: bitvec.c:176
uint8_t * data
pointer to data array
Definition: bitvec.h:48
int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit)
pad all remaining bits up to num_bits
Definition: bitvec.c:283
A CSN.1 "H" bit.
Definition: bitvec.h:41
void bitvec_to_string_r(const struct bitvec *bv, char *str)
prints bit vector to provided string It's caller's responsibility to ensure that we won't shoot him i...
Definition: bitvec.c:524
int bitvec_fill(struct bitvec *bv, unsigned int num_bits, enum bit_value fill)
fill num_bits with starting from the current position
Definition: bitvec.c:271
unsigned int bitvec_get_nth_set_bit(const struct bitvec *bv, unsigned int n)
get the Nth set bit inside the bit vector
Definition: bitvec.c:129
void bitvec_shiftl(struct bitvec *bv, unsigned int n)
int bitvec_set_uint(struct bitvec *bv, unsigned int in, unsigned int count)
set multiple bits (based on numeric value) at current pos
Definition: bitvec.c:220
enum bit_value bitvec_get_bit_pos_high(const struct bitvec *bv, unsigned int bitnr)
check if the bit is L or H for a given position inside a bitvec
Definition: bitvec.c:106
A zero (0) bit.
Definition: bitvec.h:38
char bit_value_to_char(enum bit_value v)
convert enum to corresponding character
Definition: bitvec.c:509
int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, enum bit_value val)
find first bit set in bit vector
Definition: bitvec.c:294
struct bitvec * bitvec_alloc(unsigned int size, TALLOC_CTX *bvctx)
Allocate a bit vector.
Definition: bitvec.c:387