38dfb235db
LLDB uses utility functions to run code in the inferior for its own internal purposes, such as reading classes from the Objective-C runtime for example. Because these expressions should be transparent to the user, we ignore breakpoints and unwind the stack on errors, which makes them hard to debug. This patch adds a new setting target.debug-utility-expression that, when enabled, changes these options to facilitate debugging. It enables breakpoints, disables unwinding and writes out the utility function source code to disk so it shows up in the source view. Differential revision: https://reviews.llvm.org/D97249
113 lines
3.7 KiB
C++
113 lines
3.7 KiB
C++
//===-- ClangUtilityFunction.h ----------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_SOURCE_PLUGINS_EXPRESSIONPARSER_CLANG_CLANGUTILITYFUNCTION_H
|
|
#define LLDB_SOURCE_PLUGINS_EXPRESSIONPARSER_CLANG_CLANGUTILITYFUNCTION_H
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "ClangExpressionHelper.h"
|
|
|
|
#include "lldb/Expression/UtilityFunction.h"
|
|
#include "lldb/lldb-forward.h"
|
|
#include "lldb/lldb-private.h"
|
|
|
|
namespace lldb_private {
|
|
|
|
/// \class ClangUtilityFunction ClangUtilityFunction.h
|
|
/// "lldb/Expression/ClangUtilityFunction.h" Encapsulates a single expression
|
|
/// for use with Clang
|
|
///
|
|
/// LLDB uses expressions for various purposes, notably to call functions
|
|
/// and as a backend for the expr command. ClangUtilityFunction encapsulates
|
|
/// a self-contained function meant to be used from other code. Utility
|
|
/// functions can perform error-checking for ClangUserExpressions, or can
|
|
/// simply provide a way to push a function into the target for the debugger
|
|
/// to call later on.
|
|
class ClangUtilityFunction : public UtilityFunction {
|
|
// LLVM RTTI support
|
|
static char ID;
|
|
|
|
public:
|
|
bool isA(const void *ClassID) const override {
|
|
return ClassID == &ID || UtilityFunction::isA(ClassID);
|
|
}
|
|
static bool classof(const Expression *obj) { return obj->isA(&ID); }
|
|
|
|
/// Constructor
|
|
///
|
|
/// \param[in] text
|
|
/// The text of the function. Must be a full translation unit.
|
|
///
|
|
/// \param[in] name
|
|
/// The name of the function, as used in the text.
|
|
///
|
|
/// \param[in] enable_debugging
|
|
/// Enable debugging of this function.
|
|
ClangUtilityFunction(ExecutionContextScope &exe_scope, std::string text,
|
|
std::string name, bool enable_debugging);
|
|
|
|
~ClangUtilityFunction() override;
|
|
|
|
ExpressionTypeSystemHelper *GetTypeSystemHelper() override {
|
|
return &m_type_system_helper;
|
|
}
|
|
|
|
ClangExpressionDeclMap *DeclMap() { return m_type_system_helper.DeclMap(); }
|
|
|
|
void ResetDeclMap() { m_type_system_helper.ResetDeclMap(); }
|
|
|
|
void ResetDeclMap(ExecutionContext &exe_ctx, bool keep_result_in_memory) {
|
|
m_type_system_helper.ResetDeclMap(exe_ctx, keep_result_in_memory);
|
|
}
|
|
|
|
bool Install(DiagnosticManager &diagnostic_manager,
|
|
ExecutionContext &exe_ctx) override;
|
|
|
|
private:
|
|
class ClangUtilityFunctionHelper : public ClangExpressionHelper {
|
|
public:
|
|
ClangUtilityFunctionHelper() {}
|
|
|
|
~ClangUtilityFunctionHelper() override {}
|
|
|
|
/// Return the object that the parser should use when resolving external
|
|
/// values. May be NULL if everything should be self-contained.
|
|
ClangExpressionDeclMap *DeclMap() override {
|
|
return m_expr_decl_map_up.get();
|
|
}
|
|
|
|
void ResetDeclMap() { m_expr_decl_map_up.reset(); }
|
|
|
|
void ResetDeclMap(ExecutionContext &exe_ctx, bool keep_result_in_memory);
|
|
|
|
/// Return the object that the parser should allow to access ASTs. May be
|
|
/// nullptr if the ASTs do not need to be transformed.
|
|
///
|
|
/// \param[in] passthrough
|
|
/// The ASTConsumer that the returned transformer should send
|
|
/// the ASTs to after transformation.
|
|
clang::ASTConsumer *
|
|
ASTTransformer(clang::ASTConsumer *passthrough) override {
|
|
return nullptr;
|
|
}
|
|
|
|
private:
|
|
std::unique_ptr<ClangExpressionDeclMap> m_expr_decl_map_up;
|
|
};
|
|
|
|
/// The map to use when parsing and materializing the expression.
|
|
ClangUtilityFunctionHelper m_type_system_helper;
|
|
};
|
|
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_SOURCE_PLUGINS_EXPRESSIONPARSER_CLANG_CLANGUTILITYFUNCTION_H
|