sys/contrib/dev/acpica/source/os_specific/service_layers/oswindir.c

   1 /******************************************************************************
   2  *
   3  * Module Name: oswindir - Windows directory access interfaces
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, 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
 154 #include <stdio.h>
 155 #include <stdlib.h>
 156 #include <string.h>
 157 #include <io.h>
 158
 159 typedef struct ExternalFindInfo
 160 {
 161     struct _finddata_t          DosInfo;
 162     char                        *FullWildcardSpec;
 163     long                        FindHandle;
 164     char                        State;
 165     char                        RequestedFileType;
 166
 167 } EXTERNAL_FIND_INFO;
 168
 169
 170 /*******************************************************************************
 171  *
 172  * FUNCTION:    AcpiOsOpenDirectory
 173  *
 174  * PARAMETERS:  DirPathname         - Full pathname to the directory
 175  *              WildcardSpec        - string of the form "*.c", etc.
 176  *              RequestedFileType   - Either a directory or normal file
 177  *
 178  * RETURN:      A directory "handle" to be used in subsequent search operations.
 179  *              NULL returned on failure.
 180  *
 181  * DESCRIPTION: Open a directory in preparation for a wildcard search
 182  *
 183  ******************************************************************************/
 184
 185 void *
 186 AcpiOsOpenDirectory (
 187     char                    *DirPathname,
 188     char                    *WildcardSpec,
 189     char                    RequestedFileType)
 190 {
 191     long                    FindHandle;
 192     char                    *FullWildcardSpec;
 193     EXTERNAL_FIND_INFO      *SearchInfo;
 194
 195
 196     /* No directory path means "use current directory" - use a dot */
 197
 198     if (!DirPathname || strlen (DirPathname) == 0)
 199     {
 200         DirPathname = ".";
 201     }
 202
 203     /* Allocate the info struct that will be returned to the caller */
 204
 205     SearchInfo = calloc (sizeof (EXTERNAL_FIND_INFO), 1);
 206     if (!SearchInfo)
 207     {
 208         return (NULL);
 209     }
 210
 211     /* Allocate space for the full wildcard path */
 212
 213     FullWildcardSpec = calloc (
 214         strlen (DirPathname) + strlen (WildcardSpec) + 2, 1);
 215     if (!FullWildcardSpec)
 216     {
 217         printf ("Could not allocate buffer for wildcard pathname\n");
 218         free (SearchInfo);
 219         return (NULL);
 220     }
 221
 222     /* Create the full wildcard path */
 223
 224     strcpy (FullWildcardSpec, DirPathname);
 225     strcat (FullWildcardSpec, "/");
 226     strcat (FullWildcardSpec, WildcardSpec);
 227
 228     /* Initialize the find functions, get first match */
 229
 230     FindHandle = _findfirst (FullWildcardSpec, &SearchInfo->DosInfo);
 231     if (FindHandle == -1)
 232     {
 233         /* Failure means that no match was found */
 234
 235         free (FullWildcardSpec);
 236         free (SearchInfo);
 237         return (NULL);
 238     }
 239
 240     /* Save the info in the return structure */
 241
 242     SearchInfo->RequestedFileType = RequestedFileType;
 243     SearchInfo->FullWildcardSpec = FullWildcardSpec;
 244     SearchInfo->FindHandle = FindHandle;
 245     SearchInfo->State = 0;
 246     return (SearchInfo);
 247 }
 248
 249
 250 /*******************************************************************************
 251  *
 252  * FUNCTION:    AcpiOsGetNextFilename
 253  *
 254  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
 255  *
 256  * RETURN:      Next filename matched. NULL if no more matches.
 257  *
 258  * DESCRIPTION: Get the next file in the directory that matches the wildcard
 259  *              specification.
 260  *
 261  ******************************************************************************/
 262
 263 char *
 264 AcpiOsGetNextFilename (
 265     void                    *DirHandle)
 266 {
 267     EXTERNAL_FIND_INFO      *SearchInfo = DirHandle;
 268     int                     Status;
 269     char                    FileTypeNotMatched = 1;
 270
 271
 272     /*
 273      * Loop while we have matched files but not found any files of
 274      * the requested type.
 275      */
 276     while (FileTypeNotMatched)
 277     {
 278         /* On the first call, we already have the first match */
 279
 280         if (SearchInfo->State == 0)
 281         {
 282             /* No longer the first match */
 283
 284             SearchInfo->State = 1;
 285         }
 286         else
 287         {
 288             /* Get the next match */
 289
 290             Status = _findnext (SearchInfo->FindHandle, &SearchInfo->DosInfo);
 291             if (Status != 0)
 292             {
 293                 return (NULL);
 294             }
 295         }
 296
 297         /*
 298          * Found a match, now check to make sure that the file type
 299          * matches the requested file type (directory or normal file)
 300          *
 301          * NOTE: use of the attrib field saves us from doing a very
 302          * expensive stat() on the file!
 303          */
 304         switch (SearchInfo->RequestedFileType)
 305         {
 306         case REQUEST_FILE_ONLY:
 307
 308             /* Anything other than A_SUBDIR is OK */
 309
 310             if (!(SearchInfo->DosInfo.attrib & _A_SUBDIR))
 311             {
 312                 FileTypeNotMatched = 0;
 313             }
 314             break;
 315
 316         case REQUEST_DIR_ONLY:
 317
 318             /* Must have A_SUBDIR bit set */
 319
 320             if (SearchInfo->DosInfo.attrib & _A_SUBDIR)
 321             {
 322                 FileTypeNotMatched = 0;
 323             }
 324             break;
 325
 326         default:
 327
 328             return (NULL);
 329         }
 330     }
 331
 332     return (SearchInfo->DosInfo.name);
 333 }
 334
 335
 336 /*******************************************************************************
 337  *
 338  * FUNCTION:    AcpiOsCloseDirectory
 339  *
 340  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
 341  *
 342  * RETURN:      None
 343  *
 344  * DESCRIPTION: Close the open directory and cleanup.
 345  *
 346  ******************************************************************************/
 347
 348 void
 349 AcpiOsCloseDirectory (
 350     void                    *DirHandle)
 351 {
 352     EXTERNAL_FIND_INFO      *SearchInfo = DirHandle;
 353
 354
 355     /* Close the directory and free allocations */
 356
 357     _findclose (SearchInfo->FindHandle);
 358     free (SearchInfo->FullWildcardSpec);
 359     free (DirHandle);
 360 }