drivers/acpi/os_specific/service_layers/osunixdir.c

   1 /******************************************************************************
   2  *
   3  * Module Name: osunixdir - Unix directory access interfaces
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, 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 #include "acpi.h"
 117
 118 #include <stdio.h>
 119 #include <stdlib.h>
 120 #include <string.h>
 121 #include <dirent.h>
 122 #include <fnmatch.h>
 123 #include <ctype.h>
 124 #include <sys/stat.h>
 125
 126 /*
 127  * Allocated structure returned from OsOpenDirectory
 128  */
 129 typedef struct ExternalFindInfo
 130 {
 131     char                        *DirPathname;
 132     DIR                         *DirPtr;
 133     char                        temp_buffer[256];
 134     char                        *WildcardSpec;
 135     char                        RequestedFileType;
 136
 137 } EXTERNAL_FIND_INFO;
 138
 139
 140 /*******************************************************************************
 141  *
 142  * FUNCTION:    AcpiOsOpenDirectory
 143  *
 144  * PARAMETERS:  DirPathname         - Full pathname to the directory
 145  *              WildcardSpec        - string of the form "*.c", etc.
 146  *
 147  * RETURN:      A directory "handle" to be used in subsequent search operations.
 148  *              NULL returned on failure.
 149  *
 150  * DESCRIPTION: Open a directory in preparation for a wildcard search
 151  *
 152  ******************************************************************************/
 153
 154 void *
 155 AcpiOsOpenDirectory (
 156     char                    *DirPathname,
 157     char                    *WildcardSpec,
 158     char                    RequestedFileType)
 159 {
 160     EXTERNAL_FIND_INFO      *ExternalInfo;
 161     DIR                     *dir;
 162
 163
 164     /* Allocate the info struct that will be returned to the caller */
 165
 166     ExternalInfo = calloc (1, sizeof (EXTERNAL_FIND_INFO));
 167     if (!ExternalInfo)
 168     {
 169         return (NULL);
 170     }
 171
 172     /* Get the directory stream */
 173
 174     dir = opendir (DirPathname);
 175     if (!dir)
 176     {
 177         fprintf (stderr, "Cannot open directory - %s\n", DirPathname);
 178         free (ExternalInfo);
 179         return (NULL);
 180     }
 181
 182     /* Save the info in the return structure */
 183
 184     ExternalInfo->WildcardSpec = WildcardSpec;
 185     ExternalInfo->RequestedFileType = RequestedFileType;
 186     ExternalInfo->DirPathname = DirPathname;
 187     ExternalInfo->DirPtr = dir;
 188     return (ExternalInfo);
 189 }
 190
 191
 192 /*******************************************************************************
 193  *
 194  * FUNCTION:    AcpiOsGetNextFilename
 195  *
 196  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
 197  *
 198  * RETURN:      Next filename matched. NULL if no more matches.
 199  *
 200  * DESCRIPTION: Get the next file in the directory that matches the wildcard
 201  *              specification.
 202  *
 203  ******************************************************************************/
 204
 205 char *
 206 AcpiOsGetNextFilename (
 207     void                    *DirHandle)
 208 {
 209     EXTERNAL_FIND_INFO      *ExternalInfo = DirHandle;
 210     struct dirent           *dir_entry;
 211     char                    *temp_str;
 212     int                     str_len;
 213     struct stat             temp_stat;
 214     int                     err;
 215
 216
 217     while ((dir_entry = readdir (ExternalInfo->DirPtr)))
 218     {
 219         if (!fnmatch (ExternalInfo->WildcardSpec, dir_entry->d_name, 0))
 220         {
 221             if (dir_entry->d_name[0] == '.')
 222             {
 223                 continue;
 224             }
 225
 226             str_len = strlen (dir_entry->d_name) +
 227                         strlen (ExternalInfo->DirPathname) + 2;
 228
 229             temp_str = calloc (str_len, 1);
 230             if (!temp_str)
 231             {
 232                 fprintf (stderr,
 233                     "Could not allocate buffer for temporary string\n");
 234                 return (NULL);
 235             }
 236
 237             strcpy (temp_str, ExternalInfo->DirPathname);
 238             strcat (temp_str, "/");
 239             strcat (temp_str, dir_entry->d_name);
 240
 241             err = stat (temp_str, &temp_stat);
 242             if (err == -1)
 243             {
 244                 fprintf (stderr,
 245                     "Cannot stat file (should not happen) - %s\n",
 246                     temp_str);
 247                 free (temp_str);
 248                 return (NULL);
 249             }
 250
 251             free (temp_str);
 252
 253             if ((S_ISDIR (temp_stat.st_mode)
 254                 && (ExternalInfo->RequestedFileType == REQUEST_DIR_ONLY))
 255                ||
 256                ((!S_ISDIR (temp_stat.st_mode)
 257                 && ExternalInfo->RequestedFileType == REQUEST_FILE_ONLY)))
 258             {
 259                 /* copy to a temp buffer because dir_entry struct is on the stack */
 260
 261                 strcpy (ExternalInfo->temp_buffer, dir_entry->d_name);
 262                 return (ExternalInfo->temp_buffer);
 263             }
 264         }
 265     }
 266
 267     return (NULL);
 268 }
 269
 270
 271 /*******************************************************************************
 272  *
 273  * FUNCTION:    AcpiOsCloseDirectory
 274  *
 275  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
 276  *
 277  * RETURN:      None.
 278  *
 279  * DESCRIPTION: Close the open directory and cleanup.
 280  *
 281  ******************************************************************************/
 282
 283 void
 284 AcpiOsCloseDirectory (
 285     void                    *DirHandle)
 286 {
 287     EXTERNAL_FIND_INFO      *ExternalInfo = DirHandle;
 288
 289
 290     /* Close the directory and free allocations */
 291
 292     closedir (ExternalInfo->DirPtr);
 293     free (DirHandle);
 294 }