darling-bmalloc/bmalloc/bmalloc.h
2023-04-27 08:59:12 -07:00

137 lines
4.2 KiB
C++

/*
* Copyright (C) 2014-2018 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 "Gigacage.h"
#include "Heap.h"
#include "IsoTLS.h"
#include "Mutex.h"
#include "PerHeapKind.h"
#include "Scavenger.h"
namespace bmalloc {
namespace api {
// Returns null on failure.
inline void* tryMalloc(size_t size, HeapKind kind = HeapKind::Primary)
{
return Cache::tryAllocate(kind, size);
}
// Crashes on failure.
inline void* malloc(size_t size, HeapKind kind = HeapKind::Primary)
{
return Cache::allocate(kind, size);
}
BEXPORT void* mallocOutOfLine(size_t size, HeapKind kind = HeapKind::Primary);
// Returns null on failure.
inline void* tryMemalign(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
{
return Cache::tryAllocate(kind, alignment, size);
}
// Crashes on failure.
inline void* memalign(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
{
return Cache::allocate(kind, alignment, size);
}
// Returns null on failure.
inline void* tryRealloc(void* object, size_t newSize, HeapKind kind = HeapKind::Primary)
{
return Cache::tryReallocate(kind, object, newSize);
}
// Crashes on failure.
inline void* realloc(void* object, size_t newSize, HeapKind kind = HeapKind::Primary)
{
return Cache::reallocate(kind, object, newSize);
}
// 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);
inline void free(void* object, HeapKind kind = HeapKind::Primary)
{
Cache::deallocate(kind, object);
}
BEXPORT void freeOutOfLine(void* object, HeapKind kind = HeapKind::Primary);
BEXPORT void freeLargeVirtual(void* object, size_t, HeapKind kind = HeapKind::Primary);
inline void scavengeThisThread()
{
for (unsigned i = numHeaps; i--;)
Cache::scavenge(static_cast<HeapKind>(i));
IsoTLS::scavenge();
}
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