aboutsummaryrefslogtreecommitdiffstats
path: root/include/error.h
blob: 34e7d50f2d4cc57ecc05e669e9fb55d77fa2edc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* ----------------------------------------------------------------------- *
 *
 *   Copyright 1996-2018 The NASM Authors - All Rights Reserved
 *   See the file AUTHORS included with the NASM distribution for
 *   the specific copyright holders.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following
 *   conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *
 *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ----------------------------------------------------------------------- */

/*
 * Error reporting functions for the assembler
 */

#ifndef NASM_ERROR_H
#define NASM_ERROR_H 1

#include "compiler.h"

/*
 * File pointer for error messages
 */
extern FILE *error_file;        /* Error file descriptor */

/*
 * Typedef for the severity field
 */
typedef uint32_t errflags;

/*
 * An error reporting function should look like this.
 */
void printf_func(2, 3) nasm_error(errflags severity, const char *fmt, ...);
void printf_func(1, 2) nasm_debug(const char *fmt, ...);
void printf_func(2, 3) nasm_debugf(errflags flags, const char *fmt, ...);
void printf_func(1, 2) nasm_note(const char *fmt, ...);
void printf_func(2, 3) nasm_notef(errflags flags, const char *fmt, ...);
void printf_func(1, 2) nasm_warn(const char *fmt, ...);
void printf_func(2, 3) nasm_warnf(errflags flags, const char *fmt, ...);
void printf_func(1, 2) nasm_nonfatal(const char *fmt, ...);
void printf_func(2, 3) nasm_nonfatalf(errflags flags, const char *fmt, ...);
fatal_func printf_func(1, 2) nasm_fatal(const char *fmt, ...);
fatal_func printf_func(2, 3) nasm_fatalf(errflags flags, const char *fmt, ...);
fatal_func printf_func(1, 2) nasm_panic(const char *fmt, ...);
fatal_func printf_func(2, 3) nasm_panicf(errflags flags, const char *fmt, ...);
fatal_func nasm_panic_from_macro(const char *file, int line);
#define panic() nasm_panic_from_macro(__FILE__, __LINE__);

typedef void (*vefunc) (errflags severity, const char *fmt, va_list ap);
extern vefunc nasm_verror;

static inline vefunc nasm_set_verror(vefunc ve)
{
	vefunc old_verror = nasm_verror;
	nasm_verror = ve;
	return old_verror;
}

/*
 * These are the error severity codes which get passed as the first
 * argument to an efunc.
 */

#define ERR_DEBUG		0x00000000	/* put out debugging message */
#define ERR_NOTE		0x00000001	/* additional error information */
#define ERR_WARNING		0x00000002	/* warn only: no further action */
#define ERR_NONFATAL		0x00000003	/* terminate assembly after phase */
#define ERR_FATAL		0x00000006	/* instantly fatal: exit with error */
#define ERR_PANIC		0x00000007	/* internal error: panic instantly
						 * and dump core for reference */
#define ERR_MASK		0x00000007	/* mask off the above codes */
#define ERR_NOFILE		0x00000010	/* don't give source file name/line */
#define ERR_HERE		0x00000020      /* point to a specific source location */
#define ERR_USAGE		0x00000040	/* print a usage message */
#define ERR_PASS1		0x00000080	/* only print this error on pass one */
#define ERR_PASS2		0x00000100	/* only print this error on pass one */

#define ERR_NO_SEVERITY		0x00000200	/* suppress printing severity */
#define ERR_PP_PRECOND		0x00000400	/* for preprocessor use */
#define ERR_PP_LISTMACRO	0x00000800	/* from preproc->error_list_macros() */

/*
 * These codes define specific types of suppressible warning.
 * They are assumed to occupy the most significant bits of the
 * severity code.
 */

#define WARN_SHR		12              /* how far to shift right */
#define WARN(x)         	(((errflags)(x)) << WARN_SHR)
#define WARN_MASK		WARN(~0)
#define WARN_IDX(x)     	(((errflags)(x)) >> WARN_SHR)

#define WARN_MACRO_PARAMS            	WARN( 1) /* macro-num-parameters warning */
#define WARN_MACRO_SELFREF            	WARN( 2) /* macro self-reference */
#define WARN_MACRO_DEFAULTS            	WARN( 3) /* macro default parameters check */
#define WARN_ORPHAN_LABELS             	WARN( 4) /* orphan label (no colon, and alone on line) */
#define WARN_NUMBER_OVERFLOW            	WARN( 5) /* numeric overflow */
#define WARN_GNU_ELF_EXTENSIONS         	WARN( 6) /* using GNU ELF extensions */
#define WARN_FLOAT_OVERFLOW    	WARN( 7) /* FP overflow */
#define WARN_FLOAT_DENORM      	WARN( 8) /* FP denormal */
#define WARN_FLOAT_UNDERFLOW   	WARN( 9) /* FP underflow */
#define WARN_FLOAT_TOOLONG     	WARN(10) /* FP too many digits */
#define WARN_USER           	WARN(11) /* %warning directives */
#define WARN_LOCK		WARN(12) /* bad LOCK prefixes */
#define WARN_HLE		WARN(13) /* bad HLE prefixes */
#define WARN_BND		WARN(14) /* bad BND prefixes */
#define WARN_ZEXTRELOC		WARN(15) /* relocation zero-extended */
#define WARN_PTR		WARN(16) /* not a NASM keyword */
#define WARN_BAD_PRAGMA		WARN(17) /* malformed pragma */
#define WARN_UNKNOWN_PRAGMA	WARN(18) /* unknown pragma */
#define WARN_NOT_MY_PRAGMA	WARN(19) /* pragma inapplicable */
#define WARN_UNK_WARNING	WARN(20) /* unknown warning */
#define WARN_NEGATIVE_REP		WARN(21) /* negative repeat count */
#define WARN_PHASE		WARN(22) /* phase error in pass 1 */
#define WARN_LABEL_REDEF	WARN(23) /* label redefined, but consistent */
#define WARN_LABEL_REDEF_LATE		WARN(24) /* label (re)defined during code generation */

/* These two should come last */
#define WARN_ALL		(24+2) /* Do not use WARN() here */
#define WARN_OTHER		WARN(WARN_ALL-1) /* any noncategorized warning */

/* This is a bitmask */
#define WARN_ST_ENABLED		1 /* Warning is currently enabled */
#define WARN_ST_ERROR		2 /* Treat this warning as an error */

struct warning {
	const char *name;
	const char *help;
	uint8_t state;		/* Default state for this warning */
};
extern const struct warning warnings[WARN_ALL+1];
extern uint8_t warning_state[WARN_ALL];
extern uint8_t warning_state_init[WARN_ALL];

/* Process a warning option or directive */
bool set_warning_status(const char *value);

#endif /* NASM_ERROR_H */