Source/JavaScriptCore/runtime/MarkedSpace.cpp

   1 /*
   2  *  Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
   3  *  Copyright (C) 2007 Eric Seidel <eric@webkit.org>
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public
   7  *  License as published by the Free Software Foundation; either
   8  *  version 2 of the License, or (at your option) any later version.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this library; if not, write to the Free Software
  17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  */
  20
  21 #include "config.h"
  22 #include "MarkedSpace.h"
  23
  24 #include "CollectorHeapIterator.h"
  25 #include "JSCell.h"
  26 #include "JSGlobalData.h"
  27 #include "JSLock.h"
  28
  29 using std::max;
  30
  31 namespace JSC {
  32
  33 class Structure;
  34
  35 // tunable parameters
  36
  37 const size_t GROWTH_FACTOR = 2;
  38 const size_t LOW_WATER_FACTOR = 4;
  39 const size_t ALLOCATIONS_PER_COLLECTION = 3600;
  40 // This value has to be a macro to be used in max() without introducing
  41 // a PIC branch in Mach-O binaries, see <rdar://problem/5971391>.
  42 #define MIN_ARRAY_SIZE (static_cast<size_t>(14))
  43
  44 MarkedSpace::MarkedSpace(JSGlobalData* globalData)
  45     : m_globalData(globalData)
  46 {
  47     memset(&m_heap, 0, sizeof(CollectorHeap));
  48     allocateBlock();
  49 }
  50
  51 void MarkedSpace::destroy()
  52 {
  53     clearMarkBits(); // Make sure weak pointers appear dead during destruction.
  54
  55     while (m_heap.usedBlocks)
  56         freeBlock(0);
  57     fastFree(m_heap.blocks);
  58
  59     memset(&m_heap, 0, sizeof(CollectorHeap));
  60 }
  61
  62 NEVER_INLINE MarkedBlock* MarkedSpace::allocateBlock()
  63 {
  64     PageAllocationAligned allocation = PageAllocationAligned::allocate(BLOCK_SIZE, BLOCK_SIZE, OSAllocator::JSGCHeapPages);
  65     MarkedBlock* block = static_cast<MarkedBlock*>(allocation.base());
  66     if (!block)
  67         CRASH();
  68
  69     // Initialize block.
  70
  71     block->heap = &globalData()->heap;
  72     clearMarkBits(block);
  73
  74     Structure* dummyMarkableCellStructure = globalData()->dummyMarkableCellStructure.get();
  75     for (size_t i = 0; i < HeapConstants::cellsPerBlock; ++i)
  76         new (&block->cells[i]) JSCell(dummyMarkableCellStructure);
  77
  78     // Add block to blocks vector.
  79
  80     size_t numBlocks = m_heap.numBlocks;
  81     if (m_heap.usedBlocks == numBlocks) {
  82         static const size_t maxNumBlocks = ULONG_MAX / sizeof(PageAllocationAligned) / GROWTH_FACTOR;
  83         if (numBlocks > maxNumBlocks)
  84             CRASH();
  85         numBlocks = max(MIN_ARRAY_SIZE, numBlocks * GROWTH_FACTOR);
  86         m_heap.numBlocks = numBlocks;
  87         m_heap.blocks = static_cast<PageAllocationAligned*>(fastRealloc(m_heap.blocks, numBlocks * sizeof(PageAllocationAligned)));
  88     }
  89     m_heap.blocks[m_heap.usedBlocks++] = allocation;
  90
  91     return block;
  92 }
  93
  94 NEVER_INLINE void MarkedSpace::freeBlock(size_t block)
  95 {
  96     ObjectIterator it(m_heap, block, 0);
  97     ObjectIterator end(m_heap, block + 1, 0);
  98     for ( ; it != end; ++it)
  99         (*it)->~JSCell();
 100     m_heap.blocks[block].deallocate();
 101
 102     // swap with the last block so we compact as we go
 103     m_heap.blocks[block] = m_heap.blocks[m_heap.usedBlocks - 1];
 104     m_heap.usedBlocks--;
 105
 106     if (m_heap.numBlocks > MIN_ARRAY_SIZE && m_heap.usedBlocks < m_heap.numBlocks / LOW_WATER_FACTOR) {
 107         m_heap.numBlocks = m_heap.numBlocks / GROWTH_FACTOR;
 108         m_heap.blocks = static_cast<PageAllocationAligned*>(fastRealloc(m_heap.blocks, m_heap.numBlocks * sizeof(PageAllocationAligned)));
 109     }
 110 }
 111
 112 void* MarkedSpace::allocate(size_t s)
 113 {
 114     ASSERT(globalData()->identifierTable == wtfThreadData().currentIdentifierTable());
 115     typedef HeapConstants::Block Block;
 116     typedef HeapConstants::Cell Cell;
 117
 118     ASSERT(JSLock::lockCount() > 0);
 119     ASSERT(JSLock::currentThreadIsHoldingLock());
 120     ASSERT_UNUSED(s, s <= HeapConstants::cellSize);
 121
 122     // Fast case: find the next garbage cell and recycle it.
 123
 124     do {
 125         ASSERT(m_heap.nextBlock < m_heap.usedBlocks);
 126         Block* block = m_heap.collectorBlock(m_heap.nextBlock);
 127         do {
 128             ASSERT(m_heap.nextCell < HeapConstants::cellsPerBlock);
 129             if (!block->marked.get(m_heap.nextCell)) { // Always false for the last cell in the block
 130                 Cell* cell = &block->cells[m_heap.nextCell];
 131
 132                 JSCell* imp = reinterpret_cast<JSCell*>(cell);
 133                 imp->~JSCell();
 134
 135                 ++m_heap.nextCell;
 136                 return cell;
 137             }
 138             m_heap.nextCell = block->marked.nextPossiblyUnset(m_heap.nextCell);
 139         } while (m_heap.nextCell != HeapConstants::cellsPerBlock);
 140         m_heap.nextCell = 0;
 141     } while (++m_heap.nextBlock != m_heap.usedBlocks);
 142
 143     return 0;
 144 }
 145
 146 void MarkedSpace::resizeBlocks()
 147 {
 148     size_t usedCellCount = markedCells();
 149     size_t minCellCount = usedCellCount + max(ALLOCATIONS_PER_COLLECTION, usedCellCount);
 150     size_t minBlockCount = (minCellCount + HeapConstants::cellsPerBlock - 1) / HeapConstants::cellsPerBlock;
 151
 152     size_t maxCellCount = 1.25f * minCellCount;
 153     size_t maxBlockCount = (maxCellCount + HeapConstants::cellsPerBlock - 1) / HeapConstants::cellsPerBlock;
 154
 155     if (m_heap.usedBlocks < minBlockCount)
 156         growBlocks(minBlockCount);
 157     else if (m_heap.usedBlocks > maxBlockCount)
 158         shrinkBlocks(maxBlockCount);
 159 }
 160
 161 void MarkedSpace::growBlocks(size_t neededBlocks)
 162 {
 163     ASSERT(m_heap.usedBlocks < neededBlocks);
 164     while (m_heap.usedBlocks < neededBlocks)
 165         allocateBlock();
 166 }
 167
 168 void MarkedSpace::shrinkBlocks(size_t neededBlocks)
 169 {
 170     ASSERT(m_heap.usedBlocks > neededBlocks);
 171
 172     // Clear the always-on last bit, so isEmpty() isn't fooled by it.
 173     for (size_t i = 0; i < m_heap.usedBlocks; ++i)
 174         m_heap.collectorBlock(i)->marked.clear(HeapConstants::cellsPerBlock - 1);
 175
 176     for (size_t i = 0; i != m_heap.usedBlocks && m_heap.usedBlocks != neededBlocks; ) {
 177         if (m_heap.collectorBlock(i)->marked.isEmpty()) {
 178             freeBlock(i);
 179         } else
 180             ++i;
 181     }
 182
 183     // Reset the always-on last bit.
 184     for (size_t i = 0; i < m_heap.usedBlocks; ++i)
 185         m_heap.collectorBlock(i)->marked.set(HeapConstants::cellsPerBlock - 1);
 186 }
 187
 188 bool MarkedSpace::containsSlowCase(const void* x)
 189 {
 190     uintptr_t xAsBits = reinterpret_cast<uintptr_t>(x);
 191     xAsBits &= CELL_ALIGN_MASK;
 192
 193     uintptr_t offset = xAsBits & BLOCK_OFFSET_MASK;
 194     const size_t lastCellOffset = sizeof(CollectorCell) * (CELLS_PER_BLOCK - 1);
 195     if (offset > lastCellOffset)
 196         return false;
 197
 198     MarkedBlock* blockAddr = reinterpret_cast<MarkedBlock*>(xAsBits - offset);
 199     size_t usedBlocks = m_heap.usedBlocks;
 200     for (size_t block = 0; block < usedBlocks; block++) {
 201         if (m_heap.collectorBlock(block) != blockAddr)
 202             continue;
 203
 204         // x is a pointer into the heap. Now, verify that the cell it
 205         // points to is live. (If the cell is dead, we must not mark it,
 206         // since that would revive it in a zombie state.)
 207         if (block < m_heap.nextBlock)
 208             return true;
 209
 210         size_t cellOffset = offset / CELL_SIZE;
 211
 212         if (block == m_heap.nextBlock && cellOffset < m_heap.nextCell)
 213             return true;
 214
 215         return blockAddr->marked.get(cellOffset);
 216     }
 217
 218     return false;
 219 }
 220
 221 void MarkedSpace::clearMarkBits()
 222 {
 223     for (size_t i = 0; i < m_heap.usedBlocks; ++i)
 224         clearMarkBits(m_heap.collectorBlock(i));
 225 }
 226
 227 void MarkedSpace::clearMarkBits(MarkedBlock* block)
 228 {
 229     // allocate assumes that the last cell in every block is marked.
 230     block->marked.clearAll();
 231     block->marked.set(HeapConstants::cellsPerBlock - 1);
 232 }
 233
 234 size_t MarkedSpace::markedCells(size_t startBlock, size_t startCell) const
 235 {
 236     ASSERT(startBlock <= m_heap.usedBlocks);
 237     ASSERT(startCell < HeapConstants::cellsPerBlock);
 238
 239     if (startBlock >= m_heap.usedBlocks)
 240         return 0;
 241
 242     size_t result = 0;
 243     result += m_heap.collectorBlock(startBlock)->marked.count(startCell);
 244     for (size_t i = startBlock + 1; i < m_heap.usedBlocks; ++i)
 245         result += m_heap.collectorBlock(i)->marked.count();
 246
 247     return result;
 248 }
 249
 250 void MarkedSpace::sweep()
 251 {
 252 #if !ENABLE(JSC_ZOMBIES)
 253     Structure* dummyMarkableCellStructure = globalData()->dummyMarkableCellStructure.get();
 254 #endif
 255
 256     DeadObjectIterator it(m_heap, 0, 0);
 257     DeadObjectIterator end(m_heap, m_heap.usedBlocks, 0);
 258     for ( ; it != end; ++it) {
 259         JSCell* cell = *it;
 260 #if ENABLE(JSC_ZOMBIES)
 261         if (!cell->isZombie()) {
 262             const ClassInfo* info = cell->classInfo();
 263             cell->~JSCell();
 264             new (cell) JSZombie(info, JSZombie::leakedZombieStructure());
 265             Heap::markCell(cell);
 266         }
 267 #else
 268         cell->~JSCell();
 269         // Callers of sweep assume it's safe to mark any cell in the heap.
 270         new (cell) JSCell(dummyMarkableCellStructure);
 271 #endif
 272     }
 273 }
 274
 275 size_t MarkedSpace::objectCount() const
 276 {
 277     return m_heap.nextBlock * HeapConstants::cellsPerBlock // allocated full blocks
 278            + m_heap.nextCell // allocated cells in current block
 279            + markedCells(m_heap.nextBlock, m_heap.nextCell) // marked cells in remainder of m_heap
 280            - m_heap.usedBlocks; // 1 cell per block is a dummy sentinel
 281 }
 282
 283 size_t MarkedSpace::size() const
 284 {
 285     return objectCount() * HeapConstants::cellSize;
 286 }
 287
 288 size_t MarkedSpace::capacity() const
 289 {
 290     return m_heap.usedBlocks * BLOCK_SIZE;
 291 }
 292
 293 void MarkedSpace::reset()
 294 {
 295     m_heap.nextCell = 0;
 296     m_heap.nextBlock = 0;
 297 #if ENABLE(JSC_ZOMBIES)
 298     sweep();
 299 #endif
 300     resizeBlocks();
 301 }
 302
 303 LiveObjectIterator MarkedSpace::primaryHeapBegin()
 304 {
 305     return LiveObjectIterator(m_heap, 0, 0);
 306 }
 307
 308 LiveObjectIterator MarkedSpace::primaryHeapEnd()
 309 {
 310     return LiveObjectIterator(m_heap, m_heap.usedBlocks, 0);
 311 }
 312
 313 } // namespace JSC