mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
2412ac3dc4
Don't rely on the kind for this. Allow each allocator to decide for itself for future compatibility.
86 lines
2.6 KiB
C++
86 lines
2.6 KiB
C++
//===---------- Coro.h - ABI structures for coroutines ----------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Swift ABI describing the coroutine ABI.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_ABI_CORO_H
|
|
#define SWIFT_ABI_CORO_H
|
|
|
|
#include "swift/Basic/FlagSet.h"
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
|
|
namespace swift {
|
|
|
|
enum class CoroAllocatorKind : uint8_t {
|
|
// stacksave/stackrestore
|
|
Stack = 0,
|
|
// swift_task_alloc/swift_task_dealloc_through
|
|
Async = 1,
|
|
// malloc/free
|
|
Malloc = 2,
|
|
};
|
|
|
|
class CoroAllocatorFlags : public FlagSet<uint32_t> {
|
|
public:
|
|
// clang-format off
|
|
enum {
|
|
Kind = 0,
|
|
Kind_width = 8,
|
|
|
|
ShouldDeallocateImmediately = 8,
|
|
|
|
// 24 reserved bits
|
|
};
|
|
// clang-format on
|
|
|
|
constexpr explicit CoroAllocatorFlags(uint32_t bits) : FlagSet(bits) {}
|
|
CoroAllocatorFlags(CoroAllocatorKind kind) { setKind(kind); }
|
|
constexpr CoroAllocatorFlags() {}
|
|
|
|
FLAGSET_DEFINE_FIELD_ACCESSORS(Kind, Kind_width, CoroAllocatorKind, getKind,
|
|
setKind)
|
|
FLAGSET_DEFINE_FLAG_ACCESSORS(ShouldDeallocateImmediately,
|
|
shouldDeallocateImmediately,
|
|
setShouldDeallocateImmediately)
|
|
};
|
|
|
|
using CoroAllocation = void *;
|
|
using CoroAllocateFn = CoroAllocation (*)(size_t);
|
|
using CoroDealllocateFn = void (*)(CoroAllocation);
|
|
|
|
struct CoroAllocator {
|
|
CoroAllocatorFlags flags;
|
|
CoroAllocateFn allocate;
|
|
CoroDealllocateFn deallocate;
|
|
|
|
/// Whether the allocator should deallocate memory on calls to
|
|
/// swift_coro_dealloc.
|
|
bool shouldDeallocateImmediately() {
|
|
// Currently, only the "mallocator" should immediately deallocate in
|
|
// swift_coro_dealloc. It must because the ABI does not provide a means for
|
|
// the callee to return its allocations to the caller.
|
|
//
|
|
// Async allocations can be deferred until the first non-coroutine caller
|
|
// from where swift_task_dealloc_through can be called and passed the
|
|
// caller-allocated fixed-per-callee-sized-frame.
|
|
// Stack allocations just pop the stack.
|
|
return flags.shouldDeallocateImmediately();
|
|
}
|
|
};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|