nasmlib.h

   1 /* nasmlib.c    header file for nasmlib.h
   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 (char *);
  35 #else
  36 void *nasm_malloc_log (char *, int, size_t);
  37 void *nasm_realloc_log (char *, int, void *, size_t);
  38 void nasm_free_log (char *, int, void *);
  39 char *nasm_strdup_log (char *, int, char *);
  40 #define nasm_malloc(x) nasm_malloc_log(__FILE__,__LINE__,x)
  41 #define nasm_realloc(x,y) nasm_realloc_log(__FILE__,__LINE__,x,y)
  42 #define nasm_free(x) nasm_free_log(__FILE__,__LINE__,x)
  43 #define nasm_strdup(x) nasm_strdup_log(__FILE__,__LINE__,x)
  44 #endif
  45 #endif
  46
  47 /*
  48  * ANSI doesn't guarantee the presence of `stricmp' or
  49  * `strcasecmp'.
  50  */
  51 int nasm_stricmp (char *, char *);
  52 int nasm_strnicmp (char *, char *, int);
  53
  54 /*
  55  * Convert a string into a number, using NASM number rules. Sets
  56  * `*error' to TRUE if an error occurs, and FALSE otherwise.
  57  */
  58 long readnum(char *str, int *error);
  59
  60 /*
  61  * seg_init: Initialise the segment-number allocator.
  62  * seg_alloc: allocate a hitherto unused segment number.
  63  */
  64 void seg_init(void);
  65 long seg_alloc(void);
  66
  67 /*
  68  * many output formats will be able to make use of this: a standard
  69  * function to add an extension to the name of the input file
  70  */
  71 #ifdef NASM_NASM_H
  72 void standard_extension (char *inname, char *outname, char *extension,
  73                          efunc error);
  74 #endif
  75
  76 /*
  77  * some handy macros that will probably be of use in more than one
  78  * output format: convert integers into little-endian byte packed
  79  * format in memory
  80  */
  81
  82 #define WRITELONG(p,v) \
  83   do { \
  84     *(p)++ = (v) & 0xFF; \
  85     *(p)++ = ((v) >> 8) & 0xFF; \
  86     *(p)++ = ((v) >> 16) & 0xFF; \
  87     *(p)++ = ((v) >> 24) & 0xFF; \
  88   } while (0)
  89
  90 #define WRITESHORT(p,v) \
  91   do { \
  92     *(p)++ = (v) & 0xFF; \
  93     *(p)++ = ((v) >> 8) & 0xFF; \
  94   } while (0)
  95
  96 /*
  97  * and routines to do the same thing to a file
  98  */
  99 void fwriteshort (int data, FILE *fp);
 100 void fwritelong (long data, FILE *fp);
 101
 102 /*
 103  * Routines to manage a dynamic random access array of longs which
 104  * may grow in size to be more than the largest single malloc'able
 105  * chunk.
 106  */
 107
 108 struct RAA;
 109
 110 struct RAA *raa_init (void);
 111 void raa_free (struct RAA *);
 112 long raa_read (struct RAA *, long);
 113 struct RAA *raa_write (struct RAA *r, long posn, long value);
 114
 115 /*
 116  * Routines to manage a dynamic sequential-access array, under the
 117  * same restriction on maximum mallocable block. This array may be
 118  * written to in two ways: a contiguous chunk can be reserved of a
 119  * given size, and a pointer returned, or single-byte data may be
 120  * written. The array can also be read back in the same two ways:
 121  * as a series of big byte-data blocks or as a list of structures
 122  * of a given size.
 123  */
 124
 125 struct SAA;
 126
 127 struct SAA *saa_init (long elem_len);  /* 1 == byte */
 128 void saa_free (struct SAA *);
 129 void *saa_wstruct (struct SAA *);      /* return a structure of elem_len */
 130 void saa_wbytes (struct SAA *, void *, long);  /* write arbitrary bytes */
 131 void saa_rewind (struct SAA *);        /* for reading from beginning */
 132 void *saa_rstruct (struct SAA *);      /* return NULL on EOA */
 133 void *saa_rbytes (struct SAA *, long *);   /* return 0 on EOA */
 134 void saa_rnbytes (struct SAA *, void *, long); /* read a given no. of bytes */
 135 void saa_fread (struct SAA *s, long posn, void *p, long len);   /* fixup */
 136 void saa_fwrite (struct SAA *s, long posn, void *p, long len);   /* fixup */
 137 void saa_fpwrite (struct SAA *, FILE *);
 138
 139 #endif