[apple/libpthread.git] / pthread / introspection.h

/*
 * Copyright (c) 2013, 2016 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef __PTHREAD_INTROSPECTION__
#define __PTHREAD_INTROSPECTION__

#include <sys/cdefs.h>
#include <pthread/pthread.h>
#include <Availability.h>

/*!
 * @header
 *
 * @abstract
 * Introspection API for libpthread.
 *
 * This should only be used for introspection and debugging tools.  Do not rely
 * on it in shipping code.
 */

__BEGIN_DECLS

/*!
 * @typedef pthread_introspection_hook_t
 *
 * @abstract
 * A function pointer called at various points in a PThread's lifetime.  The
 * function must be able to be called in contexts with invalid thread state.
 *
 * @param event
 * One of the events in pthread_introspection_event_t.
 *
 * @param thread
 * pthread_t associated with the event.
 *
 * @param addr
 * Address associated with the event, e.g. stack address.
 *
 * @param size
 * Size associated with the event, e.g. stack size.
 */
typedef void (*pthread_introspection_hook_t)(unsigned int event,
		pthread_t thread, void *addr, size_t size);

/*!
 * @enum pthread_introspection_event_t
 *
 * @constant PTHREAD_INTROSPECTION_THREAD_CREATE
 * pthread_t was created.
 *
 * @constant PTHREAD_INTROSPECTION_THREAD_START
 * Thread has started and stack was allocated.
 *
 * @constant PTHREAD_INTROSPECTION_THREAD_TERMINATE
 * Thread is about to be terminated and stack will be deallocated.
 *
 * @constant PTHREAD_INTROSPECTION_THREAD_DESTROY
 * pthread_t is about to be destroyed.
 */
enum {
	PTHREAD_INTROSPECTION_THREAD_CREATE = 1,
	PTHREAD_INTROSPECTION_THREAD_START,
	PTHREAD_INTROSPECTION_THREAD_TERMINATE,
	PTHREAD_INTROSPECTION_THREAD_DESTROY,
};

/*!
 * @function pthread_introspection_hook_install
 *
 * @abstract
 * Install introspection hook function into libpthread.
 *
 * @discussion
 * The caller is responsible for implementing chaining to the hook that was
 * previously installed (if any).
 *
 * @param hook
 * Pointer to hook function.
 *
 * @result
 * Previously installed hook function or NULL.
 */

__OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0)
__attribute__((__nonnull__, __warn_unused_result__))
extern pthread_introspection_hook_t
pthread_introspection_hook_install(pthread_introspection_hook_t hook);

__END_DECLS

#endif
Commit	Line	Data
2546420a A	1	/*
	2	* Copyright (c) 2013, 2016 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_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. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23
	24	#ifndef __PTHREAD_INTROSPECTION__
	25	#define __PTHREAD_INTROSPECTION__
	26
	27	#include <sys/cdefs.h>
	28	#include <pthread/pthread.h>
	29	#include <Availability.h>
	30
	31	/*!
	32	* @header
	33	*
	34	* @abstract
	35	* Introspection API for libpthread.
	36	*
	37	* This should only be used for introspection and debugging tools. Do not rely
	38	* on it in shipping code.
	39	*/
	40
	41	__BEGIN_DECLS
	42
	43	/*!
	44	* @typedef pthread_introspection_hook_t
	45	*
	46	* @abstract
	47	* A function pointer called at various points in a PThread's lifetime. The
	48	* function must be able to be called in contexts with invalid thread state.
	49	*
	50	* @param event
	51	* One of the events in pthread_introspection_event_t.
	52	*
	53	* @param thread
	54	* pthread_t associated with the event.
	55	*
	56	* @param addr
	57	* Address associated with the event, e.g. stack address.
	58	*
	59	* @param size
	60	* Size associated with the event, e.g. stack size.
	61	*/
	62	typedef void (*pthread_introspection_hook_t)(unsigned int event,
	63	pthread_t thread, void *addr, size_t size);
	64
65	/*!
66	* @enum pthread_introspection_event_t
67	*
68	* @constant PTHREAD_INTROSPECTION_THREAD_CREATE
69	* pthread_t was created.
70	*
71	* @constant PTHREAD_INTROSPECTION_THREAD_START
72	* Thread has started and stack was allocated.
73	*
74	* @constant PTHREAD_INTROSPECTION_THREAD_TERMINATE
75	* Thread is about to be terminated and stack will be deallocated.
76	*
77	* @constant PTHREAD_INTROSPECTION_THREAD_DESTROY
78	* pthread_t is about to be destroyed.
79	*/
80	enum {
81	PTHREAD_INTROSPECTION_THREAD_CREATE = 1,
82	PTHREAD_INTROSPECTION_THREAD_START,
83	PTHREAD_INTROSPECTION_THREAD_TERMINATE,
84	PTHREAD_INTROSPECTION_THREAD_DESTROY,
85	};
86
87	/*!
88	* @function pthread_introspection_hook_install
89	*
90	* @abstract
91	* Install introspection hook function into libpthread.
92	*
93	* @discussion
94	* The caller is responsible for implementing chaining to the hook that was
95	* previously installed (if any).
96	*
97	* @param hook
98	* Pointer to hook function.
99	*
100	* @result
101	* Previously installed hook function or NULL.
102	*/
103
104	__OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0)
105	__attribute__((__nonnull__, __warn_unused_result__))
106	extern pthread_introspection_hook_t
107	pthread_introspection_hook_install(pthread_introspection_hook_t hook);
108
109	__END_DECLS
110
111	#endif