1 /******************************************************************************* 2 * 3 * Module Name: nsnames - Name manipulation and search 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/amlcode.h> 155 #include <contrib/dev/acpica/include/acnamesp.h> 156 157 158 #define _COMPONENT ACPI_NAMESPACE 159 ACPI_MODULE_NAME ("nsnames") 160 161 162 /******************************************************************************* 163 * 164 * FUNCTION: AcpiNsGetExternalPathname 165 * 166 * PARAMETERS: Node - Namespace node whose pathname is needed 167 * 168 * RETURN: Pointer to storage containing the fully qualified name of 169 * the node, In external format (name segments separated by path 170 * separators.) 171 * 172 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually 173 * for error and debug statements. 174 * 175 ******************************************************************************/ 176 177 char * 178 AcpiNsGetExternalPathname ( 179 ACPI_NAMESPACE_NODE *Node) 180 { 181 char *NameBuffer; 182 183 184 ACPI_FUNCTION_TRACE_PTR (NsGetExternalPathname, Node); 185 186 187 NameBuffer = AcpiNsGetNormalizedPathname (Node, FALSE); 188 return_PTR (NameBuffer); 189 } 190 191 192 /******************************************************************************* 193 * 194 * FUNCTION: AcpiNsGetPathnameLength 195 * 196 * PARAMETERS: Node - Namespace node 197 * 198 * RETURN: Length of path, including prefix 199 * 200 * DESCRIPTION: Get the length of the pathname string for this node 201 * 202 ******************************************************************************/ 203 204 ACPI_SIZE 205 AcpiNsGetPathnameLength ( 206 ACPI_NAMESPACE_NODE *Node) 207 { 208 ACPI_SIZE Size; 209 210 211 ACPI_FUNCTION_ENTRY (); 212 213 214 Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, FALSE); 215 return (Size); 216 } 217 218 219 /******************************************************************************* 220 * 221 * FUNCTION: AcpiNsHandleToName 222 * 223 * PARAMETERS: TargetHandle - Handle of named object whose name is 224 * to be found 225 * Buffer - Where the name is returned 226 * 227 * RETURN: Status, Buffer is filled with name if status is AE_OK 228 * 229 * DESCRIPTION: Build and return a full namespace name 230 * 231 ******************************************************************************/ 232 233 ACPI_STATUS 234 AcpiNsHandleToName ( 235 ACPI_HANDLE TargetHandle, 236 ACPI_BUFFER *Buffer) 237 { 238 ACPI_STATUS Status; 239 ACPI_NAMESPACE_NODE *Node; 240 const char *NodeName; 241 242 243 ACPI_FUNCTION_TRACE_PTR (NsHandleToName, TargetHandle); 244 245 246 Node = AcpiNsValidateHandle (TargetHandle); 247 if (!Node) 248 { 249 return_ACPI_STATUS (AE_BAD_PARAMETER); 250 } 251 252 /* Validate/Allocate/Clear caller buffer */ 253 254 Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH); 255 if (ACPI_FAILURE (Status)) 256 { 257 return_ACPI_STATUS (Status); 258 } 259 260 /* Just copy the ACPI name from the Node and zero terminate it */ 261 262 NodeName = AcpiUtGetNodeName (Node); 263 ACPI_MOVE_NAME (Buffer->Pointer, NodeName); 264 ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0; 265 266 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%4.4s\n", (char *) Buffer->Pointer)); 267 return_ACPI_STATUS (AE_OK); 268 } 269 270 271 /******************************************************************************* 272 * 273 * FUNCTION: AcpiNsHandleToPathname 274 * 275 * PARAMETERS: TargetHandle - Handle of named object whose name is 276 * to be found 277 * Buffer - Where the pathname is returned 278 * NoTrailing - Remove trailing '_' for each name 279 * segment 280 * 281 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 282 * 283 * DESCRIPTION: Build and return a full namespace pathname 284 * 285 ******************************************************************************/ 286 287 ACPI_STATUS 288 AcpiNsHandleToPathname ( 289 ACPI_HANDLE TargetHandle, 290 ACPI_BUFFER *Buffer, 291 BOOLEAN NoTrailing) 292 { 293 ACPI_STATUS Status; 294 ACPI_NAMESPACE_NODE *Node; 295 ACPI_SIZE RequiredSize; 296 297 298 ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle); 299 300 301 Node = AcpiNsValidateHandle (TargetHandle); 302 if (!Node) 303 { 304 return_ACPI_STATUS (AE_BAD_PARAMETER); 305 } 306 307 /* Determine size required for the caller buffer */ 308 309 RequiredSize = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing); 310 if (!RequiredSize) 311 { 312 return_ACPI_STATUS (AE_BAD_PARAMETER); 313 } 314 315 /* Validate/Allocate/Clear caller buffer */ 316 317 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize); 318 if (ACPI_FAILURE (Status)) 319 { 320 return_ACPI_STATUS (Status); 321 } 322 323 /* Build the path in the caller buffer */ 324 325 (void) AcpiNsBuildNormalizedPath (Node, Buffer->Pointer, 326 RequiredSize, NoTrailing); 327 if (ACPI_FAILURE (Status)) 328 { 329 return_ACPI_STATUS (Status); 330 } 331 332 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n", 333 (char *) Buffer->Pointer, (UINT32) RequiredSize)); 334 return_ACPI_STATUS (AE_OK); 335 } 336 337 338 /******************************************************************************* 339 * 340 * FUNCTION: AcpiNsBuildNormalizedPath 341 * 342 * PARAMETERS: Node - Namespace node 343 * FullPath - Where the path name is returned 344 * PathSize - Size of returned path name buffer 345 * NoTrailing - Remove trailing '_' from each name segment 346 * 347 * RETURN: Return 1 if the AML path is empty, otherwise returning (length 348 * of pathname + 1) which means the 'FullPath' contains a trailing 349 * null. 350 * 351 * DESCRIPTION: Build and return a full namespace pathname. 352 * Note that if the size of 'FullPath' isn't large enough to 353 * contain the namespace node's path name, the actual required 354 * buffer length is returned, and it should be greater than 355 * 'PathSize'. So callers are able to check the returning value 356 * to determine the buffer size of 'FullPath'. 357 * 358 ******************************************************************************/ 359 360 UINT32 361 AcpiNsBuildNormalizedPath ( 362 ACPI_NAMESPACE_NODE *Node, 363 char *FullPath, 364 UINT32 PathSize, 365 BOOLEAN NoTrailing) 366 { 367 UINT32 Length = 0, i; 368 char Name[ACPI_NAME_SIZE]; 369 BOOLEAN DoNoTrailing; 370 char c, *Left, *Right; 371 ACPI_NAMESPACE_NODE *NextNode; 372 373 374 ACPI_FUNCTION_TRACE_PTR (NsBuildNormalizedPath, Node); 375 376 377 #define ACPI_PATH_PUT8(Path, Size, Byte, Length) \ 378 do { \ 379 if ((Length) < (Size)) \ 380 { \ 381 (Path)[(Length)] = (Byte); \ 382 } \ 383 (Length)++; \ 384 } while (0) 385 386 /* 387 * Make sure the PathSize is correct, so that we don't need to 388 * validate both FullPath and PathSize. 389 */ 390 if (!FullPath) 391 { 392 PathSize = 0; 393 } 394 395 if (!Node) 396 { 397 goto BuildTrailingNull; 398 } 399 400 NextNode = Node; 401 while (NextNode && NextNode != AcpiGbl_RootNode) 402 { 403 if (NextNode != Node) 404 { 405 ACPI_PATH_PUT8(FullPath, PathSize, AML_DUAL_NAME_PREFIX, Length); 406 } 407 408 ACPI_MOVE_32_TO_32 (Name, &NextNode->Name); 409 DoNoTrailing = NoTrailing; 410 for (i = 0; i < 4; i++) 411 { 412 c = Name[4-i-1]; 413 if (DoNoTrailing && c != '_') 414 { 415 DoNoTrailing = FALSE; 416 } 417 if (!DoNoTrailing) 418 { 419 ACPI_PATH_PUT8(FullPath, PathSize, c, Length); 420 } 421 } 422 423 NextNode = NextNode->Parent; 424 } 425 426 ACPI_PATH_PUT8(FullPath, PathSize, AML_ROOT_PREFIX, Length); 427 428 /* Reverse the path string */ 429 430 if (Length <= PathSize) 431 { 432 Left = FullPath; 433 Right = FullPath+Length - 1; 434 435 while (Left < Right) 436 { 437 c = *Left; 438 *Left++ = *Right; 439 *Right-- = c; 440 } 441 } 442 443 /* Append the trailing null */ 444 445 BuildTrailingNull: 446 ACPI_PATH_PUT8 (FullPath, PathSize, '\0', Length); 447 448 #undef ACPI_PATH_PUT8 449 450 return_UINT32 (Length); 451 } 452 453 454 /******************************************************************************* 455 * 456 * FUNCTION: AcpiNsGetNormalizedPathname 457 * 458 * PARAMETERS: Node - Namespace node whose pathname is needed 459 * NoTrailing - Remove trailing '_' from each name segment 460 * 461 * RETURN: Pointer to storage containing the fully qualified name of 462 * the node, In external format (name segments separated by path 463 * separators.) 464 * 465 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually 466 * for error and debug statements. All trailing '_' will be 467 * removed from the full pathname if 'NoTrailing' is specified.. 468 * 469 ******************************************************************************/ 470 471 char * 472 AcpiNsGetNormalizedPathname ( 473 ACPI_NAMESPACE_NODE *Node, 474 BOOLEAN NoTrailing) 475 { 476 char *NameBuffer; 477 ACPI_SIZE Size; 478 479 480 ACPI_FUNCTION_TRACE_PTR (NsGetNormalizedPathname, Node); 481 482 483 /* Calculate required buffer size based on depth below root */ 484 485 Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing); 486 if (!Size) 487 { 488 return_PTR (NULL); 489 } 490 491 /* Allocate a buffer to be returned to caller */ 492 493 NameBuffer = ACPI_ALLOCATE_ZEROED (Size); 494 if (!NameBuffer) 495 { 496 ACPI_ERROR ((AE_INFO, 497 "Could not allocate %u bytes", (UINT32) Size)); 498 return_PTR (NULL); 499 } 500 501 /* Build the path in the allocated buffer */ 502 503 (void) AcpiNsBuildNormalizedPath (Node, NameBuffer, Size, NoTrailing); 504 505 return_PTR (NameBuffer); 506 } 507