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