xref: /illumos-gate/usr/src/common/acpica/utilities/utdelete.c (revision 35786f6866ae52207d0f1a25fe7ca5f652f32ce0)
1 /*******************************************************************************
2  *
3  * Module Name: utdelete - object deletion and reference count utilities
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acinterp.h"
155 #include "acnamesp.h"
156 #include "acevents.h"
157 
158 
159 #define _COMPONENT          ACPI_UTILITIES
160         ACPI_MODULE_NAME    ("utdelete")
161 
162 /* Local prototypes */
163 
164 static void
165 AcpiUtDeleteInternalObj (
166     ACPI_OPERAND_OBJECT     *Object);
167 
168 static void
169 AcpiUtUpdateRefCount (
170     ACPI_OPERAND_OBJECT     *Object,
171     UINT32                  Action);
172 
173 
174 /*******************************************************************************
175  *
176  * FUNCTION:    AcpiUtDeleteInternalObj
177  *
178  * PARAMETERS:  Object         - Object to be deleted
179  *
180  * RETURN:      None
181  *
182  * DESCRIPTION: Low level object deletion, after reference counts have been
183  *              updated (All reference counts, including sub-objects!)
184  *
185  ******************************************************************************/
186 
187 static void
AcpiUtDeleteInternalObj(ACPI_OPERAND_OBJECT * Object)188 AcpiUtDeleteInternalObj (
189     ACPI_OPERAND_OBJECT     *Object)
190 {
191     void                    *ObjPointer = NULL;
192     ACPI_OPERAND_OBJECT     *HandlerDesc;
193     ACPI_OPERAND_OBJECT     *SecondDesc;
194     ACPI_OPERAND_OBJECT     *NextDesc;
195     ACPI_OPERAND_OBJECT     *StartDesc;
196     ACPI_OPERAND_OBJECT     **LastObjPtr;
197 
198 
199     ACPI_FUNCTION_TRACE_PTR (UtDeleteInternalObj, Object);
200 
201 
202     if (!Object)
203     {
204         return_VOID;
205     }
206 
207     /*
208      * Must delete or free any pointers within the object that are not
209      * actual ACPI objects (for example, a raw buffer pointer).
210      */
211     switch (Object->Common.Type)
212     {
213     case ACPI_TYPE_STRING:
214 
215         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "**** String %p, ptr %p\n",
216             Object, Object->String.Pointer));
217 
218         /* Free the actual string buffer */
219 
220         if (!(Object->Common.Flags & AOPOBJ_STATIC_POINTER))
221         {
222             /* But only if it is NOT a pointer into an ACPI table */
223 
224             ObjPointer = Object->String.Pointer;
225         }
226         break;
227 
228     case ACPI_TYPE_BUFFER:
229 
230         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "**** Buffer %p, ptr %p\n",
231             Object, Object->Buffer.Pointer));
232 
233         /* Free the actual buffer */
234 
235         if (!(Object->Common.Flags & AOPOBJ_STATIC_POINTER))
236         {
237             /* But only if it is NOT a pointer into an ACPI table */
238 
239             ObjPointer = Object->Buffer.Pointer;
240         }
241         break;
242 
243     case ACPI_TYPE_PACKAGE:
244 
245         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, " **** Package of count %X\n",
246             Object->Package.Count));
247 
248         /*
249          * Elements of the package are not handled here, they are deleted
250          * separately
251          */
252 
253         /* Free the (variable length) element pointer array */
254 
255         ObjPointer = Object->Package.Elements;
256         break;
257 
258     /*
259      * These objects have a possible list of notify handlers.
260      * Device object also may have a GPE block.
261      */
262     case ACPI_TYPE_DEVICE:
263 
264         if (Object->Device.GpeBlock)
265         {
266             (void) AcpiEvDeleteGpeBlock (Object->Device.GpeBlock);
267         }
268 
269         /*lint -fallthrough */
270 
271     case ACPI_TYPE_PROCESSOR:
272     case ACPI_TYPE_THERMAL:
273 
274         /* Walk the address handler list for this object */
275 
276         HandlerDesc = Object->CommonNotify.Handler;
277         while (HandlerDesc)
278         {
279             NextDesc = HandlerDesc->AddressSpace.Next;
280             AcpiUtRemoveReference (HandlerDesc);
281             HandlerDesc = NextDesc;
282         }
283         break;
284 
285     case ACPI_TYPE_MUTEX:
286 
287         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
288             "***** Mutex %p, OS Mutex %p\n",
289             Object, Object->Mutex.OsMutex));
290 
291         if (Object == AcpiGbl_GlobalLockMutex)
292         {
293             /* Global Lock has extra semaphore */
294 
295             (void) AcpiOsDeleteSemaphore (AcpiGbl_GlobalLockSemaphore);
296             AcpiGbl_GlobalLockSemaphore = NULL;
297 
298             AcpiOsDeleteMutex (Object->Mutex.OsMutex);
299             AcpiGbl_GlobalLockMutex = NULL;
300         }
301         else
302         {
303             AcpiExUnlinkMutex (Object);
304             AcpiOsDeleteMutex (Object->Mutex.OsMutex);
305         }
306         break;
307 
308     case ACPI_TYPE_EVENT:
309 
310         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
311             "***** Event %p, OS Semaphore %p\n",
312             Object, Object->Event.OsSemaphore));
313 
314         (void) AcpiOsDeleteSemaphore (Object->Event.OsSemaphore);
315         Object->Event.OsSemaphore = NULL;
316         break;
317 
318     case ACPI_TYPE_METHOD:
319 
320         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
321             "***** Method %p\n", Object));
322 
323         /* Delete the method mutex if it exists */
324 
325         if (Object->Method.Mutex)
326         {
327             AcpiOsDeleteMutex (Object->Method.Mutex->Mutex.OsMutex);
328             AcpiUtDeleteObjectDesc (Object->Method.Mutex);
329             Object->Method.Mutex = NULL;
330         }
331 
332         if (Object->Method.Node)
333         {
334             Object->Method.Node = NULL;
335         }
336         break;
337 
338     case ACPI_TYPE_REGION:
339 
340         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
341             "***** Region %p\n", Object));
342 
343         /*
344          * Update AddressRange list. However, only permanent regions
345          * are installed in this list. (Not created within a method)
346          */
347         if (!(Object->Region.Node->Flags & ANOBJ_TEMPORARY))
348         {
349             AcpiUtRemoveAddressRange (Object->Region.SpaceId,
350                 Object->Region.Node);
351         }
352 
353         SecondDesc = AcpiNsGetSecondaryObject (Object);
354         if (SecondDesc)
355         {
356             /*
357              * Free the RegionContext if and only if the handler is one of the
358              * default handlers -- and therefore, we created the context object
359              * locally, it was not created by an external caller.
360              */
361             HandlerDesc = Object->Region.Handler;
362             if (HandlerDesc)
363             {
364                 NextDesc = HandlerDesc->AddressSpace.RegionList;
365                 StartDesc = NextDesc;
366                 LastObjPtr = &HandlerDesc->AddressSpace.RegionList;
367 
368                 /* Remove the region object from the handler list */
369 
370                 while (NextDesc)
371                 {
372                     if (NextDesc == Object)
373                     {
374                         *LastObjPtr = NextDesc->Region.Next;
375                         break;
376                     }
377 
378                     /* Walk the linked list of handlers */
379 
380                     LastObjPtr = &NextDesc->Region.Next;
381                     NextDesc = NextDesc->Region.Next;
382 
383                     /* Prevent infinite loop if list is corrupted */
384 
385                     if (NextDesc == StartDesc)
386                     {
387                         ACPI_ERROR ((AE_INFO,
388                             "Circular region list in address handler object %p",
389                             HandlerDesc));
390                         return_VOID;
391                     }
392                 }
393 
394                 if (HandlerDesc->AddressSpace.HandlerFlags &
395                     ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)
396                 {
397                     /* Deactivate region and free region context */
398 
399                     if (HandlerDesc->AddressSpace.Setup)
400                     {
401                         (void) HandlerDesc->AddressSpace.Setup (Object,
402                             ACPI_REGION_DEACTIVATE,
403                             HandlerDesc->AddressSpace.Context,
404                             &SecondDesc->Extra.RegionContext);
405                     }
406                 }
407 
408                 AcpiUtRemoveReference (HandlerDesc);
409             }
410 
411             /* Now we can free the Extra object */
412 
413             AcpiUtDeleteObjectDesc (SecondDesc);
414         }
415         break;
416 
417     case ACPI_TYPE_BUFFER_FIELD:
418 
419         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
420             "***** Buffer Field %p\n", Object));
421 
422         SecondDesc = AcpiNsGetSecondaryObject (Object);
423         if (SecondDesc)
424         {
425             AcpiUtDeleteObjectDesc (SecondDesc);
426         }
427         break;
428 
429     case ACPI_TYPE_LOCAL_BANK_FIELD:
430 
431         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
432             "***** Bank Field %p\n", Object));
433 
434         SecondDesc = AcpiNsGetSecondaryObject (Object);
435         if (SecondDesc)
436         {
437             AcpiUtDeleteObjectDesc (SecondDesc);
438         }
439         break;
440 
441     default:
442 
443         break;
444     }
445 
446     /* Free any allocated memory (pointer within the object) found above */
447 
448     if (ObjPointer)
449     {
450         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Deleting Object Subptr %p\n",
451             ObjPointer));
452         ACPI_FREE (ObjPointer);
453     }
454 
455     /* Now the object can be safely deleted */
456 
457     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ALLOCATIONS, "%s: Deleting Object %p [%s]\n",
458         ACPI_GET_FUNCTION_NAME, Object, AcpiUtGetObjectTypeName (Object)));
459 
460     AcpiUtDeleteObjectDesc (Object);
461     return_VOID;
462 }
463 
464 
465 /*******************************************************************************
466  *
467  * FUNCTION:    AcpiUtDeleteInternalObjectList
468  *
469  * PARAMETERS:  ObjList         - Pointer to the list to be deleted
470  *
471  * RETURN:      None
472  *
473  * DESCRIPTION: This function deletes an internal object list, including both
474  *              simple objects and package objects
475  *
476  ******************************************************************************/
477 
478 void
AcpiUtDeleteInternalObjectList(ACPI_OPERAND_OBJECT ** ObjList)479 AcpiUtDeleteInternalObjectList (
480     ACPI_OPERAND_OBJECT     **ObjList)
481 {
482     ACPI_OPERAND_OBJECT     **InternalObj;
483 
484 
485     ACPI_FUNCTION_ENTRY ();
486 
487 
488     /* Walk the null-terminated internal list */
489 
490     for (InternalObj = ObjList; *InternalObj; InternalObj++)
491     {
492         AcpiUtRemoveReference (*InternalObj);
493     }
494 
495     /* Free the combined parameter pointer list and object array */
496 
497     ACPI_FREE (ObjList);
498     return;
499 }
500 
501 
502 /*******************************************************************************
503  *
504  * FUNCTION:    AcpiUtUpdateRefCount
505  *
506  * PARAMETERS:  Object          - Object whose ref count is to be updated
507  *              Action          - What to do (REF_INCREMENT or REF_DECREMENT)
508  *
509  * RETURN:      None. Sets new reference count within the object
510  *
511  * DESCRIPTION: Modify the reference count for an internal acpi object
512  *
513  ******************************************************************************/
514 
515 static void
AcpiUtUpdateRefCount(ACPI_OPERAND_OBJECT * Object,UINT32 Action)516 AcpiUtUpdateRefCount (
517     ACPI_OPERAND_OBJECT     *Object,
518     UINT32                  Action)
519 {
520     UINT16                  OriginalCount;
521     UINT16                  NewCount = 0;
522     ACPI_CPU_FLAGS          LockFlags;
523 
524 
525     ACPI_FUNCTION_NAME (UtUpdateRefCount);
526 
527 
528     if (!Object)
529     {
530         return;
531     }
532 
533     /*
534      * Always get the reference count lock. Note: Interpreter and/or
535      * Namespace is not always locked when this function is called.
536      */
537     LockFlags = AcpiOsAcquireLock (AcpiGbl_ReferenceCountLock);
538     OriginalCount = Object->Common.ReferenceCount;
539 
540     /* Perform the reference count action (increment, decrement) */
541 
542     switch (Action)
543     {
544     case REF_INCREMENT:
545 
546         NewCount = OriginalCount + 1;
547         Object->Common.ReferenceCount = NewCount;
548         AcpiOsReleaseLock (AcpiGbl_ReferenceCountLock, LockFlags);
549 
550         /* The current reference count should never be zero here */
551 
552         if (!OriginalCount)
553         {
554             ACPI_WARNING ((AE_INFO,
555                 "Obj %p, Reference Count was zero before increment\n",
556                 Object));
557         }
558 
559         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
560             "Obj %p Type %.2X [%s] Refs %.2X [Incremented]\n",
561             Object, Object->Common.Type,
562             AcpiUtGetObjectTypeName (Object), NewCount));
563         break;
564 
565     case REF_DECREMENT:
566 
567         /* The current reference count must be non-zero */
568 
569         if (OriginalCount)
570         {
571             NewCount = OriginalCount - 1;
572             Object->Common.ReferenceCount = NewCount;
573         }
574 
575         AcpiOsReleaseLock (AcpiGbl_ReferenceCountLock, LockFlags);
576 
577         if (!OriginalCount)
578         {
579             ACPI_WARNING ((AE_INFO,
580                 "Obj %p, Reference Count is already zero, cannot decrement\n",
581                 Object));
582         }
583 
584         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ALLOCATIONS,
585             "%s: Obj %p Type %.2X Refs %.2X [Decremented]\n",
586             ACPI_GET_FUNCTION_NAME, Object, Object->Common.Type, NewCount));
587 
588         /* Actually delete the object on a reference count of zero */
589 
590         if (NewCount == 0)
591         {
592             AcpiUtDeleteInternalObj (Object);
593         }
594         break;
595 
596     default:
597 
598         AcpiOsReleaseLock (AcpiGbl_ReferenceCountLock, LockFlags);
599         ACPI_ERROR ((AE_INFO, "Unknown Reference Count action (0x%X)",
600             Action));
601         return;
602     }
603 
604     /*
605      * Sanity check the reference count, for debug purposes only.
606      * (A deleted object will have a huge reference count)
607      */
608     if (NewCount > ACPI_MAX_REFERENCE_COUNT)
609     {
610         ACPI_WARNING ((AE_INFO,
611             "Large Reference Count (0x%X) in object %p, Type=0x%.2X",
612             NewCount, Object, Object->Common.Type));
613     }
614 }
615 
616 
617 /*******************************************************************************
618  *
619  * FUNCTION:    AcpiUtUpdateObjectReference
620  *
621  * PARAMETERS:  Object              - Increment ref count for this object
622  *                                    and all sub-objects
623  *              Action              - Either REF_INCREMENT or REF_DECREMENT
624  *
625  * RETURN:      Status
626  *
627  * DESCRIPTION: Increment the object reference count
628  *
629  * Object references are incremented when:
630  * 1) An object is attached to a Node (namespace object)
631  * 2) An object is copied (all subobjects must be incremented)
632  *
633  * Object references are decremented when:
634  * 1) An object is detached from an Node
635  *
636  ******************************************************************************/
637 
638 ACPI_STATUS
AcpiUtUpdateObjectReference(ACPI_OPERAND_OBJECT * Object,UINT16 Action)639 AcpiUtUpdateObjectReference (
640     ACPI_OPERAND_OBJECT     *Object,
641     UINT16                  Action)
642 {
643     ACPI_STATUS             Status = AE_OK;
644     ACPI_GENERIC_STATE      *StateList = NULL;
645     ACPI_OPERAND_OBJECT     *NextObject = NULL;
646     ACPI_OPERAND_OBJECT     *PrevObject;
647     ACPI_GENERIC_STATE      *State;
648     UINT32                  i;
649 
650 
651     ACPI_FUNCTION_NAME (UtUpdateObjectReference);
652 
653 
654     while (Object)
655     {
656         /* Make sure that this isn't a namespace handle */
657 
658         if (ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED)
659         {
660             ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
661                 "Object %p is NS handle\n", Object));
662             return (AE_OK);
663         }
664 
665         /*
666          * All sub-objects must have their reference count incremented
667          * also. Different object types have different subobjects.
668          */
669         switch (Object->Common.Type)
670         {
671         case ACPI_TYPE_DEVICE:
672         case ACPI_TYPE_PROCESSOR:
673         case ACPI_TYPE_POWER:
674         case ACPI_TYPE_THERMAL:
675             /*
676              * Update the notify objects for these types (if present)
677              * Two lists, system and device notify handlers.
678              */
679             for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++)
680             {
681                 PrevObject = Object->CommonNotify.NotifyList[i];
682                 while (PrevObject)
683                 {
684                     NextObject = PrevObject->Notify.Next[i];
685                     AcpiUtUpdateRefCount (PrevObject, Action);
686                     PrevObject = NextObject;
687                 }
688             }
689             break;
690 
691         case ACPI_TYPE_PACKAGE:
692             /*
693              * We must update all the sub-objects of the package,
694              * each of whom may have their own sub-objects.
695              */
696             for (i = 0; i < Object->Package.Count; i++)
697             {
698                 /*
699                  * Null package elements are legal and can be simply
700                  * ignored.
701                  */
702                 NextObject = Object->Package.Elements[i];
703                 if (!NextObject)
704                 {
705                     continue;
706                 }
707 
708                 switch (NextObject->Common.Type)
709                 {
710                 case ACPI_TYPE_INTEGER:
711                 case ACPI_TYPE_STRING:
712                 case ACPI_TYPE_BUFFER:
713                     /*
714                      * For these very simple sub-objects, we can just
715                      * update the reference count here and continue.
716                      * Greatly increases performance of this operation.
717                      */
718                     AcpiUtUpdateRefCount (NextObject, Action);
719                     break;
720 
721                 default:
722                     /*
723                      * For complex sub-objects, push them onto the stack
724                      * for later processing (this eliminates recursion.)
725                      */
726                     Status = AcpiUtCreateUpdateStateAndPush (
727                         NextObject, Action, &StateList);
728                     if (ACPI_FAILURE (Status))
729                     {
730                         goto ErrorExit;
731                     }
732                     break;
733                 }
734             }
735             NextObject = NULL;
736             break;
737 
738         case ACPI_TYPE_BUFFER_FIELD:
739 
740             NextObject = Object->BufferField.BufferObj;
741             break;
742 
743         case ACPI_TYPE_LOCAL_REGION_FIELD:
744 
745             NextObject = Object->Field.RegionObj;
746             break;
747 
748         case ACPI_TYPE_LOCAL_BANK_FIELD:
749 
750             NextObject = Object->BankField.BankObj;
751             Status = AcpiUtCreateUpdateStateAndPush (
752                 Object->BankField.RegionObj, Action, &StateList);
753             if (ACPI_FAILURE (Status))
754             {
755                 goto ErrorExit;
756             }
757             break;
758 
759         case ACPI_TYPE_LOCAL_INDEX_FIELD:
760 
761             NextObject = Object->IndexField.IndexObj;
762             Status = AcpiUtCreateUpdateStateAndPush (
763                 Object->IndexField.DataObj, Action, &StateList);
764             if (ACPI_FAILURE (Status))
765             {
766                 goto ErrorExit;
767             }
768             break;
769 
770         case ACPI_TYPE_LOCAL_REFERENCE:
771             /*
772              * The target of an Index (a package, string, or buffer) or a named
773              * reference must track changes to the ref count of the index or
774              * target object.
775              */
776             if ((Object->Reference.Class == ACPI_REFCLASS_INDEX) ||
777                 (Object->Reference.Class== ACPI_REFCLASS_NAME))
778             {
779                 NextObject = Object->Reference.Object;
780             }
781             break;
782 
783         case ACPI_TYPE_REGION:
784         default:
785 
786             break; /* No subobjects for all other types */
787         }
788 
789         /*
790          * Now we can update the count in the main object. This can only
791          * happen after we update the sub-objects in case this causes the
792          * main object to be deleted.
793          */
794         AcpiUtUpdateRefCount (Object, Action);
795         Object = NULL;
796 
797         /* Move on to the next object to be updated */
798 
799         if (NextObject)
800         {
801             Object = NextObject;
802             NextObject = NULL;
803         }
804         else if (StateList)
805         {
806             State = AcpiUtPopGenericState (&StateList);
807             Object = State->Update.Object;
808             AcpiUtDeleteGenericState (State);
809         }
810     }
811 
812     return (AE_OK);
813 
814 
815 ErrorExit:
816 
817     ACPI_EXCEPTION ((AE_INFO, Status,
818         "Could not update object reference count"));
819 
820     /* Free any stacked Update State objects */
821 
822     while (StateList)
823     {
824         State = AcpiUtPopGenericState (&StateList);
825         AcpiUtDeleteGenericState (State);
826     }
827 
828     return (Status);
829 }
830 
831 
832 /*******************************************************************************
833  *
834  * FUNCTION:    AcpiUtAddReference
835  *
836  * PARAMETERS:  Object          - Object whose reference count is to be
837  *                                incremented
838  *
839  * RETURN:      None
840  *
841  * DESCRIPTION: Add one reference to an ACPI object
842  *
843  ******************************************************************************/
844 
845 void
AcpiUtAddReference(ACPI_OPERAND_OBJECT * Object)846 AcpiUtAddReference (
847     ACPI_OPERAND_OBJECT     *Object)
848 {
849 
850     ACPI_FUNCTION_NAME (UtAddReference);
851 
852 
853     /* Ensure that we have a valid object */
854 
855     if (!AcpiUtValidInternalObject (Object))
856     {
857         return;
858     }
859 
860     ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
861         "Obj %p Current Refs=%X [To Be Incremented]\n",
862         Object, Object->Common.ReferenceCount));
863 
864     /* Increment the reference count */
865 
866     (void) AcpiUtUpdateObjectReference (Object, REF_INCREMENT);
867     return;
868 }
869 
870 
871 /*******************************************************************************
872  *
873  * FUNCTION:    AcpiUtRemoveReference
874  *
875  * PARAMETERS:  Object         - Object whose ref count will be decremented
876  *
877  * RETURN:      None
878  *
879  * DESCRIPTION: Decrement the reference count of an ACPI internal object
880  *
881  ******************************************************************************/
882 
883 void
AcpiUtRemoveReference(ACPI_OPERAND_OBJECT * Object)884 AcpiUtRemoveReference (
885     ACPI_OPERAND_OBJECT     *Object)
886 {
887 
888     ACPI_FUNCTION_NAME (UtRemoveReference);
889 
890 
891     /*
892      * Allow a NULL pointer to be passed in, just ignore it. This saves
893      * each caller from having to check. Also, ignore NS nodes.
894      */
895     if (!Object ||
896         (ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED))
897 
898     {
899         return;
900     }
901 
902     /* Ensure that we have a valid object */
903 
904     if (!AcpiUtValidInternalObject (Object))
905     {
906         return;
907     }
908 
909     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ALLOCATIONS,
910         "%s: Obj %p Current Refs=%X [To Be Decremented]\n",
911         ACPI_GET_FUNCTION_NAME, Object, Object->Common.ReferenceCount));
912 
913     /*
914      * Decrement the reference count, and only actually delete the object
915      * if the reference count becomes 0. (Must also decrement the ref count
916      * of all subobjects!)
917      */
918     (void) AcpiUtUpdateObjectReference (Object, REF_DECREMENT);
919     return;
920 }
921