Pass Mach message trailers to server handler functions

util/mach/exc_server_variants.h

 // 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,
@@ skipping 24 matching lines @@
  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) = 0;
+        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);
@@ skipping 18 matching lines @@
  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) = 0;
+        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);
@@ skipping 42 matching lines @@
         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) override;
+      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.
@@ skipping 34 matching lines @@
         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) override;
+      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
 
@@ skipping 34 matching lines @@
                                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;
 
  private:
   internal::SimplifiedExcServer exc_server_;
   internal::SimplifiedMachExcServer mach_exc_server_;
 
   DISALLOW_COPY_AND_ASSIGN(UniversalMachExcServer);
 };
 
 //! \brief Recovers the original exception, first exception code, and signal
@@ skipping 76 matching lines @@
 //!     \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_