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 typedef void (*efunc) (int severity, const char *fmt, ...);
  77 typedef void (*vefunc) (int severity, const char *fmt, va_list ap);
  78 void printf_func(2, 3) nasm_error(int severity, const char *fmt, ...);
  79 void nasm_set_verror(vefunc);
  80 no_return printf_func(2, 3) nasm_panic(int flags, const char *fmt, ...);
  81 #define panic() nasm_panic(ERR_NOFILE, "Internal error at %s:%d\n", __FILE__, __LINE__);
  82
  83 /*
  84  * These are the error severity codes which get passed as the first
  85  * argument to an efunc.
  86  */
  87
  88 #define ERR_DEBUG       0x00000008      /* put out debugging message */
  89 #define ERR_WARNING     0x00000000      /* warn only: no further action */
  90 #define ERR_NONFATAL    0x00000001      /* terminate assembly after phase */
  91 #define ERR_FATAL       0x00000002      /* instantly fatal: exit with error */
  92 #define ERR_PANIC       0x00000003      /* internal error: panic instantly
  93                                          * and dump core for reference */
  94 #define ERR_MASK        0x0000000F      /* mask off the above codes */
  95 #define ERR_NOFILE      0x00000010      /* don't give source file name/line */
  96 #define ERR_USAGE       0x00000020      /* print a usage message */
  97 #define ERR_PASS1       0x00000040      /* only print this error on pass one */
  98 #define ERR_PASS2       0x00000080
  99 #define ERR_NO_SEVERITY 0x00000100      /* suppress printing severity */
 100
 101 /*
 102  * These codes define specific types of suppressible warning.
 103  */
 104
 105 #define ERR_WARN_MASK   0xFFFFF000      /* the mask for this feature */
 106 #define ERR_WARN_SHR    12              /* how far to shift right */
 107
 108 #define WARN(x)         ((x) << ERR_WARN_SHR)
 109 #define WARN_IDX(x)     (((x) & ERR_WARN_MASK) >> ERR_WARN_SHR)
 110
 111 #define ERR_WARN_TERM           WARN( 0) /* treat warnings as errors */
 112 #define ERR_WARN_MNP            WARN( 1) /* macro-num-parameters warning */
 113 #define ERR_WARN_MSR            WARN( 2) /* macro self-reference */
 114 #define ERR_WARN_MDP            WARN( 3) /* macro default parameters check */
 115 #define ERR_WARN_OL             WARN( 4) /* orphan label (no colon, and
 116                                           * alone on line) */
 117 #define ERR_WARN_NOV            WARN( 5) /* numeric overflow */
 118 #define ERR_WARN_GNUELF         WARN( 6) /* using GNU ELF extensions */
 119 #define ERR_WARN_FL_OVERFLOW    WARN( 7) /* FP overflow */
 120 #define ERR_WARN_FL_DENORM      WARN( 8) /* FP denormal */
 121 #define ERR_WARN_FL_UNDERFLOW   WARN( 9) /* FP underflow */
 122 #define ERR_WARN_FL_TOOLONG     WARN(10) /* FP too many digits */
 123 #define ERR_WARN_USER           WARN(11) /* %warning directives */
 124 #define ERR_WARN_LOCK           WARN(12) /* bad LOCK prefixes */
 125 #define ERR_WARN_HLE            WARN(13) /* bad HLE prefixes */
 126 #define ERR_WARN_BND            WARN(14) /* bad BND prefixes */
 127 #define ERR_WARN_MAX            14       /* the highest numbered one */
 128
 129 /*
 130  * Wrappers around malloc, realloc and free. nasm_malloc will
 131  * fatal-error and die rather than return NULL; nasm_realloc will
 132  * do likewise, and will also guarantee to work right on being
 133  * passed a NULL pointer; nasm_free will do nothing if it is passed
 134  * a NULL pointer.
 135  */
 136 void *nasm_malloc(size_t);
 137 void *nasm_zalloc(size_t);
 138 void *nasm_realloc(void *, size_t);
 139 void nasm_free(void *);
 140 char *nasm_strdup(const char *);
 141 char *nasm_strndup(const char *, size_t);
 142
 143 /*
 144  * Wrapper around fwrite() which fatal-errors on output failure.
 145  */
 146 void nasm_write(const void *, size_t, FILE *);
 147
 148 /*
 149  * NASM assert failure
 150  */
 151 no_return nasm_assert_failed(const char *, int, const char *);
 152 #define nasm_assert(x)                                          \
 153     do {                                                        \
 154         if (unlikely(!(x)))                                     \
 155             nasm_assert_failed(__FILE__,__LINE__,#x);           \
 156     } while (0)
 157
 158 /*
 159  * NASM failure at build time if x != 0
 160  */
 161 #define nasm_build_assert(x) (void)(sizeof(char[1-2*!!(x)]))
 162
 163 /*
 164  * ANSI doesn't guarantee the presence of `stricmp' or
 165  * `strcasecmp'.
 166  */
 167 #if defined(HAVE_STRCASECMP)
 168 #define nasm_stricmp strcasecmp
 169 #elif defined(HAVE_STRICMP)
 170 #define nasm_stricmp stricmp
 171 #else
 172 int nasm_stricmp(const char *, const char *);
 173 #endif
 174
 175 #if defined(HAVE_STRNCASECMP)
 176 #define nasm_strnicmp strncasecmp
 177 #elif defined(HAVE_STRNICMP)
 178 #define nasm_strnicmp strnicmp
 179 #else
 180 int nasm_strnicmp(const char *, const char *, size_t);
 181 #endif
 182
 183 int nasm_memicmp(const char *, const char *, size_t);
 184
 185 #if defined(HAVE_STRSEP)
 186 #define nasm_strsep strsep
 187 #else
 188 char *nasm_strsep(char **stringp, const char *delim);
 189 #endif
 190
 191 /* This returns the numeric value of a given 'digit'. */
 192 #define numvalue(c)         ((c) >= 'a' ? (c) - 'a' + 10 : (c) >= 'A' ? (c) - 'A' + 10 : (c) - '0')
 193
 194 /*
 195  * Convert a string into a number, using NASM number rules. Sets
 196  * `*error' to true if an error occurs, and false otherwise.
 197  */
 198 int64_t readnum(char *str, bool *error);
 199
 200 /*
 201  * Convert a character constant into a number. Sets
 202  * `*warn' to true if an overflow occurs, and false otherwise.
 203  * str points to and length covers the middle of the string,
 204  * without the quotes.
 205  */
 206 int64_t readstrnum(char *str, int length, bool *warn);
 207
 208 /*
 209  * seg_init: Initialise the segment-number allocator.
 210  * seg_alloc: allocate a hitherto unused segment number.
 211  */
 212 void seg_init(void);
 213 int32_t seg_alloc(void);
 214
 215 /*
 216  * many output formats will be able to make use of this: a standard
 217  * function to add an extension to the name of the input file
 218  */
 219 void standard_extension(char *inname, char *outname, char *extension);
 220
 221 /*
 222  * Utility macros...
 223  *
 224  * This is a useful #define which I keep meaning to use more often:
 225  * the number of elements of a statically defined array.
 226  */
 227 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 228
 229 /*
 230  * List handling
 231  *
 232  *  list_for_each - regular iterator over list
 233  *  list_for_each_safe - the same but safe against list items removal
 234  *  list_last - find the last element in a list
 235  */
 236 #define list_for_each(pos, head)                        \
 237     for (pos = head; pos; pos = pos->next)
 238 #define list_for_each_safe(pos, n, head)                \
 239     for (pos = head, n = (pos ? pos->next : NULL); pos; \
 240         pos = n, n = (n ? n->next : NULL))
 241 #define list_last(pos, head)                            \
 242     for (pos = head; pos && pos->next; pos = pos->next) \
 243         ;
 244 #define list_reverse(head, prev, next)                  \
 245     do {                                                \
 246         if (!head || !head->next)                       \
 247             break;                                      \
 248         prev = NULL;                                    \
 249         while (head) {                                  \
 250             next = head->next;                          \
 251             head->next = prev;                          \
 252             prev = head;                                \
 253             head = next;                                \
 254         }                                               \
 255         head = prev;                                    \
 256     } while (0)
 257
 258 /*
 259  * Power of 2 align helpers
 260  */
 261 #undef ALIGN_MASK               /* Some BSD flavors define these in system headers */
 262 #undef ALIGN
 263 #define ALIGN_MASK(v, mask)     (((v) + (mask)) & ~(mask))
 264 #define ALIGN(v, a)             ALIGN_MASK(v, (a) - 1)
 265 #define IS_ALIGNED(v, a)        (((v) & ((a) - 1)) == 0)
 266
 267 /*
 268  * some handy macros that will probably be of use in more than one
 269  * output format: convert integers into little-endian byte packed
 270  * format in memory
 271  */
 272
 273 #if X86_MEMORY
 274
 275 #define WRITECHAR(p,v)                          \
 276     do {                                        \
 277         *(uint8_t *)(p) = (v);                  \
 278         (p) += 1;                               \
 279     } while (0)
 280
 281 #define WRITESHORT(p,v)                         \
 282     do {                                        \
 283         *(uint16_t *)(p) = (v);                 \
 284         (p) += 2;                               \
 285     } while (0)
 286
 287 #define WRITELONG(p,v)                          \
 288     do {                                        \
 289         *(uint32_t *)(p) = (v);                 \
 290         (p) += 4;                               \
 291     } while (0)
 292
 293 #define WRITEDLONG(p,v)                         \
 294     do {                                        \
 295         *(uint64_t *)(p) = (v);                 \
 296         (p) += 8;                               \
 297     } while (0)
 298
 299 #define WRITEADDR(p,v,s)                        \
 300     do {                                        \
 301         uint64_t _wa_v = (v);                   \
 302         memcpy((p), &_wa_v, (s));               \
 303         (p) += (s);                             \
 304     } while (0)
 305
 306 #else /* !X86_MEMORY */
 307
 308 #define WRITECHAR(p,v)                          \
 309     do {                                        \
 310         uint8_t *_wc_p = (uint8_t *)(p);        \
 311         uint8_t _wc_v = (v);                    \
 312         _wc_p[0] = _wc_v;                       \
 313         (p) = (void *)(_wc_p + 1);              \
 314     } while (0)
 315
 316 #define WRITESHORT(p,v)                         \
 317     do {                                        \
 318         uint8_t *_ws_p = (uint8_t *)(p);        \
 319         uint16_t _ws_v = (v);                   \
 320         _ws_p[0] = _ws_v;                       \
 321         _ws_p[1] = _ws_v >> 8;                  \
 322         (p) = (void *)(_ws_p + 2);              \
 323     } while (0)
 324
 325 #define WRITELONG(p,v)                          \
 326     do {                                        \
 327         uint8_t *_wl_p = (uint8_t *)(p);        \
 328         uint32_t _wl_v = (v);                   \
 329         _wl_p[0] = _wl_v;                       \
 330         _wl_p[1] = _wl_v >> 8;                  \
 331         _wl_p[2] = _wl_v >> 16;                 \
 332         _wl_p[3] = _wl_v >> 24;                 \
 333         (p) = (void *)(_wl_p + 4);              \
 334     } while (0)
 335
 336 #define WRITEDLONG(p,v)                         \
 337     do {                                        \
 338         uint8_t *_wq_p = (uint8_t *)(p);        \
 339         uint64_t _wq_v = (v);                   \
 340         _wq_p[0] = _wq_v;                       \
 341         _wq_p[1] = _wq_v >> 8;                  \
 342         _wq_p[2] = _wq_v >> 16;                 \
 343         _wq_p[3] = _wq_v >> 24;                 \
 344         _wq_p[4] = _wq_v >> 32;                 \
 345         _wq_p[5] = _wq_v >> 40;                 \
 346         _wq_p[6] = _wq_v >> 48;                 \
 347         _wq_p[7] = _wq_v >> 56;                 \
 348         (p) = (void *)(_wq_p + 8);              \
 349     } while (0)
 350
 351 #define WRITEADDR(p,v,s)                        \
 352     do {                                        \
 353         int _wa_s = (s);                        \
 354         uint64_t _wa_v = (v);                   \
 355         while (_wa_s--) {                       \
 356             WRITECHAR(p,_wa_v);                 \
 357             _wa_v >>= 8;                        \
 358         }                                       \
 359     } while(0)
 360
 361 #endif
 362
 363 /*
 364  * and routines to do the same thing to a file
 365  */
 366 #define fwriteint8_t(d,f) putc(d,f)
 367 void fwriteint16_t(uint16_t data, FILE * fp);
 368 void fwriteint32_t(uint32_t data, FILE * fp);
 369 void fwriteint64_t(uint64_t data, FILE * fp);
 370 void fwriteaddr(uint64_t data, int size, FILE * fp);
 371
 372 /*
 373  * Binary search routine. Returns index into `array' of an entry
 374  * matching `string', or <0 if no match. `array' is taken to
 375  * contain `size' elements.
 376  *
 377  * bsi() is case sensitive, bsii() is case insensitive.
 378  */
 379 int bsi(const char *string, const char **array, int size);
 380 int bsii(const char *string, const char **array, int size);
 381
 382 char *src_set_fname(char *newname);
 383 int32_t src_set_linnum(int32_t newline);
 384 int32_t src_get_linnum(void);
 385 /*
 386  * src_get may be used if you simply want to know the source file and line.
 387  * It is also used if you maintain private status about the source location
 388  * It return 0 if the information was the same as the last time you
 389  * checked, -1 if the name changed and (new-old) if just the line changed.
 390  */
 391 int src_get(int32_t *xline, char **xname);
 392
 393 char *nasm_strcat(const char *one, const char *two);
 394
 395 char *nasm_skip_spaces(const char *p);
 396 char *nasm_skip_word(const char *p);
 397 char *nasm_zap_spaces_fwd(char *p);
 398 char *nasm_zap_spaces_rev(char *p);
 399 char *nasm_trim_spaces(char *p);
 400 char *nasm_get_word(char *p, char **tail);
 401 char *nasm_opt_val(char *p, char **opt, char **val);
 402
 403 /*
 404  * Converts a relative pathname rel_path into an absolute path name.
 405  *
 406  * The buffer returned must be freed by the caller
 407  */
 408 char *nasm_realpath(const char *rel_path);
 409
 410 const char *prefix_name(int);
 411
 412 #define ZERO_BUF_SIZE 4096
 413 extern const uint8_t zero_buffer[ZERO_BUF_SIZE];
 414 void fwritezero(size_t bytes, FILE *fp);
 415
 416 static inline bool overflow_general(int64_t value, int bytes)
 417 {
 418     int sbit;
 419     int64_t vmax, vmin;
 420
 421     if (bytes >= 8)
 422         return false;
 423
 424     sbit = (bytes << 3) - 1;
 425     vmax =  ((int64_t)2 << sbit) - 1;
 426     vmin = -((int64_t)1 << sbit);
 427
 428     return value < vmin || value > vmax;
 429 }
 430
 431 static inline bool overflow_signed(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)1 << sbit) - 1;
 441     vmin = -((int64_t)1 << sbit);
 442
 443     return value < vmin || value > vmax;
 444 }
 445
 446 static inline bool overflow_unsigned(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)2 << sbit) - 1;
 456     vmin = 0;
 457
 458     return value < vmin || value > vmax;
 459 }
 460
 461 static inline int64_t signed_bits(int64_t value, int bits)
 462 {
 463     if (bits < 64) {
 464         value &= ((int64_t)1 << bits) - 1;
 465         if (value & (int64_t)1 << (bits - 1))
 466             value |= (int64_t)((uint64_t)-1 << bits);
 467     }
 468     return value;
 469 }
 470
 471 int idata_bytes(int opcode);
 472
 473 /* check if value is power of 2 */
 474 #define is_power2(v)   ((v) && ((v) & ((v) - 1)) == 0)
 475
 476 /*
 477  * floor(log2(v))
 478  */
 479 int ilog2_32(uint32_t v);
 480 int ilog2_64(uint64_t v);
 481
 482 /*
 483  * v == 0 ? 0 : is_power2(x) ? ilog2_X(v) : -1
 484  */
 485 int alignlog2_32(uint32_t v);
 486 int alignlog2_64(uint64_t v);
 487
 488 #endif