sys/contrib/dev/acpica-unix-20061109/interpreter/executer/exstorob.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exstorob - AML Interpreter object store support, store to object
   5  *              $Revision: 1.61 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #define __EXSTOROB_C__
 119
 120 #include "acpi.h"
 121 #include "acinterp.h"
 122
 123
 124 #define _COMPONENT          ACPI_EXECUTER
 125         ACPI_MODULE_NAME    ("exstorob")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiExStoreBufferToBuffer
 131  *
 132  * PARAMETERS:  SourceDesc          - Source object to copy
 133  *              TargetDesc          - Destination object of the copy
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: Copy a buffer object to another buffer object.
 138  *
 139  ******************************************************************************/
 140
 141 ACPI_STATUS
 142 AcpiExStoreBufferToBuffer (
 143     ACPI_OPERAND_OBJECT     *SourceDesc,
 144     ACPI_OPERAND_OBJECT     *TargetDesc)
 145 {
 146     UINT32                  Length;
 147     UINT8                   *Buffer;
 148
 149
 150     ACPI_FUNCTION_TRACE_PTR (ExStoreBufferToBuffer, SourceDesc);
 151
 152
 153     /* We know that SourceDesc is a buffer by now */
 154
 155     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->Buffer.Pointer);
 156     Length = SourceDesc->Buffer.Length;
 157
 158     /*
 159      * If target is a buffer of length zero or is a static buffer,
 160      * allocate a new buffer of the proper length
 161      */
 162     if ((TargetDesc->Buffer.Length == 0) ||
 163         (TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER))
 164     {
 165         TargetDesc->Buffer.Pointer = ACPI_ALLOCATE (Length);
 166         if (!TargetDesc->Buffer.Pointer)
 167         {
 168             return_ACPI_STATUS (AE_NO_MEMORY);
 169         }
 170
 171         TargetDesc->Buffer.Length = Length;
 172     }
 173
 174     /* Copy source buffer to target buffer */
 175
 176     if (Length <= TargetDesc->Buffer.Length)
 177     {
 178         /* Clear existing buffer and copy in the new one */
 179
 180         ACPI_MEMSET (TargetDesc->Buffer.Pointer, 0, TargetDesc->Buffer.Length);
 181         ACPI_MEMCPY (TargetDesc->Buffer.Pointer, Buffer, Length);
 182
 183 #ifdef ACPI_OBSOLETE_BEHAVIOR
 184         /*
 185          * NOTE: ACPI versions up to 3.0 specified that the buffer must be
 186          * truncated if the string is smaller than the buffer.  However, "other"
 187          * implementations of ACPI never did this and thus became the defacto
 188          * standard. ACPI 3.0A changes this behavior such that the buffer
 189          * is no longer truncated.
 190          */
 191
 192         /*
 193          * OBSOLETE BEHAVIOR:
 194          * If the original source was a string, we must truncate the buffer,
 195          * according to the ACPI spec.  Integer-to-Buffer and Buffer-to-Buffer
 196          * copy must not truncate the original buffer.
 197          */
 198         if (OriginalSrcType == ACPI_TYPE_STRING)
 199         {
 200             /* Set the new length of the target */
 201
 202             TargetDesc->Buffer.Length = Length;
 203         }
 204 #endif
 205     }
 206     else
 207     {
 208         /* Truncate the source, copy only what will fit */
 209
 210         ACPI_MEMCPY (TargetDesc->Buffer.Pointer, Buffer,
 211             TargetDesc->Buffer.Length);
 212
 213         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 214             "Truncating source buffer from %X to %X\n",
 215             Length, TargetDesc->Buffer.Length));
 216     }
 217
 218     /* Copy flags */
 219
 220     TargetDesc->Buffer.Flags = SourceDesc->Buffer.Flags;
 221     TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
 222     return_ACPI_STATUS (AE_OK);
 223 }
 224
 225
 226 /*******************************************************************************
 227  *
 228  * FUNCTION:    AcpiExStoreStringToString
 229  *
 230  * PARAMETERS:  SourceDesc          - Source object to copy
 231  *              TargetDesc          - Destination object of the copy
 232  *
 233  * RETURN:      Status
 234  *
 235  * DESCRIPTION: Copy a String object to another String object
 236  *
 237  ******************************************************************************/
 238
 239 ACPI_STATUS
 240 AcpiExStoreStringToString (
 241     ACPI_OPERAND_OBJECT     *SourceDesc,
 242     ACPI_OPERAND_OBJECT     *TargetDesc)
 243 {
 244     UINT32                  Length;
 245     UINT8                   *Buffer;
 246
 247
 248     ACPI_FUNCTION_TRACE_PTR (ExStoreStringToString, SourceDesc);
 249
 250
 251     /* We know that SourceDesc is a string by now */
 252
 253     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->String.Pointer);
 254     Length = SourceDesc->String.Length;
 255
 256     /*
 257      * Replace existing string value if it will fit and the string
 258      * pointer is not a static pointer (part of an ACPI table)
 259      */
 260     if ((Length < TargetDesc->String.Length) &&
 261        (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
 262     {
 263         /*
 264          * String will fit in existing non-static buffer.
 265          * Clear old string and copy in the new one
 266          */
 267         ACPI_MEMSET (TargetDesc->String.Pointer, 0,
 268             (ACPI_SIZE) TargetDesc->String.Length + 1);
 269         ACPI_MEMCPY (TargetDesc->String.Pointer, Buffer, Length);
 270     }
 271     else
 272     {
 273         /*
 274          * Free the current buffer, then allocate a new buffer
 275          * large enough to hold the value
 276          */
 277         if (TargetDesc->String.Pointer &&
 278            (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
 279         {
 280             /* Only free if not a pointer into the DSDT */
 281
 282             ACPI_FREE (TargetDesc->String.Pointer);
 283         }
 284
 285         TargetDesc->String.Pointer = ACPI_ALLOCATE_ZEROED (
 286                                         (ACPI_SIZE) Length + 1);
 287         if (!TargetDesc->String.Pointer)
 288         {
 289             return_ACPI_STATUS (AE_NO_MEMORY);
 290         }
 291
 292         TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
 293         ACPI_MEMCPY (TargetDesc->String.Pointer, Buffer, Length);
 294     }
 295
 296     /* Set the new target length */
 297
 298     TargetDesc->String.Length = Length;
 299     return_ACPI_STATUS (AE_OK);
 300 }
 301
 302