Files
swift-mirror/lib/IRGen/GenConcurrency.h
Michael Gottesman 97b0e2ebae [concurrency] Create builtins for invoking specific concurrency runtime functions.
Specifically:

1. swift_task_addCancellationHandler
2. swift_task_removeCancellationHandler
3. swift_task_addPriorityEscalationHandler
4. swift_task_removePriorityEscalationHandler
5. swift_task_localValuePush
6. swift_task_localValuePop

rdar://109850951
2025-11-05 11:03:44 -08:00

145 lines
5.6 KiB
C++

//===--- GenConcurrency.h - IRGen for concurrency features ------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file defines interfaces for emitting code for various concurrency
// features.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_IRGEN_GENCONCURRENCY_H
#define SWIFT_IRGEN_GENCONCURRENCY_H
#include "swift/AST/Types.h"
#include "swift/Basic/LLVM.h"
#include "swift/SIL/ApplySite.h"
#include "llvm/IR/CallingConv.h"
#include "Callee.h"
#include "GenHeap.h"
#include "IRGenModule.h"
namespace llvm {
class Value;
}
namespace swift {
class CanType;
class ProtocolConformanceRef;
class SILType;
namespace irgen {
class Explosion;
class OptionalExplosion;
class IRGenFunction;
/// Emit the buildMainActorExecutorRef builtin.
void emitBuildMainActorExecutorRef(IRGenFunction &IGF, Explosion &out);
/// Emit the buildDefaultActorExecutorRef builtin.
void emitBuildDefaultActorExecutorRef(IRGenFunction &IGF, llvm::Value *actor,
Explosion &out);
/// Emit the buildOrdinaryTaskExecutorRef builtin.
void emitBuildOrdinaryTaskExecutorRef(
IRGenFunction &IGF, llvm::Value *executor, CanType executorType,
ProtocolConformanceRef executorConformance, Explosion &out);
/// Emit the buildOrdinarySerialExecutorRef builtin.
void emitBuildOrdinarySerialExecutorRef(IRGenFunction &IGF,
llvm::Value *executor,
CanType executorType,
ProtocolConformanceRef executorConformance,
Explosion &out);
/// Emit the buildComplexEqualitySerialExecutorRef builtin.
void emitBuildComplexEqualitySerialExecutorRef(IRGenFunction &IGF,
llvm::Value *executor,
CanType executorType,
ProtocolConformanceRef executorConformance,
Explosion &out);
/// Emit the getCurrentExecutor builtin.
void emitGetCurrentExecutor(IRGenFunction &IGF, Explosion &out);
/// Emit the createAsyncLet builtin.
llvm::Value *emitBuiltinStartAsyncLet(IRGenFunction &IGF,
llvm::Value *taskOptions,
llvm::Value *taskFunction,
llvm::Value *localContextInfo,
llvm::Value *resultBuffer,
SubstitutionMap subs);
/// Emit the finishAsyncLet builtin.
void emitFinishAsyncLet(IRGenFunction &IGF,
llvm::Value *asyncLet,
llvm::Value *resultBuffer);
/// Emit the createTaskGroup builtin.
llvm::Value *emitCreateTaskGroup(IRGenFunction &IGF, SubstitutionMap subs,
llvm::Value *groupFlags);
/// Emit the destroyTaskGroup builtin.
void emitDestroyTaskGroup(IRGenFunction &IGF, llvm::Value *group);
void emitTaskRunInline(IRGenFunction &IGF, SubstitutionMap subs,
llvm::Value *result, llvm::Value *closure,
llvm::Value *closureContext);
void emitTaskCancel(IRGenFunction &IGF, llvm::Value *task);
llvm::Value *maybeAddEmbeddedSwiftResultTypeInfo(IRGenFunction &IGF,
llvm::Value *taskOptions,
CanType formalResultType);
/// Emit a call to swift_task_create[_f] with the given flags, options, and
/// task function.
std::pair<llvm::Value *, llvm::Value *>
emitTaskCreate(IRGenFunction &IGF, llvm::Value *flags,
OptionalExplosion &initialExecutor,
OptionalExplosion &taskGroup,
OptionalExplosion &taskExecutorUnowned,
OptionalExplosion &taskExecutorExistential,
OptionalExplosion &taskName,
Explosion &taskFunction,
SubstitutionMap subs);
llvm::Value *clearImplicitIsolatedActorBits(IRGenFunction &IGF,
llvm::Value *value);
/// Emit IR for a builtin that adds a handler to the Task's task record.
///
/// \returns the record that can be used to refer to and cancel the handler.
///
/// Currently supports TaskAddCancellationHandler and
/// TaskAddPriorityEscalationHandler.
llvm::Value *emitBuiltinTaskAddHandler(IRGenFunction &IGF,
BuiltinValueKind kind, llvm::Value *func,
llvm::Value *context);
/// Emit IR for a builtin that cancels some sort of handler by calling an ABI
/// entry point. Record is a value that was returned by the handler creator.
///
/// E.x.: TaskRemoveCancellationHandler, TaskRemovePriorityEscalationHandler.
void emitBuiltinTaskRemoveHandler(IRGenFunction &IGF, BuiltinValueKind kind,
llvm::Value *record);
void emitBuiltinTaskLocalValuePush(IRGenFunction &IGF, llvm::Value *key,
llvm::Value *value,
llvm::Value *valueMetatype);
void emitBuiltinTaskLocalValuePop(IRGenFunction &IGF);
} // end namespace irgen
} // end namespace swift
#endif