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