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