nsnames.c revision 91116
1305549Sjhb/******************************************************************************* 2305549Sjhb * 3305549Sjhb * Module Name: nsnames - Name manipulation and search 4305549Sjhb * $Revision: 74 $ 5305549Sjhb * 6305549Sjhb ******************************************************************************/ 7305549Sjhb 8305549Sjhb/****************************************************************************** 9305549Sjhb * 10305549Sjhb * 1. Copyright Notice 11305549Sjhb * 12305549Sjhb * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 13305549Sjhb * All rights reserved. 14305549Sjhb * 15305549Sjhb * 2. License 16305549Sjhb * 17305549Sjhb * 2.1. This is your license from Intel Corp. under its intellectual property 18305549Sjhb * rights. You may have additional license terms from the party that provided 19305549Sjhb * you this software, covering your right to use that party's intellectual 20305549Sjhb * property rights. 21305549Sjhb * 22305549Sjhb * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23305549Sjhb * copy of the source code appearing in this file ("Covered Code") an 24305549Sjhb * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25305549Sjhb * base code distributed originally by Intel ("Original Intel Code") to copy, 26305549Sjhb * make derivatives, distribute, use and display any portion of the Covered 27305549Sjhb * Code in any form, with the right to sublicense such rights; and 28305549Sjhb * 29305549Sjhb * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30305549Sjhb * license (with the right to sublicense), under only those claims of Intel 31305549Sjhb * patents that are infringed by the Original Intel Code, to make, use, sell, 32305549Sjhb * offer to sell, and import the Covered Code and derivative works thereof 33305549Sjhb * solely to the minimum extent necessary to exercise the above copyright 34305549Sjhb * license, and in no event shall the patent license extend to any additions 35305549Sjhb * to or modifications of the Original Intel Code. No other license or right 36305549Sjhb * is granted directly or by implication, estoppel or otherwise; 37305549Sjhb * 38305549Sjhb * The above copyright and patent license is granted only if the following 39305549Sjhb * conditions are met: 40305549Sjhb * 41305549Sjhb * 3. Conditions 42305549Sjhb * 43305549Sjhb * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44305549Sjhb * 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 "acinterp.h" 122#include "acnamesp.h" 123 124 125#define _COMPONENT ACPI_NAMESPACE 126 ACPI_MODULE_NAME ("nsnames") 127 128 129/******************************************************************************* 130 * 131 * FUNCTION: AcpiNsBuildExternalPath 132 * 133 * PARAMETERS: Node - NS node whose pathname is needed 134 * Size - Size of the pathname 135 * *NameBuffer - Where to return the pathname 136 * 137 * RETURN: 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 144void 145AcpiNsBuildExternalPath ( 146 ACPI_NAMESPACE_NODE *Node, 147 ACPI_SIZE Size, 148 NATIVE_CHAR *NameBuffer) 149{ 150 UINT32 Index; 151 ACPI_NAMESPACE_NODE *ParentNode; 152 153 154 ACPI_FUNCTION_NAME ("NsBuildExternalPath"); 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; 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_UNALIGNED32_TO_32 ((NameBuffer + Index), &ParentNode->Name); 179 ParentNode = AcpiNsGetParentNode (ParentNode); 180 181 /* Prefix name with the path separator */ 182 183 Index--; 184 NameBuffer[Index] = 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_DEBUG_PRINT ((ACPI_DB_ERROR, 194 "Could not construct pathname; index=%X, size=%X, Path=%s\n", 195 Index, Size, &NameBuffer[Size])); 196 } 197 198 return; 199} 200 201 202#ifdef ACPI_DEBUG 203/******************************************************************************* 204 * 205 * FUNCTION: AcpiNsGetExternalPathname 206 * 207 * PARAMETERS: Node - NS node whose pathname is needed 208 * 209 * RETURN: Pointer to storage containing the fully qualified name of 210 * the node, In external format (name segments separated by path 211 * separators.) 212 * 213 * DESCRIPTION: Used for debug printing in AcpiNsSearchTable(). 214 * 215 ******************************************************************************/ 216 217NATIVE_CHAR * 218AcpiNsGetExternalPathname ( 219 ACPI_NAMESPACE_NODE *Node) 220{ 221 NATIVE_CHAR *NameBuffer; 222 ACPI_SIZE Size; 223 224 225 ACPI_FUNCTION_TRACE_PTR ("NsGetExternalPathname", Node); 226 227 228 /* Calculate required buffer size based on depth below root */ 229 230 Size = AcpiNsGetPathnameLength (Node); 231 232 /* Allocate a buffer to be returned to caller */ 233 234 NameBuffer = ACPI_MEM_CALLOCATE (Size); 235 if (!NameBuffer) 236 { 237 ACPI_REPORT_ERROR (("NsGetTablePathname: allocation failure\n")); 238 return_PTR (NULL); 239 } 240 241 /* Build the path in the allocated buffer */ 242 243 AcpiNsBuildExternalPath (Node, Size, NameBuffer); 244 return_PTR (NameBuffer); 245} 246#endif 247 248 249/******************************************************************************* 250 * 251 * FUNCTION: AcpiNsGetPathnameLength 252 * 253 * PARAMETERS: Node - Namespace node 254 * 255 * RETURN: Length of path, including prefix 256 * 257 * DESCRIPTION: Get the length of the pathname string for this node 258 * 259 ******************************************************************************/ 260 261ACPI_SIZE 262AcpiNsGetPathnameLength ( 263 ACPI_NAMESPACE_NODE *Node) 264{ 265 ACPI_SIZE Size; 266 ACPI_NAMESPACE_NODE *NextNode; 267 268 269 ACPI_FUNCTION_ENTRY (); 270 271 272 /* 273 * Compute length of pathname as 5 * number of name segments. 274 * Go back up the parent tree to the root 275 */ 276 Size = 0; 277 NextNode = Node; 278 279 while (NextNode != AcpiGbl_RootNode) 280 { 281 Size += PATH_SEGMENT_LENGTH; 282 NextNode = AcpiNsGetParentNode (NextNode); 283 } 284 285 return (Size + 1); 286} 287 288 289/******************************************************************************* 290 * 291 * FUNCTION: AcpiNsHandleToPathname 292 * 293 * PARAMETERS: TargetHandle - Handle of named object whose name is 294 * to be found 295 * Buffer - Where the pathname is returned 296 * 297 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 298 * 299 * DESCRIPTION: Build and return a full namespace pathname 300 * 301 ******************************************************************************/ 302 303ACPI_STATUS 304AcpiNsHandleToPathname ( 305 ACPI_HANDLE TargetHandle, 306 ACPI_BUFFER *Buffer) 307{ 308 ACPI_STATUS Status; 309 ACPI_NAMESPACE_NODE *Node; 310 ACPI_SIZE RequiredSize; 311 312 313 ACPI_FUNCTION_TRACE_PTR ("NsHandleToPathname", TargetHandle); 314 315 316 Node = AcpiNsMapHandleToNode (TargetHandle); 317 if (!Node) 318 { 319 return_ACPI_STATUS (AE_BAD_PARAMETER); 320 } 321 322 /* Determine size required for the caller buffer */ 323 324 RequiredSize = AcpiNsGetPathnameLength (Node); 325 326 /* Validate/Allocate/Clear caller buffer */ 327 328 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize); 329 if (ACPI_FAILURE (Status)) 330 { 331 return_ACPI_STATUS (Status); 332 } 333 334 /* Build the path in the caller buffer */ 335 336 AcpiNsBuildExternalPath (Node, RequiredSize, Buffer->Pointer); 337 338 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X] \n", (char *) Buffer->Pointer, RequiredSize)); 339 return_ACPI_STATUS (AE_OK); 340} 341 342 343