Files
swift-mirror/include/swift/Runtime/CrashInfo.h
Alastair Houghton 14fcdbd389 [Backtracing][Linux] Tidy a few things up after review.
Mike and Max made various helpful suggestions, so I've added and updated
various comments and amended the code to cope with partial reads and
writes.

rdar://110261430
2023-06-06 16:06:21 +01:00

99 lines
2.4 KiB
C++

//===--- CrashInfo.h - Swift Backtracing Crash Information ------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 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
//
//===----------------------------------------------------------------------===//
//
// Defines the CrashInfo type that holds information about why the program
// crashed.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_CRASHINFO_H
#define SWIFT_CRASHINFO_H
#include <inttypes.h>
#ifdef __cplusplus
namespace swift {
namespace runtime {
namespace backtrace {
extern "C" {
#endif
// Note: The "pointers" below are pointers in a different process's address
// space, which might not even share our bitness. That is why they are
// `uint64_t`s, rather than pointers or `uintptr_t`s.
// The address of this structure in memory is passed to swift-backtrace.
struct CrashInfo {
// The thread ID for the crashing thread.
uint64_t crashing_thread;
// The signal number corresponding to this crash.
uint64_t signal;
// The fault address.
uint64_t fault_address;
#ifdef __APPLE__
// Points to the mcontext_t structure for the crashing thread; other
// threads' contexts can be recovered using Mach APIs later.
uint64_t mctx;
#elif defined(__linux__)
// The head of the thread list; points at a "struct thread" (see below).
uint64_t thread_list;
#endif
};
#ifdef __linux__
// A memory server request packet.
struct memserver_req {
// Address to read.
uint64_t addr;
// Number of bytes to read.
uint64_t len;
};
// A memory server response packet.
struct memserver_resp {
// Address that was read from.
uint64_t addr;
// Number of bytes, *or* negative to indicate an error.
int64_t len;
// Followed by len bytes of data if len > 0
};
// Holds details of a running thread.
struct thread {
// Points at the next thread.
uint64_t next;
// The thread ID for this thread.
int64_t tid;
// Points to the Linux ucontext_t structure.
uint64_t uctx;
};
#endif
#ifdef __cplusplus
} // extern "C"
} // namespace backtrace
} // namespace runtime
} // namespace swift
#endif
#endif // SWIFT_CRASHINFO_H