// 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_FUCHSIA_PROCESS_SNAPSHOT_FUCHSIA_H_
#define CRASHPAD_SNAPSHOT_FUCHSIA_PROCESS_SNAPSHOT_FUCHSIA_H_
#include <lib/zx/process.h>
#include <sys/time.h>
#include <zircon/syscalls/exception.h>
#include <zircon/types.h>
#include <memory>
#include <vector>
#include "snapshot/crashpad_info_client_options.h"
#include "snapshot/elf/elf_image_reader.h"
#include "snapshot/elf/module_snapshot_elf.h"
#include "snapshot/fuchsia/exception_snapshot_fuchsia.h"
#include "snapshot/fuchsia/memory_map_region_snapshot_fuchsia.h"
#include "snapshot/fuchsia/process_reader_fuchsia.h"
#include "snapshot/fuchsia/system_snapshot_fuchsia.h"
#include "snapshot/fuchsia/thread_snapshot_fuchsia.h"
#include "snapshot/process_snapshot.h"
#include "snapshot/unloaded_module_snapshot.h"
#include "util/misc/initialization_state_dcheck.h"
#include "util/process/process_id.h"
#include "util/process/process_memory_range.h"
namespace crashpad {
//! \brief A ProcessSnapshot of a running (or crashed) process running on a
//! Fuchsia system. This class is not yet implemented.
class ProcessSnapshotFuchsia : public ProcessSnapshot {
public:
ProcessSnapshotFuchsia();
ProcessSnapshotFuchsia(const ProcessSnapshotFuchsia&) = delete;
ProcessSnapshotFuchsia& operator=(const ProcessSnapshotFuchsia&) = delete;
~ProcessSnapshotFuchsia() override;
//! \brief Initializes the object.
//!
//! \param[in] process The process handle to create a snapshot from.
//!
//! \return `true` if the snapshot could be created, `false` otherwise with
//! an appropriate message logged.
bool Initialize(const zx::process& process);
//! \brief Initializes the object's exception.
//!
//! This populates the data to be returned by Exception(). The thread
//! identified by \a thread_id must be in an exception.
//!
//! This method must not be called until after a successful call to
//! Initialize().
//!
//! \param[in] thread_id Koid of the thread which sustained the exception.
//! \param[in] report The `zx_exception_report_t` for the thread which
//! sustained the exception.
//! \return `true` if the exception information could be initialized, `false`
//! otherwise with an appropriate message logged. When this method returns
//! `false`, the ProcessSnapshotFuchsia object’s validity remains
//! unchanged.
bool InitializeException(zx_koid_t thread_id,
const zx_exception_report_t& report);
//! \brief Returns options from CrashpadInfo structures found in modules in
//! the process.
//!
//! \param[out] options Options set in CrashpadInfo structures in modules in
//! the process.
void GetCrashpadOptions(CrashpadInfoClientOptions* options);
//! \brief Sets the value to be returned by ReportID().
//!
//! On Fuchsia, the crash report ID is under the control of the snapshot
//! producer, which may call this method to set the report ID. If this is not
//! done, ReportID() will return an identifier consisting entirely of zeroes.
void SetReportID(const UUID& report_id) { report_id_ = report_id; }
//! \brief Sets the value to be returned by ClientID().
//!
//! On Fuchsia, the client ID is under the control of the snapshot producer,
//! which may call this method to set the client ID. If this is not done,
//! ClientID() will return an identifier consisting entirely of zeroes.
void SetClientID(const UUID& client_id) { client_id_ = client_id; }
//! \brief Sets the value to be returned by AnnotationsSimpleMap().
//!
//! On Fuchsia, all process annotations are under the control of the snapshot
//! producer, which may call this method to establish these annotations.
//! Contrast this with module annotations, which are under the control of the
//! process being snapshotted.
void SetAnnotationsSimpleMap(
const std::map<std::string, std::string>& annotations_simple_map) {
annotations_simple_map_ = annotations_simple_map;
}
// ProcessSnapshot:
crashpad::ProcessID ProcessID() const override;
crashpad::ProcessID ParentProcessID() const override;
void SnapshotTime(timeval* snapshot_time) const override;
void ProcessStartTime(timeval* start_time) const override;
void ProcessCPUTimes(timeval* user_time, timeval* system_time) const override;
void ReportID(UUID* report_id) const override;
void ClientID(UUID* client_id) const override;
const std::map<std::string, std::string>& AnnotationsSimpleMap()
const override;
const SystemSnapshot* System() const override;
std::vector<const ThreadSnapshot*> Threads() const override;
std::vector<const ModuleSnapshot*> Modules() const override;
std::vector<UnloadedModuleSnapshot> UnloadedModules() const override;
const ExceptionSnapshot* Exception() const override;
std::vector<const MemoryMapRegionSnapshot*> MemoryMap() const override;
std::vector<HandleSnapshot> Handles() const override;
std::vector<const MemorySnapshot*> ExtraMemory() const override;
const ProcessMemory* Memory() const override;
private:
// Initializes threads_ on behalf of Initialize().
void InitializeThreads();
// Initializes modules_ on behalf of Initialize().
void InitializeModules();
internal::SystemSnapshotFuchsia system_;
std::vector<std::unique_ptr<internal::ThreadSnapshotFuchsia>> threads_;
std::vector<std::unique_ptr<internal::ModuleSnapshotElf>> modules_;
std::unique_ptr<internal::ExceptionSnapshotFuchsia> exception_;
ProcessReaderFuchsia process_reader_;
ProcessMemoryRange memory_range_;
std::map<std::string, std::string> annotations_simple_map_;
std::vector<std::unique_ptr<internal::MemoryMapRegionSnapshotFuchsia>>
memory_map_;
UUID report_id_;
UUID client_id_;
timeval snapshot_time_;
InitializationStateDcheck initialized_;
};
} // namespace crashpad
#endif // CRASHPAD_SNAPSHOT_FUCHSIA_PROCESS_SNAPSHOT_FUCHSIA_H_
Codebase Browser
chromium