xref: /illumos-gate/usr/src/common/acpica/namespace/nsload.c (revision 35786f6866ae52207d0f1a25fe7ca5f652f32ce0)
1 /******************************************************************************
2  *
3  * Module Name: nsload - namespace loading/expanding/contracting procedures
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 "acnamesp.h"
155 #include "acdispat.h"
156 #include "actables.h"
157 #include "acinterp.h"
158 
159 
160 #define _COMPONENT          ACPI_NAMESPACE
161         ACPI_MODULE_NAME    ("nsload")
162 
163 /* Local prototypes */
164 
165 #ifdef ACPI_FUTURE_IMPLEMENTATION
166 ACPI_STATUS
167 AcpiNsUnloadNamespace (
168     ACPI_HANDLE             Handle);
169 
170 static ACPI_STATUS
171 AcpiNsDeleteSubtree (
172     ACPI_HANDLE             StartHandle);
173 #endif
174 
175 
176 #ifndef ACPI_NO_METHOD_EXECUTION
177 /*******************************************************************************
178  *
179  * FUNCTION:    AcpiNsLoadTable
180  *
181  * PARAMETERS:  TableIndex      - Index for table to be loaded
182  *              Node            - Owning NS node
183  *
184  * RETURN:      Status
185  *
186  * DESCRIPTION: Load one ACPI table into the namespace
187  *
188  ******************************************************************************/
189 
190 ACPI_STATUS
AcpiNsLoadTable(UINT32 TableIndex,ACPI_NAMESPACE_NODE * Node)191 AcpiNsLoadTable (
192     UINT32                  TableIndex,
193     ACPI_NAMESPACE_NODE     *Node)
194 {
195     ACPI_STATUS             Status;
196 
197 
198     ACPI_FUNCTION_TRACE (NsLoadTable);
199 
200 
201     /* If table already loaded into namespace, just return */
202 
203     if (AcpiTbIsTableLoaded (TableIndex))
204     {
205         Status = AE_ALREADY_EXISTS;
206         goto Unlock;
207     }
208 
209     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
210         "**** Loading table into namespace ****\n"));
211 
212     Status = AcpiTbAllocateOwnerId (TableIndex);
213     if (ACPI_FAILURE (Status))
214     {
215         goto Unlock;
216     }
217 
218     /*
219      * Parse the table and load the namespace with all named
220      * objects found within. Control methods are NOT parsed
221      * at this time. In fact, the control methods cannot be
222      * parsed until the entire namespace is loaded, because
223      * if a control method makes a forward reference (call)
224      * to another control method, we can't continue parsing
225      * because we don't know how many arguments to parse next!
226      */
227     Status = AcpiNsParseTable (TableIndex, Node);
228     if (ACPI_SUCCESS (Status))
229     {
230         AcpiTbSetTableLoadedFlag (TableIndex, TRUE);
231     }
232     else
233     {
234         /*
235          * On error, delete any namespace objects created by this table.
236          * We cannot initialize these objects, so delete them. There are
237          * a couple of expecially bad cases:
238          * AE_ALREADY_EXISTS - namespace collision.
239          * AE_NOT_FOUND - the target of a Scope operator does not
240          * exist. This target of Scope must already exist in the
241          * namespace, as per the ACPI specification.
242          */
243         AcpiNsDeleteNamespaceByOwner (
244             AcpiGbl_RootTableList.Tables[TableIndex].OwnerId);
245 
246         AcpiTbReleaseOwnerId (TableIndex);
247         return_ACPI_STATUS (Status);
248     }
249 
250 Unlock:
251     if (ACPI_FAILURE (Status))
252     {
253         return_ACPI_STATUS (Status);
254     }
255 
256     /*
257      * Now we can parse the control methods. We always parse
258      * them here for a sanity check, and if configured for
259      * just-in-time parsing, we delete the control method
260      * parse trees.
261      */
262     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
263         "**** Begin Table Object Initialization\n"));
264 
265     AcpiExEnterInterpreter ();
266     Status = AcpiDsInitializeObjects (TableIndex, Node);
267     AcpiExExitInterpreter ();
268 
269     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
270         "**** Completed Table Object Initialization\n"));
271 
272     /*
273      * This case handles the legacy option that groups all module-level
274      * code blocks together and defers execution until all of the tables
275      * are loaded. Execute all of these blocks at this time.
276      * Execute any module-level code that was detected during the table
277      * load phase.
278      *
279      * Note: this option is deprecated and will be eliminated in the
280      * future. Use of this option can cause problems with AML code that
281      * depends upon in-order immediate execution of module-level code.
282      */
283     AcpiNsExecModuleCodeList ();
284     return_ACPI_STATUS (Status);
285 }
286 
287 
288 #ifdef ACPI_OBSOLETE_FUNCTIONS
289 /*******************************************************************************
290  *
291  * FUNCTION:    AcpiLoadNamespace
292  *
293  * PARAMETERS:  None
294  *
295  * RETURN:      Status
296  *
297  * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
298  *              (DSDT points to either the BIOS or a buffer.)
299  *
300  ******************************************************************************/
301 
302 ACPI_STATUS
AcpiNsLoadNamespace(void)303 AcpiNsLoadNamespace (
304     void)
305 {
306     ACPI_STATUS             Status;
307 
308 
309     ACPI_FUNCTION_TRACE (AcpiLoadNameSpace);
310 
311 
312     /* There must be at least a DSDT installed */
313 
314     if (AcpiGbl_DSDT == NULL)
315     {
316         ACPI_ERROR ((AE_INFO, "DSDT is not in memory"));
317         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
318     }
319 
320     /*
321      * Load the namespace. The DSDT is required,
322      * but the SSDT and PSDT tables are optional.
323      */
324     Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT);
325     if (ACPI_FAILURE (Status))
326     {
327         return_ACPI_STATUS (Status);
328     }
329 
330     /* Ignore exceptions from these */
331 
332     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT);
333     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT);
334 
335     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
336         "ACPI Namespace successfully loaded at root %p\n",
337         AcpiGbl_RootNode));
338 
339     return_ACPI_STATUS (Status);
340 }
341 #endif
342 
343 #ifdef ACPI_FUTURE_IMPLEMENTATION
344 /*******************************************************************************
345  *
346  * FUNCTION:    AcpiNsDeleteSubtree
347  *
348  * PARAMETERS:  StartHandle         - Handle in namespace where search begins
349  *
350  * RETURNS      Status
351  *
352  * DESCRIPTION: Walks the namespace starting at the given handle and deletes
353  *              all objects, entries, and scopes in the entire subtree.
354  *
355  *              Namespace/Interpreter should be locked or the subsystem should
356  *              be in shutdown before this routine is called.
357  *
358  ******************************************************************************/
359 
360 static ACPI_STATUS
AcpiNsDeleteSubtree(ACPI_HANDLE StartHandle)361 AcpiNsDeleteSubtree (
362     ACPI_HANDLE             StartHandle)
363 {
364     ACPI_STATUS             Status;
365     ACPI_HANDLE             ChildHandle;
366     ACPI_HANDLE             ParentHandle;
367     ACPI_HANDLE             NextChildHandle;
368     ACPI_HANDLE             Dummy;
369     UINT32                  Level;
370 
371 
372     ACPI_FUNCTION_TRACE (NsDeleteSubtree);
373 
374 
375     ParentHandle = StartHandle;
376     ChildHandle = NULL;
377     Level = 1;
378 
379     /*
380      * Traverse the tree of objects until we bubble back up
381      * to where we started.
382      */
383     while (Level > 0)
384     {
385         /* Attempt to get the next object in this scope */
386 
387         Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
388             ChildHandle, &NextChildHandle);
389 
390         ChildHandle = NextChildHandle;
391 
392         /* Did we get a new object? */
393 
394         if (ACPI_SUCCESS (Status))
395         {
396             /* Check if this object has any children */
397 
398             if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
399                 NULL, &Dummy)))
400             {
401                 /*
402                  * There is at least one child of this object,
403                  * visit the object
404                  */
405                 Level++;
406                 ParentHandle = ChildHandle;
407                 ChildHandle  = NULL;
408             }
409         }
410         else
411         {
412             /*
413              * No more children in this object, go back up to
414              * the object's parent
415              */
416             Level--;
417 
418             /* Delete all children now */
419 
420             AcpiNsDeleteChildren (ChildHandle);
421 
422             ChildHandle = ParentHandle;
423             Status = AcpiGetParent (ParentHandle, &ParentHandle);
424             if (ACPI_FAILURE (Status))
425             {
426                 return_ACPI_STATUS (Status);
427             }
428         }
429     }
430 
431     /* Now delete the starting object, and we are done */
432 
433     AcpiNsRemoveNode (ChildHandle);
434     return_ACPI_STATUS (AE_OK);
435 }
436 
437 
438 /*******************************************************************************
439  *
440  *  FUNCTION:       AcpiNsUnloadNameSpace
441  *
442  *  PARAMETERS:     Handle          - Root of namespace subtree to be deleted
443  *
444  *  RETURN:         Status
445  *
446  *  DESCRIPTION:    Shrinks the namespace, typically in response to an undocking
447  *                  event. Deletes an entire subtree starting from (and
448  *                  including) the given handle.
449  *
450  ******************************************************************************/
451 
452 ACPI_STATUS
AcpiNsUnloadNamespace(ACPI_HANDLE Handle)453 AcpiNsUnloadNamespace (
454     ACPI_HANDLE             Handle)
455 {
456     ACPI_STATUS             Status;
457 
458 
459     ACPI_FUNCTION_TRACE (NsUnloadNameSpace);
460 
461 
462     /* Parameter validation */
463 
464     if (!AcpiGbl_RootNode)
465     {
466         return_ACPI_STATUS (AE_NO_NAMESPACE);
467     }
468 
469     if (!Handle)
470     {
471         return_ACPI_STATUS (AE_BAD_PARAMETER);
472     }
473 
474     /* This function does the real work */
475 
476     Status = AcpiNsDeleteSubtree (Handle);
477     return_ACPI_STATUS (Status);
478 }
479 #endif
480 #endif
481