thread_state.h (2733B) - Raw
1 /* 2 * Copyright (c) 2015 Apple Computer, 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 #ifndef _MACH_THREAD_STATE_H_ 30 #define _MACH_THREAD_STATE_H_ 31 32 #include <Availability.h> 33 #include <mach/mach.h> 34 35 /* 36 * Gets all register values in the target thread with pointer-like contents. 37 * 38 * There is no guarantee that the returned values are valid pointers, but all 39 * valid pointers will be returned. The order and count of the provided 40 * register values is unspecified and may change; registers with values that 41 * are not valid pointers may be omitted, so the number of pointers returned 42 * may vary from call to call. 43 * 44 * sp is an out parameter that will contain the stack pointer. 45 * length is an in/out parameter for the length of the values array. 46 * values is an array of pointers. 47 * 48 * This may only be called on threads in the current task. If the current 49 * platform defines a stack red zone, the stack pointer returned will be 50 * adjusted to account for red zone. 51 * 52 * If length is insufficient, KERN_INSUFFICIENT_BUFFER_SIZE will be returned 53 * and length set to the amount of memory required. Callers MUST NOT assume 54 * that any particular size of buffer will be sufficient and should retry with 55 * an appropriately sized buffer upon this error. 56 */ 57 __API_AVAILABLE(macosx(10.14), ios(12.0), tvos(9.0), watchos(5.0)) 58 kern_return_t thread_get_register_pointer_values(thread_t thread, 59 uintptr_t *sp, size_t *length, uintptr_t *values); 60 61 #endif /* _MACH_THREAD_STATE_H_ */