src/add-ons/kernel/bus_managers/acpi/acpica/components/namespace/nsnames.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsnames - Name manipulation and search
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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
  19  * property rights.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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
  64  * make.
  65  *
  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
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  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.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  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
  88  * PARTICULAR PURPOSE.
  89  *
  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
  97  * LIMITED REMEDY.
  98  *
  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.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "amlcode.h"
 119 #include "acnamesp.h"
 120
 121
 122 #define _COMPONENT          ACPI_NAMESPACE
 123         ACPI_MODULE_NAME    ("nsnames")
 124
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    AcpiNsGetExternalPathname
 129  *
 130  * PARAMETERS:  Node            - Namespace node whose pathname is needed
 131  *
 132  * RETURN:      Pointer to storage containing the fully qualified name of
 133  *              the node, In external format (name segments separated by path
 134  *              separators.)
 135  *
 136  * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually
 137  *              for error and debug statements.
 138  *
 139  ******************************************************************************/
 140
 141 char *
 142 AcpiNsGetExternalPathname (
 143     ACPI_NAMESPACE_NODE     *Node)
 144 {
 145     char                    *NameBuffer;
 146
 147
 148     ACPI_FUNCTION_TRACE_PTR (NsGetExternalPathname, Node);
 149
 150
 151     NameBuffer = AcpiNsGetNormalizedPathname (Node, FALSE);
 152
 153     return_PTR (NameBuffer);
 154 }
 155
 156
 157 /*******************************************************************************
 158  *
 159  * FUNCTION:    AcpiNsGetPathnameLength
 160  *
 161  * PARAMETERS:  Node        - Namespace node
 162  *
 163  * RETURN:      Length of path, including prefix
 164  *
 165  * DESCRIPTION: Get the length of the pathname string for this node
 166  *
 167  ******************************************************************************/
 168
 169 ACPI_SIZE
 170 AcpiNsGetPathnameLength (
 171     ACPI_NAMESPACE_NODE     *Node)
 172 {
 173     ACPI_SIZE               Size;
 174
 175
 176     ACPI_FUNCTION_ENTRY ();
 177
 178
 179     Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, FALSE);
 180
 181     return (Size);
 182 }
 183
 184
 185 /*******************************************************************************
 186  *
 187  * FUNCTION:    AcpiNsHandleToPathname
 188  *
 189  * PARAMETERS:  TargetHandle            - Handle of named object whose name is
 190  *                                        to be found
 191  *              Buffer                  - Where the pathname is returned
 192  *              NoTrailing              - Remove trailing '_' for each name
 193  *                                        segment
 194  *
 195  * RETURN:      Status, Buffer is filled with pathname if status is AE_OK
 196  *
 197  * DESCRIPTION: Build and return a full namespace pathname
 198  *
 199  ******************************************************************************/
 200
 201 ACPI_STATUS
 202 AcpiNsHandleToPathname (
 203     ACPI_HANDLE             TargetHandle,
 204     ACPI_BUFFER             *Buffer,
 205     BOOLEAN                 NoTrailing)
 206 {
 207     ACPI_STATUS             Status;
 208     ACPI_NAMESPACE_NODE     *Node;
 209     ACPI_SIZE               RequiredSize;
 210
 211
 212     ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle);
 213
 214
 215     Node = AcpiNsValidateHandle (TargetHandle);
 216     if (!Node)
 217     {
 218         return_ACPI_STATUS (AE_BAD_PARAMETER);
 219     }
 220
 221     /* Determine size required for the caller buffer */
 222
 223     RequiredSize = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing);
 224     if (!RequiredSize)
 225     {
 226         return_ACPI_STATUS (AE_BAD_PARAMETER);
 227     }
 228
 229     /* Validate/Allocate/Clear caller buffer */
 230
 231     Status = AcpiUtInitializeBuffer (Buffer, RequiredSize);
 232     if (ACPI_FAILURE (Status))
 233     {
 234         return_ACPI_STATUS (Status);
 235     }
 236
 237     /* Build the path in the caller buffer */
 238
 239     (void) AcpiNsBuildNormalizedPath (Node, Buffer->Pointer,
 240             RequiredSize, NoTrailing);
 241     if (ACPI_FAILURE (Status))
 242     {
 243         return_ACPI_STATUS (Status);
 244     }
 245
 246     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n",
 247         (char *) Buffer->Pointer, (UINT32) RequiredSize));
 248     return_ACPI_STATUS (AE_OK);
 249 }
 250
 251
 252 /*******************************************************************************
 253  *
 254  * FUNCTION:    AcpiNsBuildNormalizedPath
 255  *
 256  * PARAMETERS:  Node        - Namespace node
 257  *              FullPath    - Where the path name is returned
 258  *              PathSize    - Size of returned path name buffer
 259  *              NoTrailing  - Remove trailing '_' from each name segment
 260  *
 261  * RETURN:      Return 1 if the AML path is empty, otherwise returning (length
 262  *              of pathname + 1) which means the 'FullPath' contains a trailing
 263  *              null.
 264  *
 265  * DESCRIPTION: Build and return a full namespace pathname.
 266  *              Note that if the size of 'FullPath' isn't large enough to
 267  *              contain the namespace node's path name, the actual required
 268  *              buffer length is returned, and it should be greater than
 269  *              'PathSize'. So callers are able to check the returning value
 270  *              to determine the buffer size of 'FullPath'.
 271  *
 272  ******************************************************************************/
 273
 274 UINT32
 275 AcpiNsBuildNormalizedPath (
 276     ACPI_NAMESPACE_NODE     *Node,
 277     char                    *FullPath,
 278     UINT32                  PathSize,
 279     BOOLEAN                 NoTrailing)
 280 {
 281     UINT32                  Length = 0, i;
 282     char                    Name[ACPI_NAME_SIZE];
 283     BOOLEAN                 DoNoTrailing;
 284     char                    c, *Left, *Right;
 285     ACPI_NAMESPACE_NODE     *NextNode;
 286
 287
 288     ACPI_FUNCTION_TRACE_PTR (NsBuildNormalizedPath, Node);
 289
 290
 291 #define ACPI_PATH_PUT8(Path, Size, Byte, Length)    \
 292     do {                                            \
 293         if ((Length) < (Size))                      \
 294         {                                           \
 295             (Path)[(Length)] = (Byte);              \
 296         }                                           \
 297         (Length)++;                                 \
 298     } while (0)
 299
 300     /*
 301      * Make sure the PathSize is correct, so that we don't need to
 302      * validate both FullPath and PathSize.
 303      */
 304     if (!FullPath)
 305     {
 306         PathSize = 0;
 307     }
 308
 309     if (!Node)
 310     {
 311         goto BuildTrailingNull;
 312     }
 313
 314     NextNode = Node;
 315     while (NextNode && NextNode != AcpiGbl_RootNode)
 316     {
 317         if (NextNode != Node)
 318         {
 319             ACPI_PATH_PUT8(FullPath, PathSize, AML_DUAL_NAME_PREFIX, Length);
 320         }
 321         ACPI_MOVE_32_TO_32 (Name, &NextNode->Name);
 322         DoNoTrailing = NoTrailing;
 323         for (i = 0; i < 4; i++)
 324         {
 325             c = Name[4-i-1];
 326             if (DoNoTrailing && c != '_')
 327             {
 328                 DoNoTrailing = FALSE;
 329             }
 330             if (!DoNoTrailing)
 331             {
 332                 ACPI_PATH_PUT8(FullPath, PathSize, c, Length);
 333             }
 334         }
 335         NextNode = NextNode->Parent;
 336     }
 337     ACPI_PATH_PUT8(FullPath, PathSize, AML_ROOT_PREFIX, Length);
 338
 339     /* Reverse the path string */
 340
 341     if (Length <= PathSize)
 342     {
 343         Left = FullPath;
 344         Right = FullPath+Length-1;
 345         while (Left < Right)
 346         {
 347             c = *Left;
 348             *Left++ = *Right;
 349             *Right-- = c;
 350         }
 351     }
 352
 353     /* Append the trailing null */
 354
 355 BuildTrailingNull:
 356     ACPI_PATH_PUT8(FullPath, PathSize, '\0', Length);
 357
 358 #undef ACPI_PATH_PUT8
 359
 360     return_UINT32 (Length);
 361 }
 362
 363
 364 /*******************************************************************************
 365  *
 366  * FUNCTION:    AcpiNsGetNormalizedPathname
 367  *
 368  * PARAMETERS:  Node            - Namespace node whose pathname is needed
 369  *              NoTrailing      - Remove trailing '_' from each name segment
 370  *
 371  * RETURN:      Pointer to storage containing the fully qualified name of
 372  *              the node, In external format (name segments separated by path
 373  *              separators.)
 374  *
 375  * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually
 376  *              for error and debug statements. All trailing '_' will be
 377  *              removed from the full pathname if 'NoTrailing' is specified..
 378  *
 379  ******************************************************************************/
 380
 381 char *
 382 AcpiNsGetNormalizedPathname (
 383     ACPI_NAMESPACE_NODE     *Node,
 384     BOOLEAN                 NoTrailing)
 385 {
 386     char                    *NameBuffer;
 387     ACPI_SIZE               Size;
 388
 389
 390     ACPI_FUNCTION_TRACE_PTR (NsGetNormalizedPathname, Node);
 391
 392
 393     /* Calculate required buffer size based on depth below root */
 394
 395     Size = AcpiNsBuildNormalizedPath (Node, NULL, 0, NoTrailing);
 396     if (!Size)
 397     {
 398         return_PTR (NULL);
 399     }
 400
 401     /* Allocate a buffer to be returned to caller */
 402
 403     NameBuffer = ACPI_ALLOCATE_ZEROED (Size);
 404     if (!NameBuffer)
 405     {
 406         ACPI_ERROR ((AE_INFO, "Could not allocate %u bytes", (UINT32) Size));
 407         return_PTR (NULL);
 408     }
 409
 410     /* Build the path in the allocated buffer */
 411
 412     (void) AcpiNsBuildNormalizedPath (Node, NameBuffer, Size, NoTrailing);
 413
 414     return_PTR (NameBuffer);
 415 }