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 #define nasm_build_assert(x) (void)(sizeof(char[1-2*!!(x)]))
 179
 180 /*
 181  * ANSI doesn't guarantee the presence of `stricmp' or
 182  * `strcasecmp'.
 183  */
 184 #if defined(HAVE_STRCASECMP)
 185 #define nasm_stricmp strcasecmp
 186 #elif defined(HAVE_STRICMP)
 187 #define nasm_stricmp stricmp
 188 #else
 189 int nasm_stricmp(const char *, const char *);
 190 #endif
 191
 192 #if defined(HAVE_STRNCASECMP)
 193 #define nasm_strnicmp strncasecmp
 194 #elif defined(HAVE_STRNICMP)
 195 #define nasm_strnicmp strnicmp
 196 #else
 197 int nasm_strnicmp(const char *, const char *, size_t);
 198 #endif
 199
 200 int nasm_memicmp(const char *, const char *, size_t);
 201
 202 #if defined(HAVE_STRSEP)
 203 #define nasm_strsep strsep
 204 #else
 205 char *nasm_strsep(char **stringp, const char *delim);
 206 #endif
 207
 208 /* This returns the numeric value of a given 'digit'. */
 209 #define numvalue(c)         ((c) >= 'a' ? (c) - 'a' + 10 : (c) >= 'A' ? (c) - 'A' + 10 : (c) - '0')
 210
 211 /*
 212  * Convert a string into a number, using NASM number rules. Sets
 213  * `*error' to true if an error occurs, and false otherwise.
 214  */
 215 int64_t readnum(char *str, bool *error);
 216
 217 /*
 218  * Convert a character constant into a number. Sets
 219  * `*warn' to true if an overflow occurs, and false otherwise.
 220  * str points to and length covers the middle of the string,
 221  * without the quotes.
 222  */
 223 int64_t readstrnum(char *str, int length, bool *warn);
 224
 225 /*
 226  * seg_init: Initialise the segment-number allocator.
 227  * seg_alloc: allocate a hitherto unused segment number.
 228  */
 229 void seg_init(void);
 230 int32_t seg_alloc(void);
 231
 232 /*
 233  * many output formats will be able to make use of this: a standard
 234  * function to add an extension to the name of the input file
 235  */
 236 void standard_extension(char *inname, char *outname, char *extension);
 237
 238 /*
 239  * Utility macros...
 240  *
 241  * This is a useful #define which I keep meaning to use more often:
 242  * the number of elements of a statically defined array.
 243  */
 244 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 245
 246 /*
 247  * List handling
 248  *
 249  *  list_for_each - regular iterator over list
 250  *  list_for_each_safe - the same but safe against list items removal
 251  *  list_last - find the last element in a list
 252  */
 253 #define list_for_each(pos, head)                        \
 254     for (pos = head; pos; pos = pos->next)
 255 #define list_for_each_safe(pos, n, head)                \
 256     for (pos = head, n = (pos ? pos->next : NULL); pos; \
 257         pos = n, n = (n ? n->next : NULL))
 258 #define list_last(pos, head)                            \
 259     for (pos = head; pos && pos->next; pos = pos->next) \
 260         ;
 261 #define list_reverse(head, prev, next)                  \
 262     do {                                                \
 263         if (!head || !head->next)                       \
 264             break;                                      \
 265         prev = NULL;                                    \
 266         while (head) {                                  \
 267             next = head->next;                          \
 268             head->next = prev;                          \
 269             prev = head;                                \
 270             head = next;                                \
 271         }                                               \
 272         head = prev;                                    \
 273     } while (0)
 274
 275 /*
 276  * Power of 2 align helpers
 277  */
 278 #undef ALIGN_MASK               /* Some BSD flavors define these in system headers */
 279 #undef ALIGN
 280 #define ALIGN_MASK(v, mask)     (((v) + (mask)) & ~(mask))
 281 #define ALIGN(v, a)             ALIGN_MASK(v, (a) - 1)
 282 #define IS_ALIGNED(v, a)        (((v) & ((a) - 1)) == 0)
 283
 284 /*
 285  * some handy macros that will probably be of use in more than one
 286  * output format: convert integers into little-endian byte packed
 287  * format in memory
 288  */
 289
 290 #if X86_MEMORY
 291
 292 #define WRITECHAR(p,v)                          \
 293     do {                                        \
 294         *(uint8_t *)(p) = (v);                  \
 295         (p) += 1;                               \
 296     } while (0)
 297
 298 #define WRITESHORT(p,v)                         \
 299     do {                                        \
 300         *(uint16_t *)(p) = (v);                 \
 301         (p) += 2;                               \
 302     } while (0)
 303
 304 #define WRITELONG(p,v)                          \
 305     do {                                        \
 306         *(uint32_t *)(p) = (v);                 \
 307         (p) += 4;                               \
 308     } while (0)
 309
 310 #define WRITEDLONG(p,v)                         \
 311     do {                                        \
 312         *(uint64_t *)(p) = (v);                 \
 313         (p) += 8;                               \
 314     } while (0)
 315
 316 #define WRITEADDR(p,v,s)                        \
 317     do {                                        \
 318         uint64_t _wa_v = (v);                   \
 319         memcpy((p), &_wa_v, (s));               \
 320         (p) += (s);                             \
 321     } while (0)
 322
 323 #else /* !X86_MEMORY */
 324
 325 #define WRITECHAR(p,v)                          \
 326     do {                                        \
 327         uint8_t *_wc_p = (uint8_t *)(p);        \
 328         uint8_t _wc_v = (v);                    \
 329         _wc_p[0] = _wc_v;                       \
 330         (p) = (void *)(_wc_p + 1);              \
 331     } while (0)
 332
 333 #define WRITESHORT(p,v)                         \
 334     do {                                        \
 335         uint8_t *_ws_p = (uint8_t *)(p);        \
 336         uint16_t _ws_v = (v);                   \
 337         _ws_p[0] = _ws_v;                       \
 338         _ws_p[1] = _ws_v >> 8;                  \
 339         (p) = (void *)(_ws_p + 2);              \
 340     } while (0)
 341
 342 #define WRITELONG(p,v)                          \
 343     do {                                        \
 344         uint8_t *_wl_p = (uint8_t *)(p);        \
 345         uint32_t _wl_v = (v);                   \
 346         _wl_p[0] = _wl_v;                       \
 347         _wl_p[1] = _wl_v >> 8;                  \
 348         _wl_p[2] = _wl_v >> 16;                 \
 349         _wl_p[3] = _wl_v >> 24;                 \
 350         (p) = (void *)(_wl_p + 4);              \
 351     } while (0)
 352
 353 #define WRITEDLONG(p,v)                         \
 354     do {                                        \
 355         uint8_t *_wq_p = (uint8_t *)(p);        \
 356         uint64_t _wq_v = (v);                   \
 357         _wq_p[0] = _wq_v;                       \
 358         _wq_p[1] = _wq_v >> 8;                  \
 359         _wq_p[2] = _wq_v >> 16;                 \
 360         _wq_p[3] = _wq_v >> 24;                 \
 361         _wq_p[4] = _wq_v >> 32;                 \
 362         _wq_p[5] = _wq_v >> 40;                 \
 363         _wq_p[6] = _wq_v >> 48;                 \
 364         _wq_p[7] = _wq_v >> 56;                 \
 365         (p) = (void *)(_wq_p + 8);              \
 366     } while (0)
 367
 368 #define WRITEADDR(p,v,s)                        \
 369     do {                                        \
 370         int _wa_s = (s);                        \
 371         uint64_t _wa_v = (v);                   \
 372         while (_wa_s--) {                       \
 373             WRITECHAR(p,_wa_v);                 \
 374             _wa_v >>= 8;                        \
 375         }                                       \
 376     } while(0)
 377
 378 #endif
 379
 380 /*
 381  * and routines to do the same thing to a file
 382  */
 383 #define fwriteint8_t(d,f) putc(d,f)
 384 void fwriteint16_t(uint16_t data, FILE * fp);
 385 void fwriteint32_t(uint32_t data, FILE * fp);
 386 void fwriteint64_t(uint64_t data, FILE * fp);
 387 void fwriteaddr(uint64_t data, int size, FILE * fp);
 388
 389 /*
 390  * Binary search routine. Returns index into `array' of an entry
 391  * matching `string', or <0 if no match. `array' is taken to
 392  * contain `size' elements.
 393  *
 394  * bsi() is case sensitive, bsii() is case insensitive.
 395  */
 396 int bsi(const char *string, const char **array, int size);
 397 int bsii(const char *string, const char **array, int size);
 398
 399 /*
 400  * These functions are used to keep track of the source code file and name.
 401  */
 402 void src_init(void);
 403 void src_free(void);
 404 const char *src_set_fname(const char *newname);
 405 const char *src_get_fname(void);
 406 int32_t src_set_linnum(int32_t newline);
 407 int32_t src_get_linnum(void);
 408 /* Can be used when there is no need for the old information */
 409 void src_set(int32_t line, const char *filename);
 410 /*
 411  * src_get gets both the source file name and line.
 412  * It is also used if you maintain private status about the source location
 413  * It return 0 if the information was the same as the last time you
 414  * checked, -2 if the name changed and (new-old) if just the line changed.
 415  */
 416 int32_t src_get(int32_t *xline, const char **xname);
 417
 418 char *nasm_strcat(const char *one, const char *two);
 419
 420 char *nasm_skip_spaces(const char *p);
 421 char *nasm_skip_word(const char *p);
 422 char *nasm_zap_spaces_fwd(char *p);
 423 char *nasm_zap_spaces_rev(char *p);
 424 char *nasm_trim_spaces(char *p);
 425 char *nasm_get_word(char *p, char **tail);
 426 char *nasm_opt_val(char *p, char **opt, char **val);
 427
 428 /*
 429  * Converts a relative pathname rel_path into an absolute path name.
 430  *
 431  * The buffer returned must be freed by the caller
 432  */
 433 char *nasm_realpath(const char *rel_path);
 434
 435 const char *prefix_name(int);
 436
 437 /*
 438  * Wrappers around fopen()... for future change to a dedicated structure
 439  */
 440 enum file_flags {
 441     NF_BINARY   = 0x00000000,   /* Binary file (default) */
 442     NF_TEXT     = 0x00000001,   /* Text file */
 443     NF_NONFATAL = 0x00000000,   /* Don't die on open failure (default) */
 444     NF_FATAL    = 0x00000002    /* Die on open failure */
 445 };
 446
 447 FILE *nasm_open_read(const char *filename, enum file_flags flags);
 448 FILE *nasm_open_write(const char *filename, enum file_flags flags);
 449
 450 #define ZERO_BUF_SIZE 4096      /* Default value */
 451 #if defined(BUFSIZ) && (BUFSIZ > ZERO_BUF_SIZE)
 452 # undef ZERO_BUF_SIZE
 453 # define ZERO_BUF_SIZE BUFSIZ
 454 #endif
 455 extern const uint8_t zero_buffer[ZERO_BUF_SIZE];
 456 void fwritezero(size_t bytes, FILE *fp);
 457
 458 static inline bool overflow_general(int64_t value, int bytes)
 459 {
 460     int sbit;
 461     int64_t vmax, vmin;
 462
 463     if (bytes >= 8)
 464         return false;
 465
 466     sbit = (bytes << 3) - 1;
 467     vmax =  ((int64_t)2 << sbit) - 1;
 468     vmin = -((int64_t)1 << sbit);
 469
 470     return value < vmin || value > vmax;
 471 }
 472
 473 static inline bool overflow_signed(int64_t value, int bytes)
 474 {
 475     int sbit;
 476     int64_t vmax, vmin;
 477
 478     if (bytes >= 8)
 479         return false;
 480
 481     sbit = (bytes << 3) - 1;
 482     vmax =  ((int64_t)1 << sbit) - 1;
 483     vmin = -((int64_t)1 << sbit);
 484
 485     return value < vmin || value > vmax;
 486 }
 487
 488 static inline bool overflow_unsigned(int64_t value, int bytes)
 489 {
 490     int sbit;
 491     int64_t vmax, vmin;
 492
 493     if (bytes >= 8)
 494         return false;
 495
 496     sbit = (bytes << 3) - 1;
 497     vmax = ((int64_t)2 << sbit) - 1;
 498     vmin = 0;
 499
 500     return value < vmin || value > vmax;
 501 }
 502
 503 static inline int64_t signed_bits(int64_t value, int bits)
 504 {
 505     if (bits < 64) {
 506         value &= ((int64_t)1 << bits) - 1;
 507         if (value & (int64_t)1 << (bits - 1))
 508             value |= (int64_t)((uint64_t)-1 << bits);
 509     }
 510     return value;
 511 }
 512
 513 int idata_bytes(int opcode);
 514
 515 /* check if value is power of 2 */
 516 #define is_power2(v)   ((v) && ((v) & ((v) - 1)) == 0)
 517
 518 /*
 519  * floor(log2(v))
 520  */
 521 int ilog2_32(uint32_t v);
 522 int ilog2_64(uint64_t v);
 523
 524 /*
 525  * v == 0 ? 0 : is_power2(x) ? ilog2_X(v) : -1
 526  */
 527 int alignlog2_32(uint32_t v);
 528 int alignlog2_64(uint64_t v);
 529
 530 #endif