mirror of
https://github.com/apple/swift.git
synced 2026-06-20 15:42:51 +02:00
Doug Gregor
8713c13bef
For a given function, we might end up emitting it's definition as object code, serialized SIL, or both. The @export, @inlinable, and @inline(always) attributes provide control of this behavior at the declaration level. Centralize the query function that will look for each of these attributes and map down to a specific "code generation model", whose 3 options follow the naming from SE-0497: interface, inlinable, and implementation. Use this one computation to back the queries for "always emit into client", "never emit into client", and "inlinable" so we can't get inconsistent results from places that are doing one-off checks for these attributes.
55 lines
2.2 KiB
C++
55 lines
2.2 KiB
C++
//===--- CodeGenerationModel.h - Code generation model ----------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file provides a description of the code generation model.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SWIFT_BASIC_CODEGENERATIONMODEL_H
|
|
#define SWIFT_BASIC_CODEGENERATIONMODEL_H
|
|
|
|
#include <cstdint>
|
|
|
|
namespace swift {
|
|
|
|
/// Describes where the code associated with a declaration is generated,
|
|
/// whether into the resulting object file (hiding the implementation),
|
|
/// Swift module for clients (exposing the implementation), or both.
|
|
///
|
|
/// The code generation model can be affected by a number of factors. For a
|
|
/// specific declaration, `@export` attribute introduced in SE-0497
|
|
/// explicitly chooses between "interface" and "implementation", while the
|
|
/// inlinability attributes choose "inlinable".
|
|
///
|
|
/// Globally, Embedded Swift defaults to "inlinable" but can be set to
|
|
/// "implementation" with the experimental feature DeferredCodeGen.
|
|
/// Non-embedded Swift uses "interface" and doesn't currently allow
|
|
/// customization.
|
|
enum class CodeGenerationModel: uint8_t {
|
|
/// Only the interface of the declaration is made available, and clients can
|
|
/// call through that interface. This is the equivalent to
|
|
/// `@export(interface)` on a specific declaration.
|
|
Interface,
|
|
/// Both the interface and the implementation are made available to clients,
|
|
/// who can choose whether to inline the implementation or call the
|
|
/// implementation. This is equivalent to @inlinable.
|
|
Inlinable,
|
|
/// The implementation of the declaration is made available for the client to
|
|
/// inline when it is used. There is no implementation in the corresponding
|
|
/// module. This is the equivalent of `@export(implementation)` on a
|
|
/// specific declaration.
|
|
Implementation,
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|