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.135 2011/09/20 15:30:14 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
65 #include <sys/types.h>
66 #include <sys/param.h>
67 /* Do this here and now, because struct stat gets re-defined on solaris */
71 #define ENABLE_CONDITIONALS
74 #define MAGIC "/etc/magic"
77 #if defined(__EMX__) || defined (WIN32)
83 #define private static
90 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
93 #ifndef __GNUC_PREREQ__
95 #define __GNUC_PREREQ__(x, y) \
96 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
99 #define __GNUC_PREREQ__(x, y) 0
104 #ifndef __attribute__
105 #define __attribute__(a)
110 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
114 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
118 # define HOWMANY (256 * 1024) /* how much of the file to look at */
120 #define MAXMAGIS 8192 /* max entries in any one magic file
122 #define MAXDESC 64 /* max leng of text description/MIME type */
123 #define MAXstring 64 /* max leng of "string" types */
125 #define MAGICNO 0xF11E041C
127 #define FILE_MAGICSIZE 232
131 #define FILE_COMPILE 2
139 uint8_t hs[2]; /* 2 bytes of a fixed-endian "short" */
140 uint8_t hl[4]; /* 4 bytes of a fixed-endian "long" */
141 uint8_t hq[8]; /* 8 bytes of a fixed-endian "quad" */
142 char s[MAXstring]; /* the search string or regex pattern */
143 unsigned char us[MAXstring];
150 uint16_t cont_level; /* level of ">" */
152 #define INDIR 0x01 /* if '(...)' appears */
153 #define OFFADD 0x02 /* if '>&' or '>...(&' appears */
154 #define INDIROFFADD 0x04 /* if '>&(' appears */
155 #define UNSIGNED 0x08 /* comparison is unsigned */
156 #define NOSPACE 0x10 /* suppress space character before output */
157 #define BINTEST 0x20 /* test is for a binary type (set only
158 for top-level tests) */
159 #define TEXTTEST 0x40 /* for passing to file_softmagic */
164 uint8_t reln; /* relation (0=eq, '>'=gt, etc) */
165 uint8_t vallen; /* length of string value, if any */
166 uint8_t type; /* comparison type (FILE_*) */
167 uint8_t in_type; /* type of indirection */
168 #define FILE_INVALID 0
171 #define FILE_DEFAULT 3
173 #define FILE_STRING 5
175 #define FILE_BESHORT 7
176 #define FILE_BELONG 8
177 #define FILE_BEDATE 9
178 #define FILE_LESHORT 10
179 #define FILE_LELONG 11
180 #define FILE_LEDATE 12
181 #define FILE_PSTRING 13
182 #define FILE_LDATE 14
183 #define FILE_BELDATE 15
184 #define FILE_LELDATE 16
185 #define FILE_REGEX 17
186 #define FILE_BESTRING16 18
187 #define FILE_LESTRING16 19
188 #define FILE_SEARCH 20
189 #define FILE_MEDATE 21
190 #define FILE_MELDATE 22
191 #define FILE_MELONG 23
193 #define FILE_LEQUAD 25
194 #define FILE_BEQUAD 26
195 #define FILE_QDATE 27
196 #define FILE_LEQDATE 28
197 #define FILE_BEQDATE 29
198 #define FILE_QLDATE 30
199 #define FILE_LEQLDATE 31
200 #define FILE_BEQLDATE 32
201 #define FILE_FLOAT 33
202 #define FILE_BEFLOAT 34
203 #define FILE_LEFLOAT 35
204 #define FILE_DOUBLE 36
205 #define FILE_BEDOUBLE 37
206 #define FILE_LEDOUBLE 38
207 #define FILE_BEID3 39
208 #define FILE_LEID3 40
209 #define FILE_INDIRECT 41
210 #define FILE_NAMES_SIZE 42/* size of array to contain all names */
212 #define IS_STRING(t) \
213 ((t) == FILE_STRING || \
214 (t) == FILE_PSTRING || \
215 (t) == FILE_BESTRING16 || \
216 (t) == FILE_LESTRING16 || \
217 (t) == FILE_REGEX || \
218 (t) == FILE_SEARCH || \
221 #define FILE_FMT_NONE 0
222 #define FILE_FMT_NUM 1 /* "cduxXi" */
223 #define FILE_FMT_STR 2 /* "s" */
224 #define FILE_FMT_QUAD 3 /* "ll" */
225 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
226 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
229 uint8_t in_op; /* operator for indirection */
230 uint8_t mask_op; /* operator for mask */
231 #ifdef ENABLE_CONDITIONALS
232 uint8_t cond; /* conditional type */
237 #define FILE_FACTOR_OP_PLUS '+'
238 #define FILE_FACTOR_OP_MINUS '-'
239 #define FILE_FACTOR_OP_TIMES '*'
240 #define FILE_FACTOR_OP_DIV '/'
241 #define FILE_FACTOR_OP_NONE '\0'
243 #define FILE_OPS "&|^+-*/%"
248 #define FILE_OPMINUS 4
249 #define FILE_OPMULTIPLY 5
250 #define FILE_OPDIVIDE 6
251 #define FILE_OPMODULO 7
252 #define FILE_OPS_MASK 0x07 /* mask for above ops */
253 #define FILE_UNUSED_1 0x08
254 #define FILE_UNUSED_2 0x10
255 #define FILE_UNUSED_3 0x20
256 #define FILE_OPINVERSE 0x40
257 #define FILE_OPINDIRECT 0x80
259 #ifdef ENABLE_CONDITIONALS
264 #endif /* ENABLE_CONDITIONALS */
267 uint32_t offset; /* offset to magic number */
269 int32_t in_offset; /* offset from indirection */
271 uint32_t lineno; /* line number in magic file */
274 uint64_t _mask; /* for use with numeric and date types */
276 uint32_t _count; /* repeat/line count */
277 uint32_t _flags; /* modifier flags */
278 } _s; /* for use with string types */
280 #define num_mask _u._mask
281 #define str_range _u._s._count
282 #define str_flags _u._s._flags
284 union VALUETYPE value; /* either number or string */
286 char desc[MAXDESC]; /* description */
288 char mimetype[MAXDESC]; /* MIME type */
293 #define BIT(A) (1 << (A))
294 #define STRING_COMPACT_WHITESPACE BIT(0)
295 #define STRING_COMPACT_OPTIONAL_WHITESPACE BIT(1)
296 #define STRING_IGNORE_LOWERCASE BIT(2)
297 #define STRING_IGNORE_UPPERCASE BIT(3)
298 #define REGEX_OFFSET_START BIT(4)
299 #define STRING_TEXTTEST BIT(5)
300 #define STRING_BINTEST BIT(6)
301 #define PSTRING_1_BE BIT(7)
302 #define PSTRING_1_LE BIT(7)
303 #define PSTRING_2_BE BIT(8)
304 #define PSTRING_2_LE BIT(9)
305 #define PSTRING_4_BE BIT(10)
306 #define PSTRING_4_LE BIT(11)
307 #define PSTRING_LEN \
308 (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
309 #define PSTRING_LENGTH_INCLUDES_ITSELF BIT(12)
310 #define CHAR_COMPACT_WHITESPACE 'W'
311 #define CHAR_COMPACT_OPTIONAL_WHITESPACE 'w'
312 #define CHAR_IGNORE_LOWERCASE 'c'
313 #define CHAR_IGNORE_UPPERCASE 'C'
314 #define CHAR_REGEX_OFFSET_START 's'
315 #define CHAR_TEXTTEST 't'
316 #define CHAR_BINTEST 'b'
317 #define CHAR_PSTRING_1_BE 'B'
318 #define CHAR_PSTRING_1_LE 'B'
319 #define CHAR_PSTRING_2_BE 'H'
320 #define CHAR_PSTRING_2_LE 'h'
321 #define CHAR_PSTRING_4_BE 'L'
322 #define CHAR_PSTRING_4_LE 'l'
323 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF 'J'
324 #define STRING_IGNORE_CASE (STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
325 #define STRING_DEFAULT_RANGE 100
328 /* list of magic entries */
330 struct magic *magic; /* array of magic entries */
331 uint32_t nmagic; /* number of entries in array */
332 int mapped; /* allocation type: 0 => apprentice_file
333 * 1 => apprentice_map + malloc
334 * 2 => apprentice_map + mmap */
335 struct mlist *next, *prev;
339 #define CAST(T, b) static_cast<T>(b)
340 #define RCAST(T, b) reinterpret_cast<T>(b)
342 #define CAST(T, b) (T)(b)
343 #define RCAST(T, b) (T)(b)
349 #ifdef ENABLE_CONDITIONALS
351 int last_cond; /* used for error checking by parse() */
358 struct level_info *li;
361 char *buf; /* Accumulation buffer */
362 char *pbuf; /* Printable buffer */
366 int flags; /* Control magic tests. */
367 int event_flags; /* Note things that happened. */
368 #define EVENT_HAD_ERR 0x01
370 size_t line; /* current magic line number */
372 /* data for searches */
374 const char *s; /* start of search in original source */
375 size_t s_len; /* length of search region */
376 size_t offset; /* starting offset in source: XXX - should this be off_t? */
377 size_t rm_len; /* match length */
380 /* FIXME: Make the string dynamically allocated so that e.g.
381 strings matched in files can be longer than MAXstring */
382 union VALUETYPE ms_value; /* either number or string */
385 /* Type for Unicode characters */
386 typedef unsigned long unichar;
389 protected const char *file_fmttime(uint32_t, int);
390 protected int file_buffer(struct magic_set *, int, const char *, const void *,
392 protected int file_fsmagic(struct magic_set *, const char *, struct stat *);
393 protected int file_pipe2file(struct magic_set *, int, const void *, size_t);
394 protected int file_vprintf(struct magic_set *, const char *, va_list);
395 protected size_t file_printedlen(const struct magic_set *);
396 protected int file_replace(struct magic_set *, const char *, const char *);
397 protected int file_printf(struct magic_set *, const char *, ...)
398 __attribute__((__format__(__printf__, 2, 3)));
399 protected int file_reset(struct magic_set *);
400 protected int file_tryelf(struct magic_set *, int, const unsigned char *,
402 protected int file_trycdf(struct magic_set *, int, const unsigned char *,
405 protected int file_zmagic(struct magic_set *, int, const char *,
406 const unsigned char *, size_t);
408 protected int file_ascmagic(struct magic_set *, const unsigned char *, size_t,
410 protected int file_ascmagic_with_encoding(struct magic_set *,
411 const unsigned char *, size_t, unichar *, size_t, const char *,
413 protected int file_encoding(struct magic_set *, const unsigned char *, size_t,
414 unichar **, size_t *, const char **, const char **, const char **);
415 protected int file_is_tar(struct magic_set *, const unsigned char *, size_t);
416 protected int file_softmagic(struct magic_set *, const unsigned char *, size_t,
418 protected struct mlist *file_apprentice(struct magic_set *, const char *, int);
419 protected uint64_t file_signextend(struct magic_set *, struct magic *,
421 protected void file_delmagic(struct magic *, int type, size_t entries);
422 protected void file_badread(struct magic_set *);
423 protected void file_badseek(struct magic_set *);
424 protected void file_oomem(struct magic_set *, size_t);
425 protected void file_error(struct magic_set *, int, const char *, ...)
426 __attribute__((__format__(__printf__, 3, 4)));
427 protected void file_magerror(struct magic_set *, const char *, ...)
428 __attribute__((__format__(__printf__, 2, 3)));
429 protected void file_magwarn(struct magic_set *, const char *, ...)
430 __attribute__((__format__(__printf__, 2, 3)));
431 protected void file_mdump(struct magic *);
432 protected void file_showstr(FILE *, const char *, size_t);
433 protected size_t file_mbswidth(const char *);
434 protected const char *file_getbuffer(struct magic_set *);
435 protected ssize_t sread(int, void *, size_t, int);
436 protected int file_check_mem(struct magic_set *, unsigned int);
437 protected int file_looks_utf8(const unsigned char *, size_t, unichar *,
439 protected size_t file_pstring_length_size(const struct magic *);
440 protected size_t file_pstring_get_length(const struct magic *, const char *);
442 protected int file_os2_apptype(struct magic_set *, const char *, const void *,
448 extern const char *file_names[];
449 extern const size_t file_nnames;
452 #ifndef HAVE_STRERROR
454 extern char *sys_errlist[];
455 #define strerror(e) \
456 (((e) >= 0 && (e) < sys_nerr) ? sys_errlist[(e)] : "Unknown error")
460 #define strtoul(a, b, c) strtol(a, b, c)
463 #ifndef HAVE_VASPRINTF
464 int vasprintf(char **, const char *, va_list);
466 #ifndef HAVE_ASPRINTF
467 int asprintf(char **ptr, const char *format_string, ...);
471 size_t strlcpy(char *dst, const char *src, size_t siz);
474 size_t strlcat(char *dst, const char *src, size_t siz);
477 ssize_t getline(char **dst, size_t *len, FILE *fp);
478 ssize_t getdelim(char **dst, size_t *len, int delimiter, FILE *fp);
481 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
490 #if defined(__GNUC__) && (__GNUC__ >= 3)
491 #define FILE_RCSID(id) \
492 static const char rcsid[] __attribute__((__used__)) = id;
494 #define FILE_RCSID(id) \
495 static const char *rcsid(const char *p) { \
496 return rcsid(p = id); \
500 #define FILE_RCSID(id)
503 #endif /* __file_h__ */