gdb/darwin-nat.h

   1 /* Common things used by the various darwin files
   2    Copyright (C) 1995-2017 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #ifndef __DARWIN_NAT_H__
  18 #define __DARWIN_NAT_H__
  19
  20 #include <mach/mach.h>
  21
  22 /* Describe the mach exception handling state for a task.  This state is saved
  23    before being changed and restored when a process is detached.
  24    For more information on these fields see task_get_exception_ports manual
  25    page.  */
  26 struct darwin_exception_info
  27 {
  28   /* Exceptions handled by the port.  */
  29   exception_mask_t masks[EXC_TYPES_COUNT];
  30
  31   /* Ports receiving exception messages.  */
  32   mach_port_t ports[EXC_TYPES_COUNT];
  33
  34   /* Type of messages sent.  */
  35   exception_behavior_t behaviors[EXC_TYPES_COUNT];
  36
  37   /* Type of state to be sent.  */
  38   thread_state_flavor_t flavors[EXC_TYPES_COUNT];
  39
  40   /* Number of elements set.  */
  41   mach_msg_type_number_t count;
  42 };
  43 typedef struct darwin_exception_info darwin_exception_info;
  44
  45 struct darwin_exception_msg
  46 {
  47   mach_msg_header_t header;
  48
  49   /* Thread and task taking the exception.  */
  50   mach_port_t thread_port;
  51   mach_port_t task_port;
  52
  53   /* Type of the exception.  */
  54   exception_type_t ex_type;
  55
  56   /* Machine dependent details.  */
  57   mach_msg_type_number_t data_count;
  58   integer_t ex_data[2];
  59 };
  60
  61 enum darwin_msg_state
  62 {
  63   /* The thread is running.  */
  64   DARWIN_RUNNING,
  65
  66   /* The thread is stopped.  */
  67   DARWIN_STOPPED,
  68
  69   /* The thread has sent a message and waits for a reply.  */
  70   DARWIN_MESSAGE
  71 };
  72
  73 struct private_thread_info
  74 {
  75   /* The thread port from a GDB point of view.  */
  76   thread_t gdb_port;
  77
  78   /* The thread port from the inferior point of view.  Not to be used inside
  79      gdb except for get_ada_task_ptid.  */
  80   thread_t inf_port;
  81
  82   /* Current message state.
  83      If the kernel has sent a message it expects a reply and the inferior
  84      can't be killed before.  */
  85   enum darwin_msg_state msg_state;
  86
  87   /* True if this thread is single-stepped.  */
  88   unsigned char single_step;
  89
  90   /* True if a signal was manually sent to the thread.  */
  91   unsigned char signaled;
  92
  93   /* The last exception received.  */
  94   struct darwin_exception_msg event;
  95 };
  96 typedef struct private_thread_info darwin_thread_t;
  97
  98 /* Define the threads vector type.  */
  99 DEF_VEC_O (darwin_thread_t);
 100
 101
 102 /* Describe an inferior.  */
 103 struct private_inferior
 104 {
 105   /* Corresponding task port.  */
 106   task_t task;
 107
 108   /* Port which will receive the dead-name notification for the task port.
 109      This is used to detect the death of the task.  */
 110   mach_port_t notify_port;
 111
 112   /* Initial exception handling.  */
 113   darwin_exception_info exception_info;
 114
 115   /* Number of messages that have been received but not yet replied.  */
 116   unsigned int pending_messages;
 117
 118   /* Set if inferior is not controlled by ptrace(2) but through Mach.  */
 119   unsigned char no_ptrace;
 120
 121   /* True if this task is suspended.  */
 122   unsigned char suspended;
 123
 124   /* Sorted vector of known threads.  */
 125   VEC(darwin_thread_t) *threads;
 126 };
 127 typedef struct private_inferior darwin_inferior;
 128
 129 /* Exception port.  */
 130 extern mach_port_t darwin_ex_port;
 131
 132 /* Port set.  */
 133 extern mach_port_t darwin_port_set;
 134
 135 /* A copy of mach_host_self ().  */
 136 extern mach_port_t darwin_host_self;
 137
 138 /* FUNCTION_NAME is defined in common-utils.h (or not).  */
 139 #ifdef FUNCTION_NAME
 140 #define MACH_CHECK_ERROR(ret) \
 141   mach_check_error (ret, __FILE__, __LINE__, FUNCTION_NAME)
 142 #else
 143 #define MACH_CHECK_ERROR(ret) \
 144   mach_check_error (ret, __FILE__, __LINE__, "??")
 145 #endif
 146
 147 extern void mach_check_error (kern_return_t ret, const char *file,
 148                               unsigned int line, const char *func);
 149
 150 void darwin_set_sstep (thread_t thread, int enable);
 151
 152 /* This one is called in darwin-nat.c, but needs to be provided by the
 153    platform specific nat code.  It allows each platform to add platform specific
 154    stuff to the darwin_ops.  */
 155 extern void darwin_complete_target (struct target_ops *target);
 156
 157 void darwin_check_osabi (darwin_inferior *inf, thread_t thread);
 158
 159 #endif /* __DARWIN_NAT_H__ */