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