1/*
2 * Copyright (c) 2017 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 <mach/thread_status.h>
32#include <sys/cdefs.h>
33
34__BEGIN_DECLS
35
36#if defined(__arm64__)
37typedef arm_thread_state64_t __attribute__((aligned(16))) dbgwrap_thread_state_t;
38#else
39typedef arm_thread_state32_t dbgwrap_thread_state_t;
40#endif
41
42typedef enum {
43 DBGWRAP_ERR_SELF_HALT = -6,
44 DBGWRAP_ERR_UNSUPPORTED = -5,
45 DBGWRAP_ERR_INPROGRESS = -4,
46 DBGWRAP_ERR_INSTR_ERROR = -3,
47 DBGWRAP_ERR_INSTR_TIMEOUT = -2,
48 DBGWRAP_ERR_HALT_TIMEOUT = -1,
49 DBGWRAP_SUCCESS = 0,
50 DBGWRAP_WARN_ALREADY_HALTED,
51 DBGWRAP_WARN_CPU_OFFLINE
52} dbgwrap_status_t;
53
54static inline const char*
55ml_dbgwrap_strerror(dbgwrap_status_t status)
56{
57 switch (status) {
58 case DBGWRAP_ERR_SELF_HALT: return "CPU attempted to halt itself";
59 case DBGWRAP_ERR_UNSUPPORTED: return "halt not supported for this configuration";
60 case DBGWRAP_ERR_INPROGRESS: return "halt in progress on another CPU";
61 case DBGWRAP_ERR_INSTR_ERROR: return "instruction-stuffing failure";
62 case DBGWRAP_ERR_INSTR_TIMEOUT: return "instruction-stuffing timeout";
63 case DBGWRAP_ERR_HALT_TIMEOUT: return "halt ack timeout, CPU likely wedged";
64 case DBGWRAP_SUCCESS: return "halt succeeded";
65 case DBGWRAP_WARN_ALREADY_HALTED: return "CPU already halted";
66 case DBGWRAP_WARN_CPU_OFFLINE: return "CPU offline";
67 default: return "unrecognized status";
68 }
69}
70
71boolean_t ml_dbgwrap_cpu_is_halted(int cpu_index);
72
73dbgwrap_status_t ml_dbgwrap_wait_cpu_halted(int cpu_index, uint64_t timeout_ns);
74
75dbgwrap_status_t ml_dbgwrap_halt_cpu(int cpu_index, uint64_t timeout_ns);
76
77dbgwrap_status_t ml_dbgwrap_halt_cpu_with_state(int cpu_index, uint64_t timeout_ns, dbgwrap_thread_state_t *state);
78
79__END_DECLS
80