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