blob: 07ee8e02598f4b055f861d697f575588ac47802e [file] [log] [blame]
* 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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
// TODO: Include "starboard/types.h" once legacy platforms are ported to
// starboard. Currently including <vector> is used as a platform independent
// way to introduce std::size_t.
#include <vector>
namespace nb {
// The Allocator interface offers a standard and consistent way of allocating
// and freeing memory. The interface makes no assumption on how the memory
// is allocated and/or freed, and no assumptions about any tracking that may
// occur on the allocations as well. This must all be defined and implemented
// through derived classes.
class Allocator {
virtual ~Allocator() {}
// Allocates a range of memory of the given size, without any alignment
// constraints.
// Will return NULL if the allocation fails.
virtual void* Allocate(std::size_t size) = 0;
// Allocates a range of memory of the given size with the given alignment.
// Will return NULL if the allocation fails.
virtual void* Allocate(std::size_t size, std::size_t alignment) = 0;
// When supported, allocates a range of memory of the given size for the given
// alignment. Returns a pointer that may not be aligned but points to a memory
// area that is still large enough when the pointer is subsequently aligned to
// the given alignment. This allows a reuse allocator to use the padding area
// as a free block. |size| will be set to the actual size allocated on
// successful allocations. Will return NULL if the allocation fails. In the
// case that the underlying block size is inconvenient or impossible to be
// retreived, the |size| can remain unchanged for a successful allocation. The
// user may lose the ability to combine two adjacent allocations in this case.
// Note that the coding style recommends that in/out parameters to be placed
// after input parameters but |size| is kept in the left for consistency.
virtual void* AllocateForAlignment(std::size_t* /*size*/,
std::size_t /*alignment*/) {
return 0;
// Frees memory previously allocated via any call to Allocate().
virtual void Free(void* memory) = 0;
// Frees memory with a size. By default it will delegate to Free().
virtual void FreeWithSize(void* memory, std::size_t /*size*/) {
// Returns the allocator's total capacity for allocations. It will always
// be true that GetSize() <= GetCapacity(), though it is possible for
// capacity to grow and change over time. It is also possible that due to,
// say, fragmentation, an allocation may fail even if GetCapacity() reports
// that enough space is available.
virtual std::size_t GetCapacity() const = 0;
// Returns the allocator's total memory currently allocated.
virtual std::size_t GetAllocated() const = 0;
// Print information for all allocations.
virtual void PrintAllocations() const = 0;
} // namespace nb
#endif // NB_ALLOCATOR_H_