sys/contrib/dev/acpica-unix/os_specific/service_layers/oswindir.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: oswindir - Windows directory access interfaces
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #include <acpi.h>
 118
 119 #include <stdio.h>
 120 #include <stdlib.h>
 121 #include <string.h>
 122 #include <io.h>
 123
 124 typedef struct ExternalFindInfo
 125 {
 126     struct _finddata_t          DosInfo;
 127     char                        *FullWildcardSpec;
 128     long                        FindHandle;
 129     char                        State;
 130     char                        RequestedFileType;
 131
 132 } EXTERNAL_FIND_INFO;
 133
 134
 135 /*******************************************************************************
 136  *
 137  * FUNCTION:    AcpiOsOpenDirectory
 138  *
 139  * PARAMETERS:  DirPathname         - Full pathname to the directory
 140  *              WildcardSpec        - string of the form "*.c", etc.
 141  *              RequestedFileType   - Either a directory or normal file
 142  *
 143  * RETURN:      A directory "handle" to be used in subsequent search operations.
 144  *              NULL returned on failure.
 145  *
 146  * DESCRIPTION: Open a directory in preparation for a wildcard search
 147  *
 148  ******************************************************************************/
 149
 150 void *
 151 AcpiOsOpenDirectory (
 152     char                    *DirPathname,
 153     char                    *WildcardSpec,
 154     char                    RequestedFileType)
 155 {
 156     long                    FindHandle;
 157     char                    *FullWildcardSpec;
 158     EXTERNAL_FIND_INFO      *SearchInfo;
 159
 160
 161     /* No directory path means "use current directory" - use a dot */
 162
 163     if (!DirPathname || strlen (DirPathname) == 0)
 164     {
 165         DirPathname = ".";
 166     }
 167
 168     /* Allocate the info struct that will be returned to the caller */
 169
 170     SearchInfo = calloc (sizeof (EXTERNAL_FIND_INFO), 1);
 171     if (!SearchInfo)
 172     {
 173         return (NULL);
 174     }
 175
 176     /* Allocate space for the full wildcard path */
 177
 178     FullWildcardSpec = calloc (strlen (DirPathname) + strlen (WildcardSpec) + 2, 1);
 179     if (!FullWildcardSpec)
 180     {
 181         printf ("Could not allocate buffer for wildcard pathname\n");
 182         return (NULL);
 183     }
 184
 185     /* Create the full wildcard path */
 186
 187     strcpy (FullWildcardSpec, DirPathname);
 188     strcat (FullWildcardSpec, "/");
 189     strcat (FullWildcardSpec, WildcardSpec);
 190
 191     /* Initialize the find functions, get first match */
 192
 193     FindHandle = _findfirst (FullWildcardSpec, &SearchInfo->DosInfo);
 194     if (FindHandle == -1)
 195     {
 196         /* Failure means that no match was found */
 197
 198         free (FullWildcardSpec);
 199         free (SearchInfo);
 200         return (NULL);
 201     }
 202
 203     /* Save the info in the return structure */
 204
 205     SearchInfo->RequestedFileType = RequestedFileType;
 206     SearchInfo->FullWildcardSpec = FullWildcardSpec;
 207     SearchInfo->FindHandle = FindHandle;
 208     SearchInfo->State = 0;
 209     return (SearchInfo);
 210 }
 211
 212
 213 /*******************************************************************************
 214  *
 215  * FUNCTION:    AcpiOsGetNextFilename
 216  *
 217  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
 218  *
 219  * RETURN:      Next filename matched. NULL if no more matches.
 220  *
 221  * DESCRIPTION: Get the next file in the directory that matches the wildcard
 222  *              specification.
 223  *
 224  ******************************************************************************/
 225
 226 char *
 227 AcpiOsGetNextFilename (
 228     void                    *DirHandle)
 229 {
 230     EXTERNAL_FIND_INFO      *SearchInfo = DirHandle;
 231     int                     Status;
 232     char                    FileTypeNotMatched = 1;
 233
 234
 235     /*
 236      * Loop while we have matched files but not found any files of
 237      * the requested type.
 238      */
 239     while (FileTypeNotMatched)
 240     {
 241         /* On the first call, we already have the first match */
 242
 243         if (SearchInfo->State == 0)
 244         {
 245             /* No longer the first match */
 246
 247             SearchInfo->State = 1;
 248         }
 249         else
 250         {
 251             /* Get the next match */
 252
 253             Status = _findnext (SearchInfo->FindHandle, &SearchInfo->DosInfo);
 254             if (Status != 0)
 255             {
 256                 return (NULL);
 257             }
 258         }
 259
 260         /*
 261          * Found a match, now check to make sure that the file type
 262          * matches the requested file type (directory or normal file)
 263          *
 264          * NOTE: use of the attrib field saves us from doing a very
 265          * expensive stat() on the file!
 266          */
 267         switch (SearchInfo->RequestedFileType)
 268         {
 269         case REQUEST_FILE_ONLY:
 270
 271             /* Anything other than A_SUBDIR is OK */
 272
 273             if (!(SearchInfo->DosInfo.attrib & _A_SUBDIR))
 274             {
 275                 FileTypeNotMatched = 0;
 276             }
 277             break;
 278
 279         case REQUEST_DIR_ONLY:
 280
 281             /* Must have A_SUBDIR bit set */
 282
 283             if (SearchInfo->DosInfo.attrib & _A_SUBDIR)
 284             {
 285                 FileTypeNotMatched = 0;
 286             }
 287             break;
 288
 289         default:
 290             return (NULL);
 291         }
 292     }
 293
 294     return (SearchInfo->DosInfo.name);
 295 }
 296
 297
 298 /*******************************************************************************
 299  *
 300  * FUNCTION:    AcpiOsCloseDirectory
 301  *
 302  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
 303  *
 304  * RETURN:      None
 305  *
 306  * DESCRIPTION: Close the open directory and cleanup.
 307  *
 308  ******************************************************************************/
 309
 310 void
 311 AcpiOsCloseDirectory (
 312     void                    *DirHandle)
 313 {
 314     EXTERNAL_FIND_INFO      *SearchInfo = DirHandle;
 315
 316
 317     /* Close the directory and free allocations */
 318
 319     _findclose (SearchInfo->FindHandle);
 320     free (SearchInfo->FullWildcardSpec);
 321     free (DirHandle);
 322 }
 323