Add support for landlock_create_ruleset (444), landlock_add_rule (445) and landlock_r...
[valgrind.git] / drd / drd_bitmap.h
blob3b71d749a9fbca40246611653a9744c45d8cc304
1 /*
2 This file is part of drd, a thread error detector.
4 Copyright (C) 2006-2020 Bart Van Assche <bvanassche@acm.org>.
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License as
8 published by the Free Software Foundation; either version 2 of the
9 License, or (at your option) any later version.
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, see <http://www.gnu.org/licenses/>.
19 The GNU General Public License is contained in the file COPYING.
23 #ifndef __DRD_BITMAP_H
24 #define __DRD_BITMAP_H
27 #include "pub_drd_bitmap.h"
28 #include "pub_tool_basics.h"
29 #include "pub_tool_oset.h"
30 #include "pub_tool_libcbase.h"
31 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
32 #include "pub_tool_libcassert.h"
33 #endif
36 /* Bitmap representation. A bitmap is a data structure in which two bits are
37 * reserved per 32 bit address: one bit that indicates that the data at the
38 * specified address has been read, and one bit that indicates that the data
39 * has been written to.
42 /* Client addresses are split into bitfields as follows:
43 * ------------------------------------------------------
44 * | Address MSB | Address LSB | Ignored bits |
45 * ------------------------------------------------------
46 * | Address MSB | UWord MSB | UWord LSB | Ignored bits |
47 * ------------------------------------------------------
52 /* Address MSB / LSB split. */
55 /** Number of least significant address bits that are ignored. */
56 #define ADDR_IGNORED_BITS 0
57 #define ADDR_IGNORED_MASK ((1U << ADDR_IGNORED_BITS) - 1U)
58 #define ADDR_GRANULARITY (1U << ADDR_IGNORED_BITS)
60 /**
61 * Round argument a up to a multiple of (1 << ADDR_GRANULARITY), and next
62 * shift it right ADDR_GRANULARITY bits. The expression below is optimized
63 * for the case where a is a constant.
65 #define SCALED_SIZE(a) \
66 (((((a) - 1U) | ADDR_IGNORED_MASK) + 1U) >> ADDR_IGNORED_BITS)
68 /**
69 * Number of bits assigned to the least significant component of an address.
71 #define ADDR_LSB_BITS 12
73 /**
74 * Mask that has to be applied to an address of type Addr in order to
75 * compute the least significant part of an address split, after having
76 * shifted the address bits ADDR_GRANULARITY to the right.
78 #define ADDR_LSB_MASK (((UWord)1 << ADDR_LSB_BITS) - 1U)
80 /** Compute least significant bits of an address of type Addr. */
81 static __inline__
82 UWord address_lsb(const Addr a)
83 { return (a >> ADDR_IGNORED_BITS) & ADDR_LSB_MASK; }
85 /**
86 * Compute the first address for which address_lsb() is equal to
87 * address_lsb(a).
89 static __inline__
90 Addr first_address_with_same_lsb(const Addr a)
92 return ((a | ADDR_IGNORED_MASK) ^ ADDR_IGNORED_MASK);
95 /**
96 * Compute the first address for which address_lsb() is greater than
97 * address_lsb(a).
99 static __inline__
100 Addr first_address_with_higher_lsb(const Addr a)
102 return ((a | ADDR_IGNORED_MASK) + 1U);
105 /** Compute most significant bits of an address of type Addr. */
106 static __inline__
107 UWord address_msb(const Addr a)
108 { return a >> (ADDR_LSB_BITS + ADDR_IGNORED_BITS); }
110 static __inline__
111 Addr first_address_with_higher_msb(const Addr a)
113 return ((a | ((ADDR_LSB_MASK << ADDR_IGNORED_BITS) | ADDR_IGNORED_MASK))
114 + 1U);
118 * Convert LSB and MSB back into an address.
120 * @note It is assumed that sizeof(Addr) == sizeof(UWord).
122 static __inline__
123 Addr make_address(const UWord a1, const UWord a0)
125 return ((a1 << (ADDR_LSB_BITS + ADDR_IGNORED_BITS))
126 | (a0 << ADDR_IGNORED_BITS));
133 /** Number of bits that fit in a variable of type UWord. */
134 #define BITS_PER_UWORD (8U * sizeof(UWord))
136 /** Log2 of BITS_PER_UWORD. */
137 #if defined(VGA_x86) || defined(VGA_ppc32) || defined(VGA_arm) \
138 || defined(VGA_mips32) || defined(VGA_nanomips) \
139 || (defined(VGA_mips64) && defined(VGABI_N32))
140 #define BITS_PER_BITS_PER_UWORD 5
141 #elif defined(VGA_amd64) || defined(VGA_ppc64be) || defined(VGA_ppc64le) \
142 || defined(VGA_s390x) || (defined(VGA_mips64) && !defined(VGABI_N32)) \
143 || defined(VGA_arm64)
144 #define BITS_PER_BITS_PER_UWORD 6
145 #else
146 #error Unknown platform.
147 #endif
149 /** Number of UWord's needed to store one bit per address LSB. */
150 #define BITMAP1_UWORD_COUNT (1U << (ADDR_LSB_BITS - BITS_PER_BITS_PER_UWORD))
153 * Mask that has to be applied to an (Addr >> ADDR_IGNORED_BITS) expression
154 * in order to compute the least significant part of an UWord.
156 #define UWORD_LSB_MASK (((UWord)1 << BITS_PER_BITS_PER_UWORD) - 1)
159 * Compute index into bm0[] array.
161 * @param a Address shifted right ADDR_IGNORED_BITS bits.
163 static __inline__
164 UWord uword_msb(const UWord a)
166 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
167 tl_assert(a < (1U << ADDR_LSB_BITS));
168 #endif
169 return a >> BITS_PER_BITS_PER_UWORD;
173 * Return the least significant bits.
175 * @param a Address shifted right ADDR_IGNORED_BITS bits.
177 static __inline__
178 UWord uword_lsb(const UWord a)
180 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
181 tl_assert(a < (1U << ADDR_LSB_BITS));
182 #endif
183 return a & UWORD_LSB_MASK;
187 * Compute the highest address lower than a for which
188 * uword_lsb(address_lsb(a)) == 0.
190 * @param a Address.
192 static __inline__
193 Addr first_address_with_same_uword_lsb(const Addr a)
195 return (a & (~UWORD_LSB_MASK << ADDR_IGNORED_BITS));
199 * First address that will go in the UWord past the one 'a' goes in.
201 * @param a Address.
203 static __inline__
204 Addr first_address_with_higher_uword_msb(const Addr a)
206 return ((a | ((UWORD_LSB_MASK << ADDR_IGNORED_BITS) | ADDR_IGNORED_MASK))
207 + 1);
212 /* Local variables. */
214 static ULong s_bitmap2_creation_count;
218 /*********************************************************************/
219 /* Functions for manipulating a struct bitmap1. */
220 /*********************************************************************/
223 /* Lowest level, corresponding to the lowest ADDR_LSB_BITS of an address. */
224 struct bitmap1
226 UWord bm0_r[BITMAP1_UWORD_COUNT];
227 UWord bm0_w[BITMAP1_UWORD_COUNT];
230 static __inline__ UWord bm0_mask(const UWord a)
232 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
233 tl_assert(address_msb(make_address(0, a)) == 0);
234 #endif
235 return ((UWord)1 << uword_lsb(a));
238 /** Set the bit corresponding to address a in bitmap bm0. */
239 static __inline__ void bm0_set(UWord* bm0, const UWord a)
241 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
242 tl_assert(address_msb(make_address(0, a)) == 0);
243 #endif
244 bm0[uword_msb(a)] |= (UWord)1 << uword_lsb(a);
248 * Set the bits corresponding to all of the addresses in range
249 * [ a << ADDR_IGNORED_BITS .. (a + size) << ADDR_IGNORED_BITS [
250 * in bitmap bm0.
252 static __inline__ void bm0_set_range(UWord* bm0,
253 const UWord a, const SizeT size)
255 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
256 tl_assert(size > 0);
257 tl_assert(address_msb(make_address(0, a)) == 0);
258 tl_assert(address_msb(make_address(0, a + size - 1)) == 0);
259 tl_assert(uword_msb(a) == uword_msb(a + size - 1));
260 #endif
261 bm0[uword_msb(a)]
262 |= (((UWord)1 << size) - 1) << uword_lsb(a);
265 /** Clear the bit corresponding to address a in bitmap bm0. */
266 static __inline__ void bm0_clear(UWord* bm0, const UWord a)
268 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
269 tl_assert(address_msb(make_address(0, a)) == 0);
270 #endif
271 bm0[uword_msb(a)] &= ~((UWord)1 << uword_lsb(a));
275 * Clear all of the addresses in range
276 * [ a << ADDR_IGNORED_BITS .. (a + size) << ADDR_IGNORED_BITS [
277 * in bitmap bm0.
279 static __inline__ void bm0_clear_range(UWord* bm0,
280 const UWord a, const SizeT size)
282 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
283 tl_assert(address_msb(make_address(0, a)) == 0);
284 tl_assert(size == 0 || address_msb(make_address(0, a + size - 1)) == 0);
285 tl_assert(size == 0 || uword_msb(a) == uword_msb(a + size - 1));
286 #endif
288 * Note: although the expression below yields a correct result even if
289 * size == 0, do not touch bm0[] if size == 0 because this might otherwise
290 * cause an access of memory just past the end of the bm0[] array.
292 if (size > 0)
294 bm0[uword_msb(a)]
295 &= ~((((UWord)1 << size) - 1) << uword_lsb(a));
299 /** Test whether the bit corresponding to address a is set in bitmap bm0. */
300 static __inline__ UWord bm0_is_set(const UWord* bm0, const UWord a)
302 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
303 tl_assert(address_msb(make_address(0, a)) == 0);
304 #endif
305 return (bm0[uword_msb(a)] & ((UWord)1 << uword_lsb(a)));
309 * Return true if a bit corresponding to any of the addresses in range
310 * [ a << ADDR_IGNORED_BITS .. (a + size) << ADDR_IGNORED_BITS [
311 * is set in bm0.
313 static __inline__ UWord bm0_is_any_set(const UWord* bm0,
314 const Addr a, const SizeT size)
316 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
317 tl_assert(size > 0);
318 tl_assert(address_msb(make_address(0, a)) == 0);
319 tl_assert(address_msb(make_address(0, a + size - 1)) == 0);
320 tl_assert(uword_msb(a) == uword_msb(a + size - 1));
321 #endif
322 return (bm0[uword_msb(a)] & ((((UWord)1 << size) - 1) << uword_lsb(a)));
327 /*********************************************************************/
328 /* Functions for manipulating a struct bitmap. */
329 /*********************************************************************/
332 /* Second level bitmap. */
333 struct bitmap2
335 Addr addr; ///< address_msb(...)
336 Bool recalc;
337 struct bitmap1 bm1;
341 static void bm2_clear(struct bitmap2* const bm2);
342 static __inline__
343 struct bitmap2* bm2_insert(struct bitmap* const bm, const UWord a1);
348 * Rotate elements cache[0..n-1] such that the element at position n-1 is
349 * moved to position 0. This allows to speed up future cache lookups.
351 static __inline__
352 void bm_cache_rotate(struct bm_cache_elem cache[], const int n)
354 #if 0
355 struct bm_cache_elem t;
357 tl_assert(2 <= n && n <= 8);
359 t = cache[0];
360 if (n > 1)
361 cache[0] = cache[1];
362 if (n > 2)
363 cache[1] = cache[2];
364 if (n > 3)
365 cache[2] = cache[3];
366 if (n > 4)
367 cache[3] = cache[4];
368 if (n > 5)
369 cache[4] = cache[5];
370 if (n > 6)
371 cache[5] = cache[6];
372 if (n > 7)
373 cache[6] = cache[7];
374 cache[n - 1] = t;
375 #endif
378 static __inline__
379 Bool bm_cache_lookup(struct bitmap* const bm, const UWord a1,
380 struct bitmap2** bm2)
382 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
383 tl_assert(bm);
384 tl_assert(bm2);
385 #endif
387 #if DRD_BITMAP_N_CACHE_ELEM > 8
388 #error Please update the code below.
389 #endif
390 #if DRD_BITMAP_N_CACHE_ELEM >= 1
391 if (a1 == bm->cache[0].a1)
393 *bm2 = bm->cache[0].bm2;
394 return True;
396 #endif
397 #if DRD_BITMAP_N_CACHE_ELEM >= 2
398 if (a1 == bm->cache[1].a1)
400 *bm2 = bm->cache[1].bm2;
401 return True;
403 #endif
404 #if DRD_BITMAP_N_CACHE_ELEM >= 3
405 if (a1 == bm->cache[2].a1)
407 *bm2 = bm->cache[2].bm2;
408 bm_cache_rotate(bm->cache, 3);
409 return True;
411 #endif
412 #if DRD_BITMAP_N_CACHE_ELEM >= 4
413 if (a1 == bm->cache[3].a1)
415 *bm2 = bm->cache[3].bm2;
416 bm_cache_rotate(bm->cache, 4);
417 return True;
419 #endif
420 #if DRD_BITMAP_N_CACHE_ELEM >= 5
421 if (a1 == bm->cache[4].a1)
423 *bm2 = bm->cache[4].bm2;
424 bm_cache_rotate(bm->cache, 5);
425 return True;
427 #endif
428 #if DRD_BITMAP_N_CACHE_ELEM >= 6
429 if (a1 == bm->cache[5].a1)
431 *bm2 = bm->cache[5].bm2;
432 bm_cache_rotate(bm->cache, 6);
433 return True;
435 #endif
436 #if DRD_BITMAP_N_CACHE_ELEM >= 7
437 if (a1 == bm->cache[6].a1)
439 *bm2 = bm->cache[6].bm2;
440 bm_cache_rotate(bm->cache, 7);
441 return True;
443 #endif
444 #if DRD_BITMAP_N_CACHE_ELEM >= 8
445 if (a1 == bm->cache[7].a1)
447 *bm2 = bm->cache[7].bm2;
448 bm_cache_rotate(bm->cache, 8);
449 return True;
451 #endif
452 *bm2 = 0;
453 return False;
456 static __inline__
457 void bm_update_cache(struct bitmap* const bm,
458 const UWord a1,
459 struct bitmap2* const bm2)
461 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
462 tl_assert(bm);
463 #endif
465 #if DRD_BITMAP_N_CACHE_ELEM > 8
466 #error Please update the code below.
467 #endif
468 #if DRD_BITMAP_N_CACHE_ELEM >= 8
469 bm->cache[7] = bm->cache[6];
470 #endif
471 #if DRD_BITMAP_N_CACHE_ELEM >= 7
472 bm->cache[6] = bm->cache[5];
473 #endif
474 #if DRD_BITMAP_N_CACHE_ELEM >= 6
475 bm->cache[5] = bm->cache[4];
476 #endif
477 #if DRD_BITMAP_N_CACHE_ELEM >= 5
478 bm->cache[4] = bm->cache[3];
479 #endif
480 #if DRD_BITMAP_N_CACHE_ELEM >= 4
481 bm->cache[3] = bm->cache[2];
482 #endif
483 #if DRD_BITMAP_N_CACHE_ELEM >= 3
484 bm->cache[2] = bm->cache[1];
485 #endif
486 #if DRD_BITMAP_N_CACHE_ELEM >= 2
487 bm->cache[1] = bm->cache[0];
488 #endif
489 bm->cache[0].a1 = a1;
490 bm->cache[0].bm2 = bm2;
494 * Look up the address a1 in bitmap bm and return a pointer to a potentially
495 * shared second level bitmap. The bitmap where the returned pointer points
496 * at may not be modified by the caller.
498 * @param a1 client address shifted right by ADDR_LSB_BITS.
499 * @param bm bitmap pointer.
501 static __inline__
502 const struct bitmap2* bm2_lookup(struct bitmap* const bm, const UWord a1)
504 struct bitmap2* bm2;
506 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
507 tl_assert(bm);
508 #endif
510 if (! bm_cache_lookup(bm, a1, &bm2))
512 bm2 = VG_(OSetGen_Lookup)(bm->oset, &a1);
513 bm_update_cache(bm, a1, bm2);
515 return bm2;
519 * Look up the address a1 in bitmap bm and return a pointer to a second
520 * level bitmap that is not shared and hence may be modified.
522 * @param a1 client address shifted right by ADDR_LSB_BITS.
523 * @param bm bitmap pointer.
525 static __inline__
526 struct bitmap2*
527 bm2_lookup_exclusive(struct bitmap* const bm, const UWord a1)
529 struct bitmap2* bm2;
531 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
532 tl_assert(bm);
533 #endif
535 if (! bm_cache_lookup(bm, a1, &bm2))
537 bm2 = VG_(OSetGen_Lookup)(bm->oset, &a1);
540 return bm2;
543 /** Clear the content of the second-level bitmap. */
544 static __inline__
545 void bm2_clear(struct bitmap2* const bm2)
547 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
548 tl_assert(bm2);
549 #endif
550 VG_(memset)(&bm2->bm1, 0, sizeof(bm2->bm1));
554 * Insert an uninitialized second level bitmap for the address a1.
556 * @param bm bitmap pointer.
557 * @param a1 client address shifted right by ADDR_LSB_BITS.
559 * @note bitmap2::recalc isn't initialized here on purpose.
561 static __inline__
562 struct bitmap2* bm2_insert(struct bitmap* const bm, const UWord a1)
564 struct bitmap2* bm2;
566 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
567 tl_assert(bm);
568 #endif
570 s_bitmap2_creation_count++;
572 bm2 = VG_(OSetGen_AllocNode)(bm->oset, sizeof(*bm2));
573 bm2->addr = a1;
574 VG_(OSetGen_Insert)(bm->oset, bm2);
576 bm_update_cache(bm, a1, bm2);
578 return bm2;
581 static __inline__
582 struct bitmap2* bm2_insert_copy(struct bitmap* const bm,
583 struct bitmap2* const bm2)
585 struct bitmap2* bm2_copy;
587 bm2_copy = bm2_insert(bm, bm2->addr);
588 VG_(memcpy)(&bm2_copy->bm1, &bm2->bm1, sizeof(bm2->bm1));
589 return bm2_copy;
593 * Look up the address a1 in bitmap bm, and insert it if not found.
594 * The returned second level bitmap may not be modified.
596 * @param bm bitmap pointer.
597 * @param a1 client address shifted right by ADDR_LSB_BITS.
599 static __inline__
600 struct bitmap2* bm2_lookup_or_insert(struct bitmap* const bm, const UWord a1)
602 struct bitmap2* bm2;
604 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
605 tl_assert(bm);
606 #endif
608 if (bm_cache_lookup(bm, a1, &bm2))
610 if (bm2 == 0)
612 bm2 = bm2_insert(bm, a1);
613 bm2_clear(bm2);
616 else
618 bm2 = VG_(OSetGen_Lookup)(bm->oset, &a1);
619 if (! bm2)
621 bm2 = bm2_insert(bm, a1);
622 bm2_clear(bm2);
624 bm_update_cache(bm, a1, bm2);
626 return bm2;
630 * Look up the address a1 in bitmap bm, and insert it if not found.
631 * The returned second level bitmap may be modified.
633 * @param a1 client address shifted right by ADDR_LSB_BITS.
634 * @param bm bitmap pointer.
636 static __inline__
637 struct bitmap2* bm2_lookup_or_insert_exclusive(struct bitmap* const bm,
638 const UWord a1)
640 return bm2_lookup_or_insert(bm, a1);
643 static __inline__
644 void bm2_remove(struct bitmap* const bm, const UWord a1)
646 struct bitmap2* bm2;
648 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
649 tl_assert(bm);
650 #endif
652 bm2 = VG_(OSetGen_Remove)(bm->oset, &a1);
653 VG_(OSetGen_FreeNode)(bm->oset, bm2);
655 bm_update_cache(bm, a1, NULL);
658 static __inline__
659 void bm_access_aligned_load(struct bitmap* const bm,
660 const Addr a1, const SizeT size)
662 struct bitmap2* bm2;
664 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
665 tl_assert(bm);
666 #endif
668 bm2 = bm2_lookup_or_insert_exclusive(bm, address_msb(a1));
669 bm0_set_range(bm2->bm1.bm0_r,
670 (a1 >> ADDR_IGNORED_BITS) & ADDR_LSB_MASK,
671 SCALED_SIZE(size));
674 static __inline__
675 void bm_access_aligned_store(struct bitmap* const bm,
676 const Addr a1, const SizeT size)
678 struct bitmap2* bm2;
680 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
681 tl_assert(bm);
682 #endif
684 bm2 = bm2_lookup_or_insert_exclusive(bm, address_msb(a1));
685 bm0_set_range(bm2->bm1.bm0_w,
686 (a1 >> ADDR_IGNORED_BITS) & ADDR_LSB_MASK,
687 SCALED_SIZE(size));
690 static __inline__
691 Bool bm_aligned_load_has_conflict_with(struct bitmap* const bm,
692 const Addr a, const SizeT size)
694 const struct bitmap2* bm2;
696 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
697 tl_assert(bm);
698 #endif
700 bm2 = bm2_lookup(bm, address_msb(a));
701 return (bm2
702 && bm0_is_any_set(bm2->bm1.bm0_w,
703 address_lsb(a),
704 SCALED_SIZE(size)));
707 static __inline__
708 Bool bm_aligned_store_has_conflict_with(struct bitmap* const bm,
709 const Addr a, const SizeT size)
711 const struct bitmap2* bm2;
713 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
714 tl_assert(bm);
715 #endif
717 bm2 = bm2_lookup(bm, address_msb(a));
718 if (bm2)
720 if (bm0_is_any_set(bm2->bm1.bm0_r, address_lsb(a), SCALED_SIZE(size))
721 | bm0_is_any_set(bm2->bm1.bm0_w, address_lsb(a), SCALED_SIZE(size)))
723 return True;
726 return False;
729 #endif /* __DRD_BITMAP_H */