tests/exc_helpers.h

   1 /*
   2  * Copyright (c) 2019 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef EXC_HELPERS_H
  30 #define EXC_HELPERS_H
  31
  32 #include <mach/mach.h>
  33 #include <mach/exception.h>
  34 #include <mach/thread_status.h>
  35
  36 /**
  37  * Callback invoked by run_exception_handler() when a Mach exception is
  38  * received.
  39  *
  40  * @param task      the task causing the exception
  41  * @param thread    the task causing the exception
  42  * @param type      exception type received from the kernel
  43  * @param codes     exception codes received from the kernel
  44  *
  45  * @return      how much the exception handler should advance the program
  46  *              counter, in bytes (in order to move past the code causing the
  47  *              exception)
  48  */
  49 typedef size_t (*exc_handler_callback_t)(mach_port_t task, mach_port_t thread,
  50     exception_type_t type, mach_exception_data_t codes);
  51
  52 mach_port_t
  53 create_exception_port(exception_mask_t exception_mask);
  54
  55 void
  56 run_exception_handler(mach_port_t exc_port, exc_handler_callback_t callback);
  57
  58 #endif /* EXC_HELPERS_H */