starboard/common/memory_pool.h

/*
 * Copyright 2023 The Cobalt Authors. All Rights Reserved.
 * Copyright 2014 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef STARBOARD_COMMON_MEMORY_POOL_H_
#define STARBOARD_COMMON_MEMORY_POOL_H_

#include "starboard/common/allocator.h"
#include "starboard/common/fixed_no_free_allocator.h"
#include "starboard/common/log.h"

namespace starboard {
namespace common {

// The MemoryPool class can be used to wrap a range of memory with allocators
// such that the memory can be allocated out of and free'd memory re-used as
// necessary.
template <typename ReuseAllocator>
class MemoryPool : public Allocator {
 public:
  MemoryPool(void* buffer, std::size_t size)
      : no_free_allocator_(buffer, size),
        reuse_allocator_(&no_free_allocator_, size) {
    SB_DCHECK(buffer);
    SB_DCHECK(size > 0U);
  }

  template <typename ParameterType>
  MemoryPool(void* buffer, std::size_t size, ParameterType parameter1)
      : no_free_allocator_(buffer, size),
        reuse_allocator_(&no_free_allocator_, size, parameter1) {
    SB_DCHECK(buffer);
    SB_DCHECK(size > 0U);
  }

  void* Allocate(std::size_t size) { return reuse_allocator_.Allocate(size); }
  void* Allocate(std::size_t size, std::size_t alignment) {
    return reuse_allocator_.Allocate(size, alignment);
  }
  void Free(void* memory) { reuse_allocator_.Free(memory); }
  std::size_t GetCapacity() const { return reuse_allocator_.GetCapacity(); }
  std::size_t GetAllocated() const { return reuse_allocator_.GetAllocated(); }

  std::size_t GetHighWaterMark() const {
    return no_free_allocator_.GetAllocated();
  }

  void PrintAllocations() const { reuse_allocator_.PrintAllocations(); }

 private:
  // A budget of memory to be used by the memory pool.
  FixedNoFreeAllocator no_free_allocator_;

  // A reuse allocator that will be setup to fallback on the no free allocator
  // to expand its pool as memory is required for which there is no re-usable
  // space already.
  ReuseAllocator reuse_allocator_;
};

}  // namespace common
}  // namespace starboard

#endif  // STARBOARD_COMMON_MEMORY_POOL_H_