xnu-4570.61.1.tar.gz

[apple/xnu.git] / osfmk / kdp / kdp_core.h

diff --git a/osfmk/kdp/kdp_core.h b/osfmk/kdp/kdp_core.h
index aa54f350ddef527e01df0a3c825f7b630a6fe39d..45cee67b1f23662a589fa078374f8d70f04559c1 100644 (file)
--- a/osfmk/kdp/kdp_core.h
+++ b/osfmk/kdp/kdp_core.h
@@ -33,6 +33,12 @@
 /* Various protocol definitions 
  * for the core transfer protocol, which is a variant of TFTP 
  */
 /* Various protocol definitions 
  * for the core transfer protocol, which is a variant of TFTP 
  */

+#ifndef __KDP_CORE_H
+#define __KDP_CORE_H
+
+#include <kern/thread.h>
+#include <kdp/kdp_protocol.h>
+#include <string.h>

 
 /*
  * Packet types.
 
 /*
  * Packet types.


@@ -44,6 +50,12 @@
 #define        KDP_ERROR 5                     /* error code */
 #define KDP_SEEK  6                     /* Seek to specified offset */
 #define KDP_EOF   7                     /* signal end of file */
 #define        KDP_ERROR 5                     /* error code */
 #define KDP_SEEK  6                     /* Seek to specified offset */
 #define KDP_EOF   7                     /* signal end of file */

+#define KDP_FLUSH 8                     /* flush outstanding data */
+#define KDP_FEATURE_MASK_STRING                "features"
+
+enum   {KDP_FEATURE_LARGE_CRASHDUMPS = 1, KDP_FEATURE_LARGE_PKT_SIZE = 2};
+extern uint32_t        kdp_feature_large_crashdumps, kdp_feature_large_pkt_size;
+

 struct corehdr {
        short   th_opcode;              /* packet type */
        union {
 struct corehdr {
        short   th_opcode;              /* packet type */
        union {


@@ -51,7 +63,7 @@ struct        corehdr {
                unsigned int    tu_code;        /* error code */
                char    tu_rpl[1];      /* request packet payload */
        } th_u;
                unsigned int    tu_code;        /* error code */
                char    tu_rpl[1];      /* request packet payload */
        } th_u;

-       char    th_data[1];             /* data or error string */
+       char    th_data[0];             /* data or error string */

 }__attribute__((packed));
 
 #define        th_block        th_u.tu_block
 }__attribute__((packed));
 
 #define        th_block        th_u.tu_block


@@ -73,14 +85,100 @@ struct     corehdr {
 
 #define CORE_REMOTE_PORT 1069 /* hardwired, we can't really query the services file */
 
 
 #define CORE_REMOTE_PORT 1069 /* hardwired, we can't really query the services file */
 

-void kdp_panic_dump (void);
+#if CONFIG_EMBEDDED
+/*
+ * xnu shared memory hardware debugger support
+ *
+ * A hardware debugger can connect, read the consistent debug
+ * header to determine the physical location of the handshake
+ * structure and communicate using commands in the structure as
+ * defined below.
+ *
+ * Currently used for sending compressed coredumps to
+ * astris.
+ */
+struct xnu_hw_shmem_dbg_command_info {
+       volatile uint32_t xhsdci_status;
+       uint32_t xhsdci_seq_no;
+       volatile uint64_t xhsdci_buf_phys_addr;
+       volatile uint32_t xhsdci_buf_data_length;
+       /* end of version 0 structure */
+       uint64_t xhsdci_coredump_total_size_uncomp;
+       uint64_t xhsdci_coredump_total_size_sent_uncomp;
+       uint32_t xhsdci_page_size;
+} __attribute__((packed));

 
 

+#define CUR_XNU_HWSDCI_STRUCT_VERS 1
+
+#define XHSDCI_STATUS_NONE              0 /* default status */
+#define XHSDCI_STATUS_KERNEL_BUSY       1 /* kernel is busy with other procedure */
+#define XHSDCI_STATUS_KERNEL_READY      2 /* kernel ready to begin command */
+#define XHSDCI_COREDUMP_BEGIN           3 /* indicates hardware debugger is ready to begin consuming coredump info */
+#define XHSDCI_COREDUMP_BUF_READY       4 /* indicates the kernel has populated the buffer */
+#define XHSDCI_COREDUMP_BUF_EMPTY       5 /* indicates hardware debugger is done consuming the current data */
+#define XHSDCI_COREDUMP_STATUS_DONE     6 /* indicates last compressed data is in buffer */
+#define XHSDCI_COREDUMP_ERROR           7 /* indicates an error was encountered */
+#define XHSDCI_COREDUMP_REMOTE_DONE     8 /* indicates that hardware debugger is done */
+
+void panic_spin_shmcon(void);
+
+#endif /* CONFIG_EMBEDDED */
+
+void kdp_panic_dump (void);
+void begin_panic_transfer(void);

 void abort_panic_transfer (void);
 void abort_panic_transfer (void);

+void kdp_set_dump_info(const uint32_t flags, const char *file, const char *destip,
+                       const char *routerip, const uint32_t port);
+void kdp_get_dump_info(kdp_dumpinfo_reply_t *rp);
+
+enum kern_dump_type {
+       KERN_DUMP_DISK, /* local, on device core dump */
+       KERN_DUMP_NET, /* kdp network core dump */
+#if CONFIG_EMBEDDED
+       KERN_DUMP_HW_SHMEM_DBG, /* coordinated hardware shared memory debugger core dump */
+#endif
+};
+
+int kern_dump(enum kern_dump_type kd_variant);
+
+boolean_t dumped_kernel_core(void);

 
 struct corehdr *create_panic_header(unsigned int request, const char *corename, unsigned length, unsigned block);
 
 int    kdp_send_crashdump_pkt(unsigned int request, char *corename,
 
 struct corehdr *create_panic_header(unsigned int request, const char *corename, unsigned length, unsigned block);
 
 int    kdp_send_crashdump_pkt(unsigned int request, char *corename,

-                               unsigned int length, void *panic_data);
+                               uint64_t length, void *panic_data);

 
 int    kdp_send_crashdump_data(unsigned int request, char *corename,
 
 int    kdp_send_crashdump_data(unsigned int request, char *corename,

-                               unsigned int length, caddr_t txstart);
+                           uint64_t length, void * txstart);
+
+void kern_collectth_state_size(uint64_t * tstate_count, uint64_t * tstate_size);
+
+void kern_collectth_state(thread_t thread, void *buffer, uint64_t size, void **iter);
+
+boolean_t kdp_has_polled_corefile(void);
+
+void kdp_core_init(void);
+
+extern boolean_t kdp_corezip_disabled;
+
+#define KDP_CRASHDUMP_POLL_COUNT (2500)
+
+#if PRIVATE
+kern_return_t kdp_core_output(void *kdp_core_out_vars, uint64_t length, void * data);
+
+kern_return_t kdp_reset_output_vars(void *kdp_core_out_vars, uint64_t totalbytes);
+
+int kern_dump_record_file(void *kdp_core_out_vars, const char *filename, uint64_t file_offset, uint64_t *out_file_length);
+
+int kern_dump_seek_to_next_file(void *kdp_core_out_varss, uint64_t next_file_offset);
+
+extern boolean_t efi_valid_page(ppnum_t ppn);
+#if defined(__x86_64__)
+#define EFI_VALID_PAGE(x)      efi_valid_page(x)
+#elif defined(__arm__) || defined(__arm64__)
+#define EFI_VALID_PAGE(x)      (FALSE)
+#endif /* defined (__x86_64__) */
+
+#endif /* PRIVATE */
+
+#endif /* __KDP_CORE_H */