xref: /xnu-10002.81.5/osfmk/man/lock_set_create.html (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions<h2>lock_set_create</h2>
2*5e3eaea3SApple OSS Distributions<hr>
3*5e3eaea3SApple OSS Distributions<p>
4*5e3eaea3SApple OSS Distributions<strong>Function</strong> - Create a new lock set.
5*5e3eaea3SApple OSS Distributions<h3>SYNOPSIS</h3>
6*5e3eaea3SApple OSS Distributions<pre>
7*5e3eaea3SApple OSS Distributions<strong>kern_return_t   lock_set_create</strong>
8*5e3eaea3SApple OSS Distributions                <strong>(task_t</strong>                                    <var>task</var>,
9*5e3eaea3SApple OSS Distributions                 <strong>lock_set_t</strong>                            <var>lock_set</var>,
10*5e3eaea3SApple OSS Distributions                 <strong>int</strong>                                      <var>locks</var>,
11*5e3eaea3SApple OSS Distributions                 <strong>int</strong>                                     <var>policy</var><strong>);</strong>
12*5e3eaea3SApple OSS Distributions</pre>
13*5e3eaea3SApple OSS Distributions<h3>PARAMETERS</h3>
14*5e3eaea3SApple OSS Distributions<dl>
15*5e3eaea3SApple OSS Distributions<p>
16*5e3eaea3SApple OSS Distributions<dt> <var>task</var>
17*5e3eaea3SApple OSS Distributions<dd>
18*5e3eaea3SApple OSS DistributionsThe task receiving the send right to the newly created lock set.
19*5e3eaea3SApple OSS Distributions<p>
20*5e3eaea3SApple OSS Distributions<dt> <var>lock_set</var>
21*5e3eaea3SApple OSS Distributions<dd>
22*5e3eaea3SApple OSS Distributions[out send right] The port naming the lock set which represents the lock.
23*5e3eaea3SApple OSS Distributions<p>
24*5e3eaea3SApple OSS Distributions<dt> <var>locks</var>
25*5e3eaea3SApple OSS Distributions<dd>
26*5e3eaea3SApple OSS Distributions[in scalar] The number of locks the lock set will represent (must be a positive value).
27*5e3eaea3SApple OSS Distributions<p>
28*5e3eaea3SApple OSS Distributions<dt> <var>policy</var>
29*5e3eaea3SApple OSS Distributions<dd>
30*5e3eaea3SApple OSS Distributions[in scalar] The blocked thread wakeup policy for the newly created lock set. Valid policies are:
31*5e3eaea3SApple OSS Distributions     <dl>
32*5e3eaea3SApple OSS Distributions<p>
33*5e3eaea3SApple OSS Distributions<dt> SYNC_POLICY_FIFO
34*5e3eaea3SApple OSS Distributions<dd>
35*5e3eaea3SApple OSS Distributionsa first-in-first-out policy for scheduling thread wakeup.
36*5e3eaea3SApple OSS Distributions<p>
37*5e3eaea3SApple OSS Distributions<dt> SYNC_POLICY_FIXED_PRIORITY
38*5e3eaea3SApple OSS Distributions<dd>
39*5e3eaea3SApple OSS Distributionsa fixed priority policy for scheduling thread wakeup.
40*5e3eaea3SApple OSS Distributions</dl>
41*5e3eaea3SApple OSS Distributions</dl>
42*5e3eaea3SApple OSS Distributions<h3>DESCRIPTION</h3>
43*5e3eaea3SApple OSS Distributions<p>
44*5e3eaea3SApple OSS DistributionsThe <strong>lock_set_create</strong> function creates a new lock set representing a
45*5e3eaea3SApple OSS Distributionscollection of associated locks. The lock set is associated with the
46*5e3eaea3SApple OSS Distributionsspecified task. A send right naming the lock set is returned to the
47*5e3eaea3SApple OSS Distributionscaller.
48*5e3eaea3SApple OSS Distributions<h3>RETURN VALUES</h3>
49*5e3eaea3SApple OSS Distributions<dl>
50*5e3eaea3SApple OSS Distributions<p>
51*5e3eaea3SApple OSS Distributions<dt> <strong>KERN_SUCCESS</strong>
52*5e3eaea3SApple OSS Distributions<dd>
53*5e3eaea3SApple OSS DistributionsThe lock set was created.
54*5e3eaea3SApple OSS Distributions<p>
55*5e3eaea3SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong>
56*5e3eaea3SApple OSS Distributions<dd>
57*5e3eaea3SApple OSS DistributionsEither the task or policy argument is invalid, or the locks argument
58*5e3eaea3SApple OSS Distributionshas a value that is less than or equal to zero.
59*5e3eaea3SApple OSS Distributions<p>
60*5e3eaea3SApple OSS Distributions<dt> <strong>KERN_RESOURCE_SHORTAGE</strong>
61*5e3eaea3SApple OSS Distributions<dd>
62*5e3eaea3SApple OSS DistributionsThe kernel could not allocate the lock set.
63*5e3eaea3SApple OSS Distributions</dl>
64*5e3eaea3SApple OSS Distributions<h3>RELATED INFORMATION</h3>
65*5e3eaea3SApple OSS Distributions<p>
66*5e3eaea3SApple OSS DistributionsFunctions:
67*5e3eaea3SApple OSS Distributions<a href="lock_acquire.html"><strong>lock_acquire</strong></a>,
68*5e3eaea3SApple OSS Distributions<a href="lock_make_stable.html"><strong>lock_make_stable</strong></a>,
69*5e3eaea3SApple OSS Distributions<a href="lock_try.html"><strong>lock_try</strong></a>,
70*5e3eaea3SApple OSS Distributions<a href="lock_handoff.html"><strong>lock_handoff</strong></a>,
71*5e3eaea3SApple OSS Distributions<a href="lock_handoff_accept.html"><strong>lock_handoff_accept</strong></a>,
72*5e3eaea3SApple OSS Distributions<a href="lock_try.html"><strong>lock_try</strong></a>,
73*5e3eaea3SApple OSS Distributions<a href="lock_set_destroy.html"><strong>lock_set_destroy</strong></a>.
74