src/add-ons/kernel/bus_managers/acpi/acpica/common/adfile.c

   1 /******************************************************************************
   2  *
   3  * Module Name: adfile - Application-level disassembler file support routines
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, 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
 117 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "acapps.h"
 120
 121 #include <stdio.h>
 122
 123
 124 #define _COMPONENT          ACPI_TOOLS
 125         ACPI_MODULE_NAME    ("adfile")
 126
 127 /* Local prototypes */
 128
 129 static INT32
 130 AdWriteBuffer (
 131     char                    *Filename,
 132     char                    *Buffer,
 133     UINT32                  Length);
 134
 135 static char                 FilenameBuf[20];
 136
 137
 138 /******************************************************************************
 139  *
 140  * FUNCTION:    AfGenerateFilename
 141  *
 142  * PARAMETERS:  Prefix              - prefix string
 143  *              TableId             - The table ID
 144  *
 145  * RETURN:      Pointer to the completed string
 146  *
 147  * DESCRIPTION: Build an output filename from an ACPI table ID string
 148  *
 149  ******************************************************************************/
 150
 151 char *
 152 AdGenerateFilename (
 153     char                    *Prefix,
 154     char                    *TableId)
 155 {
 156     UINT32                  i;
 157     UINT32                  j;
 158
 159
 160     for (i = 0; Prefix[i]; i++)
 161     {
 162         FilenameBuf[i] = Prefix[i];
 163     }
 164
 165     FilenameBuf[i] = '_';
 166     i++;
 167
 168     for (j = 0; j < 8 && (TableId[j] != ' ') && (TableId[j] != 0); i++, j++)
 169     {
 170         FilenameBuf[i] = TableId[j];
 171     }
 172
 173     FilenameBuf[i] = 0;
 174     strcat (FilenameBuf, ACPI_TABLE_FILE_SUFFIX);
 175     return (FilenameBuf);
 176 }
 177
 178
 179 /******************************************************************************
 180  *
 181  * FUNCTION:    AfWriteBuffer
 182  *
 183  * PARAMETERS:  Filename            - name of file
 184  *              Buffer              - data to write
 185  *              Length              - length of data
 186  *
 187  * RETURN:      Actual number of bytes written
 188  *
 189  * DESCRIPTION: Open a file and write out a single buffer
 190  *
 191  ******************************************************************************/
 192
 193 static INT32
 194 AdWriteBuffer (
 195     char                    *Filename,
 196     char                    *Buffer,
 197     UINT32                  Length)
 198 {
 199     FILE                    *File;
 200     ACPI_SIZE               Actual;
 201
 202
 203     File = fopen (Filename, "wb");
 204     if (!File)
 205     {
 206         printf ("Could not open file %s\n", Filename);
 207         return (-1);
 208     }
 209
 210     Actual = fwrite (Buffer, 1, (size_t) Length, File);
 211     if (Actual != Length)
 212     {
 213         printf ("Could not write to file %s\n", Filename);
 214     }
 215
 216     fclose (File);
 217     return ((INT32) Actual);
 218 }
 219
 220
 221 /******************************************************************************
 222  *
 223  * FUNCTION:    AfWriteTable
 224  *
 225  * PARAMETERS:  Table               - pointer to the ACPI table
 226  *              Length              - length of the table
 227  *              TableName           - the table signature
 228  *              OemTableID          - from the table header
 229  *
 230  * RETURN:      None
 231  *
 232  * DESCRIPTION: Dump the loaded tables to a file (or files)
 233  *
 234  ******************************************************************************/
 235
 236 void
 237 AdWriteTable (
 238     ACPI_TABLE_HEADER       *Table,
 239     UINT32                  Length,
 240     char                    *TableName,
 241     char                    *OemTableId)
 242 {
 243     char                    *Filename;
 244
 245
 246     Filename = AdGenerateFilename (TableName, OemTableId);
 247     AdWriteBuffer (Filename, (char *) Table, Length);
 248
 249     AcpiOsPrintf ("Table [%s] written to \"%s\"\n", TableName, Filename);
 250 }
 251
 252
 253 /*******************************************************************************
 254  *
 255  * FUNCTION:    FlGenerateFilename
 256  *
 257  * PARAMETERS:  InputFilename       - Original ASL source filename
 258  *              Suffix              - New extension.
 259  *
 260  * RETURN:      New filename containing the original base + the new suffix
 261  *
 262  * DESCRIPTION: Generate a new filename from the ASL source filename and a new
 263  *              extension. Used to create the *.LST, *.TXT, etc. files.
 264  *
 265  ******************************************************************************/
 266
 267 char *
 268 FlGenerateFilename (
 269     char                    *InputFilename,
 270     char                    *Suffix)
 271 {
 272     char                    *Position;
 273     char                    *NewFilename;
 274     char                    *DirectoryPosition;
 275
 276
 277     /*
 278      * Copy the original filename to a new buffer. Leave room for the worst
 279      * case where we append the suffix, an added dot and the null terminator.
 280      */
 281     NewFilename = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE)
 282         strlen (InputFilename) + strlen (Suffix) + 2);
 283     if (!NewFilename)
 284     {
 285         return (NULL);
 286     }
 287
 288     strcpy (NewFilename, InputFilename);
 289
 290     /* Try to find the last dot in the filename */
 291
 292     DirectoryPosition = strrchr (NewFilename, '/');
 293     Position = strrchr (NewFilename, '.');
 294
 295     if (Position && (Position > DirectoryPosition))
 296     {
 297         /* Tack on the new suffix */
 298
 299         Position++;
 300         *Position = 0;
 301         strcat (Position, Suffix);
 302     }
 303     else
 304     {
 305         /* No dot, add one and then the suffix */
 306
 307         strcat (NewFilename, ".");
 308         strcat (NewFilename, Suffix);
 309     }
 310
 311     return (NewFilename);
 312 }
 313
 314
 315 /*******************************************************************************
 316  *
 317  * FUNCTION:    FlStrdup
 318  *
 319  * DESCRIPTION: Local strdup function
 320  *
 321  ******************************************************************************/
 322
 323 static char *
 324 FlStrdup (
 325     char                *String)
 326 {
 327     char                *NewString;
 328
 329
 330     NewString = ACPI_ALLOCATE ((ACPI_SIZE) strlen (String) + 1);
 331     if (!NewString)
 332     {
 333         return (NULL);
 334     }
 335
 336     strcpy (NewString, String);
 337     return (NewString);
 338 }
 339
 340
 341 /*******************************************************************************
 342  *
 343  * FUNCTION:    FlSplitInputPathname
 344  *
 345  * PARAMETERS:  InputFilename       - The user-specified ASL source file to be
 346  *                                    compiled
 347  *              OutDirectoryPath    - Where the directory path prefix is
 348  *                                    returned
 349  *              OutFilename         - Where the filename part is returned
 350  *
 351  * RETURN:      Status
 352  *
 353  * DESCRIPTION: Split the input path into a directory and filename part
 354  *              1) Directory part used to open include files
 355  *              2) Filename part used to generate output filenames
 356  *
 357  ******************************************************************************/
 358
 359 ACPI_STATUS
 360 FlSplitInputPathname (
 361     char                    *InputPath,
 362     char                    **OutDirectoryPath,
 363     char                    **OutFilename)
 364 {
 365     char                    *Substring;
 366     char                    *DirectoryPath;
 367     char                    *Filename;
 368
 369
 370     *OutDirectoryPath = NULL;
 371
 372     if (!InputPath)
 373     {
 374         return (AE_OK);
 375     }
 376
 377     /* Get the path to the input filename's directory */
 378
 379     DirectoryPath = FlStrdup (InputPath);
 380     if (!DirectoryPath)
 381     {
 382         return (AE_NO_MEMORY);
 383     }
 384
 385     /* Convert backslashes to slashes in the entire path */
 386
 387     UtConvertBackslashes (DirectoryPath);
 388
 389     /* Backup to last slash or colon */
 390
 391     Substring = strrchr (DirectoryPath, '/');
 392     if (!Substring)
 393     {
 394         Substring = strrchr (DirectoryPath, ':');
 395     }
 396
 397     /* Extract the simple filename */
 398
 399     if (!Substring)
 400     {
 401         Filename = FlStrdup (DirectoryPath);
 402         DirectoryPath[0] = 0;
 403     }
 404     else
 405     {
 406         Filename = FlStrdup (Substring + 1);
 407         *(Substring+1) = 0;
 408     }
 409
 410     if (!Filename)
 411     {
 412         ACPI_FREE (DirectoryPath);
 413         return (AE_NO_MEMORY);
 414     }
 415
 416     *OutDirectoryPath = DirectoryPath;
 417
 418     if (OutFilename)
 419     {
 420         *OutFilename = Filename;
 421         return (AE_OK);
 422     }
 423
 424     ACPI_FREE (Filename);
 425     return (AE_OK);
 426 }