nasm.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2009 The NASM Authors - All Rights Reserved
   4  *   See the file AUTHORS included with the NASM distribution for
   5  *   the specific copyright holders.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following
   9  *   conditions are met:
  10  *
  11  *   * Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  *   * Redistributions in binary form must reproduce the above
  14  *     copyright notice, this list of conditions and the following
  15  *     disclaimer in the documentation and/or other materials provided
  16  *     with the distribution.
  17  *
  18  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  19  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * ----------------------------------------------------------------------- */
  33
  34 /*
  35  * nasm.h   main header file for the Netwide Assembler: inter-module interface
  36  */
  37
  38 #ifndef NASM_NASM_H
  39 #define NASM_NASM_H
  40
  41 #include "compiler.h"
  42
  43 #include <stdio.h>
  44 #include <inttypes.h>
  45 #include "nasmlib.h"
  46 #include "preproc.h"
  47 #include "insnsi.h"             /* For enum opcode */
  48 #include "directives.h"         /* For enum directive */
  49
  50 #define NO_SEG -1L              /* null segment value */
  51 #define SEG_ABS 0x40000000L     /* mask for far-absolute segments */
  52
  53 #ifndef FILENAME_MAX
  54 #define FILENAME_MAX 256
  55 #endif
  56
  57 #ifndef PREFIX_MAX
  58 #define PREFIX_MAX 10
  59 #endif
  60
  61 #ifndef POSTFIX_MAX
  62 #define POSTFIX_MAX 10
  63 #endif
  64
  65 #define IDLEN_MAX 4096
  66
  67 /*
  68  * Name pollution problems: <time.h> on Digital UNIX pulls in some
  69  * strange hardware header file which sees fit to define R_SP. We
  70  * undefine it here so as not to break the enum below.
  71  */
  72 #ifdef R_SP
  73 #undef R_SP
  74 #endif
  75
  76 /*
  77  * We must declare the existence of this structure type up here,
  78  * since we have to reference it before we define it...
  79  */
  80 struct ofmt;
  81
  82 /*
  83  * values for the `type' parameter to an output function.
  84  *
  85  * Exceptions are OUT_RELxADR, which denote an x-byte relocation
  86  * which will be a relative jump. For this we need to know the
  87  * distance in bytes from the start of the relocated record until
  88  * the end of the containing instruction. _This_ is what is stored
  89  * in the size part of the parameter, in this case.
  90  *
  91  * Also OUT_RESERVE denotes reservation of N bytes of BSS space,
  92  * and the contents of the "data" parameter is irrelevant.
  93  *
  94  * The "data" parameter for the output function points to a "int32_t",
  95  * containing the address in question, unless the type is
  96  * OUT_RAWDATA, in which case it points to an "uint8_t"
  97  * array.
  98  */
  99 enum out_type {
 100     OUT_RAWDATA,                /* Plain bytes */
 101     OUT_ADDRESS,                /* An address (symbol value) */
 102     OUT_RESERVE,                /* Reserved bytes (RESB et al) */
 103     OUT_REL2ADR,                /* 2-byte relative address */
 104     OUT_REL4ADR,                /* 4-byte relative address */
 105     OUT_REL8ADR,                /* 8-byte relative address */
 106 };
 107
 108 /*
 109  * -----------------------
 110  * Other function typedefs
 111  * -----------------------
 112  */
 113
 114 /*
 115  * A label-lookup function should look like this.
 116  */
 117 typedef bool (*lfunc) (char *label, int32_t *segment, int64_t *offset);
 118
 119 /*
 120  * And a label-definition function like this. The boolean parameter
 121  * `is_norm' states whether the label is a `normal' label (which
 122  * should affect the local-label system), or something odder like
 123  * an EQU or a segment-base symbol, which shouldn't.
 124  */
 125 typedef void (*ldfunc)(char *label, int32_t segment, int64_t offset,
 126                        char *special, bool is_norm, bool isextrn);
 127 void define_label(char *label, int32_t segment, int64_t offset,
 128                   char *special, bool is_norm, bool isextrn);
 129
 130 /*
 131  * List-file generators should look like this:
 132  */
 133 typedef struct {
 134     /*
 135      * Called to initialize the listing file generator. Before this
 136      * is called, the other routines will silently do nothing when
 137      * called. The `char *' parameter is the file name to write the
 138      * listing to.
 139      */
 140     void (*init) (char *, efunc);
 141
 142     /*
 143      * Called to clear stuff up and close the listing file.
 144      */
 145     void (*cleanup) (void);
 146
 147     /*
 148      * Called to output binary data. Parameters are: the offset;
 149      * the data; the data type. Data types are similar to the
 150      * output-format interface, only OUT_ADDRESS will _always_ be
 151      * displayed as if it's relocatable, so ensure that any non-
 152      * relocatable address has been converted to OUT_RAWDATA by
 153      * then. Note that OUT_RAWDATA,0 is a valid data type, and is a
 154      * dummy call used to give the listing generator an offset to
 155      * work with when doing things like uplevel(LIST_TIMES) or
 156      * uplevel(LIST_INCBIN).
 157      */
 158     void (*output) (int32_t, const void *, enum out_type, uint64_t);
 159
 160     /*
 161      * Called to send a text line to the listing generator. The
 162      * `int' parameter is LIST_READ or LIST_MACRO depending on
 163      * whether the line came directly from an input file or is the
 164      * result of a multi-line macro expansion.
 165      */
 166     void (*line) (int, char *);
 167
 168     /*
 169      * Called to change one of the various levelled mechanisms in
 170      * the listing generator. LIST_INCLUDE and LIST_MACRO can be
 171      * used to increase the nesting level of include files and
 172      * macro expansions; LIST_TIMES and LIST_INCBIN switch on the
 173      * two binary-output-suppression mechanisms for large-scale
 174      * pseudo-instructions.
 175      *
 176      * LIST_MACRO_NOLIST is synonymous with LIST_MACRO except that
 177      * it indicates the beginning of the expansion of a `nolist'
 178      * macro, so anything under that level won't be expanded unless
 179      * it includes another file.
 180      */
 181     void (*uplevel) (int);
 182
 183     /*
 184      * Reverse the effects of uplevel.
 185      */
 186     void (*downlevel) (int);
 187
 188     /*
 189      * Called on a warning or error, with the error message.
 190      */
 191     void (*error)(int severity, const char *pfx, const char *msg);
 192 } ListGen;
 193
 194 /*
 195  * Token types returned by the scanner, in addition to ordinary
 196  * ASCII character values, and zero for end-of-string.
 197  */
 198 enum token_type {               /* token types, other than chars */
 199     TOKEN_INVALID = -1,         /* a placeholder value */
 200     TOKEN_EOS = 0,              /* end of string */
 201     TOKEN_EQ = '=', TOKEN_GT = '>', TOKEN_LT = '<',     /* aliases */
 202     TOKEN_ID = 256,             /* identifier */
 203     TOKEN_NUM,                  /* numeric constant */
 204     TOKEN_ERRNUM,               /* malformed numeric constant */
 205     TOKEN_STR,                  /* string constant */
 206     TOKEN_ERRSTR,               /* unterminated string constant */
 207     TOKEN_FLOAT,                /* floating-point constant */
 208     TOKEN_REG,                  /* register name */
 209     TOKEN_INSN,                 /* instruction name */
 210     TOKEN_HERE, TOKEN_BASE,     /* $ and $$ */
 211     TOKEN_SPECIAL,              /* BYTE, WORD, DWORD, QWORD, FAR, NEAR, etc */
 212     TOKEN_PREFIX,               /* A32, O16, LOCK, REPNZ, TIMES, etc */
 213     TOKEN_SHL, TOKEN_SHR,       /* << and >> */
 214     TOKEN_SDIV, TOKEN_SMOD,     /* // and %% */
 215     TOKEN_GE, TOKEN_LE, TOKEN_NE,       /* >=, <= and <> (!= is same as <>) */
 216     TOKEN_DBL_AND, TOKEN_DBL_OR, TOKEN_DBL_XOR, /* &&, || and ^^ */
 217     TOKEN_SEG, TOKEN_WRT,       /* SEG and WRT */
 218     TOKEN_FLOATIZE,             /* __floatX__ */
 219     TOKEN_STRFUNC,              /* __utf16__, __utf32__ */
 220 };
 221
 222 enum floatize {
 223     FLOAT_8,
 224     FLOAT_16,
 225     FLOAT_32,
 226     FLOAT_64,
 227     FLOAT_80M,
 228     FLOAT_80E,
 229     FLOAT_128L,
 230     FLOAT_128H,
 231 };
 232
 233 /* Must match the list in string_transform(), in strfunc.c */
 234 enum strfunc {
 235     STRFUNC_UTF16,
 236     STRFUNC_UTF32,
 237 };
 238
 239 size_t string_transform(char *, size_t, char **, enum strfunc);
 240
 241 /*
 242  * The expression evaluator must be passed a scanner function; a
 243  * standard scanner is provided as part of nasmlib.c. The
 244  * preprocessor will use a different one. Scanners, and the
 245  * token-value structures they return, look like this.
 246  *
 247  * The return value from the scanner is always a copy of the
 248  * `t_type' field in the structure.
 249  */
 250 struct tokenval {
 251     enum token_type t_type;
 252     char *t_charptr;
 253     int64_t t_integer, t_inttwo;
 254 };
 255 typedef int (*scanner) (void *private_data, struct tokenval * tv);
 256
 257 struct location {
 258     int64_t offset;
 259     int32_t segment;
 260     int known;
 261 };
 262
 263 /*
 264  * Expression-evaluator datatype. Expressions, within the
 265  * evaluator, are stored as an array of these beasts, terminated by
 266  * a record with type==0. Mostly, it's a vector type: each type
 267  * denotes some kind of a component, and the value denotes the
 268  * multiple of that component present in the expression. The
 269  * exception is the WRT type, whose `value' field denotes the
 270  * segment to which the expression is relative. These segments will
 271  * be segment-base types, i.e. either odd segment values or SEG_ABS
 272  * types. So it is still valid to assume that anything with a
 273  * `value' field of zero is insignificant.
 274  */
 275 typedef struct {
 276     int32_t type;                  /* a register, or EXPR_xxx */
 277     int64_t value;                 /* must be >= 32 bits */
 278 } expr;
 279
 280 /*
 281  * Library routines to manipulate expression data types.
 282  */
 283 int is_reloc(expr *);
 284 int is_simple(expr *);
 285 int is_really_simple(expr *);
 286 int is_unknown(expr *);
 287 int is_just_unknown(expr *);
 288 int64_t reloc_value(expr *);
 289 int32_t reloc_seg(expr *);
 290 int32_t reloc_wrt(expr *);
 291
 292 /*
 293  * The evaluator can also return hints about which of two registers
 294  * used in an expression should be the base register. See also the
 295  * `operand' structure.
 296  */
 297 struct eval_hints {
 298     int64_t base;
 299     int type;
 300 };
 301
 302 /*
 303  * The actual expression evaluator function looks like this. When
 304  * called, it expects the first token of its expression to already
 305  * be in `*tv'; if it is not, set tv->t_type to TOKEN_INVALID and
 306  * it will start by calling the scanner.
 307  *
 308  * If a forward reference happens during evaluation, the evaluator
 309  * must set `*fwref' to true if `fwref' is non-NULL.
 310  *
 311  * `critical' is non-zero if the expression may not contain forward
 312  * references. The evaluator will report its own error if this
 313  * occurs; if `critical' is 1, the error will be "symbol not
 314  * defined before use", whereas if `critical' is 2, the error will
 315  * be "symbol undefined".
 316  *
 317  * If `critical' has bit 8 set (in addition to its main value: 0x101
 318  * and 0x102 correspond to 1 and 2) then an extended expression
 319  * syntax is recognised, in which relational operators such as =, <
 320  * and >= are accepted, as well as low-precedence logical operators
 321  * &&, ^^ and ||.
 322  *
 323  * If `hints' is non-NULL, it gets filled in with some hints as to
 324  * the base register in complex effective addresses.
 325  */
 326 #define CRITICAL 0x100
 327 typedef expr *(*evalfunc) (scanner sc, void *scprivate,
 328                            struct tokenval * tv, int *fwref, int critical,
 329                            efunc error, struct eval_hints * hints);
 330
 331 /*
 332  * Special values for expr->type.  These come after EXPR_REG_END
 333  * as defined in regs.h.
 334  */
 335
 336 #define EXPR_UNKNOWN    (EXPR_REG_END+1) /* forward references */
 337 #define EXPR_SIMPLE     (EXPR_REG_END+2)
 338 #define EXPR_WRT        (EXPR_REG_END+3)
 339 #define EXPR_SEGBASE    (EXPR_REG_END+4)
 340
 341 /*
 342  * Linked list of strings...
 343  */
 344 typedef struct string_list {
 345     struct string_list *next;
 346     char str[1];
 347 } StrList;
 348
 349 /*
 350  * preprocessors ought to look like this:
 351  */
 352 typedef struct preproc_ops {
 353     /*
 354      * Called at the start of a pass; given a file name, the number
 355      * of the pass, an error reporting function, an evaluator
 356      * function, and a listing generator to talk to.
 357      */
 358     void (*reset) (char *, int, ListGen *, StrList **);
 359
 360     /*
 361      * Called to fetch a line of preprocessed source. The line
 362      * returned has been malloc'ed, and so should be freed after
 363      * use.
 364      */
 365     char *(*getline) (void);
 366
 367     /*
 368      * Called at the end of a pass.
 369      */
 370     void (*cleanup) (int);
 371 } Preproc;
 372
 373 extern Preproc nasmpp;
 374
 375 /*
 376  * ----------------------------------------------------------------
 377  * Some lexical properties of the NASM source language, included
 378  * here because they are shared between the parser and preprocessor
 379  * ----------------------------------------------------------------
 380  */
 381
 382 /*
 383  * isidstart matches any character that may start an identifier, and isidchar
 384  * matches any character that may appear at places other than the start of an
 385  * identifier. E.g. a period may only appear at the start of an identifier
 386  * (for local labels), whereas a number may appear anywhere *but* at the
 387  * start.
 388  */
 389
 390 #define isidstart(c) ( nasm_isalpha(c) || (c)=='_' || (c)=='.' || (c)=='?' \
 391                                   || (c)=='@' )
 392 #define isidchar(c)  ( isidstart(c) || nasm_isdigit(c) || \
 393                        (c)=='$' || (c)=='#' || (c)=='~' )
 394
 395 /* Ditto for numeric constants. */
 396
 397 #define isnumstart(c)  ( nasm_isdigit(c) || (c)=='$' )
 398 #define isnumchar(c)   ( nasm_isalnum(c) || (c)=='_' )
 399
 400 /* This returns the numeric value of a given 'digit'. */
 401
 402 #define numvalue(c)  ((c)>='a' ? (c)-'a'+10 : (c)>='A' ? (c)-'A'+10 : (c)-'0')
 403
 404 /*
 405  * Data-type flags that get passed to listing-file routines.
 406  */
 407 enum {
 408     LIST_READ, LIST_MACRO, LIST_MACRO_NOLIST, LIST_INCLUDE,
 409     LIST_INCBIN, LIST_TIMES
 410 };
 411
 412 /*
 413  * -----------------------------------------------------------
 414  * Format of the `insn' structure returned from `parser.c' and
 415  * passed into `assemble.c'
 416  * -----------------------------------------------------------
 417  */
 418
 419 /*
 420  * Here we define the operand types. These are implemented as bit
 421  * masks, since some are subsets of others; e.g. AX in a MOV
 422  * instruction is a special operand type, whereas AX in other
 423  * contexts is just another 16-bit register. (Also, consider CL in
 424  * shift instructions, DX in OUT, etc.)
 425  *
 426  * The basic concept here is that
 427  *    (class & ~operand) == 0
 428  *
 429  * if and only if "operand" belongs to class type "class".
 430  *
 431  * The bits are assigned as follows:
 432  *
 433  * Bits 0-7, 23, 29: sizes
 434  *  0:  8 bits (BYTE)
 435  *  1: 16 bits (WORD)
 436  *  2: 32 bits (DWORD)
 437  *  3: 64 bits (QWORD)
 438  *  4: 80 bits (TWORD)
 439  *  5: FAR
 440  *  6: NEAR
 441  *  7: SHORT
 442  * 23: 256 bits (YWORD)
 443  * 29: 128 bits (OWORD)
 444  *
 445  * Bits 8-11 modifiers
 446  *  8: TO
 447  *  9: COLON
 448  * 10: STRICT
 449  * 11: (reserved)
 450  *
 451  * Bits 12-15: type of operand
 452  * 12: REGISTER
 453  * 13: IMMEDIATE
 454  * 14: MEMORY (always has REGMEM attribute as well)
 455  * 15: REGMEM (valid EA operand)
 456  *
 457  * Bits 16-19, 28: subclasses
 458  * With REG_CDT:
 459  * 16: REG_CREG (CRx)
 460  * 17: REG_DREG (DRx)
 461  * 18: REG_TREG (TRx)
 462
 463  * With REG_GPR:
 464  * 16: REG_ACCUM  (AL, AX, EAX, RAX)
 465  * 17: REG_COUNT  (CL, CX, ECX, RCX)
 466  * 18: REG_DATA   (DL, DX, EDX, RDX)
 467  * 19: REG_HIGH   (AH, CH, DH, BH)
 468  * 28: REG_NOTACC (not REG_ACCUM)
 469  *
 470  * With REG_SREG:
 471  * 16: REG_CS
 472  * 17: REG_DESS (DS, ES, SS)
 473  * 18: REG_FSGS
 474  * 19: REG_SEG67
 475  *
 476  * With FPUREG:
 477  * 16: FPU0
 478  *
 479  * With XMMREG:
 480  * 16: XMM0
 481  *
 482  * With YMMREG:
 483  * 16: YMM0
 484  *
 485  * With MEMORY:
 486  * 16: MEM_OFFS (this is a simple offset)
 487  * 17: IP_REL (IP-relative offset)
 488  *
 489  * With IMMEDIATE:
 490  * 16: UNITY (1)
 491  * 17: BYTENESS16 (-128..127)
 492  * 18: BYTENESS32 (-128..127)
 493  * 19: BYTENESS64 (-128..127)
 494  *
 495  * Bits 20-22, 24-27: register classes
 496  * 20: REG_CDT (CRx, DRx, TRx)
 497  * 21: RM_GPR (REG_GPR) (integer register)
 498  * 22: REG_SREG
 499  * 24: FPUREG
 500  * 25: RM_MMX (MMXREG)
 501  * 26: RM_XMM (XMMREG)
 502  * 27: RM_YMM (YMMREG)
 503  *
 504  * Bit 31 is currently unallocated.
 505  *
 506  * 30: SAME_AS
 507  * Special flag only used in instruction patterns; means this operand
 508  * has to be identical to another operand.  Currently only supported
 509  * for registers.
 510  */
 511
 512 typedef uint32_t opflags_t;
 513
 514 /* Size, and other attributes, of the operand */
 515 #define BITS8           0x00000001U
 516 #define BITS16          0x00000002U
 517 #define BITS32          0x00000004U
 518 #define BITS64          0x00000008U   /* x64 and FPU only */
 519 #define BITS80          0x00000010U   /* FPU only */
 520 #define BITS128         0x20000000U
 521 #define BITS256         0x00800000U
 522 #define FAR             0x00000020U   /* grotty: this means 16:16 or */
 523                                        /* 16:32, like in CALL/JMP */
 524 #define NEAR            0x00000040U
 525 #define SHORT           0x00000080U   /* and this means what it says :) */
 526
 527 #define SIZE_MASK       0x208000FFU   /* all the size attributes */
 528
 529 /* Modifiers */
 530 #define MODIFIER_MASK   0x00000f00U
 531 #define TO              0x00000100U   /* reverse effect in FADD, FSUB &c */
 532 #define COLON           0x00000200U   /* operand is followed by a colon */
 533 #define STRICT          0x00000400U   /* do not optimize this operand */
 534
 535 /* Type of operand: memory reference, register, etc. */
 536 #define OPTYPE_MASK     0x0000f000U
 537 #define REGISTER        0x00001000U   /* register number in 'basereg' */
 538 #define IMMEDIATE       0x00002000U
 539 #define MEMORY          0x0000c000U
 540 #define REGMEM          0x00008000U   /* for r/m, ie EA, operands */
 541
 542 #define is_class(class, op)     (!((opflags_t)(class) & ~(opflags_t)(op)))
 543
 544 /* Register classes */
 545 #define REG_EA          0x00009000U   /* 'normal' reg, qualifies as EA */
 546 #define RM_GPR          0x00208000U   /* integer operand */
 547 #define REG_GPR         0x00209000U   /* integer register */
 548 #define REG8            0x00209001U   /*  8-bit GPR  */
 549 #define REG16           0x00209002U   /* 16-bit GPR */
 550 #define REG32           0x00209004U   /* 32-bit GPR */
 551 #define REG64           0x00209008U   /* 64-bit GPR */
 552 #define FPUREG          0x01001000U   /* floating point stack registers */
 553 #define FPU0            0x01011000U   /* FPU stack register zero */
 554 #define RM_MMX          0x02008000U   /* MMX operand */
 555 #define MMXREG          0x02009000U   /* MMX register */
 556 #define RM_XMM          0x04008000U   /* XMM (SSE) operand */
 557 #define XMMREG          0x04009000U   /* XMM (SSE) register */
 558 #define XMM0            0x04019000U   /* XMM register zero */
 559 #define RM_YMM          0x08008000U   /* YMM (AVX) operand */
 560 #define YMMREG          0x08009000U   /* YMM (AVX) register */
 561 #define YMM0            0x08019000U   /* YMM register zero */
 562 #define REG_CDT         0x00101004U   /* CRn, DRn and TRn */
 563 #define REG_CREG        0x00111004U   /* CRn */
 564 #define REG_DREG        0x00121004U   /* DRn */
 565 #define REG_TREG        0x00141004U   /* TRn */
 566 #define REG_SREG        0x00401002U   /* any segment register */
 567 #define REG_CS          0x00411002U   /* CS */
 568 #define REG_DESS        0x00421002U   /* DS, ES, SS */
 569 #define REG_FSGS        0x00441002U   /* FS, GS */
 570 #define REG_SEG67       0x00481002U   /* Unimplemented segment registers */
 571
 572 #define REG_RIP         0x00801008U   /* RIP relative addressing */
 573 #define REG_EIP         0x00801004U   /* EIP relative addressing */
 574
 575 /* Special GPRs */
 576 #define REG_SMASK       0x100f0000U   /* a mask for the following */
 577 #define REG_ACCUM       0x00219000U   /* accumulator: AL, AX, EAX, RAX */
 578 #define REG_AL          0x00219001U
 579 #define REG_AX          0x00219002U
 580 #define REG_EAX         0x00219004U
 581 #define REG_RAX         0x00219008U
 582 #define REG_COUNT       0x10229000U   /* counter: CL, CX, ECX, RCX */
 583 #define REG_CL          0x10229001U
 584 #define REG_CX          0x10229002U
 585 #define REG_ECX         0x10229004U
 586 #define REG_RCX         0x10229008U
 587 #define REG_DL          0x10249001U   /* data: DL, DX, EDX, RDX */
 588 #define REG_DX          0x10249002U
 589 #define REG_EDX         0x10249004U
 590 #define REG_RDX         0x10249008U
 591 #define REG_HIGH        0x10289001U   /* high regs: AH, CH, DH, BH */
 592 #define REG_NOTACC      0x10000000U   /* non-accumulator register */
 593 #define REG8NA          0x10209001U   /*  8-bit non-acc GPR  */
 594 #define REG16NA         0x10209002U   /* 16-bit non-acc GPR */
 595 #define REG32NA         0x10209004U   /* 32-bit non-acc GPR */
 596 #define REG64NA         0x10209008U   /* 64-bit non-acc GPR */
 597
 598 /* special types of EAs */
 599 #define MEM_OFFS        0x0001c000U   /* simple [address] offset - absolute! */
 600 #define IP_REL          0x0002c000U   /* IP-relative offset */
 601
 602 /* memory which matches any type of r/m operand */
 603 #define MEMORY_ANY      (MEMORY|RM_GPR|RM_MMX|RM_XMM|RM_YMM)
 604
 605 /* special type of immediate operand */
 606 #define UNITY           0x00012000U   /* for shift/rotate instructions */
 607 #define SBYTE16         0x00022000U   /* for op r16,immediate instrs. */
 608 #define SBYTE32         0x00042000U   /* for op r32,immediate instrs. */
 609 #define SBYTE64         0x00082000U   /* for op r64,immediate instrs. */
 610 #define BYTENESS        0x000e0000U   /* for testing for byteness */
 611
 612 /* special flags */
 613 #define SAME_AS         0x40000000U
 614
 615 /* Register names automatically generated from regs.dat */
 616 #include "regs.h"
 617
 618 enum ccode {                    /* condition code names */
 619     C_A, C_AE, C_B, C_BE, C_C, C_E, C_G, C_GE, C_L, C_LE, C_NA, C_NAE,
 620     C_NB, C_NBE, C_NC, C_NE, C_NG, C_NGE, C_NL, C_NLE, C_NO, C_NP,
 621     C_NS, C_NZ, C_O, C_P, C_PE, C_PO, C_S, C_Z,
 622     C_none = -1
 623 };
 624
 625 /*
 626  * REX flags
 627  */
 628 #define REX_REAL        0x4f    /* Actual REX prefix bits */
 629 #define REX_B           0x01    /* ModRM r/m extension */
 630 #define REX_X           0x02    /* SIB index extension */
 631 #define REX_R           0x04    /* ModRM reg extension */
 632 #define REX_W           0x08    /* 64-bit operand size */
 633 #define REX_L           0x20    /* Use LOCK prefix instead of REX.R */
 634 #define REX_P           0x40    /* REX prefix present/required */
 635 #define REX_H           0x80    /* High register present, REX forbidden */
 636 #define REX_D           0x0100  /* Instruction uses DREX instead of REX */
 637 #define REX_OC          0x0200  /* DREX suffix has the OC0 bit set */
 638 #define REX_V           0x0400  /* Instruction uses VEX/XOP instead of REX */
 639 #define REX_NH          0x0800  /* Instruction which doesn't use high regs */
 640
 641 /*
 642  * REX_V "classes" (prefixes which behave like VEX)
 643  */
 644 enum vex_class {
 645     RV_VEX              = 0,    /* C4/C5 */
 646     RV_XOP              = 1     /* 8F */
 647 };
 648
 649 /*
 650  * Note that because segment registers may be used as instruction
 651  * prefixes, we must ensure the enumerations for prefixes and
 652  * register names do not overlap.
 653  */
 654 enum prefixes {                 /* instruction prefixes */
 655     P_none = 0,
 656     PREFIX_ENUM_START = REG_ENUM_LIMIT,
 657     P_A16 = PREFIX_ENUM_START, P_A32, P_A64, P_ASP,
 658     P_LOCK, P_O16, P_O32, P_O64, P_OSP,
 659     P_REP, P_REPE, P_REPNE, P_REPNZ, P_REPZ, P_TIMES,
 660     P_WAIT,
 661     PREFIX_ENUM_LIMIT
 662 };
 663
 664 enum extop_type {               /* extended operand types */
 665     EOT_NOTHING,
 666     EOT_DB_STRING,              /* Byte string */
 667     EOT_DB_STRING_FREE,         /* Byte string which should be nasm_free'd*/
 668     EOT_DB_NUMBER,              /* Integer */
 669 };
 670
 671 enum ea_flags {                 /* special EA flags */
 672     EAF_BYTEOFFS =  1,          /* force offset part to byte size */
 673     EAF_WORDOFFS =  2,          /* force offset part to [d]word size */
 674     EAF_TIMESTWO =  4,          /* really do EAX*2 not EAX+EAX */
 675     EAF_REL      =  8,          /* IP-relative addressing */
 676     EAF_ABS      = 16,          /* non-IP-relative addressing */
 677     EAF_FSGS     = 32           /* fs/gs segment override present */
 678 };
 679
 680 enum eval_hint {                /* values for `hinttype' */
 681     EAH_NOHINT   = 0,           /* no hint at all - our discretion */
 682     EAH_MAKEBASE = 1,           /* try to make given reg the base */
 683     EAH_NOTBASE  = 2            /* try _not_ to make reg the base */
 684 };
 685
 686 typedef struct operand {        /* operand to an instruction */
 687     opflags_t type;             /* type of operand */
 688     int disp_size;              /* 0 means default; 16; 32; 64 */
 689     enum reg_enum basereg, indexreg; /* address registers */
 690     int scale;                  /* index scale */
 691     int hintbase;
 692     enum eval_hint hinttype;    /* hint as to real base register */
 693     int32_t segment;            /* immediate segment, if needed */
 694     int64_t offset;             /* any immediate number */
 695     int32_t wrt;                /* segment base it's relative to */
 696     int eaflags;                /* special EA flags */
 697     int opflags;                /* see OPFLAG_* defines below */
 698 } operand;
 699
 700 #define OPFLAG_FORWARD          1       /* operand is a forward reference */
 701 #define OPFLAG_EXTERN           2       /* operand is an external reference */
 702 #define OPFLAG_UNKNOWN          4       /* operand is an unknown reference */
 703                                         /* (always a forward reference also) */
 704
 705 typedef struct extop {          /* extended operand */
 706     struct extop *next;         /* linked list */
 707     char *stringval;            /* if it's a string, then here it is */
 708     size_t stringlen;           /* ... and here's how long it is */
 709     int64_t offset;             /* ... it's given here ... */
 710     int32_t segment;            /* if it's a number/address, then... */
 711     int32_t wrt;                /* ... and here */
 712     enum extop_type type;       /* defined above */
 713 } extop;
 714
 715 /* Prefix positions: each type of prefix goes in a specific slot.
 716    This affects the final ordering of the assembled output, which
 717    shouldn't matter to the processor, but if you have stylistic
 718    preferences, you can change this.  REX prefixes are handled
 719    differently for the time being.
 720
 721    Note that LOCK and REP are in the same slot.  This is
 722    an x86 architectural constraint. */
 723 enum prefix_pos {
 724     PPS_WAIT,                   /* WAIT (technically not a prefix!) */
 725     PPS_LREP,                   /* Lock or REP prefix */
 726     PPS_SEG,                    /* Segment override prefix */
 727     PPS_OSIZE,                  /* Operand size prefix */
 728     PPS_ASIZE,                  /* Address size prefix */
 729     MAXPREFIX                   /* Total number of prefix slots */
 730 };
 731
 732 /* If you need to change this, also change it in insns.pl */
 733 #define MAX_OPERANDS 5
 734
 735 typedef struct insn {           /* an instruction itself */
 736     char *label;                /* the label defined, or NULL */
 737     enum prefixes prefixes[MAXPREFIX]; /* instruction prefixes, if any */
 738     enum opcode opcode;         /* the opcode - not just the string */
 739     enum ccode condition;       /* the condition code, if Jcc/SETcc */
 740     int operands;               /* how many operands? 0-3
 741                                  * (more if db et al) */
 742     int addr_size;              /* address size */
 743     operand oprs[MAX_OPERANDS]; /* the operands, defined as above */
 744     extop *eops;                /* extended operands */
 745     int eops_float;             /* true if DD and floating */
 746     int32_t times;              /* repeat count (TIMES prefix) */
 747     bool forw_ref;              /* is there a forward reference? */
 748     int rex;                    /* Special REX Prefix */
 749     int drexdst;                /* Destination register for DREX/VEX suffix */
 750     int vex_cm;                 /* Class and M field for VEX prefix */
 751     int vex_wlp;                /* W, P and L information for VEX prefix */
 752 } insn;
 753
 754 enum geninfo { GI_SWITCH };
 755 /*
 756  * ------------------------------------------------------------
 757  * The data structure defining an output format driver, and the
 758  * interfaces to the functions therein.
 759  * ------------------------------------------------------------
 760  */
 761
 762 struct ofmt {
 763     /*
 764      * This is a short (one-liner) description of the type of
 765      * output generated by the driver.
 766      */
 767     const char *fullname;
 768
 769     /*
 770      * This is a single keyword used to select the driver.
 771      */
 772     const char *shortname;
 773
 774     /*
 775      * Output format flags.
 776      */
 777 #define OFMT_TEXT       1       /* Text file format */
 778     unsigned int flags;
 779
 780     /*
 781      * this is a pointer to the first element of the debug information
 782      */
 783     struct dfmt **debug_formats;
 784
 785     /*
 786      * and a pointer to the element that is being used
 787      * note: this is set to the default at compile time and changed if the
 788      * -F option is selected.  If developing a set of new debug formats for
 789      * an output format, be sure to set this to whatever default you want
 790      *
 791      */
 792     const struct dfmt *current_dfmt;
 793
 794     /*
 795      * This, if non-NULL, is a NULL-terminated list of `char *'s
 796      * pointing to extra standard macros supplied by the object
 797      * format (e.g. a sensible initial default value of __SECT__,
 798      * and user-level equivalents for any format-specific
 799      * directives).
 800      */
 801     macros_t *stdmac;
 802
 803     /*
 804      * This procedure is called at the start of an output session to set
 805      * up internal parameters.
 806      */
 807     void (*init)(void);
 808
 809     /*
 810      * This procedure is called to pass generic information to the
 811      * object file.  The first parameter gives the information type
 812      * (currently only command line switches)
 813      * and the second parameter gives the value.  This function returns
 814      * 1 if recognized, 0 if unrecognized
 815      */
 816     int (*setinfo) (enum geninfo type, char **string);
 817
 818     /*
 819      * This procedure is called by assemble() to write actual
 820      * generated code or data to the object file. Typically it
 821      * doesn't have to actually _write_ it, just store it for
 822      * later.
 823      *
 824      * The `type' argument specifies the type of output data, and
 825      * usually the size as well: its contents are described below.
 826      */
 827     void (*output) (int32_t segto, const void *data,
 828                     enum out_type type, uint64_t size,
 829                     int32_t segment, int32_t wrt);
 830
 831     /*
 832      * This procedure is called once for every symbol defined in
 833      * the module being assembled. It gives the name and value of
 834      * the symbol, in NASM's terms, and indicates whether it has
 835      * been declared to be global. Note that the parameter "name",
 836      * when passed, will point to a piece of static storage
 837      * allocated inside the label manager - it's safe to keep using
 838      * that pointer, because the label manager doesn't clean up
 839      * until after the output driver has.
 840      *
 841      * Values of `is_global' are: 0 means the symbol is local; 1
 842      * means the symbol is global; 2 means the symbol is common (in
 843      * which case `offset' holds the _size_ of the variable).
 844      * Anything else is available for the output driver to use
 845      * internally.
 846      *
 847      * This routine explicitly _is_ allowed to call the label
 848      * manager to define further symbols, if it wants to, even
 849      * though it's been called _from_ the label manager. That much
 850      * re-entrancy is guaranteed in the label manager. However, the
 851      * label manager will in turn call this routine, so it should
 852      * be prepared to be re-entrant itself.
 853      *
 854      * The `special' parameter contains special information passed
 855      * through from the command that defined the label: it may have
 856      * been an EXTERN, a COMMON or a GLOBAL. The distinction should
 857      * be obvious to the output format from the other parameters.
 858      */
 859     void (*symdef) (char *name, int32_t segment, int64_t offset,
 860                     int is_global, char *special);
 861
 862     /*
 863      * This procedure is called when the source code requests a
 864      * segment change. It should return the corresponding segment
 865      * _number_ for the name, or NO_SEG if the name is not a valid
 866      * segment name.
 867      *
 868      * It may also be called with NULL, in which case it is to
 869      * return the _default_ section number for starting assembly in.
 870      *
 871      * It is allowed to modify the string it is given a pointer to.
 872      *
 873      * It is also allowed to specify a default instruction size for
 874      * the segment, by setting `*bits' to 16 or 32. Or, if it
 875      * doesn't wish to define a default, it can leave `bits' alone.
 876      */
 877     int32_t (*section) (char *name, int pass, int *bits);
 878
 879     /*
 880      * This procedure is called to modify the segment base values
 881      * returned from the SEG operator. It is given a segment base
 882      * value (i.e. a segment value with the low bit set), and is
 883      * required to produce in return a segment value which may be
 884      * different. It can map segment bases to absolute numbers by
 885      * means of returning SEG_ABS types.
 886      *
 887      * It should return NO_SEG if the segment base cannot be
 888      * determined; the evaluator (which calls this routine) is
 889      * responsible for throwing an error condition if that occurs
 890      * in pass two or in a critical expression.
 891      */
 892     int32_t (*segbase) (int32_t segment);
 893
 894     /*
 895      * This procedure is called to allow the output driver to
 896      * process its own specific directives. When called, it has the
 897      * directive word in `directive' and the parameter string in
 898      * `value'. It is called in both assembly passes, and `pass'
 899      * will be either 1 or 2.
 900      *
 901      * This procedure should return zero if it does not _recognise_
 902      * the directive, so that the main program can report an error.
 903      * If it recognises the directive but then has its own errors,
 904      * it should report them itself and then return non-zero. It
 905      * should also return non-zero if it correctly processes the
 906      * directive.
 907      */
 908     int (*directive)(enum directives directive, char *value, int pass);
 909
 910     /*
 911      * This procedure is called before anything else - even before
 912      * the "init" routine - and is passed the name of the input
 913      * file from which this output file is being generated. It
 914      * should return its preferred name for the output file in
 915      * `outname', if outname[0] is not '\0', and do nothing to
 916      * `outname' otherwise. Since it is called before the driver is
 917      * properly initialized, it has to be passed its error handler
 918      * separately.
 919      *
 920      * This procedure may also take its own copy of the input file
 921      * name for use in writing the output file: it is _guaranteed_
 922      * that it will be called before the "init" routine.
 923      *
 924      * The parameter `outname' points to an area of storage
 925      * guaranteed to be at least FILENAME_MAX in size.
 926      */
 927     void (*filename) (char *inname, char *outname);
 928
 929     /*
 930      * This procedure is called after assembly finishes, to allow
 931      * the output driver to clean itself up and free its memory.
 932      * Typically, it will also be the point at which the object
 933      * file actually gets _written_.
 934      *
 935      * One thing the cleanup routine should always do is to close
 936      * the output file pointer.
 937      */
 938     void (*cleanup) (int debuginfo);
 939 };
 940
 941 extern struct ofmt *ofmt;
 942 extern FILE *ofile;
 943
 944 /*
 945  * ------------------------------------------------------------
 946  * The data structure defining a debug format driver, and the
 947  * interfaces to the functions therein.
 948  * ------------------------------------------------------------
 949  */
 950
 951 struct dfmt {
 952     /*
 953      * This is a short (one-liner) description of the type of
 954      * output generated by the driver.
 955      */
 956     const char *fullname;
 957
 958     /*
 959      * This is a single keyword used to select the driver.
 960      */
 961     const char *shortname;
 962
 963     /*
 964      * init - called initially to set up local pointer to object format.
 965      */
 966     void (*init)(void);
 967
 968     /*
 969      * linenum - called any time there is output with a change of
 970      * line number or file.
 971      */
 972     void (*linenum)(const char *filename, int32_t linenumber, int32_t segto);
 973
 974     /*
 975      * debug_deflabel - called whenever a label is defined. Parameters
 976      * are the same as to 'symdef()' in the output format. This function
 977      * would be called before the output format version.
 978      */
 979
 980     void (*debug_deflabel)(char *name, int32_t segment, int64_t offset,
 981                            int is_global, char *special);
 982     /*
 983      * debug_directive - called whenever a DEBUG directive other than 'LINE'
 984      * is encountered. 'directive' contains the first parameter to the
 985      * DEBUG directive, and params contains the rest. For example,
 986      * 'DEBUG VAR _somevar:int' would translate to a call to this
 987      * function with 'directive' equal to "VAR" and 'params' equal to
 988      * "_somevar:int".
 989      */
 990     void (*debug_directive)(const char *directive, const char *params);
 991
 992     /*
 993      * typevalue - called whenever the assembler wishes to register a type
 994      * for the last defined label.  This routine MUST detect if a type was
 995      * already registered and not re-register it.
 996      */
 997     void (*debug_typevalue)(int32_t type);
 998
 999     /*
1000      * debug_output - called whenever output is required
1001      * 'type' is the type of info required, and this is format-specific
1002      */
1003     void (*debug_output)(int type, void *param);
1004
1005     /*
1006      * cleanup - called after processing of file is complete
1007      */
1008     void (*cleanup)(void);
1009 };
1010
1011 extern const struct dfmt *dfmt;
1012
1013 /*
1014  * The type definition macros
1015  * for debugging
1016  *
1017  * low 3 bits: reserved
1018  * next 5 bits: type
1019  * next 24 bits: number of elements for arrays (0 for labels)
1020  */
1021
1022 #define TY_UNKNOWN 0x00
1023 #define TY_LABEL   0x08
1024 #define TY_BYTE    0x10
1025 #define TY_WORD    0x18
1026 #define TY_DWORD   0x20
1027 #define TY_FLOAT   0x28
1028 #define TY_QWORD   0x30
1029 #define TY_TBYTE   0x38
1030 #define TY_OWORD   0x40
1031 #define TY_YWORD   0x48
1032 #define TY_COMMON  0xE0
1033 #define TY_SEG     0xE8
1034 #define TY_EXTERN  0xF0
1035 #define TY_EQU     0xF8
1036
1037 #define TYM_TYPE(x) ((x) & 0xF8)
1038 #define TYM_ELEMENTS(x) (((x) & 0xFFFFFF00) >> 8)
1039
1040 #define TYS_ELEMENTS(x)  ((x) << 8)
1041
1042 /*
1043  * -----
1044  * Special tokens
1045  * -----
1046  */
1047
1048 enum special_tokens {
1049     SPECIAL_ENUM_START = PREFIX_ENUM_LIMIT,
1050     S_ABS = SPECIAL_ENUM_START,
1051     S_BYTE, S_DWORD, S_FAR, S_LONG, S_NEAR, S_NOSPLIT,
1052     S_OWORD, S_QWORD, S_REL, S_SHORT, S_STRICT, S_TO, S_TWORD, S_WORD, S_YWORD,
1053     SPECIAL_ENUM_LIMIT
1054 };
1055
1056 /*
1057  * -----
1058  * Global modes
1059  * -----
1060  */
1061
1062 /*
1063  * This declaration passes the "pass" number to all other modules
1064  * "pass0" assumes the values: 0, 0, ..., 0, 1, 2
1065  * where 0 = optimizing pass
1066  *       1 = pass 1
1067  *       2 = pass 2
1068  */
1069
1070 extern int pass0;
1071 extern int passn;               /* Actual pass number */
1072
1073 extern bool tasm_compatible_mode;
1074 extern int optimizing;
1075 extern int globalbits;          /* 16, 32 or 64-bit mode */
1076 extern int globalrel;           /* default to relative addressing? */
1077 extern int maxbits;             /* max bits supported by output */
1078
1079 /*
1080  * NASM version strings, defined in ver.c
1081  */
1082 extern const char nasm_version[];
1083 extern const char nasm_date[];
1084 extern const char nasm_compile_options[];
1085 extern const char nasm_comment[];
1086 extern const char nasm_signature[];
1087
1088 #endif