1 /******************************************************************************* 2 * 3 * Module Name: utownerid - Support for Table/Method Owner IDs 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #include "acpi.h" 117 #include "accommon.h" 118 #include "acnamesp.h" 119 120 121 #define _COMPONENT ACPI_UTILITIES 122 ACPI_MODULE_NAME ("utownerid") 123 124 125 /******************************************************************************* 126 * 127 * FUNCTION: AcpiUtAllocateOwnerId 128 * 129 * PARAMETERS: OwnerId - Where the new owner ID is returned 130 * 131 * RETURN: Status 132 * 133 * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to 134 * track objects created by the table or method, to be deleted 135 * when the method exits or the table is unloaded. 136 * 137 ******************************************************************************/ 138 139 ACPI_STATUS 140 AcpiUtAllocateOwnerId ( 141 ACPI_OWNER_ID *OwnerId) 142 { 143 UINT32 i; 144 UINT32 j; 145 UINT32 k; 146 ACPI_STATUS Status; 147 148 149 ACPI_FUNCTION_TRACE (UtAllocateOwnerId); 150 151 152 /* Guard against multiple allocations of ID to the same location */ 153 154 if (*OwnerId) 155 { 156 ACPI_ERROR ((AE_INFO, 157 "Owner ID [0x%2.2X] already exists", *OwnerId)); 158 return_ACPI_STATUS (AE_ALREADY_EXISTS); 159 } 160 161 /* Mutex for the global ID mask */ 162 163 Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES); 164 if (ACPI_FAILURE (Status)) 165 { 166 return_ACPI_STATUS (Status); 167 } 168 169 /* 170 * Find a free owner ID, cycle through all possible IDs on repeated 171 * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index 172 * may have to be scanned twice. 173 */ 174 for (i = 0, j = AcpiGbl_LastOwnerIdIndex; 175 i < (ACPI_NUM_OWNERID_MASKS + 1); 176 i++, j++) 177 { 178 if (j >= ACPI_NUM_OWNERID_MASKS) 179 { 180 j = 0; /* Wraparound to start of mask array */ 181 } 182 183 for (k = AcpiGbl_NextOwnerIdOffset; k < 32; k++) 184 { 185 if (AcpiGbl_OwnerIdMask[j] == ACPI_UINT32_MAX) 186 { 187 /* There are no free IDs in this mask */ 188 189 break; 190 } 191 192 if (!(AcpiGbl_OwnerIdMask[j] & (1 << k))) 193 { 194 /* 195 * Found a free ID. The actual ID is the bit index plus one, 196 * making zero an invalid Owner ID. Save this as the last ID 197 * allocated and update the global ID mask. 198 */ 199 AcpiGbl_OwnerIdMask[j] |= (1 << k); 200 201 AcpiGbl_LastOwnerIdIndex = (UINT8) j; 202 AcpiGbl_NextOwnerIdOffset = (UINT8) (k + 1); 203 204 /* 205 * Construct encoded ID from the index and bit position 206 * 207 * Note: Last [j].k (bit 255) is never used and is marked 208 * permanently allocated (prevents +1 overflow) 209 */ 210 *OwnerId = (ACPI_OWNER_ID) ((k + 1) + ACPI_MUL_32 (j)); 211 212 ACPI_DEBUG_PRINT ((ACPI_DB_VALUES, 213 "Allocated OwnerId: %2.2X\n", (unsigned int) *OwnerId)); 214 goto Exit; 215 } 216 } 217 218 AcpiGbl_NextOwnerIdOffset = 0; 219 } 220 221 /* 222 * All OwnerIds have been allocated. This typically should 223 * not happen since the IDs are reused after deallocation. The IDs are 224 * allocated upon table load (one per table) and method execution, and 225 * they are released when a table is unloaded or a method completes 226 * execution. 227 * 228 * If this error happens, there may be very deep nesting of invoked 229 * control methods, or there may be a bug where the IDs are not released. 230 */ 231 Status = AE_OWNER_ID_LIMIT; 232 ACPI_ERROR ((AE_INFO, 233 "Could not allocate new OwnerId (255 max), AE_OWNER_ID_LIMIT")); 234 235 Exit: 236 (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES); 237 return_ACPI_STATUS (Status); 238 } 239 240 241 /******************************************************************************* 242 * 243 * FUNCTION: AcpiUtReleaseOwnerId 244 * 245 * PARAMETERS: OwnerIdPtr - Pointer to a previously allocated OwnerID 246 * 247 * RETURN: None. No error is returned because we are either exiting a 248 * control method or unloading a table. Either way, we would 249 * ignore any error anyway. 250 * 251 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255 252 * 253 ******************************************************************************/ 254 255 void 256 AcpiUtReleaseOwnerId ( 257 ACPI_OWNER_ID *OwnerIdPtr) 258 { 259 ACPI_OWNER_ID OwnerId = *OwnerIdPtr; 260 ACPI_STATUS Status; 261 UINT32 Index; 262 UINT32 Bit; 263 264 265 ACPI_FUNCTION_TRACE_U32 (UtReleaseOwnerId, OwnerId); 266 267 268 /* Always clear the input OwnerId (zero is an invalid ID) */ 269 270 *OwnerIdPtr = 0; 271 272 /* Zero is not a valid OwnerID */ 273 274 if (OwnerId == 0) 275 { 276 ACPI_ERROR ((AE_INFO, "Invalid OwnerId: 0x%2.2X", OwnerId)); 277 return_VOID; 278 } 279 280 /* Mutex for the global ID mask */ 281 282 Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES); 283 if (ACPI_FAILURE (Status)) 284 { 285 return_VOID; 286 } 287 288 /* Normalize the ID to zero */ 289 290 OwnerId--; 291 292 /* Decode ID to index/offset pair */ 293 294 Index = ACPI_DIV_32 (OwnerId); 295 Bit = 1 << ACPI_MOD_32 (OwnerId); 296 297 /* Free the owner ID only if it is valid */ 298 299 if (AcpiGbl_OwnerIdMask[Index] & Bit) 300 { 301 AcpiGbl_OwnerIdMask[Index] ^= Bit; 302 } 303 else 304 { 305 ACPI_ERROR ((AE_INFO, 306 "Release of non-allocated OwnerId: 0x%2.2X", OwnerId + 1)); 307 } 308 309 (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES); 310 return_VOID; 311 } 312