rt/gc/cdgc/bits.d

   1 /**
   2  * This module contains a specialized bitset implementation.
   3  *
   4  * Copyright: Copyright (C) 2005-2006 Digital Mars, www.digitalmars.com.
   5  *            All rights reserved.
   6  * License:
   7  *  This software is provided 'as-is', without any express or implied
   8  *  warranty. In no event will the authors be held liable for any damages
   9  *  arising from the use of this software.
  10  *
  11  *  Permission is granted to anyone to use this software for any purpose,
  12  *  including commercial applications, and to alter it and redistribute it
  13  *  freely, in both source and binary form, subject to the following
  14  *  restrictions:
  15  *
  16  *  o  The origin of this software must not be misrepresented; you must not
  17  *     claim that you wrote the original software. If you use this software
  18  *     in a product, an acknowledgment in the product documentation would be
  19  *     appreciated but is not required.
  20  *  o  Altered source versions must be plainly marked as such, and must not
  21  *     be misrepresented as being the original software.
  22  *  o  This notice may not be removed or altered from any source
  23  *     distribution.
  24  * Authors:   Walter Bright, David Friedman, Sean Kelly
  25  */
  26
  27 module rt.gc.cdgc.bits;
  28
  29 import os = rt.gc.cdgc.os;
  30
  31 import cstring = tango.stdc.string;
  32
  33 private extern (C) void onOutOfMemoryError();
  34
  35
  36 version (DigitalMars)
  37 {
  38     version = bitops;
  39     import std.intrinsic;
  40 }
  41 else version (GNU)
  42 {
  43     // use the unoptimized version
  44 }
  45 else version(LDC)
  46 {
  47     // ditto
  48 }
  49 else version (D_InlineAsm_X86)
  50 {
  51     version = Asm86;
  52 }
  53
  54 struct GCBits
  55 {
  56     const int BITS_PER_WORD = 32;
  57     const int BITS_SHIFT = 5;
  58     const int BITS_MASK = 31;
  59
  60     uint*  data = null;
  61     size_t nwords = 0;    // allocated words in data[] excluding sentinals
  62     size_t nbits = 0;     // number of bits in data[] excluding sentinals
  63
  64     /// Get the number of bytes needed to store nbits bits
  65     size_t data_size()
  66     {
  67         return (nwords + 2) * uint.sizeof; // +2 for sentinels
  68     }
  69
  70     void Dtor(os.Vis vis = os.Vis.PRIV)
  71     {
  72         // Even when os.dealloc() can be called with a null pointer, the extra
  73         // call might be significant. On hard GC benchmarks making the test for
  74         // null here (i.e. not making the call) can reduce the GC time by
  75         // almost ~5%.
  76         if (data)
  77         {
  78             os.dealloc(data, data_size, vis);
  79             data = null;
  80         }
  81     }
  82
  83     invariant
  84     {
  85         if (data)
  86         {
  87             assert(nwords * data[0].sizeof * 8 >= nbits);
  88         }
  89     }
  90
  91     void alloc(size_t nbits, os.Vis vis = os.Vis.PRIV)
  92     {
  93         this.nbits = nbits;
  94         this.nwords = (nbits + (BITS_PER_WORD - 1)) >> BITS_SHIFT;
  95         this.data = cast(uint*) os.alloc(data_size, vis);
  96         if (!data)
  97             onOutOfMemoryError();
  98     }
  99
 100     uint test(size_t i)
 101     in
 102     {
 103         assert(i < nbits);
 104     }
 105     body
 106     {
 107         //return (cast(bit *)(data + 1))[i];
 108         return data[1 + (i >> BITS_SHIFT)] & (1 << (i & BITS_MASK));
 109     }
 110
 111     void set(size_t i)
 112     in
 113     {
 114         assert(i < nbits);
 115     }
 116     body
 117     {
 118         //(cast(bit *)(data + 1))[i] = 1;
 119         data[1 + (i >> BITS_SHIFT)] |= (1 << (i & BITS_MASK));
 120     }
 121
 122     void clear(size_t i)
 123     in
 124     {
 125         assert(i < nbits);
 126     }
 127     body
 128     {
 129         //(cast(bit *)(data + 1))[i] = 0;
 130         data[1 + (i >> BITS_SHIFT)] &= ~(1 << (i & BITS_MASK));
 131     }
 132
 133     uint testClear(size_t i)
 134     {
 135         version (bitops)
 136         {
 137             return std.intrinsic.btr(data + 1, i);
 138         }
 139         else version (Asm86)
 140         {
 141             asm
 142             {
 143                 naked                   ;
 144                 mov     EAX,data[EAX]   ;
 145                 mov     ECX,i-4[ESP]    ;
 146                 btr     4[EAX],ECX      ;
 147                 sbb     EAX,EAX         ;
 148                 ret     4               ;
 149             }
 150         }
 151         else
 152         {
 153             //result = (cast(bit *)(data + 1))[i];
 154             //(cast(bit *)(data + 1))[i] = 0;
 155
 156             uint* p = &data[1 + (i >> BITS_SHIFT)];
 157             uint  mask = (1 << (i & BITS_MASK));
 158             uint result = *p & mask;
 159             *p &= ~mask;
 160             return result;
 161         }
 162     }
 163
 164     void zero()
 165     {
 166         version(MEMCPY_NON_SIG_SAFE) {
 167             uint * d1=data+1,dEnd=d1+nwords;
 168             for (;d1!=dEnd;++d1)
 169                 *d1=0u;
 170         } else {
 171             cstring.memset(data + 1, 0, nwords * uint.sizeof);
 172         }
 173     }
 174
 175     void copy(GCBits *f)
 176     in
 177     {
 178         assert(nwords == f.nwords);
 179     }
 180     body
 181     {
 182         version(MEMCPY_NON_SIG_SAFE) {
 183             uint * d1=data+1,d2=f.data+1,dEnd=d1+nwords;
 184             for (;d1!=dEnd;++d1,++d2)
 185                 *d1=*d2;
 186         } else {
 187             cstring.memcpy(data + 1, f.data + 1, nwords * uint.sizeof);
 188         }
 189     }
 190
 191     uint* base()
 192     in
 193     {
 194         assert(data);
 195     }
 196     body
 197     {
 198         return data + 1;
 199     }
 200 }
 201
 202 unittest
 203 {
 204     GCBits b;
 205
 206     b.alloc(786);
 207     assert(b.test(123) == 0);
 208     assert(b.testClear(123) == 0);
 209     b.set(123);
 210     assert(b.test(123) != 0);
 211     assert(b.testClear(123) != 0);
 212     assert(b.test(123) == 0);
 213
 214     b.set(785);
 215     b.set(0);
 216     assert(b.test(785) != 0);
 217     assert(b.test(0) != 0);
 218     b.zero();
 219     assert(b.test(785) == 0);
 220     assert(b.test(0) == 0);
 221
 222     GCBits b2;
 223     b2.alloc(786);
 224     b2.set(38);
 225     b.copy(&b2);
 226     assert(b.test(38) != 0);
 227     b2.Dtor();
 228
 229     b.Dtor();
 230 }
 231
 232
 233 // vim: set et sw=4 sts=4 :