xref: /xnu-11215.1.10/libsyscall/mach/mach_eventlink.c (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1*8d741a5dSApple OSS Distributions /*
2*8d741a5dSApple OSS Distributions  * Copyright (c) 2019 Apple Computer, Inc. All rights reserved.
3*8d741a5dSApple OSS Distributions  *
4*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*8d741a5dSApple OSS Distributions  *
6*8d741a5dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*8d741a5dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*8d741a5dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*8d741a5dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*8d741a5dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*8d741a5dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*8d741a5dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*8d741a5dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*8d741a5dSApple OSS Distributions  *
15*8d741a5dSApple OSS Distributions  * Please obtain a copy of the License at
16*8d741a5dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*8d741a5dSApple OSS Distributions  *
18*8d741a5dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*8d741a5dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*8d741a5dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*8d741a5dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*8d741a5dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*8d741a5dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*8d741a5dSApple OSS Distributions  * limitations under the License.
25*8d741a5dSApple OSS Distributions  *
26*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*8d741a5dSApple OSS Distributions  */
28*8d741a5dSApple OSS Distributions 
29*8d741a5dSApple OSS Distributions #include <mach/boolean.h>
30*8d741a5dSApple OSS Distributions #include <mach/message.h>
31*8d741a5dSApple OSS Distributions #include <mach/kern_return.h>
32*8d741a5dSApple OSS Distributions #include <mach/mach_traps.h>
33*8d741a5dSApple OSS Distributions #include <mach/mach_types.h>
34*8d741a5dSApple OSS Distributions #include <mach/clock_types.h>
35*8d741a5dSApple OSS Distributions #include <mach/mach_eventlink_types.h>
36*8d741a5dSApple OSS Distributions 
37*8d741a5dSApple OSS Distributions /*
38*8d741a5dSApple OSS Distributions  * __mach_eventlink* calls are bsd syscalls instead of mach traps because
39*8d741a5dSApple OSS Distributions  * they need to return a 64 bit value in register and mach traps currently
40*8d741a5dSApple OSS Distributions  * does not allow 64 bit return values.
41*8d741a5dSApple OSS Distributions  */
42*8d741a5dSApple OSS Distributions uint64_t
43*8d741a5dSApple OSS Distributions __mach_eventlink_signal(
44*8d741a5dSApple OSS Distributions 	mach_port_t         eventlink_port,
45*8d741a5dSApple OSS Distributions 	uint64_t            signal_count);
46*8d741a5dSApple OSS Distributions 
47*8d741a5dSApple OSS Distributions uint64_t
48*8d741a5dSApple OSS Distributions __mach_eventlink_wait_until(
49*8d741a5dSApple OSS Distributions 	mach_port_t                          eventlink_port,
50*8d741a5dSApple OSS Distributions 	uint64_t                             wait_signal_count,
51*8d741a5dSApple OSS Distributions 	uint64_t                             deadline,
52*8d741a5dSApple OSS Distributions 	kern_clock_id_t                      clock_id,
53*8d741a5dSApple OSS Distributions 	mach_eventlink_signal_wait_option_t  option);
54*8d741a5dSApple OSS Distributions 
55*8d741a5dSApple OSS Distributions uint64_t
56*8d741a5dSApple OSS Distributions __mach_eventlink_signal_wait_until(
57*8d741a5dSApple OSS Distributions 	mach_port_t                          eventlink_port,
58*8d741a5dSApple OSS Distributions 	uint64_t                             wait_count,
59*8d741a5dSApple OSS Distributions 	uint64_t                             signal_count,
60*8d741a5dSApple OSS Distributions 	uint64_t                             deadline,
61*8d741a5dSApple OSS Distributions 	kern_clock_id_t                      clock_id,
62*8d741a5dSApple OSS Distributions 	mach_eventlink_signal_wait_option_t  option);
63*8d741a5dSApple OSS Distributions 
64*8d741a5dSApple OSS Distributions kern_return_t
mach_eventlink_signal(mach_port_t eventlink_port,uint64_t signal_count)65*8d741a5dSApple OSS Distributions mach_eventlink_signal(
66*8d741a5dSApple OSS Distributions 	mach_port_t         eventlink_port,
67*8d741a5dSApple OSS Distributions 	uint64_t            signal_count)
68*8d741a5dSApple OSS Distributions {
69*8d741a5dSApple OSS Distributions 	uint64_t retval = __mach_eventlink_signal(eventlink_port, signal_count);
70*8d741a5dSApple OSS Distributions 
71*8d741a5dSApple OSS Distributions 	return decode_eventlink_error_from_retval(retval);
72*8d741a5dSApple OSS Distributions }
73*8d741a5dSApple OSS Distributions 
74*8d741a5dSApple OSS Distributions kern_return_t
mach_eventlink_wait_until(mach_port_t eventlink_port,uint64_t * wait_count_ptr,mach_eventlink_signal_wait_option_t option,kern_clock_id_t clock_id,uint64_t deadline)75*8d741a5dSApple OSS Distributions mach_eventlink_wait_until(
76*8d741a5dSApple OSS Distributions 	mach_port_t                          eventlink_port,
77*8d741a5dSApple OSS Distributions 	uint64_t                             *wait_count_ptr,
78*8d741a5dSApple OSS Distributions 	mach_eventlink_signal_wait_option_t  option,
79*8d741a5dSApple OSS Distributions 	kern_clock_id_t                      clock_id,
80*8d741a5dSApple OSS Distributions 	uint64_t                             deadline)
81*8d741a5dSApple OSS Distributions {
82*8d741a5dSApple OSS Distributions 	uint64_t retval;
83*8d741a5dSApple OSS Distributions 
84*8d741a5dSApple OSS Distributions 	retval = __mach_eventlink_wait_until(eventlink_port, *wait_count_ptr,
85*8d741a5dSApple OSS Distributions 	    deadline, clock_id, option);
86*8d741a5dSApple OSS Distributions 
87*8d741a5dSApple OSS Distributions 	*wait_count_ptr = decode_eventlink_count_from_retval(retval);
88*8d741a5dSApple OSS Distributions 	return decode_eventlink_error_from_retval(retval);
89*8d741a5dSApple OSS Distributions }
90*8d741a5dSApple OSS Distributions 
91*8d741a5dSApple OSS Distributions kern_return_t
mach_eventlink_signal_wait_until(mach_port_t eventlink_port,uint64_t * wait_count_ptr,uint64_t signal_count,mach_eventlink_signal_wait_option_t option,kern_clock_id_t clock_id,uint64_t deadline)92*8d741a5dSApple OSS Distributions mach_eventlink_signal_wait_until(
93*8d741a5dSApple OSS Distributions 	mach_port_t                          eventlink_port,
94*8d741a5dSApple OSS Distributions 	uint64_t                             *wait_count_ptr,
95*8d741a5dSApple OSS Distributions 	uint64_t                             signal_count,
96*8d741a5dSApple OSS Distributions 	mach_eventlink_signal_wait_option_t  option,
97*8d741a5dSApple OSS Distributions 	kern_clock_id_t                      clock_id,
98*8d741a5dSApple OSS Distributions 	uint64_t                             deadline)
99*8d741a5dSApple OSS Distributions {
100*8d741a5dSApple OSS Distributions 	uint64_t retval;
101*8d741a5dSApple OSS Distributions 	retval = __mach_eventlink_signal_wait_until(eventlink_port, *wait_count_ptr,
102*8d741a5dSApple OSS Distributions 	    signal_count, deadline, clock_id, option);
103*8d741a5dSApple OSS Distributions 	*wait_count_ptr = decode_eventlink_count_from_retval(retval);
104*8d741a5dSApple OSS Distributions 	return decode_eventlink_error_from_retval(retval);
105*8d741a5dSApple OSS Distributions }
106