kjs/CollectorHeapIntrospector.cpp

   1 /*
   2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include "config.h"
  30 #include "CollectorHeapIntrospector.h"
  31
  32 #include "collector.h"
  33 #include "MallocZoneSupport.h"
  34
  35 namespace KJS {
  36
  37 extern "C" {
  38 malloc_introspection_t jscore_collector_introspection = { &CollectorHeapIntrospector::enumerate, &CollectorHeapIntrospector::goodSize, &CollectorHeapIntrospector::check, &CollectorHeapIntrospector::print,
  39     &CollectorHeapIntrospector::log, &CollectorHeapIntrospector::forceLock, &CollectorHeapIntrospector::forceUnlock, &CollectorHeapIntrospector::statistics };
  40 }
  41
  42 void CollectorHeapIntrospector::init(CollectorHeap* primaryHeap, CollectorHeap* numberHeap)
  43 {
  44     static CollectorHeapIntrospector zone(primaryHeap, numberHeap);
  45 }
  46
  47 CollectorHeapIntrospector::CollectorHeapIntrospector(CollectorHeap* primaryHeap, CollectorHeap* numberHeap)
  48     : m_primaryHeap(primaryHeap)
  49     , m_numberHeap(numberHeap)
  50 {
  51     memset(&m_zone, 0, sizeof(m_zone));
  52     m_zone.zone_name = "JavaScriptCore Collector";
  53     m_zone.size = &CollectorHeapIntrospector::size;
  54     m_zone.malloc = &CollectorHeapIntrospector::zoneMalloc;
  55     m_zone.calloc = &CollectorHeapIntrospector::zoneCalloc;
  56     m_zone.realloc = &CollectorHeapIntrospector::zoneRealloc;
  57     m_zone.free = &CollectorHeapIntrospector::zoneFree;
  58     m_zone.valloc = &CollectorHeapIntrospector::zoneValloc;
  59     m_zone.destroy = &CollectorHeapIntrospector::zoneDestroy;
  60     m_zone.introspect = &jscore_collector_introspection;
  61     malloc_zone_register(&m_zone);
  62 }
  63
  64 kern_return_t CollectorHeapIntrospector::enumerate(task_t task, void* context, unsigned typeMask, vm_address_t zoneAddress, memory_reader_t reader, vm_range_recorder_t recorder)
  65 {
  66     RemoteMemoryReader memoryReader(task, reader);
  67     CollectorHeapIntrospector* zone = memoryReader(reinterpret_cast<CollectorHeapIntrospector*>(zoneAddress));
  68     CollectorHeap* heaps[2] = {memoryReader(zone->m_primaryHeap), memoryReader(zone->m_numberHeap)};
  69
  70     if (!heaps[0]->blocks && !heaps[1]->blocks)
  71         return 0;
  72
  73     for (int currentHeap = 0; currentHeap < 2; currentHeap++) {
  74         CollectorHeap* heap = heaps[currentHeap];
  75         CollectorBlock** blocks = memoryReader(heap->blocks);
  76         for (unsigned i = 0; i < heap->usedBlocks; i++) {
  77             vm_address_t remoteBlockAddress = reinterpret_cast<vm_address_t>(blocks[i]);
  78             vm_range_t ptrRange = { remoteBlockAddress, sizeof(CollectorBlock) };
  79
  80             if (typeMask & (MALLOC_PTR_REGION_RANGE_TYPE | MALLOC_ADMIN_REGION_RANGE_TYPE))
  81                 (*recorder)(task, context, MALLOC_PTR_REGION_RANGE_TYPE, &ptrRange, 1);
  82
  83             // Recording individual cells causes frequent false-positives.  Any garbage cells
  84             // which have yet to be collected are labeled as leaks.  Recording on a per-block
  85             // basis provides less detail but avoids these false-positives.
  86             if (memoryReader(blocks[i])->usedCells && (typeMask & MALLOC_PTR_IN_USE_RANGE_TYPE))
  87                 (*recorder)(task, context, MALLOC_PTR_IN_USE_RANGE_TYPE, &ptrRange, 1);
  88         }
  89     }
  90
  91     return 0;
  92 }
  93
  94 } // namespace KJS