1 /******************************************************************************
3 * Module Name: utprint - Formatted printing routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
153 #include "accommon.h"
155 #define _COMPONENT ACPI_UTILITIES
156 ACPI_MODULE_NAME ("utprint")
159 #define ACPI_FORMAT_SIGN 0x01
160 #define ACPI_FORMAT_SIGN_PLUS 0x02
161 #define ACPI_FORMAT_SIGN_PLUS_SPACE 0x04
162 #define ACPI_FORMAT_ZERO 0x08
163 #define ACPI_FORMAT_LEFT 0x10
164 #define ACPI_FORMAT_UPPER 0x20
165 #define ACPI_FORMAT_PREFIX 0x40
168 /* Local prototypes */
171 AcpiUtBoundStringLength (
176 AcpiUtBoundStringOutput (
199 /*******************************************************************************
201 * FUNCTION: AcpiUtBoundStringLength
203 * PARAMETERS: String - String with boundary
204 * Count - Boundary of the string
206 * RETURN: Length of the string. Less than or equal to Count.
208 * DESCRIPTION: Calculate the length of a string with boundary.
210 ******************************************************************************/
213 AcpiUtBoundStringLength (
220 while (*String
&& Count
)
231 /*******************************************************************************
233 * FUNCTION: AcpiUtBoundStringOutput
235 * PARAMETERS: String - String with boundary
236 * End - Boundary of the string
237 * c - Character to be output to the string
239 * RETURN: Updated position for next valid character
241 * DESCRIPTION: Output a character into a string with boundary check.
243 ******************************************************************************/
246 AcpiUtBoundStringOutput (
262 /*******************************************************************************
264 * FUNCTION: AcpiUtPutNumber
266 * PARAMETERS: String - Buffer to hold reverse-ordered string
267 * Number - Integer to be converted
268 * Base - Base of the integer
269 * Upper - Whether or not using upper cased digits
271 * RETURN: Updated position for next valid character
273 * DESCRIPTION: Convert an integer into a string, note that, the string holds a
274 * reversed ordered number without the trailing zero.
276 ******************************************************************************/
291 Digits
= Upper
? AcpiGbl_UpperHexDigits
: AcpiGbl_LowerHexDigits
;
301 (void) AcpiUtDivide (Number
, Base
, &Number
, &DigitIndex
);
302 *(Pos
++) = Digits
[DigitIndex
];
306 /* *(Pos++) = '0'; */
311 /*******************************************************************************
313 * FUNCTION: AcpiUtScanNumber
315 * PARAMETERS: String - String buffer
316 * NumberPtr - Where the number is returned
318 * RETURN: Updated position for next valid character
320 * DESCRIPTION: Scan a string for a decimal integer.
322 ******************************************************************************/
332 while (isdigit ((int) *String
))
334 AcpiUtShortMultiply (Number
, 10, &Number
);
335 Number
+= *(String
++) - '0';
343 /*******************************************************************************
345 * FUNCTION: AcpiUtPrintNumber
347 * PARAMETERS: String - String buffer
348 * Number - The number to be converted
350 * RETURN: Updated position for next valid character
352 * DESCRIPTION: Print a decimal integer into a string.
354 ******************************************************************************/
361 char AsciiString
[20];
366 Pos1
= AcpiUtPutNumber (AsciiString
, Number
, 10, FALSE
);
369 while (Pos1
!= AsciiString
)
371 *(Pos2
++) = *(--Pos1
);
379 /*******************************************************************************
381 * FUNCTION: AcpiUtFormatNumber
383 * PARAMETERS: String - String buffer with boundary
384 * End - Boundary of the string
385 * Number - The number to be converted
386 * Base - Base of the integer
387 * Width - Field width
388 * Precision - Precision of the integer
389 * Type - Special printing flags
391 * RETURN: Updated position for next valid character
393 * DESCRIPTION: Print an integer into a string with any base and any precision.
395 ******************************************************************************/
413 char ReversedString
[66];
416 /* Parameter validation */
418 if (Base
< 2 || Base
> 16)
423 if (Type
& ACPI_FORMAT_LEFT
)
425 Type
&= ~ACPI_FORMAT_ZERO
;
428 NeedPrefix
= ((Type
& ACPI_FORMAT_PREFIX
) && Base
!= 10) ? TRUE
: FALSE
;
429 Upper
= (Type
& ACPI_FORMAT_UPPER
) ? TRUE
: FALSE
;
430 Zero
= (Type
& ACPI_FORMAT_ZERO
) ? '0' : ' ';
432 /* Calculate size according to sign and prefix */
435 if (Type
& ACPI_FORMAT_SIGN
)
437 if ((INT64
) Number
< 0)
440 Number
= - (INT64
) Number
;
443 else if (Type
& ACPI_FORMAT_SIGN_PLUS
)
448 else if (Type
& ACPI_FORMAT_SIGN_PLUS_SPACE
)
463 /* Generate full string in reverse order */
465 Pos
= AcpiUtPutNumber (ReversedString
, Number
, Base
, Upper
);
466 i
= (INT32
) ACPI_PTR_DIFF (Pos
, ReversedString
);
468 /* Printing 100 using %2d gives "100", not "00" */
477 /* Output the string */
479 if (!(Type
& (ACPI_FORMAT_ZERO
| ACPI_FORMAT_LEFT
)))
483 String
= AcpiUtBoundStringOutput (String
, End
, ' ');
488 String
= AcpiUtBoundStringOutput (String
, End
, Sign
);
492 String
= AcpiUtBoundStringOutput (String
, End
, '0');
495 String
= AcpiUtBoundStringOutput (
496 String
, End
, Upper
? 'X' : 'x');
499 if (!(Type
& ACPI_FORMAT_LEFT
))
503 String
= AcpiUtBoundStringOutput (String
, End
, Zero
);
507 while (i
<= --Precision
)
509 String
= AcpiUtBoundStringOutput (String
, End
, '0');
513 String
= AcpiUtBoundStringOutput (String
, End
,
518 String
= AcpiUtBoundStringOutput (String
, End
, ' ');
525 /*******************************************************************************
527 * FUNCTION: vsnprintf
529 * PARAMETERS: String - String with boundary
530 * Size - Boundary of the string
531 * Format - Standard printf format
532 * Args - Argument list
534 * RETURN: Number of bytes actually written.
536 * DESCRIPTION: Formatted output to a string using argument list pointer.
538 ******************************************************************************/
565 for (; *Format
; ++Format
)
569 Pos
= AcpiUtBoundStringOutput (Pos
, End
, *Format
);
583 Type
|= ACPI_FORMAT_PREFIX
;
585 else if (*Format
== '0')
587 Type
|= ACPI_FORMAT_ZERO
;
589 else if (*Format
== '+')
591 Type
|= ACPI_FORMAT_SIGN_PLUS
;
593 else if (*Format
== ' ')
595 Type
|= ACPI_FORMAT_SIGN_PLUS_SPACE
;
597 else if (*Format
== '-')
599 Type
|= ACPI_FORMAT_LEFT
;
611 if (isdigit ((int) *Format
))
613 Format
= AcpiUtScanNumber (Format
, &Number
);
614 Width
= (INT32
) Number
;
616 else if (*Format
== '*')
619 Width
= va_arg (Args
, int);
623 Type
|= ACPI_FORMAT_LEFT
;
627 /* Process precision */
633 if (isdigit ((int) *Format
))
635 Format
= AcpiUtScanNumber (Format
, &Number
);
636 Precision
= (INT32
) Number
;
638 else if (*Format
== '*')
641 Precision
= va_arg (Args
, int);
650 /* Process qualifier */
653 if (*Format
== 'h' || *Format
== 'l' || *Format
== 'L')
658 if (Qualifier
== 'l' && *Format
== 'l')
669 Pos
= AcpiUtBoundStringOutput (Pos
, End
, '%');
674 if (!(Type
& ACPI_FORMAT_LEFT
))
678 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
682 c
= (char) va_arg (Args
, int);
683 Pos
= AcpiUtBoundStringOutput (Pos
, End
, c
);
687 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
693 s
= va_arg (Args
, char *);
698 Length
= (INT32
) AcpiUtBoundStringLength (s
, Precision
);
699 if (!(Type
& ACPI_FORMAT_LEFT
))
701 while (Length
< Width
--)
703 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
707 for (i
= 0; i
< Length
; ++i
)
709 Pos
= AcpiUtBoundStringOutput (Pos
, End
, *s
);
713 while (Length
< Width
--)
715 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
726 Type
|= ACPI_FORMAT_UPPER
;
737 Type
|= ACPI_FORMAT_SIGN
;
747 Width
= 2 * sizeof (void *);
748 Type
|= ACPI_FORMAT_ZERO
;
751 p
= va_arg (Args
, void *);
752 Pos
= AcpiUtFormatNumber (
753 Pos
, End
, ACPI_TO_INTEGER (p
), 16, Width
, Precision
, Type
);
758 Pos
= AcpiUtBoundStringOutput (Pos
, End
, '%');
761 Pos
= AcpiUtBoundStringOutput (Pos
, End
, *Format
);
770 if (Qualifier
== 'L')
772 Number
= va_arg (Args
, UINT64
);
773 if (Type
& ACPI_FORMAT_SIGN
)
775 Number
= (INT64
) Number
;
778 else if (Qualifier
== 'l')
780 Number
= va_arg (Args
, unsigned long);
781 if (Type
& ACPI_FORMAT_SIGN
)
783 Number
= (INT32
) Number
;
786 else if (Qualifier
== 'h')
788 Number
= (UINT16
) va_arg (Args
, int);
789 if (Type
& ACPI_FORMAT_SIGN
)
791 Number
= (INT16
) Number
;
796 Number
= va_arg (Args
, unsigned int);
797 if (Type
& ACPI_FORMAT_SIGN
)
799 Number
= (signed int) Number
;
803 Pos
= AcpiUtFormatNumber (Pos
, End
, Number
, Base
,
804 Width
, Precision
, Type
);
819 return ((int) ACPI_PTR_DIFF (Pos
, String
));
823 /*******************************************************************************
827 * PARAMETERS: String - String with boundary
828 * Size - Boundary of the string
829 * Format, ... - Standard printf format
831 * RETURN: Number of bytes actually written.
833 * DESCRIPTION: Formatted output to a string.
835 ******************************************************************************/
848 va_start (Args
, Format
);
849 Length
= vsnprintf (String
, Size
, Format
, Args
);
856 /*******************************************************************************
860 * PARAMETERS: String - String with boundary
861 * Format, ... - Standard printf format
863 * RETURN: Number of bytes actually written.
865 * DESCRIPTION: Formatted output to a string.
867 ******************************************************************************/
879 va_start (Args
, Format
);
880 Length
= vsnprintf (String
, ACPI_UINT32_MAX
, Format
, Args
);
887 #ifdef ACPI_APPLICATION
888 /*******************************************************************************
892 * PARAMETERS: Format - Standard printf format
893 * Args - Argument list
895 * RETURN: Number of bytes actually written.
897 * DESCRIPTION: Formatted output to stdout using argument list pointer.
899 ******************************************************************************/
906 ACPI_CPU_FLAGS Flags
;
910 Flags
= AcpiOsAcquireLock (AcpiGbl_PrintLock
);
911 Length
= vsnprintf (AcpiGbl_PrintBuffer
,
912 sizeof (AcpiGbl_PrintBuffer
), Format
, Args
);
914 (void) fwrite (AcpiGbl_PrintBuffer
, Length
, 1, ACPI_FILE_OUT
);
915 AcpiOsReleaseLock (AcpiGbl_PrintLock
, Flags
);
921 /*******************************************************************************
925 * PARAMETERS: Format, ... - Standard printf format
927 * RETURN: Number of bytes actually written.
929 * DESCRIPTION: Formatted output to stdout.
931 ******************************************************************************/
942 va_start (Args
, Format
);
943 Length
= vprintf (Format
, Args
);
950 /*******************************************************************************
954 * PARAMETERS: File - File descriptor
955 * Format - Standard printf format
956 * Args - Argument list
958 * RETURN: Number of bytes actually written.
960 * DESCRIPTION: Formatted output to a file using argument list pointer.
962 ******************************************************************************/
970 ACPI_CPU_FLAGS Flags
;
974 Flags
= AcpiOsAcquireLock (AcpiGbl_PrintLock
);
975 Length
= vsnprintf (AcpiGbl_PrintBuffer
,
976 sizeof (AcpiGbl_PrintBuffer
), Format
, Args
);
978 (void) fwrite (AcpiGbl_PrintBuffer
, Length
, 1, File
);
979 AcpiOsReleaseLock (AcpiGbl_PrintLock
, Flags
);
985 /*******************************************************************************
989 * PARAMETERS: File - File descriptor
990 * Format, ... - Standard printf format
992 * RETURN: Number of bytes actually written.
994 * DESCRIPTION: Formatted output to a file.
996 ******************************************************************************/
1008 va_start (Args
, Format
);
1009 Length
= vfprintf (File
, Format
, Args
);