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 licence given in the file "Licence"
   6  * distributed in the NASM archive.
   7  */
   8
   9 #ifndef NASM_NASMLIB_H
  10 #define NASM_NASMLIB_H
  11
  12 #include <inttypes.h>
  13 #include <stdio.h>
  14 #include "compiler.h"
  15
  16 /*
  17  * If this is defined, the wrappers around malloc et al will
  18  * transform into logging variants, which will cause NASM to create
  19  * a file called `malloc.log' when run, and spew details of all its
  20  * memory management into that. That can then be analysed to detect
  21  * memory leaks and potentially other problems too.
  22  */
  23 /* #define LOGALLOC */
  24
  25 /*
  26  * -------------------------
  27  * Error reporting functions
  28  * -------------------------
  29  */
  30
  31 /*
  32  * An error reporting function should look like this.
  33  */
  34 typedef void (*efunc) (int severity, const char *fmt, ...);
  35
  36 /*
  37  * These are the error severity codes which get passed as the first
  38  * argument to an efunc.
  39  */
  40
  41 #define ERR_DEBUG       0x00000008      /* put out debugging message */
  42 #define ERR_WARNING     0x00000000      /* warn only: no further action */
  43 #define ERR_NONFATAL    0x00000001      /* terminate assembly after phase */
  44 #define ERR_FATAL       0x00000002      /* instantly fatal: exit with error */
  45 #define ERR_PANIC       0x00000003      /* internal error: panic instantly
  46                                          * and dump core for reference */
  47 #define ERR_MASK        0x0000000F      /* mask off the above codes */
  48 #define ERR_NOFILE      0x00000010      /* don't give source file name/line */
  49 #define ERR_USAGE       0x00000020      /* print a usage message */
  50 #define ERR_PASS1       0x00000040      /* only print this error on pass one */
  51
  52 /*
  53  * These codes define specific types of suppressible warning.
  54  */
  55
  56 #define ERR_WARN_MASK   0x0000FF00      /* the mask for this feature */
  57 #define ERR_WARN_SHR  8         /* how far to shift right */
  58
  59 #define ERR_WARN_MNP    0x00000100      /* macro-num-parameters warning */
  60 #define ERR_WARN_MSR    0x00000200      /* macro self-reference */
  61 #define ERR_WARN_OL     0x00000300      /* orphan label (no colon, and
  62                                          * alone on line) */
  63 #define ERR_WARN_NOV    0x00000400      /* numeric overflow */
  64 #define ERR_WARN_GNUELF 0x00000500      /* using GNU ELF extensions */
  65 #define ERR_WARN_MAX    5       /* the highest numbered one */
  66
  67 /*
  68  * Wrappers around malloc, realloc and free. nasm_malloc will
  69  * fatal-error and die rather than return NULL; nasm_realloc will
  70  * do likewise, and will also guarantee to work right on being
  71  * passed a NULL pointer; nasm_free will do nothing if it is passed
  72  * a NULL pointer.
  73  */
  74 void nasm_set_malloc_error(efunc);
  75 #ifndef LOGALLOC
  76 void *nasm_malloc(size_t);
  77 void *nasm_zalloc(size_t);
  78 void *nasm_realloc(void *, size_t);
  79 void nasm_free(void *);
  80 char *nasm_strdup(const char *);
  81 char *nasm_strndup(char *, size_t);
  82 #else
  83 void *nasm_malloc_log(char *, int, size_t);
  84 void *nasm_zalloc_log(char *, int, size_t);
  85 void *nasm_realloc_log(char *, int, void *, size_t);
  86 void nasm_free_log(char *, int, void *);
  87 char *nasm_strdup_log(char *, int, const char *);
  88 char *nasm_strndup_log(char *, int, char *, size_t);
  89 #define nasm_malloc(x) nasm_malloc_log(__FILE__,__LINE__,x)
  90 #define nasm_zalloc(x) nasm_malloc_log(__FILE__,__LINE__,x)
  91 #define nasm_realloc(x,y) nasm_realloc_log(__FILE__,__LINE__,x,y)
  92 #define nasm_free(x) nasm_free_log(__FILE__,__LINE__,x)
  93 #define nasm_strdup(x) nasm_strdup_log(__FILE__,__LINE__,x)
  94 #define nasm_strndup(x,y) nasm_strndup_log(__FILE__,__LINE__,x,y)
  95 #endif
  96
  97 /*
  98  * ANSI doesn't guarantee the presence of `stricmp' or
  99  * `strcasecmp'.
 100  */
 101 #if defined(stricmp) || defined(strcasecmp)
 102 #if defined(stricmp)
 103 #define nasm_stricmp stricmp
 104 #else
 105 #define nasm_stricmp strcasecmp
 106 #endif
 107 #else
 108 int nasm_stricmp(const char *, const char *);
 109 #endif
 110
 111 #if defined(strnicmp) || defined(strncasecmp)
 112 #if defined(strnicmp)
 113 #define nasm_strnicmp strnicmp
 114 #else
 115 #define nasm_strnicmp strncasecmp
 116 #endif
 117 #else
 118 int nasm_strnicmp(const char *, const char *, int);
 119 #endif
 120
 121 #if defined(strsep)
 122 #define nasm_strsep strsep
 123 #else
 124 char *nasm_strsep(char **stringp, const char *delim);
 125 #endif
 126
 127
 128 /*
 129  * Convert a string into a number, using NASM number rules. Sets
 130  * `*error' to TRUE if an error occurs, and FALSE otherwise.
 131  */
 132 int64_t readnum(char *str, int *error);
 133
 134 /*
 135  * Convert a character constant into a number. Sets
 136  * `*warn' to TRUE if an overflow occurs, and FALSE otherwise.
 137  * str points to and length covers the middle of the string,
 138  * without the quotes.
 139  */
 140 int64_t readstrnum(char *str, int length, int *warn);
 141
 142 /*
 143  * seg_init: Initialise the segment-number allocator.
 144  * seg_alloc: allocate a hitherto unused segment number.
 145  */
 146 void seg_init(void);
 147 int32_t seg_alloc(void);
 148
 149 /*
 150  * many output formats will be able to make use of this: a standard
 151  * function to add an extension to the name of the input file
 152  */
 153 #ifdef NASM_NASM_H
 154 void standard_extension(char *inname, char *outname, char *extension,
 155                         efunc error);
 156 #endif
 157
 158 /*
 159  * some handy macros that will probably be of use in more than one
 160  * output format: convert integers into little-endian byte packed
 161  * format in memory
 162  */
 163
 164 #define WRITECHAR(p,v) \
 165   do { \
 166     *(p)++ = (v) & 0xFF; \
 167   } while (0)
 168
 169 #define WRITESHORT(p,v) \
 170   do { \
 171     WRITECHAR(p,v); \
 172     WRITECHAR(p,(v) >> 8); \
 173   } while (0)
 174
 175 #define WRITELONG(p,v) \
 176   do { \
 177     WRITECHAR(p,v); \
 178     WRITECHAR(p,(v) >> 8); \
 179     WRITECHAR(p,(v) >> 16); \
 180     WRITECHAR(p,(v) >> 24); \
 181   } while (0)
 182
 183 #define WRITEDLONG(p,v) \
 184   do { \
 185     WRITECHAR(p,v); \
 186     WRITECHAR(p,(v) >> 8); \
 187     WRITECHAR(p,(v) >> 16); \
 188     WRITECHAR(p,(v) >> 24); \
 189     WRITECHAR(p,(v) >> 32); \
 190     WRITECHAR(p,(v) >> 40); \
 191     WRITECHAR(p,(v) >> 48); \
 192     WRITECHAR(p,(v) >> 56); \
 193   } while (0)
 194
 195 /*
 196  * and routines to do the same thing to a file
 197  */
 198 void fwriteint16_t(int data, FILE * fp);
 199 void fwriteint32_t(int32_t data, FILE * fp);
 200 void fwriteint64_t(int64_t data, FILE * fp);
 201
 202 /*
 203  * Routines to manage a dynamic random access array of int32_ts which
 204  * may grow in size to be more than the largest single malloc'able
 205  * chunk.
 206  */
 207
 208 #define RAA_BLKSIZE 4096        /* this many longs allocated at once */
 209 #define RAA_LAYERSIZE 1024      /* this many _pointers_ allocated */
 210
 211 typedef struct RAA RAA;
 212 typedef union RAA_UNION RAA_UNION;
 213 typedef struct RAA_LEAF RAA_LEAF;
 214 typedef struct RAA_BRANCH RAA_BRANCH;
 215
 216 struct RAA {
 217     /*
 218      * Number of layers below this one to get to the real data. 0
 219      * means this structure is a leaf, holding RAA_BLKSIZE real
 220      * data items; 1 and above mean it's a branch, holding
 221      * RAA_LAYERSIZE pointers to the next level branch or leaf
 222      * structures.
 223      */
 224     int layers;
 225     /*
 226      * Number of real data items spanned by one position in the
 227      * `data' array at this level. This number is 1, trivially, for
 228      * a leaf (level 0): for a level 1 branch it should be
 229      * RAA_BLKSIZE, and for a level 2 branch it's
 230      * RAA_LAYERSIZE*RAA_BLKSIZE.
 231      */
 232     int32_t stepsize;
 233     union RAA_UNION {
 234         struct RAA_LEAF {
 235             int32_t data[RAA_BLKSIZE];
 236         } l;
 237         struct RAA_BRANCH {
 238             struct RAA *data[RAA_LAYERSIZE];
 239         } b;
 240     } u;
 241 };
 242
 243 struct RAA *raa_init(void);
 244 void raa_free(struct RAA *);
 245 int32_t raa_read(struct RAA *, int32_t);
 246 struct RAA *raa_write(struct RAA *r, int32_t posn, int32_t value);
 247
 248 /*
 249  * Routines to manage a dynamic sequential-access array, under the
 250  * same restriction on maximum mallocable block. This array may be
 251  * written to in two ways: a contiguous chunk can be reserved of a
 252  * given size with a pointer returned OR single-byte data may be
 253  * written. The array can also be read back in the same two ways:
 254  * as a series of big byte-data blocks or as a list of structures
 255  * of a given size.
 256  */
 257
 258 struct SAA {
 259     /*
 260      * members `end' and `elem_len' are only valid in first link in
 261      * list; `rptr' and `rpos' are used for reading
 262      */
 263     struct SAA *next, *end, *rptr;
 264     int32_t elem_len, length, posn, start, rpos;
 265     char *data;
 266 };
 267
 268 struct SAA *saa_init(int32_t elem_len);    /* 1 == byte */
 269 void saa_free(struct SAA *);
 270 void *saa_wstruct(struct SAA *);        /* return a structure of elem_len */
 271 void saa_wbytes(struct SAA *, const void *, int32_t);      /* write arbitrary bytes */
 272 void saa_rewind(struct SAA *);  /* for reading from beginning */
 273 void *saa_rstruct(struct SAA *);        /* return NULL on EOA */
 274 void *saa_rbytes(struct SAA *, int32_t *); /* return 0 on EOA */
 275 void saa_rnbytes(struct SAA *, void *, int32_t);   /* read a given no. of bytes */
 276 void saa_fread(struct SAA *s, int32_t posn, void *p, int32_t len);    /* fixup */
 277 void saa_fwrite(struct SAA *s, int32_t posn, void *p, int32_t len);   /* fixup */
 278 void saa_fpwrite(struct SAA *, FILE *);
 279
 280 /*
 281  * Binary search routine. Returns index into `array' of an entry
 282  * matching `string', or <0 if no match. `array' is taken to
 283  * contain `size' elements.
 284  *
 285  * bsi() is case sensitive, bsii() is case insensitive.
 286  */
 287 int bsi(char *string, const char **array, int size);
 288 int bsii(char *string, const char **array, int size);
 289
 290 char *src_set_fname(char *newname);
 291 int32_t src_set_linnum(int32_t newline);
 292 int32_t src_get_linnum(void);
 293 /*
 294  * src_get may be used if you simply want to know the source file and line.
 295  * It is also used if you maintain private status about the source location
 296  * It return 0 if the information was the same as the last time you
 297  * checked, -1 if the name changed and (new-old) if just the line changed.
 298  */
 299 int src_get(int32_t *xline, char **xname);
 300
 301 void nasm_quote(char **str);
 302 char *nasm_strcat(char *one, char *two);
 303
 304 void null_debug_routine(const char *directive, const char *params);
 305 extern struct dfmt null_debug_form;
 306 extern struct dfmt *null_debug_arr[2];
 307
 308 const char *prefix_name(int);
 309
 310 #endif