sys/contrib/dev/acpica/nsnames.c

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