1 /******************************************************************************
3 * Module Name: utlock - Reader/Writer lock interfaces
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2018, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME ("utlock")
52 /*******************************************************************************
54 * FUNCTION: AcpiUtCreateRwLock
57 * PARAMETERS: Lock - Pointer to a valid RW lock
61 * DESCRIPTION: Reader/writer lock creation and deletion interfaces.
63 ******************************************************************************/
73 Status
= AcpiOsCreateMutex (&Lock
->ReaderMutex
);
74 if (ACPI_FAILURE (Status
))
79 Status
= AcpiOsCreateMutex (&Lock
->WriterMutex
);
89 AcpiOsDeleteMutex (Lock
->ReaderMutex
);
90 AcpiOsDeleteMutex (Lock
->WriterMutex
);
93 Lock
->ReaderMutex
= NULL
;
94 Lock
->WriterMutex
= NULL
;
98 /*******************************************************************************
100 * FUNCTION: AcpiUtAcquireReadLock
101 * AcpiUtReleaseReadLock
103 * PARAMETERS: Lock - Pointer to a valid RW lock
107 * DESCRIPTION: Reader interfaces for reader/writer locks. On acquisition,
108 * only the first reader acquires the write mutex. On release,
109 * only the last reader releases the write mutex. Although this
110 * algorithm can in theory starve writers, this should not be a
111 * problem with ACPICA since the subsystem is infrequently used
112 * in comparison to (for example) an I/O system.
114 ******************************************************************************/
117 AcpiUtAcquireReadLock (
123 Status
= AcpiOsAcquireMutex (Lock
->ReaderMutex
, ACPI_WAIT_FOREVER
);
124 if (ACPI_FAILURE (Status
))
129 /* Acquire the write lock only for the first reader */
132 if (Lock
->NumReaders
== 1)
134 Status
= AcpiOsAcquireMutex (Lock
->WriterMutex
, ACPI_WAIT_FOREVER
);
137 AcpiOsReleaseMutex (Lock
->ReaderMutex
);
143 AcpiUtReleaseReadLock (
149 Status
= AcpiOsAcquireMutex (Lock
->ReaderMutex
, ACPI_WAIT_FOREVER
);
150 if (ACPI_FAILURE (Status
))
155 /* Release the write lock only for the very last reader */
158 if (Lock
->NumReaders
== 0)
160 AcpiOsReleaseMutex (Lock
->WriterMutex
);
163 AcpiOsReleaseMutex (Lock
->ReaderMutex
);
168 /*******************************************************************************
170 * FUNCTION: AcpiUtAcquireWriteLock
171 * AcpiUtReleaseWriteLock
173 * PARAMETERS: Lock - Pointer to a valid RW lock
177 * DESCRIPTION: Writer interfaces for reader/writer locks. Simply acquire or
178 * release the writer mutex associated with the lock. Acquisition
179 * of the lock is fully exclusive and will block all readers and
180 * writers until it is released.
182 ******************************************************************************/
185 AcpiUtAcquireWriteLock (
191 Status
= AcpiOsAcquireMutex (Lock
->WriterMutex
, ACPI_WAIT_FOREVER
);
197 AcpiUtReleaseWriteLock (
201 AcpiOsReleaseMutex (Lock
->WriterMutex
);