xref: /dragonfly/contrib/file/src/file.h (revision 7d3e9a5b)
1 /*
2  * Copyright (c) Ian F. Darwin 1986-1995.
3  * Software written by Ian F. Darwin and others;
4  * maintained 1995-present by Christos Zoulas and others.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice immediately at the beginning of the file, without modification,
11  *    this list of conditions, and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 /*
29  * file.h - definitions for file(1) program
30  * @(#)$File: file.h,v 1.225 2021/02/05 22:29:07 christos Exp $
31  */
32 
33 #ifndef __file_h__
34 #define __file_h__
35 
36 #ifdef HAVE_CONFIG_H
37 #include <config.h>
38 #endif
39 
40 #ifdef HAVE_STDINT_H
41 #include <stdint.h>
42 #endif
43 
44 #ifdef HAVE_INTTYPES_H
45 #include <inttypes.h>
46 #endif
47 
48 #ifndef __STDC_LIMIT_MACROS
49 #define __STDC_LIMIT_MACROS
50 #endif
51 #ifndef __STDC_FORMAT_MACROS
52 #define __STDC_FORMAT_MACROS
53 #endif
54 
55 #ifdef _WIN32
56 # ifdef PRIu32
57 #  ifdef _WIN64
58 #   define SIZE_T_FORMAT PRIu64
59 #  else
60 #   define SIZE_T_FORMAT PRIu32
61 #  endif
62 #  define INT64_T_FORMAT PRIi64
63 #  define INTMAX_T_FORMAT PRIiMAX
64 # else
65 #  ifdef _WIN64
66 #   define SIZE_T_FORMAT "I64"
67 #  else
68 #   define SIZE_T_FORMAT ""
69 #  endif
70 #  define INT64_T_FORMAT "I64"
71 #  define INTMAX_T_FORMAT "I64"
72 # endif
73 #else
74 # define SIZE_T_FORMAT "z"
75 # define INT64_T_FORMAT "ll"
76 # define INTMAX_T_FORMAT "j"
77 #endif
78 
79 #include <stdio.h>	/* Include that here, to make sure __P gets defined */
80 #include <errno.h>
81 #include <fcntl.h>	/* For open and flags */
82 #include <regex.h>
83 #include <time.h>
84 #include <sys/types.h>
85 #ifndef WIN32
86 #include <sys/param.h>
87 #endif
88 /* Do this here and now, because struct stat gets re-defined on solaris */
89 #include <sys/stat.h>
90 #include <stdarg.h>
91 #include <wchar.h>
92 
93 #define ENABLE_CONDITIONALS
94 
95 #ifndef MAGIC
96 #define MAGIC "/etc/magic"
97 #endif
98 
99 #if defined(__EMX__) || defined (WIN32)
100 #define PATHSEP	';'
101 #else
102 #define PATHSEP	':'
103 #endif
104 
105 #define private static
106 
107 #if HAVE_VISIBILITY && !defined(WIN32)
108 #define public  __attribute__ ((__visibility__("default")))
109 #ifndef protected
110 #define protected __attribute__ ((__visibility__("hidden")))
111 #endif
112 #else
113 #define public
114 #ifndef protected
115 #define protected
116 #endif
117 #endif
118 
119 #ifndef __arraycount
120 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
121 #endif
122 
123 #ifndef __GNUC_PREREQ__
124 #ifdef __GNUC__
125 #define	__GNUC_PREREQ__(x, y)						\
126 	((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) ||			\
127 	 (__GNUC__ > (x)))
128 #else
129 #define	__GNUC_PREREQ__(x, y)	0
130 #endif
131 #endif
132 
133 #ifndef __GNUC__
134 #ifndef __attribute__
135 #define __attribute__(a)
136 #endif
137 #endif
138 
139 #ifndef MIN
140 #define	MIN(a,b)	(((a) < (b)) ? (a) : (b))
141 #endif
142 
143 #ifndef MAX
144 #define	MAX(a,b)	(((a) > (b)) ? (a) : (b))
145 #endif
146 
147 #ifndef O_CLOEXEC
148 # define O_CLOEXEC 0
149 #endif
150 
151 #ifndef FD_CLOEXEC
152 # define FD_CLOEXEC 1
153 #endif
154 
155 #define FILE_BADSIZE CAST(size_t, ~0ul)
156 #define MAXDESC	64		/* max len of text description/MIME type */
157 #define MAXMIME	80		/* max len of text MIME type */
158 #define MAXstring 128		/* max len of "string" types */
159 
160 #define MAGICNO		0xF11E041C
161 #define VERSIONNO	16
162 #define FILE_MAGICSIZE	376
163 
164 #define FILE_GUID_SIZE	sizeof("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
165 
166 #define	FILE_LOAD	0
167 #define FILE_CHECK	1
168 #define FILE_COMPILE	2
169 #define FILE_LIST	3
170 
171 struct buffer {
172 	int fd;
173 	struct stat st;
174 	const void *fbuf;
175 	size_t flen;
176 	off_t eoff;
177 	void *ebuf;
178 	size_t elen;
179 };
180 
181 union VALUETYPE {
182 	uint8_t b;
183 	uint16_t h;
184 	uint32_t l;
185 	uint64_t q;
186 	uint8_t hs[2];	/* 2 bytes of a fixed-endian "short" */
187 	uint8_t hl[4];	/* 4 bytes of a fixed-endian "long" */
188 	uint8_t hq[8];	/* 8 bytes of a fixed-endian "quad" */
189 	char s[MAXstring];	/* the search string or regex pattern */
190 	unsigned char us[MAXstring];
191 	uint64_t guid[2];
192 	float f;
193 	double d;
194 };
195 
196 struct magic {
197 	/* Word 1 */
198 	uint16_t cont_level;	/* level of ">" */
199 	uint8_t flag;
200 #define INDIR		0x01	/* if '(...)' appears */
201 #define OFFADD		0x02	/* if '>&' or '>...(&' appears */
202 #define INDIROFFADD	0x04	/* if '>&(' appears */
203 #define UNSIGNED	0x08	/* comparison is unsigned */
204 #define NOSPACE		0x10	/* suppress space character before output */
205 #define BINTEST		0x20	/* test is for a binary type (set only
206 				   for top-level tests) */
207 #define TEXTTEST	0x40	/* for passing to file_softmagic */
208 #define OFFNEGATIVE	0x80	/* relative to the end of file */
209 
210 	uint8_t factor;
211 
212 	/* Word 2 */
213 	uint8_t reln;		/* relation (0=eq, '>'=gt, etc) */
214 	uint8_t vallen;		/* length of string value, if any */
215 	uint8_t type;		/* comparison type (FILE_*) */
216 	uint8_t in_type;	/* type of indirection */
217 #define 			FILE_INVALID	0
218 #define 			FILE_BYTE	1
219 #define				FILE_SHORT	2
220 #define				FILE_DEFAULT	3
221 #define				FILE_LONG	4
222 #define				FILE_STRING	5
223 #define				FILE_DATE	6
224 #define				FILE_BESHORT	7
225 #define				FILE_BELONG	8
226 #define				FILE_BEDATE	9
227 #define				FILE_LESHORT	10
228 #define				FILE_LELONG	11
229 #define				FILE_LEDATE	12
230 #define				FILE_PSTRING	13
231 #define				FILE_LDATE	14
232 #define				FILE_BELDATE	15
233 #define				FILE_LELDATE	16
234 #define				FILE_REGEX	17
235 #define				FILE_BESTRING16	18
236 #define				FILE_LESTRING16	19
237 #define				FILE_SEARCH	20
238 #define				FILE_MEDATE	21
239 #define				FILE_MELDATE	22
240 #define				FILE_MELONG	23
241 #define				FILE_QUAD	24
242 #define				FILE_LEQUAD	25
243 #define				FILE_BEQUAD	26
244 #define				FILE_QDATE	27
245 #define				FILE_LEQDATE	28
246 #define				FILE_BEQDATE	29
247 #define				FILE_QLDATE	30
248 #define				FILE_LEQLDATE	31
249 #define				FILE_BEQLDATE	32
250 #define				FILE_FLOAT	33
251 #define				FILE_BEFLOAT	34
252 #define				FILE_LEFLOAT	35
253 #define				FILE_DOUBLE	36
254 #define				FILE_BEDOUBLE	37
255 #define				FILE_LEDOUBLE	38
256 #define				FILE_BEID3	39
257 #define				FILE_LEID3	40
258 #define				FILE_INDIRECT	41
259 #define				FILE_QWDATE	42
260 #define				FILE_LEQWDATE	43
261 #define				FILE_BEQWDATE	44
262 #define				FILE_NAME	45
263 #define				FILE_USE	46
264 #define				FILE_CLEAR	47
265 #define				FILE_DER	48
266 #define				FILE_GUID	49
267 #define				FILE_OFFSET	50
268 #define				FILE_NAMES_SIZE	51 /* size of array to contain all names */
269 
270 #define IS_STRING(t) \
271 	((t) == FILE_STRING || \
272 	 (t) == FILE_PSTRING || \
273 	 (t) == FILE_BESTRING16 || \
274 	 (t) == FILE_LESTRING16 || \
275 	 (t) == FILE_REGEX || \
276 	 (t) == FILE_SEARCH || \
277 	 (t) == FILE_INDIRECT || \
278 	 (t) == FILE_NAME || \
279 	 (t) == FILE_USE)
280 
281 #define FILE_FMT_NONE 0
282 #define FILE_FMT_NUM  1 /* "cduxXi" */
283 #define FILE_FMT_STR  2 /* "s" */
284 #define FILE_FMT_QUAD 3 /* "ll" */
285 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
286 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
287 
288 	/* Word 3 */
289 	uint8_t in_op;		/* operator for indirection */
290 	uint8_t mask_op;	/* operator for mask */
291 #ifdef ENABLE_CONDITIONALS
292 	uint8_t cond;		/* conditional type */
293 #else
294 	uint8_t dummy;
295 #endif
296 	uint8_t factor_op;
297 #define		FILE_FACTOR_OP_PLUS	'+'
298 #define		FILE_FACTOR_OP_MINUS	'-'
299 #define		FILE_FACTOR_OP_TIMES	'*'
300 #define		FILE_FACTOR_OP_DIV	'/'
301 #define		FILE_FACTOR_OP_NONE	'\0'
302 
303 #define				FILE_OPS	"&|^+-*/%"
304 #define				FILE_OPAND	0
305 #define				FILE_OPOR	1
306 #define				FILE_OPXOR	2
307 #define				FILE_OPADD	3
308 #define				FILE_OPMINUS	4
309 #define				FILE_OPMULTIPLY	5
310 #define				FILE_OPDIVIDE	6
311 #define				FILE_OPMODULO	7
312 #define				FILE_OPS_MASK	0x07 /* mask for above ops */
313 #define				FILE_UNUSED_1	0x08
314 #define				FILE_UNUSED_2	0x10
315 #define				FILE_OPSIGNED	0x20
316 #define				FILE_OPINVERSE	0x40
317 #define				FILE_OPINDIRECT	0x80
318 
319 #ifdef ENABLE_CONDITIONALS
320 #define				COND_NONE	0
321 #define				COND_IF		1
322 #define				COND_ELIF	2
323 #define				COND_ELSE	3
324 #endif /* ENABLE_CONDITIONALS */
325 
326 	/* Word 4 */
327 	int32_t offset;		/* offset to magic number */
328 	/* Word 5 */
329 	int32_t in_offset;	/* offset from indirection */
330 	/* Word 6 */
331 	uint32_t lineno;	/* line number in magic file */
332 	/* Word 7,8 */
333 	union {
334 		uint64_t _mask;	/* for use with numeric and date types */
335 		struct {
336 			uint32_t _count;	/* repeat/line count */
337 			uint32_t _flags;	/* modifier flags */
338 		} _s;		/* for use with string types */
339 	} _u;
340 #define num_mask _u._mask
341 #define str_range _u._s._count
342 #define str_flags _u._s._flags
343 	/* Words 9-24 */
344 	union VALUETYPE value;	/* either number or string */
345 	/* Words 25-40 */
346 	char desc[MAXDESC];	/* description */
347 	/* Words 41-60 */
348 	char mimetype[MAXMIME]; /* MIME type */
349 	/* Words 61-62 */
350 	char apple[8];		/* APPLE CREATOR/TYPE */
351 	/* Words 63-78 */
352 	char ext[64];		/* Popular extensions */
353 };
354 
355 #define BIT(A)   (1 << (A))
356 #define STRING_COMPACT_WHITESPACE		BIT(0)
357 #define STRING_COMPACT_OPTIONAL_WHITESPACE	BIT(1)
358 #define STRING_IGNORE_LOWERCASE			BIT(2)
359 #define STRING_IGNORE_UPPERCASE			BIT(3)
360 #define REGEX_OFFSET_START			BIT(4)
361 #define STRING_TEXTTEST				BIT(5)
362 #define STRING_BINTEST				BIT(6)
363 #define PSTRING_1_BE				BIT(7)
364 #define PSTRING_1_LE				BIT(7)
365 #define PSTRING_2_BE				BIT(8)
366 #define PSTRING_2_LE				BIT(9)
367 #define PSTRING_4_BE				BIT(10)
368 #define PSTRING_4_LE				BIT(11)
369 #define REGEX_LINE_COUNT			BIT(11)
370 #define PSTRING_LEN	\
371     (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
372 #define PSTRING_LENGTH_INCLUDES_ITSELF		BIT(12)
373 #define	STRING_TRIM				BIT(13)
374 #define CHAR_COMPACT_WHITESPACE			'W'
375 #define CHAR_COMPACT_OPTIONAL_WHITESPACE	'w'
376 #define CHAR_IGNORE_LOWERCASE			'c'
377 #define CHAR_IGNORE_UPPERCASE			'C'
378 #define CHAR_REGEX_OFFSET_START			's'
379 #define CHAR_TEXTTEST				't'
380 #define	CHAR_TRIM				'T'
381 #define CHAR_BINTEST				'b'
382 #define CHAR_PSTRING_1_BE			'B'
383 #define CHAR_PSTRING_1_LE			'B'
384 #define CHAR_PSTRING_2_BE			'H'
385 #define CHAR_PSTRING_2_LE			'h'
386 #define CHAR_PSTRING_4_BE			'L'
387 #define CHAR_PSTRING_4_LE			'l'
388 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF     'J'
389 #define STRING_IGNORE_CASE		(STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
390 #define STRING_DEFAULT_RANGE		100
391 
392 #define	INDIRECT_RELATIVE			BIT(0)
393 #define	CHAR_INDIRECT_RELATIVE			'r'
394 
395 /* list of magic entries */
396 struct mlist {
397 	struct magic *magic;		/* array of magic entries */
398 	uint32_t nmagic;		/* number of entries in array */
399 	void *map;			/* internal resources used by entry */
400 	struct mlist *next, *prev;
401 };
402 
403 #ifdef __cplusplus
404 #define CAST(T, b)	static_cast<T>(b)
405 #define RCAST(T, b)	reinterpret_cast<T>(b)
406 #define CCAST(T, b)	const_cast<T>(b)
407 #else
408 #define CAST(T, b)	((T)(b))
409 #define RCAST(T, b)	((T)(uintptr_t)(b))
410 #define CCAST(T, b)	((T)(uintptr_t)(b))
411 #endif
412 
413 struct level_info {
414 	int32_t off;
415 	int got_match;
416 #ifdef ENABLE_CONDITIONALS
417 	int last_match;
418 	int last_cond;	/* used for error checking by parse() */
419 #endif
420 };
421 
422 struct cont {
423 	size_t len;
424 	struct level_info *li;
425 };
426 
427 #define MAGIC_SETS	2
428 
429 struct magic_set {
430 	struct mlist *mlist[MAGIC_SETS];	/* list of regular entries */
431 	struct cont c;
432 	struct out {
433 		char *buf;		/* Accumulation buffer */
434 		size_t blen;		/* Length of buffer */
435 		char *pbuf;		/* Printable buffer */
436 	} o;
437 	uint32_t offset;			/* a copy of m->offset while we */
438 					/* are working on the magic entry */
439 	uint32_t eoffset;		/* offset from end of file */
440 	int error;
441 	int flags;			/* Control magic tests. */
442 	int event_flags;		/* Note things that happened. */
443 #define 		EVENT_HAD_ERR		0x01
444 	const char *file;
445 	size_t line;			/* current magic line number */
446 	mode_t mode;			/* copy of current stat mode */
447 
448 	/* data for searches */
449 	struct {
450 		const char *s;		/* start of search in original source */
451 		size_t s_len;		/* length of search region */
452 		size_t offset;		/* starting offset in source: XXX - should this be off_t? */
453 		size_t rm_len;		/* match length */
454 	} search;
455 
456 	/* FIXME: Make the string dynamically allocated so that e.g.
457 	   strings matched in files can be longer than MAXstring */
458 	union VALUETYPE ms_value;	/* either number or string */
459 	uint16_t indir_max;
460 	uint16_t name_max;
461 	uint16_t elf_shnum_max;
462 	uint16_t elf_phnum_max;
463 	uint16_t elf_notes_max;
464 	uint16_t regex_max;
465 	size_t bytes_max;		/* number of bytes to read from file */
466 	size_t encoding_max;		/* bytes to look for encoding */
467 #ifndef FILE_BYTES_MAX
468 # define FILE_BYTES_MAX (1024 * 1024)	/* how much of the file to look at */
469 #endif
470 #define	FILE_ELF_NOTES_MAX		256
471 #define	FILE_ELF_PHNUM_MAX		2048
472 #define	FILE_ELF_SHNUM_MAX		32768
473 #define	FILE_INDIR_MAX			50
474 #define	FILE_NAME_MAX			50
475 #define	FILE_REGEX_MAX			8192
476 #define	FILE_ENCODING_MAX		(64 * 1024)
477 };
478 
479 /* Type for Unicode characters */
480 typedef unsigned long file_unichar_t;
481 
482 struct stat;
483 #define FILE_T_LOCAL	1
484 #define FILE_T_WINDOWS	2
485 protected const char *file_fmttime(char *, size_t, uint64_t, int);
486 protected struct magic_set *file_ms_alloc(int);
487 protected void file_ms_free(struct magic_set *);
488 protected int file_default(struct magic_set *, size_t);
489 protected int file_buffer(struct magic_set *, int, struct stat *, const char *,
490     const void *, size_t);
491 protected int file_fsmagic(struct magic_set *, const char *, struct stat *);
492 protected int file_pipe2file(struct magic_set *, int, const void *, size_t);
493 protected int file_vprintf(struct magic_set *, const char *, va_list)
494     __attribute__((__format__(__printf__, 2, 0)));
495 protected int file_separator(struct magic_set *);
496 protected char *file_copystr(char *, size_t, size_t, const char *);
497 protected int file_checkfmt(char *, size_t, const char *);
498 protected size_t file_printedlen(const struct magic_set *);
499 protected int file_print_guid(char *, size_t, const uint64_t *);
500 protected int file_parse_guid(const char *, uint64_t *);
501 protected int file_replace(struct magic_set *, const char *, const char *);
502 protected int file_printf(struct magic_set *, const char *, ...)
503     __attribute__((__format__(__printf__, 2, 3)));
504 protected int file_reset(struct magic_set *, int);
505 protected int file_tryelf(struct magic_set *, const struct buffer *);
506 protected int file_trycdf(struct magic_set *, const struct buffer *);
507 #if HAVE_FORK
508 protected int file_zmagic(struct magic_set *, const struct buffer *,
509     const char *);
510 #endif
511 protected int file_ascmagic(struct magic_set *, const struct buffer *,
512     int);
513 protected int file_ascmagic_with_encoding(struct magic_set *,
514     const struct buffer *, file_unichar_t *, size_t, const char *, const char *, int);
515 protected int file_encoding(struct magic_set *, const struct buffer *,
516     file_unichar_t **, size_t *, const char **, const char **, const char **);
517 protected int file_is_json(struct magic_set *, const struct buffer *);
518 protected int file_is_csv(struct magic_set *, const struct buffer *, int);
519 protected int file_is_tar(struct magic_set *, const struct buffer *);
520 protected int file_softmagic(struct magic_set *, const struct buffer *,
521     uint16_t *, uint16_t *, int, int);
522 protected int file_apprentice(struct magic_set *, const char *, int);
523 protected int buffer_apprentice(struct magic_set *, struct magic **,
524     size_t *, size_t);
525 protected int file_magicfind(struct magic_set *, const char *, struct mlist *);
526 protected uint64_t file_signextend(struct magic_set *, struct magic *,
527     uint64_t);
528 protected void file_badread(struct magic_set *);
529 protected void file_badseek(struct magic_set *);
530 protected void file_oomem(struct magic_set *, size_t);
531 protected void file_error(struct magic_set *, int, const char *, ...)
532     __attribute__((__format__(__printf__, 3, 4)));
533 protected void file_magerror(struct magic_set *, const char *, ...)
534     __attribute__((__format__(__printf__, 2, 3)));
535 protected void file_magwarn(struct magic_set *, const char *, ...)
536     __attribute__((__format__(__printf__, 2, 3)));
537 protected void file_mdump(struct magic *);
538 protected void file_showstr(FILE *, const char *, size_t);
539 protected size_t file_mbswidth(const char *);
540 protected const char *file_getbuffer(struct magic_set *);
541 protected ssize_t sread(int, void *, size_t, int);
542 protected int file_check_mem(struct magic_set *, unsigned int);
543 protected int file_looks_utf8(const unsigned char *, size_t, file_unichar_t *,
544     size_t *);
545 protected size_t file_pstring_length_size(struct magic_set *,
546     const struct magic *);
547 protected size_t file_pstring_get_length(struct magic_set *,
548     const struct magic *, const char *);
549 protected char * file_printable(char *, size_t, const char *, size_t);
550 #ifdef __EMX__
551 protected int file_os2_apptype(struct magic_set *, const char *, const void *,
552     size_t);
553 #endif /* __EMX__ */
554 protected int file_pipe_closexec(int *);
555 protected int file_clear_closexec(int);
556 protected char *file_strtrim(char *);
557 
558 protected void buffer_init(struct buffer *, int, const struct stat *,
559     const void *, size_t);
560 protected void buffer_fini(struct buffer *);
561 protected int buffer_fill(const struct buffer *);
562 
563 #include <locale.h>
564 #if defined(HAVE_XLOCALE_H)
565 #include <xlocale.h>
566 #endif
567 
568 typedef struct {
569 	const char *pat;
570 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
571 #define USE_C_LOCALE
572 	locale_t old_lc_ctype;
573 	locale_t c_lc_ctype;
574 #else
575 	char *old_lc_ctype;
576 #endif
577 	int rc;
578 	regex_t rx;
579 } file_regex_t;
580 
581 protected int file_regcomp(file_regex_t *, const char *, int);
582 protected int file_regexec(file_regex_t *, const char *, size_t, regmatch_t *,
583     int);
584 protected void file_regfree(file_regex_t *);
585 protected void file_regerror(file_regex_t *, int, struct magic_set *);
586 
587 typedef struct {
588 	char *buf;
589 	size_t blen;
590 	uint32_t offset;
591 } file_pushbuf_t;
592 
593 protected file_pushbuf_t *file_push_buffer(struct magic_set *);
594 protected char  *file_pop_buffer(struct magic_set *, file_pushbuf_t *);
595 
596 #ifndef COMPILE_ONLY
597 extern const char *file_names[];
598 extern const size_t file_nnames;
599 #endif
600 
601 #ifndef HAVE_PREAD
602 ssize_t pread(int, void *, size_t, off_t);
603 #endif
604 #ifndef HAVE_VASPRINTF
605 int vasprintf(char **, const char *, va_list);
606 #endif
607 #ifndef HAVE_ASPRINTF
608 int asprintf(char **, const char *, ...);
609 #endif
610 #ifndef HAVE_DPRINTF
611 int dprintf(int, const char *, ...);
612 #endif
613 
614 #ifndef HAVE_STRLCPY
615 size_t strlcpy(char *, const char *, size_t);
616 #endif
617 #ifndef HAVE_STRLCAT
618 size_t strlcat(char *, const char *, size_t);
619 #endif
620 #ifndef HAVE_STRCASESTR
621 char *strcasestr(const char *, const char *);
622 #endif
623 #ifndef HAVE_GETLINE
624 ssize_t getline(char **, size_t *, FILE *);
625 ssize_t getdelim(char **, size_t *, int, FILE *);
626 #endif
627 #ifndef HAVE_CTIME_R
628 char   *ctime_r(const time_t *, char *);
629 #endif
630 #ifndef HAVE_ASCTIME_R
631 char   *asctime_r(const struct tm *, char *);
632 #endif
633 #ifndef HAVE_GMTIME_R
634 struct tm *gmtime_r(const time_t *, struct tm *);
635 #endif
636 #ifndef HAVE_LOCALTIME_R
637 struct tm *localtime_r(const time_t *, struct tm *);
638 #endif
639 #ifndef HAVE_FMTCHECK
640 const char *fmtcheck(const char *, const char *)
641      __attribute__((__format_arg__(2)));
642 #endif
643 
644 #ifdef HAVE_LIBSECCOMP
645 // basic filter
646 // this mode should not interfere with normal operations
647 // only some dangerous syscalls are blacklisted
648 int enable_sandbox_basic(void);
649 
650 // enhanced filter
651 // this mode allows only the necessary syscalls used during normal operation
652 // extensive testing required !!!
653 int enable_sandbox_full(void);
654 #endif
655 
656 protected const char *file_getprogname(void);
657 protected void file_setprogname(const char *);
658 protected void file_err(int, const char *, ...)
659     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
660 protected void file_errx(int, const char *, ...)
661     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
662 protected void file_warn(const char *, ...)
663     __attribute__((__format__(__printf__, 1, 2)));
664 protected void file_warnx(const char *, ...)
665     __attribute__((__format__(__printf__, 1, 2)));
666 
667 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
668 #define QUICK
669 #endif
670 
671 #ifndef O_BINARY
672 #define O_BINARY	0
673 #endif
674 #ifndef O_NONBLOCK
675 #define O_NONBLOCK	0
676 #endif
677 
678 #ifndef __cplusplus
679 #if defined(__GNUC__) && (__GNUC__ >= 3)
680 #define FILE_RCSID(id) \
681 static const char rcsid[] __attribute__((__used__)) = id;
682 #else
683 #define FILE_RCSID(id) \
684 static const char *rcsid(const char *p) { \
685 	return rcsid(p = id); \
686 }
687 #endif
688 #else
689 #define FILE_RCSID(id)
690 #endif
691 #ifndef __RCSID
692 #define __RCSID(a)
693 #endif
694 
695 #endif /* __file_h__ */
696