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