1 /******************************************************************************* 2 * 3 * Module Name: nsnames - Name manipulation and search 4 * $Revision: 1.101 $ 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 #define __NSNAMES_C__ 118 119 #include "acpi.h" 120 #include "amlcode.h" 121 #include "acnamesp.h" 122 123 124 #define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nsnames") 126 127 128 /******************************************************************************* 129 * 130 * FUNCTION: AcpiNsBuildExternalPath 131 * 132 * PARAMETERS: Node - NS node whose pathname is needed 133 * Size - Size of the pathname 134 * *NameBuffer - Where to return the pathname 135 * 136 * RETURN: Status 137 * Places the pathname into the NameBuffer, in external format 138 * (name segments separated by path separators) 139 * 140 * DESCRIPTION: Generate a full pathaname 141 * 142 ******************************************************************************/ 143 144 ACPI_STATUS 145 AcpiNsBuildExternalPath ( 146 ACPI_NAMESPACE_NODE *Node, 147 ACPI_SIZE Size, 148 char *NameBuffer) 149 { 150 ACPI_SIZE Index; 151 ACPI_NAMESPACE_NODE *ParentNode; 152 153 154 ACPI_FUNCTION_ENTRY (); 155 156 157 /* Special case for root */ 158 159 Index = Size - 1; 160 if (Index < ACPI_NAME_SIZE) 161 { 162 NameBuffer[0] = AML_ROOT_PREFIX; 163 NameBuffer[1] = 0; 164 return (AE_OK); 165 } 166 167 /* Store terminator byte, then build name backwards */ 168 169 ParentNode = Node; 170 NameBuffer[Index] = 0; 171 172 while ((Index > ACPI_NAME_SIZE) && (ParentNode != AcpiGbl_RootNode)) 173 { 174 Index -= ACPI_NAME_SIZE; 175 176 /* Put the name into the buffer */ 177 178 ACPI_MOVE_32_TO_32 ((NameBuffer + Index), &ParentNode->Name); 179 ParentNode = AcpiNsGetParentNode (ParentNode); 180 181 /* Prefix name with the path separator */ 182 183 Index--; 184 NameBuffer[Index] = ACPI_PATH_SEPARATOR; 185 } 186 187 /* Overwrite final separator with the root prefix character */ 188 189 NameBuffer[Index] = AML_ROOT_PREFIX; 190 191 if (Index != 0) 192 { 193 ACPI_ERROR ((AE_INFO, 194 "Could not construct external pathname; index=%X, size=%X, Path=%s", 195 (UINT32) Index, (UINT32) Size, &NameBuffer[Size])); 196 197 return (AE_BAD_PARAMETER); 198 } 199 200 return (AE_OK); 201 } 202 203 204 #ifdef ACPI_DEBUG_OUTPUT 205 /******************************************************************************* 206 * 207 * FUNCTION: AcpiNsGetExternalPathname 208 * 209 * PARAMETERS: Node - Namespace node whose pathname is needed 210 * 211 * RETURN: Pointer to storage containing the fully qualified name of 212 * the node, In external format (name segments separated by path 213 * separators.) 214 * 215 * DESCRIPTION: Used for debug printing in AcpiNsSearchTable(). 216 * 217 ******************************************************************************/ 218 219 char * 220 AcpiNsGetExternalPathname ( 221 ACPI_NAMESPACE_NODE *Node) 222 { 223 ACPI_STATUS Status; 224 char *NameBuffer; 225 ACPI_SIZE Size; 226 227 228 ACPI_FUNCTION_TRACE_PTR (NsGetExternalPathname, Node); 229 230 231 /* Calculate required buffer size based on depth below root */ 232 233 Size = AcpiNsGetPathnameLength (Node); 234 if (!Size) 235 { 236 return_PTR (NULL); 237 } 238 239 /* Allocate a buffer to be returned to caller */ 240 241 NameBuffer = ACPI_ALLOCATE_ZEROED (Size); 242 if (!NameBuffer) 243 { 244 ACPI_ERROR ((AE_INFO, "Allocation failure")); 245 return_PTR (NULL); 246 } 247 248 /* Build the path in the allocated buffer */ 249 250 Status = AcpiNsBuildExternalPath (Node, Size, NameBuffer); 251 if (ACPI_FAILURE (Status)) 252 { 253 ACPI_FREE (NameBuffer); 254 return_PTR (NULL); 255 } 256 257 return_PTR (NameBuffer); 258 } 259 #endif 260 261 262 /******************************************************************************* 263 * 264 * FUNCTION: AcpiNsGetPathnameLength 265 * 266 * PARAMETERS: Node - Namespace node 267 * 268 * RETURN: Length of path, including prefix 269 * 270 * DESCRIPTION: Get the length of the pathname string for this node 271 * 272 ******************************************************************************/ 273 274 ACPI_SIZE 275 AcpiNsGetPathnameLength ( 276 ACPI_NAMESPACE_NODE *Node) 277 { 278 ACPI_SIZE Size; 279 ACPI_NAMESPACE_NODE *NextNode; 280 281 282 ACPI_FUNCTION_ENTRY (); 283 284 285 /* 286 * Compute length of pathname as 5 * number of name segments. 287 * Go back up the parent tree to the root 288 */ 289 Size = 0; 290 NextNode = Node; 291 292 while (NextNode && (NextNode != AcpiGbl_RootNode)) 293 { 294 if (ACPI_GET_DESCRIPTOR_TYPE (NextNode) != ACPI_DESC_TYPE_NAMED) 295 { 296 ACPI_ERROR ((AE_INFO, 297 "Invalid Namespace Node (%p) while traversing namespace", 298 NextNode)); 299 return 0; 300 } 301 Size += ACPI_PATH_SEGMENT_LENGTH; 302 NextNode = AcpiNsGetParentNode (NextNode); 303 } 304 305 if (!Size) 306 { 307 Size = 1; /* Root node case */ 308 } 309 310 return (Size + 1); /* +1 for null string terminator */ 311 } 312 313 314 /******************************************************************************* 315 * 316 * FUNCTION: AcpiNsHandleToPathname 317 * 318 * PARAMETERS: TargetHandle - Handle of named object whose name is 319 * to be found 320 * Buffer - Where the pathname is returned 321 * 322 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 323 * 324 * DESCRIPTION: Build and return a full namespace pathname 325 * 326 ******************************************************************************/ 327 328 ACPI_STATUS 329 AcpiNsHandleToPathname ( 330 ACPI_HANDLE TargetHandle, 331 ACPI_BUFFER *Buffer) 332 { 333 ACPI_STATUS Status; 334 ACPI_NAMESPACE_NODE *Node; 335 ACPI_SIZE RequiredSize; 336 337 338 ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle); 339 340 341 Node = AcpiNsMapHandleToNode (TargetHandle); 342 if (!Node) 343 { 344 return_ACPI_STATUS (AE_BAD_PARAMETER); 345 } 346 347 /* Determine size required for the caller buffer */ 348 349 RequiredSize = AcpiNsGetPathnameLength (Node); 350 if (!RequiredSize) 351 { 352 return_ACPI_STATUS (AE_BAD_PARAMETER); 353 } 354 355 /* Validate/Allocate/Clear caller buffer */ 356 357 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize); 358 if (ACPI_FAILURE (Status)) 359 { 360 return_ACPI_STATUS (Status); 361 } 362 363 /* Build the path in the caller buffer */ 364 365 Status = AcpiNsBuildExternalPath (Node, RequiredSize, Buffer->Pointer); 366 if (ACPI_FAILURE (Status)) 367 { 368 return_ACPI_STATUS (Status); 369 } 370 371 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n", 372 (char *) Buffer->Pointer, (UINT32) RequiredSize)); 373 return_ACPI_STATUS (AE_OK); 374 } 375 376 377