osfmk/kdp/kdp_internal.h

   1 /*
   2  * Copyright (c) 2000-2004 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 /*
  30  * Internal definitions for kdp module
  31  */
  32
  33 #include <kdp/kdp.h>
  34 #include <kdp/kdp_protocol.h>
  35 #include <mach/vm_types.h>
  36 #include <mach/boolean.h>
  37 #include <mach/mach_types.h>
  38 #include <libsa/types.h>
  39
  40 typedef struct {
  41     void                        *saved_state;
  42     thread_t                    kdp_thread;
  43     int                         kdp_cpu;
  44     uint32_t                    session_key;
  45     unsigned int                conn_seq;
  46     unsigned short              reply_port;
  47     unsigned short              exception_port;
  48     boolean_t                   is_conn;
  49     boolean_t                   is_halted;
  50     unsigned char               exception_seq;
  51     boolean_t                   exception_ack_needed;
  52 } kdp_glob_t;
  53
  54 extern kdp_glob_t       kdp;
  55
  56 extern volatile int     kdp_flag;
  57 extern int            noresume_on_disconnect;
  58
  59 extern char kdp_kernelversion_string[256];
  60
  61 #define KDP_READY       0x1
  62 #define KDP_ARP         0x2
  63 #define KDP_BP_DIS      0x4
  64 #define KDP_GETC_ENA    0x8
  65 #define KDP_PANIC_DUMP_ENABLED 0x10
  66 #define PANIC_CORE_ON_NMI 0x20
  67 #define DBG_POST_CORE     0x40
  68 #define PANIC_LOG_DUMP    0x80
  69 #define REBOOT_POST_CORE  0x100
  70 #define SYSTEM_LOG_DUMP   0x200
  71 typedef boolean_t
  72 (*kdp_dispatch_t) (
  73     kdp_pkt_t *,
  74     int  *,
  75     unsigned short *
  76 );
  77
  78 struct debugger_callback {
  79         kern_return_t (*callback) (void*);
  80         void *callback_context;
  81         boolean_t proceed_on_sync_failure;
  82         kern_return_t error;
  83 };
  84
  85 extern struct debugger_callback *debugger_callback;
  86
  87 extern
  88 boolean_t
  89 kdp_packet(
  90     unsigned char *,
  91     int *,
  92     unsigned short *
  93 );
  94
  95 extern
  96 boolean_t
  97 kdp_remove_all_breakpoints (void);
  98
  99 extern
 100 void
 101 kdp_exception(
 102     unsigned char *,
 103     int *,
 104     unsigned short *,
 105     unsigned int,
 106     unsigned int,
 107     unsigned int
 108 );
 109
 110 extern
 111 boolean_t
 112 kdp_exception_ack(
 113     unsigned char *,
 114     int
 115 );
 116
 117 extern
 118 void
 119 kdp_panic(
 120     const char          *msg
 121 );
 122
 123 extern
 124 void
 125 kdp_machine_reboot(
 126     void
 127 );
 128
 129 extern
 130 void
 131 kdp_us_spin(
 132     int usec
 133 );
 134
 135 extern
 136 int
 137 kdp_intr_disbl(
 138     void
 139 );
 140
 141 extern
 142 void
 143 kdp_intr_enbl(
 144     int s
 145 );
 146
 147 extern
 148 kdp_error_t
 149 kdp_machine_read_regs(
 150     unsigned int cpu,
 151     unsigned int flavor,
 152     char *data,
 153     int *size
 154 );
 155
 156 extern
 157 kdp_error_t
 158 kdp_machine_write_regs(
 159     unsigned int cpu,
 160     unsigned int flavor,
 161     char *data,
 162     int *size
 163 );
 164
 165 extern
 166 void
 167 kdp_machine_hostinfo(
 168     kdp_hostinfo_t *hostinfo
 169 );
 170
 171 extern
 172 void
 173 kdp_sync_cache(
 174     void
 175 );
 176
 177 /* Return a byte array that can be byte-copied to a memory address
 178  * to trap into the debugger. Must be 4 bytes or less in the current
 179  * implementation
 180  */
 181 #define MAX_BREAKINSN_BYTES 4
 182
 183 void
 184 kdp_machine_get_breakinsn(
 185                                                   uint8_t *bytes,
 186                                                   uint32_t *size
 187 );
 188
 189 extern void
 190 kdp_ml_enter_debugger(
 191         void
 192 );
 193
 194 mach_vm_size_t
 195 kdp_machine_vm_read( mach_vm_address_t, caddr_t, mach_vm_size_t);
 196
 197 mach_vm_size_t
 198 kdp_machine_vm_write( caddr_t, mach_vm_address_t, mach_vm_size_t);
 199
 200 mach_vm_size_t
 201 kdp_machine_phys_read(kdp_readphysmem64_req_t *rq, caddr_t /* data */,
 202                       uint16_t /* lcpu */);
 203
 204 mach_vm_size_t
 205 kdp_machine_phys_write(kdp_writephysmem64_req_t *rq, caddr_t /* data */,
 206                        uint16_t /* lcpu */);
 207
 208 int
 209 kdp_machine_ioport_read(kdp_readioport_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 210
 211 int
 212 kdp_machine_ioport_write(kdp_writeioport_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 213
 214 int
 215 kdp_machine_msr64_read(kdp_readmsr64_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 216
 217 int
 218 kdp_machine_msr64_write(kdp_writemsr64_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 219