Source/bmalloc/bmalloc/Zone.h

   1 /*
   2  * Copyright (C) 2014, 2015 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  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef Zone_h
  27 #define Zone_h
  28
  29 #include "FixedVector.h"
  30 #include <malloc/malloc.h>
  31
  32 namespace bmalloc {
  33
  34 class SuperChunk;
  35
  36 class Zone : public malloc_zone_t {
  37 public:
  38     // Enough capacity to track a 64GB heap, so probably enough for anything.
  39     static const size_t capacity = 2048;
  40
  41     static size_t size(malloc_zone_t*, const void*);
  42     static kern_return_t enumerator(task_t, void* context, unsigned type_mask, vm_address_t, memory_reader_t, vm_range_recorder_t);
  43
  44     Zone();
  45
  46     void addSuperChunk(SuperChunk*);
  47     FixedVector<SuperChunk*, capacity>& superChunks() { return m_superChunks; }
  48
  49 private:
  50     // This vector has two purposes:
  51     //     (1) It stores the list of SuperChunks so that we can enumerate
  52     //         each SuperChunk and request that it be scanned if reachable.
  53     //     (2) It roots a pointer to each SuperChunk in a global non-malloc
  54     //         VM region, making each SuperChunk appear reachable, and therefore
  55     //         ensuring that the leaks tool will scan it. (The leaks tool
  56     //         conservatively scans all writeable VM regions that are not malloc
  57     //         regions, and then scans malloc regions using the introspection API.)
  58     // This prevents the leaks tool from reporting false positive leaks for
  59     // objects pointed to from bmalloc memory -- though it also prevents the
  60     // leaks tool from finding any leaks in bmalloc memory.
  61     FixedVector<SuperChunk*, capacity> m_superChunks;
  62 };
  63
  64 inline void Zone::addSuperChunk(SuperChunk* superChunk)
  65 {
  66     if (m_superChunks.size() == m_superChunks.capacity())
  67         return;
  68
  69     m_superChunks.push(superChunk);
  70 }
  71
  72 } // namespace bmalloc
  73
  74 #endif // Zone_h