nasmlib.h

   1 /* nasmlib.h    header file for nasmlib.c
   2  *
   3  * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
   4  * Julian Hall. All rights reserved. The software is
   5  * redistributable under the license given in the file "LICENSE"
   6  * distributed in the NASM archive.
   7  */
   8
   9 #ifndef NASM_NASMLIB_H
  10 #define NASM_NASMLIB_H
  11
  12 #include "compiler.h"
  13
  14 #include <inttypes.h>
  15 #include <stdio.h>
  16 #include <string.h>
  17 #ifdef HAVE_STRINGS_H
  18 #include <strings.h>
  19 #endif
  20
  21 /*
  22  * tolower table -- avoids a function call on some platforms.
  23  * NOTE: unlike the tolower() function in ctype, EOF is *NOT*
  24  * a permitted value, for obvious reasons.
  25  */
  26 void tolower_init(void);
  27 extern unsigned char nasm_tolower_tab[256];
  28 #define nasm_tolower(x) nasm_tolower_tab[(unsigned char)(x)]
  29
  30 /* Wrappers around <ctype.h> functions */
  31 /* These are only valid for values that cannot include EOF */
  32 #define nasm_isspace(x)  isspace((unsigned char)(x))
  33 #define nasm_isalpha(x)  isalpha((unsigned char)(x))
  34 #define nasm_isdigit(x)  isdigit((unsigned char)(x))
  35 #define nasm_isalnum(x)  isalnum((unsigned char)(x))
  36 #define nasm_isxdigit(x) isxdigit((unsigned char)(x))
  37
  38 /*
  39  * If this is defined, the wrappers around malloc et al will
  40  * transform into logging variants, which will cause NASM to create
  41  * a file called `malloc.log' when run, and spew details of all its
  42  * memory management into that. That can then be analysed to detect
  43  * memory leaks and potentially other problems too.
  44  */
  45 /* #define LOGALLOC */
  46
  47 /*
  48  * -------------------------
  49  * Error reporting functions
  50  * -------------------------
  51  */
  52
  53 /*
  54  * An error reporting function should look like this.
  55  */
  56 typedef void (*efunc) (int severity, const char *fmt, ...);
  57 extern efunc nasm_malloc_error;
  58
  59 /*
  60  * These are the error severity codes which get passed as the first
  61  * argument to an efunc.
  62  */
  63
  64 #define ERR_DEBUG       0x00000008      /* put out debugging message */
  65 #define ERR_WARNING     0x00000000      /* warn only: no further action */
  66 #define ERR_NONFATAL    0x00000001      /* terminate assembly after phase */
  67 #define ERR_FATAL       0x00000002      /* instantly fatal: exit with error */
  68 #define ERR_PANIC       0x00000003      /* internal error: panic instantly
  69                                          * and dump core for reference */
  70 #define ERR_MASK        0x0000000F      /* mask off the above codes */
  71 #define ERR_NOFILE      0x00000010      /* don't give source file name/line */
  72 #define ERR_USAGE       0x00000020      /* print a usage message */
  73 #define ERR_PASS1       0x00000040      /* only print this error on pass one */
  74 #define ERR_NO_SEVERITY 0x00000080      /* suppress printing severity */
  75
  76 /*
  77  * These codes define specific types of suppressible warning.
  78  */
  79
  80 #define ERR_WARN_MASK   0x0000FF00      /* the mask for this feature */
  81 #define ERR_WARN_SHR    8               /* how far to shift right */
  82
  83 #define WARN(x) ((x) << ERR_WARN_SHR)
  84
  85 #define ERR_WARN_MNP            WARN( 1) /* macro-num-parameters warning */
  86 #define ERR_WARN_MSR            WARN( 2) /* macro self-reference */
  87 #define ERR_WARN_MDP            WARN( 3) /* macro default parameters check */
  88 #define ERR_WARN_OL             WARN( 4) /* orphan label (no colon, and
  89                                           * alone on line) */
  90 #define ERR_WARN_NOV            WARN( 5) /* numeric overflow */
  91 #define ERR_WARN_GNUELF         WARN( 6) /* using GNU ELF extensions */
  92 #define ERR_WARN_FL_OVERFLOW    WARN( 7) /* FP overflow */
  93 #define ERR_WARN_FL_DENORM      WARN( 8) /* FP denormal */
  94 #define ERR_WARN_FL_UNDERFLOW   WARN( 9) /* FP underflow */
  95 #define ERR_WARN_FL_TOOLONG     WARN(10) /* FP too many digits */
  96 #define ERR_WARN_USER           WARN(11) /* %warning directives */
  97 #define ERR_WARN_MAX            11       /* the highest numbered one */
  98
  99 /*
 100  * Wrappers around malloc, realloc and free. nasm_malloc will
 101  * fatal-error and die rather than return NULL; nasm_realloc will
 102  * do likewise, and will also guarantee to work right on being
 103  * passed a NULL pointer; nasm_free will do nothing if it is passed
 104  * a NULL pointer.
 105  */
 106 void nasm_set_malloc_error(efunc);
 107 #ifndef LOGALLOC
 108 void *nasm_malloc(size_t);
 109 void *nasm_zalloc(size_t);
 110 void *nasm_realloc(void *, size_t);
 111 void nasm_free(void *);
 112 char *nasm_strdup(const char *);
 113 char *nasm_strndup(char *, size_t);
 114 #else
 115 void *nasm_malloc_log(char *, int, size_t);
 116 void *nasm_zalloc_log(char *, int, size_t);
 117 void *nasm_realloc_log(char *, int, void *, size_t);
 118 void nasm_free_log(char *, int, void *);
 119 char *nasm_strdup_log(char *, int, const char *);
 120 char *nasm_strndup_log(char *, int, char *, size_t);
 121 #define nasm_malloc(x) nasm_malloc_log(__FILE__,__LINE__,x)
 122 #define nasm_zalloc(x) nasm_zalloc_log(__FILE__,__LINE__,x)
 123 #define nasm_realloc(x,y) nasm_realloc_log(__FILE__,__LINE__,x,y)
 124 #define nasm_free(x) nasm_free_log(__FILE__,__LINE__,x)
 125 #define nasm_strdup(x) nasm_strdup_log(__FILE__,__LINE__,x)
 126 #define nasm_strndup(x,y) nasm_strndup_log(__FILE__,__LINE__,x,y)
 127 #endif
 128
 129 /*
 130  * ANSI doesn't guarantee the presence of `stricmp' or
 131  * `strcasecmp'.
 132  */
 133 #if defined(HAVE_STRCASECMP)
 134 #define nasm_stricmp strcasecmp
 135 #elif defined(HAVE_STRICMP)
 136 #define nasm_stricmp stricmp
 137 #else
 138 int nasm_stricmp(const char *, const char *);
 139 #endif
 140
 141 #if defined(HAVE_STRNCASECMP)
 142 #define nasm_strnicmp strncasecmp
 143 #elif defined(HAVE_STRNICMP)
 144 #define nasm_strnicmp strnicmp
 145 #else
 146 int nasm_strnicmp(const char *, const char *, size_t);
 147 #endif
 148
 149 int nasm_memicmp(const char *, const char *, size_t);
 150
 151 #if defined(HAVE_STRSEP)
 152 #define nasm_strsep strsep
 153 #else
 154 char *nasm_strsep(char **stringp, const char *delim);
 155 #endif
 156
 157
 158 /*
 159  * Convert a string into a number, using NASM number rules. Sets
 160  * `*error' to true if an error occurs, and false otherwise.
 161  */
 162 int64_t readnum(char *str, bool *error);
 163
 164 /*
 165  * Convert a character constant into a number. Sets
 166  * `*warn' to true if an overflow occurs, and false otherwise.
 167  * str points to and length covers the middle of the string,
 168  * without the quotes.
 169  */
 170 int64_t readstrnum(char *str, int length, bool *warn);
 171
 172 /*
 173  * seg_init: Initialise the segment-number allocator.
 174  * seg_alloc: allocate a hitherto unused segment number.
 175  */
 176 void seg_init(void);
 177 int32_t seg_alloc(void);
 178
 179 /*
 180  * many output formats will be able to make use of this: a standard
 181  * function to add an extension to the name of the input file
 182  */
 183 #ifdef NASM_NASM_H
 184 void standard_extension(char *inname, char *outname, char *extension,
 185                         efunc error);
 186 #endif
 187
 188 /*
 189  * Utility macros...
 190  *
 191  * This is a useful #define which I keep meaning to use more often:
 192  * the number of elements of a statically defined array.
 193  */
 194
 195 #define elements(x)     ( sizeof(x) / sizeof(*(x)) )
 196
 197 /*
 198  * some handy macros that will probably be of use in more than one
 199  * output format: convert integers into little-endian byte packed
 200  * format in memory
 201  */
 202
 203 #if X86_MEMORY
 204
 205 #define WRITECHAR(p,v)                          \
 206     do {                                        \
 207         *(uint8_t *)(p) = (v);                  \
 208         (p) += 1;                               \
 209     } while (0)
 210
 211 #define WRITESHORT(p,v)                         \
 212     do {                                        \
 213         *(uint16_t *)(p) = (v);                 \
 214         (p) += 2;                               \
 215     } while (0)
 216
 217 #define WRITELONG(p,v)                          \
 218     do {                                        \
 219         *(uint32_t *)(p) = (v);                 \
 220         (p) += 4;                               \
 221     } while (0)
 222
 223 #define WRITEDLONG(p,v)                         \
 224     do {                                        \
 225         *(uint64_t *)(p) = (v);                 \
 226         (p) += 8;                               \
 227     } while (0)
 228
 229 #define WRITEADDR(p,v,s)                        \
 230     do {                                        \
 231         uint64_t _wa_v = (v);                   \
 232         memcpy((p), &_wa_v, (s));               \
 233         (p) += (s);                             \
 234     } while (0)
 235
 236 #else /* !X86_MEMORY */
 237
 238 #define WRITECHAR(p,v)                          \
 239     do {                                        \
 240         uint8_t *_wc_p = (uint8_t *)(p);        \
 241         uint8_t _wc_v = (v);                    \
 242         _wc_p[0] = _wc_v;                       \
 243         (p) = (void *)(_wc_p + 1);              \
 244     } while (0)
 245
 246 #define WRITESHORT(p,v)                         \
 247     do {                                        \
 248         uint8_t *_ws_p = (uint8_t *)(p);        \
 249         uint16_t _ws_v = (v);                   \
 250         _ws_p[0] = _ws_v;                       \
 251         _ws_p[1] = _ws_v >> 8;                  \
 252         (p) = (void *)(_ws_p + 2);              \
 253     } while (0)
 254
 255 #define WRITELONG(p,v)                          \
 256     do {                                        \
 257         uint8_t *_wl_p = (uint8_t *)(p);        \
 258         uint32_t _wl_v = (v);                   \
 259         _wl_p[0] = _wl_v;                       \
 260         _wl_p[1] = _wl_v >> 8;                  \
 261         _wl_p[2] = _wl_v >> 16;                 \
 262         _wl_p[3] = _wl_v >> 24;                 \
 263         (p) = (void *)(_wl_p + 4);              \
 264     } while (0)
 265
 266 #define WRITEDLONG(p,v)                         \
 267     do {                                        \
 268         uint8_t *_wq_p = (uint8_t *)(p);        \
 269         uint64_t _wq_v = (v);                   \
 270         _wq_p[0] = _wq_v;                       \
 271         _wq_p[1] = _wq_v >> 8;                  \
 272         _wq_p[2] = _wq_v >> 16;                 \
 273         _wq_p[3] = _wq_v >> 24;                 \
 274         _wq_p[4] = _wq_v >> 32;                 \
 275         _wq_p[5] = _wq_v >> 40;                 \
 276         _wq_p[6] = _wq_v >> 48;                 \
 277         _wq_p[7] = _wq_v >> 56;                 \
 278         (p) = (void *)(_wq_p + 8);              \
 279     } while (0)
 280
 281 #define WRITEADDR(p,v,s)                        \
 282     do {                                        \
 283         int _wa_s = (s);                        \
 284         uint64_t _wa_v = (v);                   \
 285         while (_wa_s--) {                       \
 286             WRITECHAR(p,_wa_v);                 \
 287             _wa_v >>= 8;                        \
 288         }                                       \
 289     } while(0)
 290
 291 #endif
 292
 293 /*
 294  * and routines to do the same thing to a file
 295  */
 296 #define fwriteint8_t(d,f) putc(d,f)
 297 void fwriteint16_t(uint16_t data, FILE * fp);
 298 void fwriteint32_t(uint32_t data, FILE * fp);
 299 void fwriteint64_t(uint64_t data, FILE * fp);
 300 void fwriteaddr(uint64_t data, int size, FILE * fp);
 301
 302 /*
 303  * Binary search routine. Returns index into `array' of an entry
 304  * matching `string', or <0 if no match. `array' is taken to
 305  * contain `size' elements.
 306  *
 307  * bsi() is case sensitive, bsii() is case insensitive.
 308  */
 309 int bsi(const char *string, const char **array, int size);
 310 int bsii(const char *string, const char **array, int size);
 311
 312 char *src_set_fname(char *newname);
 313 int32_t src_set_linnum(int32_t newline);
 314 int32_t src_get_linnum(void);
 315 /*
 316  * src_get may be used if you simply want to know the source file and line.
 317  * It is also used if you maintain private status about the source location
 318  * It return 0 if the information was the same as the last time you
 319  * checked, -1 if the name changed and (new-old) if just the line changed.
 320  */
 321 int src_get(int32_t *xline, char **xname);
 322
 323 char *nasm_strcat(char *one, char *two);
 324
 325 void null_debug_routine(const char *directive, const char *params);
 326 extern struct dfmt null_debug_form;
 327 extern struct dfmt *null_debug_arr[2];
 328
 329 const char *prefix_name(int);
 330
 331 #endif