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.168 2015/04/09 20:01:41 christos Exp $
42 #define SIZE_T_FORMAT "I64"
44 #define SIZE_T_FORMAT ""
46 #define INT64_T_FORMAT "I64"
48 #define SIZE_T_FORMAT "z"
49 #define INT64_T_FORMAT "ll"
52 #include <stdio.h> /* Include that here, to make sure __P gets defined */
54 #include <fcntl.h> /* For open and flags */
56 #ifndef __STDC_LIMIT_MACROS
57 #define __STDC_LIMIT_MACROS
61 #ifdef HAVE_INTTYPES_H
66 #include <sys/types.h>
68 #include <sys/param.h>
70 /* Do this here and now, because struct stat gets re-defined on solaris */
74 #define ENABLE_CONDITIONALS
77 #define MAGIC "/etc/magic"
80 #if defined(__EMX__) || defined (WIN32)
86 #define private static
88 #if HAVE_VISIBILITY && !defined(WIN32)
89 #define public __attribute__ ((__visibility__("default")))
91 #define protected __attribute__ ((__visibility__("hidden")))
101 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
104 #ifndef __GNUC_PREREQ__
106 #define __GNUC_PREREQ__(x, y) \
107 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
110 #define __GNUC_PREREQ__(x, y) 0
115 #ifndef __attribute__
116 #define __attribute__(a)
121 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
125 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
129 # define HOWMANY (1024 * 1024) /* how much of the file to look at */
131 #define MAXMAGIS 8192 /* max entries in any one magic file
133 #define MAXDESC 64 /* max len of text description/MIME type */
134 #define MAXMIME 80 /* max len of text MIME type */
135 #define MAXstring 64 /* max len of "string" types */
137 #define MAGICNO 0xF11E041C
139 #define FILE_MAGICSIZE 312
143 #define FILE_COMPILE 2
151 uint8_t hs[2]; /* 2 bytes of a fixed-endian "short" */
152 uint8_t hl[4]; /* 4 bytes of a fixed-endian "long" */
153 uint8_t hq[8]; /* 8 bytes of a fixed-endian "quad" */
154 char s[MAXstring]; /* the search string or regex pattern */
155 unsigned char us[MAXstring];
162 uint16_t cont_level; /* level of ">" */
164 #define INDIR 0x01 /* if '(...)' appears */
165 #define OFFADD 0x02 /* if '>&' or '>...(&' appears */
166 #define INDIROFFADD 0x04 /* if '>&(' appears */
167 #define UNSIGNED 0x08 /* comparison is unsigned */
168 #define NOSPACE 0x10 /* suppress space character before output */
169 #define BINTEST 0x20 /* test is for a binary type (set only
170 for top-level tests) */
171 #define TEXTTEST 0x40 /* for passing to file_softmagic */
176 uint8_t reln; /* relation (0=eq, '>'=gt, etc) */
177 uint8_t vallen; /* length of string value, if any */
178 uint8_t type; /* comparison type (FILE_*) */
179 uint8_t in_type; /* type of indirection */
180 #define FILE_INVALID 0
183 #define FILE_DEFAULT 3
185 #define FILE_STRING 5
187 #define FILE_BESHORT 7
188 #define FILE_BELONG 8
189 #define FILE_BEDATE 9
190 #define FILE_LESHORT 10
191 #define FILE_LELONG 11
192 #define FILE_LEDATE 12
193 #define FILE_PSTRING 13
194 #define FILE_LDATE 14
195 #define FILE_BELDATE 15
196 #define FILE_LELDATE 16
197 #define FILE_REGEX 17
198 #define FILE_BESTRING16 18
199 #define FILE_LESTRING16 19
200 #define FILE_SEARCH 20
201 #define FILE_MEDATE 21
202 #define FILE_MELDATE 22
203 #define FILE_MELONG 23
205 #define FILE_LEQUAD 25
206 #define FILE_BEQUAD 26
207 #define FILE_QDATE 27
208 #define FILE_LEQDATE 28
209 #define FILE_BEQDATE 29
210 #define FILE_QLDATE 30
211 #define FILE_LEQLDATE 31
212 #define FILE_BEQLDATE 32
213 #define FILE_FLOAT 33
214 #define FILE_BEFLOAT 34
215 #define FILE_LEFLOAT 35
216 #define FILE_DOUBLE 36
217 #define FILE_BEDOUBLE 37
218 #define FILE_LEDOUBLE 38
219 #define FILE_BEID3 39
220 #define FILE_LEID3 40
221 #define FILE_INDIRECT 41
222 #define FILE_QWDATE 42
223 #define FILE_LEQWDATE 43
224 #define FILE_BEQWDATE 44
227 #define FILE_CLEAR 47
228 #define FILE_NAMES_SIZE 48 /* size of array to contain all names */
230 #define IS_STRING(t) \
231 ((t) == FILE_STRING || \
232 (t) == FILE_PSTRING || \
233 (t) == FILE_BESTRING16 || \
234 (t) == FILE_LESTRING16 || \
235 (t) == FILE_REGEX || \
236 (t) == FILE_SEARCH || \
237 (t) == FILE_INDIRECT || \
238 (t) == FILE_NAME || \
241 #define FILE_FMT_NONE 0
242 #define FILE_FMT_NUM 1 /* "cduxXi" */
243 #define FILE_FMT_STR 2 /* "s" */
244 #define FILE_FMT_QUAD 3 /* "ll" */
245 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
246 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
249 uint8_t in_op; /* operator for indirection */
250 uint8_t mask_op; /* operator for mask */
251 #ifdef ENABLE_CONDITIONALS
252 uint8_t cond; /* conditional type */
257 #define FILE_FACTOR_OP_PLUS '+'
258 #define FILE_FACTOR_OP_MINUS '-'
259 #define FILE_FACTOR_OP_TIMES '*'
260 #define FILE_FACTOR_OP_DIV '/'
261 #define FILE_FACTOR_OP_NONE '\0'
263 #define FILE_OPS "&|^+-*/%"
268 #define FILE_OPMINUS 4
269 #define FILE_OPMULTIPLY 5
270 #define FILE_OPDIVIDE 6
271 #define FILE_OPMODULO 7
272 #define FILE_OPS_MASK 0x07 /* mask for above ops */
273 #define FILE_UNUSED_1 0x08
274 #define FILE_UNUSED_2 0x10
275 #define FILE_UNUSED_3 0x20
276 #define FILE_OPINVERSE 0x40
277 #define FILE_OPINDIRECT 0x80
279 #ifdef ENABLE_CONDITIONALS
284 #endif /* ENABLE_CONDITIONALS */
287 uint32_t offset; /* offset to magic number */
289 int32_t in_offset; /* offset from indirection */
291 uint32_t lineno; /* line number in magic file */
294 uint64_t _mask; /* for use with numeric and date types */
296 uint32_t _count; /* repeat/line count */
297 uint32_t _flags; /* modifier flags */
298 } _s; /* for use with string types */
300 #define num_mask _u._mask
301 #define str_range _u._s._count
302 #define str_flags _u._s._flags
304 union VALUETYPE value; /* either number or string */
306 char desc[MAXDESC]; /* description */
308 char mimetype[MAXMIME]; /* MIME type */
310 char apple[8]; /* APPLE CREATOR/TYPE */
312 char ext[64]; /* Popular extensions */
315 #define BIT(A) (1 << (A))
316 #define STRING_COMPACT_WHITESPACE BIT(0)
317 #define STRING_COMPACT_OPTIONAL_WHITESPACE BIT(1)
318 #define STRING_IGNORE_LOWERCASE BIT(2)
319 #define STRING_IGNORE_UPPERCASE BIT(3)
320 #define REGEX_OFFSET_START BIT(4)
321 #define STRING_TEXTTEST BIT(5)
322 #define STRING_BINTEST BIT(6)
323 #define PSTRING_1_BE BIT(7)
324 #define PSTRING_1_LE BIT(7)
325 #define PSTRING_2_BE BIT(8)
326 #define PSTRING_2_LE BIT(9)
327 #define PSTRING_4_BE BIT(10)
328 #define PSTRING_4_LE BIT(11)
329 #define REGEX_LINE_COUNT BIT(11)
330 #define PSTRING_LEN \
331 (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
332 #define PSTRING_LENGTH_INCLUDES_ITSELF BIT(12)
333 #define STRING_TRIM BIT(13)
334 #define CHAR_COMPACT_WHITESPACE 'W'
335 #define CHAR_COMPACT_OPTIONAL_WHITESPACE 'w'
336 #define CHAR_IGNORE_LOWERCASE 'c'
337 #define CHAR_IGNORE_UPPERCASE 'C'
338 #define CHAR_REGEX_OFFSET_START 's'
339 #define CHAR_TEXTTEST 't'
340 #define CHAR_TRIM 'T'
341 #define CHAR_BINTEST 'b'
342 #define CHAR_PSTRING_1_BE 'B'
343 #define CHAR_PSTRING_1_LE 'B'
344 #define CHAR_PSTRING_2_BE 'H'
345 #define CHAR_PSTRING_2_LE 'h'
346 #define CHAR_PSTRING_4_BE 'L'
347 #define CHAR_PSTRING_4_LE 'l'
348 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF 'J'
349 #define STRING_IGNORE_CASE (STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
350 #define STRING_DEFAULT_RANGE 100
352 #define INDIRECT_RELATIVE BIT(0)
353 #define CHAR_INDIRECT_RELATIVE 'r'
355 /* list of magic entries */
357 struct magic *magic; /* array of magic entries */
358 uint32_t nmagic; /* number of entries in array */
359 void *map; /* internal resources used by entry */
360 struct mlist *next, *prev;
364 #define CAST(T, b) static_cast<T>(b)
365 #define RCAST(T, b) reinterpret_cast<T>(b)
367 #define CAST(T, b) (T)(b)
368 #define RCAST(T, b) (T)(b)
374 #ifdef ENABLE_CONDITIONALS
376 int last_cond; /* used for error checking by parse() */
383 struct mlist *mlist[MAGIC_SETS]; /* list of regular entries */
386 struct level_info *li;
389 char *buf; /* Accumulation buffer */
390 char *pbuf; /* Printable buffer */
394 int flags; /* Control magic tests. */
395 int event_flags; /* Note things that happened. */
396 #define EVENT_HAD_ERR 0x01
398 size_t line; /* current magic line number */
400 /* data for searches */
402 const char *s; /* start of search in original source */
403 size_t s_len; /* length of search region */
404 size_t offset; /* starting offset in source: XXX - should this be off_t? */
405 size_t rm_len; /* match length */
408 /* FIXME: Make the string dynamically allocated so that e.g.
409 strings matched in files can be longer than MAXstring */
410 union VALUETYPE ms_value; /* either number or string */
413 uint16_t elf_shnum_max;
414 uint16_t elf_phnum_max;
415 uint16_t elf_notes_max;
416 #define FILE_INDIR_MAX 15
417 #define FILE_NAME_MAX 30
418 #define FILE_ELF_SHNUM_MAX 32768
419 #define FILE_ELF_PHNUM_MAX 128
420 #define FILE_ELF_NOTES_MAX 256
423 /* Type for Unicode characters */
424 typedef unsigned long unichar;
427 #define FILE_T_LOCAL 1
428 #define FILE_T_WINDOWS 2
429 protected const char *file_fmttime(uint64_t, int, char *);
430 protected struct magic_set *file_ms_alloc(int);
431 protected void file_ms_free(struct magic_set *);
432 protected int file_buffer(struct magic_set *, int, const char *, const void *,
434 protected int file_fsmagic(struct magic_set *, const char *, struct stat *);
435 protected int file_pipe2file(struct magic_set *, int, const void *, size_t);
436 protected int file_vprintf(struct magic_set *, const char *, va_list)
437 __attribute__((__format__(__printf__, 2, 0)));
438 protected size_t file_printedlen(const struct magic_set *);
439 protected int file_replace(struct magic_set *, const char *, const char *);
440 protected int file_printf(struct magic_set *, const char *, ...)
441 __attribute__((__format__(__printf__, 2, 3)));
442 protected int file_reset(struct magic_set *);
443 protected int file_tryelf(struct magic_set *, int, const unsigned char *,
445 protected int file_trycdf(struct magic_set *, int, const unsigned char *,
448 protected int file_zmagic(struct magic_set *, int, const char *,
449 const unsigned char *, size_t);
451 protected int file_ascmagic(struct magic_set *, const unsigned char *, size_t,
453 protected int file_ascmagic_with_encoding(struct magic_set *,
454 const unsigned char *, size_t, unichar *, size_t, const char *,
456 protected int file_encoding(struct magic_set *, const unsigned char *, size_t,
457 unichar **, size_t *, const char **, const char **, const char **);
458 protected int file_is_tar(struct magic_set *, const unsigned char *, size_t);
459 protected int file_softmagic(struct magic_set *, const unsigned char *, size_t,
460 uint16_t, uint16_t *, int, int);
461 protected int file_apprentice(struct magic_set *, const char *, int);
462 protected int buffer_apprentice(struct magic_set *, struct magic **,
464 protected int file_magicfind(struct magic_set *, const char *, struct mlist *);
465 protected uint64_t file_signextend(struct magic_set *, struct magic *,
467 protected void file_badread(struct magic_set *);
468 protected void file_badseek(struct magic_set *);
469 protected void file_oomem(struct magic_set *, size_t);
470 protected void file_error(struct magic_set *, int, const char *, ...)
471 __attribute__((__format__(__printf__, 3, 4)));
472 protected void file_magerror(struct magic_set *, const char *, ...)
473 __attribute__((__format__(__printf__, 2, 3)));
474 protected void file_magwarn(struct magic_set *, const char *, ...)
475 __attribute__((__format__(__printf__, 2, 3)));
476 protected void file_mdump(struct magic *);
477 protected void file_showstr(FILE *, const char *, size_t);
478 protected size_t file_mbswidth(const char *);
479 protected const char *file_getbuffer(struct magic_set *);
480 protected ssize_t sread(int, void *, size_t, int);
481 protected int file_check_mem(struct magic_set *, unsigned int);
482 protected int file_looks_utf8(const unsigned char *, size_t, unichar *,
484 protected size_t file_pstring_length_size(const struct magic *);
485 protected size_t file_pstring_get_length(const struct magic *, const char *);
486 protected char * file_printable(char *, size_t, const char *);
488 protected int file_os2_apptype(struct magic_set *, const char *, const void *,
492 #if defined(HAVE_LOCALE_H)
495 #if defined(HAVE_XLOCALE_H)
501 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
503 locale_t old_lc_ctype;
510 protected int file_regcomp(file_regex_t *, const char *, int);
511 protected int file_regexec(file_regex_t *, const char *, size_t, regmatch_t *,
513 protected void file_regfree(file_regex_t *);
514 protected void file_regerror(file_regex_t *, int, struct magic_set *);
521 protected file_pushbuf_t *file_push_buffer(struct magic_set *);
522 protected char *file_pop_buffer(struct magic_set *, file_pushbuf_t *);
525 extern const char *file_names[];
526 extern const size_t file_nnames;
529 #ifndef HAVE_STRERROR
531 extern char *sys_errlist[];
532 #define strerror(e) \
533 (((e) >= 0 && (e) < sys_nerr) ? sys_errlist[(e)] : "Unknown error")
537 #define strtoul(a, b, c) strtol(a, b, c)
541 ssize_t pread(int, void *, size_t, off_t);
543 #ifndef HAVE_VASPRINTF
544 int vasprintf(char **, const char *, va_list);
546 #ifndef HAVE_ASPRINTF
547 int asprintf(char **, const char *, ...);
551 size_t strlcpy(char *, const char *, size_t);
554 size_t strlcat(char *, const char *, size_t);
556 #ifndef HAVE_STRCASESTR
557 char *strcasestr(const char *, const char *);
560 ssize_t getline(char **, size_t *, FILE *);
561 ssize_t getdelim(char **, size_t *, int, FILE *);
564 char *ctime_r(const time_t *, char *);
566 #ifndef HAVE_ASCTIME_R
567 char *asctime_r(const struct tm *, char *);
569 #ifndef HAVE_GMTIME_R
570 struct tm *gmtime_r(const time_t *, struct tm *);
572 #ifndef HAVE_LOCALTIME_R
573 struct tm *localtime_r(const time_t *, struct tm *);
575 #ifndef HAVE_FMTCHECK
576 const char *fmtcheck(const char *, const char *)
577 __attribute__((__format_arg__(2)));
580 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
589 #if defined(__GNUC__) && (__GNUC__ >= 3)
590 #define FILE_RCSID(id) \
591 static const char rcsid[] __attribute__((__used__)) = id;
593 #define FILE_RCSID(id) \
594 static const char *rcsid(const char *p) { \
595 return rcsid(p = id); \
599 #define FILE_RCSID(id)
605 #endif /* __file_h__ */