Source/bmalloc/bmalloc/BumpAllocator.h

   1 /*
   2  * Copyright (C) 2014 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 BumpAllocator_h
  27 #define BumpAllocator_h
  28
  29 #include "BAssert.h"
  30 #include "ObjectType.h"
  31
  32 namespace bmalloc {
  33
  34 // Helper object for allocating small and medium objects.
  35
  36 class BumpAllocator {
  37 public:
  38     BumpAllocator();
  39     template<typename Line> void init(size_t);
  40
  41     bool isNull() { return !m_ptr; }
  42     template<typename Line> Line* line();
  43
  44     bool canAllocate() { return !!m_remaining; }
  45     void* allocate();
  46
  47     template<typename Line> void refill(Line*);
  48     void clear();
  49
  50 private:
  51     void validate(void*);
  52
  53     char* m_ptr;
  54     unsigned short m_size;
  55     unsigned char m_remaining;
  56     unsigned char m_maxObjectCount;
  57 };
  58
  59 inline BumpAllocator::BumpAllocator()
  60     : m_ptr()
  61     , m_size()
  62     , m_remaining()
  63     , m_maxObjectCount()
  64 {
  65 }
  66
  67 template<typename Line>
  68 inline void BumpAllocator::init(size_t size)
  69 {
  70     BASSERT(size >= Line::minimumObjectSize);
  71
  72     m_ptr = nullptr;
  73     m_size = size;
  74     m_remaining = 0;
  75     m_maxObjectCount = Line::lineSize / size;
  76 }
  77
  78 template<typename Line>
  79 inline Line* BumpAllocator::line()
  80 {
  81     return Line::get(canAllocate() ? m_ptr : m_ptr - 1);
  82 }
  83
  84 inline void BumpAllocator::validate(void* ptr)
  85 {
  86     UNUSED(ptr);
  87     if (m_size <= smallMax) {
  88         BASSERT(isSmall(ptr));
  89         return;
  90     }
  91
  92     BASSERT(m_size <= mediumMax);
  93     BASSERT(isMedium(ptr));
  94 }
  95
  96 inline void* BumpAllocator::allocate()
  97 {
  98     BASSERT(m_remaining);
  99
 100     --m_remaining;
 101     char* result = m_ptr;
 102     m_ptr += m_size;
 103     validate(result);
 104     return result;
 105 }
 106
 107 template<typename Line>
 108 inline void BumpAllocator::refill(Line* line)
 109 {
 110     BASSERT(!canAllocate());
 111     line->concurrentRef(m_maxObjectCount);
 112     m_ptr = line->begin();
 113     m_remaining = m_maxObjectCount;
 114 }
 115
 116 inline void BumpAllocator::clear()
 117 {
 118     m_ptr = nullptr;
 119     m_remaining = 0;
 120 }
 121
 122 } // namespace bmalloc
 123
 124 #endif // BumpAllocator_h