nsnames.c revision 151937
1/******************************************************************************* 2 * 3 * Module Name: nsnames - Name manipulation and search 4 * $Revision: 1.91 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2005, 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 <contrib/dev/acpica/acpi.h> 120#include <contrib/dev/acpica/amlcode.h> 121#include <contrib/dev/acpica/acnamesp.h> 122 123 124#define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nsnames") 126 127/* Local prototypes */ 128 129static void 130AcpiNsBuildExternalPath ( 131 ACPI_NAMESPACE_NODE *Node, 132 ACPI_SIZE Size, 133 char *NameBuffer); 134 135 136/******************************************************************************* 137 * 138 * FUNCTION: AcpiNsBuildExternalPath 139 * 140 * PARAMETERS: Node - NS node whose pathname is needed 141 * Size - Size of the pathname 142 * *NameBuffer - Where to return the pathname 143 * 144 * RETURN: Places the pathname into the NameBuffer, in external format 145 * (name segments separated by path separators) 146 * 147 * DESCRIPTION: Generate a full pathaname 148 * 149 ******************************************************************************/ 150 151static void 152AcpiNsBuildExternalPath ( 153 ACPI_NAMESPACE_NODE *Node, 154 ACPI_SIZE Size, 155 char *NameBuffer) 156{ 157 ACPI_SIZE Index; 158 ACPI_NAMESPACE_NODE *ParentNode; 159 160 161 ACPI_FUNCTION_NAME ("NsBuildExternalPath"); 162 163 164 /* Special case for root */ 165 166 Index = Size - 1; 167 if (Index < ACPI_NAME_SIZE) 168 { 169 NameBuffer[0] = AML_ROOT_PREFIX; 170 NameBuffer[1] = 0; 171 return; 172 } 173 174 /* Store terminator byte, then build name backwards */ 175 176 ParentNode = Node; 177 NameBuffer[Index] = 0; 178 179 while ((Index > ACPI_NAME_SIZE) && (ParentNode != AcpiGbl_RootNode)) 180 { 181 Index -= ACPI_NAME_SIZE; 182 183 /* Put the name into the buffer */ 184 185 ACPI_MOVE_32_TO_32 ((NameBuffer + Index), &ParentNode->Name); 186 ParentNode = AcpiNsGetParentNode (ParentNode); 187 188 /* Prefix name with the path separator */ 189 190 Index--; 191 NameBuffer[Index] = ACPI_PATH_SEPARATOR; 192 } 193 194 /* Overwrite final separator with the root prefix character */ 195 196 NameBuffer[Index] = AML_ROOT_PREFIX; 197 198 if (Index != 0) 199 { 200 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, 201 "Could not construct pathname; index=%X, size=%X, Path=%s\n", 202 (UINT32) Index, (UINT32) Size, &NameBuffer[Size])); 203 } 204 205 return; 206} 207 208 209#ifdef ACPI_DEBUG_OUTPUT 210/******************************************************************************* 211 * 212 * FUNCTION: AcpiNsGetExternalPathname 213 * 214 * PARAMETERS: Node - Namespace node whose pathname is needed 215 * 216 * RETURN: Pointer to storage containing the fully qualified name of 217 * the node, In external format (name segments separated by path 218 * separators.) 219 * 220 * DESCRIPTION: Used for debug printing in AcpiNsSearchTable(). 221 * 222 ******************************************************************************/ 223 224char * 225AcpiNsGetExternalPathname ( 226 ACPI_NAMESPACE_NODE *Node) 227{ 228 char *NameBuffer; 229 ACPI_SIZE Size; 230 231 232 ACPI_FUNCTION_TRACE_PTR ("NsGetExternalPathname", Node); 233 234 235 /* Calculate required buffer size based on depth below root */ 236 237 Size = AcpiNsGetPathnameLength (Node); 238 239 /* Allocate a buffer to be returned to caller */ 240 241 NameBuffer = ACPI_MEM_CALLOCATE (Size); 242 if (!NameBuffer) 243 { 244 ACPI_REPORT_ERROR (("NsGetTablePathname: allocation failure\n")); 245 return_PTR (NULL); 246 } 247 248 /* Build the path in the allocated buffer */ 249 250 AcpiNsBuildExternalPath (Node, Size, NameBuffer); 251 return_PTR (NameBuffer); 252} 253#endif 254 255 256/******************************************************************************* 257 * 258 * FUNCTION: AcpiNsGetPathnameLength 259 * 260 * PARAMETERS: Node - Namespace node 261 * 262 * RETURN: Length of path, including prefix 263 * 264 * DESCRIPTION: Get the length of the pathname string for this node 265 * 266 ******************************************************************************/ 267 268ACPI_SIZE 269AcpiNsGetPathnameLength ( 270 ACPI_NAMESPACE_NODE *Node) 271{ 272 ACPI_SIZE Size; 273 ACPI_NAMESPACE_NODE *NextNode; 274 275 276 ACPI_FUNCTION_ENTRY (); 277 278 279 /* 280 * Compute length of pathname as 5 * number of name segments. 281 * Go back up the parent tree to the root 282 */ 283 Size = 0; 284 NextNode = Node; 285 286 while (NextNode && (NextNode != AcpiGbl_RootNode)) 287 { 288 Size += ACPI_PATH_SEGMENT_LENGTH; 289 NextNode = AcpiNsGetParentNode (NextNode); 290 } 291 292 if (!Size) 293 { 294 Size = 1; /* Root node case */ 295 } 296 297 return (Size + 1); /* +1 for null string terminator */ 298} 299 300 301/******************************************************************************* 302 * 303 * FUNCTION: AcpiNsHandleToPathname 304 * 305 * PARAMETERS: TargetHandle - Handle of named object whose name is 306 * to be found 307 * Buffer - Where the pathname is returned 308 * 309 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 310 * 311 * DESCRIPTION: Build and return a full namespace pathname 312 * 313 ******************************************************************************/ 314 315ACPI_STATUS 316AcpiNsHandleToPathname ( 317 ACPI_HANDLE TargetHandle, 318 ACPI_BUFFER *Buffer) 319{ 320 ACPI_STATUS Status; 321 ACPI_NAMESPACE_NODE *Node; 322 ACPI_SIZE RequiredSize; 323 324 325 ACPI_FUNCTION_TRACE_PTR ("NsHandleToPathname", TargetHandle); 326 327 328 Node = AcpiNsMapHandleToNode (TargetHandle); 329 if (!Node) 330 { 331 return_ACPI_STATUS (AE_BAD_PARAMETER); 332 } 333 334 /* Determine size required for the caller buffer */ 335 336 RequiredSize = AcpiNsGetPathnameLength (Node); 337 338 /* Validate/Allocate/Clear caller buffer */ 339 340 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize); 341 if (ACPI_FAILURE (Status)) 342 { 343 return_ACPI_STATUS (Status); 344 } 345 346 /* Build the path in the caller buffer */ 347 348 AcpiNsBuildExternalPath (Node, RequiredSize, Buffer->Pointer); 349 350 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n", 351 (char *) Buffer->Pointer, (UINT32) RequiredSize)); 352 return_ACPI_STATUS (AE_OK); 353} 354 355 356