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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
29 * file.h - definitions for file(1) program
30 * @(#)$File: file.h,v 1.183 2017/08/28 13:39:18 christos Exp $
40 #ifndef __STDC_LIMIT_MACROS
41 #define __STDC_LIMIT_MACROS
46 #define SIZE_T_FORMAT "I64"
48 #define SIZE_T_FORMAT ""
50 #define INT64_T_FORMAT "I64"
51 #define INTMAX_T_FORMAT "I64"
53 #define SIZE_T_FORMAT "z"
54 #define INT64_T_FORMAT "ll"
55 #define INTMAX_T_FORMAT "j"
60 #include <stdio.h> /* Include that here, to make sure __P gets defined */
62 #include <fcntl.h> /* For open and flags */
63 #ifdef HAVE_INTTYPES_H
68 #include <sys/types.h>
70 #include <sys/param.h>
72 /* Do this here and now, because struct stat gets re-defined on solaris */
77 #define ENABLE_CONDITIONALS
80 #define MAGIC "/etc/magic"
83 #if defined(__EMX__) || defined (WIN32)
89 #define private static
91 #if HAVE_VISIBILITY && !defined(WIN32)
92 #define public __attribute__ ((__visibility__("default")))
94 #define protected __attribute__ ((__visibility__("hidden")))
104 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
107 #ifndef __GNUC_PREREQ__
109 #define __GNUC_PREREQ__(x, y) \
110 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
113 #define __GNUC_PREREQ__(x, y) 0
118 #ifndef __attribute__
119 #define __attribute__(a)
124 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
128 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
131 #ifndef FILE_BYTES_MAX
132 # define FILE_BYTES_MAX (1024 * 1024) /* how much of the file to look at */
134 #define MAXMAGIS 8192 /* max entries in any one magic file
136 #define MAXDESC 64 /* max len of text description/MIME type */
137 #define MAXMIME 80 /* max len of text MIME type */
138 #define MAXstring 96 /* max len of "string" types */
140 #define MAGICNO 0xF11E041C
142 #define FILE_MAGICSIZE 344
146 #define FILE_COMPILE 2
154 uint8_t hs
[2]; /* 2 bytes of a fixed-endian "short" */
155 uint8_t hl
[4]; /* 4 bytes of a fixed-endian "long" */
156 uint8_t hq
[8]; /* 8 bytes of a fixed-endian "quad" */
157 char s
[MAXstring
]; /* the search string or regex pattern */
158 unsigned char us
[MAXstring
];
165 uint16_t cont_level
; /* level of ">" */
167 #define INDIR 0x01 /* if '(...)' appears */
168 #define OFFADD 0x02 /* if '>&' or '>...(&' appears */
169 #define INDIROFFADD 0x04 /* if '>&(' appears */
170 #define UNSIGNED 0x08 /* comparison is unsigned */
171 #define NOSPACE 0x10 /* suppress space character before output */
172 #define BINTEST 0x20 /* test is for a binary type (set only
173 for top-level tests) */
174 #define TEXTTEST 0x40 /* for passing to file_softmagic */
179 uint8_t reln
; /* relation (0=eq, '>'=gt, etc) */
180 uint8_t vallen
; /* length of string value, if any */
181 uint8_t type
; /* comparison type (FILE_*) */
182 uint8_t in_type
; /* type of indirection */
183 #define FILE_INVALID 0
186 #define FILE_DEFAULT 3
188 #define FILE_STRING 5
190 #define FILE_BESHORT 7
191 #define FILE_BELONG 8
192 #define FILE_BEDATE 9
193 #define FILE_LESHORT 10
194 #define FILE_LELONG 11
195 #define FILE_LEDATE 12
196 #define FILE_PSTRING 13
197 #define FILE_LDATE 14
198 #define FILE_BELDATE 15
199 #define FILE_LELDATE 16
200 #define FILE_REGEX 17
201 #define FILE_BESTRING16 18
202 #define FILE_LESTRING16 19
203 #define FILE_SEARCH 20
204 #define FILE_MEDATE 21
205 #define FILE_MELDATE 22
206 #define FILE_MELONG 23
208 #define FILE_LEQUAD 25
209 #define FILE_BEQUAD 26
210 #define FILE_QDATE 27
211 #define FILE_LEQDATE 28
212 #define FILE_BEQDATE 29
213 #define FILE_QLDATE 30
214 #define FILE_LEQLDATE 31
215 #define FILE_BEQLDATE 32
216 #define FILE_FLOAT 33
217 #define FILE_BEFLOAT 34
218 #define FILE_LEFLOAT 35
219 #define FILE_DOUBLE 36
220 #define FILE_BEDOUBLE 37
221 #define FILE_LEDOUBLE 38
222 #define FILE_BEID3 39
223 #define FILE_LEID3 40
224 #define FILE_INDIRECT 41
225 #define FILE_QWDATE 42
226 #define FILE_LEQWDATE 43
227 #define FILE_BEQWDATE 44
230 #define FILE_CLEAR 47
232 #define FILE_NAMES_SIZE 49 /* size of array to contain all names */
234 #define IS_STRING(t) \
235 ((t) == FILE_STRING || \
236 (t) == FILE_PSTRING || \
237 (t) == FILE_BESTRING16 || \
238 (t) == FILE_LESTRING16 || \
239 (t) == FILE_REGEX || \
240 (t) == FILE_SEARCH || \
241 (t) == FILE_INDIRECT || \
242 (t) == FILE_NAME || \
245 #define FILE_FMT_NONE 0
246 #define FILE_FMT_NUM 1 /* "cduxXi" */
247 #define FILE_FMT_STR 2 /* "s" */
248 #define FILE_FMT_QUAD 3 /* "ll" */
249 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
250 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
253 uint8_t in_op
; /* operator for indirection */
254 uint8_t mask_op
; /* operator for mask */
255 #ifdef ENABLE_CONDITIONALS
256 uint8_t cond
; /* conditional type */
261 #define FILE_FACTOR_OP_PLUS '+'
262 #define FILE_FACTOR_OP_MINUS '-'
263 #define FILE_FACTOR_OP_TIMES '*'
264 #define FILE_FACTOR_OP_DIV '/'
265 #define FILE_FACTOR_OP_NONE '\0'
267 #define FILE_OPS "&|^+-*/%"
272 #define FILE_OPMINUS 4
273 #define FILE_OPMULTIPLY 5
274 #define FILE_OPDIVIDE 6
275 #define FILE_OPMODULO 7
276 #define FILE_OPS_MASK 0x07 /* mask for above ops */
277 #define FILE_UNUSED_1 0x08
278 #define FILE_UNUSED_2 0x10
279 #define FILE_OPSIGNED 0x20
280 #define FILE_OPINVERSE 0x40
281 #define FILE_OPINDIRECT 0x80
283 #ifdef ENABLE_CONDITIONALS
288 #endif /* ENABLE_CONDITIONALS */
291 uint32_t offset
; /* offset to magic number */
293 int32_t in_offset
; /* offset from indirection */
295 uint32_t lineno
; /* line number in magic file */
298 uint64_t _mask
; /* for use with numeric and date types */
300 uint32_t _count
; /* repeat/line count */
301 uint32_t _flags
; /* modifier flags */
302 } _s
; /* for use with string types */
304 #define num_mask _u._mask
305 #define str_range _u._s._count
306 #define str_flags _u._s._flags
308 union VALUETYPE value
; /* either number or string */
310 char desc
[MAXDESC
]; /* description */
312 char mimetype
[MAXMIME
]; /* MIME type */
314 char apple
[8]; /* APPLE CREATOR/TYPE */
316 char ext
[64]; /* Popular extensions */
319 #define BIT(A) (1 << (A))
320 #define STRING_COMPACT_WHITESPACE BIT(0)
321 #define STRING_COMPACT_OPTIONAL_WHITESPACE BIT(1)
322 #define STRING_IGNORE_LOWERCASE BIT(2)
323 #define STRING_IGNORE_UPPERCASE BIT(3)
324 #define REGEX_OFFSET_START BIT(4)
325 #define STRING_TEXTTEST BIT(5)
326 #define STRING_BINTEST BIT(6)
327 #define PSTRING_1_BE BIT(7)
328 #define PSTRING_1_LE BIT(7)
329 #define PSTRING_2_BE BIT(8)
330 #define PSTRING_2_LE BIT(9)
331 #define PSTRING_4_BE BIT(10)
332 #define PSTRING_4_LE BIT(11)
333 #define REGEX_LINE_COUNT BIT(11)
334 #define PSTRING_LEN \
335 (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
336 #define PSTRING_LENGTH_INCLUDES_ITSELF BIT(12)
337 #define STRING_TRIM BIT(13)
338 #define CHAR_COMPACT_WHITESPACE 'W'
339 #define CHAR_COMPACT_OPTIONAL_WHITESPACE 'w'
340 #define CHAR_IGNORE_LOWERCASE 'c'
341 #define CHAR_IGNORE_UPPERCASE 'C'
342 #define CHAR_REGEX_OFFSET_START 's'
343 #define CHAR_TEXTTEST 't'
344 #define CHAR_TRIM 'T'
345 #define CHAR_BINTEST 'b'
346 #define CHAR_PSTRING_1_BE 'B'
347 #define CHAR_PSTRING_1_LE 'B'
348 #define CHAR_PSTRING_2_BE 'H'
349 #define CHAR_PSTRING_2_LE 'h'
350 #define CHAR_PSTRING_4_BE 'L'
351 #define CHAR_PSTRING_4_LE 'l'
352 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF 'J'
353 #define STRING_IGNORE_CASE (STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
354 #define STRING_DEFAULT_RANGE 100
356 #define INDIRECT_RELATIVE BIT(0)
357 #define CHAR_INDIRECT_RELATIVE 'r'
359 /* list of magic entries */
361 struct magic
*magic
; /* array of magic entries */
362 uint32_t nmagic
; /* number of entries in array */
363 void *map
; /* internal resources used by entry */
364 struct mlist
*next
, *prev
;
368 #define CAST(T, b) static_cast<T>(b)
369 #define RCAST(T, b) reinterpret_cast<T>(b)
370 #define CCAST(T, b) const_cast<T>(b)
372 #define CAST(T, b) ((T)(b))
373 #define RCAST(T, b) ((T)(b))
374 #define CCAST(T, b) ((T)(uintptr_t)(b))
380 #ifdef ENABLE_CONDITIONALS
382 int last_cond
; /* used for error checking by parse() */
389 struct mlist
*mlist
[MAGIC_SETS
]; /* list of regular entries */
392 struct level_info
*li
;
395 char *buf
; /* Accumulation buffer */
396 char *pbuf
; /* Printable buffer */
400 int flags
; /* Control magic tests. */
401 int event_flags
; /* Note things that happened. */
402 #define EVENT_HAD_ERR 0x01
404 size_t line
; /* current magic line number */
406 /* data for searches */
408 const char *s
; /* start of search in original source */
409 size_t s_len
; /* length of search region */
410 size_t offset
; /* starting offset in source: XXX - should this be off_t? */
411 size_t rm_len
; /* match length */
414 /* FIXME: Make the string dynamically allocated so that e.g.
415 strings matched in files can be longer than MAXstring */
416 union VALUETYPE ms_value
; /* either number or string */
419 uint16_t elf_shnum_max
;
420 uint16_t elf_phnum_max
;
421 uint16_t elf_notes_max
;
423 size_t bytes_max
; /* number of bytes to read from file */
424 #define FILE_INDIR_MAX 50
425 #define FILE_NAME_MAX 30
426 #define FILE_ELF_SHNUM_MAX 32768
427 #define FILE_ELF_PHNUM_MAX 2048
428 #define FILE_ELF_NOTES_MAX 256
429 #define FILE_REGEX_MAX 8192
432 /* Type for Unicode characters */
433 typedef unsigned long unichar
;
436 #define FILE_T_LOCAL 1
437 #define FILE_T_WINDOWS 2
438 protected const char *file_fmttime(uint64_t, int, char *);
439 protected struct magic_set
*file_ms_alloc(int);
440 protected void file_ms_free(struct magic_set
*);
441 protected int file_buffer(struct magic_set
*, int, const char *, const void *,
443 protected int file_fsmagic(struct magic_set
*, const char *, struct stat
*);
444 protected int file_pipe2file(struct magic_set
*, int, const void *, size_t);
445 protected int file_vprintf(struct magic_set
*, const char *, va_list)
446 __attribute__((__format__(__printf__
, 2, 0)));
447 protected size_t file_printedlen(const struct magic_set
*);
448 protected int file_replace(struct magic_set
*, const char *, const char *);
449 protected int file_printf(struct magic_set
*, const char *, ...)
450 __attribute__((__format__(__printf__
, 2, 3)));
451 protected int file_reset(struct magic_set
*, int);
452 protected int file_tryelf(struct magic_set
*, int, const unsigned char *,
454 protected int file_trycdf(struct magic_set
*, int, const unsigned char *,
457 protected int file_zmagic(struct magic_set
*, int, const char *,
458 const unsigned char *, size_t);
460 protected int file_ascmagic(struct magic_set
*, const unsigned char *, size_t,
462 protected int file_ascmagic_with_encoding(struct magic_set
*,
463 const unsigned char *, size_t, unichar
*, size_t, const char *,
465 protected int file_encoding(struct magic_set
*, const unsigned char *, size_t,
466 unichar
**, size_t *, const char **, const char **, const char **);
467 protected int file_is_tar(struct magic_set
*, const unsigned char *, size_t);
468 protected int file_softmagic(struct magic_set
*, const unsigned char *, size_t,
469 uint16_t *, uint16_t *, int, int);
470 protected int file_apprentice(struct magic_set
*, const char *, int);
471 protected int buffer_apprentice(struct magic_set
*, struct magic
**,
473 protected int file_magicfind(struct magic_set
*, const char *, struct mlist
*);
474 protected uint64_t file_signextend(struct magic_set
*, struct magic
*,
476 protected void file_badread(struct magic_set
*);
477 protected void file_badseek(struct magic_set
*);
478 protected void file_oomem(struct magic_set
*, size_t);
479 protected void file_error(struct magic_set
*, int, const char *, ...)
480 __attribute__((__format__(__printf__
, 3, 4)));
481 protected void file_magerror(struct magic_set
*, const char *, ...)
482 __attribute__((__format__(__printf__
, 2, 3)));
483 protected void file_magwarn(struct magic_set
*, const char *, ...)
484 __attribute__((__format__(__printf__
, 2, 3)));
485 protected void file_mdump(struct magic
*);
486 protected void file_showstr(FILE *, const char *, size_t);
487 protected size_t file_mbswidth(const char *);
488 protected const char *file_getbuffer(struct magic_set
*);
489 protected ssize_t
sread(int, void *, size_t, int);
490 protected int file_check_mem(struct magic_set
*, unsigned int);
491 protected int file_looks_utf8(const unsigned char *, size_t, unichar
*,
493 protected size_t file_pstring_length_size(const struct magic
*);
494 protected size_t file_pstring_get_length(const struct magic
*, const char *);
495 protected char * file_printable(char *, size_t, const char *);
497 protected int file_os2_apptype(struct magic_set
*, const char *, const void *,
501 #if defined(HAVE_LOCALE_H)
504 #if defined(HAVE_XLOCALE_H)
510 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
512 locale_t old_lc_ctype
;
521 protected int file_regcomp(file_regex_t
*, const char *, int);
522 protected int file_regexec(file_regex_t
*, const char *, size_t, regmatch_t
*,
524 protected void file_regfree(file_regex_t
*);
525 protected void file_regerror(file_regex_t
*, int, struct magic_set
*);
532 protected file_pushbuf_t
*file_push_buffer(struct magic_set
*);
533 protected char *file_pop_buffer(struct magic_set
*, file_pushbuf_t
*);
536 extern const char *file_names
[];
537 extern const size_t file_nnames
;
540 #ifndef HAVE_STRERROR
542 extern char *sys_errlist
[];
543 #define strerror(e) \
544 (((e) >= 0 && (e) < sys_nerr) ? sys_errlist[(e)] : "Unknown error")
548 #define strtoul(a, b, c) strtol(a, b, c)
552 ssize_t
pread(int, void *, size_t, off_t
);
554 #ifndef HAVE_VASPRINTF
555 int vasprintf(char **, const char *, va_list);
557 #ifndef HAVE_ASPRINTF
558 int asprintf(char **, const char *, ...);
561 int dprintf(int, const char *, ...);
565 size_t strlcpy(char *, const char *, size_t);
568 size_t strlcat(char *, const char *, size_t);
570 #ifndef HAVE_STRCASESTR
571 char *strcasestr(const char *, const char *);
574 ssize_t
getline(char **, size_t *, FILE *);
575 ssize_t
getdelim(char **, size_t *, int, FILE *);
578 char *ctime_r(const time_t *, char *);
580 #ifndef HAVE_ASCTIME_R
581 char *asctime_r(const struct tm
*, char *);
583 #ifndef HAVE_GMTIME_R
584 struct tm
*gmtime_r(const time_t *, struct tm
*);
586 #ifndef HAVE_LOCALTIME_R
587 struct tm
*localtime_r(const time_t *, struct tm
*);
589 #ifndef HAVE_FMTCHECK
590 const char *fmtcheck(const char *, const char *)
591 __attribute__((__format_arg__(2)));
594 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
603 #if defined(__GNUC__) && (__GNUC__ >= 3)
604 #define FILE_RCSID(id) \
605 static const char rcsid[] __attribute__((__used__)) = id;
607 #define FILE_RCSID(id) \
608 static const char *rcsid(const char *p) { \
609 return rcsid(p = id); \
613 #define FILE_RCSID(id)
619 #endif /* __file_h__ */