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