| //===--- Heap.cpp - Swift Language Heap Logic -----------------------------===// |
| // |
| // This source file is part of the Swift.org open source project |
| // |
| // Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors |
| // Licensed under Apache License v2.0 with Runtime Library Exception |
| // |
| // See https://swift.org/LICENSE.txt for license information |
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| // |
| //===----------------------------------------------------------------------===// |
| // |
| // Implementations of the Swift heap |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #include "swift/Runtime/HeapObject.h" |
| #include "swift/Runtime/Heap.h" |
| #include "Private.h" |
| #include "swift/Runtime/Debug.h" |
| #include "../SwiftShims/RuntimeShims.h" |
| #include <algorithm> |
| #include <stdlib.h> |
| |
| using namespace swift; |
| |
| #if defined(__APPLE__) |
| // Apple malloc is always 16-byte aligned. |
| # define MALLOC_ALIGN_MASK 15 |
| |
| #elif defined(__linux__) |
| // Linux malloc is 16-byte aligned on 64-bit, and 8-byte aligned on 32-bit. |
| # if defined(__LP64) |
| # define MALLOC_ALIGN_MASK 15 |
| # else |
| # define MALLOC_ALIGN_MASK 7 |
| # endif |
| |
| #elif defined(_WIN64) |
| // Windows malloc is 16-byte aligned on 64-bit and 8-byte aligned on 32-bit. |
| # define MALLOC_ALIGN_MASK 15 |
| #elif defined(_WIN32) |
| # define MALLOC_ALIGN_MASK 7 |
| |
| #else |
| // Unknown alignment, but the standard requires alignment suitable for the largest |
| // standard types. |
| # define MALLOC_ALIGN_MASK std::max(alignof(void *), alignof(double)) |
| |
| #endif |
| |
| // This assert ensures that manually allocated memory always uses the |
| // AlignedAlloc path. The stdlib will use "default" alignment for any user |
| // requested alignment less than or equal to _swift_MinAllocationAlignment. The |
| // runtime must ensure that any alignment > _swift_MinAllocationAlignment also |
| // uses the "aligned" deallocation path. |
| static_assert(_swift_MinAllocationAlignment > MALLOC_ALIGN_MASK, |
| "Swift's default alignment must exceed platform malloc mask."); |
| |
| // When alignMask == ~(size_t(0)), allocation uses the "default" |
| // _swift_MinAllocationAlignment. This is different than calling swift_slowAlloc |
| // with `alignMask == _swift_MinAllocationAlignment - 1` because it forces |
| // the use of AlignedAlloc. This allows manually allocated to memory to always |
| // be deallocated with AlignedFree without knowledge of its original allocation |
| // alignment. |
| // |
| // For alignMask > (_minAllocationAlignment-1) |
| // i.e. alignment == 0 || alignment > _minAllocationAlignment: |
| // The runtime must use AlignedAlloc, and the standard library must |
| // deallocate using an alignment that meets the same condition. |
| // |
| // For alignMask <= (_minAllocationAlignment-1) |
| // i.e. 0 < alignment <= _minAllocationAlignment: |
| // The runtime may use either malloc or AlignedAlloc, and the standard library |
| // must deallocate using an identical alignment. |
| void *swift::swift_slowAlloc(size_t size, size_t alignMask) { |
| void *p; |
| // This check also forces "default" alignment to use AlignedAlloc. |
| if (alignMask <= MALLOC_ALIGN_MASK) { |
| p = malloc(size); |
| } else { |
| size_t alignment = (alignMask == ~(size_t(0))) |
| ? _swift_MinAllocationAlignment |
| : alignMask + 1; |
| p = AlignedAlloc(size, alignment); |
| } |
| if (!p) swift::crash("Could not allocate memory."); |
| return p; |
| } |
| |
| // Unknown alignment is specified by passing alignMask == ~(size_t(0)), forcing |
| // the AlignedFree deallocation path for unknown alignment. The memory |
| // deallocated with unknown alignment must have been allocated with either |
| // "default" alignment, or alignment > _swift_MinAllocationAlignment, to |
| // guarantee that it was allocated with AlignedAlloc. |
| // |
| // The standard library assumes the following behavior: |
| // |
| // For alignMask > (_minAllocationAlignment-1) |
| // i.e. alignment == 0 || alignment > _minAllocationAlignment: |
| // The runtime must use AlignedFree. |
| // |
| // For alignMask <= (_minAllocationAlignment-1) |
| // i.e. 0 < alignment <= _minAllocationAlignment: |
| // The runtime may use either `free` or AlignedFree as long as it is |
| // consistent with allocation with the same alignment. |
| void swift::swift_slowDealloc(void *ptr, size_t bytes, size_t alignMask) { |
| if (alignMask <= MALLOC_ALIGN_MASK) { |
| free(ptr); |
| } else { |
| AlignedFree(ptr); |
| } |
| } |