nsnames.c revision 193267
167760Smsmith/******************************************************************************* 269459Smsmith * 367760Smsmith * Module Name: nsnames - Name manipulation and search 467760Smsmith * 567760Smsmith ******************************************************************************/ 667760Smsmith 767760Smsmith/****************************************************************************** 867760Smsmith * 967760Smsmith * 1. Copyright Notice 1067760Smsmith * 1167760Smsmith * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp. 1267760Smsmith * All rights reserved. 1367760Smsmith * 1467760Smsmith * 2. License 1567760Smsmith * 1667760Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1767760Smsmith * rights. You may have additional license terms from the party that provided 1867760Smsmith * you this software, covering your right to use that party's intellectual 1967760Smsmith * property rights. 2067760Smsmith * 2167760Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2267760Smsmith * copy of the source code appearing in this file ("Covered Code") an 2367760Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2467760Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2567760Smsmith * make derivatives, distribute, use and display any portion of the Covered 2667760Smsmith * Code in any form, with the right to sublicense such rights; and 2767760Smsmith * 2867760Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 2967760Smsmith * license (with the right to sublicense), under only those claims of Intel 3067760Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3167760Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3267760Smsmith * solely to the minimum extent necessary to exercise the above copyright 33148318Snjl * license, and in no event shall the patent license extend to any additions 34148318Snjl * to or modifications of the Original Intel Code. No other license or right 35148318Snjl * is granted directly or by implication, estoppel or otherwise; 36150003Sobrien * 3767760Smsmith * The above copyright and patent license is granted only if the following 3867760Smsmith * conditions are met: 3967760Smsmith * 4067760Smsmith * 3. Conditions 4167760Smsmith * 4267760Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43128225Snjl * Redistribution of source code of any substantial portion of the Covered 4467760Smsmith * Code or modification with rights to further distribute source must include 4567760Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4692118Speter * and the following Disclaimer and Export Compliance provision. In addition, 4767760Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 48128225Snjl * contain a file documenting the changes Licensee made to create that Covered 4967760Smsmith * Code and the date of any change. Licensee must include in that file the 5067760Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5167760Smsmith * must include a prominent statement that the modification is derived, 52128225Snjl * directly or indirectly, from Original Intel Code. 5367760Smsmith * 5467760Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5567760Smsmith * Redistribution of source code of any substantial portion of the Covered 5667760Smsmith * Code or modification without rights to further distribute source must 5767760Smsmith * include the following Disclaimer and Export Compliance provision in the 58128225Snjl * documentation and/or other materials provided with distribution. In 59128225Snjl * addition, Licensee may not authorize further sublicense of source of any 6067760Smsmith * portion of the Covered Code, and must include terms to the effect that the 61161223Sjhb * license from Licensee to its licensee is limited to the intellectual 6267760Smsmith * property embodied in the software Licensee provides to its licensee, and 63128225Snjl * not to intellectual property embodied in modifications its licensee may 64128225Snjl * make. 6567760Smsmith * 6667760Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6767760Smsmith * substantial portion of the Covered Code or modification must reproduce the 68128225Snjl * above Copyright Notice, and the following Disclaimer and Export Compliance 6967760Smsmith * provision in the documentation and/or other materials provided with the 70161223Sjhb * distribution. 7167760Smsmith * 7267760Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7380071Smsmith * Intel Code. 74128225Snjl * 75128225Snjl * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7680071Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 77128225Snjl * other dealings in products derived from or relating to the Covered Code 78128225Snjl * without prior written authorization from Intel. 7980071Smsmith * 8080071Smsmith * 4. Disclaimer and Export Compliance 8167760Smsmith * 8267760Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8367760Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8467760Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8567760Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86117534Smarcel * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8767760Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88128225Snjl * PARTICULAR PURPOSE. 8967760Smsmith * 9067760Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9167760Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92117534Smarcel * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9367760Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94128225Snjl * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9567760Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9667760Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9780071Smsmith * LIMITED REMEDY. 98128225Snjl * 9969459Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10069459Smsmith * software or system incorporating such software without first obtaining any 10169459Smsmith * required license or other approval from the U. S. Department of Commerce or 102128225Snjl * any other agency or department of the United States Government. In the 103128225Snjl * event Licensee exports any such software from the United States or 10469459Smsmith * re-exports any such software from a foreign destination, Licensee shall 10580071Smsmith * ensure that the distribution and export/re-export of the software is in 10680071Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10780071Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10869459Smsmith * any of its subsidiaries will export/re-export any technical data, process, 10980071Smsmith * software, or service, directly or indirectly, to any country for which the 11080071Smsmith * United States government or any agency thereof requires an export license, 11169459Smsmith * other governmental approval, or letter of assurance, without first obtaining 11280071Smsmith * such license, approval or letter. 11380071Smsmith * 11469459Smsmith *****************************************************************************/ 11580071Smsmith 11680071Smsmith#define __NSNAMES_C__ 11780071Smsmith 11880071Smsmith#include "acpi.h" 11980071Smsmith#include "accommon.h" 12092666Speter#include "amlcode.h" 12169459Smsmith#include "acnamesp.h" 12269459Smsmith 12380071Smsmith 12469459Smsmith#define _COMPONENT ACPI_NAMESPACE 125128225Snjl ACPI_MODULE_NAME ("nsnames") 12669459Smsmith 12769459Smsmith 12880071Smsmith/******************************************************************************* 129128225Snjl * 13069459Smsmith * FUNCTION: AcpiNsBuildExternalPath 13169459Smsmith * 13269459Smsmith * PARAMETERS: Node - NS node whose pathname is needed 133128225Snjl * Size - Size of the pathname 134128225Snjl * *NameBuffer - Where to return the pathname 13569459Smsmith * 13680071Smsmith * RETURN: Status 13780071Smsmith * Places the pathname into the NameBuffer, in external format 13869459Smsmith * (name segments separated by path separators) 13969459Smsmith * 14080071Smsmith * DESCRIPTION: Generate a full pathaname 14169459Smsmith * 14269459Smsmith ******************************************************************************/ 14380071Smsmith 14480071SmsmithACPI_STATUS 14569459SmsmithAcpiNsBuildExternalPath ( 14680071Smsmith ACPI_NAMESPACE_NODE *Node, 14780071Smsmith ACPI_SIZE Size, 14880071Smsmith char *NameBuffer) 14980071Smsmith{ 15080071Smsmith ACPI_SIZE Index; 15192666Speter ACPI_NAMESPACE_NODE *ParentNode; 15269459Smsmith 15369459Smsmith 15480071Smsmith ACPI_FUNCTION_ENTRY (); 15569459Smsmith 156128225Snjl 15769459Smsmith /* 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/******************************************************************************* 205 * 206 * FUNCTION: AcpiNsGetExternalPathname 207 * 208 * PARAMETERS: Node - Namespace node whose pathname is needed 209 * 210 * RETURN: Pointer to storage containing the fully qualified name of 211 * the node, In external format (name segments separated by path 212 * separators.) 213 * 214 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually 215 * for error and debug statements. 216 * 217 ******************************************************************************/ 218 219char * 220AcpiNsGetExternalPathname ( 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, "Could not allocate %u bytes", (UINT32) Size)); 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 260 261/******************************************************************************* 262 * 263 * FUNCTION: AcpiNsGetPathnameLength 264 * 265 * PARAMETERS: Node - Namespace node 266 * 267 * RETURN: Length of path, including prefix 268 * 269 * DESCRIPTION: Get the length of the pathname string for this node 270 * 271 ******************************************************************************/ 272 273ACPI_SIZE 274AcpiNsGetPathnameLength ( 275 ACPI_NAMESPACE_NODE *Node) 276{ 277 ACPI_SIZE Size; 278 ACPI_NAMESPACE_NODE *NextNode; 279 280 281 ACPI_FUNCTION_ENTRY (); 282 283 284 /* 285 * Compute length of pathname as 5 * number of name segments. 286 * Go back up the parent tree to the root 287 */ 288 Size = 0; 289 NextNode = Node; 290 291 while (NextNode && (NextNode != AcpiGbl_RootNode)) 292 { 293 if (ACPI_GET_DESCRIPTOR_TYPE (NextNode) != ACPI_DESC_TYPE_NAMED) 294 { 295 ACPI_ERROR ((AE_INFO, 296 "Invalid Namespace Node (%p) while traversing namespace", 297 NextNode)); 298 return 0; 299 } 300 Size += ACPI_PATH_SEGMENT_LENGTH; 301 NextNode = AcpiNsGetParentNode (NextNode); 302 } 303 304 if (!Size) 305 { 306 Size = 1; /* Root node case */ 307 } 308 309 return (Size + 1); /* +1 for null string terminator */ 310} 311 312 313/******************************************************************************* 314 * 315 * FUNCTION: AcpiNsHandleToPathname 316 * 317 * PARAMETERS: TargetHandle - Handle of named object whose name is 318 * to be found 319 * Buffer - Where the pathname is returned 320 * 321 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 322 * 323 * DESCRIPTION: Build and return a full namespace pathname 324 * 325 ******************************************************************************/ 326 327ACPI_STATUS 328AcpiNsHandleToPathname ( 329 ACPI_HANDLE TargetHandle, 330 ACPI_BUFFER *Buffer) 331{ 332 ACPI_STATUS Status; 333 ACPI_NAMESPACE_NODE *Node; 334 ACPI_SIZE RequiredSize; 335 336 337 ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle); 338 339 340 Node = AcpiNsMapHandleToNode (TargetHandle); 341 if (!Node) 342 { 343 return_ACPI_STATUS (AE_BAD_PARAMETER); 344 } 345 346 /* Determine size required for the caller buffer */ 347 348 RequiredSize = AcpiNsGetPathnameLength (Node); 349 if (!RequiredSize) 350 { 351 return_ACPI_STATUS (AE_BAD_PARAMETER); 352 } 353 354 /* Validate/Allocate/Clear caller buffer */ 355 356 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize); 357 if (ACPI_FAILURE (Status)) 358 { 359 return_ACPI_STATUS (Status); 360 } 361 362 /* Build the path in the caller buffer */ 363 364 Status = AcpiNsBuildExternalPath (Node, RequiredSize, Buffer->Pointer); 365 if (ACPI_FAILURE (Status)) 366 { 367 return_ACPI_STATUS (Status); 368 } 369 370 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n", 371 (char *) Buffer->Pointer, (UINT32) RequiredSize)); 372 return_ACPI_STATUS (AE_OK); 373} 374 375 376