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>
107 lines
3.6 KiB
C++
107 lines
3.6 KiB
C++
// Copyright 2020 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_IOS_INTERMEDIATE_DUMP_SYSTEM_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|
|
#define CRASHPAD_SNAPSHOT_IOS_INTERMEDIATE_DUMP_SYSTEM_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <string>
|
|
|
|
#include "snapshot/system_snapshot.h"
|
|
#include "util/ios/ios_intermediate_dump_map.h"
|
|
#include "util/ios/ios_system_data_collector.h"
|
|
#include "util/misc/initialization_state_dcheck.h"
|
|
|
|
namespace crashpad {
|
|
|
|
namespace internal {
|
|
|
|
//! \brief A SystemSnapshot of the running system, when the system runs iOS.
|
|
class SystemSnapshotIOSIntermediateDump final : public SystemSnapshot {
|
|
public:
|
|
SystemSnapshotIOSIntermediateDump();
|
|
|
|
SystemSnapshotIOSIntermediateDump(const SystemSnapshotIOSIntermediateDump&) =
|
|
delete;
|
|
SystemSnapshotIOSIntermediateDump& operator=(
|
|
const SystemSnapshotIOSIntermediateDump&) = delete;
|
|
|
|
~SystemSnapshotIOSIntermediateDump() override;
|
|
|
|
//! \brief Initializes the object.
|
|
//!
|
|
//! \param[in] system_data An intermediate dump map containing various system
|
|
//! data points.
|
|
void Initialize(const IOSIntermediateDumpMap* system_data);
|
|
|
|
// SystemSnapshot:
|
|
|
|
CPUArchitecture GetCPUArchitecture() const override;
|
|
uint32_t CPURevision() const override;
|
|
uint8_t CPUCount() const override;
|
|
std::string CPUVendor() const override;
|
|
void CPUFrequency(uint64_t* current_hz, uint64_t* max_hz) const override;
|
|
uint32_t CPUX86Signature() const override;
|
|
uint64_t CPUX86Features() const override;
|
|
uint64_t CPUX86ExtendedFeatures() const override;
|
|
uint32_t CPUX86Leaf7Features() const override;
|
|
bool CPUX86SupportsDAZ() const override;
|
|
OperatingSystem GetOperatingSystem() const override;
|
|
bool OSServer() const override;
|
|
void OSVersion(int* major,
|
|
int* minor,
|
|
int* bugfix,
|
|
std::string* build) const override;
|
|
std::string OSVersionFull() const override;
|
|
bool NXEnabled() const override;
|
|
std::string MachineDescription() const override;
|
|
void TimeZone(DaylightSavingTimeStatus* dst_status,
|
|
int* standard_offset_seconds,
|
|
int* daylight_offset_seconds,
|
|
std::string* standard_name,
|
|
std::string* daylight_name) const override;
|
|
uint64_t AddressMask() const override;
|
|
|
|
//! \brief Returns the number of nanoseconds between Crashpad initialization
|
|
//! and snapshot generation.
|
|
uint64_t CrashpadUptime() const;
|
|
|
|
private:
|
|
std::string os_version_build_;
|
|
std::string machine_description_;
|
|
int os_version_major_;
|
|
int os_version_minor_;
|
|
int os_version_bugfix_;
|
|
uint32_t active_;
|
|
uint32_t inactive_;
|
|
uint32_t wired_;
|
|
uint32_t free_;
|
|
int cpu_count_;
|
|
std::string cpu_vendor_;
|
|
DaylightSavingTimeStatus dst_status_;
|
|
int standard_offset_seconds_;
|
|
int daylight_offset_seconds_;
|
|
std::string standard_name_;
|
|
std::string daylight_name_;
|
|
uint64_t address_mask_;
|
|
uint64_t crashpad_uptime_ns_;
|
|
InitializationStateDcheck initialized_;
|
|
};
|
|
|
|
} // namespace internal
|
|
} // namespace crashpad
|
|
|
|
#endif // CRASHPAD_SNAPSHOT_IOS_INTERMEDIATE_DUMP_SYSTEM_SNAPSHOT_IOS_INTERMEDIATEDUMP_H_
|