drd/pub_drd_bitmap.h

   1 /*
   2   This file is part of drd, a thread error detector.
   3
   4   Copyright (C) 2006-2020 Bart Van Assche <bvanassche@acm.org>.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19   The GNU General Public License is contained in the file COPYING.
  20 */
  21
  22
  23 /*
  24  * A bitmap is a data structure that contains information about which
  25  * addresses have been accessed for reading or writing within a given
  26  * segment.
  27  */
  28
  29
  30 #ifndef __PUB_DRD_BITMAP_H
  31 #define __PUB_DRD_BITMAP_H
  32
  33
  34 #include "drd_basics.h"      /* DRD_() */
  35 #include "pub_tool_basics.h" /* Addr, SizeT */
  36 #include "pub_tool_oset.h"   /* struct _OSet */
  37
  38
  39 /* Defines. */
  40
  41 #define LHS_R (1<<0)
  42 #define LHS_W (1<<1)
  43 #define RHS_R (1<<2)
  44 #define RHS_W (1<<3)
  45 #define HAS_RACE(a) ((((a) & RHS_W) && ((a) & (LHS_R | LHS_W)))         \
  46                      || (((a) & LHS_W) && ((a) & (RHS_R | RHS_W))))
  47
  48
  49 /* Forward declarations. */
  50
  51 struct bitmap;
  52
  53
  54 /* Datatype definitions. */
  55
  56 typedef enum { eLoad, eStore, eStart, eEnd } BmAccessTypeT;
  57
  58 struct bm_cache_elem
  59 {
  60    Addr            a1;
  61    struct bitmap2* bm2;
  62 };
  63
  64 #define DRD_BITMAP_N_CACHE_ELEM 4
  65
  66 /* Complete bitmap. */
  67 struct bitmap
  68 {
  69    struct bm_cache_elem cache[DRD_BITMAP_N_CACHE_ELEM];
  70    OSet*                oset;
  71 };
  72
  73
  74 /* Function declarations. */
  75
  76 void DRD_(bm_module_init)(void);
  77 void DRD_(bm_module_cleanup)(void);
  78 struct bitmap* DRD_(bm_new)(void);
  79 void DRD_(bm_delete)(struct bitmap* const bm);
  80 void DRD_(bm_init)(struct bitmap* const bm);
  81 void DRD_(bm_cleanup)(struct bitmap* const bm);
  82 void DRD_(bm_access_range)(struct bitmap* const bm,
  83                            const Addr a1, const Addr a2,
  84                            const BmAccessTypeT access_type);
  85 void DRD_(bm_access_range_load)(struct bitmap* const bm,
  86                                 const Addr a1, const Addr a2);
  87 void DRD_(bm_access_load_1)(struct bitmap* const bm, const Addr a1);
  88 void DRD_(bm_access_load_2)(struct bitmap* const bm, const Addr a1);
  89 void DRD_(bm_access_load_4)(struct bitmap* const bm, const Addr a1);
  90 void DRD_(bm_access_load_8)(struct bitmap* const bm, const Addr a1);
  91 void DRD_(bm_access_range_store)(struct bitmap* const bm,
  92                                  const Addr a1, const Addr a2);
  93 void DRD_(bm_access_store_1)(struct bitmap* const bm, const Addr a1);
  94 void DRD_(bm_access_store_2)(struct bitmap* const bm, const Addr a1);
  95 void DRD_(bm_access_store_4)(struct bitmap* const bm, const Addr a1);
  96 void DRD_(bm_access_store_8)(struct bitmap* const bm, const Addr a1);
  97 Bool DRD_(bm_has)(struct bitmap* const bm,
  98                   const Addr a1, const Addr a2,
  99                   const BmAccessTypeT access_type);
 100 Bool DRD_(bm_has_any_load_g)(struct bitmap* const bm);
 101 Bool DRD_(bm_has_any_load)(struct bitmap* const bm,
 102                            const Addr a1, const Addr a2);
 103 Bool DRD_(bm_has_any_store)(struct bitmap* const bm,
 104                             const Addr a1, const Addr a2);
 105 Bool DRD_(bm_has_any_access)(struct bitmap* const bm,
 106                              const Addr a1, const Addr a2);
 107 Bool DRD_(bm_has_1)(struct bitmap* const bm,
 108                     const Addr address, const BmAccessTypeT access_type);
 109 void DRD_(bm_clear)(struct bitmap* const bm,
 110                     const Addr a1, const Addr a2);
 111 void DRD_(bm_clear_load)(struct bitmap* const bm,
 112                          const Addr a1, const Addr a2);
 113 void DRD_(bm_clear_store)(struct bitmap* const bm,
 114                           const Addr a1, const Addr a2);
 115 Bool DRD_(bm_test_and_clear)(struct bitmap* const bm,
 116                              const Addr a1, const Addr a2);
 117 Bool DRD_(bm_has_conflict_with)(struct bitmap* const bm,
 118                                 const Addr a1, const Addr a2,
 119                                 const BmAccessTypeT access_type);
 120 Bool DRD_(bm_load_1_has_conflict_with)(struct bitmap* const bm, const Addr a1);
 121 Bool DRD_(bm_load_2_has_conflict_with)(struct bitmap* const bm, const Addr a1);
 122 Bool DRD_(bm_load_4_has_conflict_with)(struct bitmap* const bm, const Addr a1);
 123 Bool DRD_(bm_load_8_has_conflict_with)(struct bitmap* const bm, const Addr a1);
 124 Bool DRD_(bm_load_has_conflict_with)(struct bitmap* const bm,
 125                                      const Addr a1, const Addr a2);
 126 Bool DRD_(bm_store_1_has_conflict_with)(struct bitmap* const bm,const Addr a1);
 127 Bool DRD_(bm_store_2_has_conflict_with)(struct bitmap* const bm,const Addr a1);
 128 Bool DRD_(bm_store_4_has_conflict_with)(struct bitmap* const bm,const Addr a1);
 129 Bool DRD_(bm_store_8_has_conflict_with)(struct bitmap* const bm,const Addr a1);
 130 Bool DRD_(bm_store_has_conflict_with)(struct bitmap* const bm,
 131                                       const Addr a1, const Addr a2);
 132 Bool DRD_(bm_equal)(struct bitmap* const lhs, struct bitmap* const rhs);
 133 void DRD_(bm_swap)(struct bitmap* const bm1, struct bitmap* const bm2);
 134 void DRD_(bm_merge2)(struct bitmap* const lhs, struct bitmap* const rhs);
 135 void DRD_(bm_unmark)(struct bitmap* bm);
 136 Bool DRD_(bm_is_marked)(struct bitmap* bm, const Addr a);
 137 void DRD_(bm_mark)(struct bitmap* bm1, struct bitmap* bm2);
 138 void DRD_(bm_clear_marked)(struct bitmap* bm);
 139 void DRD_(bm_merge2_marked)(struct bitmap* const lhs, struct bitmap* const rhs);
 140 void DRD_(bm_remove_cleared_marked)(struct bitmap* bm);
 141 int DRD_(bm_has_races)(struct bitmap* const bm1,
 142                        struct bitmap* const bm2);
 143 void DRD_(bm_report_races)(ThreadId const tid1, ThreadId const tid2,
 144                            struct bitmap* const bm1,
 145                            struct bitmap* const bm2);
 146 void DRD_(bm_print)(struct bitmap* bm);
 147 ULong DRD_(bm_get_bitmap_creation_count)(void);
 148 ULong DRD_(bm_get_bitmap2_creation_count)(void);
 149 ULong DRD_(bm_get_bitmap2_merge_count)(void);
 150
 151 #endif /* __PUB_DRD_BITMAP_H */