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 - 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 "amlcode.h" 119 #include "acnamesp.h" 120 121 122 #define _COMPONENT ACPI_NAMESPACE 123 ACPI_MODULE_NAME ("nsnames") 124 125 126 /******************************************************************************* 127 * 128 * FUNCTION: AcpiNsGetExternalPathname 129 * 130 * PARAMETERS: Node - Namespace node whose pathname is needed 131 * 132 * RETURN: Pointer to storage containing the fully qualified name of 133 * the node, In external format (name segments separated by path 134 * separators.) 135 * 136 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually 137 * for error and debug statements. 138 * 139 ******************************************************************************/ 140 141 char * 142 AcpiNsGetExternalPathname ( 143 ACPI_NAMESPACE_NODE *Node) 144 { 145 char *NameBuffer; 146 147 148 ACPI_FUNCTION_TRACE_PTR (NsGetExternalPathname, Node); 149 150 151 NameBuffer = AcpiNsGetNormalizedPathname (Node, FALSE); 152 return_PTR (NameBuffer); 153 } 154 155 156 /******************************************************************************* 157 * 158 * FUNCTION: AcpiNsGetPathnameLength 159 * 160 * PARAMETERS: Node - Namespace node 161 * 162 * RETURN: Length of path, including prefix 163 * 164 * DESCRIPTION: Get the length of the pathname string for this node 165 * 166 ******************************************************************************/ 167 168 ACPI_SIZE 169 AcpiNsGetPathnameLength ( 170 ACPI_NAMESPACE_NODE *Node) 171 { 172 ACPI_SIZE Size; 173 174 175 ACPI_FUNCTION_ENTRY (); 176 177 178 Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, FALSE); 179 return (Size); 180 } 181 182 183 /******************************************************************************* 184 * 185 * FUNCTION: AcpiNsHandleToPathname 186 * 187 * PARAMETERS: TargetHandle - Handle of named object whose name is 188 * to be found 189 * Buffer - Where the pathname is returned 190 * NoTrailing - Remove trailing '_' for each name 191 * segment 192 * 193 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 194 * 195 * DESCRIPTION: Build and return a full namespace pathname 196 * 197 ******************************************************************************/ 198 199 ACPI_STATUS 200 AcpiNsHandleToPathname ( 201 ACPI_HANDLE TargetHandle, 202 ACPI_BUFFER *Buffer, 203 BOOLEAN NoTrailing) 204 { 205 ACPI_STATUS Status; 206 ACPI_NAMESPACE_NODE *Node; 207 ACPI_SIZE RequiredSize; 208 209 210 ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle); 211 212 213 Node = AcpiNsValidateHandle (TargetHandle); 214 if (!Node) 215 { 216 return_ACPI_STATUS (AE_BAD_PARAMETER); 217 } 218 219 /* Determine size required for the caller buffer */ 220 221 RequiredSize = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing); 222 if (!RequiredSize) 223 { 224 return_ACPI_STATUS (AE_BAD_PARAMETER); 225 } 226 227 /* Validate/Allocate/Clear caller buffer */ 228 229 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize); 230 if (ACPI_FAILURE (Status)) 231 { 232 return_ACPI_STATUS (Status); 233 } 234 235 /* Build the path in the caller buffer */ 236 237 (void) AcpiNsBuildNormalizedPath (Node, Buffer->Pointer, 238 RequiredSize, NoTrailing); 239 if (ACPI_FAILURE (Status)) 240 { 241 return_ACPI_STATUS (Status); 242 } 243 244 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n", 245 (char *) Buffer->Pointer, (UINT32) RequiredSize)); 246 return_ACPI_STATUS (AE_OK); 247 } 248 249 250 /******************************************************************************* 251 * 252 * FUNCTION: AcpiNsBuildNormalizedPath 253 * 254 * PARAMETERS: Node - Namespace node 255 * FullPath - Where the path name is returned 256 * PathSize - Size of returned path name buffer 257 * NoTrailing - Remove trailing '_' from each name segment 258 * 259 * RETURN: Return 1 if the AML path is empty, otherwise returning (length 260 * of pathname + 1) which means the 'FullPath' contains a trailing 261 * null. 262 * 263 * DESCRIPTION: Build and return a full namespace pathname. 264 * Note that if the size of 'FullPath' isn't large enough to 265 * contain the namespace node's path name, the actual required 266 * buffer length is returned, and it should be greater than 267 * 'PathSize'. So callers are able to check the returning value 268 * to determine the buffer size of 'FullPath'. 269 * 270 ******************************************************************************/ 271 272 UINT32 273 AcpiNsBuildNormalizedPath ( 274 ACPI_NAMESPACE_NODE *Node, 275 char *FullPath, 276 UINT32 PathSize, 277 BOOLEAN NoTrailing) 278 { 279 UINT32 Length = 0, i; 280 char Name[ACPI_NAME_SIZE]; 281 BOOLEAN DoNoTrailing; 282 char c, *Left, *Right; 283 ACPI_NAMESPACE_NODE *NextNode; 284 285 286 ACPI_FUNCTION_TRACE_PTR (NsBuildNormalizedPath, Node); 287 288 289 #define ACPI_PATH_PUT8(Path, Size, Byte, Length) \ 290 do { \ 291 if ((Length) < (Size)) \ 292 { \ 293 (Path)[(Length)] = (Byte); \ 294 } \ 295 (Length)++; \ 296 } while (0) 297 298 /* 299 * Make sure the PathSize is correct, so that we don't need to 300 * validate both FullPath and PathSize. 301 */ 302 if (!FullPath) 303 { 304 PathSize = 0; 305 } 306 307 if (!Node) 308 { 309 goto BuildTrailingNull; 310 } 311 312 NextNode = Node; 313 while (NextNode && NextNode != AcpiGbl_RootNode) 314 { 315 if (NextNode != Node) 316 { 317 ACPI_PATH_PUT8(FullPath, PathSize, AML_DUAL_NAME_PREFIX, Length); 318 } 319 320 ACPI_MOVE_32_TO_32 (Name, &NextNode->Name); 321 DoNoTrailing = NoTrailing; 322 for (i = 0; i < 4; i++) 323 { 324 c = Name[4-i-1]; 325 if (DoNoTrailing && c != '_') 326 { 327 DoNoTrailing = FALSE; 328 } 329 if (!DoNoTrailing) 330 { 331 ACPI_PATH_PUT8(FullPath, PathSize, c, Length); 332 } 333 } 334 335 NextNode = NextNode->Parent; 336 } 337 338 ACPI_PATH_PUT8(FullPath, PathSize, AML_ROOT_PREFIX, Length); 339 340 /* Reverse the path string */ 341 342 if (Length <= PathSize) 343 { 344 Left = FullPath; 345 Right = FullPath+Length - 1; 346 347 while (Left < Right) 348 { 349 c = *Left; 350 *Left++ = *Right; 351 *Right-- = c; 352 } 353 } 354 355 /* Append the trailing null */ 356 357 BuildTrailingNull: 358 ACPI_PATH_PUT8 (FullPath, PathSize, '\0', Length); 359 360 #undef ACPI_PATH_PUT8 361 362 return_UINT32 (Length); 363 } 364 365 366 /******************************************************************************* 367 * 368 * FUNCTION: AcpiNsGetNormalizedPathname 369 * 370 * PARAMETERS: Node - Namespace node whose pathname is needed 371 * NoTrailing - Remove trailing '_' from each name segment 372 * 373 * RETURN: Pointer to storage containing the fully qualified name of 374 * the node, In external format (name segments separated by path 375 * separators.) 376 * 377 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually 378 * for error and debug statements. All trailing '_' will be 379 * removed from the full pathname if 'NoTrailing' is specified.. 380 * 381 ******************************************************************************/ 382 383 char * 384 AcpiNsGetNormalizedPathname ( 385 ACPI_NAMESPACE_NODE *Node, 386 BOOLEAN NoTrailing) 387 { 388 char *NameBuffer; 389 ACPI_SIZE Size; 390 391 392 ACPI_FUNCTION_TRACE_PTR (NsGetNormalizedPathname, Node); 393 394 395 /* Calculate required buffer size based on depth below root */ 396 397 Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing); 398 if (!Size) 399 { 400 return_PTR (NULL); 401 } 402 403 /* Allocate a buffer to be returned to caller */ 404 405 NameBuffer = ACPI_ALLOCATE_ZEROED (Size); 406 if (!NameBuffer) 407 { 408 ACPI_ERROR ((AE_INFO, 409 "Could not allocate %u bytes", (UINT32) Size)); 410 return_PTR (NULL); 411 } 412 413 /* Build the path in the allocated buffer */ 414 415 (void) AcpiNsBuildNormalizedPath (Node, NameBuffer, Size, NoTrailing); 416 417 return_PTR (NameBuffer); 418 } 419