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