mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-10 06:36:02 +00:00
e428b3ad13
doc/support/crashpad.doxy is updated with:
```
% doxygen -u doc/support/crashpad.doxy
[…]
% doxygen -v
1.13.2
```
Additional updates to doc/support/crashpad.doxy are made:
- The settings for `DISABLE_INDEX` and `GENERATE_TREEVIEW` are updated,
as Doxygen’s defaults have changed. This switches from the
top-of-page index to the side-of-page tree view.
- The TODO and Deprecated sections have become more prominent under the
side-of-page tree view than they were with the top-of-page index, and
they’re not very useful in Crashpad documentation, so they’re
disabled by setting `GENERATE_TODOLIST` and `GENERATE_DEPRECATEDLIST`
appropriately. The similar (but unused in Crashpad)
`GENERATE_TESTLIST` and `GENERATE_BUGLIST` are also disabled.
- `USE_DOT` is now set, to use `dot` from GraphViz to generate SVG
diagrams. These look better than the PNGs that Doxygen generated
without `dot`. `DOT_COMMON_ATTR` and `DOT_EDGE_ATTR` are set to make
the fonts used in GraphViz-generated SVGs match those used in
Doxygen-generated HTML/CSS.
- `EXCLUDE` has been updated to drop directories that no longer exist
(compat/non_cxx11_lib) and add ones that now do (compat/android,
compat/ios, and compat/linux).
- Some values that were otherwise unused in doc/support/crashpad.doxy
are set back to their default values. The differences from the
default configuration are shown with `doxygen -x
doc/support/crashpad.doxy`, and a configuration template with default
values can be generated for inspection with `doxygen -g
/tmp/template.doxy`. The tags affected are:
- `MATHJAX_RELPATH`, unused since `USE_MATHJAX` is `NO`.
- `LATEX_CMD_NAME` and `LATEX_BIB_STYLE`, unused since `USE_LATEX`
is `NO`).
- `EXCLUDE_PATTERNS`, unused since `EXCLUDE_PATH` is empty.
doc/support/doxygen_crashpad.css is updated to change the non-monospaced
font from Open Sans to Noto Sans. It is also updated to use the CSS
properties Doxygen defines for the purpose, rather than monkeying around
with custom selectors. The properties can be discovered by running
`doxygen -w html header.html footer.html customdoxygen.css
doc/support/crashpad.doxy` and reviewing customdoxygen.css.
doc/support/generate.sh is updated to further execute
doc/support/generate_doxygen.py by invoking directly and relying on its
`#!/usr/bin/env python3` line rather than invoking via `python`, which
is no longer available on many systems. doc/support/generate_doxygen.py
has already been Python 3-compatible since f88a116c0e2e
(https://chromium-review.googlesource.com/c/3542572, 2022-03-23).
Finally, there are a number of changes to fix Doxygen warnings produced
by the new Doxygen version or because of new code that has not yet been
run through Doxygen during a test run.
Change-Id: I436688b16530cb0a07dbf89d32601fff689ac2f2
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/6180234
Reviewed-by: Justin Cohen <justincohen@chromium.org>
Reviewed-by: Joshua Peraza <jperaza@chromium.org>
Commit-Queue: Mark Mentovai <mark@chromium.org>
100 lines
3.3 KiB
C++
100 lines
3.3 KiB
C++
// Copyright 2017 The Crashpad Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef CRASHPAD_SNAPSHOT_LINUX_THREAD_SNAPSHOT_LINUX_H_
|
|
#define CRASHPAD_SNAPSHOT_LINUX_THREAD_SNAPSHOT_LINUX_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "build/build_config.h"
|
|
#include "snapshot/cpu_context.h"
|
|
#include "snapshot/linux/process_reader_linux.h"
|
|
#include "snapshot/memory_snapshot.h"
|
|
#include "snapshot/memory_snapshot_generic.h"
|
|
#include "snapshot/thread_snapshot.h"
|
|
#include "util/misc/initialization_state_dcheck.h"
|
|
|
|
namespace crashpad {
|
|
namespace internal {
|
|
|
|
//! \brief A ThreadSnapshot of a thread on a Linux system.
|
|
class ThreadSnapshotLinux final : public ThreadSnapshot {
|
|
public:
|
|
ThreadSnapshotLinux();
|
|
|
|
ThreadSnapshotLinux(const ThreadSnapshotLinux&) = delete;
|
|
ThreadSnapshotLinux& operator=(const ThreadSnapshotLinux&) = delete;
|
|
|
|
~ThreadSnapshotLinux() override;
|
|
|
|
//! \brief Initializes the object.
|
|
//!
|
|
//! \param[in] process_reader A ProcessReaderLinux for the process containing
|
|
//! the thread.
|
|
//! \param[in] thread The thread within the ProcessReaderLinux for
|
|
//! which the snapshot should be created.
|
|
//! \param[inout] gather_indirectly_referenced_memory_bytes_remaining The
|
|
//! remaining budget for indirectly referenced memory, honored on entry
|
|
//! and updated on return.
|
|
//!
|
|
//! \return `true` if the snapshot could be created, `false` otherwise with
|
|
//! a message logged.
|
|
bool Initialize(
|
|
ProcessReaderLinux* process_reader,
|
|
const ProcessReaderLinux::Thread& thread,
|
|
uint32_t* gather_indirectly_referenced_memory_bytes_remaining);
|
|
|
|
// ThreadSnapshot:
|
|
|
|
const CPUContext* Context() const override;
|
|
const MemorySnapshot* Stack() const override;
|
|
uint64_t ThreadID() const override;
|
|
std::string ThreadName() const override;
|
|
int SuspendCount() const override;
|
|
int Priority() const override;
|
|
uint64_t ThreadSpecificDataAddress() const override;
|
|
std::vector<const MemorySnapshot*> ExtraMemory() const override;
|
|
|
|
private:
|
|
union {
|
|
#if defined(ARCH_CPU_X86_FAMILY)
|
|
CPUContextX86 x86;
|
|
CPUContextX86_64 x86_64;
|
|
#elif defined(ARCH_CPU_ARM_FAMILY)
|
|
CPUContextARM arm;
|
|
CPUContextARM64 arm64;
|
|
#elif defined(ARCH_CPU_MIPS_FAMILY)
|
|
CPUContextMIPS mipsel;
|
|
CPUContextMIPS64 mips64;
|
|
#elif defined(ARCH_CPU_RISCV64)
|
|
CPUContextRISCV64 riscv64;
|
|
#else
|
|
#error Port.
|
|
#endif // ARCH_CPU_X86_FAMILY
|
|
} context_union_;
|
|
CPUContext context_;
|
|
MemorySnapshotGeneric stack_;
|
|
LinuxVMAddress thread_specific_data_address_;
|
|
std::string thread_name_;
|
|
pid_t thread_id_;
|
|
int priority_;
|
|
InitializationStateDcheck initialized_;
|
|
std::vector<std::unique_ptr<MemorySnapshotGeneric>> pointed_to_memory_;
|
|
};
|
|
|
|
} // namespace internal
|
|
} // namespace crashpad
|
|
|
|
#endif // CRASHPAD_SNAPSHOT_LINUX_THREAD_SNAPSHOT_LINUX_H_
|