1 /*******************************************************************************
2  *
3  * Module Name: uterror - Various internal error/warning output functions
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2019, 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 
156 
157 #define _COMPONENT          ACPI_UTILITIES
158         ACPI_MODULE_NAME    ("uterror")
159 
160 
161 /*
162  * This module contains internal error functions that may
163  * be configured out.
164  */
165 #if !defined (ACPI_NO_ERROR_MESSAGES)
166 
167 /*******************************************************************************
168  *
169  * FUNCTION:    AcpiUtPredefinedWarning
170  *
171  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
172  *              LineNumber      - Caller's line number (for error output)
173  *              Pathname        - Full pathname to the node
174  *              NodeFlags       - From Namespace node for the method/object
175  *              Format          - Printf format string + additional args
176  *
177  * RETURN:      None
178  *
179  * DESCRIPTION: Warnings for the predefined validation module. Messages are
180  *              only emitted the first time a problem with a particular
181  *              method/object is detected. This prevents a flood of error
182  *              messages for methods that are repeatedly evaluated.
183  *
184  ******************************************************************************/
185 
186 void ACPI_INTERNAL_VAR_XFACE
187 AcpiUtPredefinedWarning (
188     const char              *ModuleName,
189     UINT32                  LineNumber,
190     char                    *Pathname,
191     UINT8                   NodeFlags,
192     const char              *Format,
193     ...)
194 {
195     va_list                 ArgList;
196 
197 
198     /*
199      * Warning messages for this method/object will be disabled after the
200      * first time a validation fails or an object is successfully repaired.
201      */
202     if (NodeFlags & ANOBJ_EVALUATED)
203     {
204         return;
205     }
206 
207     AcpiOsPrintf (ACPI_MSG_WARNING "%s: ", Pathname);
208 
209     va_start (ArgList, Format);
210     AcpiOsVprintf (Format, ArgList);
211     ACPI_MSG_SUFFIX;
212     va_end (ArgList);
213 }
214 
215 
216 /*******************************************************************************
217  *
218  * FUNCTION:    AcpiUtPredefinedInfo
219  *
220  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
221  *              LineNumber      - Caller's line number (for error output)
222  *              Pathname        - Full pathname to the node
223  *              NodeFlags       - From Namespace node for the method/object
224  *              Format          - Printf format string + additional args
225  *
226  * RETURN:      None
227  *
228  * DESCRIPTION: Info messages for the predefined validation module. Messages
229  *              are only emitted the first time a problem with a particular
230  *              method/object is detected. This prevents a flood of
231  *              messages for methods that are repeatedly evaluated.
232  *
233  ******************************************************************************/
234 
235 void ACPI_INTERNAL_VAR_XFACE
236 AcpiUtPredefinedInfo (
237     const char              *ModuleName,
238     UINT32                  LineNumber,
239     char                    *Pathname,
240     UINT8                   NodeFlags,
241     const char              *Format,
242     ...)
243 {
244     va_list                 ArgList;
245 
246 
247     /*
248      * Warning messages for this method/object will be disabled after the
249      * first time a validation fails or an object is successfully repaired.
250      */
251     if (NodeFlags & ANOBJ_EVALUATED)
252     {
253         return;
254     }
255 
256     AcpiOsPrintf (ACPI_MSG_INFO "%s: ", Pathname);
257 
258     va_start (ArgList, Format);
259     AcpiOsVprintf (Format, ArgList);
260     ACPI_MSG_SUFFIX;
261     va_end (ArgList);
262 }
263 
264 
265 /*******************************************************************************
266  *
267  * FUNCTION:    AcpiUtPredefinedBiosError
268  *
269  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
270  *              LineNumber      - Caller's line number (for error output)
271  *              Pathname        - Full pathname to the node
272  *              NodeFlags       - From Namespace node for the method/object
273  *              Format          - Printf format string + additional args
274  *
275  * RETURN:      None
276  *
277  * DESCRIPTION: BIOS error message for predefined names. Messages
278  *              are only emitted the first time a problem with a particular
279  *              method/object is detected. This prevents a flood of
280  *              messages for methods that are repeatedly evaluated.
281  *
282  ******************************************************************************/
283 
284 void ACPI_INTERNAL_VAR_XFACE
285 AcpiUtPredefinedBiosError (
286     const char              *ModuleName,
287     UINT32                  LineNumber,
288     char                    *Pathname,
289     UINT8                   NodeFlags,
290     const char              *Format,
291     ...)
292 {
293     va_list                 ArgList;
294 
295 
296     /*
297      * Warning messages for this method/object will be disabled after the
298      * first time a validation fails or an object is successfully repaired.
299      */
300     if (NodeFlags & ANOBJ_EVALUATED)
301     {
302         return;
303     }
304 
305     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s: ", Pathname);
306 
307     va_start (ArgList, Format);
308     AcpiOsVprintf (Format, ArgList);
309     ACPI_MSG_SUFFIX;
310     va_end (ArgList);
311 }
312 
313 
314 /*******************************************************************************
315  *
316  * FUNCTION:    AcpiUtPrefixedNamespaceError
317  *
318  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
319  *              LineNumber          - Caller's line number (for error output)
320  *              PrefixScope         - Scope/Path that prefixes the internal path
321  *              InternalPath        - Name or path of the namespace node
322  *              LookupStatus        - Exception code from NS lookup
323  *
324  * RETURN:      None
325  *
326  * DESCRIPTION: Print error message with the full pathname constructed this way:
327  *
328  *                  PrefixScopeNodeFullPath.ExternalizedInternalPath
329  *
330  * NOTE:        10/2017: Treat the major NsLookup errors as firmware errors
331  *
332  ******************************************************************************/
333 
334 void
335 AcpiUtPrefixedNamespaceError (
336     const char              *ModuleName,
337     UINT32                  LineNumber,
338     ACPI_GENERIC_STATE      *PrefixScope,
339     const char              *InternalPath,
340     ACPI_STATUS             LookupStatus)
341 {
342     char                    *FullPath;
343     const char              *Message;
344 
345 
346     /*
347      * Main cases:
348      * 1) Object creation, object must not already exist
349      * 2) Object lookup, object must exist
350      */
351     switch (LookupStatus)
352     {
353     case AE_ALREADY_EXISTS:
354 
355         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
356         Message = "Failure creating named object";
357         break;
358 
359     case AE_NOT_FOUND:
360 
361         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
362         Message = "Could not resolve symbol";
363         break;
364 
365     default:
366 
367         AcpiOsPrintf (ACPI_MSG_ERROR);
368         Message = "Failure resolving symbol";
369         break;
370     }
371 
372     /* Concatenate the prefix path and the internal path */
373 
374     FullPath = AcpiNsBuildPrefixedPathname (PrefixScope, InternalPath);
375 
376     AcpiOsPrintf ("%s [%s], %s", Message,
377         FullPath ? FullPath : "Could not get pathname",
378         AcpiFormatException (LookupStatus));
379 
380     if (FullPath)
381     {
382         ACPI_FREE (FullPath);
383     }
384 
385     ACPI_MSG_SUFFIX;
386 }
387 
388 
389 #ifdef __OBSOLETE_FUNCTION
390 /*******************************************************************************
391  *
392  * FUNCTION:    AcpiUtNamespaceError
393  *
394  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
395  *              LineNumber          - Caller's line number (for error output)
396  *              InternalName        - Name or path of the namespace node
397  *              LookupStatus        - Exception code from NS lookup
398  *
399  * RETURN:      None
400  *
401  * DESCRIPTION: Print error message with the full pathname for the NS node.
402  *
403  ******************************************************************************/
404 
405 void
406 AcpiUtNamespaceError (
407     const char              *ModuleName,
408     UINT32                  LineNumber,
409     const char              *InternalName,
410     ACPI_STATUS             LookupStatus)
411 {
412     ACPI_STATUS             Status;
413     UINT32                  BadName;
414     char                    *Name = NULL;
415 
416 
417     ACPI_MSG_REDIRECT_BEGIN;
418     AcpiOsPrintf (ACPI_MSG_ERROR);
419 
420     if (LookupStatus == AE_BAD_CHARACTER)
421     {
422         /* There is a non-ascii character in the name */
423 
424         ACPI_MOVE_32_TO_32 (&BadName, ACPI_CAST_PTR (UINT32, InternalName));
425         AcpiOsPrintf ("[0x%.8X] (NON-ASCII)", BadName);
426     }
427     else
428     {
429         /* Convert path to external format */
430 
431         Status = AcpiNsExternalizeName (
432             ACPI_UINT32_MAX, InternalName, NULL, &Name);
433 
434         /* Print target name */
435 
436         if (ACPI_SUCCESS (Status))
437         {
438             AcpiOsPrintf ("[%s]", Name);
439         }
440         else
441         {
442             AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");
443         }
444 
445         if (Name)
446         {
447             ACPI_FREE (Name);
448         }
449     }
450 
451     AcpiOsPrintf (" Namespace lookup failure, %s",
452         AcpiFormatException (LookupStatus));
453 
454     ACPI_MSG_SUFFIX;
455     ACPI_MSG_REDIRECT_END;
456 }
457 #endif
458 
459 /*******************************************************************************
460  *
461  * FUNCTION:    AcpiUtMethodError
462  *
463  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
464  *              LineNumber          - Caller's line number (for error output)
465  *              Message             - Error message to use on failure
466  *              PrefixNode          - Prefix relative to the path
467  *              Path                - Path to the node (optional)
468  *              MethodStatus        - Execution status
469  *
470  * RETURN:      None
471  *
472  * DESCRIPTION: Print error message with the full pathname for the method.
473  *
474  ******************************************************************************/
475 
476 void
477 AcpiUtMethodError (
478     const char              *ModuleName,
479     UINT32                  LineNumber,
480     const char              *Message,
481     ACPI_NAMESPACE_NODE     *PrefixNode,
482     const char              *Path,
483     ACPI_STATUS             MethodStatus)
484 {
485     ACPI_STATUS             Status;
486     ACPI_NAMESPACE_NODE     *Node = PrefixNode;
487 
488 
489     ACPI_MSG_REDIRECT_BEGIN;
490     AcpiOsPrintf (ACPI_MSG_ERROR);
491 
492     if (Path)
493     {
494         Status = AcpiNsGetNode (PrefixNode, Path,
495             ACPI_NS_NO_UPSEARCH, &Node);
496         if (ACPI_FAILURE (Status))
497         {
498             AcpiOsPrintf ("[Could not get node by pathname]");
499         }
500     }
501 
502     AcpiNsPrintNodePathname (Node, Message);
503     AcpiOsPrintf (" due to previous error (%s)",
504         AcpiFormatException (MethodStatus));
505 
506     ACPI_MSG_SUFFIX;
507     ACPI_MSG_REDIRECT_END;
508 }
509 
510 #endif /* ACPI_NO_ERROR_MESSAGES */
511