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