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