1*2c2f96dcSApple OSS Distributions /*
2*2c2f96dcSApple OSS Distributions * Copyright (c) 2017 Apple Inc. All rights reserved.
3*2c2f96dcSApple OSS Distributions *
4*2c2f96dcSApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*2c2f96dcSApple OSS Distributions *
6*2c2f96dcSApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code
7*2c2f96dcSApple OSS Distributions * as defined in and that are subject to the Apple Public Source License
8*2c2f96dcSApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in
9*2c2f96dcSApple OSS Distributions * compliance with the License. The rights granted to you under the License
10*2c2f96dcSApple OSS Distributions * may not be used to create, or enable the creation or redistribution of,
11*2c2f96dcSApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to
12*2c2f96dcSApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any
13*2c2f96dcSApple OSS Distributions * terms of an Apple operating system software license agreement.
14*2c2f96dcSApple OSS Distributions *
15*2c2f96dcSApple OSS Distributions * Please obtain a copy of the License at
16*2c2f96dcSApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*2c2f96dcSApple OSS Distributions *
18*2c2f96dcSApple OSS Distributions * The Original Code and all software distributed under the License are
19*2c2f96dcSApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*2c2f96dcSApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*2c2f96dcSApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*2c2f96dcSApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*2c2f96dcSApple OSS Distributions * Please see the License for the specific language governing rights and
24*2c2f96dcSApple OSS Distributions * limitations under the License.
25*2c2f96dcSApple OSS Distributions *
26*2c2f96dcSApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*2c2f96dcSApple OSS Distributions */
28*2c2f96dcSApple OSS Distributions
29*2c2f96dcSApple OSS Distributions #pragma once
30*2c2f96dcSApple OSS Distributions
31*2c2f96dcSApple OSS Distributions #include <mach/thread_status.h>
32*2c2f96dcSApple OSS Distributions #include <sys/cdefs.h>
33*2c2f96dcSApple OSS Distributions
34*2c2f96dcSApple OSS Distributions __BEGIN_DECLS
35*2c2f96dcSApple OSS Distributions
36*2c2f96dcSApple OSS Distributions #if defined(__arm64__)
37*2c2f96dcSApple OSS Distributions typedef arm_thread_state64_t __attribute__((aligned(16))) dbgwrap_thread_state_t;
38*2c2f96dcSApple OSS Distributions #else
39*2c2f96dcSApple OSS Distributions typedef arm_thread_state32_t dbgwrap_thread_state_t;
40*2c2f96dcSApple OSS Distributions #endif
41*2c2f96dcSApple OSS Distributions
42*2c2f96dcSApple OSS Distributions typedef enum {
43*2c2f96dcSApple OSS Distributions DBGWRAP_ERR_SELF_HALT = -6,
44*2c2f96dcSApple OSS Distributions DBGWRAP_ERR_UNSUPPORTED = -5,
45*2c2f96dcSApple OSS Distributions DBGWRAP_ERR_INPROGRESS = -4,
46*2c2f96dcSApple OSS Distributions DBGWRAP_ERR_INSTR_ERROR = -3,
47*2c2f96dcSApple OSS Distributions DBGWRAP_ERR_INSTR_TIMEOUT = -2,
48*2c2f96dcSApple OSS Distributions DBGWRAP_ERR_HALT_TIMEOUT = -1,
49*2c2f96dcSApple OSS Distributions DBGWRAP_SUCCESS = 0,
50*2c2f96dcSApple OSS Distributions DBGWRAP_WARN_ALREADY_HALTED,
51*2c2f96dcSApple OSS Distributions DBGWRAP_WARN_CPU_OFFLINE
52*2c2f96dcSApple OSS Distributions } dbgwrap_status_t;
53*2c2f96dcSApple OSS Distributions
54*2c2f96dcSApple OSS Distributions static inline const char*
ml_dbgwrap_strerror(dbgwrap_status_t status)55*2c2f96dcSApple OSS Distributions ml_dbgwrap_strerror(dbgwrap_status_t status)
56*2c2f96dcSApple OSS Distributions {
57*2c2f96dcSApple OSS Distributions switch (status) {
58*2c2f96dcSApple OSS Distributions case DBGWRAP_ERR_SELF_HALT: return "CPU attempted to halt itself";
59*2c2f96dcSApple OSS Distributions case DBGWRAP_ERR_UNSUPPORTED: return "halt not supported for this configuration";
60*2c2f96dcSApple OSS Distributions case DBGWRAP_ERR_INPROGRESS: return "halt in progress on another CPU";
61*2c2f96dcSApple OSS Distributions case DBGWRAP_ERR_INSTR_ERROR: return "instruction-stuffing failure";
62*2c2f96dcSApple OSS Distributions case DBGWRAP_ERR_INSTR_TIMEOUT: return "instruction-stuffing timeout";
63*2c2f96dcSApple OSS Distributions case DBGWRAP_ERR_HALT_TIMEOUT: return "halt ack timeout, CPU likely wedged";
64*2c2f96dcSApple OSS Distributions case DBGWRAP_SUCCESS: return "halt succeeded";
65*2c2f96dcSApple OSS Distributions case DBGWRAP_WARN_ALREADY_HALTED: return "CPU already halted";
66*2c2f96dcSApple OSS Distributions case DBGWRAP_WARN_CPU_OFFLINE: return "CPU offline";
67*2c2f96dcSApple OSS Distributions default: return "unrecognized status";
68*2c2f96dcSApple OSS Distributions }
69*2c2f96dcSApple OSS Distributions }
70*2c2f96dcSApple OSS Distributions
71*2c2f96dcSApple OSS Distributions boolean_t ml_dbgwrap_cpu_is_halted(int cpu_index);
72*2c2f96dcSApple OSS Distributions
73*2c2f96dcSApple OSS Distributions dbgwrap_status_t ml_dbgwrap_wait_cpu_halted(int cpu_index, uint64_t timeout_ns);
74*2c2f96dcSApple OSS Distributions
75*2c2f96dcSApple OSS Distributions dbgwrap_status_t ml_dbgwrap_halt_cpu(int cpu_index, uint64_t timeout_ns);
76*2c2f96dcSApple OSS Distributions
77*2c2f96dcSApple OSS Distributions dbgwrap_status_t ml_dbgwrap_halt_cpu_with_state(int cpu_index, uint64_t timeout_ns, dbgwrap_thread_state_t *state);
78*2c2f96dcSApple OSS Distributions
79*2c2f96dcSApple OSS Distributions __END_DECLS
80