xref: /dflybsd-src/crypto/openssh/bitmap.c (revision 664f47636b7e6e9e2c54a4799ca4884a9c628df5)
1*664f4763Szrj /* $OpenBSD: bitmap.c,v 1.9 2017/10/20 01:56:39 djm Exp $ */
2e9778795SPeter Avalos /*
3e9778795SPeter Avalos  * Copyright (c) 2015 Damien Miller <djm@mindrot.org>
4e9778795SPeter Avalos  *
5e9778795SPeter Avalos  * Permission to use, copy, modify, and distribute this software for any
6e9778795SPeter Avalos  * purpose with or without fee is hereby granted, provided that the above
7e9778795SPeter Avalos  * copyright notice and this permission notice appear in all copies.
8e9778795SPeter Avalos  *
9e9778795SPeter Avalos  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10e9778795SPeter Avalos  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11e9778795SPeter Avalos  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12e9778795SPeter Avalos  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13e9778795SPeter Avalos  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14e9778795SPeter Avalos  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15e9778795SPeter Avalos  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16e9778795SPeter Avalos  */
17e9778795SPeter Avalos 
18e9778795SPeter Avalos #include "includes.h"
19e9778795SPeter Avalos 
20e9778795SPeter Avalos #include <sys/types.h>
21e9778795SPeter Avalos #include <string.h>
22e9778795SPeter Avalos #include <stdlib.h>
23e9778795SPeter Avalos 
24e9778795SPeter Avalos #include "bitmap.h"
25e9778795SPeter Avalos 
26e9778795SPeter Avalos #define BITMAP_WTYPE	u_int
27e9778795SPeter Avalos #define BITMAP_MAX	(1<<24)
28e9778795SPeter Avalos #define BITMAP_BYTES	(sizeof(BITMAP_WTYPE))
29e9778795SPeter Avalos #define BITMAP_BITS	(sizeof(BITMAP_WTYPE) * 8)
30e9778795SPeter Avalos #define BITMAP_WMASK	((BITMAP_WTYPE)BITMAP_BITS - 1)
31e9778795SPeter Avalos struct bitmap {
32e9778795SPeter Avalos 	BITMAP_WTYPE *d;
33e9778795SPeter Avalos 	size_t len; /* number of words allocated */
34e9778795SPeter Avalos 	size_t top; /* index of top word allocated */
35e9778795SPeter Avalos };
36e9778795SPeter Avalos 
37e9778795SPeter Avalos struct bitmap *
bitmap_new(void)38e9778795SPeter Avalos bitmap_new(void)
39e9778795SPeter Avalos {
40e9778795SPeter Avalos 	struct bitmap *ret;
41e9778795SPeter Avalos 
42e9778795SPeter Avalos 	if ((ret = calloc(1, sizeof(*ret))) == NULL)
43e9778795SPeter Avalos 		return NULL;
44e9778795SPeter Avalos 	if ((ret->d = calloc(1, BITMAP_BYTES)) == NULL) {
45e9778795SPeter Avalos 		free(ret);
46e9778795SPeter Avalos 		return NULL;
47e9778795SPeter Avalos 	}
48e9778795SPeter Avalos 	ret->len = 1;
49e9778795SPeter Avalos 	ret->top = 0;
50e9778795SPeter Avalos 	return ret;
51e9778795SPeter Avalos }
52e9778795SPeter Avalos 
53e9778795SPeter Avalos void
bitmap_free(struct bitmap * b)54e9778795SPeter Avalos bitmap_free(struct bitmap *b)
55e9778795SPeter Avalos {
56e9778795SPeter Avalos 	if (b != NULL && b->d != NULL) {
57ce74bacaSMatthew Dillon 		bitmap_zero(b);
58e9778795SPeter Avalos 		free(b->d);
59ce74bacaSMatthew Dillon 		b->d = NULL;
60e9778795SPeter Avalos 	}
61e9778795SPeter Avalos 	free(b);
62e9778795SPeter Avalos }
63e9778795SPeter Avalos 
64e9778795SPeter Avalos void
bitmap_zero(struct bitmap * b)65e9778795SPeter Avalos bitmap_zero(struct bitmap *b)
66e9778795SPeter Avalos {
67e9778795SPeter Avalos 	memset(b->d, 0, b->len * BITMAP_BYTES);
68e9778795SPeter Avalos 	b->top = 0;
69e9778795SPeter Avalos }
70e9778795SPeter Avalos 
71e9778795SPeter Avalos int
bitmap_test_bit(struct bitmap * b,u_int n)72e9778795SPeter Avalos bitmap_test_bit(struct bitmap *b, u_int n)
73e9778795SPeter Avalos {
74e9778795SPeter Avalos 	if (b->top >= b->len)
75e9778795SPeter Avalos 		return 0; /* invalid */
76e9778795SPeter Avalos 	if (b->len == 0 || (n / BITMAP_BITS) > b->top)
77e9778795SPeter Avalos 		return 0;
78e9778795SPeter Avalos 	return (b->d[n / BITMAP_BITS] >> (n & BITMAP_WMASK)) & 1;
79e9778795SPeter Avalos }
80e9778795SPeter Avalos 
81e9778795SPeter Avalos static int
reserve(struct bitmap * b,u_int n)82e9778795SPeter Avalos reserve(struct bitmap *b, u_int n)
83e9778795SPeter Avalos {
84e9778795SPeter Avalos 	BITMAP_WTYPE *tmp;
85e9778795SPeter Avalos 	size_t nlen;
86e9778795SPeter Avalos 
87e9778795SPeter Avalos 	if (b->top >= b->len || n > BITMAP_MAX)
88e9778795SPeter Avalos 		return -1; /* invalid */
89e9778795SPeter Avalos 	nlen = (n / BITMAP_BITS) + 1;
90e9778795SPeter Avalos 	if (b->len < nlen) {
91ce74bacaSMatthew Dillon 		if ((tmp = recallocarray(b->d, b->len,
92ce74bacaSMatthew Dillon 		    nlen, BITMAP_BYTES)) == NULL)
93e9778795SPeter Avalos 			return -1;
94e9778795SPeter Avalos 		b->d = tmp;
95e9778795SPeter Avalos 		b->len = nlen;
96e9778795SPeter Avalos 	}
97e9778795SPeter Avalos 	return 0;
98e9778795SPeter Avalos }
99e9778795SPeter Avalos 
100e9778795SPeter Avalos int
bitmap_set_bit(struct bitmap * b,u_int n)101e9778795SPeter Avalos bitmap_set_bit(struct bitmap *b, u_int n)
102e9778795SPeter Avalos {
103e9778795SPeter Avalos 	int r;
104e9778795SPeter Avalos 	size_t offset;
105e9778795SPeter Avalos 
106e9778795SPeter Avalos 	if ((r = reserve(b, n)) != 0)
107e9778795SPeter Avalos 		return r;
108e9778795SPeter Avalos 	offset = n / BITMAP_BITS;
109e9778795SPeter Avalos 	if (offset > b->top)
110e9778795SPeter Avalos 		b->top = offset;
111e9778795SPeter Avalos 	b->d[offset] |= (BITMAP_WTYPE)1 << (n & BITMAP_WMASK);
112e9778795SPeter Avalos 	return 0;
113e9778795SPeter Avalos }
114e9778795SPeter Avalos 
115e9778795SPeter Avalos /* Resets b->top to point to the most significant bit set in b->d */
116e9778795SPeter Avalos static void
retop(struct bitmap * b)117e9778795SPeter Avalos retop(struct bitmap *b)
118e9778795SPeter Avalos {
119e9778795SPeter Avalos 	if (b->top >= b->len)
120e9778795SPeter Avalos 		return;
121e9778795SPeter Avalos 	while (b->top > 0 && b->d[b->top] == 0)
122e9778795SPeter Avalos 		b->top--;
123e9778795SPeter Avalos }
124e9778795SPeter Avalos 
125e9778795SPeter Avalos void
bitmap_clear_bit(struct bitmap * b,u_int n)126e9778795SPeter Avalos bitmap_clear_bit(struct bitmap *b, u_int n)
127e9778795SPeter Avalos {
128e9778795SPeter Avalos 	size_t offset;
129e9778795SPeter Avalos 
130e9778795SPeter Avalos 	if (b->top >= b->len || n > BITMAP_MAX)
131e9778795SPeter Avalos 		return; /* invalid */
132e9778795SPeter Avalos 	offset = n / BITMAP_BITS;
133e9778795SPeter Avalos 	if (offset > b->top)
134e9778795SPeter Avalos 		return;
135e9778795SPeter Avalos 	b->d[offset] &= ~((BITMAP_WTYPE)1 << (n & BITMAP_WMASK));
136e9778795SPeter Avalos 	/* The top may have changed as a result of the clear */
137e9778795SPeter Avalos 	retop(b);
138e9778795SPeter Avalos }
139e9778795SPeter Avalos 
140e9778795SPeter Avalos size_t
bitmap_nbits(struct bitmap * b)141e9778795SPeter Avalos bitmap_nbits(struct bitmap *b)
142e9778795SPeter Avalos {
143e9778795SPeter Avalos 	size_t bits;
144e9778795SPeter Avalos 	BITMAP_WTYPE w;
145e9778795SPeter Avalos 
146e9778795SPeter Avalos 	retop(b);
147e9778795SPeter Avalos 	if (b->top >= b->len)
148e9778795SPeter Avalos 		return 0; /* invalid */
149e9778795SPeter Avalos 	if (b->len == 0 || (b->top == 0 && b->d[0] == 0))
150e9778795SPeter Avalos 		return 0;
151e9778795SPeter Avalos 	/* Find MSB set */
152e9778795SPeter Avalos 	w = b->d[b->top];
153e9778795SPeter Avalos 	bits = (b->top + 1) * BITMAP_BITS;
154e9778795SPeter Avalos 	while (!(w & ((BITMAP_WTYPE)1 << (BITMAP_BITS - 1)))) {
155e9778795SPeter Avalos 		w <<= 1;
156e9778795SPeter Avalos 		bits--;
157e9778795SPeter Avalos 	}
158e9778795SPeter Avalos 	return bits;
159e9778795SPeter Avalos }
160e9778795SPeter Avalos 
161e9778795SPeter Avalos size_t
bitmap_nbytes(struct bitmap * b)162e9778795SPeter Avalos bitmap_nbytes(struct bitmap *b)
163e9778795SPeter Avalos {
164e9778795SPeter Avalos 	return (bitmap_nbits(b) + 7) / 8;
165e9778795SPeter Avalos }
166e9778795SPeter Avalos 
167e9778795SPeter Avalos int
bitmap_to_string(struct bitmap * b,void * p,size_t l)168e9778795SPeter Avalos bitmap_to_string(struct bitmap *b, void *p, size_t l)
169e9778795SPeter Avalos {
170e9778795SPeter Avalos 	u_char *s = (u_char *)p;
171e9778795SPeter Avalos 	size_t i, j, k, need = bitmap_nbytes(b);
172e9778795SPeter Avalos 
173e9778795SPeter Avalos 	if (l < need || b->top >= b->len)
174e9778795SPeter Avalos 		return -1;
175e9778795SPeter Avalos 	if (l > need)
176e9778795SPeter Avalos 		l = need;
177e9778795SPeter Avalos 	/* Put the bytes from LSB backwards */
178e9778795SPeter Avalos 	for (i = k = 0; i < b->top + 1; i++) {
179e9778795SPeter Avalos 		for (j = 0; j < BITMAP_BYTES; j++) {
180e9778795SPeter Avalos 			if (k >= l)
181e9778795SPeter Avalos 				break;
182e9778795SPeter Avalos 			s[need - 1 - k++] = (b->d[i] >> (j * 8)) & 0xff;
183e9778795SPeter Avalos 		}
184e9778795SPeter Avalos 	}
185e9778795SPeter Avalos 	return 0;
186e9778795SPeter Avalos }
187e9778795SPeter Avalos 
188e9778795SPeter Avalos int
bitmap_from_string(struct bitmap * b,const void * p,size_t l)189e9778795SPeter Avalos bitmap_from_string(struct bitmap *b, const void *p, size_t l)
190e9778795SPeter Avalos {
191e9778795SPeter Avalos 	int r;
192e9778795SPeter Avalos 	size_t i, offset, shift;
193ce74bacaSMatthew Dillon 	const u_char *s = (const u_char *)p;
194e9778795SPeter Avalos 
195e9778795SPeter Avalos 	if (l > BITMAP_MAX / 8)
196e9778795SPeter Avalos 		return -1;
197e9778795SPeter Avalos 	if ((r = reserve(b, l * 8)) != 0)
198e9778795SPeter Avalos 		return r;
199e9778795SPeter Avalos 	bitmap_zero(b);
200e9778795SPeter Avalos 	if (l == 0)
201e9778795SPeter Avalos 		return 0;
202e9778795SPeter Avalos 	b->top = offset = ((l + (BITMAP_BYTES - 1)) / BITMAP_BYTES) - 1;
203e9778795SPeter Avalos 	shift = ((l + (BITMAP_BYTES - 1)) % BITMAP_BYTES) * 8;
204e9778795SPeter Avalos 	for (i = 0; i < l; i++) {
205e9778795SPeter Avalos 		b->d[offset] |= (BITMAP_WTYPE)s[i] << shift;
206e9778795SPeter Avalos 		if (shift == 0) {
207e9778795SPeter Avalos 			offset--;
208e9778795SPeter Avalos 			shift = BITMAP_BITS - 8;
209e9778795SPeter Avalos 		} else
210e9778795SPeter Avalos 			shift -= 8;
211e9778795SPeter Avalos 	}
212e9778795SPeter Avalos 	retop(b);
213e9778795SPeter Avalos 	return 0;
214e9778795SPeter Avalos }
215