Merge branch 'vendor/FILE'
[dragonfly.git] / contrib / file / src / file.h
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.227 2021/06/30 10:08:48 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_BEVARINT   51
269 #define                         FILE_LEVARINT   52
270 #define                         FILE_NAMES_SIZE 53 /* size of array to contain all names */
271
272 #define IS_STRING(t) \
273         ((t) == FILE_STRING || \
274          (t) == FILE_PSTRING || \
275          (t) == FILE_BESTRING16 || \
276          (t) == FILE_LESTRING16 || \
277          (t) == FILE_REGEX || \
278          (t) == FILE_SEARCH || \
279          (t) == FILE_INDIRECT || \
280          (t) == FILE_NAME || \
281          (t) == FILE_USE)
282
283 #define FILE_FMT_NONE 0
284 #define FILE_FMT_NUM  1 /* "cduxXi" */
285 #define FILE_FMT_STR  2 /* "s" */
286 #define FILE_FMT_QUAD 3 /* "ll" */
287 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
288 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
289
290         /* Word 3 */
291         uint8_t in_op;          /* operator for indirection */
292         uint8_t mask_op;        /* operator for mask */
293 #ifdef ENABLE_CONDITIONALS
294         uint8_t cond;           /* conditional type */
295 #else
296         uint8_t dummy;
297 #endif
298         uint8_t factor_op;
299 #define         FILE_FACTOR_OP_PLUS     '+'
300 #define         FILE_FACTOR_OP_MINUS    '-'
301 #define         FILE_FACTOR_OP_TIMES    '*'
302 #define         FILE_FACTOR_OP_DIV      '/'
303 #define         FILE_FACTOR_OP_NONE     '\0'
304
305 #define                         FILE_OPS        "&|^+-*/%"
306 #define                         FILE_OPAND      0
307 #define                         FILE_OPOR       1
308 #define                         FILE_OPXOR      2
309 #define                         FILE_OPADD      3
310 #define                         FILE_OPMINUS    4
311 #define                         FILE_OPMULTIPLY 5
312 #define                         FILE_OPDIVIDE   6
313 #define                         FILE_OPMODULO   7
314 #define                         FILE_OPS_MASK   0x07 /* mask for above ops */
315 #define                         FILE_UNUSED_1   0x08
316 #define                         FILE_UNUSED_2   0x10
317 #define                         FILE_OPSIGNED   0x20
318 #define                         FILE_OPINVERSE  0x40
319 #define                         FILE_OPINDIRECT 0x80
320
321 #ifdef ENABLE_CONDITIONALS
322 #define                         COND_NONE       0
323 #define                         COND_IF         1
324 #define                         COND_ELIF       2
325 #define                         COND_ELSE       3
326 #endif /* ENABLE_CONDITIONALS */
327
328         /* Word 4 */
329         int32_t offset;         /* offset to magic number */
330         /* Word 5 */
331         int32_t in_offset;      /* offset from indirection */
332         /* Word 6 */
333         uint32_t lineno;        /* line number in magic file */
334         /* Word 7,8 */
335         union {
336                 uint64_t _mask; /* for use with numeric and date types */
337                 struct {
338                         uint32_t _count;        /* repeat/line count */
339                         uint32_t _flags;        /* modifier flags */
340                 } _s;           /* for use with string types */
341         } _u;
342 #define num_mask _u._mask
343 #define str_range _u._s._count
344 #define str_flags _u._s._flags
345         /* Words 9-24 */
346         union VALUETYPE value;  /* either number or string */
347         /* Words 25-40 */
348         char desc[MAXDESC];     /* description */
349         /* Words 41-60 */
350         char mimetype[MAXMIME]; /* MIME type */
351         /* Words 61-62 */
352         char apple[8];          /* APPLE CREATOR/TYPE */
353         /* Words 63-78 */
354         char ext[64];           /* Popular extensions */
355 };
356
357 #define BIT(A)   (1 << (A))
358 #define STRING_COMPACT_WHITESPACE               BIT(0)
359 #define STRING_COMPACT_OPTIONAL_WHITESPACE      BIT(1)
360 #define STRING_IGNORE_LOWERCASE                 BIT(2)
361 #define STRING_IGNORE_UPPERCASE                 BIT(3)
362 #define REGEX_OFFSET_START                      BIT(4)
363 #define STRING_TEXTTEST                         BIT(5)
364 #define STRING_BINTEST                          BIT(6)
365 #define PSTRING_1_BE                            BIT(7)
366 #define PSTRING_1_LE                            BIT(7)
367 #define PSTRING_2_BE                            BIT(8)
368 #define PSTRING_2_LE                            BIT(9)
369 #define PSTRING_4_BE                            BIT(10)
370 #define PSTRING_4_LE                            BIT(11)
371 #define REGEX_LINE_COUNT                        BIT(11)
372 #define PSTRING_LEN     \
373     (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
374 #define PSTRING_LENGTH_INCLUDES_ITSELF          BIT(12)
375 #define STRING_TRIM                             BIT(13)
376 #define STRING_FULL_WORD                        BIT(14)
377 #define CHAR_COMPACT_WHITESPACE                 'W'
378 #define CHAR_COMPACT_OPTIONAL_WHITESPACE        'w'
379 #define CHAR_IGNORE_LOWERCASE                   'c'
380 #define CHAR_IGNORE_UPPERCASE                   'C'
381 #define CHAR_REGEX_OFFSET_START                 's'
382 #define CHAR_TEXTTEST                           't'
383 #define CHAR_TRIM                               'T'
384 #define CHAR_FULL_WORD                          'f'
385 #define CHAR_BINTEST                            'b'
386 #define CHAR_PSTRING_1_BE                       'B'
387 #define CHAR_PSTRING_1_LE                       'B'
388 #define CHAR_PSTRING_2_BE                       'H'
389 #define CHAR_PSTRING_2_LE                       'h'
390 #define CHAR_PSTRING_4_BE                       'L'
391 #define CHAR_PSTRING_4_LE                       'l'
392 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF     'J'
393 #define STRING_IGNORE_CASE              (STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
394 #define STRING_DEFAULT_RANGE            100
395
396 #define INDIRECT_RELATIVE                       BIT(0)
397 #define CHAR_INDIRECT_RELATIVE                  'r'
398
399 /* list of magic entries */
400 struct mlist {
401         struct magic *magic;            /* array of magic entries */
402         uint32_t nmagic;                /* number of entries in array */
403         void *map;                      /* internal resources used by entry */
404         struct mlist *next, *prev;
405 };
406
407 #ifdef __cplusplus
408 #define CAST(T, b)      static_cast<T>(b)
409 #define RCAST(T, b)     reinterpret_cast<T>(b)
410 #define CCAST(T, b)     const_cast<T>(b)
411 #else
412 #define CAST(T, b)      ((T)(b))
413 #define RCAST(T, b)     ((T)(uintptr_t)(b))
414 #define CCAST(T, b)     ((T)(uintptr_t)(b))
415 #endif
416
417 struct level_info {
418         int32_t off;
419         int got_match;
420 #ifdef ENABLE_CONDITIONALS
421         int last_match;
422         int last_cond;  /* used for error checking by parse() */
423 #endif
424 };
425
426 struct cont {
427         size_t len;
428         struct level_info *li;
429 };
430
431 #define MAGIC_SETS      2
432
433 struct magic_set {
434         struct mlist *mlist[MAGIC_SETS];        /* list of regular entries */
435         struct cont c;
436         struct out {
437                 char *buf;              /* Accumulation buffer */
438                 size_t blen;            /* Length of buffer */
439                 char *pbuf;             /* Printable buffer */
440         } o;
441         uint32_t offset;                        /* a copy of m->offset while we */
442                                         /* are working on the magic entry */
443         uint32_t eoffset;               /* offset from end of file */
444         int error;
445         int flags;                      /* Control magic tests. */
446         int event_flags;                /* Note things that happened. */
447 #define                 EVENT_HAD_ERR           0x01
448         const char *file;
449         size_t line;                    /* current magic line number */
450         mode_t mode;                    /* copy of current stat mode */
451
452         /* data for searches */
453         struct {
454                 const char *s;          /* start of search in original source */
455                 size_t s_len;           /* length of search region */
456                 size_t offset;          /* starting offset in source: XXX - should this be off_t? */
457                 size_t rm_len;          /* match length */
458         } search;
459
460         /* FIXME: Make the string dynamically allocated so that e.g.
461            strings matched in files can be longer than MAXstring */
462         union VALUETYPE ms_value;       /* either number or string */
463         uint16_t indir_max;
464         uint16_t name_max;
465         uint16_t elf_shnum_max;
466         uint16_t elf_phnum_max;
467         uint16_t elf_notes_max;
468         uint16_t regex_max;
469         size_t bytes_max;               /* number of bytes to read from file */
470         size_t encoding_max;            /* bytes to look for encoding */
471 #ifndef FILE_BYTES_MAX
472 # define FILE_BYTES_MAX (1024 * 1024)   /* how much of the file to look at */
473 #endif
474 #define FILE_ELF_NOTES_MAX              256
475 #define FILE_ELF_PHNUM_MAX              2048
476 #define FILE_ELF_SHNUM_MAX              32768
477 #define FILE_INDIR_MAX                  50
478 #define FILE_NAME_MAX                   50
479 #define FILE_REGEX_MAX                  8192
480 #define FILE_ENCODING_MAX               (64 * 1024)
481 };
482
483 /* Type for Unicode characters */
484 typedef unsigned long file_unichar_t;
485
486 struct stat;
487 #define FILE_T_LOCAL    1
488 #define FILE_T_WINDOWS  2
489 protected const char *file_fmttime(char *, size_t, uint64_t, int);
490 protected const char *file_fmtvarint(const unsigned char *, int, char *,
491     size_t);
492 protected struct magic_set *file_ms_alloc(int);
493 protected void file_ms_free(struct magic_set *);
494 protected int file_default(struct magic_set *, size_t);
495 protected int file_buffer(struct magic_set *, int, struct stat *, const char *,
496     const void *, size_t);
497 protected int file_fsmagic(struct magic_set *, const char *, struct stat *);
498 protected int file_pipe2file(struct magic_set *, int, const void *, size_t);
499 protected int file_vprintf(struct magic_set *, const char *, va_list)
500     __attribute__((__format__(__printf__, 2, 0)));
501 protected int file_separator(struct magic_set *);
502 protected char *file_copystr(char *, size_t, size_t, const char *);
503 protected int file_checkfmt(char *, size_t, const char *);
504 protected size_t file_printedlen(const struct magic_set *);
505 protected int file_print_guid(char *, size_t, const uint64_t *);
506 protected int file_parse_guid(const char *, uint64_t *);
507 protected int file_replace(struct magic_set *, const char *, const char *);
508 protected int file_printf(struct magic_set *, const char *, ...)
509     __attribute__((__format__(__printf__, 2, 3)));
510 protected int file_reset(struct magic_set *, int);
511 protected int file_tryelf(struct magic_set *, const struct buffer *);
512 protected int file_trycdf(struct magic_set *, const struct buffer *);
513 #if HAVE_FORK
514 protected int file_zmagic(struct magic_set *, const struct buffer *,
515     const char *);
516 #endif
517 protected int file_ascmagic(struct magic_set *, const struct buffer *,
518     int);
519 protected int file_ascmagic_with_encoding(struct magic_set *,
520     const struct buffer *, file_unichar_t *, size_t, const char *, const char *, int);
521 protected int file_encoding(struct magic_set *, const struct buffer *,
522     file_unichar_t **, size_t *, const char **, const char **, const char **);
523 protected int file_is_json(struct magic_set *, const struct buffer *);
524 protected int file_is_csv(struct magic_set *, const struct buffer *, int);
525 protected int file_is_tar(struct magic_set *, const struct buffer *);
526 protected int file_softmagic(struct magic_set *, const struct buffer *,
527     uint16_t *, uint16_t *, int, int);
528 protected int file_apprentice(struct magic_set *, const char *, int);
529 protected int buffer_apprentice(struct magic_set *, struct magic **,
530     size_t *, size_t);
531 protected int file_magicfind(struct magic_set *, const char *, struct mlist *);
532 protected uint64_t file_signextend(struct magic_set *, struct magic *,
533     uint64_t);
534 protected uintmax_t file_varint2uintmax_t(const unsigned char *, int, size_t *);
535
536 protected void file_badread(struct magic_set *);
537 protected void file_badseek(struct magic_set *);
538 protected void file_oomem(struct magic_set *, size_t);
539 protected void file_error(struct magic_set *, int, const char *, ...)
540     __attribute__((__format__(__printf__, 3, 4)));
541 protected void file_magerror(struct magic_set *, const char *, ...)
542     __attribute__((__format__(__printf__, 2, 3)));
543 protected void file_magwarn(struct magic_set *, const char *, ...)
544     __attribute__((__format__(__printf__, 2, 3)));
545 protected void file_mdump(struct magic *);
546 protected void file_showstr(FILE *, const char *, size_t);
547 protected size_t file_mbswidth(const char *);
548 protected const char *file_getbuffer(struct magic_set *);
549 protected ssize_t sread(int, void *, size_t, int);
550 protected int file_check_mem(struct magic_set *, unsigned int);
551 protected int file_looks_utf8(const unsigned char *, size_t, file_unichar_t *,
552     size_t *);
553 protected size_t file_pstring_length_size(struct magic_set *,
554     const struct magic *);
555 protected size_t file_pstring_get_length(struct magic_set *,
556     const struct magic *, const char *);
557 protected char * file_printable(struct magic_set *, char *, size_t,
558     const char *, size_t);
559 #ifdef __EMX__
560 protected int file_os2_apptype(struct magic_set *, const char *, const void *,
561     size_t);
562 #endif /* __EMX__ */
563 protected int file_pipe_closexec(int *);
564 protected int file_clear_closexec(int);
565 protected char *file_strtrim(char *);
566
567 protected void buffer_init(struct buffer *, int, const struct stat *,
568     const void *, size_t);
569 protected void buffer_fini(struct buffer *);
570 protected int buffer_fill(const struct buffer *);
571
572 #include <locale.h>
573 #if defined(HAVE_XLOCALE_H)
574 #include <xlocale.h>
575 #endif
576
577 typedef struct {
578         const char *pat;
579 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
580 #define USE_C_LOCALE
581         locale_t old_lc_ctype;
582         locale_t c_lc_ctype;
583 #else
584         char *old_lc_ctype;
585 #endif
586         int rc;
587         regex_t rx;
588 } file_regex_t;
589
590 protected int file_regcomp(file_regex_t *, const char *, int);
591 protected int file_regexec(file_regex_t *, const char *, size_t, regmatch_t *,
592     int);
593 protected void file_regfree(file_regex_t *);
594 protected void file_regerror(file_regex_t *, int, struct magic_set *);
595
596 typedef struct {
597         char *buf;
598         size_t blen;
599         uint32_t offset;
600 } file_pushbuf_t;
601
602 protected file_pushbuf_t *file_push_buffer(struct magic_set *);
603 protected char  *file_pop_buffer(struct magic_set *, file_pushbuf_t *);
604
605 #ifndef COMPILE_ONLY
606 extern const char *file_names[];
607 extern const size_t file_nnames;
608 #endif
609
610 #ifndef HAVE_PREAD
611 ssize_t pread(int, void *, size_t, off_t);
612 #endif
613 #ifndef HAVE_VASPRINTF
614 int vasprintf(char **, const char *, va_list);
615 #endif
616 #ifndef HAVE_ASPRINTF
617 int asprintf(char **, const char *, ...);
618 #endif
619 #ifndef HAVE_DPRINTF
620 int dprintf(int, const char *, ...);
621 #endif
622
623 #ifndef HAVE_STRLCPY
624 size_t strlcpy(char *, const char *, size_t);
625 #endif
626 #ifndef HAVE_STRLCAT
627 size_t strlcat(char *, const char *, size_t);
628 #endif
629 #ifndef HAVE_STRCASESTR
630 char *strcasestr(const char *, const char *);
631 #endif
632 #ifndef HAVE_GETLINE
633 ssize_t getline(char **, size_t *, FILE *);
634 ssize_t getdelim(char **, size_t *, int, FILE *);
635 #endif
636 #ifndef HAVE_CTIME_R
637 char   *ctime_r(const time_t *, char *);
638 #endif
639 #ifndef HAVE_ASCTIME_R
640 char   *asctime_r(const struct tm *, char *);
641 #endif
642 #ifndef HAVE_GMTIME_R
643 struct tm *gmtime_r(const time_t *, struct tm *);
644 #endif
645 #ifndef HAVE_LOCALTIME_R
646 struct tm *localtime_r(const time_t *, struct tm *);
647 #endif
648 #ifndef HAVE_FMTCHECK
649 const char *fmtcheck(const char *, const char *)
650      __attribute__((__format_arg__(2)));
651 #endif
652
653 #ifdef HAVE_LIBSECCOMP
654 // basic filter
655 // this mode should not interfere with normal operations
656 // only some dangerous syscalls are blacklisted
657 int enable_sandbox_basic(void);
658
659 // enhanced filter
660 // this mode allows only the necessary syscalls used during normal operation
661 // extensive testing required !!!
662 int enable_sandbox_full(void);
663 #endif
664
665 protected const char *file_getprogname(void);
666 protected void file_setprogname(const char *);
667 protected void file_err(int, const char *, ...)
668     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
669 protected void file_errx(int, const char *, ...)
670     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
671 protected void file_warn(const char *, ...)
672     __attribute__((__format__(__printf__, 1, 2)));
673 protected void file_warnx(const char *, ...)
674     __attribute__((__format__(__printf__, 1, 2)));
675
676 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
677 #define QUICK
678 #endif
679
680 #ifndef O_BINARY
681 #define O_BINARY        0
682 #endif
683 #ifndef O_NONBLOCK
684 #define O_NONBLOCK      0
685 #endif
686
687 #ifndef __cplusplus
688 #if defined(__GNUC__) && (__GNUC__ >= 3)
689 #define FILE_RCSID(id) \
690 static const char rcsid[] __attribute__((__used__)) = id;
691 #else
692 #define FILE_RCSID(id) \
693 static const char *rcsid(const char *p) { \
694         return rcsid(p = id); \
695 }
696 #endif
697 #else
698 #define FILE_RCSID(id)
699 #endif
700 #ifndef __RCSID
701 #define __RCSID(a)
702 #endif
703
704 #endif /* __file_h__ */