mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
114 lines
4.0 KiB
C++
114 lines
4.0 KiB
C++
//===--- DebugOptUtils.h --------------------------------------------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
///
|
|
/// Debug Info related utilities that rely on code in SILOptimizer/ and thus can
|
|
/// not be in include/swift/SIL/DebugUtils.h.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SILOPTIMIZER_DEBUGOPTUTILS_H
|
|
#define SWIFT_SILOPTIMIZER_DEBUGOPTUTILS_H
|
|
|
|
#include "swift/SIL/DebugUtils.h"
|
|
#include "swift/SIL/Projection.h"
|
|
#include "swift/SIL/SILValue.h"
|
|
#include "swift/SILOptimizer/Utils/InstOptUtils.h"
|
|
|
|
namespace swift {
|
|
|
|
/// Deletes all of the debug instructions that use \p value.
|
|
inline void deleteAllDebugUses(SILValue value, InstModCallbacks &callbacks) {
|
|
for (auto ui = value->use_begin(), ue = value->use_end(); ui != ue;) {
|
|
auto *inst = ui->getUser();
|
|
++ui;
|
|
if (inst->isDebugInstruction()) {
|
|
callbacks.deleteInst(inst);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Deletes all of the debug uses of any result of \p inst.
|
|
inline void deleteAllDebugUses(SILInstruction *inst,
|
|
InstModCallbacks &callbacks) {
|
|
for (SILValue v : inst->getResults()) {
|
|
deleteAllDebugUses(v, callbacks);
|
|
}
|
|
}
|
|
|
|
/// Transfer debug info associated with (the result of) \p I to a
|
|
/// new `debug_value` instruction before \p I is deleted.
|
|
void salvageDebugInfo(SILInstruction *I);
|
|
|
|
/// Transfer debug info associated with the store-like instruction \p SI to a
|
|
/// new `debug_value` instruction before \p SI is deleted.
|
|
/// \param SI The store instruction being deleted
|
|
/// \param SrcVal The old source, where the debuginfo should be propagated to
|
|
/// \param DestVal The old destination, where the debuginfo was
|
|
void salvageStoreDebugInfo(SILInstruction *SI,
|
|
SILValue SrcVal, SILValue DestVal);
|
|
|
|
/// Transfer debug information associated with the result of \p load to the
|
|
/// load's address operand.
|
|
///
|
|
/// TODO: combine this with salvageDebugInfo when it is supported by
|
|
/// optimizations.
|
|
void salvageLoadDebugInfo(LoadOperation load);
|
|
|
|
/// Create debug_value fragment for a new partial value.
|
|
///
|
|
/// Precondition: \p oldValue is a struct or class aggregate. \p proj projects a
|
|
/// field from the aggregate into \p newValue corresponding to struct_extract.
|
|
void createDebugFragments(SILValue oldValue, Projection proj,
|
|
SILValue newValue);
|
|
|
|
/// Erases the instruction \p I from it's parent block and deletes it, including
|
|
/// all debug instructions which use \p I.
|
|
/// Precondition: The instruction may only have debug instructions as uses.
|
|
/// If the iterator \p InstIter references any deleted instruction, it is
|
|
/// incremented.
|
|
///
|
|
/// \p callbacks InstModCallback to use.
|
|
///
|
|
/// Returns an iterator to the next non-deleted instruction after \p I.
|
|
inline SILBasicBlock::iterator
|
|
eraseFromParentWithDebugInsts(SILInstruction *inst,
|
|
InstModCallbacks callbacks = InstModCallbacks()) {
|
|
auto nextII = std::next(inst->getIterator());
|
|
|
|
auto results = inst->getResults();
|
|
bool foundAny;
|
|
do {
|
|
foundAny = false;
|
|
for (auto result : results) {
|
|
while (!result->use_empty()) {
|
|
foundAny = true;
|
|
auto *user = result->use_begin()->getUser();
|
|
assert(user->isDebugInstruction());
|
|
if (nextII == user->getIterator())
|
|
++nextII;
|
|
callbacks.deleteInst(user);
|
|
}
|
|
}
|
|
} while (foundAny);
|
|
|
|
// Just matching what eraseFromParentWithDebugInsts is today.
|
|
if (nextII == inst->getIterator())
|
|
++nextII;
|
|
swift::salvageDebugInfo(inst);
|
|
callbacks.deleteInst(inst, false /*do not notify*/);
|
|
return nextII;
|
|
}
|
|
|
|
} // namespace swift
|
|
|
|
#endif
|