gems-kernel/source/THIRDPARTY/xnu/bsd/sys/fasttrap.h
2024-06-03 11:29:39 -05:00

125 lines
3.7 KiB
C

/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_FASTTRAP_H
#define _SYS_FASTTRAP_H
#include <sys/fasttrap_isa.h>
#include <sys/dtrace.h>
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif
#if !defined(__APPLE__)
#define FASTTRAPIOC (('m' << 24) | ('r' << 16) | ('f' << 8))
#else
#define FASTTRAPIOC _IO('d', 0)
#endif /* __APPLE__ */
#define FASTTRAPIOC_MAKEPROBE (FASTTRAPIOC | 1)
#define FASTTRAPIOC_GETINSTR (FASTTRAPIOC | 2)
typedef enum fasttrap_probe_type {
DTFTP_NONE = 0,
DTFTP_ENTRY,
DTFTP_RETURN,
DTFTP_OFFSETS,
DTFTP_POST_OFFSETS,
DTFTP_IS_ENABLED
} fasttrap_probe_type_t;
#if defined(__APPLE__)
typedef enum fasttrap_provider_type {
DTFTP_PROVIDER_NONE = 0,
DTFTP_PROVIDER_USDT,
DTFTP_PROVIDER_PID,
DTFTP_PROVIDER_OBJC,
DTFTP_PROVIDER_ONESHOT
} fasttrap_provider_type_t;
/* Moved from fasttrap.c */
#define FASTTRAP_PID_NAME "pid"
#define FASTTRAP_OBJC_NAME "objc"
#define FASTTRAP_ONESHOT_NAME "oneshot"
#endif
typedef struct fasttrap_probe_spec {
pid_t ftps_pid;
#if defined(__APPLE__)
fasttrap_provider_type_t ftps_provider_type;
fasttrap_probe_type_t ftps_probe_type;
#if defined(__arm__) || defined(__arm64__)
uint32_t ftps_arch_subinfo; // For any additional per probe architecture specific data
#endif
#endif
char ftps_func[DTRACE_FUNCNAMELEN];
char ftps_mod[DTRACE_MODNAMELEN];
#if defined(__APPLE__)
#if defined(__arm__) || defined(__arm64__)
// We already have 'padding' from the ftps_arch_subinfo above
#else
#if !defined(__LP64__)
uint32_t pad; /* Explicit pad to keep ILP32 and LP64 lined up. */
#endif
#endif
#endif
uint64_t ftps_pc;
uint64_t ftps_size;
uint64_t ftps_noffs;
uint64_t ftps_offs[1];
} fasttrap_probe_spec_t;
typedef struct fasttrap_instr_query {
uint64_t ftiq_pc;
pid_t ftiq_pid;
fasttrap_instr_t ftiq_instr;
} fasttrap_instr_query_t;
/*
* To support the fasttrap provider from very early in a process's life,
* the run-time linker, ld.so.1, has a program header of type PT_SUNWDTRACE
* which points to a data object which must be PT_SUNWDTRACE_SIZE bytes.
* This structure mimics the fasttrap provider section of the ulwp_t structure.
* When the fasttrap provider is changed to require new or different
* instructions, the data object in ld.so.1 and the thread initializers in libc
* (libc_init() and _thrp_create()) need to be updated to include the new
* instructions, and PT_SUNWDTRACE needs to be changed to a new unique number
* (while the old value gets assigned something like PT_SUNWDTRACE_1). Since the
* linker must be backward compatible with old Solaris releases, it must have
* program headers for each of the PT_SUNWDTRACE versions. The kernel's
* elfexec() function only has to look for the latest version of the
* PT_SUNWDTRACE program header.
*/
#define PT_SUNWDTRACE_SIZE FASTTRAP_SUNWDTRACE_SIZE
#ifdef __cplusplus
}
#endif
#endif /* _SYS_FASTTRAP_H */