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