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