mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
69d1cafd1c
For now, it's not used, but we do try to pass the right value down from our various call sites. Progress on <rdar://problem/46674512>.
113 lines
4.9 KiB
C++
113 lines
4.9 KiB
C++
//===--- SILFunctionBuilder.h ---------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2018 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_SILFUNCTIONBUILDER_H
|
|
#define SWIFT_SIL_SILFUNCTIONBUILDER_H
|
|
|
|
#include "swift/AST/Availability.h"
|
|
#include "swift/SIL/SILModule.h"
|
|
|
|
namespace swift {
|
|
|
|
class SILParserFunctionBuilder;
|
|
class SILSerializationFunctionBuilder;
|
|
class SILOptFunctionBuilder;
|
|
namespace Lowering {
|
|
class SILGenFunctionBuilder;
|
|
} // namespace Lowering
|
|
|
|
/// A class for creating SILFunctions in a specific SILModule.
|
|
///
|
|
/// The intention is that this class is not used directly, but rather that each
|
|
/// part of the compiler that needs to create functions create a composition
|
|
/// type with SILFunctionBuilder as a field. This enables subsystems that use
|
|
/// SIL to:
|
|
///
|
|
/// 1. Enforce invariants in the type system. An example of this is in the
|
|
/// SILOptimizer where we want to ensure that the pass manager properly
|
|
/// notifies analyses whenever functions are created/destroyed.
|
|
///
|
|
/// 2. Have a convenient place to place utility functionality for creating
|
|
/// functions. Today the compiler has many small utility functions for
|
|
/// creating the underlying SILFunction that are generally quite verbose and
|
|
/// have shared code. These SILFunctionBuilder composition types will enable
|
|
/// code-reuse in between these different SILFunction creation sites.
|
|
class SILFunctionBuilder {
|
|
SILModule &mod;
|
|
AvailabilityContext availCtx;
|
|
|
|
friend class SILParserFunctionBuilder;
|
|
friend class SILSerializationFunctionBuilder;
|
|
friend class SILOptFunctionBuilder;
|
|
friend class Lowering::SILGenFunctionBuilder;
|
|
|
|
SILFunctionBuilder(SILModule &mod)
|
|
: SILFunctionBuilder(mod,
|
|
AvailabilityContext::forDeploymentTarget(
|
|
mod.getASTContext())) {}
|
|
|
|
SILFunctionBuilder(SILModule &mod, AvailabilityContext availCtx)
|
|
: mod(mod), availCtx(availCtx) {}
|
|
|
|
/// Return the declaration of a utility function that can, but needn't, be
|
|
/// shared between different parts of a program.
|
|
SILFunction *getOrCreateSharedFunction(SILLocation loc, StringRef name,
|
|
CanSILFunctionType type,
|
|
IsBare_t isBareSILFunction,
|
|
IsTransparent_t isTransparent,
|
|
IsSerialized_t isSerialized,
|
|
ProfileCounter entryCount,
|
|
IsThunk_t isThunk,
|
|
IsDynamicallyReplaceable_t isDynamic);
|
|
|
|
/// Return the declaration of a function, or create it if it doesn't exist.
|
|
SILFunction *getOrCreateFunction(
|
|
SILLocation loc, StringRef name, SILLinkage linkage,
|
|
CanSILFunctionType type, IsBare_t isBareSILFunction,
|
|
IsTransparent_t isTransparent, IsSerialized_t isSerialized,
|
|
IsDynamicallyReplaceable_t isDynamic,
|
|
ProfileCounter entryCount = ProfileCounter(),
|
|
IsThunk_t isThunk = IsNotThunk,
|
|
SubclassScope subclassScope = SubclassScope::NotApplicable);
|
|
|
|
/// Return the declaration of a function, or create it if it doesn't exist.
|
|
SILFunction *
|
|
getOrCreateFunction(SILLocation loc, SILDeclRef constant,
|
|
ForDefinition_t forDefinition,
|
|
ProfileCounter entryCount = ProfileCounter());
|
|
|
|
/// Create a function declaration.
|
|
///
|
|
/// This signature is a direct copy of the signature of SILFunction::create()
|
|
/// in order to simplify refactoring all SILFunction creation use-sites to use
|
|
/// SILFunctionBuilder. Eventually the uses should probably be refactored.
|
|
SILFunction *
|
|
createFunction(SILLinkage linkage, StringRef name,
|
|
CanSILFunctionType loweredType, GenericEnvironment *genericEnv,
|
|
Optional<SILLocation> loc, IsBare_t isBareSILFunction,
|
|
IsTransparent_t isTrans, IsSerialized_t isSerialized,
|
|
IsDynamicallyReplaceable_t isDynamic,
|
|
ProfileCounter entryCount = ProfileCounter(),
|
|
IsThunk_t isThunk = IsNotThunk,
|
|
SubclassScope subclassScope = SubclassScope::NotApplicable,
|
|
Inline_t inlineStrategy = InlineDefault,
|
|
EffectsKind EK = EffectsKind::Unspecified,
|
|
SILFunction *InsertBefore = nullptr,
|
|
const SILDebugScope *DebugScope = nullptr);
|
|
|
|
void addFunctionAttributes(SILFunction *F, DeclAttributes &Attrs,
|
|
SILModule &M, SILDeclRef constant = SILDeclRef());
|
|
};
|
|
} // namespace swift
|
|
|
|
#endif
|