1 /******************************************************************************
3 * Module Name: utobject - ACPI object create/delete/size/cache routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME("utobject")
51 /* Local prototypes */
53 acpi_ut_get_simple_object_size(union acpi_operand_object *obj,
54 acpi_size * obj_length);
57 acpi_ut_get_package_object_size(union acpi_operand_object *obj,
58 acpi_size * obj_length);
61 acpi_ut_get_element_length(u8 object_type,
62 union acpi_operand_object *source_object,
63 union acpi_generic_state *state, void *context);
65 /*******************************************************************************
67 * FUNCTION: acpi_ut_create_internal_object_dbg
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
74 * RETURN: A new internal object, null on failure
76 * DESCRIPTION: Create and initialize a new internal object.
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!
84 ******************************************************************************/
86 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
93 union acpi_operand_object *object;
94 union acpi_operand_object *second_object;
96 ACPI_FUNCTION_TRACE_STR(ut_create_internal_object_dbg,
97 acpi_ut_get_type_name(type));
99 /* Allocate the raw object descriptor */
102 acpi_ut_allocate_object_desc_dbg(module_name, line_number,
109 case ACPI_TYPE_REGION:
110 case ACPI_TYPE_BUFFER_FIELD:
111 case ACPI_TYPE_LOCAL_BANK_FIELD:
113 /* These types require a secondary object */
115 second_object = acpi_ut_allocate_object_desc_dbg(module_name,
118 if (!second_object) {
119 acpi_ut_delete_object_desc(object);
123 second_object->common.type = ACPI_TYPE_LOCAL_EXTRA;
124 second_object->common.reference_count = 1;
126 /* Link the second object to the first */
128 object->common.next_object = second_object;
132 /* All others have no secondary object */
136 /* Save the object type in the object descriptor */
138 object->common.type = (u8) type;
140 /* Init the reference count */
142 object->common.reference_count = 1;
144 /* Any per-type initialization should go here */
149 /*******************************************************************************
151 * FUNCTION: acpi_ut_create_package_object
153 * PARAMETERS: Count - Number of package elements
155 * RETURN: Pointer to a new Package object, null on failure
157 * DESCRIPTION: Create a fully initialized package object
159 ******************************************************************************/
161 union acpi_operand_object *acpi_ut_create_package_object(u32 count)
163 union acpi_operand_object *package_desc;
164 union acpi_operand_object **package_elements;
166 ACPI_FUNCTION_TRACE_U32(ut_create_package_object, count);
168 /* Create a new Package object */
170 package_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
176 * Create the element array. Count+1 allows the array to be null
179 package_elements = ACPI_ALLOCATE_ZEROED(((acpi_size) count +
180 1) * sizeof(void *));
181 if (!package_elements) {
182 acpi_ut_remove_reference(package_desc);
186 package_desc->package.count = count;
187 package_desc->package.elements = package_elements;
188 return_PTR(package_desc);
191 /*******************************************************************************
193 * FUNCTION: acpi_ut_create_integer_object
195 * PARAMETERS: initial_value - Initial value for the integer
197 * RETURN: Pointer to a new Integer object, null on failure
199 * DESCRIPTION: Create an initialized integer object
201 ******************************************************************************/
203 union acpi_operand_object *acpi_ut_create_integer_object(u64 initial_value)
205 union acpi_operand_object *integer_desc;
207 ACPI_FUNCTION_TRACE(ut_create_integer_object);
209 /* Create and initialize a new integer object */
211 integer_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
216 integer_desc->integer.value = initial_value;
217 return_PTR(integer_desc);
220 /*******************************************************************************
222 * FUNCTION: acpi_ut_create_buffer_object
224 * PARAMETERS: buffer_size - Size of buffer to be created
226 * RETURN: Pointer to a new Buffer object, null on failure
228 * DESCRIPTION: Create a fully initialized buffer object
230 ******************************************************************************/
232 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size)
234 union acpi_operand_object *buffer_desc;
237 ACPI_FUNCTION_TRACE_U32(ut_create_buffer_object, buffer_size);
239 /* Create a new Buffer object */
241 buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
246 /* Create an actual buffer only if size > 0 */
248 if (buffer_size > 0) {
250 /* Allocate the actual buffer */
252 buffer = ACPI_ALLOCATE_ZEROED(buffer_size);
254 ACPI_ERROR((AE_INFO, "Could not allocate size %u",
256 acpi_ut_remove_reference(buffer_desc);
261 /* Complete buffer object initialization */
263 buffer_desc->buffer.flags |= AOPOBJ_DATA_VALID;
264 buffer_desc->buffer.pointer = buffer;
265 buffer_desc->buffer.length = (u32) buffer_size;
267 /* Return the new buffer descriptor */
269 return_PTR(buffer_desc);
272 /*******************************************************************************
274 * FUNCTION: acpi_ut_create_string_object
276 * PARAMETERS: string_size - Size of string to be created. Does not
277 * include NULL terminator, this is added
280 * RETURN: Pointer to a new String object
282 * DESCRIPTION: Create a fully initialized string object
284 ******************************************************************************/
286 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size)
288 union acpi_operand_object *string_desc;
291 ACPI_FUNCTION_TRACE_U32(ut_create_string_object, string_size);
293 /* Create a new String object */
295 string_desc = acpi_ut_create_internal_object(ACPI_TYPE_STRING);
301 * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
302 * NOTE: Zero-length strings are NULL terminated
304 string = ACPI_ALLOCATE_ZEROED(string_size + 1);
306 ACPI_ERROR((AE_INFO, "Could not allocate size %u",
308 acpi_ut_remove_reference(string_desc);
312 /* Complete string object initialization */
314 string_desc->string.pointer = string;
315 string_desc->string.length = (u32) string_size;
317 /* Return the new string descriptor */
319 return_PTR(string_desc);
322 /*******************************************************************************
324 * FUNCTION: acpi_ut_valid_internal_object
326 * PARAMETERS: Object - Object to be validated
328 * RETURN: TRUE if object is valid, FALSE otherwise
330 * DESCRIPTION: Validate a pointer to be a union acpi_operand_object
332 ******************************************************************************/
334 u8 acpi_ut_valid_internal_object(void *object)
337 ACPI_FUNCTION_NAME(ut_valid_internal_object);
339 /* Check for a null pointer */
342 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "**** Null Object Ptr\n"));
346 /* Check the descriptor type field */
348 switch (ACPI_GET_DESCRIPTOR_TYPE(object)) {
349 case ACPI_DESC_TYPE_OPERAND:
351 /* The object appears to be a valid union acpi_operand_object */
356 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
357 "%p is not not an ACPI operand obj [%s]\n",
358 object, acpi_ut_get_descriptor_name(object)));
365 /*******************************************************************************
367 * FUNCTION: acpi_ut_allocate_object_desc_dbg
369 * PARAMETERS: module_name - Caller's module name (for error output)
370 * line_number - Caller's line number (for error output)
371 * component_id - Caller's component ID (for error output)
373 * RETURN: Pointer to newly allocated object descriptor. Null on error
375 * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
378 ******************************************************************************/
380 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
381 u32 line_number, u32 component_id)
383 union acpi_operand_object *object;
385 ACPI_FUNCTION_TRACE(ut_allocate_object_desc_dbg);
387 object = acpi_os_acquire_object(acpi_gbl_operand_cache);
389 ACPI_ERROR((module_name, line_number,
390 "Could not allocate an object descriptor"));
395 /* Mark the descriptor type */
397 memset(object, 0, sizeof(union acpi_operand_object));
398 ACPI_SET_DESCRIPTOR_TYPE(object, ACPI_DESC_TYPE_OPERAND);
400 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p Size %X\n",
401 object, (u32) sizeof(union acpi_operand_object)));
406 /*******************************************************************************
408 * FUNCTION: acpi_ut_delete_object_desc
410 * PARAMETERS: Object - An Acpi internal object to be deleted
414 * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
416 ******************************************************************************/
418 void acpi_ut_delete_object_desc(union acpi_operand_object *object)
420 ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc, object);
422 /* Object must be a union acpi_operand_object */
424 if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
426 "%p is not an ACPI Operand object [%s]", object,
427 acpi_ut_get_descriptor_name(object)));
431 (void)acpi_os_release_object(acpi_gbl_operand_cache, object);
435 /*******************************************************************************
437 * FUNCTION: acpi_ut_get_simple_object_size
439 * PARAMETERS: internal_object - An ACPI operand object
440 * obj_length - Where the length is returned
444 * DESCRIPTION: This function is called to determine the space required to
445 * contain a simple object for return to an external user.
447 * The length includes the object structure plus any additional
450 ******************************************************************************/
453 acpi_ut_get_simple_object_size(union acpi_operand_object *internal_object,
454 acpi_size * obj_length)
458 acpi_status status = AE_OK;
460 ACPI_FUNCTION_TRACE_PTR(ut_get_simple_object_size, internal_object);
463 * Handle a null object (Could be a uninitialized package
464 * element -- which is legal)
466 if (!internal_object) {
467 *obj_length = sizeof(union acpi_object);
468 return_ACPI_STATUS(AE_OK);
471 /* Start with the length of the Acpi object */
473 length = sizeof(union acpi_object);
475 if (ACPI_GET_DESCRIPTOR_TYPE(internal_object) == ACPI_DESC_TYPE_NAMED) {
477 /* Object is a named object (reference), just return the length */
479 *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
480 return_ACPI_STATUS(status);
484 * The final length depends on the object type
485 * Strings and Buffers are packed right up against the parent object and
486 * must be accessed bytewise or there may be alignment problems on
489 switch (internal_object->common.type) {
490 case ACPI_TYPE_STRING:
492 length += (acpi_size) internal_object->string.length + 1;
495 case ACPI_TYPE_BUFFER:
497 length += (acpi_size) internal_object->buffer.length;
500 case ACPI_TYPE_INTEGER:
501 case ACPI_TYPE_PROCESSOR:
502 case ACPI_TYPE_POWER:
504 /* No extra data for these types */
508 case ACPI_TYPE_LOCAL_REFERENCE:
510 switch (internal_object->reference.class) {
511 case ACPI_REFCLASS_NAME:
514 * Get the actual length of the full pathname to this object.
515 * The reference will be converted to the pathname to the object
518 acpi_ns_get_pathname_length(internal_object->
521 return_ACPI_STATUS(AE_BAD_PARAMETER);
524 length += ACPI_ROUND_UP_TO_NATIVE_WORD(size);
530 * No other reference opcodes are supported.
531 * Notably, Locals and Args are not supported, but this may be
532 * required eventually.
535 "Cannot convert to external object - "
536 "unsupported Reference Class [%s] 0x%X in object %p",
537 acpi_ut_get_reference_name(internal_object),
538 internal_object->reference.class,
547 ACPI_ERROR((AE_INFO, "Cannot convert to external object - "
548 "unsupported type [%s] 0x%X in object %p",
549 acpi_ut_get_object_type_name(internal_object),
550 internal_object->common.type, internal_object));
556 * Account for the space required by the object rounded up to the next
557 * multiple of the machine word size. This keeps each object aligned
558 * on a machine word boundary. (preventing alignment faults on some
561 *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
562 return_ACPI_STATUS(status);
565 /*******************************************************************************
567 * FUNCTION: acpi_ut_get_element_length
569 * PARAMETERS: acpi_pkg_callback
573 * DESCRIPTION: Get the length of one package element.
575 ******************************************************************************/
578 acpi_ut_get_element_length(u8 object_type,
579 union acpi_operand_object *source_object,
580 union acpi_generic_state *state, void *context)
582 acpi_status status = AE_OK;
583 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
584 acpi_size object_space;
586 switch (object_type) {
587 case ACPI_COPY_TYPE_SIMPLE:
590 * Simple object - just get the size (Null object/entry is handled
591 * here also) and sum it into the running package length
594 acpi_ut_get_simple_object_size(source_object,
596 if (ACPI_FAILURE(status)) {
600 info->length += object_space;
603 case ACPI_COPY_TYPE_PACKAGE:
605 /* Package object - nothing much to do here, let the walk handle it */
607 info->num_packages++;
608 state->pkg.this_target_obj = NULL;
613 /* No other types allowed */
615 return (AE_BAD_PARAMETER);
621 /*******************************************************************************
623 * FUNCTION: acpi_ut_get_package_object_size
625 * PARAMETERS: internal_object - An ACPI internal object
626 * obj_length - Where the length is returned
630 * DESCRIPTION: This function is called to determine the space required to
631 * contain a package object for return to an external user.
633 * This is moderately complex since a package contains other
634 * objects including packages.
636 ******************************************************************************/
639 acpi_ut_get_package_object_size(union acpi_operand_object *internal_object,
640 acpi_size * obj_length)
643 struct acpi_pkg_info info;
645 ACPI_FUNCTION_TRACE_PTR(ut_get_package_object_size, internal_object);
648 info.object_space = 0;
649 info.num_packages = 1;
651 status = acpi_ut_walk_package_tree(internal_object, NULL,
652 acpi_ut_get_element_length, &info);
653 if (ACPI_FAILURE(status)) {
654 return_ACPI_STATUS(status);
658 * We have handled all of the objects in all levels of the package.
659 * just add the length of the package objects themselves.
660 * Round up to the next machine word.
662 info.length += ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object)) *
663 (acpi_size) info.num_packages;
665 /* Return the total package length */
667 *obj_length = info.length;
668 return_ACPI_STATUS(status);
671 /*******************************************************************************
673 * FUNCTION: acpi_ut_get_object_size
675 * PARAMETERS: internal_object - An ACPI internal object
676 * obj_length - Where the length will be returned
680 * DESCRIPTION: This function is called to determine the space required to
681 * contain an object for return to an API user.
683 ******************************************************************************/
686 acpi_ut_get_object_size(union acpi_operand_object *internal_object,
687 acpi_size * obj_length)
691 ACPI_FUNCTION_ENTRY();
693 if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object) ==
694 ACPI_DESC_TYPE_OPERAND)
695 && (internal_object->common.type == ACPI_TYPE_PACKAGE)) {
697 acpi_ut_get_package_object_size(internal_object,
701 acpi_ut_get_simple_object_size(internal_object, obj_length);