1 /*******************************************************************************
3 * Module Name: nsnames - Name manipulation and search
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acnamesp.h>
158 #define _COMPONENT ACPI_NAMESPACE
159 ACPI_MODULE_NAME ("nsnames")
162 /*******************************************************************************
164 * FUNCTION: AcpiNsGetExternalPathname
166 * PARAMETERS: Node - Namespace node whose pathname is needed
168 * RETURN: Pointer to storage containing the fully qualified name of
169 * the node, In external format (name segments separated by path
172 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually
173 * for error and debug statements.
175 ******************************************************************************/
178 AcpiNsGetExternalPathname (
179 ACPI_NAMESPACE_NODE *Node)
184 ACPI_FUNCTION_TRACE_PTR (NsGetExternalPathname, Node);
187 NameBuffer = AcpiNsGetNormalizedPathname (Node, FALSE);
188 return_PTR (NameBuffer);
192 /*******************************************************************************
194 * FUNCTION: AcpiNsGetPathnameLength
196 * PARAMETERS: Node - Namespace node
198 * RETURN: Length of path, including prefix
200 * DESCRIPTION: Get the length of the pathname string for this node
202 ******************************************************************************/
205 AcpiNsGetPathnameLength (
206 ACPI_NAMESPACE_NODE *Node)
211 /* Validate the Node */
213 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
215 ACPI_ERROR ((AE_INFO,
216 "Invalid/cached reference target node: %p, descriptor type %d",
217 Node, ACPI_GET_DESCRIPTOR_TYPE (Node)));
221 Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, FALSE);
226 /*******************************************************************************
228 * FUNCTION: AcpiNsHandleToName
230 * PARAMETERS: TargetHandle - Handle of named object whose name is
232 * Buffer - Where the name is returned
234 * RETURN: Status, Buffer is filled with name if status is AE_OK
236 * DESCRIPTION: Build and return a full namespace name
238 ******************************************************************************/
242 ACPI_HANDLE TargetHandle,
246 ACPI_NAMESPACE_NODE *Node;
247 const char *NodeName;
250 ACPI_FUNCTION_TRACE_PTR (NsHandleToName, TargetHandle);
253 Node = AcpiNsValidateHandle (TargetHandle);
256 return_ACPI_STATUS (AE_BAD_PARAMETER);
259 /* Validate/Allocate/Clear caller buffer */
261 Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
262 if (ACPI_FAILURE (Status))
264 return_ACPI_STATUS (Status);
267 /* Just copy the ACPI name from the Node and zero terminate it */
269 NodeName = AcpiUtGetNodeName (Node);
270 ACPI_MOVE_NAME (Buffer->Pointer, NodeName);
271 ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
273 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%4.4s\n", (char *) Buffer->Pointer));
274 return_ACPI_STATUS (AE_OK);
278 /*******************************************************************************
280 * FUNCTION: AcpiNsHandleToPathname
282 * PARAMETERS: TargetHandle - Handle of named object whose name is
284 * Buffer - Where the pathname is returned
285 * NoTrailing - Remove trailing '_' for each name
288 * RETURN: Status, Buffer is filled with pathname if status is AE_OK
290 * DESCRIPTION: Build and return a full namespace pathname
292 ******************************************************************************/
295 AcpiNsHandleToPathname (
296 ACPI_HANDLE TargetHandle,
301 ACPI_NAMESPACE_NODE *Node;
302 ACPI_SIZE RequiredSize;
305 ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle);
308 Node = AcpiNsValidateHandle (TargetHandle);
311 return_ACPI_STATUS (AE_BAD_PARAMETER);
314 /* Determine size required for the caller buffer */
316 RequiredSize = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing);
319 return_ACPI_STATUS (AE_BAD_PARAMETER);
322 /* Validate/Allocate/Clear caller buffer */
324 Status = AcpiUtInitializeBuffer (Buffer, RequiredSize);
325 if (ACPI_FAILURE (Status))
327 return_ACPI_STATUS (Status);
330 /* Build the path in the caller buffer */
332 (void) AcpiNsBuildNormalizedPath (Node, Buffer->Pointer,
333 RequiredSize, NoTrailing);
335 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n",
336 (char *) Buffer->Pointer, (UINT32) RequiredSize));
337 return_ACPI_STATUS (AE_OK);
341 /*******************************************************************************
343 * FUNCTION: AcpiNsBuildNormalizedPath
345 * PARAMETERS: Node - Namespace node
346 * FullPath - Where the path name is returned
347 * PathSize - Size of returned path name buffer
348 * NoTrailing - Remove trailing '_' from each name segment
350 * RETURN: Return 1 if the AML path is empty, otherwise returning (length
351 * of pathname + 1) which means the 'FullPath' contains a trailing
354 * DESCRIPTION: Build and return a full namespace pathname.
355 * Note that if the size of 'FullPath' isn't large enough to
356 * contain the namespace node's path name, the actual required
357 * buffer length is returned, and it should be greater than
358 * 'PathSize'. So callers are able to check the returning value
359 * to determine the buffer size of 'FullPath'.
361 ******************************************************************************/
364 AcpiNsBuildNormalizedPath (
365 ACPI_NAMESPACE_NODE *Node,
370 UINT32 Length = 0, i;
371 char Name[ACPI_NAME_SIZE];
372 BOOLEAN DoNoTrailing;
373 char c, *Left, *Right;
374 ACPI_NAMESPACE_NODE *NextNode;
377 ACPI_FUNCTION_TRACE_PTR (NsBuildNormalizedPath, Node);
380 #define ACPI_PATH_PUT8(Path, Size, Byte, Length) \
382 if ((Length) < (Size)) \
384 (Path)[(Length)] = (Byte); \
390 * Make sure the PathSize is correct, so that we don't need to
391 * validate both FullPath and PathSize.
400 goto BuildTrailingNull;
404 while (NextNode && NextNode != AcpiGbl_RootNode)
406 if (NextNode != Node)
408 ACPI_PATH_PUT8(FullPath, PathSize, AML_DUAL_NAME_PREFIX, Length);
411 ACPI_MOVE_32_TO_32 (Name, &NextNode->Name);
412 DoNoTrailing = NoTrailing;
413 for (i = 0; i < 4; i++)
416 if (DoNoTrailing && c != '_')
418 DoNoTrailing = FALSE;
422 ACPI_PATH_PUT8(FullPath, PathSize, c, Length);
426 NextNode = NextNode->Parent;
429 ACPI_PATH_PUT8(FullPath, PathSize, AML_ROOT_PREFIX, Length);
431 /* Reverse the path string */
433 if (Length <= PathSize)
436 Right = FullPath+Length - 1;
446 /* Append the trailing null */
449 ACPI_PATH_PUT8 (FullPath, PathSize, '\0', Length);
451 #undef ACPI_PATH_PUT8
453 return_UINT32 (Length);
457 /*******************************************************************************
459 * FUNCTION: AcpiNsGetNormalizedPathname
461 * PARAMETERS: Node - Namespace node whose pathname is needed
462 * NoTrailing - Remove trailing '_' from each name segment
464 * RETURN: Pointer to storage containing the fully qualified name of
465 * the node, In external format (name segments separated by path
468 * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually
469 * for error and debug statements. All trailing '_' will be
470 * removed from the full pathname if 'NoTrailing' is specified..
472 ******************************************************************************/
475 AcpiNsGetNormalizedPathname (
476 ACPI_NAMESPACE_NODE *Node,
483 ACPI_FUNCTION_TRACE_PTR (NsGetNormalizedPathname, Node);
486 /* Calculate required buffer size based on depth below root */
488 Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing);
494 /* Allocate a buffer to be returned to caller */
496 NameBuffer = ACPI_ALLOCATE_ZEROED (Size);
499 ACPI_ERROR ((AE_INFO,
500 "Could not allocate %u bytes", (UINT32) Size));
504 /* Build the path in the allocated buffer */
506 (void) AcpiNsBuildNormalizedPath (Node, NameBuffer, Size, NoTrailing);
508 return_PTR (NameBuffer);