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"
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)
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)
69 * Number of bits assigned to the least significant component of an address.
71 #define ADDR_LSB_BITS 12
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. */
82 UWord
address_lsb(const Addr a
)
83 { return (a
>> ADDR_IGNORED_BITS
) & ADDR_LSB_MASK
; }
86 * Compute the first address for which address_lsb() is equal to
90 Addr
first_address_with_same_lsb(const Addr a
)
92 return ((a
| ADDR_IGNORED_MASK
) ^ ADDR_IGNORED_MASK
);
96 * Compute the first address for which address_lsb() is greater than
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. */
107 UWord
address_msb(const Addr a
)
108 { return a
>> (ADDR_LSB_BITS
+ ADDR_IGNORED_BITS
); }
111 Addr
first_address_with_higher_msb(const Addr a
)
113 return ((a
| ((ADDR_LSB_MASK
<< ADDR_IGNORED_BITS
) | ADDR_IGNORED_MASK
))
118 * Convert LSB and MSB back into an address.
120 * @note It is assumed that sizeof(Addr) == sizeof(UWord).
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
146 #error Unknown platform.
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.
164 UWord
uword_msb(const UWord a
)
166 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
167 tl_assert(a
< (1U << ADDR_LSB_BITS
));
169 return a
>> BITS_PER_BITS_PER_UWORD
;
173 * Return the least significant bits.
175 * @param a Address shifted right ADDR_IGNORED_BITS bits.
178 UWord
uword_lsb(const UWord a
)
180 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
181 tl_assert(a
< (1U << ADDR_LSB_BITS
));
183 return a
& UWORD_LSB_MASK
;
187 * Compute the highest address lower than a for which
188 * uword_lsb(address_lsb(a)) == 0.
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.
204 Addr
first_address_with_higher_uword_msb(const Addr a
)
206 return ((a
| ((UWORD_LSB_MASK
<< ADDR_IGNORED_BITS
) | ADDR_IGNORED_MASK
))
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. */
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);
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);
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 [
252 static __inline__
void bm0_set_range(UWord
* bm0
,
253 const UWord a
, const SizeT size
)
255 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
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));
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);
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 [
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));
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.
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);
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 [
313 static __inline__ UWord
bm0_is_any_set(const UWord
* bm0
,
314 const Addr a
, const SizeT size
)
316 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
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));
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. */
335 Addr addr
; ///< address_msb(...)
341 static void bm2_clear(struct bitmap2
* const bm2
);
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.
352 void bm_cache_rotate(struct bm_cache_elem cache
[], const int n
)
355 struct bm_cache_elem t
;
357 tl_assert(2 <= n
&& n
<= 8);
379 Bool
bm_cache_lookup(struct bitmap
* const bm
, const UWord a1
,
380 struct bitmap2
** bm2
)
382 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
387 #if DRD_BITMAP_N_CACHE_ELEM > 8
388 #error Please update the code below.
390 #if DRD_BITMAP_N_CACHE_ELEM >= 1
391 if (a1
== bm
->cache
[0].a1
)
393 *bm2
= bm
->cache
[0].bm2
;
397 #if DRD_BITMAP_N_CACHE_ELEM >= 2
398 if (a1
== bm
->cache
[1].a1
)
400 *bm2
= bm
->cache
[1].bm2
;
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);
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);
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);
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);
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);
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);
457 void bm_update_cache(struct bitmap
* const bm
,
459 struct bitmap2
* const bm2
)
461 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
465 #if DRD_BITMAP_N_CACHE_ELEM > 8
466 #error Please update the code below.
468 #if DRD_BITMAP_N_CACHE_ELEM >= 8
469 bm
->cache
[7] = bm
->cache
[6];
471 #if DRD_BITMAP_N_CACHE_ELEM >= 7
472 bm
->cache
[6] = bm
->cache
[5];
474 #if DRD_BITMAP_N_CACHE_ELEM >= 6
475 bm
->cache
[5] = bm
->cache
[4];
477 #if DRD_BITMAP_N_CACHE_ELEM >= 5
478 bm
->cache
[4] = bm
->cache
[3];
480 #if DRD_BITMAP_N_CACHE_ELEM >= 4
481 bm
->cache
[3] = bm
->cache
[2];
483 #if DRD_BITMAP_N_CACHE_ELEM >= 3
484 bm
->cache
[2] = bm
->cache
[1];
486 #if DRD_BITMAP_N_CACHE_ELEM >= 2
487 bm
->cache
[1] = bm
->cache
[0];
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.
502 const struct bitmap2
* bm2_lookup(struct bitmap
* const bm
, const UWord a1
)
506 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
510 if (! bm_cache_lookup(bm
, a1
, &bm2
))
512 bm2
= VG_(OSetGen_Lookup
)(bm
->oset
, &a1
);
513 bm_update_cache(bm
, a1
, 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.
527 bm2_lookup_exclusive(struct bitmap
* const bm
, const UWord a1
)
531 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
535 if (! bm_cache_lookup(bm
, a1
, &bm2
))
537 bm2
= VG_(OSetGen_Lookup
)(bm
->oset
, &a1
);
543 /** Clear the content of the second-level bitmap. */
545 void bm2_clear(struct bitmap2
* const bm2
)
547 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
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.
562 struct bitmap2
* bm2_insert(struct bitmap
* const bm
, const UWord a1
)
566 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
570 s_bitmap2_creation_count
++;
572 bm2
= VG_(OSetGen_AllocNode
)(bm
->oset
, sizeof(*bm2
));
574 VG_(OSetGen_Insert
)(bm
->oset
, bm2
);
576 bm_update_cache(bm
, a1
, bm2
);
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
));
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.
600 struct bitmap2
* bm2_lookup_or_insert(struct bitmap
* const bm
, const UWord a1
)
604 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
608 if (bm_cache_lookup(bm
, a1
, &bm2
))
612 bm2
= bm2_insert(bm
, a1
);
618 bm2
= VG_(OSetGen_Lookup
)(bm
->oset
, &a1
);
621 bm2
= bm2_insert(bm
, a1
);
624 bm_update_cache(bm
, a1
, 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.
637 struct bitmap2
* bm2_lookup_or_insert_exclusive(struct bitmap
* const bm
,
640 return bm2_lookup_or_insert(bm
, a1
);
644 void bm2_remove(struct bitmap
* const bm
, const UWord a1
)
648 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
652 bm2
= VG_(OSetGen_Remove
)(bm
->oset
, &a1
);
653 VG_(OSetGen_FreeNode
)(bm
->oset
, bm2
);
655 bm_update_cache(bm
, a1
, NULL
);
659 void bm_access_aligned_load(struct bitmap
* const bm
,
660 const Addr a1
, const SizeT size
)
664 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
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
,
675 void bm_access_aligned_store(struct bitmap
* const bm
,
676 const Addr a1
, const SizeT size
)
680 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
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
,
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
700 bm2
= bm2_lookup(bm
, address_msb(a
));
702 && bm0_is_any_set(bm2
->bm1
.bm0_w
,
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
717 bm2
= bm2_lookup(bm
, address_msb(a
));
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
)))
729 #endif /* __DRD_BITMAP_H */