1 /******************************************************************************
3 * Module Name: utobject - ACPI object create/delete/size/cache routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 */
116 acpi_ut_allocate_object_desc_dbg(module_name
, line_number
,
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
;
133 /* All others have no secondary object */
137 /* Save the object type in the object descriptor */
139 object
->common
.type
= (u8
) type
;
141 /* Init the reference count */
143 object
->common
.reference_count
= 1;
145 /* Any per-type initialization should go here */
150 /*******************************************************************************
152 * FUNCTION: acpi_ut_create_package_object
154 * PARAMETERS: count - Number of package elements
156 * RETURN: Pointer to a new Package object, null on failure
158 * DESCRIPTION: Create a fully initialized package object
160 ******************************************************************************/
162 union acpi_operand_object
*acpi_ut_create_package_object(u32 count
)
164 union acpi_operand_object
*package_desc
;
165 union acpi_operand_object
**package_elements
;
167 ACPI_FUNCTION_TRACE_U32(ut_create_package_object
, count
);
169 /* Create a new Package object */
171 package_desc
= acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE
);
177 * Create the element array. Count+1 allows the array to be null
180 package_elements
= ACPI_ALLOCATE_ZEROED(((acpi_size
)count
+
181 1) * sizeof(void *));
182 if (!package_elements
) {
183 ACPI_FREE(package_desc
);
187 package_desc
->package
.count
= count
;
188 package_desc
->package
.elements
= package_elements
;
189 return_PTR(package_desc
);
192 /*******************************************************************************
194 * FUNCTION: acpi_ut_create_integer_object
196 * PARAMETERS: initial_value - Initial value for the integer
198 * RETURN: Pointer to a new Integer object, null on failure
200 * DESCRIPTION: Create an initialized integer object
202 ******************************************************************************/
204 union acpi_operand_object
*acpi_ut_create_integer_object(u64 initial_value
)
206 union acpi_operand_object
*integer_desc
;
208 ACPI_FUNCTION_TRACE(ut_create_integer_object
);
210 /* Create and initialize a new integer object */
212 integer_desc
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
217 integer_desc
->integer
.value
= initial_value
;
218 return_PTR(integer_desc
);
221 /*******************************************************************************
223 * FUNCTION: acpi_ut_create_buffer_object
225 * PARAMETERS: buffer_size - Size of buffer to be created
227 * RETURN: Pointer to a new Buffer object, null on failure
229 * DESCRIPTION: Create a fully initialized buffer object
231 ******************************************************************************/
233 union acpi_operand_object
*acpi_ut_create_buffer_object(acpi_size buffer_size
)
235 union acpi_operand_object
*buffer_desc
;
238 ACPI_FUNCTION_TRACE_U32(ut_create_buffer_object
, buffer_size
);
240 /* Create a new Buffer object */
242 buffer_desc
= acpi_ut_create_internal_object(ACPI_TYPE_BUFFER
);
247 /* Create an actual buffer only if size > 0 */
249 if (buffer_size
> 0) {
251 /* Allocate the actual buffer */
253 buffer
= ACPI_ALLOCATE_ZEROED(buffer_size
);
255 ACPI_ERROR((AE_INFO
, "Could not allocate size %u",
258 acpi_ut_remove_reference(buffer_desc
);
263 /* Complete buffer object initialization */
265 buffer_desc
->buffer
.flags
|= AOPOBJ_DATA_VALID
;
266 buffer_desc
->buffer
.pointer
= buffer
;
267 buffer_desc
->buffer
.length
= (u32
) buffer_size
;
269 /* Return the new buffer descriptor */
271 return_PTR(buffer_desc
);
274 /*******************************************************************************
276 * FUNCTION: acpi_ut_create_string_object
278 * PARAMETERS: string_size - Size of string to be created. Does not
279 * include NULL terminator, this is added
282 * RETURN: Pointer to a new String object
284 * DESCRIPTION: Create a fully initialized string object
286 ******************************************************************************/
288 union acpi_operand_object
*acpi_ut_create_string_object(acpi_size string_size
)
290 union acpi_operand_object
*string_desc
;
293 ACPI_FUNCTION_TRACE_U32(ut_create_string_object
, string_size
);
295 /* Create a new String object */
297 string_desc
= acpi_ut_create_internal_object(ACPI_TYPE_STRING
);
303 * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
304 * NOTE: Zero-length strings are NULL terminated
306 string
= ACPI_ALLOCATE_ZEROED(string_size
+ 1);
308 ACPI_ERROR((AE_INFO
, "Could not allocate size %u",
311 acpi_ut_remove_reference(string_desc
);
315 /* Complete string object initialization */
317 string_desc
->string
.pointer
= string
;
318 string_desc
->string
.length
= (u32
) string_size
;
320 /* Return the new string descriptor */
322 return_PTR(string_desc
);
325 /*******************************************************************************
327 * FUNCTION: acpi_ut_valid_internal_object
329 * PARAMETERS: object - Object to be validated
331 * RETURN: TRUE if object is valid, FALSE otherwise
333 * DESCRIPTION: Validate a pointer to be of type union acpi_operand_object
335 ******************************************************************************/
337 u8
acpi_ut_valid_internal_object(void *object
)
340 ACPI_FUNCTION_NAME(ut_valid_internal_object
);
342 /* Check for a null pointer */
345 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "**** Null Object Ptr\n"));
349 /* Check the descriptor type field */
351 switch (ACPI_GET_DESCRIPTOR_TYPE(object
)) {
352 case ACPI_DESC_TYPE_OPERAND
:
354 /* The object appears to be a valid union acpi_operand_object */
360 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
361 "%p is not an ACPI operand obj [%s]\n",
362 object
, acpi_ut_get_descriptor_name(object
)));
369 /*******************************************************************************
371 * FUNCTION: acpi_ut_allocate_object_desc_dbg
373 * PARAMETERS: module_name - Caller's module name (for error output)
374 * line_number - Caller's line number (for error output)
375 * component_id - Caller's component ID (for error output)
377 * RETURN: Pointer to newly allocated object descriptor. Null on error
379 * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
382 ******************************************************************************/
384 void *acpi_ut_allocate_object_desc_dbg(const char *module_name
,
385 u32 line_number
, u32 component_id
)
387 union acpi_operand_object
*object
;
389 ACPI_FUNCTION_TRACE(ut_allocate_object_desc_dbg
);
391 object
= acpi_os_acquire_object(acpi_gbl_operand_cache
);
393 ACPI_ERROR((module_name
, line_number
,
394 "Could not allocate an object descriptor"));
399 /* Mark the descriptor type */
401 ACPI_SET_DESCRIPTOR_TYPE(object
, ACPI_DESC_TYPE_OPERAND
);
403 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS
, "%p Size %X\n",
404 object
, (u32
) sizeof(union acpi_operand_object
)));
409 /*******************************************************************************
411 * FUNCTION: acpi_ut_delete_object_desc
413 * PARAMETERS: object - An Acpi internal object to be deleted
417 * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
419 ******************************************************************************/
421 void acpi_ut_delete_object_desc(union acpi_operand_object
*object
)
423 ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc
, object
);
425 /* Object must be of type union acpi_operand_object */
427 if (ACPI_GET_DESCRIPTOR_TYPE(object
) != ACPI_DESC_TYPE_OPERAND
) {
429 "%p is not an ACPI Operand object [%s]", object
,
430 acpi_ut_get_descriptor_name(object
)));
434 (void)acpi_os_release_object(acpi_gbl_operand_cache
, object
);
438 /*******************************************************************************
440 * FUNCTION: acpi_ut_get_simple_object_size
442 * PARAMETERS: internal_object - An ACPI operand object
443 * obj_length - Where the length is returned
447 * DESCRIPTION: This function is called to determine the space required to
448 * contain a simple object for return to an external user.
450 * The length includes the object structure plus any additional
453 ******************************************************************************/
456 acpi_ut_get_simple_object_size(union acpi_operand_object
*internal_object
,
457 acpi_size
*obj_length
)
461 acpi_status status
= AE_OK
;
463 ACPI_FUNCTION_TRACE_PTR(ut_get_simple_object_size
, internal_object
);
465 /* Start with the length of the (external) Acpi object */
467 length
= sizeof(union acpi_object
);
469 /* A NULL object is allowed, can be a legal uninitialized package element */
471 if (!internal_object
) {
473 * Object is NULL, just return the length of union acpi_object
474 * (A NULL union acpi_object is an object of all zeroes.)
476 *obj_length
= ACPI_ROUND_UP_TO_NATIVE_WORD(length
);
477 return_ACPI_STATUS(AE_OK
);
480 /* A Namespace Node should never appear here */
482 if (ACPI_GET_DESCRIPTOR_TYPE(internal_object
) == ACPI_DESC_TYPE_NAMED
) {
484 /* A namespace node should never get here */
486 return_ACPI_STATUS(AE_AML_INTERNAL
);
490 * The final length depends on the object type
491 * Strings and Buffers are packed right up against the parent object and
492 * must be accessed bytewise or there may be alignment problems on
495 switch (internal_object
->common
.type
) {
496 case ACPI_TYPE_STRING
:
498 length
+= (acpi_size
)internal_object
->string
.length
+ 1;
501 case ACPI_TYPE_BUFFER
:
503 length
+= (acpi_size
)internal_object
->buffer
.length
;
506 case ACPI_TYPE_INTEGER
:
507 case ACPI_TYPE_PROCESSOR
:
508 case ACPI_TYPE_POWER
:
510 /* No extra data for these types */
514 case ACPI_TYPE_LOCAL_REFERENCE
:
516 switch (internal_object
->reference
.class) {
517 case ACPI_REFCLASS_NAME
:
519 * Get the actual length of the full pathname to this object.
520 * The reference will be converted to the pathname to the object
523 acpi_ns_get_pathname_length(internal_object
->
526 return_ACPI_STATUS(AE_BAD_PARAMETER
);
529 length
+= ACPI_ROUND_UP_TO_NATIVE_WORD(size
);
534 * No other reference opcodes are supported.
535 * Notably, Locals and Args are not supported, but this may be
536 * required eventually.
539 "Cannot convert to external object - "
540 "unsupported Reference Class [%s] 0x%X in object %p",
541 acpi_ut_get_reference_name(internal_object
),
542 internal_object
->reference
.class,
551 ACPI_ERROR((AE_INFO
, "Cannot convert to external object - "
552 "unsupported type [%s] 0x%X in object %p",
553 acpi_ut_get_object_type_name(internal_object
),
554 internal_object
->common
.type
, internal_object
));
560 * Account for the space required by the object rounded up to the next
561 * multiple of the machine word size. This keeps each object aligned
562 * on a machine word boundary. (preventing alignment faults on some
565 *obj_length
= ACPI_ROUND_UP_TO_NATIVE_WORD(length
);
566 return_ACPI_STATUS(status
);
569 /*******************************************************************************
571 * FUNCTION: acpi_ut_get_element_length
573 * PARAMETERS: acpi_pkg_callback
577 * DESCRIPTION: Get the length of one package element.
579 ******************************************************************************/
582 acpi_ut_get_element_length(u8 object_type
,
583 union acpi_operand_object
*source_object
,
584 union acpi_generic_state
*state
, void *context
)
586 acpi_status status
= AE_OK
;
587 struct acpi_pkg_info
*info
= (struct acpi_pkg_info
*)context
;
588 acpi_size object_space
;
590 switch (object_type
) {
591 case ACPI_COPY_TYPE_SIMPLE
:
593 * Simple object - just get the size (Null object/entry is handled
594 * here also) and sum it into the running package length
597 acpi_ut_get_simple_object_size(source_object
,
599 if (ACPI_FAILURE(status
)) {
603 info
->length
+= object_space
;
606 case ACPI_COPY_TYPE_PACKAGE
:
608 /* Package object - nothing much to do here, let the walk handle it */
610 info
->num_packages
++;
611 state
->pkg
.this_target_obj
= NULL
;
616 /* No other types allowed */
618 return (AE_BAD_PARAMETER
);
624 /*******************************************************************************
626 * FUNCTION: acpi_ut_get_package_object_size
628 * PARAMETERS: internal_object - An ACPI internal object
629 * obj_length - Where the length is returned
633 * DESCRIPTION: This function is called to determine the space required to
634 * contain a package object for return to an external user.
636 * This is moderately complex since a package contains other
637 * objects including packages.
639 ******************************************************************************/
642 acpi_ut_get_package_object_size(union acpi_operand_object
*internal_object
,
643 acpi_size
*obj_length
)
646 struct acpi_pkg_info info
;
648 ACPI_FUNCTION_TRACE_PTR(ut_get_package_object_size
, internal_object
);
651 info
.object_space
= 0;
652 info
.num_packages
= 1;
655 acpi_ut_walk_package_tree(internal_object
, NULL
,
656 acpi_ut_get_element_length
, &info
);
657 if (ACPI_FAILURE(status
)) {
658 return_ACPI_STATUS(status
);
662 * We have handled all of the objects in all levels of the package.
663 * just add the length of the package objects themselves.
664 * Round up to the next machine word.
667 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object
)) *
668 (acpi_size
)info
.num_packages
;
670 /* Return the total package length */
672 *obj_length
= info
.length
;
673 return_ACPI_STATUS(status
);
676 /*******************************************************************************
678 * FUNCTION: acpi_ut_get_object_size
680 * PARAMETERS: internal_object - An ACPI internal object
681 * obj_length - Where the length will be returned
685 * DESCRIPTION: This function is called to determine the space required to
686 * contain an object for return to an API user.
688 ******************************************************************************/
691 acpi_ut_get_object_size(union acpi_operand_object
*internal_object
,
692 acpi_size
*obj_length
)
696 ACPI_FUNCTION_ENTRY();
698 if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object
) ==
699 ACPI_DESC_TYPE_OPERAND
) &&
700 (internal_object
->common
.type
== ACPI_TYPE_PACKAGE
)) {
702 acpi_ut_get_package_object_size(internal_object
,
706 acpi_ut_get_simple_object_size(internal_object
, obj_length
);