1 /******************************************************************************
3 * Module Name: utobject - ACPI object create/delete/size/cache routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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>
45 #include <acpi/acnamesp.h>
47 #define _COMPONENT ACPI_UTILITIES
48 ACPI_MODULE_NAME("utobject")
50 /* Local prototypes */
52 acpi_ut_get_simple_object_size(union acpi_operand_object
*obj
,
53 acpi_size
* obj_length
);
56 acpi_ut_get_package_object_size(union acpi_operand_object
*obj
,
57 acpi_size
* obj_length
);
60 acpi_ut_get_element_length(u8 object_type
,
61 union acpi_operand_object
*source_object
,
62 union acpi_generic_state
*state
, void *context
);
64 /*******************************************************************************
66 * FUNCTION: acpi_ut_create_internal_object_dbg
68 * PARAMETERS: module_name - Source file name of caller
69 * line_number - Line number of caller
70 * component_id - Component type of caller
71 * Type - ACPI Type of the new object
73 * RETURN: A new internal object, null on failure
75 * DESCRIPTION: Create and initialize a new internal object.
77 * NOTE: We always allocate the worst-case object descriptor because
78 * these objects are cached, and we want them to be
79 * one-size-satisifies-any-request. This in itself may not be
80 * the most memory efficient, but the efficiency of the object
81 * cache should more than make up for this!
83 ******************************************************************************/
85 union acpi_operand_object
*acpi_ut_create_internal_object_dbg(const char
92 union acpi_operand_object
*object
;
93 union acpi_operand_object
*second_object
;
95 ACPI_FUNCTION_TRACE_STR(ut_create_internal_object_dbg
,
96 acpi_ut_get_type_name(type
));
98 /* Allocate the raw object descriptor */
101 acpi_ut_allocate_object_desc_dbg(module_name
, line_number
,
108 case ACPI_TYPE_REGION
:
109 case ACPI_TYPE_BUFFER_FIELD
:
110 case ACPI_TYPE_LOCAL_BANK_FIELD
:
112 /* These types require a secondary object */
114 second_object
= acpi_ut_allocate_object_desc_dbg(module_name
,
117 if (!second_object
) {
118 acpi_ut_delete_object_desc(object
);
122 second_object
->common
.type
= ACPI_TYPE_LOCAL_EXTRA
;
123 second_object
->common
.reference_count
= 1;
125 /* Link the second object to the first */
127 object
->common
.next_object
= second_object
;
131 /* All others have no secondary object */
135 /* Save the object type in the object descriptor */
137 object
->common
.type
= (u8
) type
;
139 /* Init the reference count */
141 object
->common
.reference_count
= 1;
143 /* Any per-type initialization should go here */
148 /*******************************************************************************
150 * FUNCTION: acpi_ut_create_package_object
152 * PARAMETERS: Count - Number of package elements
154 * RETURN: Pointer to a new Package object, null on failure
156 * DESCRIPTION: Create a fully initialized package object
158 ******************************************************************************/
160 union acpi_operand_object
*acpi_ut_create_package_object(u32 count
)
162 union acpi_operand_object
*package_desc
;
163 union acpi_operand_object
**package_elements
;
165 ACPI_FUNCTION_TRACE_U32(ut_create_package_object
, count
);
167 /* Create a new Package object */
169 package_desc
= acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE
);
175 * Create the element array. Count+1 allows the array to be null
178 package_elements
= ACPI_ALLOCATE_ZEROED(((acpi_size
) count
+
179 1) * sizeof(void *));
180 if (!package_elements
) {
181 acpi_ut_remove_reference(package_desc
);
185 package_desc
->package
.count
= count
;
186 package_desc
->package
.elements
= package_elements
;
187 return_PTR(package_desc
);
190 /*******************************************************************************
192 * FUNCTION: acpi_ut_create_buffer_object
194 * PARAMETERS: buffer_size - Size of buffer to be created
196 * RETURN: Pointer to a new Buffer object, null on failure
198 * DESCRIPTION: Create a fully initialized buffer object
200 ******************************************************************************/
202 union acpi_operand_object
*acpi_ut_create_buffer_object(acpi_size buffer_size
)
204 union acpi_operand_object
*buffer_desc
;
207 ACPI_FUNCTION_TRACE_U32(ut_create_buffer_object
, buffer_size
);
209 /* Create a new Buffer object */
211 buffer_desc
= acpi_ut_create_internal_object(ACPI_TYPE_BUFFER
);
216 /* Create an actual buffer only if size > 0 */
218 if (buffer_size
> 0) {
220 /* Allocate the actual buffer */
222 buffer
= ACPI_ALLOCATE_ZEROED(buffer_size
);
224 ACPI_ERROR((AE_INFO
, "Could not allocate size %X",
226 acpi_ut_remove_reference(buffer_desc
);
231 /* Complete buffer object initialization */
233 buffer_desc
->buffer
.flags
|= AOPOBJ_DATA_VALID
;
234 buffer_desc
->buffer
.pointer
= buffer
;
235 buffer_desc
->buffer
.length
= (u32
) buffer_size
;
237 /* Return the new buffer descriptor */
239 return_PTR(buffer_desc
);
242 /*******************************************************************************
244 * FUNCTION: acpi_ut_create_string_object
246 * PARAMETERS: string_size - Size of string to be created. Does not
247 * include NULL terminator, this is added
250 * RETURN: Pointer to a new String object
252 * DESCRIPTION: Create a fully initialized string object
254 ******************************************************************************/
256 union acpi_operand_object
*acpi_ut_create_string_object(acpi_size string_size
)
258 union acpi_operand_object
*string_desc
;
261 ACPI_FUNCTION_TRACE_U32(ut_create_string_object
, string_size
);
263 /* Create a new String object */
265 string_desc
= acpi_ut_create_internal_object(ACPI_TYPE_STRING
);
271 * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
272 * NOTE: Zero-length strings are NULL terminated
274 string
= ACPI_ALLOCATE_ZEROED(string_size
+ 1);
276 ACPI_ERROR((AE_INFO
, "Could not allocate size %X",
278 acpi_ut_remove_reference(string_desc
);
282 /* Complete string object initialization */
284 string_desc
->string
.pointer
= string
;
285 string_desc
->string
.length
= (u32
) string_size
;
287 /* Return the new string descriptor */
289 return_PTR(string_desc
);
292 /*******************************************************************************
294 * FUNCTION: acpi_ut_valid_internal_object
296 * PARAMETERS: Object - Object to be validated
298 * RETURN: TRUE if object is valid, FALSE otherwise
300 * DESCRIPTION: Validate a pointer to be an union acpi_operand_object
302 ******************************************************************************/
304 u8
acpi_ut_valid_internal_object(void *object
)
307 ACPI_FUNCTION_NAME(ut_valid_internal_object
);
309 /* Check for a null pointer */
312 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "**** Null Object Ptr\n"));
316 /* Check the descriptor type field */
318 switch (ACPI_GET_DESCRIPTOR_TYPE(object
)) {
319 case ACPI_DESC_TYPE_OPERAND
:
321 /* The object appears to be a valid union acpi_operand_object */
326 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
327 "%p is not not an ACPI operand obj [%s]\n",
328 object
, acpi_ut_get_descriptor_name(object
)));
335 /*******************************************************************************
337 * FUNCTION: acpi_ut_allocate_object_desc_dbg
339 * PARAMETERS: module_name - Caller's module name (for error output)
340 * line_number - Caller's line number (for error output)
341 * component_id - Caller's component ID (for error output)
343 * RETURN: Pointer to newly allocated object descriptor. Null on error
345 * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
348 ******************************************************************************/
350 void *acpi_ut_allocate_object_desc_dbg(const char *module_name
,
351 u32 line_number
, u32 component_id
)
353 union acpi_operand_object
*object
;
355 ACPI_FUNCTION_TRACE(ut_allocate_object_desc_dbg
);
357 object
= acpi_os_acquire_object(acpi_gbl_operand_cache
);
359 ACPI_ERROR((module_name
, line_number
,
360 "Could not allocate an object descriptor"));
365 /* Mark the descriptor type */
367 memset(object
, 0, sizeof(union acpi_operand_object
));
368 ACPI_SET_DESCRIPTOR_TYPE(object
, ACPI_DESC_TYPE_OPERAND
);
370 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
, "%p Size %X\n",
371 object
, (u32
) sizeof(union acpi_operand_object
)));
376 /*******************************************************************************
378 * FUNCTION: acpi_ut_delete_object_desc
380 * PARAMETERS: Object - An Acpi internal object to be deleted
384 * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
386 ******************************************************************************/
388 void acpi_ut_delete_object_desc(union acpi_operand_object
*object
)
390 ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc
, object
);
392 /* Object must be an union acpi_operand_object */
394 if (ACPI_GET_DESCRIPTOR_TYPE(object
) != ACPI_DESC_TYPE_OPERAND
) {
396 "%p is not an ACPI Operand object [%s]", object
,
397 acpi_ut_get_descriptor_name(object
)));
401 (void)acpi_os_release_object(acpi_gbl_operand_cache
, object
);
405 /*******************************************************************************
407 * FUNCTION: acpi_ut_get_simple_object_size
409 * PARAMETERS: internal_object - An ACPI operand object
410 * obj_length - Where the length is returned
414 * DESCRIPTION: This function is called to determine the space required to
415 * contain a simple object for return to an external user.
417 * The length includes the object structure plus any additional
420 ******************************************************************************/
423 acpi_ut_get_simple_object_size(union acpi_operand_object
*internal_object
,
424 acpi_size
* obj_length
)
428 acpi_status status
= AE_OK
;
430 ACPI_FUNCTION_TRACE_PTR(ut_get_simple_object_size
, internal_object
);
433 * Handle a null object (Could be a uninitialized package
434 * element -- which is legal)
436 if (!internal_object
) {
437 *obj_length
= sizeof(union acpi_object
);
438 return_ACPI_STATUS(AE_OK
);
441 /* Start with the length of the Acpi object */
443 length
= sizeof(union acpi_object
);
445 if (ACPI_GET_DESCRIPTOR_TYPE(internal_object
) == ACPI_DESC_TYPE_NAMED
) {
447 /* Object is a named object (reference), just return the length */
449 *obj_length
= ACPI_ROUND_UP_TO_NATIVE_WORD(length
);
450 return_ACPI_STATUS(status
);
454 * The final length depends on the object type
455 * Strings and Buffers are packed right up against the parent object and
456 * must be accessed bytewise or there may be alignment problems on
459 switch (ACPI_GET_OBJECT_TYPE(internal_object
)) {
460 case ACPI_TYPE_STRING
:
462 length
+= (acpi_size
) internal_object
->string
.length
+ 1;
465 case ACPI_TYPE_BUFFER
:
467 length
+= (acpi_size
) internal_object
->buffer
.length
;
470 case ACPI_TYPE_INTEGER
:
471 case ACPI_TYPE_PROCESSOR
:
472 case ACPI_TYPE_POWER
:
474 /* No extra data for these types */
478 case ACPI_TYPE_LOCAL_REFERENCE
:
480 switch (internal_object
->reference
.class) {
481 case ACPI_REFCLASS_NAME
:
484 * Get the actual length of the full pathname to this object.
485 * The reference will be converted to the pathname to the object
488 acpi_ns_get_pathname_length(internal_object
->
491 return_ACPI_STATUS(AE_BAD_PARAMETER
);
494 length
+= ACPI_ROUND_UP_TO_NATIVE_WORD(size
);
500 * No other reference opcodes are supported.
501 * Notably, Locals and Args are not supported, but this may be
502 * required eventually.
505 "Cannot convert to external object - "
506 "unsupported Reference Class [%s] %X in object %p",
507 acpi_ut_get_reference_name(internal_object
),
508 internal_object
->reference
.class,
517 ACPI_ERROR((AE_INFO
, "Cannot convert to external object - "
518 "unsupported type [%s] %X in object %p",
519 acpi_ut_get_object_type_name(internal_object
),
520 ACPI_GET_OBJECT_TYPE(internal_object
),
527 * Account for the space required by the object rounded up to the next
528 * multiple of the machine word size. This keeps each object aligned
529 * on a machine word boundary. (preventing alignment faults on some
532 *obj_length
= ACPI_ROUND_UP_TO_NATIVE_WORD(length
);
533 return_ACPI_STATUS(status
);
536 /*******************************************************************************
538 * FUNCTION: acpi_ut_get_element_length
540 * PARAMETERS: acpi_pkg_callback
544 * DESCRIPTION: Get the length of one package element.
546 ******************************************************************************/
549 acpi_ut_get_element_length(u8 object_type
,
550 union acpi_operand_object
*source_object
,
551 union acpi_generic_state
*state
, void *context
)
553 acpi_status status
= AE_OK
;
554 struct acpi_pkg_info
*info
= (struct acpi_pkg_info
*)context
;
555 acpi_size object_space
;
557 switch (object_type
) {
558 case ACPI_COPY_TYPE_SIMPLE
:
561 * Simple object - just get the size (Null object/entry is handled
562 * here also) and sum it into the running package length
565 acpi_ut_get_simple_object_size(source_object
,
567 if (ACPI_FAILURE(status
)) {
571 info
->length
+= object_space
;
574 case ACPI_COPY_TYPE_PACKAGE
:
576 /* Package object - nothing much to do here, let the walk handle it */
578 info
->num_packages
++;
579 state
->pkg
.this_target_obj
= NULL
;
584 /* No other types allowed */
586 return (AE_BAD_PARAMETER
);
592 /*******************************************************************************
594 * FUNCTION: acpi_ut_get_package_object_size
596 * PARAMETERS: internal_object - An ACPI internal object
597 * obj_length - Where the length is returned
601 * DESCRIPTION: This function is called to determine the space required to
602 * contain a package object for return to an external user.
604 * This is moderately complex since a package contains other
605 * objects including packages.
607 ******************************************************************************/
610 acpi_ut_get_package_object_size(union acpi_operand_object
*internal_object
,
611 acpi_size
* obj_length
)
614 struct acpi_pkg_info info
;
616 ACPI_FUNCTION_TRACE_PTR(ut_get_package_object_size
, internal_object
);
619 info
.object_space
= 0;
620 info
.num_packages
= 1;
622 status
= acpi_ut_walk_package_tree(internal_object
, NULL
,
623 acpi_ut_get_element_length
, &info
);
624 if (ACPI_FAILURE(status
)) {
625 return_ACPI_STATUS(status
);
629 * We have handled all of the objects in all levels of the package.
630 * just add the length of the package objects themselves.
631 * Round up to the next machine word.
633 info
.length
+= ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object
)) *
634 (acpi_size
) info
.num_packages
;
636 /* Return the total package length */
638 *obj_length
= info
.length
;
639 return_ACPI_STATUS(status
);
642 /*******************************************************************************
644 * FUNCTION: acpi_ut_get_object_size
646 * PARAMETERS: internal_object - An ACPI internal object
647 * obj_length - Where the length will be returned
651 * DESCRIPTION: This function is called to determine the space required to
652 * contain an object for return to an API user.
654 ******************************************************************************/
657 acpi_ut_get_object_size(union acpi_operand_object
*internal_object
,
658 acpi_size
* obj_length
)
662 ACPI_FUNCTION_ENTRY();
664 if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object
) ==
665 ACPI_DESC_TYPE_OPERAND
)
666 && (ACPI_GET_OBJECT_TYPE(internal_object
) == ACPI_TYPE_PACKAGE
)) {
668 acpi_ut_get_package_object_size(internal_object
,
672 acpi_ut_get_simple_object_size(internal_object
, obj_length
);