Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 962 lines (851 sloc) 33.707 kb
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
1 /* nasm.h main header file for the Netwide Assembler: inter-module interface
2 *
3 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
4 * Julian Hall. All rights reserved. The software is
5 * redistributable under the licence given in the file "Licence"
6 * distributed in the NASM archive.
7 *
8 * initial version: 27/iii/95 by Simon Tatham
9 */
10
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
11 #ifndef NASM_NASM_H
12 #define NASM_NASM_H
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
13
24cfef4f » H. Peter Anvin
2002-09-12 Clean up unnecessary dependencies.
14 #include <stdio.h>
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
15 #include <inttypes.h>
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
16 #include "version.h" /* generated NASM version macros */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
17
c40f89e1 » H. Peter Anvin
2007-04-13 AIf we have config.h, we should actually include it!!
18 #ifdef HAVE_CONFIG_H
19 #include "config.h"
20 #endif
21
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
22 #ifndef NULL
23 #define NULL 0
24 #endif
25
26 #ifndef FALSE
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
27 #define FALSE 0 /* comes in handy */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
28 #endif
29 #ifndef TRUE
30 #define TRUE 1
31 #endif
32
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
33 #define NO_SEG -1L /* null segment value */
34 #define SEG_ABS 0x40000000L /* mask for far-absolute segments */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
35
36 #ifndef FILENAME_MAX
37 #define FILENAME_MAX 256
38 #endif
39
1cd0e2d5 » H. Peter Anvin
2002-04-30 NASM 0.98.08
40 #ifndef PREFIX_MAX
41 #define PREFIX_MAX 10
42 #endif
43
44 #ifndef POSTFIX_MAX
45 #define POSTFIX_MAX 10
46 #endif
47
c06f6df2 » Ed Beroset
2003-09-08 fixed bug #677841 by limiting the scanner to no more than 4095 charac…
48 #define IDLEN_MAX 4096
1cd0e2d5 » H. Peter Anvin
2002-04-30 NASM 0.98.08
49
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
50 /*
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
51 * Name pollution problems: <time.h> on Digital UNIX pulls in some
52 * strange hardware header file which sees fit to define R_SP. We
53 * undefine it here so as not to break the enum below.
54 */
55 #ifdef R_SP
56 #undef R_SP
57 #endif
58
59 /*
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
60 * We must declare the existence of this structure type up here,
61 * since we have to reference it before we define it...
62 */
63 struct ofmt;
64
65 /*
66 * -------------------------
67 * Error reporting functions
68 * -------------------------
69 */
70
71 /*
72 * An error reporting function should look like this.
73 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
74 typedef void (*efunc) (int severity, const char *fmt, ...);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
75
76 /*
77 * These are the error severity codes which get passed as the first
78 * argument to an efunc.
79 */
80
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
81 #define ERR_DEBUG 0x00000008 /* put out debugging message */
82 #define ERR_WARNING 0x00000000 /* warn only: no further action */
83 #define ERR_NONFATAL 0x00000001 /* terminate assembly after phase */
84 #define ERR_FATAL 0x00000002 /* instantly fatal: exit with error */
85 #define ERR_PANIC 0x00000003 /* internal error: panic instantly
86 * and dump core for reference */
87 #define ERR_MASK 0x0000000F /* mask off the above codes */
88 #define ERR_NOFILE 0x00000010 /* don't give source file name/line */
89 #define ERR_USAGE 0x00000020 /* print a usage message */
90 #define ERR_PASS1 0x00000040 /* only print this error on pass one */
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
91
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
92 /*
93 * These codes define specific types of suppressible warning.
94 */
1cd0e2d5 » H. Peter Anvin
2002-04-30 NASM 0.98.08
95
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
96 #define ERR_WARN_MASK 0x0000FF00 /* the mask for this feature */
97 #define ERR_WARN_SHR 8 /* how far to shift right */
1cd0e2d5 » H. Peter Anvin
2002-04-30 NASM 0.98.08
98
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
99 #define ERR_WARN_MNP 0x00000100 /* macro-num-parameters warning */
100 #define ERR_WARN_MSR 0x00000200 /* macro self-reference */
101 #define ERR_WARN_OL 0x00000300 /* orphan label (no colon, and
102 * alone on line) */
103 #define ERR_WARN_NOV 0x00000400 /* numeric overflow */
8ac36413 » H. Peter Anvin
2002-04-30 NASM 0.98.30
104 #define ERR_WARN_GNUELF 0x00000500 /* using GNU ELF extensions */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
105 #define ERR_WARN_MAX 5 /* the highest numbered one */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
106
107 /*
108 * -----------------------
109 * Other function typedefs
110 * -----------------------
111 */
112
113 /*
114 * A label-lookup function should look like this.
115 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
116 typedef int (*lfunc) (char *label, int32_t *segment, int32_t *offset);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
117
118 /*
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
119 * And a label-definition function like this. The boolean parameter
120 * `is_norm' states whether the label is a `normal' label (which
121 * should affect the local-label system), or something odder like
122 * an EQU or a segment-base symbol, which shouldn't.
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
123 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
124 typedef void (*ldfunc) (char *label, int32_t segment, int32_t offset,
125 char *special, int is_norm, int isextrn,
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
126 struct ofmt * ofmt, efunc error);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
127
128 /*
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
129 * List-file generators should look like this:
130 */
131 typedef struct {
132 /*
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
133 * Called to initialize the listing file generator. Before this
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
134 * is called, the other routines will silently do nothing when
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
135 * called. The `char *' parameter is the file name to write the
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
136 * listing to.
137 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
138 void (*init) (char *, efunc);
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
139
140 /*
141 * Called to clear stuff up and close the listing file.
142 */
143 void (*cleanup) (void);
144
145 /*
146 * Called to output binary data. Parameters are: the offset;
147 * the data; the data type. Data types are similar to the
148 * output-format interface, only OUT_ADDRESS will _always_ be
149 * displayed as if it's relocatable, so ensure that any non-
150 * relocatable address has been converted to OUT_RAWDATA by
151 * then. Note that OUT_RAWDATA+0 is a valid data type, and is a
152 * dummy call used to give the listing generator an offset to
153 * work with when doing things like uplevel(LIST_TIMES) or
154 * uplevel(LIST_INCBIN).
155 */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
156 void (*output) (int32_t, const void *, uint32_t);
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
157
158 /*
159 * Called to send a text line to the listing generator. The
160 * `int' parameter is LIST_READ or LIST_MACRO depending on
161 * whether the line came directly from an input file or is the
162 * result of a multi-line macro expansion.
163 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
164 void (*line) (int, char *);
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
165
166 /*
167 * Called to change one of the various levelled mechanisms in
168 * the listing generator. LIST_INCLUDE and LIST_MACRO can be
169 * used to increase the nesting level of include files and
170 * macro expansions; LIST_TIMES and LIST_INCBIN switch on the
171 * two binary-output-suppression mechanisms for large-scale
172 * pseudo-instructions.
173 *
174 * LIST_MACRO_NOLIST is synonymous with LIST_MACRO except that
175 * it indicates the beginning of the expansion of a `nolist'
176 * macro, so anything under that level won't be expanded unless
177 * it includes another file.
178 */
179 void (*uplevel) (int);
180
181 /*
182 * Reverse the effects of uplevel.
183 */
184 void (*downlevel) (int);
185 } ListGen;
186
187 /*
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
188 * The expression evaluator must be passed a scanner function; a
189 * standard scanner is provided as part of nasmlib.c. The
190 * preprocessor will use a different one. Scanners, and the
191 * token-value structures they return, look like this.
192 *
193 * The return value from the scanner is always a copy of the
194 * `t_type' field in the structure.
195 */
196 struct tokenval {
197 int t_type;
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
198 int64_t t_integer, t_inttwo;
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
199 char *t_charptr;
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
200 };
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
201 typedef int (*scanner) (void *private_data, struct tokenval * tv);
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
202
203 /*
204 * Token types returned by the scanner, in addition to ordinary
205 * ASCII character values, and zero for end-of-string.
206 */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
207 enum { /* token types, other than chars */
208 TOKEN_INVALID = -1, /* a placeholder value */
209 TOKEN_EOS = 0, /* end of string */
210 TOKEN_EQ = '=', TOKEN_GT = '>', TOKEN_LT = '<', /* aliases */
211 TOKEN_ID = 256, TOKEN_NUM, TOKEN_REG, TOKEN_INSN, /* major token types */
212 TOKEN_ERRNUM, /* numeric constant with error in */
213 TOKEN_HERE, TOKEN_BASE, /* $ and $$ */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
214 TOKEN_SPECIAL, /* BYTE, WORD, DWORD, QWORD, FAR, NEAR, etc */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
215 TOKEN_PREFIX, /* A32, O16, LOCK, REPNZ, TIMES, etc */
216 TOKEN_SHL, TOKEN_SHR, /* << and >> */
217 TOKEN_SDIV, TOKEN_SMOD, /* // and %% */
218 TOKEN_GE, TOKEN_LE, TOKEN_NE, /* >=, <= and <> (!= is same as <>) */
219 TOKEN_DBL_AND, TOKEN_DBL_OR, TOKEN_DBL_XOR, /* &&, || and ^^ */
220 TOKEN_SEG, TOKEN_WRT, /* SEG and WRT */
221 TOKEN_FLOAT /* floating-point constant */
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
222 };
223
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
224 typedef struct {
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
225 int32_t segment;
0ee01423 » H. Peter Anvin
2007-04-16 Initial 64-bit support for ndisasm. Still a work in progress.
226 int64_t offset;
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
227 int known;
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
228 } loc_t;
229
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
230 /*
231 * Expression-evaluator datatype. Expressions, within the
232 * evaluator, are stored as an array of these beasts, terminated by
233 * a record with type==0. Mostly, it's a vector type: each type
234 * denotes some kind of a component, and the value denotes the
235 * multiple of that component present in the expression. The
236 * exception is the WRT type, whose `value' field denotes the
237 * segment to which the expression is relative. These segments will
238 * be segment-base types, i.e. either odd segment values or SEG_ABS
239 * types. So it is still valid to assume that anything with a
240 * `value' field of zero is insignificant.
241 */
242 typedef struct {
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
243 int32_t type; /* a register, or EXPR_xxx */
244 int64_t value; /* must be >= 32 bits */
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
245 } expr;
246
247 /*
248 * The evaluator can also return hints about which of two registers
249 * used in an expression should be the base register. See also the
250 * `operand' structure.
251 */
252 struct eval_hints {
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
253 int64_t base;
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
254 int type;
255 };
256
257 /*
258 * The actual expression evaluator function looks like this. When
259 * called, it expects the first token of its expression to already
260 * be in `*tv'; if it is not, set tv->t_type to TOKEN_INVALID and
261 * it will start by calling the scanner.
262 *
263 * If a forward reference happens during evaluation, the evaluator
264 * must set `*fwref' to TRUE if `fwref' is non-NULL.
265 *
266 * `critical' is non-zero if the expression may not contain forward
267 * references. The evaluator will report its own error if this
268 * occurs; if `critical' is 1, the error will be "symbol not
269 * defined before use", whereas if `critical' is 2, the error will
270 * be "symbol undefined".
271 *
af535c16 » H. Peter Anvin
2002-04-30 NASM 0.98.03
272 * If `critical' has bit 8 set (in addition to its main value: 0x101
273 * and 0x102 correspond to 1 and 2) then an extended expression
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
274 * syntax is recognised, in which relational operators such as =, <
275 * and >= are accepted, as well as low-precedence logical operators
276 * &&, ^^ and ||.
277 *
278 * If `hints' is non-NULL, it gets filled in with some hints as to
279 * the base register in complex effective addresses.
280 */
af535c16 » H. Peter Anvin
2002-04-30 NASM 0.98.03
281 #define CRITICAL 0x100
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
282 typedef expr *(*evalfunc) (scanner sc, void *scprivate,
283 struct tokenval * tv, int *fwref, int critical,
284 efunc error, struct eval_hints * hints);
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
285
286 /*
a1abb320 » H. Peter Anvin
2007-05-30 Avoid magic values; we have more than 124 registers now
287 * Special values for expr->type. These come after EXPR_REG_END
288 * as defined in regs.h.
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
289 */
a1abb320 » H. Peter Anvin
2007-05-30 Avoid magic values; we have more than 124 registers now
290
291 #define EXPR_UNKNOWN (EXPR_REG_END+1) /* forward references */
292 #define EXPR_SIMPLE (EXPR_REG_END+2)
293 #define EXPR_WRT (EXPR_REG_END+3)
294 #define EXPR_SEGBASE (EXPR_REG_END+4)
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
295
296 /*
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
297 * Preprocessors ought to look like this:
298 */
299 typedef struct {
300 /*
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
301 * Called at the start of a pass; given a file name, the number
302 * of the pass, an error reporting function, an evaluator
303 * function, and a listing generator to talk to.
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
304 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
305 void (*reset) (char *, int, efunc, evalfunc, ListGen *);
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
306
307 /*
308 * Called to fetch a line of preprocessed source. The line
309 * returned has been malloc'ed, and so should be freed after
310 * use.
311 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
312 char *(*getline) (void);
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
313
314 /*
315 * Called at the end of a pass.
316 */
ce61607e » H. Peter Anvin
2002-04-30 NASM 0.98.14
317 void (*cleanup) (int);
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
318 } Preproc;
319
320 /*
321 * ----------------------------------------------------------------
322 * Some lexical properties of the NASM source language, included
323 * here because they are shared between the parser and preprocessor
324 * ----------------------------------------------------------------
325 */
326
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
327 /*
328 * isidstart matches any character that may start an identifier, and isidchar
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
329 * matches any character that may appear at places other than the start of an
330 * identifier. E.g. a period may only appear at the start of an identifier
331 * (for local labels), whereas a number may appear anywhere *but* at the
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
332 * start.
333 */
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
334
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
335 #define isidstart(c) ( isalpha(c) || (c)=='_' || (c)=='.' || (c)=='?' \
336 || (c)=='@' )
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
337 #define isidchar(c) ( isidstart(c) || isdigit(c) || (c)=='$' || (c)=='#' \
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
338 || (c)=='~' )
d7ed89ea » H. Peter Anvin
2002-04-30 NASM 0.94
339
340 /* Ditto for numeric constants. */
341
342 #define isnumstart(c) ( isdigit(c) || (c)=='$' )
343 #define isnumchar(c) ( isalnum(c) )
344
345 /* This returns the numeric value of a given 'digit'. */
346
347 #define numvalue(c) ((c)>='a' ? (c)-'a'+10 : (c)>='A' ? (c)-'A'+10 : (c)-'0')
348
349 /*
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
350 * Data-type flags that get passed to listing-file routines.
351 */
352 enum {
353 LIST_READ, LIST_MACRO, LIST_MACRO_NOLIST, LIST_INCLUDE,
354 LIST_INCBIN, LIST_TIMES
355 };
356
357 /*
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
358 * -----------------------------------------------------------
359 * Format of the `insn' structure returned from `parser.c' and
360 * passed into `assemble.c'
361 * -----------------------------------------------------------
362 */
363
364 /*
365 * Here we define the operand types. These are implemented as bit
366 * masks, since some are subsets of others; e.g. AX in a MOV
367 * instruction is a special operand type, whereas AX in other
368 * contexts is just another 16-bit register. (Also, consider CL in
369 * shift instructions, DX in OUT, etc.)
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
370 *
371 * The basic concept here is that
372 * (class & ~operand) == 0
373 *
3df97a72 » H. Peter Anvin
2007-05-30 Get rid of magic open-coded "register numbers"
374 * if and only if "operand" belongs to class type "class".
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
375 *
376 * The bits are assigned as follows:
377 *
378 * Bits 0-7: sizes
379 * 0: 8 bits (BYTE)
380 * 1: 16 bits (WORD)
381 * 2: 32 bits (DWORD)
382 * 3: 64 bits (QWORD)
383 * 4: 80 bits (TWORD)
384 * 5: FAR
385 * 6: NEAR
386 * 7: SHORT
387 *
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
388 * Bits 8-11 modifiers
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
389 * 8: TO
390 * 9: COLON
391 * 10: STRICT
392 * 11: (reserved)
393 *
394 * Bits 12-15: type of operand
395 * 12: REGISTER
396 * 13: IMMEDIATE
397 * 14: MEMORY (always has REGMEM attribute as well)
1ffbd70a » H. Peter Anvin
2007-05-30 More instruction flag surgery
398 * 15: REGMEM (valid EA operand)
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
399 *
400 * Bits 16-19: subclasses
401 * With REG_CDT:
402 * 16: REG_CREG (CRx)
403 * 17: REG_DREG (DRx)
404 * 18: REG_TREG (TRx)
405
1ffbd70a » H. Peter Anvin
2007-05-30 More instruction flag surgery
406 * With REG_GPR:
edb14282 » H. Peter Anvin
2007-05-30 More cleanup of operand flags/register classes
407 * 16: REG_ACCUM (AL, AX, EAX, RAX)
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
408 * 17: REG_COUNT (CL, CX, ECX, RCX)
409 * 18: REG_DATA (DL, DX, EDX, RDX)
edb14282 » H. Peter Anvin
2007-05-30 More cleanup of operand flags/register classes
410 * 19: REG_HIGH (AH, CH, DH, BH)
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
411 *
412 * With REG_SREG:
413 * 16: REG_CS
414 * 17: REG_DESS (DS, ES, SS)
415 * 18: REG_FSGS
416 * 19: REG_SEG67
417 *
418 * With FPUREG:
419 * 16: FPU0
420 *
421 * With MEMORY:
422 * 16: MEM_OFFS (this is a simple offset)
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
423 * 17: IP_REL (IP-relative offset)
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
424 *
425 * With IMMEDIATE:
426 * 16: UNITY (1)
427 * 17: BYTENESS (-128..127)
428 *
429 * Bits 20-26: register classes
430 * 20: REG_CDT (CRx, DRx, TRx)
1ffbd70a » H. Peter Anvin
2007-05-30 More instruction flag surgery
431 * 21: REG_GPR (integer register)
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
432 * 22: REG_SREG
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
433 * 23: IP_REG (RIP or EIP) [unused]
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
434 * 24: FPUREG
435 * 25: MMXREG
436 * 26: XMMREG
437 *
438 * Bits 27-31 are currently unallocated.
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
439 */
440
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
441 /* Size, and other attributes, of the operand */
442 #define BITS8 0x00000001L
443 #define BITS16 0x00000002L
444 #define BITS32 0x00000004L
445 #define BITS64 0x00000008L /* x64 and FPU only */
446 #define BITS80 0x00000010L /* FPU only */
447 #define FAR 0x00000020L /* grotty: this means 16:16 or */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
448 /* 16:32, like in CALL/JMP */
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
449 #define NEAR 0x00000040L
450 #define SHORT 0x00000080L /* and this means what it says :) */
451
452 #define SIZE_MASK 0x000000FFL /* all the size attributes */
453
454 /* Modifiers */
455 #define MODIFIER_MASK 0x00000f00L
456 #define TO 0x00000100L /* reverse effect in FADD, FSUB &c */
457 #define COLON 0x00000200L /* operand is followed by a colon */
458 #define STRICT 0x00000400L /* do not optimize this operand */
459
460 /* Type of operand: memory reference, register, etc. */
461 #define OPTYPE_MASK 0x0000f000L
462 #define REGISTER 0x00001000L /* register number in 'basereg' */
463 #define IMMEDIATE 0x00002000L
1ffbd70a » H. Peter Anvin
2007-05-30 More instruction flag surgery
464 #define MEMORY 0x0000c000L
465 #define REGMEM 0x00008000L /* for r/m, ie EA, operands */
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
466
edb14282 » H. Peter Anvin
2007-05-30 More cleanup of operand flags/register classes
467 /* Register classes */
dbf130e6 » H. Peter Anvin
2007-05-30 Rename REGNORM to REG_EA
468 #define REG_EA 0x00009000L /* 'normal' reg, qualifies as EA */
1ffbd70a » H. Peter Anvin
2007-05-30 More instruction flag surgery
469 #define REG_GPR 0x00209000L /* integer register */
470 #define REG8 0x00209001L /* 8-bit GPR */
471 #define REG16 0x00209002L /* 16-bit GPR */
472 #define REG32 0x00209004L /* 32-bit GPR */
473 #define REG64 0x00209008L /* 64-bit GPR */
edb14282 » H. Peter Anvin
2007-05-30 More cleanup of operand flags/register classes
474 #define IP_REG 0x00801000L /* RIP or EIP register */
475 #define RIPREG 0x00801008L /* RIP */
476 #define EIPREG 0x00801004L /* EIP */
477 #define FPUREG 0x01001000L /* floating point stack registers */
478 #define FPU0 0x01011000L /* FPU stack register zero */
e5b47ab1 » Keith Kanios
2007-08-17 Changed MMXREG and XMMREG flags to help resolve invalid REX prefix ge…
479 #define MMXREG 0x04009001L /* MMX registers */
480 #define XMMREG 0x04009002L /* XMM Katmai reg */
edb14282 » H. Peter Anvin
2007-05-30 More cleanup of operand flags/register classes
481 #define REG_CDT 0x00101004L /* CRn, DRn and TRn */
482 #define REG_CREG 0x00111004L /* CRn */
483 #define REG_DREG 0x00121004L /* DRn */
484 #define REG_TREG 0x00141004L /* TRn */
485 #define REG_SREG 0x00401002L /* any segment register */
486 #define REG_CS 0x00411002L /* CS */
487 #define REG_DESS 0x00421002L /* DS, ES, SS */
488 #define REG_FSGS 0x00441002L /* FS, GS */
489 #define REG_SEG67 0x00481002L /* Unimplemented segment registers */
490
3df97a72 » H. Peter Anvin
2007-05-30 Get rid of magic open-coded "register numbers"
491 #define REG_RIP 0x00801008L /* RIP relative addressing */
492 #define REG_EIP 0x00801004L /* EIP relative addressing */
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
493
494 /* Special GPRs */
495 #define REG_SMASK 0x000f0000L /* a mask for the following */
1ffbd70a » H. Peter Anvin
2007-05-30 More instruction flag surgery
496 #define REG_ACCUM 0x00219000L /* accumulator: AL, AX, EAX, RAX */
497 #define REG_AL 0x00219001L
498 #define REG_AX 0x00219002L
499 #define REG_EAX 0x00219004L
500 #define REG_RAX 0x00219008L
501 #define REG_COUNT 0x00229000L /* counter: CL, CX, ECX, RCX */
502 #define REG_CL 0x00229001L
503 #define REG_CX 0x00229002L
504 #define REG_ECX 0x00229004L
505 #define REG_RCX 0x00229008L
506 #define REG_DL 0x00249001L /* data: DL, DX, EDX, RDX */
507 #define REG_DX 0x00249002L
508 #define REG_EDX 0x00249004L
509 #define REG_RDX 0x00249008L
510 #define REG_HIGH 0x00289001L /* high regs: AH, CH, DH, BH */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
511
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
512 /* special types of EAs */
513 #define MEM_OFFS 0x00214000L /* simple [address] offset - absolute! */
514 #define IP_REL 0x00224000L /* IP-relative offset */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
515
516 /* special type of immediate operand */
5a640e11 » H. Peter Anvin
2007-05-29 Clean up the existing operand flag definitions, and document
517 #define UNITY 0x00012000L /* for shift/rotate instructions */
518 #define SBYTE 0x00022000L /* for op r16/32,immediate instrs. */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
519
232badbb » H. Peter Anvin
2002-06-06 This is the "megapatch":
520 /* Register names automatically generated from regs.dat */
521 #include "regs.h"
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
522
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
523 enum { /* condition code names */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
524 C_A, C_AE, C_B, C_BE, C_C, C_E, C_G, C_GE, C_L, C_LE, C_NA, C_NAE,
525 C_NB, C_NBE, C_NC, C_NE, C_NG, C_NGE, C_NL, C_NLE, C_NO, C_NP,
526 C_NS, C_NZ, C_O, C_P, C_PE, C_PO, C_S, C_Z
527 };
528
529 /*
3df97a72 » H. Peter Anvin
2007-05-30 Get rid of magic open-coded "register numbers"
530 * REX flags
531 */
532 #define REX_H 0x80 /* High register present, REX forbidden */
533 #define REX_P 0x40 /* REX prefix present/required */
534 #define REX_L 0x20 /* Use LOCK prefix instead of REX.R */
535 #define REX_W 0x08 /* 64-bit operand size */
536 #define REX_R 0x04 /* ModRM reg extension */
537 #define REX_X 0x02 /* SIB index extension */
538 #define REX_B 0x01 /* ModRM r/m extension */
539 #define REX_REAL 0x4f /* Actual REX prefix bits */
540
541 /*
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
542 * Note that because segment registers may be used as instruction
543 * prefixes, we must ensure the enumerations for prefixes and
544 * register names do not overlap.
545 */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
546 enum { /* instruction prefixes */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
547 PREFIX_ENUM_START = REG_ENUM_LIMIT,
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
548 P_A16 = PREFIX_ENUM_START, P_A32, P_LOCK, P_O16, P_O32,
549 P_REP, P_REPE, P_REPNE, P_REPNZ, P_REPZ, P_TIMES
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
550 };
551
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
552 enum { /* extended operand types */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
553 EOT_NOTHING, EOT_DB_STRING, EOT_DB_NUMBER
554 };
555
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
556 enum { /* special EA flags */
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
557 EAF_BYTEOFFS = 1, /* force offset part to byte size */
558 EAF_WORDOFFS = 2, /* force offset part to [d]word size */
559 EAF_TIMESTWO = 4, /* really do EAX*2 not EAX+EAX */
560 EAF_REL = 8, /* IP-relative addressing */
561 EAF_ABS = 16, /* non-IP-relative addressing */
150e20db » H. Peter Anvin
2007-08-29 Suppress IP-relative only for fs: and gs: overrides
562 EAF_FSGS = 32 /* fs/gs segment override present */
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
563 };
564
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
565 enum { /* values for `hinttype' */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
566 EAH_NOHINT = 0, /* no hint at all - our discretion */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
567 EAH_MAKEBASE = 1, /* try to make given reg the base */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
568 EAH_NOTBASE = 2 /* try _not_ to make reg the base */
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
569 };
570
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
571 typedef struct { /* operand to an instruction */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
572 int32_t type; /* type of operand */
573 int addr_size; /* 0 means default; 16; 32; 64 */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
574 int basereg, indexreg, scale; /* registers and scale involved */
575 int hintbase, hinttype; /* hint as to real base register */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
576 int32_t segment; /* immediate segment, if needed */
577 int64_t offset; /* any immediate number */
578 int32_t wrt; /* segment base it's relative to */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
579 int eaflags; /* special EA flags */
580 int opflags; /* see OPFLAG_* defines below */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
581 } operand;
582
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
583 #define OPFLAG_FORWARD 1 /* operand is a forward reference */
584 #define OPFLAG_EXTERN 2 /* operand is an external reference */
585
586 typedef struct extop { /* extended operand */
587 struct extop *next; /* linked list */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
588 int32_t type; /* defined above */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
589 char *stringval; /* if it's a string, then here it is */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
590 int stringlen; /* ... and here's how long it is */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
591 int32_t segment; /* if it's a number/address, then... */
592 int64_t offset; /* ... it's given here ... */
593 int32_t wrt; /* ... and here */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
594 } extop;
595
596 #define MAXPREFIX 4
597
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
598 typedef struct { /* an instruction itself */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
599 char *label; /* the label defined, or NULL */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
600 int prefixes[MAXPREFIX]; /* instruction prefixes, if any */
601 int nprefix; /* number of entries in above */
602 int opcode; /* the opcode - not just the string */
603 int condition; /* the condition code, if Jcc/SETcc */
604 int operands; /* how many operands? 0-3
605 * (more if db et al) */
606 operand oprs[3]; /* the operands, defined as above */
607 extop *eops; /* extended operands */
608 int eops_float; /* true if DD and floating */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
609 int32_t times; /* repeat count (TIMES prefix) */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
610 int forw_ref; /* is there a forward reference? */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
611 uint8_t rex; /* Special REX Prefix */
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
612 } insn;
613
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
614 enum geninfo { GI_SWITCH };
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
615 /*
616 * ------------------------------------------------------------
617 * The data structure defining an output format driver, and the
618 * interfaces to the functions therein.
619 * ------------------------------------------------------------
620 */
621
622 struct ofmt {
623 /*
624 * This is a short (one-liner) description of the type of
625 * output generated by the driver.
626 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
627 const char *fullname;
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
628
629 /*
630 * This is a single keyword used to select the driver.
631 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
632 const char *shortname;
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
633
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
634
635 /*
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
636 * this is reserved for out module specific help.
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
637 * It is set to NULL in all the out modules and is not implemented
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
638 * in the main program
639 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
640 const char *helpstring;
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
641
642 /*
643 * this is a pointer to the first element of the debug information
644 */
645 struct dfmt **debug_formats;
646
647 /*
648 * and a pointer to the element that is being used
649 * note: this is set to the default at compile time and changed if the
650 * -F option is selected. If developing a set of new debug formats for
651 * an output format, be sure to set this to whatever default you want
652 *
653 */
654 struct dfmt *current_dfmt;
655
656 /*
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
657 * This, if non-NULL, is a NULL-terminated list of `char *'s
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
658 * pointing to extra standard macros supplied by the object
659 * format (e.g. a sensible initial default value of __SECT__,
660 * and user-level equivalents for any format-specific
661 * directives).
662 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
663 const char **stdmac;
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
664
665 /*
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
666 * This procedure is called at the start of an output session.
667 * It tells the output format what file it will be writing to,
668 * what routine to report errors through, and how to interface
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
669 * to the label manager and expression evaluator if necessary.
670 * It also gives it a chance to do other initialisation.
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
671 */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
672 void (*init) (FILE * fp, efunc error, ldfunc ldef, evalfunc eval);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
673
674 /*
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
675 * This procedure is called to pass generic information to the
676 * object file. The first parameter gives the information type
677 * (currently only command line switches)
678 * and the second parameter gives the value. This function returns
679 * 1 if recognized, 0 if unrecognized
680 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
681 int (*setinfo) (enum geninfo type, char **string);
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
682
683 /*
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
684 * This procedure is called by assemble() to write actual
685 * generated code or data to the object file. Typically it
686 * doesn't have to actually _write_ it, just store it for
687 * later.
688 *
689 * The `type' argument specifies the type of output data, and
690 * usually the size as well: its contents are described below.
691 */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
692 void (*output) (int32_t segto, const void *data, uint32_t type,
693 int32_t segment, int32_t wrt);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
694
695 /*
696 * This procedure is called once for every symbol defined in
697 * the module being assembled. It gives the name and value of
698 * the symbol, in NASM's terms, and indicates whether it has
699 * been declared to be global. Note that the parameter "name",
700 * when passed, will point to a piece of static storage
701 * allocated inside the label manager - it's safe to keep using
702 * that pointer, because the label manager doesn't clean up
703 * until after the output driver has.
704 *
705 * Values of `is_global' are: 0 means the symbol is local; 1
706 * means the symbol is global; 2 means the symbol is common (in
707 * which case `offset' holds the _size_ of the variable).
708 * Anything else is available for the output driver to use
709 * internally.
6768eb71 » H. Peter Anvin
2002-04-30 NASM 0.95
710 *
711 * This routine explicitly _is_ allowed to call the label
712 * manager to define further symbols, if it wants to, even
713 * though it's been called _from_ the label manager. That much
714 * re-entrancy is guaranteed in the label manager. However, the
715 * label manager will in turn call this routine, so it should
716 * be prepared to be re-entrant itself.
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
717 *
718 * The `special' parameter contains special information passed
719 * through from the command that defined the label: it may have
720 * been an EXTERN, a COMMON or a GLOBAL. The distinction should
721 * be obvious to the output format from the other parameters.
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
722 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
723 void (*symdef) (char *name, int32_t segment, int32_t offset, int is_global,
724 char *special);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
725
726 /*
727 * This procedure is called when the source code requests a
728 * segment change. It should return the corresponding segment
729 * _number_ for the name, or NO_SEG if the name is not a valid
730 * segment name.
731 *
732 * It may also be called with NULL, in which case it is to
733 * return the _default_ section number for starting assembly in.
734 *
735 * It is allowed to modify the string it is given a pointer to.
736 *
737 * It is also allowed to specify a default instruction size for
738 * the segment, by setting `*bits' to 16 or 32. Or, if it
739 * doesn't wish to define a default, it can leave `bits' alone.
740 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
741 int32_t (*section) (char *name, int pass, int *bits);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
742
743 /*
744 * This procedure is called to modify the segment base values
745 * returned from the SEG operator. It is given a segment base
746 * value (i.e. a segment value with the low bit set), and is
747 * required to produce in return a segment value which may be
748 * different. It can map segment bases to absolute numbers by
749 * means of returning SEG_ABS types.
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
750 *
751 * It should return NO_SEG if the segment base cannot be
752 * determined; the evaluator (which calls this routine) is
753 * responsible for throwing an error condition if that occurs
754 * in pass two or in a critical expression.
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
755 */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
756 int32_t (*segbase) (int32_t segment);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
757
758 /*
759 * This procedure is called to allow the output driver to
760 * process its own specific directives. When called, it has the
761 * directive word in `directive' and the parameter string in
762 * `value'. It is called in both assembly passes, and `pass'
763 * will be either 1 or 2.
764 *
765 * This procedure should return zero if it does not _recognise_
766 * the directive, so that the main program can report an error.
767 * If it recognises the directive but then has its own errors,
768 * it should report them itself and then return non-zero. It
769 * should also return non-zero if it correctly processes the
770 * directive.
771 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
772 int (*directive) (char *directive, char *value, int pass);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
773
774 /*
775 * This procedure is called before anything else - even before
776 * the "init" routine - and is passed the name of the input
777 * file from which this output file is being generated. It
778 * should return its preferred name for the output file in
76690a12 » H. Peter Anvin
2002-04-30 NASM 0.96
779 * `outname', if outname[0] is not '\0', and do nothing to
780 * `outname' otherwise. Since it is called before the driver is
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
781 * properly initialized, it has to be passed its error handler
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
782 * separately.
783 *
784 * This procedure may also take its own copy of the input file
785 * name for use in writing the output file: it is _guaranteed_
786 * that it will be called before the "init" routine.
787 *
788 * The parameter `outname' points to an area of storage
789 * guaranteed to be at least FILENAME_MAX in size.
790 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
791 void (*filename) (char *inname, char *outname, efunc error);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
792
793 /*
794 * This procedure is called after assembly finishes, to allow
795 * the output driver to clean itself up and free its memory.
796 * Typically, it will also be the point at which the object
797 * file actually gets _written_.
798 *
799 * One thing the cleanup routine should always do is to close
800 * the output file pointer.
801 */
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
802 void (*cleanup) (int debuginfo);
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
803 };
804
805 /*
806 * values for the `type' parameter to an output function. Each one
807 * must have the actual number of _bytes_ added to it.
808 *
809 * Exceptions are OUT_RELxADR, which denote an x-byte relocation
810 * which will be a relative jump. For this we need to know the
811 * distance in bytes from the start of the relocated record until
812 * the end of the containing instruction. _This_ is what is stored
813 * in the size part of the parameter, in this case.
814 *
815 * Also OUT_RESERVE denotes reservation of N bytes of BSS space,
816 * and the contents of the "data" parameter is irrelevant.
817 *
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
818 * The "data" parameter for the output function points to a "int32_t",
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
819 * containing the address in question, unless the type is
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
820 * OUT_RAWDATA, in which case it points to an "uint8_t"
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
821 * array.
822 */
823 #define OUT_RAWDATA 0x00000000UL
824 #define OUT_ADDRESS 0x10000000UL
825 #define OUT_REL2ADR 0x20000000UL
826 #define OUT_REL4ADR 0x30000000UL
827 #define OUT_RESERVE 0x40000000UL
828 #define OUT_TYPMASK 0xF0000000UL
829 #define OUT_SIZMASK 0x0FFFFFFFUL
830
831 /*
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
832 * ------------------------------------------------------------
833 * The data structure defining a debug format driver, and the
834 * interfaces to the functions therein.
835 * ------------------------------------------------------------
836 */
837
838 struct dfmt {
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
839
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
840 /*
841 * This is a short (one-liner) description of the type of
842 * output generated by the driver.
843 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
844 const char *fullname;
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
845
846 /*
847 * This is a single keyword used to select the driver.
848 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
849 const char *shortname;
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
850
851 /*
852 * init - called initially to set up local pointer to object format,
853 * void pointer to implementation defined data, file pointer (which
854 * probably won't be used, but who knows?), and error function.
855 */
e2c80181 » H. Peter Anvin
2005-01-15 Apply Nindent to all .c and .h files
856 void (*init) (struct ofmt * of, void *id, FILE * fp, efunc error);
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
857
858 /*
859 * linenum - called any time there is output with a change of
860 * line number or file.
861 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
862 void (*linenum) (const char *filename, int32_t linenumber, int32_t segto);
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
863
864 /*
865 * debug_deflabel - called whenever a label is defined. Parameters
866 * are the same as to 'symdef()' in the output format. This function
867 * would be called before the output format version.
868 */
869
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
870 void (*debug_deflabel) (char *name, int32_t segment, int32_t offset,
871 int is_global, char *special);
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
872 /*
873 * debug_directive - called whenever a DEBUG directive other than 'LINE'
874 * is encountered. 'directive' contains the first parameter to the
875 * DEBUG directive, and params contains the rest. For example,
876 * 'DEBUG VAR _somevar:int' would translate to a call to this
877 * function with 'directive' equal to "VAR" and 'params' equal to
878 * "_somevar:int".
879 */
a6dfa78b » Keith Kanios
2007-04-13 Fixed distinction between char and int8_t data types.
880 void (*debug_directive) (const char *directive, const char *params);
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
881
882 /*
883 * typevalue - called whenever the assembler wishes to register a type
884 * for the last defined label. This routine MUST detect if a type was
885 * already registered and not re-register it.
886 */
b7a89544 » Keith Kanios
2007-04-12 General push for x86-64 support, dubbed 0.99.00.
887 void (*debug_typevalue) (int32_t type);
eba20a73 » H. Peter Anvin
2002-04-30 NASM 0.98p3
888
889 /*
890 * debug_output - called whenever output is required
891 * 'type' is the type of info required, and this is format-specific
892 */
893 void (*debug_output) (int type, void *param);
894
895 /*
896 * cleanup - called after processing of file is complete
897 */
898 void (*cleanup) (void);
899
900 };
901 /*
902 * The type definition macros
903 * for debugging
904 *
905 * low 3 bits: reserved
906 * next 5 bits: type
907 * next 24 bits: number of elements for arrays (0 for labels)
908 */
909
910 #define TY_UNKNOWN 0x00
911 #define TY_LABEL 0x08
912 #define TY_BYTE 0x10
913 #define TY_WORD 0x18
914 #define TY_DWORD 0x20
915 #define TY_FLOAT 0x28
916 #define TY_QWORD 0x30
917 #define TY_TBYTE 0x38
918 #define TY_COMMON 0xE0
919 #define TY_SEG 0xE8
920 #define TY_EXTERN 0xF0
921 #define TY_EQU 0xF8
922
923 #define TYM_TYPE(x) ((x) & 0xF8)
924 #define TYM_ELEMENTS(x) (((x) & 0xFFFFFF00) >> 8)
925
926 #define TYS_ELEMENTS(x) ((x) << 8)
927 /*
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
928 * -----
929 * Other
930 * -----
931 */
932
933 /*
934 * This is a useful #define which I keep meaning to use more often:
935 * the number of elements of a statically defined array.
936 */
937
938 #define elements(x) ( sizeof(x) / sizeof(*(x)) )
939
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
940 /*
941 * -----
942 * Global modes
943 * -----
944 */
1cd0e2d5 » H. Peter Anvin
2002-04-30 NASM 0.98.08
945
946 /*
947 * This declaration passes the "pass" number to all other modules
948 * "pass0" assumes the values: 0, 0, ..., 0, 1, 2
949 * where 0 = optimizing pass
950 * 1 = pass 1
951 * 2 = pass 2
952 */
953
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
954 extern int pass0;
955
956 extern int tasm_compatible_mode;
4cf1748e » H. Peter Anvin
2002-04-30 NASM 0.98.11
957 extern int optimizing;
99c4ecd1 » H. Peter Anvin
2007-08-28 Implement REL/ABS modifiers
958 extern int globalbits; /* 16, 32 or 64-bit mode */
959 extern int globalrel; /* default to relative addressing? */
960 extern int maxbits; /* max bits supported by output */
1cd0e2d5 » H. Peter Anvin
2002-04-30 NASM 0.98.08
961
ea6e34db » H. Peter Anvin
2002-04-30 NASM 0.91
962 #endif
Something went wrong with that request. Please try again.