drivers/acpi/utilities/utobject.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utobject - ACPI object create/delete/size/cache routines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/acnamesp.h>
  46 #include <acpi/amlcode.h>
  47
  48 #define _COMPONENT          ACPI_UTILITIES
  49 ACPI_MODULE_NAME("utobject")
  50
  51 /* Local prototypes */
  52 static acpi_status
  53 acpi_ut_get_simple_object_size(union acpi_operand_object *obj,
  54                                acpi_size * obj_length);
  55
  56 static acpi_status
  57 acpi_ut_get_package_object_size(union acpi_operand_object *obj,
  58                                 acpi_size * obj_length);
  59
  60 static acpi_status
  61 acpi_ut_get_element_length(u8 object_type,
  62                            union acpi_operand_object *source_object,
  63                            union acpi_generic_state *state, void *context);
  64
  65 /*******************************************************************************
  66  *
  67  * FUNCTION:    acpi_ut_create_internal_object_dbg
  68  *
  69  * PARAMETERS:  module_name         - Source file name of caller
  70  *              line_number         - Line number of caller
  71  *              component_id        - Component type of caller
  72  *              Type                - ACPI Type of the new object
  73  *
  74  * RETURN:      A new internal object, null on failure
  75  *
  76  * DESCRIPTION: Create and initialize a new internal object.
  77  *
  78  * NOTE:        We always allocate the worst-case object descriptor because
  79  *              these objects are cached, and we want them to be
  80  *              one-size-satisifies-any-request.  This in itself may not be
  81  *              the most memory efficient, but the efficiency of the object
  82  *              cache should more than make up for this!
  83  *
  84  ******************************************************************************/
  85
  86 union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
  87                                                               u32 line_number,
  88                                                               u32 component_id,
  89                                                               acpi_object_type
  90                                                               type)
  91 {
  92         union acpi_operand_object *object;
  93         union acpi_operand_object *second_object;
  94
  95         ACPI_FUNCTION_TRACE_STR("ut_create_internal_object_dbg",
  96                                 acpi_ut_get_type_name(type));
  97
  98         /* Allocate the raw object descriptor */
  99
 100         object =
 101             acpi_ut_allocate_object_desc_dbg(module_name, line_number,
 102                                              component_id);
 103         if (!object) {
 104                 return_PTR(NULL);
 105         }
 106
 107         switch (type) {
 108         case ACPI_TYPE_REGION:
 109         case ACPI_TYPE_BUFFER_FIELD:
 110
 111                 /* These types require a secondary object */
 112
 113                 second_object = acpi_ut_allocate_object_desc_dbg(module_name,
 114                                                                  line_number,
 115                                                                  component_id);
 116                 if (!second_object) {
 117                         acpi_ut_delete_object_desc(object);
 118                         return_PTR(NULL);
 119                 }
 120
 121                 second_object->common.type = ACPI_TYPE_LOCAL_EXTRA;
 122                 second_object->common.reference_count = 1;
 123
 124                 /* Link the second object to the first */
 125
 126                 object->common.next_object = second_object;
 127                 break;
 128
 129         default:
 130                 /* All others have no secondary object */
 131                 break;
 132         }
 133
 134         /* Save the object type in the object descriptor */
 135
 136         object->common.type = (u8) type;
 137
 138         /* Init the reference count */
 139
 140         object->common.reference_count = 1;
 141
 142         /* Any per-type initialization should go here */
 143
 144         return_PTR(object);
 145 }
 146
 147 /*******************************************************************************
 148  *
 149  * FUNCTION:    acpi_ut_create_buffer_object
 150  *
 151  * PARAMETERS:  buffer_size            - Size of buffer to be created
 152  *
 153  * RETURN:      Pointer to a new Buffer object, null on failure
 154  *
 155  * DESCRIPTION: Create a fully initialized buffer object
 156  *
 157  ******************************************************************************/
 158
 159 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size)
 160 {
 161         union acpi_operand_object *buffer_desc;
 162         u8 *buffer = NULL;
 163
 164         ACPI_FUNCTION_TRACE_U32("ut_create_buffer_object", buffer_size);
 165
 166         /* Create a new Buffer object */
 167
 168         buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
 169         if (!buffer_desc) {
 170                 return_PTR(NULL);
 171         }
 172
 173         /* Create an actual buffer only if size > 0 */
 174
 175         if (buffer_size > 0) {
 176                 /* Allocate the actual buffer */
 177
 178                 buffer = ACPI_MEM_CALLOCATE(buffer_size);
 179                 if (!buffer) {
 180                         ACPI_REPORT_ERROR(("Could not allocate size %X\n",
 181                                            (u32) buffer_size));
 182                         acpi_ut_remove_reference(buffer_desc);
 183                         return_PTR(NULL);
 184                 }
 185         }
 186
 187         /* Complete buffer object initialization */
 188
 189         buffer_desc->buffer.flags |= AOPOBJ_DATA_VALID;
 190         buffer_desc->buffer.pointer = buffer;
 191         buffer_desc->buffer.length = (u32) buffer_size;
 192
 193         /* Return the new buffer descriptor */
 194
 195         return_PTR(buffer_desc);
 196 }
 197
 198 /*******************************************************************************
 199  *
 200  * FUNCTION:    acpi_ut_create_string_object
 201  *
 202  * PARAMETERS:  string_size         - Size of string to be created. Does not
 203  *                                    include NULL terminator, this is added
 204  *                                    automatically.
 205  *
 206  * RETURN:      Pointer to a new String object
 207  *
 208  * DESCRIPTION: Create a fully initialized string object
 209  *
 210  ******************************************************************************/
 211
 212 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size)
 213 {
 214         union acpi_operand_object *string_desc;
 215         char *string;
 216
 217         ACPI_FUNCTION_TRACE_U32("ut_create_string_object", string_size);
 218
 219         /* Create a new String object */
 220
 221         string_desc = acpi_ut_create_internal_object(ACPI_TYPE_STRING);
 222         if (!string_desc) {
 223                 return_PTR(NULL);
 224         }
 225
 226         /*
 227          * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
 228          * NOTE: Zero-length strings are NULL terminated
 229          */
 230         string = ACPI_MEM_CALLOCATE(string_size + 1);
 231         if (!string) {
 232                 ACPI_REPORT_ERROR(("Could not allocate size %X\n",
 233                                    (u32) string_size));
 234                 acpi_ut_remove_reference(string_desc);
 235                 return_PTR(NULL);
 236         }
 237
 238         /* Complete string object initialization */
 239
 240         string_desc->string.pointer = string;
 241         string_desc->string.length = (u32) string_size;
 242
 243         /* Return the new string descriptor */
 244
 245         return_PTR(string_desc);
 246 }
 247
 248 /*******************************************************************************
 249  *
 250  * FUNCTION:    acpi_ut_valid_internal_object
 251  *
 252  * PARAMETERS:  Object              - Object to be validated
 253  *
 254  * RETURN:      TRUE if object is valid, FALSE otherwise
 255  *
 256  * DESCRIPTION: Validate a pointer to be an union acpi_operand_object
 257  *
 258  ******************************************************************************/
 259
 260 u8 acpi_ut_valid_internal_object(void *object)
 261 {
 262
 263         ACPI_FUNCTION_NAME("ut_valid_internal_object");
 264
 265         /* Check for a null pointer */
 266
 267         if (!object) {
 268                 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "**** Null Object Ptr\n"));
 269                 return (FALSE);
 270         }
 271
 272         /* Check the descriptor type field */
 273
 274         switch (ACPI_GET_DESCRIPTOR_TYPE(object)) {
 275         case ACPI_DESC_TYPE_OPERAND:
 276
 277                 /* The object appears to be a valid union acpi_operand_object    */
 278
 279                 return (TRUE);
 280
 281         default:
 282                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 283                                   "%p is not not an ACPI operand obj [%s]\n",
 284                                   object, acpi_ut_get_descriptor_name(object)));
 285                 break;
 286         }
 287
 288         return (FALSE);
 289 }
 290
 291 /*******************************************************************************
 292  *
 293  * FUNCTION:    acpi_ut_allocate_object_desc_dbg
 294  *
 295  * PARAMETERS:  module_name         - Caller's module name (for error output)
 296  *              line_number         - Caller's line number (for error output)
 297  *              component_id        - Caller's component ID (for error output)
 298  *
 299  * RETURN:      Pointer to newly allocated object descriptor.  Null on error
 300  *
 301  * DESCRIPTION: Allocate a new object descriptor.  Gracefully handle
 302  *              error conditions.
 303  *
 304  ******************************************************************************/
 305
 306 void *acpi_ut_allocate_object_desc_dbg(char *module_name,
 307                                        u32 line_number, u32 component_id)
 308 {
 309         union acpi_operand_object *object;
 310
 311         ACPI_FUNCTION_TRACE("ut_allocate_object_desc_dbg");
 312
 313         object = acpi_os_acquire_object(acpi_gbl_operand_cache);
 314         if (!object) {
 315                 _ACPI_REPORT_ERROR(module_name, line_number,
 316                                    ("Could not allocate an object descriptor\n"));
 317
 318                 return_PTR(NULL);
 319         }
 320
 321         /* Mark the descriptor type */
 322         memset(object, 0, sizeof(union acpi_operand_object));
 323         ACPI_SET_DESCRIPTOR_TYPE(object, ACPI_DESC_TYPE_OPERAND);
 324
 325         ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p Size %X\n",
 326                           object, (u32) sizeof(union acpi_operand_object)));
 327
 328         return_PTR(object);
 329 }
 330
 331 /*******************************************************************************
 332  *
 333  * FUNCTION:    acpi_ut_delete_object_desc
 334  *
 335  * PARAMETERS:  Object          - An Acpi internal object to be deleted
 336  *
 337  * RETURN:      None.
 338  *
 339  * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
 340  *
 341  ******************************************************************************/
 342
 343 void acpi_ut_delete_object_desc(union acpi_operand_object *object)
 344 {
 345         ACPI_FUNCTION_TRACE_PTR("ut_delete_object_desc", object);
 346
 347         /* Object must be an union acpi_operand_object    */
 348
 349         if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
 350                 ACPI_REPORT_ERROR(("%p is not an ACPI Operand object [%s]\n",
 351                                    object,
 352                                    acpi_ut_get_descriptor_name(object)));
 353                 return_VOID;
 354         }
 355
 356         (void)acpi_os_release_object(acpi_gbl_operand_cache, object);
 357         return_VOID;
 358 }
 359
 360 /*******************************************************************************
 361  *
 362  * FUNCTION:    acpi_ut_get_simple_object_size
 363  *
 364  * PARAMETERS:  internal_object    - An ACPI operand object
 365  *              obj_length         - Where the length is returned
 366  *
 367  * RETURN:      Status
 368  *
 369  * DESCRIPTION: This function is called to determine the space required to
 370  *              contain a simple object for return to an external user.
 371  *
 372  *              The length includes the object structure plus any additional
 373  *              needed space.
 374  *
 375  ******************************************************************************/
 376
 377 static acpi_status
 378 acpi_ut_get_simple_object_size(union acpi_operand_object *internal_object,
 379                                acpi_size * obj_length)
 380 {
 381         acpi_size length;
 382         acpi_status status = AE_OK;
 383
 384         ACPI_FUNCTION_TRACE_PTR("ut_get_simple_object_size", internal_object);
 385
 386         /*
 387          * Handle a null object (Could be a uninitialized package
 388          * element -- which is legal)
 389          */
 390         if (!internal_object) {
 391                 *obj_length = 0;
 392                 return_ACPI_STATUS(AE_OK);
 393         }
 394
 395         /* Start with the length of the Acpi object */
 396
 397         length = sizeof(union acpi_object);
 398
 399         if (ACPI_GET_DESCRIPTOR_TYPE(internal_object) == ACPI_DESC_TYPE_NAMED) {
 400                 /* Object is a named object (reference), just return the length */
 401
 402                 *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
 403                 return_ACPI_STATUS(status);
 404         }
 405
 406         /*
 407          * The final length depends on the object type
 408          * Strings and Buffers are packed right up against the parent object and
 409          * must be accessed bytewise or there may be alignment problems on
 410          * certain processors
 411          */
 412         switch (ACPI_GET_OBJECT_TYPE(internal_object)) {
 413         case ACPI_TYPE_STRING:
 414
 415                 length += (acpi_size) internal_object->string.length + 1;
 416                 break;
 417
 418         case ACPI_TYPE_BUFFER:
 419
 420                 length += (acpi_size) internal_object->buffer.length;
 421                 break;
 422
 423         case ACPI_TYPE_INTEGER:
 424         case ACPI_TYPE_PROCESSOR:
 425         case ACPI_TYPE_POWER:
 426
 427                 /*
 428                  * No extra data for these types
 429                  */
 430                 break;
 431
 432         case ACPI_TYPE_LOCAL_REFERENCE:
 433
 434                 switch (internal_object->reference.opcode) {
 435                 case AML_INT_NAMEPATH_OP:
 436
 437                         /*
 438                          * Get the actual length of the full pathname to this object.
 439                          * The reference will be converted to the pathname to the object
 440                          */
 441                         length +=
 442                             ACPI_ROUND_UP_TO_NATIVE_WORD
 443                             (acpi_ns_get_pathname_length
 444                              (internal_object->reference.node));
 445                         break;
 446
 447                 default:
 448
 449                         /*
 450                          * No other reference opcodes are supported.
 451                          * Notably, Locals and Args are not supported, but this may be
 452                          * required eventually.
 453                          */
 454                         ACPI_REPORT_ERROR(("Unsupported Reference opcode=%X in object %p\n", internal_object->reference.opcode, internal_object));
 455                         status = AE_TYPE;
 456                         break;
 457                 }
 458                 break;
 459
 460         default:
 461
 462                 ACPI_REPORT_ERROR(("Unsupported type=%X in object %p\n",
 463                                    ACPI_GET_OBJECT_TYPE(internal_object),
 464                                    internal_object));
 465                 status = AE_TYPE;
 466                 break;
 467         }
 468
 469         /*
 470          * Account for the space required by the object rounded up to the next
 471          * multiple of the machine word size.  This keeps each object aligned
 472          * on a machine word boundary. (preventing alignment faults on some
 473          * machines.)
 474          */
 475         *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
 476         return_ACPI_STATUS(status);
 477 }
 478
 479 /*******************************************************************************
 480  *
 481  * FUNCTION:    acpi_ut_get_element_length
 482  *
 483  * PARAMETERS:  acpi_pkg_callback
 484  *
 485  * RETURN:      Status
 486  *
 487  * DESCRIPTION: Get the length of one package element.
 488  *
 489  ******************************************************************************/
 490
 491 static acpi_status
 492 acpi_ut_get_element_length(u8 object_type,
 493                            union acpi_operand_object *source_object,
 494                            union acpi_generic_state *state, void *context)
 495 {
 496         acpi_status status = AE_OK;
 497         struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
 498         acpi_size object_space;
 499
 500         switch (object_type) {
 501         case ACPI_COPY_TYPE_SIMPLE:
 502
 503                 /*
 504                  * Simple object - just get the size (Null object/entry is handled
 505                  * here also) and sum it into the running package length
 506                  */
 507                 status =
 508                     acpi_ut_get_simple_object_size(source_object,
 509                                                    &object_space);
 510                 if (ACPI_FAILURE(status)) {
 511                         return (status);
 512                 }
 513
 514                 info->length += object_space;
 515                 break;
 516
 517         case ACPI_COPY_TYPE_PACKAGE:
 518
 519                 /* Package object - nothing much to do here, let the walk handle it */
 520
 521                 info->num_packages++;
 522                 state->pkg.this_target_obj = NULL;
 523                 break;
 524
 525         default:
 526
 527                 /* No other types allowed */
 528
 529                 return (AE_BAD_PARAMETER);
 530         }
 531
 532         return (status);
 533 }
 534
 535 /*******************************************************************************
 536  *
 537  * FUNCTION:    acpi_ut_get_package_object_size
 538  *
 539  * PARAMETERS:  internal_object     - An ACPI internal object
 540  *              obj_length          - Where the length is returned
 541  *
 542  * RETURN:      Status
 543  *
 544  * DESCRIPTION: This function is called to determine the space required to
 545  *              contain a package object for return to an external user.
 546  *
 547  *              This is moderately complex since a package contains other
 548  *              objects including packages.
 549  *
 550  ******************************************************************************/
 551
 552 static acpi_status
 553 acpi_ut_get_package_object_size(union acpi_operand_object *internal_object,
 554                                 acpi_size * obj_length)
 555 {
 556         acpi_status status;
 557         struct acpi_pkg_info info;
 558
 559         ACPI_FUNCTION_TRACE_PTR("ut_get_package_object_size", internal_object);
 560
 561         info.length = 0;
 562         info.object_space = 0;
 563         info.num_packages = 1;
 564
 565         status = acpi_ut_walk_package_tree(internal_object, NULL,
 566                                            acpi_ut_get_element_length, &info);
 567         if (ACPI_FAILURE(status)) {
 568                 return_ACPI_STATUS(status);
 569         }
 570
 571         /*
 572          * We have handled all of the objects in all levels of the package.
 573          * just add the length of the package objects themselves.
 574          * Round up to the next machine word.
 575          */
 576         info.length += ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object)) *
 577             (acpi_size) info.num_packages;
 578
 579         /* Return the total package length */
 580
 581         *obj_length = info.length;
 582         return_ACPI_STATUS(status);
 583 }
 584
 585 /*******************************************************************************
 586  *
 587  * FUNCTION:    acpi_ut_get_object_size
 588  *
 589  * PARAMETERS:  internal_object     - An ACPI internal object
 590  *              obj_length          - Where the length will be returned
 591  *
 592  * RETURN:      Status
 593  *
 594  * DESCRIPTION: This function is called to determine the space required to
 595  *              contain an object for return to an API user.
 596  *
 597  ******************************************************************************/
 598
 599 acpi_status
 600 acpi_ut_get_object_size(union acpi_operand_object *internal_object,
 601                         acpi_size * obj_length)
 602 {
 603         acpi_status status;
 604
 605         ACPI_FUNCTION_ENTRY();
 606
 607         if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object) ==
 608              ACPI_DESC_TYPE_OPERAND)
 609             && (ACPI_GET_OBJECT_TYPE(internal_object) == ACPI_TYPE_PACKAGE)) {
 610                 status =
 611                     acpi_ut_get_package_object_size(internal_object,
 612                                                     obj_length);
 613         } else {
 614                 status =
 615                     acpi_ut_get_simple_object_size(internal_object, obj_length);
 616         }
 617
 618         return (status);
 619 }