mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
f3ff561c6f
This is phase-1 of switching from llvm::Optional to std::optional in the
next rebranch. llvm::Optional was removed from upstream LLVM, so we need
to migrate off rather soon. On Darwin, std::optional, and llvm::Optional
have the same layout, so we don't need to be as concerned about ABI
beyond the name mangling. `llvm::Optional` is only returned from one
function in
```
getStandardTypeSubst(StringRef TypeName,
bool allowConcurrencyManglings);
```
It's the return value, so it should not impact the mangling of the
function, and the layout is the same as `std::optional`, so it should be
mostly okay. This function doesn't appear to have users, and the ABI was
already broken 2 years ago for concurrency and no one seemed to notice
so this should be "okay".
I'm doing the migration incrementally so that folks working on main can
cherry-pick back to the release/5.9 branch. Once 5.9 is done and locked
away, then we can go through and finish the replacement. Since `None`
and `Optional` show up in contexts where they are not `llvm::None` and
`llvm::Optional`, I'm preparing the work now by going through and
removing the namespace unwrapping and making the `llvm` namespace
explicit. This should make it fairly mechanical to go through and
replace llvm::Optional with std::optional, and llvm::None with
std::nullopt. It's also a change that can be brought onto the
release/5.9 with minimal impact. This should be an NFC change.
114 lines
4.0 KiB
C++
114 lines
4.0 KiB
C++
//===--- ConstantFolding.h - Utilities for SIL constant folding -*- 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 utility functions for constant folding.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SIL_CONSTANTFOLDING_H
|
|
#define SWIFT_SIL_CONSTANTFOLDING_H
|
|
|
|
#include "swift/SIL/SILInstruction.h"
|
|
#include "swift/SILOptimizer/Analysis/Analysis.h"
|
|
#include "llvm/ADT/SetVector.h"
|
|
#include <functional>
|
|
|
|
namespace swift {
|
|
|
|
class SILOptFunctionBuilder;
|
|
|
|
/// Evaluates the constant result of a binary bit-operation.
|
|
///
|
|
/// The \p ID must be the ID of a binary bit-operation builtin.
|
|
APInt constantFoldBitOperation(APInt lhs, APInt rhs, BuiltinValueKind ID);
|
|
|
|
/// Evaluates the constant result of an integer comparison.
|
|
///
|
|
/// The \p ID must be the ID of an integer builtin operation.
|
|
APInt constantFoldComparison(APInt lhs, APInt rhs, BuiltinValueKind ID);
|
|
|
|
/// Evaluates the constant result of a binary operation with overflow.
|
|
///
|
|
/// The \p ID must be the ID of a binary operation with overflow.
|
|
APInt constantFoldBinaryWithOverflow(APInt lhs, APInt rhs, bool &Overflow,
|
|
llvm::Intrinsic::ID ID);
|
|
|
|
/// Evaluates the constant result of a division operation.
|
|
///
|
|
/// The \p ID must be the ID of a division operation.
|
|
APInt constantFoldDiv(APInt lhs, APInt rhs, bool &Overflow, BuiltinValueKind ID);
|
|
|
|
/// Evaluates the constant result of an integer cast operation.
|
|
///
|
|
/// The \p ID must be the ID of a trunc/sext/zext builtin.
|
|
APInt constantFoldCast(APInt val, const BuiltinInfo &BI);
|
|
|
|
/// If `ResultsInError` is not none than errors are diagnosed and
|
|
/// `ResultsInError` is set to true in case of an error.
|
|
SILValue constantFoldBuiltin(BuiltinInst *BI,
|
|
llvm::Optional<bool> &ResultsInError);
|
|
|
|
/// A utility class to do constant folding.
|
|
class ConstantFolder {
|
|
private:
|
|
SILOptFunctionBuilder &FuncBuilder;
|
|
|
|
/// The worklist of the constants that could be folded into their users.
|
|
llvm::SetVector<SILInstruction *> WorkList;
|
|
|
|
/// The assert configuration of SILOptions.
|
|
unsigned AssertConfiguration;
|
|
|
|
/// Print diagnostics as part of mandatory constant propagation.
|
|
bool EnableDiagnostics;
|
|
|
|
/// Called for each constant folded instruction.
|
|
std::function<void (SILInstruction *)> Callback;
|
|
|
|
public:
|
|
/// The constructor.
|
|
///
|
|
/// \param AssertConfiguration The assert configuration of SILOptions.
|
|
/// \param EnableDiagnostics Print diagnostics as part of mandatory constant
|
|
/// propagation.
|
|
/// \param Callback Called for each constant folded instruction.
|
|
ConstantFolder(SILOptFunctionBuilder &FuncBuilder,
|
|
unsigned AssertConfiguration,
|
|
bool EnableDiagnostics = false,
|
|
std::function<void (SILInstruction *)> Callback =
|
|
[](SILInstruction *){}) :
|
|
FuncBuilder(FuncBuilder),
|
|
AssertConfiguration(AssertConfiguration),
|
|
EnableDiagnostics(EnableDiagnostics),
|
|
Callback(Callback) { }
|
|
|
|
/// Initialize the worklist with all instructions of the function \p F.
|
|
void initializeWorklist(SILFunction &F);
|
|
|
|
/// When asserts are enabled, dumps the worklist for diagnostic
|
|
/// purposes. Without asserts this is a no-op.
|
|
void dumpWorklist() const;
|
|
|
|
/// Initialize the worklist with a single instruction \p I.
|
|
void addToWorklist(SILInstruction *I) {
|
|
WorkList.insert(I);
|
|
}
|
|
|
|
/// Constant fold everything in the worklist and transitively all uses of
|
|
/// folded instructions.
|
|
SILAnalysis::InvalidationKind processWorkList();
|
|
};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|