3 .\" The DragonFly Project. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\" contributors may be used to endorse or promote products derived
17 .\" from this software without specific, prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" $DragonFly: src/share/man/man9/serializer.9,v 1.2 2007/04/03 09:14:33 swildner Exp $
38 .Nm lwkt_serialize_init ,
39 .Nm lwkt_serialize_enter ,
40 .Nm lwkt_serialize_try ,
41 .Nm lwkt_serialize_exit ,
42 .Nm lwkt_serialize_handler_enable ,
43 .Nm lwkt_serialize_handler_disable ,
44 .Nm lwkt_serialize_handler_call ,
45 .Nm lwkt_serialize_handler_try ,
47 .Nd generic low level serializer
51 .Fn lwkt_serialize_init "lwkt_serialize_t s"
53 .Fn lwkt_serialize_enter "lwkt_serialize_t s"
55 .Fn lwkt_serialize_try "lwkt_serialize_t s"
57 .Fn lwkt_serialize_exit "lwkt_serialize_t s"
59 .Fn lwkt_serialize_handler_enable "lwkt_serialize_t s"
61 .Fn lwkt_serialize_handler_disable "lwkt_serialize_t s"
63 .Fo lwkt_serialize_handler_call
64 .Fa "lwkt_serialize_t s"
65 .Fa "void (*func)(void *, void *)"
70 .Fo lwkt_serialize_handler_try
71 .Fa "lwkt_serialize_t s"
72 .Fa "void (*func)(void *, void *)"
76 .Fn ASSERT_SERIALIZED "s"
80 API provides a fast locked-bus-cycle-based serialization facility
81 that will serialize across blocking conditions.
82 It is very similar to a lock but much faster for the common case.
84 This API was initially designed to be a replacement for SPL calls, but
85 may be used whenever a low level exclusive lock (serialization) and/or
86 interrupt/device interaction is required.
87 Unlike tokens this serialization is not safe from deadlocks nor is it
88 recursive, and care must be taken when using it.
91 will not release a serializer that is being held.
93 There are two primary facilities \(em the serializer facility itself and
94 an integrated non-stackable interrupt handler disablement facility
97 .Fn lwkt_serialize_init ,
98 .Fn lwkt_serialize_enter
100 .Fn lwkt_serialize_exit
101 respectively initialize, hold and release the serializer
103 .Fn lwkt_serialize_try
104 is a non-blocking version of
105 .Fn lwkt_serialize_enter .
107 .Fn lwkt_serialize_handler_disable ,
108 .Fn lwkt_serialize_handler_enable
110 .Fn lwkt_serialize_handler_call
111 respectively disable, enable and call an interrupt handler
119 will be passed to the handler.
120 .Fn lwkt_serialize_handler_try
121 is a non-blocking version of
122 .Fn lwkt_serialize_handler_call .
125 .Fn ASSERT_SERIALIZED
126 macro asserts that the serializer
131 .Fn lwkt_serialize_try
133 .Fn lwkt_serialize_handler_try
134 functions return 0 on success and 1 on failure.
136 .Pa sys/kern/lwkt_serialize.c
143 API first appeared in
151 This manual page was written by