1 /* 2 * Copyright (c) 2021 Apple 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 #pragma once 30 31 #include <stdbool.h> 32 #include <stddef.h> 33 #include <stdint.h> 34 #include <sys/queue.h> 35 #include <kdp/processor_core.h> 36 37 struct kdp_output_stage; 38 39 struct kdp_core_out_state { 40 STAILQ_HEAD(, kdp_output_stage) kcos_out_stage; 41 struct kdp_output_stage * kcos_encryption_stage; 42 bool kcos_enforce_encryption; 43 uint64_t kcos_totalbytes; 44 uint64_t kcos_bytes_written; 45 uint64_t kcos_lastpercent; 46 kern_return_t kcos_error; 47 }; 48 49 struct kdp_output_stage_funcs { 50 kern_return_t (*kosf_reset)(struct kdp_output_stage *stage, const char *corename, kern_coredump_type_t coretype); 51 kern_return_t (*kosf_outproc)(struct kdp_output_stage *stage, unsigned int request, 52 char *corename, uint64_t length, void *panic_data); 53 void (*kosf_free)(struct kdp_output_stage *stage); 54 }; 55 56 struct kdp_output_stage { 57 STAILQ_ENTRY(kdp_output_stage) kos_next; 58 bool kos_initialized; 59 struct kdp_core_out_state * kos_outstate; 60 struct kdp_output_stage_funcs kos_funcs; 61 uint64_t kos_bytes_written; // bytes written since the last call to reset() 62 bool kos_bypass; 63 void * kos_data; 64 size_t kos_data_size; 65 }; 66