197 lines
6.1 KiB
C++
197 lines
6.1 KiB
C++
/*
|
|
* Copyright (C) 2014-2021 Apple Inc. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "AvailableMemory.h"
|
|
#include "Cache.h"
|
|
#include "DebugHeap.h"
|
|
#include "Gigacage.h"
|
|
#include "Heap.h"
|
|
#include "IsoTLS.h"
|
|
#include "Mutex.h"
|
|
#include "PerHeapKind.h"
|
|
#include "Scavenger.h"
|
|
|
|
#if BUSE(LIBPAS)
|
|
#ifndef PAS_BMALLOC
|
|
#define PAS_BMALLOC 1
|
|
#endif
|
|
#include "bmalloc_heap_inlines.h"
|
|
#endif
|
|
|
|
namespace bmalloc {
|
|
namespace api {
|
|
|
|
#if BUSE(LIBPAS)
|
|
extern pas_primitive_heap_ref gigacageHeaps[Gigacage::NumberOfKinds];
|
|
|
|
inline pas_primitive_heap_ref& heapForKind(Gigacage::Kind kind)
|
|
{
|
|
RELEASE_BASSERT(static_cast<unsigned>(kind) < Gigacage::NumberOfKinds);
|
|
return gigacageHeaps[static_cast<unsigned>(kind)];
|
|
}
|
|
#endif
|
|
|
|
// Returns null on failure.
|
|
BINLINE void* tryMalloc(size_t size, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
if (!isGigacage(kind))
|
|
return bmalloc_try_allocate_inline(size);
|
|
return bmalloc_try_allocate_auxiliary_inline(&heapForKind(gigacageKind(kind)), size);
|
|
#else
|
|
return Cache::tryAllocate(kind, size);
|
|
#endif
|
|
}
|
|
|
|
// Crashes on failure.
|
|
BINLINE void* malloc(size_t size, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
if (!isGigacage(kind))
|
|
return bmalloc_allocate_inline(size);
|
|
return bmalloc_allocate_auxiliary_inline(&heapForKind(gigacageKind(kind)), size);
|
|
#else
|
|
return Cache::allocate(kind, size);
|
|
#endif
|
|
}
|
|
|
|
BEXPORT void* mallocOutOfLine(size_t size, HeapKind kind = HeapKind::Primary);
|
|
|
|
// Returns null on failure.
|
|
BINLINE void* tryMemalign(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
if (!isGigacage(kind))
|
|
return bmalloc_try_allocate_with_alignment_inline(size, alignment);
|
|
return bmalloc_try_allocate_auxiliary_with_alignment_inline(
|
|
&heapForKind(gigacageKind(kind)), size, alignment);
|
|
#else
|
|
return Cache::tryAllocate(kind, alignment, size);
|
|
#endif
|
|
}
|
|
|
|
// Crashes on failure.
|
|
BINLINE void* memalign(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
if (!isGigacage(kind))
|
|
return bmalloc_allocate_with_alignment_inline(size, alignment);
|
|
return bmalloc_allocate_auxiliary_with_alignment_inline(
|
|
&heapForKind(gigacageKind(kind)), size, alignment);
|
|
#else
|
|
return Cache::allocate(kind, alignment, size);
|
|
#endif
|
|
}
|
|
|
|
// Returns null on failure.
|
|
BINLINE void* tryRealloc(void* object, size_t newSize, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
if (!isGigacage(kind)) {
|
|
return bmalloc_try_reallocate_inline(
|
|
object, newSize, pas_reallocate_free_if_successful);
|
|
}
|
|
return bmalloc_try_reallocate_auxiliary_inline(
|
|
object, &heapForKind(gigacageKind(kind)), newSize, pas_reallocate_free_if_successful);
|
|
#else
|
|
return Cache::tryReallocate(kind, object, newSize);
|
|
#endif
|
|
}
|
|
|
|
// Crashes on failure.
|
|
BINLINE void* realloc(void* object, size_t newSize, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
if (!isGigacage(kind))
|
|
return bmalloc_reallocate_inline(object, newSize, pas_reallocate_free_if_successful);
|
|
return bmalloc_reallocate_auxiliary_inline(
|
|
object, &heapForKind(gigacageKind(kind)), newSize, pas_reallocate_free_if_successful);
|
|
#else
|
|
return Cache::reallocate(kind, object, newSize);
|
|
#endif
|
|
}
|
|
|
|
// Returns null on failure.
|
|
// This API will give you zeroed pages that are ready to be used. These pages
|
|
// will page fault on first access. It returns to you memory that initially only
|
|
// uses up virtual address space, not `size` bytes of physical memory.
|
|
BEXPORT void* tryLargeZeroedMemalignVirtual(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary);
|
|
|
|
BINLINE void free(void* object, HeapKind kind = HeapKind::Primary)
|
|
{
|
|
#if BUSE(LIBPAS)
|
|
BUNUSED(kind);
|
|
bmalloc_deallocate_inline(object);
|
|
#else
|
|
Cache::deallocate(kind, object);
|
|
#endif
|
|
}
|
|
|
|
BEXPORT void freeOutOfLine(void* object, HeapKind kind = HeapKind::Primary);
|
|
|
|
BEXPORT void freeLargeVirtual(void* object, size_t, HeapKind kind = HeapKind::Primary);
|
|
|
|
BEXPORT void scavengeThisThread();
|
|
|
|
BEXPORT void scavenge();
|
|
|
|
BEXPORT bool isEnabled(HeapKind kind = HeapKind::Primary);
|
|
|
|
// ptr must be aligned to vmPageSizePhysical and size must be divisible
|
|
// by vmPageSizePhysical.
|
|
BEXPORT void decommitAlignedPhysical(void* object, size_t, HeapKind = HeapKind::Primary);
|
|
BEXPORT void commitAlignedPhysical(void* object, size_t, HeapKind = HeapKind::Primary);
|
|
|
|
inline size_t availableMemory()
|
|
{
|
|
return bmalloc::availableMemory();
|
|
}
|
|
|
|
#if BPLATFORM(IOS_FAMILY) || BOS(LINUX) || BOS(FREEBSD)
|
|
inline size_t memoryFootprint()
|
|
{
|
|
return bmalloc::memoryFootprint();
|
|
}
|
|
|
|
inline double percentAvailableMemoryInUse()
|
|
{
|
|
return bmalloc::percentAvailableMemoryInUse();
|
|
}
|
|
#endif
|
|
|
|
#if BOS(DARWIN)
|
|
BEXPORT void setScavengerThreadQOSClass(qos_class_t overrideClass);
|
|
#endif
|
|
|
|
BEXPORT void enableMiniMode();
|
|
|
|
// Used for debugging only.
|
|
BEXPORT void disableScavenger();
|
|
|
|
} // namespace api
|
|
} // namespace bmalloc
|