nsnames.c revision 83174
1/******************************************************************************* 2 * 3 * Module Name: nsnames - Name manipulation and search 4 * $Revision: 63 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 "acinterp.h" 122#include "acnamesp.h" 123 124 125#define _COMPONENT ACPI_NAMESPACE 126 MODULE_NAME ("nsnames") 127 128 129/******************************************************************************* 130 * 131 * FUNCTION: AcpiNsGetTablePathname 132 * 133 * PARAMETERS: Node - Scope whose name is needed 134 * 135 * RETURN: Pointer to storage containing the fully qualified name of 136 * the scope, in Label format (all segments strung together 137 * with no separators) 138 * 139 * DESCRIPTION: Used for debug printing in AcpiNsSearchTable(). 140 * 141 ******************************************************************************/ 142 143NATIVE_CHAR * 144AcpiNsGetTablePathname ( 145 ACPI_NAMESPACE_NODE *Node) 146{ 147 NATIVE_CHAR *NameBuffer; 148 UINT32 Size; 149 ACPI_NAME Name; 150 ACPI_NAMESPACE_NODE *ChildNode; 151 ACPI_NAMESPACE_NODE *ParentNode; 152 153 154 FUNCTION_TRACE_PTR ("NsGetTablePathname", Node); 155 156 157 if (!AcpiGbl_RootNode || !Node) 158 { 159 /* 160 * If the name space has not been initialized, 161 * this function should not have been called. 162 */ 163 return_PTR (NULL); 164 } 165 166 ChildNode = Node->Child; 167 168 169 /* Calculate required buffer size based on depth below root */ 170 171 Size = 1; 172 ParentNode = ChildNode; 173 while (ParentNode) 174 { 175 ParentNode = AcpiNsGetParentObject (ParentNode); 176 if (ParentNode) 177 { 178 Size += ACPI_NAME_SIZE; 179 } 180 } 181 182 183 /* Allocate a buffer to be returned to caller */ 184 185 NameBuffer = ACPI_MEM_CALLOCATE (Size + 1); 186 if (!NameBuffer) 187 { 188 REPORT_ERROR (("NsGetTablePathname: allocation failure\n")); 189 return_PTR (NULL); 190 } 191 192 193 /* Store terminator byte, then build name backwards */ 194 195 NameBuffer[Size] = '\0'; 196 while ((Size > ACPI_NAME_SIZE) && 197 AcpiNsGetParentObject (ChildNode)) 198 { 199 Size -= ACPI_NAME_SIZE; 200 Name = AcpiNsFindParentName (ChildNode); 201 202 /* Put the name into the buffer */ 203 204 MOVE_UNALIGNED32_TO_32 ((NameBuffer + Size), &Name); 205 ChildNode = AcpiNsGetParentObject (ChildNode); 206 } 207 208 NameBuffer[--Size] = AML_ROOT_PREFIX; 209 210 if (Size != 0) 211 { 212 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Bad pointer returned; size=%X\n", Size)); 213 } 214 215 return_PTR (NameBuffer); 216} 217 218 219/******************************************************************************* 220 * 221 * FUNCTION: AcpiNsGetPathnameLength 222 * 223 * PARAMETERS: Node - Namespace node 224 * 225 * RETURN: Length of path, including prefix 226 * 227 * DESCRIPTION: Get the length of the pathname string for this node 228 * 229 ******************************************************************************/ 230 231UINT32 232AcpiNsGetPathnameLength ( 233 ACPI_NAMESPACE_NODE *Node) 234{ 235 UINT32 Size; 236 ACPI_NAMESPACE_NODE *NextNode; 237 238 239 FUNCTION_ENTRY (); 240 241 242 /* 243 * Compute length of pathname as 5 * number of name segments. 244 * Go back up the parent tree to the root 245 */ 246 for (Size = 0, NextNode = Node; 247 AcpiNsGetParentObject (NextNode); 248 NextNode = AcpiNsGetParentObject (NextNode)) 249 { 250 Size += PATH_SEGMENT_LENGTH; 251 } 252 253 /* Special case for size still 0 - no parent for "special" nodes */ 254 255 if (!Size) 256 { 257 Size = PATH_SEGMENT_LENGTH; 258 } 259 260 return (Size + 1); 261} 262 263 264/******************************************************************************* 265 * 266 * FUNCTION: AcpiNsHandleToPathname 267 * 268 * PARAMETERS: TargetHandle - Handle of named object whose name is 269 * to be found 270 * BufSize - Size of the buffer provided 271 * UserBuffer - Where the pathname is returned 272 * 273 * RETURN: Status, Buffer is filled with pathname if status is AE_OK 274 * 275 * DESCRIPTION: Build and return a full namespace pathname 276 * 277 * MUTEX: Locks Namespace 278 * 279 ******************************************************************************/ 280 281ACPI_STATUS 282AcpiNsHandleToPathname ( 283 ACPI_HANDLE TargetHandle, 284 UINT32 *BufSize, 285 NATIVE_CHAR *UserBuffer) 286{ 287 ACPI_STATUS Status = AE_OK; 288 ACPI_NAMESPACE_NODE *Node; 289 UINT32 PathLength; 290 UINT32 UserBufSize; 291 ACPI_NAME Name; 292 UINT32 Size; 293 294 295 FUNCTION_TRACE_PTR ("NsHandleToPathname", TargetHandle); 296 297 298 if (!AcpiGbl_RootNode) 299 { 300 /* 301 * If the name space has not been initialized, 302 * this function should not have been called. 303 */ 304 return_ACPI_STATUS (AE_NO_NAMESPACE); 305 } 306 307 Node = AcpiNsConvertHandleToEntry (TargetHandle); 308 if (!Node) 309 { 310 return_ACPI_STATUS (AE_BAD_PARAMETER); 311 } 312 313 314 /* Set return length to the required path length */ 315 316 PathLength = AcpiNsGetPathnameLength (Node); 317 Size = PathLength - 1; 318 319 UserBufSize = *BufSize; 320 *BufSize = PathLength; 321 322 /* Check if the user buffer is sufficiently large */ 323 324 if (PathLength > UserBufSize) 325 { 326 Status = AE_BUFFER_OVERFLOW; 327 goto Exit; 328 } 329 330 /* Store null terminator */ 331 332 UserBuffer[Size] = 0; 333 Size -= ACPI_NAME_SIZE; 334 335 /* Put the original ACPI name at the end of the path */ 336 337 MOVE_UNALIGNED32_TO_32 ((UserBuffer + Size), 338 &Node->Name); 339 340 UserBuffer[--Size] = PATH_SEPARATOR; 341 342 /* Build name backwards, putting "." between segments */ 343 344 while ((Size > ACPI_NAME_SIZE) && Node) 345 { 346 Size -= ACPI_NAME_SIZE; 347 Name = AcpiNsFindParentName (Node); 348 MOVE_UNALIGNED32_TO_32 ((UserBuffer + Size), &Name); 349 350 UserBuffer[--Size] = PATH_SEPARATOR; 351 Node = AcpiNsGetParentObject (Node); 352 } 353 354 /* 355 * Overlay the "." preceding the first segment with 356 * the root name "\" 357 */ 358 UserBuffer[Size] = '\\'; 359 360 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Len=%X, %s \n", PathLength, UserBuffer)); 361 362Exit: 363 return_ACPI_STATUS (Status); 364} 365 366 367