acpica/utilities/utstring.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: utstring - Common functions for strings and characters
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155
0156
0157 #define _COMPONENT          ACPI_UTILITIES
0158         ACPI_MODULE_NAME    ("utstring")
0159
0160
0161 /*******************************************************************************
0162  *
0163  * FUNCTION:    AcpiUtPrintString
0164  *
0165  * PARAMETERS:  String          - Null terminated ASCII string
0166  *              MaxLength       - Maximum output length. Used to constrain the
0167  *                                length of strings during debug output only.
0168  *
0169  * RETURN:      None
0170  *
0171  * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
0172  *              sequences.
0173  *
0174  ******************************************************************************/
0175
0176 void
0177 AcpiUtPrintString (
0178     char                    *String,
0179     UINT16                  MaxLength)
0180 {
0181     UINT32                  i;
0182
0183
0184     if (!String)
0185     {
0186         AcpiOsPrintf ("<\"NULL STRING PTR\">");
0187         return;
0188     }
0189
0190     AcpiOsPrintf ("\"");
0191     for (i = 0; (i < MaxLength) && String[i]; i++)
0192     {
0193         /* Escape sequences */
0194
0195         switch (String[i])
0196         {
0197         case 0x07:
0198
0199             AcpiOsPrintf ("\\a");       /* BELL */
0200             break;
0201
0202         case 0x08:
0203
0204             AcpiOsPrintf ("\\b");       /* BACKSPACE */
0205             break;
0206
0207         case 0x0C:
0208
0209             AcpiOsPrintf ("\\f");       /* FORMFEED */
0210             break;
0211
0212         case 0x0A:
0213
0214             AcpiOsPrintf ("\\n");       /* LINEFEED */
0215             break;
0216
0217         case 0x0D:
0218
0219             AcpiOsPrintf ("\\r");       /* CARRIAGE RETURN*/
0220             break;
0221
0222         case 0x09:
0223
0224             AcpiOsPrintf ("\\t");       /* HORIZONTAL TAB */
0225             break;
0226
0227         case 0x0B:
0228
0229             AcpiOsPrintf ("\\v");       /* VERTICAL TAB */
0230             break;
0231
0232         case '\'':                      /* Single Quote */
0233         case '\"':                      /* Double Quote */
0234         case '\\':                      /* Backslash */
0235
0236             AcpiOsPrintf ("\\%c", (int) String[i]);
0237             break;
0238
0239         default:
0240
0241             /* Check for printable character or hex escape */
0242
0243             if (isprint ((int) String[i]))
0244             {
0245                 /* This is a normal character */
0246
0247                 AcpiOsPrintf ("%c", (int) String[i]);
0248             }
0249             else
0250             {
0251                 /* All others will be Hex escapes */
0252
0253                 AcpiOsPrintf ("\\x%2.2X", (INT32) String[i]);
0254             }
0255             break;
0256         }
0257     }
0258
0259     AcpiOsPrintf ("\"");
0260
0261     if (i == MaxLength && String[i])
0262     {
0263         AcpiOsPrintf ("...");
0264     }
0265 }
0266
0267
0268 /*******************************************************************************
0269  *
0270  * FUNCTION:    AcpiUtRepairName
0271  *
0272  * PARAMETERS:  Name            - The ACPI name to be repaired
0273  *
0274  * RETURN:      Repaired version of the name
0275  *
0276  * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and
0277  *              return the new name. NOTE: the Name parameter must reside in
0278  *              read/write memory, cannot be a const.
0279  *
0280  * An ACPI Name must consist of valid ACPI characters. We will repair the name
0281  * if necessary because we don't want to abort because of this, but we want
0282  * all namespace names to be printable. A warning message is appropriate.
0283  *
0284  * This issue came up because there are in fact machines that exhibit
0285  * this problem, and we want to be able to enable ACPI support for them,
0286  * even though there are a few bad names.
0287  *
0288  ******************************************************************************/
0289
0290 void
0291 AcpiUtRepairName (
0292     char                    *Name)
0293 {
0294     UINT32                  i;
0295     BOOLEAN                 FoundBadChar = FALSE;
0296     UINT32                  OriginalName;
0297
0298
0299     ACPI_FUNCTION_NAME (UtRepairName);
0300
0301
0302     /*
0303      * Special case for the root node. This can happen if we get an
0304      * error during the execution of module-level code.
0305      */
0306     if (ACPI_COMPARE_NAMESEG (Name, ACPI_ROOT_PATHNAME))
0307     {
0308         return;
0309     }
0310
0311     ACPI_COPY_NAMESEG (&OriginalName, &Name[0]);
0312
0313     /* Check each character in the name */
0314
0315     for (i = 0; i < ACPI_NAMESEG_SIZE; i++)
0316     {
0317         if (AcpiUtValidNameChar (Name[i], i))
0318         {
0319             continue;
0320         }
0321
0322         /*
0323          * Replace a bad character with something printable, yet technically
0324          * "odd". This prevents any collisions with existing "good"
0325          * names in the namespace.
0326          */
0327         Name[i] = '_';
0328         FoundBadChar = TRUE;
0329     }
0330
0331     if (FoundBadChar)
0332     {
0333         /* Report warning only if in strict mode or debug mode */
0334
0335         if (!AcpiGbl_EnableInterpreterSlack)
0336         {
0337             ACPI_WARNING ((AE_INFO,
0338                 "Invalid character(s) in name (0x%.8X) %p, repaired: [%4.4s]",
0339                 OriginalName, Name, &Name[0]));
0340         }
0341         else
0342         {
0343             ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0344                 "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]",
0345                 OriginalName, Name));
0346         }
0347     }
0348 }
0349
0350
0351 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
0352 /*******************************************************************************
0353  *
0354  * FUNCTION:    UtConvertBackslashes
0355  *
0356  * PARAMETERS:  Pathname        - File pathname string to be converted
0357  *
0358  * RETURN:      Modifies the input Pathname
0359  *
0360  * DESCRIPTION: Convert all backslashes (0x5C) to forward slashes (0x2F) within
0361  *              the entire input file pathname string.
0362  *
0363  ******************************************************************************/
0364
0365 void
0366 UtConvertBackslashes (
0367     char                    *Pathname)
0368 {
0369
0370     if (!Pathname)
0371     {
0372         return;
0373     }
0374
0375     while (*Pathname)
0376     {
0377         if (*Pathname == '\\')
0378         {
0379             *Pathname = '/';
0380         }
0381
0382         Pathname++;
0383     }
0384 }
0385 #endif