blob: 1b35d3ebf3c7f913a4759b5d4477a4432a52c13e [file] [log] [blame]
//===--- PrettyStackTrace.h - Crash trace information -----------*- C++ -*-===//
// This source file is part of the 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 for license information
// See for the list of Swift project authors
// This file defines SIL-specific RAII classes that give better diagnostic
// output about when, exactly, a crash is occurring.
#include "swift/SIL/SILLocation.h"
#include "llvm/Support/PrettyStackTrace.h"
namespace swift {
class ASTContext;
class SILFunction;
class SILNode;
void printSILLocationDescription(llvm::raw_ostream &out, SILLocation loc,
ASTContext &ctx);
/// PrettyStackTraceLocation - Observe that we are doing some
/// processing starting at a SIL location.
class PrettyStackTraceSILLocation : public llvm::PrettyStackTraceEntry {
SILLocation Loc;
const char *Action;
ASTContext &Context;
PrettyStackTraceSILLocation(const char *action, SILLocation loc,
ASTContext &C)
: Loc(loc), Action(action), Context(C) {}
virtual void print(llvm::raw_ostream &OS) const override;
/// Observe that we are doing some processing of a SIL function.
class PrettyStackTraceSILFunction : public llvm::PrettyStackTraceEntry {
const SILFunction *func;
/// An inline buffer of characters used if we are passed a twine.
SmallString<256> data;
/// This points either at a user provided const char * string or points at the
/// inline message buffer that is initialized with data from a twine on
/// construction.
StringRef action;
PrettyStackTraceSILFunction(const char *action, const SILFunction *func)
: func(func), data(), action(action) {}
PrettyStackTraceSILFunction(llvm::Twine &&twine, const SILFunction *func)
: func(func), data(), action(twine.toNullTerminatedStringRef(data)) {}
virtual void print(llvm::raw_ostream &os) const override;
void printFunctionInfo(llvm::raw_ostream &out) const;
/// Observe that we are visiting SIL nodes.
class PrettyStackTraceSILNode : public llvm::PrettyStackTraceEntry {
const SILNode *Node;
const char *Action;
PrettyStackTraceSILNode(const char *action, const SILNode *node)
: Node(node), Action(action) {}
virtual void print(llvm::raw_ostream &OS) const override;
} // end namespace swift