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 /*
  75  * Convert a string into a number, using NASM number rules. Sets
  76  * `*error' to TRUE if an error occurs, and FALSE otherwise.
  77  */
  78 long readnum(char *str, int *error);
  79
  80 /*
  81  * Convert a character constant into a number. Sets
  82  * `*warn' to TRUE if an overflow occurs, and FALSE otherwise.
  83  * str points to and length covers the middle of the string,
  84  * without the quotes.
  85  */
  86 long readstrnum(char *str, int length, int *warn);
  87
  88 /*
  89  * seg_init: Initialise the segment-number allocator.
  90  * seg_alloc: allocate a hitherto unused segment number.
  91  */
  92 void seg_init(void);
  93 long seg_alloc(void);
  94
  95 /*
  96  * many output formats will be able to make use of this: a standard
  97  * function to add an extension to the name of the input file
  98  */
  99 #ifdef NASM_NASM_H
 100 void standard_extension (char *inname, char *outname, char *extension,
 101                          efunc error);
 102 #endif
 103
 104 /*
 105  * some handy macros that will probably be of use in more than one
 106  * output format: convert integers into little-endian byte packed
 107  * format in memory
 108  */
 109
 110 #define WRITELONG(p,v) \
 111   do { \
 112     *(p)++ = (v) & 0xFF; \
 113     *(p)++ = ((v) >> 8) & 0xFF; \
 114     *(p)++ = ((v) >> 16) & 0xFF; \
 115     *(p)++ = ((v) >> 24) & 0xFF; \
 116   } while (0)
 117
 118 #define WRITESHORT(p,v) \
 119   do { \
 120     *(p)++ = (v) & 0xFF; \
 121     *(p)++ = ((v) >> 8) & 0xFF; \
 122   } while (0)
 123
 124 /*
 125  * and routines to do the same thing to a file
 126  */
 127 void fwriteshort (int data, FILE *fp);
 128 void fwritelong (long data, FILE *fp);
 129
 130 /*
 131  * Routines to manage a dynamic random access array of longs which
 132  * may grow in size to be more than the largest single malloc'able
 133  * chunk.
 134  */
 135
 136 #define RAA_BLKSIZE 4096               /* this many longs allocated at once */
 137 #define RAA_LAYERSIZE 1024             /* this many _pointers_ allocated */
 138
 139 typedef struct RAA RAA;
 140 typedef union RAA_UNION RAA_UNION;
 141 typedef struct RAA_LEAF RAA_LEAF;
 142 typedef struct RAA_BRANCH RAA_BRANCH;
 143
 144 struct RAA {
 145     /*
 146      * Number of layers below this one to get to the real data. 0
 147      * means this structure is a leaf, holding RAA_BLKSIZE real
 148      * data items; 1 and above mean it's a branch, holding
 149      * RAA_LAYERSIZE pointers to the next level branch or leaf
 150      * structures.
 151      */
 152     int layers;
 153     /*
 154      * Number of real data items spanned by one position in the
 155      * `data' array at this level. This number is 1, trivially, for
 156      * a leaf (level 0): for a level 1 branch it should be
 157      * RAA_BLKSIZE, and for a level 2 branch it's
 158      * RAA_LAYERSIZE*RAA_BLKSIZE.
 159      */
 160     long stepsize;
 161     union RAA_UNION {
 162         struct RAA_LEAF {
 163             long data[RAA_BLKSIZE];
 164         } l;
 165         struct RAA_BRANCH {
 166             struct RAA *data[RAA_LAYERSIZE];
 167         } b;
 168     } u;
 169 };
 170
 171
 172 struct RAA *raa_init (void);
 173 void raa_free (struct RAA *);
 174 long raa_read (struct RAA *, long);
 175 struct RAA *raa_write (struct RAA *r, long posn, long value);
 176
 177 /*
 178  * Routines to manage a dynamic sequential-access array, under the
 179  * same restriction on maximum mallocable block. This array may be
 180  * written to in two ways: a contiguous chunk can be reserved of a
 181  * given size, and a pointer returned, or single-byte data may be
 182  * written. The array can also be read back in the same two ways:
 183  * as a series of big byte-data blocks or as a list of structures
 184  * of a given size.
 185  */
 186
 187 struct SAA {
 188     /*
 189      * members `end' and `elem_len' are only valid in first link in
 190      * list; `rptr' and `rpos' are used for reading
 191      */
 192     struct SAA *next, *end, *rptr;
 193     long elem_len, length, posn, start, rpos;
 194     char *data;
 195 };
 196
 197 struct SAA *saa_init (long elem_len);  /* 1 == byte */
 198 void saa_free (struct SAA *);
 199 void *saa_wstruct (struct SAA *);      /* return a structure of elem_len */
 200 void saa_wbytes (struct SAA *, const void *, long);  /* write arbitrary bytes */
 201 void saa_rewind (struct SAA *);        /* for reading from beginning */
 202 void *saa_rstruct (struct SAA *);      /* return NULL on EOA */
 203 void *saa_rbytes (struct SAA *, long *);   /* return 0 on EOA */
 204 void saa_rnbytes (struct SAA *, void *, long); /* read a given no. of bytes */
 205 void saa_fread (struct SAA *s, long posn, void *p, long len);   /* fixup */
 206 void saa_fwrite (struct SAA *s, long posn, void *p, long len);   /* fixup */
 207 void saa_fpwrite (struct SAA *, FILE *);
 208
 209 #ifdef NASM_NASM_H
 210 /*
 211  * Standard scanner.
 212  */
 213 extern char *stdscan_bufptr;
 214 void stdscan_reset(void);
 215 int stdscan (void *private_data, struct tokenval *tv);
 216 #endif
 217
 218 #ifdef NASM_NASM_H
 219 /*
 220  * Library routines to manipulate expression data types.
 221  */
 222 int is_reloc(expr *);
 223 int is_simple(expr *);
 224 int is_really_simple (expr *);
 225 int is_unknown(expr *);
 226 int is_just_unknown(expr *);
 227 long reloc_value(expr *);
 228 long reloc_seg(expr *);
 229 long reloc_wrt(expr *);
 230 #endif
 231
 232 /*
 233  * Binary search routine. Returns index into `array' of an entry
 234  * matching `string', or <0 if no match. `array' is taken to
 235  * contain `size' elements.
 236  */
 237 int bsi (char *string, const char **array, int size);
 238
 239
 240 char *src_set_fname(char *newname);
 241 long src_set_linnum(long newline);
 242 long src_get_linnum(void);
 243 /*
 244  * src_get may be used if you simply want to know the source file and line.
 245  * It is also used if you maintain private status about the source location
 246  * It return 0 if the information was the same as the last time you
 247  * checked, -1 if the name changed and (new-old) if just the line changed.
 248  */
 249 int src_get(long *xline, char **xname);
 250
 251 void nasm_quote(char **str);
 252 char *nasm_strcat(char *one, char *two);
 253 void nasmlib_cleanup(void);
 254
 255 void null_debug_routine(const char *directive, const char *params);
 256 extern struct dfmt null_debug_form;
 257 extern struct dfmt *null_debug_arr[2];
 258 #endif