2 This file is part of drd, a thread error detector.
4 Copyright (C) 2006-2011 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, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 The GNU General Public License is contained in the file COPYING.
25 #ifndef __DRD_BITMAP_H
26 #define __DRD_BITMAP_H
29 #include "pub_drd_bitmap.h"
30 #include "pub_tool_basics.h"
31 #include "pub_tool_oset.h"
32 #include "pub_tool_libcbase.h"
33 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
34 #include "pub_tool_libcassert.h"
38 /* Bitmap representation. A bitmap is a data structure in which two bits are
39 * reserved per 32 bit address: one bit that indicates that the data at the
40 * specified address has been read, and one bit that indicates that the data
41 * has been written to.
44 /* Client addresses are split into bitfields as follows:
45 * ------------------------------------------------------
46 * | Address MSB | Address LSB | Ignored bits |
47 * ------------------------------------------------------
48 * | Address MSB | UWord MSB | UWord LSB | Ignored bits |
49 * ------------------------------------------------------
54 /* Address MSB / LSB split. */
57 /** Number of least significant address bits that are ignored. */
58 #define ADDR_IGNORED_BITS 0
59 #define ADDR_IGNORED_MASK ((1U << ADDR_IGNORED_BITS) - 1U)
60 #define ADDR_GRANULARITY (1U << ADDR_IGNORED_BITS)
63 * Round argument a up to a multiple of (1 << ADDR_GRANULARITY), and next
64 * shift it right ADDR_GRANULARITY bits. The expression below is optimized
65 * for the case where a is a constant.
67 #define SCALED_SIZE(a) \
68 (((((a) - 1U) | ADDR_IGNORED_MASK) + 1U) >> ADDR_IGNORED_BITS)
71 * Number of bits assigned to the least significant component of an address.
73 #define ADDR_LSB_BITS 12
76 * Mask that has to be applied to an address of type Addr in order to
77 * compute the least significant part of an address split, after having
78 * shifted the address bits ADDR_GRANULARITY to the right.
80 #define ADDR_LSB_MASK (((UWord)1 << ADDR_LSB_BITS) - 1U)
82 /** Compute least significant bits of an address of type Addr. */
84 UWord
address_lsb(const Addr a
)
85 { return (a
>> ADDR_IGNORED_BITS
) & ADDR_LSB_MASK
; }
88 * Compute the first address for which address_lsb() is equal to
92 Addr
first_address_with_same_lsb(const Addr a
)
94 return ((a
| ADDR_IGNORED_MASK
) ^ ADDR_IGNORED_MASK
);
98 * Compute the first address for which address_lsb() is greater than
102 Addr
first_address_with_higher_lsb(const Addr a
)
104 return ((a
| ADDR_IGNORED_MASK
) + 1U);
107 /** Compute most significant bits of an address of type Addr. */
109 UWord
address_msb(const Addr a
)
110 { return a
>> (ADDR_LSB_BITS
+ ADDR_IGNORED_BITS
); }
113 Addr
first_address_with_higher_msb(const Addr a
)
115 return ((a
| ((ADDR_LSB_MASK
<< ADDR_IGNORED_BITS
) | ADDR_IGNORED_MASK
))
120 * Convert LSB and MSB back into an address.
122 * @note It is assumed that sizeof(Addr) == sizeof(UWord).
125 Addr
make_address(const UWord a1
, const UWord a0
)
127 return ((a1
<< (ADDR_LSB_BITS
+ ADDR_IGNORED_BITS
))
128 | (a0
<< ADDR_IGNORED_BITS
));
135 /** Number of bits that fit in a variable of type UWord. */
136 #define BITS_PER_UWORD (8U * sizeof(UWord))
138 /** Log2 of BITS_PER_UWORD. */
139 #if defined(VGA_x86) || defined(VGA_ppc32) || defined(VGA_arm)
140 #define BITS_PER_BITS_PER_UWORD 5
141 #elif defined(VGA_amd64) || defined(VGA_ppc64) || defined(VGA_s390x)
142 #define BITS_PER_BITS_PER_UWORD 6
144 #error Unknown platform.
147 /** Number of UWord's needed to store one bit per address LSB. */
148 #define BITMAP1_UWORD_COUNT (1U << (ADDR_LSB_BITS - BITS_PER_BITS_PER_UWORD))
151 * Mask that has to be applied to an (Addr >> ADDR_IGNORED_BITS) expression
152 * in order to compute the least significant part of an UWord.
154 #define UWORD_LSB_MASK (((UWord)1 << BITS_PER_BITS_PER_UWORD) - 1)
157 * Compute index into bm0[] array.
159 * @param a Address shifted right ADDR_IGNORED_BITS bits.
162 UWord
uword_msb(const UWord a
)
164 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
165 tl_assert(a
< (1U << ADDR_LSB_BITS
));
167 return a
>> BITS_PER_BITS_PER_UWORD
;
171 * Return the least significant bits.
173 * @param a Address shifted right ADDR_IGNORED_BITS bits.
176 UWord
uword_lsb(const UWord a
)
178 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
179 tl_assert(a
< (1U << ADDR_LSB_BITS
));
181 return a
& UWORD_LSB_MASK
;
185 * Compute the highest address lower than a for which
186 * uword_lsb(address_lsb(a)) == 0.
191 Addr
first_address_with_same_uword_lsb(const Addr a
)
193 return (a
& (~UWORD_LSB_MASK
<< ADDR_IGNORED_BITS
));
197 * First address that will go in the UWord past the one 'a' goes in.
202 Addr
first_address_with_higher_uword_msb(const Addr a
)
204 return ((a
| ((UWORD_LSB_MASK
<< ADDR_IGNORED_BITS
) | ADDR_IGNORED_MASK
))
210 /* Local variables. */
212 static ULong s_bitmap2_creation_count
;
216 /*********************************************************************/
217 /* Functions for manipulating a struct bitmap1. */
218 /*********************************************************************/
221 /* Lowest level, corresponding to the lowest ADDR_LSB_BITS of an address. */
224 UWord bm0_r
[BITMAP1_UWORD_COUNT
];
225 UWord bm0_w
[BITMAP1_UWORD_COUNT
];
228 static __inline__ UWord
bm0_mask(const UWord a
)
230 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
231 tl_assert(address_msb(make_address(0, a
)) == 0);
233 return ((UWord
)1 << uword_lsb(a
));
236 /** Set the bit corresponding to address a in bitmap bm0. */
237 static __inline__
void bm0_set(UWord
* bm0
, const UWord a
)
239 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
240 tl_assert(address_msb(make_address(0, a
)) == 0);
242 bm0
[uword_msb(a
)] |= (UWord
)1 << uword_lsb(a
);
246 * Set the bits corresponding to all of the addresses in range
247 * [ a << ADDR_IGNORED_BITS .. (a + size) << ADDR_IGNORED_BITS [
250 static __inline__
void bm0_set_range(UWord
* bm0
,
251 const UWord a
, const SizeT size
)
253 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
255 tl_assert(address_msb(make_address(0, a
)) == 0);
256 tl_assert(address_msb(make_address(0, a
+ size
- 1)) == 0);
257 tl_assert(uword_msb(a
) == uword_msb(a
+ size
- 1));
260 |= (((UWord
)1 << size
) - 1) << uword_lsb(a
);
263 /** Clear the bit corresponding to address a in bitmap bm0. */
264 static __inline__
void bm0_clear(UWord
* bm0
, const UWord a
)
266 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
267 tl_assert(address_msb(make_address(0, a
)) == 0);
269 bm0
[uword_msb(a
)] &= ~((UWord
)1 << uword_lsb(a
));
273 * Clear all of the addresses in range
274 * [ a << ADDR_IGNORED_BITS .. (a + size) << ADDR_IGNORED_BITS [
277 static __inline__
void bm0_clear_range(UWord
* bm0
,
278 const UWord a
, const SizeT size
)
280 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
281 tl_assert(address_msb(make_address(0, a
)) == 0);
282 tl_assert(size
== 0 || address_msb(make_address(0, a
+ size
- 1)) == 0);
283 tl_assert(size
== 0 || uword_msb(a
) == uword_msb(a
+ size
- 1));
286 * Note: although the expression below yields a correct result even if
287 * size == 0, do not touch bm0[] if size == 0 because this might otherwise
288 * cause an access of memory just past the end of the bm0[] array.
293 &= ~((((UWord
)1 << size
) - 1) << uword_lsb(a
));
297 /** Test whether the bit corresponding to address a is set in bitmap bm0. */
298 static __inline__ UWord
bm0_is_set(const UWord
* bm0
, const UWord a
)
300 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
301 tl_assert(address_msb(make_address(0, a
)) == 0);
303 return (bm0
[uword_msb(a
)] & ((UWord
)1 << uword_lsb(a
)));
307 * Return true if a bit corresponding to any of the addresses in range
308 * [ a << ADDR_IGNORED_BITS .. (a + size) << ADDR_IGNORED_BITS [
311 static __inline__ UWord
bm0_is_any_set(const UWord
* bm0
,
312 const Addr a
, const SizeT size
)
314 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
316 tl_assert(address_msb(make_address(0, a
)) == 0);
317 tl_assert(address_msb(make_address(0, a
+ size
- 1)) == 0);
318 tl_assert(uword_msb(a
) == uword_msb(a
+ size
- 1));
320 return (bm0
[uword_msb(a
)] & ((((UWord
)1 << size
) - 1) << uword_lsb(a
)));
325 /*********************************************************************/
326 /* Functions for manipulating a struct bitmap. */
327 /*********************************************************************/
330 /* Second level bitmap. */
333 Addr addr
; ///< address_msb(...)
339 static void bm2_clear(struct bitmap2
* const bm2
);
341 struct bitmap2
* bm2_insert(struct bitmap
* const bm
, const UWord a1
);
346 * Rotate elements cache[0..n-1] such that the element at position n-1 is
347 * moved to position 0. This allows to speed up future cache lookups.
350 void bm_cache_rotate(struct bm_cache_elem cache
[], const int n
)
353 struct bm_cache_elem t
;
355 tl_assert(2 <= n
&& n
<= 8);
377 Bool
bm_cache_lookup(struct bitmap
* const bm
, const UWord a1
,
378 struct bitmap2
** bm2
)
380 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
385 #if DRD_BITMAP_N_CACHE_ELEM > 8
386 #error Please update the code below.
388 #if DRD_BITMAP_N_CACHE_ELEM >= 1
389 if (a1
== bm
->cache
[0].a1
)
391 *bm2
= bm
->cache
[0].bm2
;
395 #if DRD_BITMAP_N_CACHE_ELEM >= 2
396 if (a1
== bm
->cache
[1].a1
)
398 *bm2
= bm
->cache
[1].bm2
;
402 #if DRD_BITMAP_N_CACHE_ELEM >= 3
403 if (a1
== bm
->cache
[2].a1
)
405 *bm2
= bm
->cache
[2].bm2
;
406 bm_cache_rotate(bm
->cache
, 3);
410 #if DRD_BITMAP_N_CACHE_ELEM >= 4
411 if (a1
== bm
->cache
[3].a1
)
413 *bm2
= bm
->cache
[3].bm2
;
414 bm_cache_rotate(bm
->cache
, 4);
418 #if DRD_BITMAP_N_CACHE_ELEM >= 5
419 if (a1
== bm
->cache
[4].a1
)
421 *bm2
= bm
->cache
[4].bm2
;
422 bm_cache_rotate(bm
->cache
, 5);
426 #if DRD_BITMAP_N_CACHE_ELEM >= 6
427 if (a1
== bm
->cache
[5].a1
)
429 *bm2
= bm
->cache
[5].bm2
;
430 bm_cache_rotate(bm
->cache
, 6);
434 #if DRD_BITMAP_N_CACHE_ELEM >= 7
435 if (a1
== bm
->cache
[6].a1
)
437 *bm2
= bm
->cache
[6].bm2
;
438 bm_cache_rotate(bm
->cache
, 7);
442 #if DRD_BITMAP_N_CACHE_ELEM >= 8
443 if (a1
== bm
->cache
[7].a1
)
445 *bm2
= bm
->cache
[7].bm2
;
446 bm_cache_rotate(bm
->cache
, 8);
455 void bm_update_cache(struct bitmap
* const bm
,
457 struct bitmap2
* const bm2
)
459 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
463 #if DRD_BITMAP_N_CACHE_ELEM > 8
464 #error Please update the code below.
466 #if DRD_BITMAP_N_CACHE_ELEM >= 8
467 bm
->cache
[7] = bm
->cache
[6];
469 #if DRD_BITMAP_N_CACHE_ELEM >= 7
470 bm
->cache
[6] = bm
->cache
[5];
472 #if DRD_BITMAP_N_CACHE_ELEM >= 6
473 bm
->cache
[5] = bm
->cache
[4];
475 #if DRD_BITMAP_N_CACHE_ELEM >= 5
476 bm
->cache
[4] = bm
->cache
[3];
478 #if DRD_BITMAP_N_CACHE_ELEM >= 4
479 bm
->cache
[3] = bm
->cache
[2];
481 #if DRD_BITMAP_N_CACHE_ELEM >= 3
482 bm
->cache
[2] = bm
->cache
[1];
484 #if DRD_BITMAP_N_CACHE_ELEM >= 2
485 bm
->cache
[1] = bm
->cache
[0];
487 bm
->cache
[0].a1
= a1
;
488 bm
->cache
[0].bm2
= bm2
;
492 * Look up the address a1 in bitmap bm and return a pointer to a potentially
493 * shared second level bitmap. The bitmap where the returned pointer points
494 * at may not be modified by the caller.
496 * @param a1 client address shifted right by ADDR_LSB_BITS.
497 * @param bm bitmap pointer.
500 const struct bitmap2
* bm2_lookup(struct bitmap
* const bm
, const UWord a1
)
504 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
508 if (! bm_cache_lookup(bm
, a1
, &bm2
))
510 bm2
= VG_(OSetGen_Lookup
)(bm
->oset
, &a1
);
511 bm_update_cache(bm
, a1
, bm2
);
517 * Look up the address a1 in bitmap bm and return a pointer to a second
518 * level bitmap that is not shared and hence may be modified.
520 * @param a1 client address shifted right by ADDR_LSB_BITS.
521 * @param bm bitmap pointer.
525 bm2_lookup_exclusive(struct bitmap
* const bm
, const UWord a1
)
529 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
533 if (! bm_cache_lookup(bm
, a1
, &bm2
))
535 bm2
= VG_(OSetGen_Lookup
)(bm
->oset
, &a1
);
541 /** Clear the content of the second-level bitmap. */
543 void bm2_clear(struct bitmap2
* const bm2
)
545 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
548 VG_(memset
)(&bm2
->bm1
, 0, sizeof(bm2
->bm1
));
552 * Insert an uninitialized second level bitmap for the address a1.
554 * @param bm bitmap pointer.
555 * @param a1 client address shifted right by ADDR_LSB_BITS.
557 * @note bitmap2::recalc isn't initialized here on purpose.
560 struct bitmap2
* bm2_insert(struct bitmap
* const bm
, const UWord a1
)
564 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
568 s_bitmap2_creation_count
++;
570 bm2
= VG_(OSetGen_AllocNode
)(bm
->oset
, sizeof(*bm2
));
572 VG_(OSetGen_Insert
)(bm
->oset
, bm2
);
574 bm_update_cache(bm
, a1
, bm2
);
580 struct bitmap2
* bm2_insert_copy(struct bitmap
* const bm
,
581 struct bitmap2
* const bm2
)
583 struct bitmap2
* bm2_copy
;
585 bm2_copy
= bm2_insert(bm
, bm2
->addr
);
586 VG_(memcpy
)(&bm2_copy
->bm1
, &bm2
->bm1
, sizeof(bm2
->bm1
));
591 * Look up the address a1 in bitmap bm, and insert it if not found.
592 * The returned second level bitmap may not be modified.
594 * @param bm bitmap pointer.
595 * @param a1 client address shifted right by ADDR_LSB_BITS.
598 struct bitmap2
* bm2_lookup_or_insert(struct bitmap
* const bm
, const UWord a1
)
602 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
606 if (bm_cache_lookup(bm
, a1
, &bm2
))
610 bm2
= bm2_insert(bm
, a1
);
616 bm2
= VG_(OSetGen_Lookup
)(bm
->oset
, &a1
);
619 bm2
= bm2_insert(bm
, a1
);
622 bm_update_cache(bm
, a1
, bm2
);
628 * Look up the address a1 in bitmap bm, and insert it if not found.
629 * The returned second level bitmap may be modified.
631 * @param a1 client address shifted right by ADDR_LSB_BITS.
632 * @param bm bitmap pointer.
635 struct bitmap2
* bm2_lookup_or_insert_exclusive(struct bitmap
* const bm
,
638 return bm2_lookup_or_insert(bm
, a1
);
642 void bm2_remove(struct bitmap
* const bm
, const UWord a1
)
646 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
650 bm2
= VG_(OSetGen_Remove
)(bm
->oset
, &a1
);
651 VG_(OSetGen_FreeNode
)(bm
->oset
, bm2
);
653 bm_update_cache(bm
, a1
, NULL
);
657 void bm_access_aligned_load(struct bitmap
* const bm
,
658 const Addr a1
, const SizeT size
)
662 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
666 bm2
= bm2_lookup_or_insert_exclusive(bm
, address_msb(a1
));
667 bm0_set_range(bm2
->bm1
.bm0_r
,
668 (a1
>> ADDR_IGNORED_BITS
) & ADDR_LSB_MASK
,
673 void bm_access_aligned_store(struct bitmap
* const bm
,
674 const Addr a1
, const SizeT size
)
678 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
682 bm2
= bm2_lookup_or_insert_exclusive(bm
, address_msb(a1
));
683 bm0_set_range(bm2
->bm1
.bm0_w
,
684 (a1
>> ADDR_IGNORED_BITS
) & ADDR_LSB_MASK
,
689 Bool
bm_aligned_load_has_conflict_with(struct bitmap
* const bm
,
690 const Addr a
, const SizeT size
)
692 const struct bitmap2
* bm2
;
694 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
698 bm2
= bm2_lookup(bm
, address_msb(a
));
700 && bm0_is_any_set(bm2
->bm1
.bm0_w
,
706 Bool
bm_aligned_store_has_conflict_with(struct bitmap
* const bm
,
707 const Addr a
, const SizeT size
)
709 const struct bitmap2
* bm2
;
711 #ifdef ENABLE_DRD_CONSISTENCY_CHECKS
715 bm2
= bm2_lookup(bm
, address_msb(a
));
718 if (bm0_is_any_set(bm2
->bm1
.bm0_r
, address_lsb(a
), SCALED_SIZE(size
))
719 | bm0_is_any_set(bm2
->bm1
.bm0_w
, address_lsb(a
), SCALED_SIZE(size
)))
727 #endif /* __DRD_BITMAP_H */