xref: /xnu-8020.140.41/osfmk/kern/block_hint.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1 /*
2  * Copyright (c) 2000-2016 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 #ifndef _KERN_BLOCK_HINT_H_
30 #define _KERN_BLOCK_HINT_H_
31 
32 typedef enum thread_snapshot_wait_flags {
33 	kThreadWaitNone                 = 0x00,
34 	kThreadWaitKernelMutex          = 0x01,
35 	kThreadWaitPortReceive          = 0x02,
36 	kThreadWaitPortSetReceive       = 0x03,
37 	kThreadWaitPortSend             = 0x04,
38 	kThreadWaitPortSendInTransit    = 0x05,
39 	kThreadWaitSemaphore            = 0x06,
40 	kThreadWaitKernelRWLockRead     = 0x07,
41 	kThreadWaitKernelRWLockWrite    = 0x08,
42 	kThreadWaitKernelRWLockUpgrade  = 0x09,
43 	kThreadWaitUserLock             = 0x0a,
44 	kThreadWaitPThreadMutex         = 0x0b,
45 	kThreadWaitPThreadRWLockRead    = 0x0c,
46 	kThreadWaitPThreadRWLockWrite   = 0x0d,
47 	kThreadWaitPThreadCondVar       = 0x0e,
48 	kThreadWaitParkedWorkQueue      = 0x0f,
49 	kThreadWaitWorkloopSyncWait     = 0x10,
50 	kThreadWaitOnProcess            = 0x11,
51 	kThreadWaitSleepWithInheritor   = 0x12,
52 	kThreadWaitEventlink            = 0x13,
53 	kThreadWaitCompressor           = 0x14,
54 } __attribute__((packed)) block_hint_t;
55 
56 _Static_assert(sizeof(block_hint_t) <= sizeof(short),
57     "block_hint_t must fit within a short");
58 
59 #ifdef XNU_KERNEL_PRIVATE
60 
61 struct turnstile;
62 struct waitq;
63 typedef struct stackshot_thread_waitinfo thread_waitinfo_t;
64 struct ipc_service_port_label;
65 struct portlabel_info;
66 
67 /* Used for stackshot_thread_waitinfo_unsafe */
68 extern void kdp_lck_mtx_find_owner(struct waitq * waitq, event64_t event, thread_waitinfo_t *waitinfo);
69 extern void kdp_sema_find_owner(struct waitq * waitq, event64_t event, thread_waitinfo_t *waitinfo);
70 extern void kdp_mqueue_send_find_owner(struct waitq * waitq, event64_t event, thread_waitinfo_v2_t *waitinfo,
71     struct ipc_service_port_label **isplp);
72 extern void kdp_mqueue_recv_find_owner(struct waitq * waitq, event64_t event, thread_waitinfo_v2_t *waitinfo,
73     struct ipc_service_port_label **isplp);
74 extern void kdp_ulock_find_owner(struct waitq * waitq, event64_t event, thread_waitinfo_t *waitinfo);
75 extern void kdp_rwlck_find_owner(struct waitq * waitq, event64_t event, thread_waitinfo_t *waitinfo);
76 extern void kdp_pthread_find_owner(thread_t thread, thread_waitinfo_t *waitinfo);
77 extern void *kdp_pthread_get_thread_kwq(thread_t thread);
78 extern void kdp_workloop_sync_wait_find_owner(thread_t thread, event64_t event, thread_waitinfo_t *waitinfo);
79 extern void kdp_wait4_find_process(thread_t thread, event64_t event, thread_waitinfo_t *waitinfo);
80 extern void kdp_sleep_with_inheritor_find_owner(struct waitq * waitq, __unused event64_t event, thread_waitinfo_t * waitinfo);
81 extern void kdp_turnstile_fill_tsinfo(struct turnstile *ts, thread_turnstileinfo_v2_t *tsinfo, struct ipc_service_port_label **isplp);
82 extern void kdp_ipc_fill_splabel(struct ipc_service_port_label *ispl, struct portlabel_info *spl, const char **namep);
83 extern void kdp_ipc_splabel_size(size_t *ispl_size, size_t *maxnamelen);
84 extern const bool kdp_ipc_have_splabel;
85 void kdp_eventlink_find_owner(struct waitq *waitq, event64_t event, thread_waitinfo_t *waitinfo);
86 
87 #endif /* XNU_KERNEL_PRIVATE */
88 
89 #endif /* !_KERN_BLOCK_HINT_H_ */
90