osfmk/kdp/kdp_core.h

   1 /*
   2  * Copyright (c) 2003 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 /* HISTORY
  30  * 8 Aug. 2003 - Created (Derek Kumar)
  31  */
  32
  33 /* Various protocol definitions
  34  * for the core transfer protocol, which is a variant of TFTP
  35  */
  36 #ifndef __KDP_CORE_H
  37 #define __KDP_CORE_H
  38
  39 /*
  40  * Packet types.
  41  */
  42 #define KDP_RRQ   1                     /* read request */
  43 #define KDP_WRQ   2                     /* write request */
  44 #define KDP_DATA  3                     /* data packet */
  45 #define KDP_ACK   4                     /* acknowledgement */
  46 #define KDP_ERROR 5                     /* error code */
  47 #define KDP_SEEK  6                     /* Seek to specified offset */
  48 #define KDP_EOF   7                     /* signal end of file */
  49 #define KDP_FEATURE_MASK_STRING         "features"
  50
  51 enum    {KDP_FEATURE_LARGE_CRASHDUMPS = 1, KDP_FEATURE_LARGE_PKT_SIZE = 2};
  52 extern  uint32_t        kdp_feature_large_crashdumps, kdp_feature_large_pkt_size;
  53
  54 struct  corehdr {
  55         short   th_opcode;              /* packet type */
  56         union {
  57                 unsigned int    tu_block;       /* block # */
  58                 unsigned int    tu_code;        /* error code */
  59                 char    tu_rpl[1];      /* request packet payload */
  60         } th_u;
  61         char    th_data[0];             /* data or error string */
  62 }__attribute__((packed));
  63
  64 #define th_block        th_u.tu_block
  65 #define th_code         th_u.tu_code
  66 #define th_stuff        th_u.tu_rpl
  67 #define th_msg          th_data
  68
  69 /*
  70  * Error codes.
  71  */
  72 #define EUNDEF          0               /* not defined */
  73 #define ENOTFOUND       1               /* file not found */
  74 #define EACCESS         2               /* access violation */
  75 #define ENOSPACE        3               /* disk full or allocation exceeded */
  76 #define EBADOP          4               /* illegal TFTP operation */
  77 #define EBADID          5               /* unknown transfer ID */
  78 #define EEXISTS         6               /* file already exists */
  79 #define ENOUSER         7               /* no such user */
  80
  81 #define CORE_REMOTE_PORT 1069 /* hardwired, we can't really query the services file */
  82
  83 #if WITH_CONSISTENT_DBG
  84 /*
  85  * xnu shared memory hardware debugger support
  86  *
  87  * A hardware debugger can connect, read the consistent debug
  88  * header to determine the physical location of the handshake
  89  * structure and communicate using commands in the structure as
  90  * defined below.
  91  *
  92  * Currently used for sending compressed coredumps to
  93  * astris.
  94  */
  95 struct xnu_hw_shmem_dbg_command_info {
  96         volatile uint32_t xhsdci_status;
  97         uint32_t xhsdci_seq_no;
  98         volatile uint64_t xhsdci_buf_phys_addr;
  99         volatile uint32_t xhsdci_buf_data_length;
 100         /* end of version 0 structure */
 101         uint64_t xhsdci_coredump_total_size_uncomp;
 102         uint64_t xhsdci_coredump_total_size_sent_uncomp;
 103         uint32_t xhsdci_page_size;
 104 } __attribute__((packed));
 105
 106 #define CUR_XNU_HWSDCI_STRUCT_VERS 1
 107
 108 #define XHSDCI_STATUS_NONE              0 /* default status */
 109 #define XHSDCI_STATUS_KERNEL_BUSY       1 /* kernel is busy with other procedure */
 110 #define XHSDCI_STATUS_KERNEL_READY      2 /* kernel ready to begin command */
 111 #define XHSDCI_COREDUMP_BEGIN           3 /* indicates hardware debugger is ready to begin consuming coredump info */
 112 #define XHSDCI_COREDUMP_BUF_READY       4 /* indicates the kernel has populated the buffer */
 113 #define XHSDCI_COREDUMP_BUF_EMPTY       5 /* indicates hardware debugger is done consuming the current data */
 114 #define XHSDCI_COREDUMP_STATUS_DONE     6 /* indicates last compressed data is in buffer */
 115 #define XHSDCI_COREDUMP_ERROR           7 /* indicates an error was encountered */
 116 #define XHSDCI_COREDUMP_REMOTE_DONE     8 /* indicates that hardware debugger is done */
 117
 118 #endif /* WITH_CONSISTENT_DBG */
 119
 120 void kdp_panic_dump (void);
 121 void abort_panic_transfer (void);
 122 void kdp_set_dump_info(const uint32_t flags, const char *file, const char *destip,
 123                        const char *routerip, const uint32_t port);
 124 void kdp_get_dump_info(uint32_t *flags, char *file, char *destip, char *routerip,
 125                        uint32_t *port);
 126
 127 enum kern_dump_type {
 128         KERN_DUMP_DISK, /* local, on device core dump */
 129         KERN_DUMP_NET, /* kdp network core dump */
 130 #if WITH_CONSISTENT_DBG
 131         KERN_DUMP_HW_SHMEM_DBG, /* coordinated hardware shared memory debugger core dump */
 132 #endif
 133 };
 134
 135 extern int kern_dump(enum kern_dump_type kd_variant);
 136
 137 struct corehdr *create_panic_header(unsigned int request, const char *corename, unsigned length, unsigned block);
 138
 139 int     kdp_send_crashdump_pkt(unsigned int request, char *corename,
 140                                 uint64_t length, void *panic_data);
 141
 142 int     kdp_send_crashdump_data(unsigned int request, char *corename,
 143                             uint64_t length, void * txstart);
 144
 145 void kern_collectth_state_size(uint32_t * tstate_count, size_t * tstate_size);
 146
 147 void kern_collectth_state(thread_t thread, void *buffer, size_t size, void **iter);
 148
 149 boolean_t kdp_has_polled_corefile(void);
 150
 151 void kdp_core_init(void);
 152
 153 extern boolean_t kdp_corezip_disabled;
 154
 155 #define KDP_CRASHDUMP_POLL_COUNT (2500)
 156
 157 #endif /* __KDP_CORE_H */