xref: /xnu-10002.81.5/osfmk/man/semaphore_create.html (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions<h2>semaphore_create</h2>
2*5e3eaea3SApple OSS Distributions<hr>
3*5e3eaea3SApple OSS Distributions<p>
4*5e3eaea3SApple OSS Distributions<strong>Function</strong> - Create a new semaphore.
5*5e3eaea3SApple OSS Distributions<h3>SYNOPSIS</h3>
6*5e3eaea3SApple OSS Distributions<pre>
7*5e3eaea3SApple OSS Distributions<strong>kern_return_t	semaphore_create</strong>
8*5e3eaea3SApple OSS Distributions		<strong>(task_t</strong>                   <var>task</var>,
9*5e3eaea3SApple OSS Distributions		 <strong>semaphore_t</strong>        <var>*semaphore</var>,
10*5e3eaea3SApple OSS Distributions		 <strong>int</strong>                    <var>policy</var>,
11*5e3eaea3SApple OSS Distributions		 <strong>int</strong>                     <var>value</var><strong>);</strong>
12*5e3eaea3SApple OSS Distributions</pre>
13*5e3eaea3SApple OSS Distributions<h3>PARAMETERS</h3>
14*5e3eaea3SApple OSS Distributions<dl>
15*5e3eaea3SApple OSS Distributions<dt> <var>task</var>
16*5e3eaea3SApple OSS Distributions<dd>
17*5e3eaea3SApple OSS Distributions[in task port] The task receiving the send right of the newly created semaphore.
18*5e3eaea3SApple OSS Distributions<p>
19*5e3eaea3SApple OSS Distributions<dt> <var>semaphore</var>
20*5e3eaea3SApple OSS Distributions<dd>
21*5e3eaea3SApple OSS Distributions[out send right] The port naming the created semaphore.
22*5e3eaea3SApple OSS Distributions<p>
23*5e3eaea3SApple OSS Distributions<dt> <var>policy</var>
24*5e3eaea3SApple OSS Distributions<dd>
25*5e3eaea3SApple OSS Distributions[in scalar] The blocked thread wakeup policy for the newly created semaphore. Valid policies are:
26*5e3eaea3SApple OSS Distributions<dl>
27*5e3eaea3SApple OSS Distributions<p>
28*5e3eaea3SApple OSS Distributions  <dt> SYNC_POLICY_FIFO
29*5e3eaea3SApple OSS Distributions<dd>
30*5e3eaea3SApple OSS Distributionsa first-in-first-out policy for scheduling thread wakeup.
31*5e3eaea3SApple OSS Distributions     <p>
32*5e3eaea3SApple OSS Distributions  <dt> SYNC_POLICY_FIXED_PRIORITY
33*5e3eaea3SApple OSS Distributions<dd>
34*5e3eaea3SApple OSS Distributionsa fixed priority policy for scheduling thread wakeup.
35*5e3eaea3SApple OSS Distributions     </dl>
36*5e3eaea3SApple OSS Distributions     <p>
37*5e3eaea3SApple OSS Distributions<dt> <var>value</var>
38*5e3eaea3SApple OSS Distributions<dd>
39*5e3eaea3SApple OSS Distributions[in scalar] The initial value of the semaphore count.
40*5e3eaea3SApple OSS Distributions</dl>
41*5e3eaea3SApple OSS Distributions<h3>DESCRIPTION</h3>
42*5e3eaea3SApple OSS Distributions<p>
43*5e3eaea3SApple OSS DistributionsThe <strong>semaphore_create</strong> function creates a new semaphore, associates the
44*5e3eaea3SApple OSS Distributionscreated semaphore with the specified task, and returns a send right
45*5e3eaea3SApple OSS Distributionsnaming the new semaphore.  In order to support a robust
46*5e3eaea3SApple OSS Distributionsproducer/consumer communication service, Interrupt Service Routines
47*5e3eaea3SApple OSS Distributions(ISR) must be able to signal semaphores. The semaphore synchronizer
48*5e3eaea3SApple OSS Distributionsservice is designed to allow user-level device drivers to perform
49*5e3eaea3SApple OSS Distributionssignal operations, eliminating the need for event counters.  Device
50*5e3eaea3SApple OSS Distributionsdrivers which utilize semaphores are responsible for creating (via
51*5e3eaea3SApple OSS Distributions<strong>semaphore_create</strong>) and exporting (via <strong>device_get_status</strong>)
52*5e3eaea3SApple OSS Distributionssemaphores for
53*5e3eaea3SApple OSS Distributionsuser level access. Device driver semaphore creation is done at device
54*5e3eaea3SApple OSS Distributionsinitialization time. Device drivers may support multiple semaphores.
55*5e3eaea3SApple OSS Distributions<h3>RETURN VALUES</h3>
56*5e3eaea3SApple OSS Distributions<dl>
57*5e3eaea3SApple OSS Distributions  <p>
58*5e3eaea3SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong>
59*5e3eaea3SApple OSS Distributions<dd>
60*5e3eaea3SApple OSS DistributionsThe task argument or the policy argument was invalid,
61*5e3eaea3SApple OSS Distributions     or the initial value of the semaphore was invalid.
62*5e3eaea3SApple OSS Distributions     <p>
63*5e3eaea3SApple OSS Distributions<dt> <strong>KERN_RESOURCE_SHORTAGE</strong>
64*5e3eaea3SApple OSS Distributions<dd>
65*5e3eaea3SApple OSS DistributionsThe kernel could not allocate the semaphore.
66*5e3eaea3SApple OSS Distributions     <p>
67*5e3eaea3SApple OSS Distributions<dt> <strong>KERN_SUCCESS</strong>
68*5e3eaea3SApple OSS Distributions<dd>
69*5e3eaea3SApple OSS DistributionsThe semaphore was successfully created.
70*5e3eaea3SApple OSS Distributions</dl>
71*5e3eaea3SApple OSS Distributions<h3>RELATED INFORMATION</h3>
72*5e3eaea3SApple OSS Distributions<p>
73*5e3eaea3SApple OSS DistributionsFunctions:
74*5e3eaea3SApple OSS Distributions<a href="semaphore_destroy.html"><strong>semaphore_destroy</strong></a>,
75*5e3eaea3SApple OSS Distributions<a href="semaphore_signal.html"><strong>semaphore_signal</strong></a>,
76*5e3eaea3SApple OSS Distributions<a href="semaphore_signal_all.html"><strong>semaphore_signal_all</strong></a>,
77*5e3eaea3SApple OSS Distributions<a href="semaphore_wait.html"><strong>semaphore_wait</strong></a>,
78*5e3eaea3SApple OSS Distributions<a href="device_get_status.html"><strong>device_get_status</strong></a>.
79