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  * If this is defined, the wrappers around malloc et al will
  23  * transform into logging variants, which will cause NASM to create
  24  * a file called `malloc.log' when run, and spew details of all its
  25  * memory management into that. That can then be analysed to detect
  26  * memory leaks and potentially other problems too.
  27  */
  28 /* #define LOGALLOC */
  29
  30 /*
  31  * -------------------------
  32  * Error reporting functions
  33  * -------------------------
  34  */
  35
  36 /*
  37  * An error reporting function should look like this.
  38  */
  39 typedef void (*efunc) (int severity, const char *fmt, ...);
  40
  41 /*
  42  * These are the error severity codes which get passed as the first
  43  * argument to an efunc.
  44  */
  45
  46 #define ERR_DEBUG       0x00000008      /* put out debugging message */
  47 #define ERR_WARNING     0x00000000      /* warn only: no further action */
  48 #define ERR_NONFATAL    0x00000001      /* terminate assembly after phase */
  49 #define ERR_FATAL       0x00000002      /* instantly fatal: exit with error */
  50 #define ERR_PANIC       0x00000003      /* internal error: panic instantly
  51                                          * and dump core for reference */
  52 #define ERR_MASK        0x0000000F      /* mask off the above codes */
  53 #define ERR_NOFILE      0x00000010      /* don't give source file name/line */
  54 #define ERR_USAGE       0x00000020      /* print a usage message */
  55 #define ERR_PASS1       0x00000040      /* only print this error on pass one */
  56
  57 /*
  58  * These codes define specific types of suppressible warning.
  59  */
  60
  61 #define ERR_WARN_MASK   0x0000FF00      /* the mask for this feature */
  62 #define ERR_WARN_SHR  8                 /* how far to shift right */
  63
  64 #define WARN(x) ((x) << ERR_WARN_SHR)
  65
  66 #define ERR_WARN_MNP            WARN(1) /* macro-num-parameters warning */
  67 #define ERR_WARN_MSR            WARN(2) /* macro self-reference */
  68 #define ERR_WARN_OL             WARN(3) /* orphan label (no colon, and
  69                                          * alone on line) */
  70 #define ERR_WARN_NOV            WARN(4) /* numeric overflow */
  71 #define ERR_WARN_GNUELF         WARN(5) /* using GNU ELF extensions */
  72 #define ERR_WARN_FL_OVERFLOW    WARN(6) /* FP overflow */
  73 #define ERR_WARN_FL_DENORM      WARN(7) /* FP denormal */
  74 #define ERR_WARN_FL_UNDERFLOW   WARN(8) /* FP underflow */
  75 #define ERR_WARN_FL_TOOLONG     WARN(9) /* FP too many digits */
  76 #define ERR_WARN_MAX    9               /* the highest numbered one */
  77
  78 /*
  79  * Wrappers around malloc, realloc and free. nasm_malloc will
  80  * fatal-error and die rather than return NULL; nasm_realloc will
  81  * do likewise, and will also guarantee to work right on being
  82  * passed a NULL pointer; nasm_free will do nothing if it is passed
  83  * a NULL pointer.
  84  */
  85 void nasm_set_malloc_error(efunc);
  86 #ifndef LOGALLOC
  87 void *nasm_malloc(size_t);
  88 void *nasm_zalloc(size_t);
  89 void *nasm_realloc(void *, size_t);
  90 void nasm_free(void *);
  91 char *nasm_strdup(const char *);
  92 char *nasm_strndup(char *, size_t);
  93 #else
  94 void *nasm_malloc_log(char *, int, size_t);
  95 void *nasm_zalloc_log(char *, int, size_t);
  96 void *nasm_realloc_log(char *, int, void *, size_t);
  97 void nasm_free_log(char *, int, void *);
  98 char *nasm_strdup_log(char *, int, const char *);
  99 char *nasm_strndup_log(char *, int, char *, size_t);
 100 #define nasm_malloc(x) nasm_malloc_log(__FILE__,__LINE__,x)
 101 #define nasm_zalloc(x) nasm_zalloc_log(__FILE__,__LINE__,x)
 102 #define nasm_realloc(x,y) nasm_realloc_log(__FILE__,__LINE__,x,y)
 103 #define nasm_free(x) nasm_free_log(__FILE__,__LINE__,x)
 104 #define nasm_strdup(x) nasm_strdup_log(__FILE__,__LINE__,x)
 105 #define nasm_strndup(x,y) nasm_strndup_log(__FILE__,__LINE__,x,y)
 106 #endif
 107
 108 /*
 109  * ANSI doesn't guarantee the presence of `stricmp' or
 110  * `strcasecmp'.
 111  */
 112 #if defined(HAVE_STRCASECMP)
 113 #define nasm_stricmp strcasecmp
 114 #elif defined(HAVE_STRICMP)
 115 #define nasm_stricmp stricmp
 116 #else
 117 int nasm_stricmp(const char *, const char *);
 118 #endif
 119
 120 #if defined(HAVE_STRNCASECMP)
 121 #define nasm_strnicmp strncasecmp
 122 #elif defined(HAVE_STRNICMP)
 123 #define nasm_strnicmp strnicmp
 124 #else
 125 int nasm_strnicmp(const char *, const char *, int);
 126 #endif
 127
 128 #if defined(HAVE_STRSEP)
 129 #define nasm_strsep strsep
 130 #else
 131 char *nasm_strsep(char **stringp, const char *delim);
 132 #endif
 133
 134
 135 /*
 136  * Convert a string into a number, using NASM number rules. Sets
 137  * `*error' to true if an error occurs, and false otherwise.
 138  */
 139 int64_t readnum(char *str, bool *error);
 140
 141 /*
 142  * Convert a character constant into a number. Sets
 143  * `*warn' to true if an overflow occurs, and false otherwise.
 144  * str points to and length covers the middle of the string,
 145  * without the quotes.
 146  */
 147 int64_t readstrnum(char *str, int length, bool *warn);
 148
 149 /*
 150  * seg_init: Initialise the segment-number allocator.
 151  * seg_alloc: allocate a hitherto unused segment number.
 152  */
 153 void seg_init(void);
 154 int32_t seg_alloc(void);
 155
 156 /*
 157  * many output formats will be able to make use of this: a standard
 158  * function to add an extension to the name of the input file
 159  */
 160 #ifdef NASM_NASM_H
 161 void standard_extension(char *inname, char *outname, char *extension,
 162                         efunc error);
 163 #endif
 164
 165 /*
 166  * Utility macros...
 167  *
 168  * This is a useful #define which I keep meaning to use more often:
 169  * the number of elements of a statically defined array.
 170  */
 171
 172 #define elements(x)     ( sizeof(x) / sizeof(*(x)) )
 173
 174
 175 /*
 176  * some handy macros that will probably be of use in more than one
 177  * output format: convert integers into little-endian byte packed
 178  * format in memory
 179  */
 180
 181 #if X86_MEMORY
 182
 183 #define WRITECHAR(p,v)                          \
 184     do {                                        \
 185         *(uint8_t *)(p) = (v);                  \
 186         (p) += 1;                               \
 187     } while (0)
 188
 189 #define WRITESHORT(p,v)                         \
 190     do {                                        \
 191         *(uint16_t *)(p) = (v);                 \
 192         (p) += 2;                               \
 193     } while (0)
 194
 195 #define WRITELONG(p,v)                          \
 196     do {                                        \
 197         *(uint32_t *)(p) = (v);                 \
 198         (p) += 4;                               \
 199     } while (0)
 200
 201 #define WRITEDLONG(p,v)                         \
 202     do {                                        \
 203         *(uint64_t *)(p) = (v);                 \
 204         (p) += 8;                               \
 205     } while (0)
 206
 207 #define WRITEADDR(p,v,s)                        \
 208     do {                                        \
 209         uint64_t _wa_v = (v);                   \
 210         memcpy((p), &_wa_v, (s));               \
 211         (p) += (s);                             \
 212     } while (0)
 213
 214 #else /* !X86_MEMORY */
 215
 216 #define WRITECHAR(p,v)                          \
 217     do {                                        \
 218         uint8_t *_wc_p = (uint8_t *)(p);        \
 219         uint8_t _wc_v = (v);                    \
 220         _wc_p[0] = _wc_v;                       \
 221         (p) = (void *)(_wc_p + 1);              \
 222     } while (0)
 223
 224 #define WRITESHORT(p,v)                         \
 225     do {                                        \
 226         uint8_t *_ws_p = (uint8_t *)(p);        \
 227         uint16_t _ws_v = (v);                   \
 228         _ws_p[0] = _ws_v;                       \
 229         _ws_p[1] = _ws_v >> 8;                  \
 230         (p) = (void *)(_ws_p + 2);              \
 231     } while (0)
 232
 233 #define WRITELONG(p,v)                          \
 234     do {                                        \
 235         uint8_t *_wl_p = (uint8_t *)(p);        \
 236         uint32_t _wl_v = (v);                   \
 237         _wl_p[0] = _wl_v;                       \
 238         _wl_p[1] = _wl_v >> 8;                  \
 239         _wl_p[2] = _wl_v >> 16;                 \
 240         _wl_p[3] = _wl_v >> 24;                 \
 241         (p) = (void *)(_wl_p + 4);              \
 242     } while (0)
 243
 244 #define WRITEDLONG(p,v)                         \
 245     do {                                        \
 246         uint8_t *_wq_p = (uint8_t *)(p);        \
 247         uint64_t _wq_v = (v);                   \
 248         _wq_p[0] = _wq_v;                       \
 249         _wq_p[1] = _wq_v >> 8;                  \
 250         _wq_p[2] = _wq_v >> 16;                 \
 251         _wq_p[3] = _wq_v >> 24;                 \
 252         _wq_p[4] = _wq_v >> 32;                 \
 253         _wq_p[5] = _wq_v >> 40;                 \
 254         _wq_p[6] = _wq_v >> 48;                 \
 255         _wq_p[7] = _wq_v >> 56;                 \
 256         (p) = (void *)(_wq_p + 8);              \
 257     } while (0)
 258
 259 #define WRITEADDR(p,v,s)                        \
 260     do {                                        \
 261         int _wa_s = (s);                        \
 262         uint64_t _wa_v = (v);                   \
 263         while (_wa_s--) {                       \
 264             WRITECHAR(p,_wa_v);                 \
 265             _wa_v >>= 8;                        \
 266         }                                       \
 267     } while(0)
 268
 269 #endif
 270
 271 /*
 272  * and routines to do the same thing to a file
 273  */
 274 #define fwriteint8_t(d,f) putc(d,f)
 275 void fwriteint16_t(uint16_t data, FILE * fp);
 276 void fwriteint32_t(uint32_t data, FILE * fp);
 277 void fwriteint64_t(uint64_t data, FILE * fp);
 278 void fwriteaddr(uint64_t data, int size, FILE * fp);
 279
 280 /*
 281  * Routines to manage a dynamic random access array of int64_ts which
 282  * may grow in size to be more than the largest single malloc'able
 283  * chunk.
 284  */
 285
 286 #define RAA_BLKSHIFT    15      /* 2**this many longs allocated at once */
 287 #define RAA_BLKSIZE     (1 << RAA_BLKSHIFT)
 288 #define RAA_LAYERSHIFT  15      /* 2**this many _pointers_ allocated */
 289 #define RAA_LAYERSIZE   (1 << RAA_LAYERSHIFT)
 290
 291 typedef struct RAA RAA;
 292 typedef union RAA_UNION RAA_UNION;
 293 typedef struct RAA_LEAF RAA_LEAF;
 294 typedef struct RAA_BRANCH RAA_BRANCH;
 295
 296 struct RAA {
 297     /*
 298      * Number of layers below this one to get to the real data. 0
 299      * means this structure is a leaf, holding RAA_BLKSIZE real
 300      * data items; 1 and above mean it's a branch, holding
 301      * RAA_LAYERSIZE pointers to the next level branch or leaf
 302      * structures.
 303      */
 304     int layers;
 305
 306     /*
 307      * Number of real data items spanned by one position in the
 308      * `data' array at this level. This number is 0 trivially, for
 309      * a leaf (level 0): for a level 1 branch it should be
 310      * RAA_BLKSHIFT, and for a level 2 branch it's
 311      * RAA_LAYERSHIFT+RAA_BLKSHIFT.
 312      */
 313     int shift;
 314
 315     union RAA_UNION {
 316         struct RAA_LEAF {
 317             int64_t data[RAA_BLKSIZE];
 318         } l;
 319         struct RAA_BRANCH {
 320             struct RAA *data[RAA_LAYERSIZE];
 321         } b;
 322     } u;
 323 };
 324
 325 struct RAA *raa_init(void);
 326 void raa_free(struct RAA *);
 327 int64_t raa_read(struct RAA *, int32_t);
 328 struct RAA *raa_write(struct RAA *r, int32_t posn, int64_t value);
 329
 330 /*
 331  * Routines to manage a dynamic sequential-access array, under the
 332  * same restriction on maximum mallocable block. This array may be
 333  * written to in two ways: a contiguous chunk can be reserved of a
 334  * given size with a pointer returned OR single-byte data may be
 335  * written. The array can also be read back in the same two ways:
 336  * as a series of big byte-data blocks or as a list of structures
 337  * of a given size.
 338  */
 339
 340 struct SAA {
 341     /*
 342      * members `end' and `elem_len' are only valid in first link in
 343      * list; `rptr' and `rpos' are used for reading
 344      */
 345     size_t elem_len;            /* Size of each element */
 346     size_t blk_len;             /* Size of each allocation block */
 347     size_t nblks;               /* Total number of allocated blocks */
 348     size_t nblkptrs;            /* Total number of allocation block pointers */
 349     size_t length;              /* Total allocated length of the array */
 350     size_t datalen;             /* Total data length of the array */
 351     char **wblk;                /* Write block pointer */
 352     size_t wpos;                /* Write position inside block */
 353     size_t wptr;                /* Absolute write position */
 354     char **rblk;                /* Read block pointer */
 355     size_t rpos;                /* Read position inside block */
 356     size_t rptr;                /* Absolute read position */
 357     char **blk_ptrs;            /* Pointer to pointer blocks */
 358 };
 359
 360 struct SAA *saa_init(size_t elem_len);    /* 1 == byte */
 361 void saa_free(struct SAA *);
 362 void *saa_wstruct(struct SAA *);        /* return a structure of elem_len */
 363 void saa_wbytes(struct SAA *, const void *, size_t);      /* write arbitrary bytes */
 364 void saa_wleb128u(struct SAA *, int); /* write unsigned LEB128 value */
 365 void saa_wleb128s(struct SAA *, int); /* write signed LEB128 value */
 366 void saa_rewind(struct SAA *);  /* for reading from beginning */
 367 void *saa_rstruct(struct SAA *);        /* return NULL on EOA */
 368 const void *saa_rbytes(struct SAA *, size_t *); /* return 0 on EOA */
 369 void saa_rnbytes(struct SAA *, void *, size_t);   /* read a given no. of bytes */
 370 /* random access */
 371 void saa_fread(struct SAA *, size_t, void *, size_t);
 372 void saa_fwrite(struct SAA *, size_t, const void *, size_t);
 373
 374 /* dump to file */
 375 void saa_fpwrite(struct SAA *, FILE *);
 376
 377 /*
 378  * Binary search routine. Returns index into `array' of an entry
 379  * matching `string', or <0 if no match. `array' is taken to
 380  * contain `size' elements.
 381  *
 382  * bsi() is case sensitive, bsii() is case insensitive.
 383  */
 384 int bsi(const char *string, const char **array, int size);
 385 int bsii(const char *string, const char **array, int size);
 386
 387 char *src_set_fname(char *newname);
 388 int32_t src_set_linnum(int32_t newline);
 389 int32_t src_get_linnum(void);
 390 /*
 391  * src_get may be used if you simply want to know the source file and line.
 392  * It is also used if you maintain private status about the source location
 393  * It return 0 if the information was the same as the last time you
 394  * checked, -1 if the name changed and (new-old) if just the line changed.
 395  */
 396 int src_get(int32_t *xline, char **xname);
 397
 398 void nasm_quote(char **str);
 399 char *nasm_strcat(char *one, char *two);
 400
 401 void null_debug_routine(const char *directive, const char *params);
 402 extern struct dfmt null_debug_form;
 403 extern struct dfmt *null_debug_arr[2];
 404
 405 const char *prefix_name(int);
 406
 407 #endif