gdb/darwin-nat.h

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