xref: /illumos-gate/usr/src/cmd/acpi/acpidump/osunixdir.c (revision 45ede40b2394db7967e59f19288fae9b62efd4aa)
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 - 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 <dirent.h>
158 #include <fnmatch.h>
159 #include <ctype.h>
160 #include <sys/stat.h>
161 
162 /*
163  * Allocated structure returned from OsOpenDirectory
164  */
165 typedef struct ExternalFindInfo
166 {
167     char                        *DirPathname;
168     DIR                         *DirPtr;
169     char                        temp_buffer[256];
170     char                        *WildcardSpec;
171     char                        RequestedFileType;
172 
173 } EXTERNAL_FIND_INFO;
174 
175 
176 /*******************************************************************************
177  *
178  * FUNCTION:    AcpiOsOpenDirectory
179  *
180  * PARAMETERS:  DirPathname         - Full pathname to the directory
181  *              WildcardSpec        - string of the form "*.c", etc.
182  *
183  * RETURN:      A directory "handle" to be used in subsequent search operations.
184  *              NULL returned on failure.
185  *
186  * DESCRIPTION: Open a directory in preparation for a wildcard search
187  *
188  ******************************************************************************/
189 
190 void *
191 AcpiOsOpenDirectory (
192     char                    *DirPathname,
193     char                    *WildcardSpec,
194     char                    RequestedFileType)
195 {
196     EXTERNAL_FIND_INFO      *ExternalInfo;
197     DIR                     *dir;
198 
199 
200     /* Allocate the info struct that will be returned to the caller */
201 
202     ExternalInfo = calloc (1, sizeof (EXTERNAL_FIND_INFO));
203     if (!ExternalInfo)
204     {
205         return (NULL);
206     }
207 
208     /* Get the directory stream */
209 
210     dir = opendir (DirPathname);
211     if (!dir)
212     {
213         fprintf (stderr, "Cannot open directory - %s\n", DirPathname);
214         free (ExternalInfo);
215         return (NULL);
216     }
217 
218     /* Save the info in the return structure */
219 
220     ExternalInfo->WildcardSpec = WildcardSpec;
221     ExternalInfo->RequestedFileType = RequestedFileType;
222     ExternalInfo->DirPathname = DirPathname;
223     ExternalInfo->DirPtr = dir;
224     return (ExternalInfo);
225 }
226 
227 
228 /*******************************************************************************
229  *
230  * FUNCTION:    AcpiOsGetNextFilename
231  *
232  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
233  *
234  * RETURN:      Next filename matched. NULL if no more matches.
235  *
236  * DESCRIPTION: Get the next file in the directory that matches the wildcard
237  *              specification.
238  *
239  ******************************************************************************/
240 
241 char *
242 AcpiOsGetNextFilename (
243     void                    *DirHandle)
244 {
245     EXTERNAL_FIND_INFO      *ExternalInfo = DirHandle;
246     struct dirent           *dir_entry;
247     char                    *temp_str;
248     int                     str_len;
249     struct stat             temp_stat;
250     int                     err;
251 
252 
253     while ((dir_entry = readdir (ExternalInfo->DirPtr)))
254     {
255         if (!fnmatch (ExternalInfo->WildcardSpec, dir_entry->d_name, 0))
256         {
257             if (dir_entry->d_name[0] == '.')
258             {
259                 continue;
260             }
261 
262             str_len = strlen (dir_entry->d_name) +
263                         strlen (ExternalInfo->DirPathname) + 2;
264 
265             temp_str = calloc (str_len, 1);
266             if (!temp_str)
267             {
268                 fprintf (stderr,
269                     "Could not allocate buffer for temporary string\n");
270                 return (NULL);
271             }
272 
273             strcpy (temp_str, ExternalInfo->DirPathname);
274             strcat (temp_str, "/");
275             strcat (temp_str, dir_entry->d_name);
276 
277             err = stat (temp_str, &temp_stat);
278             if (err == -1)
279             {
280                 fprintf (stderr,
281                     "Cannot stat file (should not happen) - %s\n",
282                     temp_str);
283                 free (temp_str);
284                 return (NULL);
285             }
286 
287             free (temp_str);
288 
289             if ((S_ISDIR (temp_stat.st_mode)
290                 && (ExternalInfo->RequestedFileType == REQUEST_DIR_ONLY))
291                ||
292                ((!S_ISDIR (temp_stat.st_mode)
293                 && ExternalInfo->RequestedFileType == REQUEST_FILE_ONLY)))
294             {
295                 /* copy to a temp buffer because dir_entry struct is on the stack */
296 
297                 strcpy (ExternalInfo->temp_buffer, dir_entry->d_name);
298                 return (ExternalInfo->temp_buffer);
299             }
300         }
301     }
302 
303     return (NULL);
304 }
305 
306 
307 /*******************************************************************************
308  *
309  * FUNCTION:    AcpiOsCloseDirectory
310  *
311  * PARAMETERS:  DirHandle           - Created via AcpiOsOpenDirectory
312  *
313  * RETURN:      None.
314  *
315  * DESCRIPTION: Close the open directory and cleanup.
316  *
317  ******************************************************************************/
318 
319 void
320 AcpiOsCloseDirectory (
321     void                    *DirHandle)
322 {
323     EXTERNAL_FIND_INFO      *ExternalInfo = DirHandle;
324 
325 
326     /* Close the directory and free allocations */
327 
328     closedir (ExternalInfo->DirPtr);
329     free (DirHandle);
330 }
331