mirror of
https://github.com/chromium/crashpad.git
synced 2024-12-28 15:50:26 +08:00
c83e773c33
TEST=util_test CompositeMachMessageServer* R=rsesek@chromium.org Review URL: https://codereview.chromium.org/781823002
626 lines
27 KiB
C++
626 lines
27 KiB
C++
// Copyright 2014 The Crashpad Authors. All rights reserved.
|
||
//
|
||
// 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_UTIL_MACH_EXC_SERVER_VARIANTS_H_
|
||
#define CRASHPAD_UTIL_MACH_EXC_SERVER_VARIANTS_H_
|
||
|
||
#include <mach/mach.h>
|
||
|
||
#include <set>
|
||
|
||
#include "build/build_config.h"
|
||
#include "util/mach/mach_message_server.h"
|
||
|
||
namespace crashpad {
|
||
|
||
// Routines to provide a single unified front-end to the interfaces in
|
||
// <mach/exc.defs> and <mach/mach_exc.defs>. The two interfaces are identical,
|
||
// except that the latter allows for 64-bit exception codes, and is requested by
|
||
// setting the MACH_EXCEPTION_CODES behavior bit associated with an exception
|
||
// port.
|
||
|
||
namespace internal {
|
||
|
||
//! \brief A server interface for the `exc` Mach subsystem.
|
||
class ExcServer : public MachMessageServer::Interface {
|
||
public:
|
||
//! \brief An interface that the different request messages that are a part of
|
||
//! the `exc` Mach subsystem can be dispatched to.
|
||
class Interface {
|
||
public:
|
||
//! \brief Handles exceptions raised by `exception_raise()`.
|
||
//!
|
||
//! This behaves equivalently to a `catch_exception_raise()` function used
|
||
//! with `exc_server()`.
|
||
//!
|
||
//! \param[in] trailer The trailer received with the request message.
|
||
//! \param[out] destroy_request `true` if the request message is to be
|
||
//! destroyed even when this method returns success. See
|
||
//! MachMessageServer::Interface.
|
||
virtual kern_return_t CatchExceptionRaise(
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) = 0;
|
||
|
||
//! \brief Handles exceptions raised by `exception_raise_state()`.
|
||
//!
|
||
//! This behaves equivalently to a `catch_exception_raise_state()` function
|
||
//! used with `exc_server()`.
|
||
//!
|
||
//! There is no \a destroy_request parameter because, unlike
|
||
//! CatchExceptionRaise() and CatchExceptionRaiseStateIdentity(), the
|
||
//! request message is not complex (it does not carry the \a thread or \a
|
||
//! task port rights) and thus there is nothing to destroy.
|
||
//!
|
||
//! \param[in] trailer The trailer received with the request message.
|
||
virtual kern_return_t CatchExceptionRaiseState(
|
||
exception_handler_t exception_port,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer) = 0;
|
||
|
||
//! \brief Handles exceptions raised by `exception_raise_state_identity()`.
|
||
//!
|
||
//! This behaves equivalently to a `catch_exception_raise_state_identity()`
|
||
//! function used with `exc_server()`.
|
||
//!
|
||
//! \param[in] trailer The trailer received with the request message.
|
||
//! \param[out] destroy_request `true` if the request message is to be
|
||
//! destroyed even when this method returns success. See
|
||
//! MachMessageServer::Interface.
|
||
virtual kern_return_t CatchExceptionRaiseStateIdentity(
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) = 0;
|
||
|
||
protected:
|
||
~Interface() {}
|
||
};
|
||
|
||
//! \brief Constructs an object of this class.
|
||
//!
|
||
//! \param[in] interface The interface to dispatch requests to. Weak.
|
||
explicit ExcServer(Interface* interface);
|
||
|
||
// MachMessageServer::Interface:
|
||
|
||
bool MachMessageServerFunction(const mach_msg_header_t* in_header,
|
||
mach_msg_header_t* out_header,
|
||
bool* destroy_complex_request) override;
|
||
|
||
std::set<mach_msg_id_t> MachMessageServerRequestIDs() override;
|
||
|
||
mach_msg_size_t MachMessageServerRequestSize() override;
|
||
mach_msg_size_t MachMessageServerReplySize() override;
|
||
|
||
private:
|
||
Interface* interface_; // weak
|
||
|
||
DISALLOW_COPY_AND_ASSIGN(ExcServer);
|
||
};
|
||
|
||
//! \brief A server interface for the `mach_exc` Mach subsystem.
|
||
class MachExcServer : public MachMessageServer::Interface {
|
||
public:
|
||
//! \brief An interface that the different request messages that are a part of
|
||
//! the `mach_exc` Mach subsystem can be dispatched to.
|
||
class Interface {
|
||
public:
|
||
//! \brief Handles exceptions raised by `mach_exception_raise()`.
|
||
//!
|
||
//! This behaves equivalently to a `catch_mach_exception_raise()` function
|
||
//! used with `mach_exc_server()`.
|
||
//!
|
||
//! \param[in] trailer The trailer received with the request message.
|
||
//! \param[out] destroy_request `true` if the request message is to be
|
||
//! destroyed even when this method returns success. See
|
||
//! MachMessageServer::Interface.
|
||
virtual kern_return_t CatchMachExceptionRaise(
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) = 0;
|
||
|
||
//! \brief Handles exceptions raised by `mach_exception_raise_state()`.
|
||
//!
|
||
//! This behaves equivalently to a `catch_mach_exception_raise_state()`
|
||
//! function used with `mach_exc_server()`.
|
||
//!
|
||
//! There is no \a destroy_request parameter because, unlike
|
||
//! CatchMachExceptionRaise() and CatchMachExceptionRaiseStateIdentity(),
|
||
//! the request message is not complex (it does not carry the \a thread or
|
||
//! \a task port rights) and thus there is nothing to destroy.
|
||
//!
|
||
//! \param[in] trailer The trailer received with the request message.
|
||
virtual kern_return_t CatchMachExceptionRaiseState(
|
||
exception_handler_t exception_port,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer) = 0;
|
||
|
||
//! \brief Handles exceptions raised by
|
||
//! `mach_exception_raise_state_identity()`.
|
||
//!
|
||
//! This behaves equivalently to a
|
||
//! `catch_mach_exception_raise_state_identity()` function used with
|
||
//! `mach_exc_server()`.
|
||
//!
|
||
//! \param[in] trailer The trailer received with the request message.
|
||
//! \param[out] destroy_request `true` if the request message is to be
|
||
//! destroyed even when this method returns success. See
|
||
//! MachMessageServer::Interface.
|
||
virtual kern_return_t CatchMachExceptionRaiseStateIdentity(
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) = 0;
|
||
|
||
protected:
|
||
~Interface() {}
|
||
};
|
||
|
||
//! \brief Constructs an object of this class.
|
||
//!
|
||
//! \param[in] interface The interface to dispatch requests to. Weak.
|
||
explicit MachExcServer(Interface* interface);
|
||
|
||
// MachMessageServer::Interface:
|
||
|
||
bool MachMessageServerFunction(const mach_msg_header_t* in_header,
|
||
mach_msg_header_t* out_header,
|
||
bool* destroy_complex_request) override;
|
||
|
||
std::set<mach_msg_id_t> MachMessageServerRequestIDs() override;
|
||
|
||
mach_msg_size_t MachMessageServerRequestSize() override;
|
||
mach_msg_size_t MachMessageServerReplySize() override;
|
||
|
||
private:
|
||
Interface* interface_; // weak
|
||
|
||
DISALLOW_COPY_AND_ASSIGN(MachExcServer);
|
||
};
|
||
|
||
//! \brief A server interface for the `exc` Mach subsystem, simplified to have
|
||
//! only a single interface method needing implementation.
|
||
class SimplifiedExcServer : public ExcServer, public ExcServer::Interface {
|
||
public:
|
||
//! \brief An interface that the different request messages that are a part of
|
||
//! the `exc` Mach subsystem can be dispatched to.
|
||
class Interface {
|
||
public:
|
||
//! \brief Handles exceptions raised by `exception_raise()`,
|
||
//! `exception_raise_state()`, and `exception_raise_state_identity()`.
|
||
//!
|
||
//! For convenience in implementation, these different “behaviors” of
|
||
//! exception messages are all mapped to a single interface method. The
|
||
//! exception’s original “behavior” is specified in the \a behavior
|
||
//! parameter. Only parameters that were supplied in the request message
|
||
//! are populated, other parameters are set to reasonable default values.
|
||
//!
|
||
//! The meanings of most parameters are identical to that of
|
||
//! ExcServer::Interface::CatchExceptionRaiseStateIdentity().
|
||
//!
|
||
//! \param[in] behavior `EXCEPTION_DEFAULT`, `EXCEPTION_STATE`, or
|
||
//! `EXCEPTION_STATE_IDENTITY`, identifying which exception request
|
||
//! message was processed and thus which other parameters are valid.
|
||
virtual kern_return_t CatchException(
|
||
exception_behavior_t behavior,
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_complex_request) = 0;
|
||
|
||
protected:
|
||
~Interface() {}
|
||
};
|
||
|
||
//! \brief Constructs an object of this class.
|
||
//!
|
||
//! \param[in] interface The interface to dispatch requests to. Weak.
|
||
explicit SimplifiedExcServer(Interface* interface);
|
||
|
||
// ExcServer::Interface:
|
||
|
||
kern_return_t CatchExceptionRaise(exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) override;
|
||
kern_return_t CatchExceptionRaiseState(
|
||
exception_handler_t exception_port,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer) override;
|
||
kern_return_t CatchExceptionRaiseStateIdentity(
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) override;
|
||
|
||
private:
|
||
Interface* interface_; // weak
|
||
|
||
DISALLOW_COPY_AND_ASSIGN(SimplifiedExcServer);
|
||
};
|
||
|
||
//! \brief A server interface for the `mach_exc` Mach subsystem, simplified to
|
||
//! have only a single interface method needing implementation.
|
||
class SimplifiedMachExcServer : public MachExcServer,
|
||
public MachExcServer::Interface {
|
||
public:
|
||
//! \brief An interface that the different request messages that are a part of
|
||
//! the `mach_exc` Mach subsystem can be dispatched to.
|
||
class Interface {
|
||
public:
|
||
//! \brief Handles exceptions raised by `mach_exception_raise()`,
|
||
//! `mach_exception_raise_state()`, and
|
||
//! `mach_exception_raise_state_identity()`.
|
||
//!
|
||
//! For convenience in implementation, these different “behaviors” of
|
||
//! exception messages are all mapped to a single interface method. The
|
||
//! exception’s original “behavior” is specified in the \a behavior
|
||
//! parameter. Only parameters that were supplied in the request message
|
||
//! are populated, other parameters are set to reasonable default values.
|
||
//!
|
||
//! The meanings of most parameters are identical to that of
|
||
//! MachExcServer::Interface::CatchMachExceptionRaiseStateIdentity().
|
||
//!
|
||
//! \param[in] behavior `MACH_EXCEPTION_CODES | EXCEPTION_DEFAULT`,
|
||
//! `MACH_EXCEPTION_CODES | EXCEPTION_STATE`, or
|
||
//! `MACH_EXCEPTION_CODES | EXCEPTION_STATE_IDENTITY`, identifying which
|
||
//! exception request message was processed and thus which other
|
||
//! parameters are valid.
|
||
virtual kern_return_t CatchMachException(
|
||
exception_behavior_t behavior,
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_complex_request) = 0;
|
||
|
||
protected:
|
||
~Interface() {}
|
||
};
|
||
|
||
//! \brief Constructs an object of this class.
|
||
//!
|
||
//! \param[in] interface The interface to dispatch requests to. Weak.
|
||
explicit SimplifiedMachExcServer(Interface* interface);
|
||
|
||
// MachExcServer::Interface:
|
||
|
||
kern_return_t CatchMachExceptionRaise(exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) override;
|
||
kern_return_t CatchMachExceptionRaiseState(
|
||
exception_handler_t exception_port,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer) override;
|
||
kern_return_t CatchMachExceptionRaiseStateIdentity(
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_request) override;
|
||
|
||
private:
|
||
Interface* interface_; // weak
|
||
|
||
DISALLOW_COPY_AND_ASSIGN(SimplifiedMachExcServer);
|
||
};
|
||
|
||
} // namespace internal
|
||
|
||
//! \brief A server interface for the `exc` and `mach_exc` Mach subsystems,
|
||
//! unified to handle exceptions delivered to either subsystem, and
|
||
//! simplified to have only a single interface method needing
|
||
//! implementation.
|
||
//!
|
||
//! UniversalMachExcServer operates by translating messages received in the
|
||
//! `exc` subsystem to a variant that is compatible with the `mach_exc`
|
||
//! subsystem. This involves changing the format of \a code, the exception code
|
||
//! field, from `exception_data_type_t` to `mach_exception_data_type_t`.
|
||
//! This is achieved by implementing SimplifiedExcServer::Interface and having
|
||
//! it forward translated messages to SimplifiedMachExcServer::Interface, which
|
||
//! is left unimplemented here so that users of this class can provide their own
|
||
//! implementations.
|
||
class UniversalMachExcServer
|
||
: public MachMessageServer::Interface,
|
||
public internal::SimplifiedExcServer::Interface,
|
||
public internal::SimplifiedMachExcServer::Interface {
|
||
public:
|
||
//! \brief An interface that the different request messages that are a part of
|
||
//! the `exc` and `mach_exc` Mach subsystems can be dispatched to.
|
||
class Interface {
|
||
public:
|
||
//! \brief Handles exceptions raised by `exception_raise()`,
|
||
//! `exception_raise_state()`, `exception_raise_state_identity()`,
|
||
//! `mach_exception_raise()`, `mach_exception_raise_state()`, and
|
||
//! `mach_exception_raise_state_identity()`.
|
||
//!
|
||
//! For convenience in implementation, these different “behaviors” of
|
||
//! exception messages are all mapped to a single interface method. The
|
||
//! exception’s original “behavior” is specified in the \a behavior
|
||
//! parameter. Only parameters that were supplied in the request message
|
||
//! are populated, other parameters are set to reasonable default values.
|
||
//!
|
||
//! The meanings of most parameters are identical to that of
|
||
//! MachExcServer::Interface::CatchMachExceptionRaiseStateIdentity().
|
||
//!
|
||
//! \param[in] behavior `EXCEPTION_DEFAULT`, `EXCEPTION_STATE`,
|
||
//! or `EXCEPTION_STATE_IDENTITY`, possibly with `MACH_EXCEPTION_CODES`
|
||
//! ORed in. This identifies which exception request message was
|
||
//! processed and thus which other parameters are valid.
|
||
virtual kern_return_t CatchMachException(
|
||
exception_behavior_t behavior,
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_complex_request) = 0;
|
||
|
||
protected:
|
||
~Interface() {}
|
||
};
|
||
|
||
//! \brief Constructs an object of this class.
|
||
//!
|
||
//! \param[in] interface The interface to dispatch requests to. Weak.
|
||
explicit UniversalMachExcServer(Interface* interface);
|
||
|
||
// MachMessageServer::Interface:
|
||
|
||
bool MachMessageServerFunction(const mach_msg_header_t* in_header,
|
||
mach_msg_header_t* out_header,
|
||
bool* destroy_complex_request) override;
|
||
|
||
std::set<mach_msg_id_t> MachMessageServerRequestIDs() override;
|
||
|
||
mach_msg_size_t MachMessageServerRequestSize() override;
|
||
mach_msg_size_t MachMessageServerReplySize() override;
|
||
|
||
// internal::SimplifiedExcServer::Interface:
|
||
|
||
kern_return_t CatchException(exception_behavior_t behavior,
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_complex_request) override;
|
||
|
||
// internal::SimplifiedMachExcServer::Interface:
|
||
|
||
kern_return_t CatchMachException(exception_behavior_t behavior,
|
||
exception_handler_t exception_port,
|
||
thread_t thread,
|
||
task_t task,
|
||
exception_type_t exception,
|
||
const mach_exception_data_type_t* code,
|
||
mach_msg_type_number_t code_count,
|
||
thread_state_flavor_t* flavor,
|
||
const natural_t* old_state,
|
||
mach_msg_type_number_t old_state_count,
|
||
thread_state_t new_state,
|
||
mach_msg_type_number_t* new_state_count,
|
||
const mach_msg_trailer_t* trailer,
|
||
bool* destroy_complex_request) override;
|
||
|
||
private:
|
||
internal::SimplifiedExcServer exc_server_;
|
||
internal::SimplifiedMachExcServer mach_exc_server_;
|
||
Interface* interface_; // weak
|
||
|
||
DISALLOW_COPY_AND_ASSIGN(UniversalMachExcServer);
|
||
};
|
||
|
||
//! \brief Recovers the original exception, first exception code, and signal
|
||
//! from the encoded form of the first exception code delivered with
|
||
//! `EXC_CRASH` exceptions.
|
||
//!
|
||
//! `EXC_CRASH` exceptions are generated when the kernel has committed to
|
||
//! terminating a process as a result of a core-generating POSIX signal and, for
|
||
//! hardware exceptions, an earlier Mach exception. Information about this
|
||
//! earlier exception and signal is made available to the `EXC_CRASH` handler
|
||
//! via its `code[0]` parameter. This function recovers the original exception,
|
||
//! the value of `code[0]` from the original exception, and the value of the
|
||
//! signal responsible for process termination.
|
||
//!
|
||
//! \param[in] code_0 The first exception code (`code[0]`) passed to a Mach
|
||
//! exception handler in an `EXC_CRASH` exception. It is invalid to call
|
||
//! this function with an exception code from any exception other than
|
||
//! `EXC_CRASH`.
|
||
//! \param[out] original_code_0 The first exception code (`code[0]`) passed to
|
||
//! the Mach exception handler for a hardware exception that resulted in the
|
||
//! generation of a POSIX signal that caused process termination. If the
|
||
//! signal that caused termination was not sent as a result of a hardware
|
||
//! exception, this will be `0`. Callers that do not need this value may
|
||
//! pass `nullptr`.
|
||
//! \param[out] signal The POSIX signal that caused process termination. Callers
|
||
//! that do not need this value may pass `nullptr`.
|
||
//!
|
||
//! \return The original exception for a hardware exception that resulted in the
|
||
//! generation of a POSIX signal that caused process termination. If the
|
||
//! signal that caused termination was not sent as a result of a hardware
|
||
//! exception, this will be `0`.
|
||
exception_type_t ExcCrashRecoverOriginalException(
|
||
mach_exception_code_t code_0,
|
||
mach_exception_code_t* original_code_0,
|
||
int* signal);
|
||
|
||
//! \brief Computes an approriate successful return value for an exception
|
||
//! handler function.
|
||
//!
|
||
//! For exception handlers that respond to state-carrying behaviors, when the
|
||
//! handler is called by the kernel (as it is normally), the kernel will attempt
|
||
//! to set a new thread state when the exception handler returns successfully.
|
||
//! Other code that mimics the kernel’s exception-delivery semantics may
|
||
//! implement the same or similar behavior. In some situations, it is
|
||
//! undesirable to set a new thread state. If the exception handler were to
|
||
//! return unsuccessfully, however, the kernel would continue searching for an
|
||
//! exception handler at a wider (task or host) scope. This may also be
|
||
//! undesirable.
|
||
//!
|
||
//! If such exception handlers return `MACH_RCV_PORT_DIED`, the kernel will not
|
||
//! set a new thread state and will also not search for another exception
|
||
//! handler. See 10.9.4 `xnu-2422.110.17/osfmk/kern/exception.c`.
|
||
//! `exception_deliver()` will only set a new thread state if the handler’s
|
||
//! return code was `MACH_MSG_SUCCESS` (a synonym for `KERN_SUCCESS`), and
|
||
//! subsequently, `exception_triage()` will not search for a new handler if the
|
||
//! handler’s return code was `KERN_SUCCESS` or `MACH_RCV_PORT_DIED`.
|
||
//!
|
||
//! This function allows exception handlers to compute an appropriate return
|
||
//! code to influence their caller (the kernel) in the desired way with respect
|
||
//! to setting a new thread state while suppressing the caller’s subsequent
|
||
//! search for other exception handlers. An exception handler should return the
|
||
//! value returned by this function.
|
||
//!
|
||
//! This function is useful even for `EXC_CRASH` handlers, where returning
|
||
//! `KERN_SUCCESS` and allowing the kernel to set a new thread state has been
|
||
//! observed to cause a perceptible and unnecessary waste of time. The victim
|
||
//! task in an `EXC_CRASH` handler is already being terminated and is no longer
|
||
//! schedulable, so there is no point in setting the states of any of its
|
||
//! threads.
|
||
//!
|
||
//! \param[in] behavior The behavior of the exception handler as invoked. This
|
||
//! may be taken directly from the \a behavior parameter of
|
||
//! internal::SimplifiedExcServer::Interface::CatchException(), for example.
|
||
//! \param[in] set_thread_state `true` if the handler would like its caller to
|
||
//! set the new thread state using the \a flavor, \a new_state, and \a
|
||
//! new_state_count out parameters. This can only happen when \a behavior is
|
||
//! a state-carrying behavior.
|
||
//!
|
||
//! \return `KERN_SUCCESS` or `MACH_RCV_PORT_DIED`. `KERN_SUCCESS` is used when
|
||
//! \a behavior is not a state-carrying behavior, or when it is a
|
||
//! state-carrying behavior and \a set_thread_state is `true`.
|
||
//! `MACH_RCV_PORT_DIED` is used when \a behavior is a state-carrying
|
||
//! behavior and \a set_thread_state is `false`.
|
||
kern_return_t ExcServerSuccessfulReturnValue(exception_behavior_t behavior,
|
||
bool set_thread_state);
|
||
|
||
} // namespace crashpad
|
||
|
||
#endif // CRASHPAD_UTIL_MACH_EXC_SERVER_VARIANTS_H_
|