include/nasmlib.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2016 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  * nasmlib.h    header file for nasmlib.c
  36  */
  37
  38 #ifndef NASM_NASMLIB_H
  39 #define NASM_NASMLIB_H
  40
  41 #include "compiler.h"
  42
  43 #include <stdio.h>
  44 #include <string.h>
  45 #ifdef HAVE_STRINGS_H
  46 # include <strings.h>
  47 #endif
  48
  49 /*
  50  * tolower table -- avoids a function call on some platforms.
  51  * NOTE: unlike the tolower() function in ctype, EOF is *NOT*
  52  * a permitted value, for obvious reasons.
  53  */
  54 void tolower_init(void);
  55 extern unsigned char nasm_tolower_tab[256];
  56 #define nasm_tolower(x) nasm_tolower_tab[(unsigned char)(x)]
  57
  58 /* Wrappers around <ctype.h> functions */
  59 /* These are only valid for values that cannot include EOF */
  60 #define nasm_isspace(x)  isspace((unsigned char)(x))
  61 #define nasm_isalpha(x)  isalpha((unsigned char)(x))
  62 #define nasm_isdigit(x)  isdigit((unsigned char)(x))
  63 #define nasm_isalnum(x)  isalnum((unsigned char)(x))
  64 #define nasm_isxdigit(x) isxdigit((unsigned char)(x))
  65
  66 /*
  67  * -------------------------
  68  * Error reporting functions
  69  * -------------------------
  70  */
  71
  72 /*
  73  * An error reporting function should look like this.
  74  */
  75 void printf_func(2, 3) nasm_error(int severity, const char *fmt, ...);
  76 no_return printf_func(2, 3) nasm_fatal(int flags, const char *fmt, ...);
  77 no_return printf_func(2, 3) nasm_panic(int flags, const char *fmt, ...);
  78 no_return nasm_panic_from_macro(const char *file, int line);
  79 #define panic() nasm_panic_from_macro(__FILE__, __LINE__);
  80
  81 typedef void (*vefunc) (int severity, const char *fmt, va_list ap);
  82 extern vefunc nasm_verror;
  83 static inline vefunc nasm_set_verror(vefunc ve)
  84 {
  85     vefunc old_verror = nasm_verror;
  86     nasm_verror = ve;
  87     return old_verror;
  88 }
  89
  90 /*
  91  * These are the error severity codes which get passed as the first
  92  * argument to an efunc.
  93  */
  94
  95 #define ERR_DEBUG       0x00000000      /* put out debugging message */
  96 #define ERR_WARNING     0x00000001      /* warn only: no further action */
  97 #define ERR_NONFATAL    0x00000002      /* terminate assembly after phase */
  98 #define ERR_FATAL       0x00000006      /* instantly fatal: exit with error */
  99 #define ERR_PANIC       0x00000007      /* internal error: panic instantly
 100                                          * and dump core for reference */
 101 #define ERR_MASK        0x00000007      /* mask off the above codes */
 102 #define ERR_NOFILE      0x00000010      /* don't give source file name/line */
 103 #define ERR_USAGE       0x00000020      /* print a usage message */
 104 #define ERR_PASS1       0x00000040      /* only print this error on pass one */
 105 #define ERR_PASS2       0x00000080
 106
 107 #define ERR_NO_SEVERITY 0x00000100      /* suppress printing severity */
 108 #define ERR_PP_PRECOND  0x00000200      /* for preprocessor use */
 109 #define ERR_PP_LISTMACRO 0x00000400     /* from preproc->error_list_macros() */
 110
 111 /*
 112  * These codes define specific types of suppressible warning.
 113  */
 114
 115 #define ERR_WARN_MASK   0xFFFFF000      /* the mask for this feature */
 116 #define ERR_WARN_SHR    12              /* how far to shift right */
 117
 118 #define WARN(x)         ((x) << ERR_WARN_SHR)
 119 #define WARN_IDX(x)     (((x) & ERR_WARN_MASK) >> ERR_WARN_SHR)
 120
 121 #define ERR_WARN_TERM           WARN( 0) /* treat warnings as errors */
 122 #define ERR_WARN_MNP            WARN( 1) /* macro-num-parameters warning */
 123 #define ERR_WARN_MSR            WARN( 2) /* macro self-reference */
 124 #define ERR_WARN_MDP            WARN( 3) /* macro default parameters check */
 125 #define ERR_WARN_OL             WARN( 4) /* orphan label (no colon, and
 126                                           * alone on line) */
 127 #define ERR_WARN_NOV            WARN( 5) /* numeric overflow */
 128 #define ERR_WARN_GNUELF         WARN( 6) /* using GNU ELF extensions */
 129 #define ERR_WARN_FL_OVERFLOW    WARN( 7) /* FP overflow */
 130 #define ERR_WARN_FL_DENORM      WARN( 8) /* FP denormal */
 131 #define ERR_WARN_FL_UNDERFLOW   WARN( 9) /* FP underflow */
 132 #define ERR_WARN_FL_TOOLONG     WARN(10) /* FP too many digits */
 133 #define ERR_WARN_USER           WARN(11) /* %warning directives */
 134 #define ERR_WARN_LOCK           WARN(12) /* bad LOCK prefixes */
 135 #define ERR_WARN_HLE            WARN(13) /* bad HLE prefixes */
 136 #define ERR_WARN_BND            WARN(14) /* bad BND prefixes */
 137 #define ERR_WARN_ZEXTRELOC      WARN(15) /* relocation zero-extended */
 138 #define ERR_WARN_PTR            WARN(16) /* not a NASM keyword */
 139 #define ERR_WARN_MAX            16       /* the highest numbered one */
 140
 141 /*
 142  * Wrappers around malloc, realloc and free. nasm_malloc will
 143  * fatal-error and die rather than return NULL; nasm_realloc will
 144  * do likewise, and will also guarantee to work right on being
 145  * passed a NULL pointer; nasm_free will do nothing if it is passed
 146  * a NULL pointer.
 147  */
 148 void * safe_malloc(1) nasm_malloc(size_t);
 149 void * safe_malloc(1) nasm_zalloc(size_t);
 150 void * safe_malloc2(1,2) nasm_calloc(size_t, size_t);
 151 void * safe_realloc(2) nasm_realloc(void *, size_t);
 152 void nasm_free(void *);
 153 char * safe_alloc nasm_strdup(const char *);
 154 char * safe_alloc nasm_strndup(const char *, size_t);
 155
 156 #define nasm_new(p) ((p) = nasm_zalloc(sizeof(*(p))))
 157 #define nasm_newn(p,n) ((p) = nasm_calloc(sizeof(*(p)),(n)))
 158 #define nasm_delete(p) do { nasm_free(p); (p) = NULL; } while (0)
 159
 160 /*
 161  * Wrapper around fwrite() which fatal-errors on output failure.
 162  */
 163 void nasm_write(const void *, size_t, FILE *);
 164
 165 /*
 166  * NASM assert failure
 167  */
 168 no_return nasm_assert_failed(const char *, int, const char *);
 169 #define nasm_assert(x)                                          \
 170     do {                                                        \
 171         if (unlikely(!(x)))                                     \
 172             nasm_assert_failed(__FILE__,__LINE__,#x);           \
 173     } while (0)
 174
 175 /*
 176  * NASM failure at build time if x != 0
 177  */
 178 #ifdef static_assert
 179 # define nasm_build_assert(x) static_assert(x, "assertion " #x " failed")
 180 #elif defined(HAVE_FUNC_ATTRIBUTE_ERROR)
 181 # define nasm_build_assert(x)                                           \
 182     if (!(x)) {                                                         \
 183         extern void __attribute__((error("assertion " #x " failed")))      \
 184             fail(void);                                                 \
 185         fail();                                                         \
 186     }
 187 #else
 188 # define nasm_build_assert(x) (void)(sizeof(char[1-2*!(x)]))
 189 #endif
 190
 191 /*
 192  * ANSI doesn't guarantee the presence of `stricmp' or
 193  * `strcasecmp'.
 194  */
 195 #if defined(HAVE_STRCASECMP)
 196 #define nasm_stricmp strcasecmp
 197 #elif defined(HAVE_STRICMP)
 198 #define nasm_stricmp stricmp
 199 #else
 200 int pure_func nasm_stricmp(const char *, const char *);
 201 #endif
 202
 203 #if defined(HAVE_STRNCASECMP)
 204 #define nasm_strnicmp strncasecmp
 205 #elif defined(HAVE_STRNICMP)
 206 #define nasm_strnicmp strnicmp
 207 #else
 208 int pure_func nasm_strnicmp(const char *, const char *, size_t);
 209 #endif
 210
 211 int pure_func nasm_memicmp(const char *, const char *, size_t);
 212
 213 #if defined(HAVE_STRSEP)
 214 #define nasm_strsep strsep
 215 #else
 216 char *nasm_strsep(char **stringp, const char *delim);
 217 #endif
 218
 219 #ifndef HAVE_DECL_STRNLEN
 220 size_t pure_func strnlen(const char *, size_t);
 221 #endif
 222
 223 /* This returns the numeric value of a given 'digit'. */
 224 #define numvalue(c)         ((c) >= 'a' ? (c) - 'a' + 10 : (c) >= 'A' ? (c) - 'A' + 10 : (c) - '0')
 225
 226 /*
 227  * Convert a string into a number, using NASM number rules. Sets
 228  * `*error' to true if an error occurs, and false otherwise.
 229  */
 230 int64_t readnum(char *str, bool *error);
 231
 232 /*
 233  * Convert a character constant into a number. Sets
 234  * `*warn' to true if an overflow occurs, and false otherwise.
 235  * str points to and length covers the middle of the string,
 236  * without the quotes.
 237  */
 238 int64_t readstrnum(char *str, int length, bool *warn);
 239
 240 /*
 241  * seg_init: Initialise the segment-number allocator.
 242  * seg_alloc: allocate a hitherto unused segment number.
 243  */
 244 void pure_func seg_init(void);
 245 int32_t pure_func seg_alloc(void);
 246
 247 /*
 248  * many output formats will be able to make use of this: a standard
 249  * function to add an extension to the name of the input file
 250  */
 251 void standard_extension(char *inname, char *outname, char *extension);
 252
 253 /*
 254  * Utility macros...
 255  *
 256  * This is a useful #define which I keep meaning to use more often:
 257  * the number of elements of a statically defined array.
 258  */
 259 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 260
 261 /*
 262  * List handling
 263  *
 264  *  list_for_each - regular iterator over list
 265  *  list_for_each_safe - the same but safe against list items removal
 266  *  list_last - find the last element in a list
 267  */
 268 #define list_for_each(pos, head)                        \
 269     for (pos = head; pos; pos = pos->next)
 270 #define list_for_each_safe(pos, n, head)                \
 271     for (pos = head, n = (pos ? pos->next : NULL); pos; \
 272         pos = n, n = (n ? n->next : NULL))
 273 #define list_last(pos, head)                            \
 274     for (pos = head; pos && pos->next; pos = pos->next) \
 275         ;
 276 #define list_reverse(head, prev, next)                  \
 277     do {                                                \
 278         if (!head || !head->next)                       \
 279             break;                                      \
 280         prev = NULL;                                    \
 281         while (head) {                                  \
 282             next = head->next;                          \
 283             head->next = prev;                          \
 284             prev = head;                                \
 285             head = next;                                \
 286         }                                               \
 287         head = prev;                                    \
 288     } while (0)
 289
 290 /*
 291  * Power of 2 align helpers
 292  */
 293 #undef ALIGN_MASK               /* Some BSD flavors define these in system headers */
 294 #undef ALIGN
 295 #define ALIGN_MASK(v, mask)     (((v) + (mask)) & ~(mask))
 296 #define ALIGN(v, a)             ALIGN_MASK(v, (a) - 1)
 297 #define IS_ALIGNED(v, a)        (((v) & ((a) - 1)) == 0)
 298
 299 /*
 300  * some handy macros that will probably be of use in more than one
 301  * output format: convert integers into little-endian byte packed
 302  * format in memory
 303  */
 304
 305 #if X86_MEMORY
 306
 307 #define WRITECHAR(p,v)                          \
 308     do {                                        \
 309         *(uint8_t *)(p) = (v);                  \
 310         (p) += 1;                               \
 311     } while (0)
 312
 313 #define WRITESHORT(p,v)                         \
 314     do {                                        \
 315         *(uint16_t *)(p) = (v);                 \
 316         (p) += 2;                               \
 317     } while (0)
 318
 319 #define WRITELONG(p,v)                          \
 320     do {                                        \
 321         *(uint32_t *)(p) = (v);                 \
 322         (p) += 4;                               \
 323     } while (0)
 324
 325 #define WRITEDLONG(p,v)                         \
 326     do {                                        \
 327         *(uint64_t *)(p) = (v);                 \
 328         (p) += 8;                               \
 329     } while (0)
 330
 331 #define WRITEADDR(p,v,s)                        \
 332     do {                                        \
 333         uint64_t _wa_v = (v);                   \
 334         memcpy((p), &_wa_v, (s));               \
 335         (p) += (s);                             \
 336     } while (0)
 337
 338 #else /* !X86_MEMORY */
 339
 340 #define WRITECHAR(p,v)                          \
 341     do {                                        \
 342         uint8_t *_wc_p = (uint8_t *)(p);        \
 343         uint8_t _wc_v = (v);                    \
 344         _wc_p[0] = _wc_v;                       \
 345         (p) = (void *)(_wc_p + 1);              \
 346     } while (0)
 347
 348 #define WRITESHORT(p,v)                         \
 349     do {                                        \
 350         uint8_t *_ws_p = (uint8_t *)(p);        \
 351         uint16_t _ws_v = (v);                   \
 352         _ws_p[0] = _ws_v;                       \
 353         _ws_p[1] = _ws_v >> 8;                  \
 354         (p) = (void *)(_ws_p + 2);              \
 355     } while (0)
 356
 357 #define WRITELONG(p,v)                          \
 358     do {                                        \
 359         uint8_t *_wl_p = (uint8_t *)(p);        \
 360         uint32_t _wl_v = (v);                   \
 361         _wl_p[0] = _wl_v;                       \
 362         _wl_p[1] = _wl_v >> 8;                  \
 363         _wl_p[2] = _wl_v >> 16;                 \
 364         _wl_p[3] = _wl_v >> 24;                 \
 365         (p) = (void *)(_wl_p + 4);              \
 366     } while (0)
 367
 368 #define WRITEDLONG(p,v)                         \
 369     do {                                        \
 370         uint8_t *_wq_p = (uint8_t *)(p);        \
 371         uint64_t _wq_v = (v);                   \
 372         _wq_p[0] = _wq_v;                       \
 373         _wq_p[1] = _wq_v >> 8;                  \
 374         _wq_p[2] = _wq_v >> 16;                 \
 375         _wq_p[3] = _wq_v >> 24;                 \
 376         _wq_p[4] = _wq_v >> 32;                 \
 377         _wq_p[5] = _wq_v >> 40;                 \
 378         _wq_p[6] = _wq_v >> 48;                 \
 379         _wq_p[7] = _wq_v >> 56;                 \
 380         (p) = (void *)(_wq_p + 8);              \
 381     } while (0)
 382
 383 #define WRITEADDR(p,v,s)                        \
 384     do {                                        \
 385         int _wa_s = (s);                        \
 386         uint64_t _wa_v = (v);                   \
 387         while (_wa_s--) {                       \
 388             WRITECHAR(p,_wa_v);                 \
 389             _wa_v >>= 8;                        \
 390         }                                       \
 391     } while(0)
 392
 393 #endif
 394
 395 /*
 396  * and routines to do the same thing to a file
 397  */
 398 #define fwriteint8_t(d,f) putc(d,f)
 399 void fwriteint16_t(uint16_t data, FILE * fp);
 400 void fwriteint32_t(uint32_t data, FILE * fp);
 401 void fwriteint64_t(uint64_t data, FILE * fp);
 402 void fwriteaddr(uint64_t data, int size, FILE * fp);
 403
 404 /*
 405  * Binary search routine. Returns index into `array' of an entry
 406  * matching `string', or <0 if no match. `array' is taken to
 407  * contain `size' elements.
 408  *
 409  * bsi() is case sensitive, bsii() is case insensitive.
 410  */
 411 int bsi(const char *string, const char **array, int size);
 412 int bsii(const char *string, const char **array, int size);
 413
 414 /*
 415  * These functions are used to keep track of the source code file and name.
 416  */
 417 void src_init(void);
 418 void src_free(void);
 419 const char *src_set_fname(const char *newname);
 420 const char *src_get_fname(void);
 421 int32_t src_set_linnum(int32_t newline);
 422 int32_t src_get_linnum(void);
 423 /* Can be used when there is no need for the old information */
 424 void src_set(int32_t line, const char *filename);
 425 /*
 426  * src_get gets both the source file name and line.
 427  * It is also used if you maintain private status about the source location
 428  * It return 0 if the information was the same as the last time you
 429  * checked, -2 if the name changed and (new-old) if just the line changed.
 430  */
 431 int32_t src_get(int32_t *xline, const char **xname);
 432
 433 char *nasm_strcat(const char *one, const char *two);
 434
 435 char *nasm_skip_spaces(const char *p);
 436 char *nasm_skip_word(const char *p);
 437 char *nasm_zap_spaces_fwd(char *p);
 438 char *nasm_zap_spaces_rev(char *p);
 439 char *nasm_trim_spaces(char *p);
 440 char *nasm_get_word(char *p, char **tail);
 441 char *nasm_opt_val(char *p, char **opt, char **val);
 442
 443 /*
 444  * Converts a relative pathname rel_path into an absolute path name.
 445  *
 446  * The buffer returned must be freed by the caller
 447  */
 448 char *nasm_realpath(const char *rel_path);
 449
 450 const char * pure_func prefix_name(int);
 451
 452 /*
 453  * Wrappers around fopen()... for future change to a dedicated structure
 454  */
 455 enum file_flags {
 456     NF_BINARY   = 0x00000000,   /* Binary file (default) */
 457     NF_TEXT     = 0x00000001,   /* Text file */
 458     NF_NONFATAL = 0x00000000,   /* Don't die on open failure (default) */
 459     NF_FATAL    = 0x00000002,   /* Die on open failure */
 460     NF_FORMAP   = 0x00000004    /* Intended to use nasm_map_file() */
 461 };
 462
 463 FILE *nasm_open_read(const char *filename, enum file_flags flags);
 464 FILE *nasm_open_write(const char *filename, enum file_flags flags);
 465
 466 /* Probe for existence of a file */
 467 bool nasm_file_exists(const char *filename);
 468
 469 #define ZERO_BUF_SIZE 65536     /* Default value */
 470 #if defined(BUFSIZ) && (BUFSIZ > ZERO_BUF_SIZE)
 471 # undef ZERO_BUF_SIZE
 472 # define ZERO_BUF_SIZE BUFSIZ
 473 #endif
 474 extern const uint8_t zero_buffer[ZERO_BUF_SIZE];
 475
 476 /* Missing fseeko/ftello */
 477 #ifndef HAVE_FSEEKO
 478 # undef off_t                   /* Just in case it is a macro */
 479 # ifdef HAVE__FSEEKI64
 480 #  define fseeko _fseeki64
 481 #  define ftello _ftelli64
 482 #  define off_t  int64_t
 483 # else
 484 #  define fseeko fseek
 485 #  define ftello ftell
 486 #  define off_t  long
 487 # endif
 488 #endif
 489
 490 const void *nasm_map_file(FILE *fp, off_t start, off_t len);
 491 void nasm_unmap_file(const void *p, size_t len);
 492 off_t nasm_file_size(FILE *f);
 493 off_t nasm_file_size_by_path(const char *pathname);
 494 void fwritezero(off_t bytes, FILE *fp);
 495
 496 static inline bool const_func overflow_general(int64_t value, int bytes)
 497 {
 498     int sbit;
 499     int64_t vmax, vmin;
 500
 501     if (bytes >= 8)
 502         return false;
 503
 504     sbit = (bytes << 3) - 1;
 505     vmax =  ((int64_t)2 << sbit) - 1;
 506     vmin = -((int64_t)1 << sbit);
 507
 508     return value < vmin || value > vmax;
 509 }
 510
 511 static inline bool const_func overflow_signed(int64_t value, int bytes)
 512 {
 513     int sbit;
 514     int64_t vmax, vmin;
 515
 516     if (bytes >= 8)
 517         return false;
 518
 519     sbit = (bytes << 3) - 1;
 520     vmax =  ((int64_t)1 << sbit) - 1;
 521     vmin = -((int64_t)1 << sbit);
 522
 523     return value < vmin || value > vmax;
 524 }
 525
 526 static inline bool const_func overflow_unsigned(int64_t value, int bytes)
 527 {
 528     int sbit;
 529     int64_t vmax, vmin;
 530
 531     if (bytes >= 8)
 532         return false;
 533
 534     sbit = (bytes << 3) - 1;
 535     vmax = ((int64_t)2 << sbit) - 1;
 536     vmin = 0;
 537
 538     return value < vmin || value > vmax;
 539 }
 540
 541 static inline int64_t const_func signed_bits(int64_t value, int bits)
 542 {
 543     if (bits < 64) {
 544         value &= ((int64_t)1 << bits) - 1;
 545         if (value & (int64_t)1 << (bits - 1))
 546             value |= (int64_t)((uint64_t)-1 << bits);
 547     }
 548     return value;
 549 }
 550
 551 int const_func idata_bytes(int opcode);
 552
 553 /* check if value is power of 2 */
 554 #define is_power2(v)   ((v) && ((v) & ((v) - 1)) == 0)
 555
 556 /*
 557  * floor(log2(v))
 558  */
 559 int const_func ilog2_32(uint32_t v);
 560 int const_func ilog2_64(uint64_t v);
 561
 562 /*
 563  * v == 0 ? 0 : is_power2(x) ? ilog2_X(v) : -1
 564  */
 565 int const_func alignlog2_32(uint32_t v);
 566 int const_func alignlog2_64(uint64_t v);
 567
 568 #endif