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 <inttypes.h>
  44 #include <stdio.h>
  45 #include <string.h>
  46 #ifdef HAVE_STRINGS_H
  47 #include <strings.h>
  48 #endif
  49
  50 /*
  51  * tolower table -- avoids a function call on some platforms.
  52  * NOTE: unlike the tolower() function in ctype, EOF is *NOT*
  53  * a permitted value, for obvious reasons.
  54  */
  55 void tolower_init(void);
  56 extern unsigned char nasm_tolower_tab[256];
  57 #define nasm_tolower(x) nasm_tolower_tab[(unsigned char)(x)]
  58
  59 /* Wrappers around <ctype.h> functions */
  60 /* These are only valid for values that cannot include EOF */
  61 #define nasm_isspace(x)  isspace((unsigned char)(x))
  62 #define nasm_isalpha(x)  isalpha((unsigned char)(x))
  63 #define nasm_isdigit(x)  isdigit((unsigned char)(x))
  64 #define nasm_isalnum(x)  isalnum((unsigned char)(x))
  65 #define nasm_isxdigit(x) isxdigit((unsigned char)(x))
  66
  67 /*
  68  * -------------------------
  69  * Error reporting functions
  70  * -------------------------
  71  */
  72
  73 /*
  74  * An error reporting function should look like this.
  75  */
  76 void printf_func(2, 3) nasm_error(int severity, const char *fmt, ...);
  77 no_return printf_func(2, 3) nasm_fatal(int flags, const char *fmt, ...);
  78 no_return printf_func(2, 3) nasm_panic(int flags, const char *fmt, ...);
  79 no_return nasm_panic_from_macro(const char *file, int line);
  80 #define panic() nasm_panic_from_macro(__FILE__, __LINE__);
  81
  82 typedef void (*vefunc) (int severity, const char *fmt, va_list ap);
  83 extern vefunc nasm_verror;
  84 static inline vefunc nasm_set_verror(vefunc ve)
  85 {
  86     vefunc old_verror = nasm_verror;
  87     nasm_verror = ve;
  88     return old_verror;
  89 }
  90
  91 /*
  92  * These are the error severity codes which get passed as the first
  93  * argument to an efunc.
  94  */
  95
  96 #define ERR_DEBUG       0x00000000      /* put out debugging message */
  97 #define ERR_WARNING     0x00000001      /* warn only: no further action */
  98 #define ERR_NONFATAL    0x00000002      /* terminate assembly after phase */
  99 #define ERR_FATAL       0x00000006      /* instantly fatal: exit with error */
 100 #define ERR_PANIC       0x00000007      /* internal error: panic instantly
 101                                          * and dump core for reference */
 102 #define ERR_MASK        0x00000007      /* mask off the above codes */
 103 #define ERR_NOFILE      0x00000010      /* don't give source file name/line */
 104 #define ERR_USAGE       0x00000020      /* print a usage message */
 105 #define ERR_PASS1       0x00000040      /* only print this error on pass one */
 106 #define ERR_PASS2       0x00000080
 107
 108 #define ERR_NO_SEVERITY 0x00000100      /* suppress printing severity */
 109 #define ERR_PP_PRECOND  0x00000200      /* for preprocessor use */
 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_MAX            15       /* the highest numbered one */
 139
 140 /*
 141  * Wrappers around malloc, realloc and free. nasm_malloc will
 142  * fatal-error and die rather than return NULL; nasm_realloc will
 143  * do likewise, and will also guarantee to work right on being
 144  * passed a NULL pointer; nasm_free will do nothing if it is passed
 145  * a NULL pointer.
 146  */
 147 void *nasm_malloc(size_t);
 148 void *nasm_zalloc(size_t);
 149 void *nasm_realloc(void *, size_t);
 150 void nasm_free(void *);
 151 char *nasm_strdup(const char *);
 152 char *nasm_strndup(const char *, size_t);
 153
 154 /*
 155  * Wrapper around fwrite() which fatal-errors on output failure.
 156  */
 157 void nasm_write(const void *, size_t, FILE *);
 158
 159 /*
 160  * NASM assert failure
 161  */
 162 no_return nasm_assert_failed(const char *, int, const char *);
 163 #define nasm_assert(x)                                          \
 164     do {                                                        \
 165         if (unlikely(!(x)))                                     \
 166             nasm_assert_failed(__FILE__,__LINE__,#x);           \
 167     } while (0)
 168
 169 /*
 170  * NASM failure at build time if x != 0
 171  */
 172 #define nasm_build_assert(x) (void)(sizeof(char[1-2*!!(x)]))
 173
 174 /*
 175  * ANSI doesn't guarantee the presence of `stricmp' or
 176  * `strcasecmp'.
 177  */
 178 #if defined(HAVE_STRCASECMP)
 179 #define nasm_stricmp strcasecmp
 180 #elif defined(HAVE_STRICMP)
 181 #define nasm_stricmp stricmp
 182 #else
 183 int nasm_stricmp(const char *, const char *);
 184 #endif
 185
 186 #if defined(HAVE_STRNCASECMP)
 187 #define nasm_strnicmp strncasecmp
 188 #elif defined(HAVE_STRNICMP)
 189 #define nasm_strnicmp strnicmp
 190 #else
 191 int nasm_strnicmp(const char *, const char *, size_t);
 192 #endif
 193
 194 int nasm_memicmp(const char *, const char *, size_t);
 195
 196 #if defined(HAVE_STRSEP)
 197 #define nasm_strsep strsep
 198 #else
 199 char *nasm_strsep(char **stringp, const char *delim);
 200 #endif
 201
 202 /* This returns the numeric value of a given 'digit'. */
 203 #define numvalue(c)         ((c) >= 'a' ? (c) - 'a' + 10 : (c) >= 'A' ? (c) - 'A' + 10 : (c) - '0')
 204
 205 /*
 206  * Convert a string into a number, using NASM number rules. Sets
 207  * `*error' to true if an error occurs, and false otherwise.
 208  */
 209 int64_t readnum(char *str, bool *error);
 210
 211 /*
 212  * Convert a character constant into a number. Sets
 213  * `*warn' to true if an overflow occurs, and false otherwise.
 214  * str points to and length covers the middle of the string,
 215  * without the quotes.
 216  */
 217 int64_t readstrnum(char *str, int length, bool *warn);
 218
 219 /*
 220  * seg_init: Initialise the segment-number allocator.
 221  * seg_alloc: allocate a hitherto unused segment number.
 222  */
 223 void seg_init(void);
 224 int32_t seg_alloc(void);
 225
 226 /*
 227  * many output formats will be able to make use of this: a standard
 228  * function to add an extension to the name of the input file
 229  */
 230 void standard_extension(char *inname, char *outname, char *extension);
 231
 232 /*
 233  * Utility macros...
 234  *
 235  * This is a useful #define which I keep meaning to use more often:
 236  * the number of elements of a statically defined array.
 237  */
 238 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 239
 240 /*
 241  * List handling
 242  *
 243  *  list_for_each - regular iterator over list
 244  *  list_for_each_safe - the same but safe against list items removal
 245  *  list_last - find the last element in a list
 246  */
 247 #define list_for_each(pos, head)                        \
 248     for (pos = head; pos; pos = pos->next)
 249 #define list_for_each_safe(pos, n, head)                \
 250     for (pos = head, n = (pos ? pos->next : NULL); pos; \
 251         pos = n, n = (n ? n->next : NULL))
 252 #define list_last(pos, head)                            \
 253     for (pos = head; pos && pos->next; pos = pos->next) \
 254         ;
 255 #define list_reverse(head, prev, next)                  \
 256     do {                                                \
 257         if (!head || !head->next)                       \
 258             break;                                      \
 259         prev = NULL;                                    \
 260         while (head) {                                  \
 261             next = head->next;                          \
 262             head->next = prev;                          \
 263             prev = head;                                \
 264             head = next;                                \
 265         }                                               \
 266         head = prev;                                    \
 267     } while (0)
 268
 269 /*
 270  * Power of 2 align helpers
 271  */
 272 #undef ALIGN_MASK               /* Some BSD flavors define these in system headers */
 273 #undef ALIGN
 274 #define ALIGN_MASK(v, mask)     (((v) + (mask)) & ~(mask))
 275 #define ALIGN(v, a)             ALIGN_MASK(v, (a) - 1)
 276 #define IS_ALIGNED(v, a)        (((v) & ((a) - 1)) == 0)
 277
 278 /*
 279  * some handy macros that will probably be of use in more than one
 280  * output format: convert integers into little-endian byte packed
 281  * format in memory
 282  */
 283
 284 #if X86_MEMORY
 285
 286 #define WRITECHAR(p,v)                          \
 287     do {                                        \
 288         *(uint8_t *)(p) = (v);                  \
 289         (p) += 1;                               \
 290     } while (0)
 291
 292 #define WRITESHORT(p,v)                         \
 293     do {                                        \
 294         *(uint16_t *)(p) = (v);                 \
 295         (p) += 2;                               \
 296     } while (0)
 297
 298 #define WRITELONG(p,v)                          \
 299     do {                                        \
 300         *(uint32_t *)(p) = (v);                 \
 301         (p) += 4;                               \
 302     } while (0)
 303
 304 #define WRITEDLONG(p,v)                         \
 305     do {                                        \
 306         *(uint64_t *)(p) = (v);                 \
 307         (p) += 8;                               \
 308     } while (0)
 309
 310 #define WRITEADDR(p,v,s)                        \
 311     do {                                        \
 312         uint64_t _wa_v = (v);                   \
 313         memcpy((p), &_wa_v, (s));               \
 314         (p) += (s);                             \
 315     } while (0)
 316
 317 #else /* !X86_MEMORY */
 318
 319 #define WRITECHAR(p,v)                          \
 320     do {                                        \
 321         uint8_t *_wc_p = (uint8_t *)(p);        \
 322         uint8_t _wc_v = (v);                    \
 323         _wc_p[0] = _wc_v;                       \
 324         (p) = (void *)(_wc_p + 1);              \
 325     } while (0)
 326
 327 #define WRITESHORT(p,v)                         \
 328     do {                                        \
 329         uint8_t *_ws_p = (uint8_t *)(p);        \
 330         uint16_t _ws_v = (v);                   \
 331         _ws_p[0] = _ws_v;                       \
 332         _ws_p[1] = _ws_v >> 8;                  \
 333         (p) = (void *)(_ws_p + 2);              \
 334     } while (0)
 335
 336 #define WRITELONG(p,v)                          \
 337     do {                                        \
 338         uint8_t *_wl_p = (uint8_t *)(p);        \
 339         uint32_t _wl_v = (v);                   \
 340         _wl_p[0] = _wl_v;                       \
 341         _wl_p[1] = _wl_v >> 8;                  \
 342         _wl_p[2] = _wl_v >> 16;                 \
 343         _wl_p[3] = _wl_v >> 24;                 \
 344         (p) = (void *)(_wl_p + 4);              \
 345     } while (0)
 346
 347 #define WRITEDLONG(p,v)                         \
 348     do {                                        \
 349         uint8_t *_wq_p = (uint8_t *)(p);        \
 350         uint64_t _wq_v = (v);                   \
 351         _wq_p[0] = _wq_v;                       \
 352         _wq_p[1] = _wq_v >> 8;                  \
 353         _wq_p[2] = _wq_v >> 16;                 \
 354         _wq_p[3] = _wq_v >> 24;                 \
 355         _wq_p[4] = _wq_v >> 32;                 \
 356         _wq_p[5] = _wq_v >> 40;                 \
 357         _wq_p[6] = _wq_v >> 48;                 \
 358         _wq_p[7] = _wq_v >> 56;                 \
 359         (p) = (void *)(_wq_p + 8);              \
 360     } while (0)
 361
 362 #define WRITEADDR(p,v,s)                        \
 363     do {                                        \
 364         int _wa_s = (s);                        \
 365         uint64_t _wa_v = (v);                   \
 366         while (_wa_s--) {                       \
 367             WRITECHAR(p,_wa_v);                 \
 368             _wa_v >>= 8;                        \
 369         }                                       \
 370     } while(0)
 371
 372 #endif
 373
 374 /*
 375  * and routines to do the same thing to a file
 376  */
 377 #define fwriteint8_t(d,f) putc(d,f)
 378 void fwriteint16_t(uint16_t data, FILE * fp);
 379 void fwriteint32_t(uint32_t data, FILE * fp);
 380 void fwriteint64_t(uint64_t data, FILE * fp);
 381 void fwriteaddr(uint64_t data, int size, FILE * fp);
 382
 383 /*
 384  * Binary search routine. Returns index into `array' of an entry
 385  * matching `string', or <0 if no match. `array' is taken to
 386  * contain `size' elements.
 387  *
 388  * bsi() is case sensitive, bsii() is case insensitive.
 389  */
 390 int bsi(const char *string, const char **array, int size);
 391 int bsii(const char *string, const char **array, int size);
 392
 393 char *src_set_fname(char *newname);
 394 int32_t src_set_linnum(int32_t newline);
 395 int32_t src_get_linnum(void);
 396 /*
 397  * src_get may be used if you simply want to know the source file and line.
 398  * It is also used if you maintain private status about the source location
 399  * It return 0 if the information was the same as the last time you
 400  * checked, -1 if the name changed and (new-old) if just the line changed.
 401  */
 402 int src_get(int32_t *xline, char **xname);
 403
 404 char *nasm_strcat(const char *one, const char *two);
 405
 406 char *nasm_skip_spaces(const char *p);
 407 char *nasm_skip_word(const char *p);
 408 char *nasm_zap_spaces_fwd(char *p);
 409 char *nasm_zap_spaces_rev(char *p);
 410 char *nasm_trim_spaces(char *p);
 411 char *nasm_get_word(char *p, char **tail);
 412 char *nasm_opt_val(char *p, char **opt, char **val);
 413
 414 /*
 415  * Converts a relative pathname rel_path into an absolute path name.
 416  *
 417  * The buffer returned must be freed by the caller
 418  */
 419 char *nasm_realpath(const char *rel_path);
 420
 421 const char *prefix_name(int);
 422
 423 #define ZERO_BUF_SIZE 4096      /* Default value */
 424 #if defined(BUFSIZ) && (BUFSIZ > ZERO_BUF_SIZE)
 425 # undef ZERO_BUF_SIZE
 426 # define ZERO_BUF_SIZE BUFSIZ
 427 #endif
 428 extern const uint8_t zero_buffer[ZERO_BUF_SIZE];
 429 void fwritezero(size_t bytes, FILE *fp);
 430
 431 static inline bool overflow_general(int64_t value, int bytes)
 432 {
 433     int sbit;
 434     int64_t vmax, vmin;
 435
 436     if (bytes >= 8)
 437         return false;
 438
 439     sbit = (bytes << 3) - 1;
 440     vmax =  ((int64_t)2 << sbit) - 1;
 441     vmin = -((int64_t)1 << sbit);
 442
 443     return value < vmin || value > vmax;
 444 }
 445
 446 static inline bool overflow_signed(int64_t value, int bytes)
 447 {
 448     int sbit;
 449     int64_t vmax, vmin;
 450
 451     if (bytes >= 8)
 452         return false;
 453
 454     sbit = (bytes << 3) - 1;
 455     vmax =  ((int64_t)1 << sbit) - 1;
 456     vmin = -((int64_t)1 << sbit);
 457
 458     return value < vmin || value > vmax;
 459 }
 460
 461 static inline bool overflow_unsigned(int64_t value, int bytes)
 462 {
 463     int sbit;
 464     int64_t vmax, vmin;
 465
 466     if (bytes >= 8)
 467         return false;
 468
 469     sbit = (bytes << 3) - 1;
 470     vmax = ((int64_t)2 << sbit) - 1;
 471     vmin = 0;
 472
 473     return value < vmin || value > vmax;
 474 }
 475
 476 static inline int64_t signed_bits(int64_t value, int bits)
 477 {
 478     if (bits < 64) {
 479         value &= ((int64_t)1 << bits) - 1;
 480         if (value & (int64_t)1 << (bits - 1))
 481             value |= (int64_t)((uint64_t)-1 << bits);
 482     }
 483     return value;
 484 }
 485
 486 int idata_bytes(int opcode);
 487
 488 /* check if value is power of 2 */
 489 #define is_power2(v)   ((v) && ((v) & ((v) - 1)) == 0)
 490
 491 /*
 492  * floor(log2(v))
 493  */
 494 int ilog2_32(uint32_t v);
 495 int ilog2_64(uint64_t v);
 496
 497 /*
 498  * v == 0 ? 0 : is_power2(x) ? ilog2_X(v) : -1
 499  */
 500 int alignlog2_32(uint32_t v);
 501 int alignlog2_64(uint64_t v);
 502
 503 #endif