src/mm/boehm-gc/include/private/gc_hdrs.h

   1 /*
   2  * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
   3  * Copyright (c) 1991-1994 by Xerox Corporation.  All rights reserved.
   4  *
   5  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   6  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   7  *
   8  * Permission is hereby granted to use or copy this program
   9  * for any purpose,  provided the above notices are retained on all copies.
  10  * Permission to modify the code and to distribute modified code is granted,
  11  * provided the above notices are retained, and a notice that the code was
  12  * modified is included with the above copyright notice.
  13  */
  14 /* Boehm, July 11, 1995 11:54 am PDT */
  15 # ifndef GC_HEADERS_H
  16 # define GC_HEADERS_H
  17 typedef struct hblkhdr hdr;
  18
  19 # if CPP_WORDSZ != 32 && CPP_WORDSZ < 36
  20         --> Get a real machine.
  21 # endif
  22
  23 /*
  24  * The 2 level tree data structure that is used to find block headers.
  25  * If there are more than 32 bits in a pointer, the top level is a hash
  26  * table.
  27  *
  28  * This defines HDR, GET_HDR, and SET_HDR, the main macros used to
  29  * retrieve and set object headers.
  30  *
  31  * We take advantage of a header lookup
  32  * cache.  This is a locally declared direct mapped cache, used inside
  33  * the marker.  The HC_GET_HDR macro uses and maintains this
  34  * cache.  Assuming we get reasonable hit rates, this shaves a few
  35  * memory references from each pointer validation.
  36  */
  37
  38 # if CPP_WORDSZ > 32
  39 #   define HASH_TL
  40 # endif
  41
  42 /* Define appropriate out-degrees for each of the two tree levels       */
  43 # ifdef SMALL_CONFIG
  44 #   define LOG_BOTTOM_SZ 11
  45         /* Keep top index size reasonable with smaller blocks. */
  46 # else
  47 #   define LOG_BOTTOM_SZ 10
  48 # endif
  49 # ifndef HASH_TL
  50 #   define LOG_TOP_SZ (WORDSZ - LOG_BOTTOM_SZ - LOG_HBLKSIZE)
  51 # else
  52 #   define LOG_TOP_SZ 11
  53 # endif
  54 # define TOP_SZ (1 << LOG_TOP_SZ)
  55 # define BOTTOM_SZ (1 << LOG_BOTTOM_SZ)
  56
  57 /* #define COUNT_HDR_CACHE_HITS  */
  58
  59 # ifdef COUNT_HDR_CACHE_HITS
  60     extern word GC_hdr_cache_hits;
  61     extern word GC_hdr_cache_misses;
  62 #   define HC_HIT() ++GC_hdr_cache_hits
  63 #   define HC_MISS() ++GC_hdr_cache_misses
  64 # else
  65 #   define HC_HIT()
  66 #   define HC_MISS()
  67 # endif
  68
  69   typedef struct hce {
  70     word block_addr;    /* right shifted by LOG_HBLKSIZE */
  71     hdr * hce_hdr;
  72   } hdr_cache_entry;
  73
  74 # define HDR_CACHE_SIZE 8  /* power of 2 */
  75
  76 # define DECLARE_HDR_CACHE \
  77         hdr_cache_entry hdr_cache[HDR_CACHE_SIZE]
  78
  79 # define INIT_HDR_CACHE BZERO(hdr_cache, sizeof(hdr_cache))
  80
  81 # define HCE(h) hdr_cache + (((word)(h) >> LOG_HBLKSIZE) & (HDR_CACHE_SIZE-1))
  82
  83 # define HCE_VALID_FOR(hce,h) ((hce) -> block_addr == \
  84                                 ((word)(h) >> LOG_HBLKSIZE))
  85
  86 # define HCE_HDR(h) ((hce) -> hce_hdr)
  87
  88 #ifdef PRINT_BLACK_LIST
  89   hdr * GC_header_cache_miss(ptr_t p, hdr_cache_entry *hce, ptr_t source);
  90 # define HEADER_CACHE_MISS(p, hce, source) \
  91           GC_header_cache_miss(p, hce, source)
  92 #else
  93   hdr * GC_header_cache_miss(ptr_t p, hdr_cache_entry *hce);
  94 # define HEADER_CACHE_MISS(p, hce, source) GC_header_cache_miss(p, hce)
  95 #endif
  96
  97 /* Set hhdr to the header for p.  Analogous to GET_HDR below,           */
  98 /* except that in the case of large objects, it                         */
  99 /* gets the header for the object beginning, if GC_all_interior_ptrs    */
 100 /* is set.                                                              */
 101 /* Returns zero if p points to somewhere other than the first page      */
 102 /* of an object, and it is not a valid pointer to the object.           */
 103 # define HC_GET_HDR(p, hhdr, source, exit_label) \
 104         { \
 105           hdr_cache_entry * hce = HCE(p); \
 106           if (EXPECT(HCE_VALID_FOR(hce, p), 1)) { \
 107             HC_HIT(); \
 108             hhdr = hce -> hce_hdr; \
 109           } else { \
 110             hhdr = HEADER_CACHE_MISS(p, hce, source); \
 111             if (0 == hhdr) goto exit_label; \
 112           } \
 113         }
 114
 115 typedef struct bi {
 116     hdr * index[BOTTOM_SZ];
 117         /*
 118          * The bottom level index contains one of three kinds of values:
 119          * 0 means we're not responsible for this block,
 120          *   or this is a block other than the first one in a free block.
 121          * 1 < (long)X <= MAX_JUMP means the block starts at least
 122          *        X * HBLKSIZE bytes before the current address.
 123          * A valid pointer points to a hdr structure. (The above can't be
 124          * valid pointers due to the GET_MEM return convention.)
 125          */
 126     struct bi * asc_link;       /* All indices are linked in    */
 127                                 /* ascending order...           */
 128     struct bi * desc_link;      /* ... and in descending order. */
 129     word key;                   /* high order address bits.     */
 130 # ifdef HASH_TL
 131     struct bi * hash_link;      /* Hash chain link.             */
 132 # endif
 133 } bottom_index;
 134
 135 /* extern bottom_index GC_all_nils; - really part of GC_arrays */
 136
 137 /* extern bottom_index * GC_top_index []; - really part of GC_arrays */
 138                                 /* Each entry points to a bottom_index. */
 139                                 /* On a 32 bit machine, it points to    */
 140                                 /* the index for a set of high order    */
 141                                 /* bits equal to the index.  For longer */
 142                                 /* addresses, we hash the high order    */
 143                                 /* bits to compute the index in         */
 144                                 /* GC_top_index, and each entry points  */
 145                                 /* to a hash chain.                     */
 146                                 /* The last entry in each chain is      */
 147                                 /* GC_all_nils.                         */
 148
 149
 150 # define MAX_JUMP (HBLKSIZE - 1)
 151
 152 # define HDR_FROM_BI(bi, p) \
 153                 ((bi)->index[((word)(p) >> LOG_HBLKSIZE) & (BOTTOM_SZ - 1)])
 154 # ifndef HASH_TL
 155 #   define BI(p) (GC_top_index \
 156                 [(word)(p) >> (LOG_BOTTOM_SZ + LOG_HBLKSIZE)])
 157 #   define HDR_INNER(p) HDR_FROM_BI(BI(p),p)
 158 #   ifdef SMALL_CONFIG
 159 #       define HDR(p) GC_find_header((ptr_t)(p))
 160 #   else
 161 #       define HDR(p) HDR_INNER(p)
 162 #   endif
 163 #   define GET_BI(p, bottom_indx) (bottom_indx) = BI(p)
 164 #   define GET_HDR(p, hhdr) (hhdr) = HDR(p)
 165 #   define SET_HDR(p, hhdr) HDR_INNER(p) = (hhdr)
 166 #   define GET_HDR_ADDR(p, ha) (ha) = &(HDR_INNER(p))
 167 # else /* hash */
 168 /*  Hash function for tree top level */
 169 #   define TL_HASH(hi) ((hi) & (TOP_SZ - 1))
 170 /*  Set bottom_indx to point to the bottom index for address p */
 171 #   define GET_BI(p, bottom_indx) \
 172         { \
 173             register word hi = \
 174                 (word)(p) >> (LOG_BOTTOM_SZ + LOG_HBLKSIZE); \
 175             register bottom_index * _bi = GC_top_index[TL_HASH(hi)]; \
 176             \
 177             while (_bi -> key != hi && _bi != GC_all_nils) \
 178                 _bi = _bi -> hash_link; \
 179             (bottom_indx) = _bi; \
 180         }
 181 #   define GET_HDR_ADDR(p, ha) \
 182         { \
 183             register bottom_index * bi; \
 184             \
 185             GET_BI(p, bi);      \
 186             (ha) = &(HDR_FROM_BI(bi, p)); \
 187         }
 188 #   define GET_HDR(p, hhdr) { register hdr ** _ha; GET_HDR_ADDR(p, _ha); \
 189                               (hhdr) = *_ha; }
 190 #   define SET_HDR(p, hhdr) { register hdr ** _ha; GET_HDR_ADDR(p, _ha); \
 191                               *_ha = (hhdr); }
 192 #   define HDR(p) GC_find_header((ptr_t)(p))
 193 # endif
 194
 195 /* Is the result a forwarding address to someplace closer to the        */
 196 /* beginning of the block or NIL?                                       */
 197 # define IS_FORWARDING_ADDR_OR_NIL(hhdr) ((size_t) (hhdr) <= MAX_JUMP)
 198
 199 /* Get an HBLKSIZE aligned address closer to the beginning of the block */
 200 /* h.  Assumes hhdr == HDR(h) and IS_FORWARDING_ADDR(hhdr).             */
 201 # define FORWARDED_ADDR(h, hhdr) ((struct hblk *)(h) - (size_t)(hhdr))
 202 # endif /*  GC_HEADERS_H */