mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
ff2db93922
Define the possible runtime effects of an instruction in an enum `RuntimeEffect`. Add a new utility `swift:getRuntimeEffect` to estimate the runtime effects of an instruction. Also, add a mechanism to validate the correctness of the analysis in IRGen: annotate all runtime functions in RuntimeFunctions.def with the actual effect what the runtime function has or can have. Then check if the effects of emitted runtime functions for an instruction match what `getRuntimeEffect` predicts. This check is only enabled on demand by defining the CHECK_RUNTIME_EFFECT_ANALYSIS macro in RuntimeEffect.h
84 lines
2.6 KiB
C++
84 lines
2.6 KiB
C++
//===--- RuntimeEffect.h - Defines the RuntimeEffect enum -------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SIL_RUNTIMEIMPACT_H
|
|
#define SWIFT_SIL_RUNTIMEIMPACT_H
|
|
|
|
namespace swift {
|
|
|
|
/// Defines the effect of runtime functions.
|
|
enum class RuntimeEffect : unsigned {
|
|
/// The runtime function has no observable effect.
|
|
NoEffect = 0,
|
|
|
|
/// The runtime function can lock.
|
|
Locking = 0x01,
|
|
|
|
/// The runtime function can allocate memory (implies Locking).
|
|
Allocating = 0x02,
|
|
|
|
/// The runtime function can deallocate memory (implies Locking).
|
|
Deallocating = 0x04,
|
|
|
|
/// The runtime function performs ARC operations (implies Locking).
|
|
RefCounting = 0x08,
|
|
|
|
/// The runtime function performs metadata operations (which implies Locking
|
|
/// and Allocating).
|
|
/// TODO: distinguish between metadata runtime functions which only lock and
|
|
/// which also can allocate.
|
|
MetaData = 0x10,
|
|
|
|
/// The runtime function performs dynamic casting (which implies Locking
|
|
/// and Allocating).
|
|
/// TODO: distinguish between casting runtime functions which only lock and
|
|
/// which also can allocate.
|
|
Casting = 0x20,
|
|
|
|
/// The runtime function performs exclusivity checking.
|
|
/// This does not have any observable runtime effect like locking or
|
|
/// allocation, but it's modelled separatly.
|
|
ExclusivityChecking = 0x100,
|
|
|
|
/// The runtime function calls ObjectiveC methods.
|
|
ObjectiveC = 0x40,
|
|
|
|
/// Not modelled currently.
|
|
Concurrency = 0x0,
|
|
|
|
/// Not modelled currently.
|
|
AutoDiff = 0x0,
|
|
|
|
Releasing = RefCounting | Deallocating,
|
|
};
|
|
|
|
inline RuntimeEffect operator|(RuntimeEffect lhs, RuntimeEffect rhs) {
|
|
return (RuntimeEffect)((unsigned)lhs | (unsigned)rhs);
|
|
}
|
|
|
|
inline RuntimeEffect &operator|=(RuntimeEffect &lhs, RuntimeEffect rhs) {
|
|
lhs = lhs | rhs;
|
|
return lhs;
|
|
}
|
|
|
|
inline bool operator&(RuntimeEffect lhs, RuntimeEffect rhs) {
|
|
return ((unsigned)lhs & (unsigned)rhs) != 0;
|
|
}
|
|
|
|
} // end swift namespace
|
|
|
|
// Enable the following macro to perform validation check on the runtime effects
|
|
// of instructions in IRGen.
|
|
// #define CHECK_RUNTIME_EFFECT_ANALYSIS
|
|
|
|
#endif
|