gdb/darwin-nat.h

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