Add missing static declarations in rdoff/ldrdf.c
[nasm.git] / nasmlib.h
blobfb2bb0842f1b6127c206c8423f8912e42cab4af7
1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2009 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
9 * conditions are met:
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * ----------------------------------------------------------------------- */
35 * nasmlib.h header file for nasmlib.c
38 #ifndef NASM_NASMLIB_H
39 #define NASM_NASMLIB_H
41 #include "compiler.h"
43 #include <inttypes.h>
44 #include <stdio.h>
45 #include <string.h>
46 #ifdef HAVE_STRINGS_H
47 #include <strings.h>
48 #endif
51 * tolower table -- avoids a function call on some platforms.
52 * NOTE: unlike the tolower() function in ctype, EOF is *NOT*
53 * a permitted value, for obvious reasons.
55 void tolower_init(void);
56 extern unsigned char nasm_tolower_tab[256];
57 #define nasm_tolower(x) nasm_tolower_tab[(unsigned char)(x)]
59 /* Wrappers around <ctype.h> functions */
60 /* These are only valid for values that cannot include EOF */
61 #define nasm_isspace(x) isspace((unsigned char)(x))
62 #define nasm_isalpha(x) isalpha((unsigned char)(x))
63 #define nasm_isdigit(x) isdigit((unsigned char)(x))
64 #define nasm_isalnum(x) isalnum((unsigned char)(x))
65 #define nasm_isxdigit(x) isxdigit((unsigned char)(x))
68 * -------------------------
69 * Error reporting functions
70 * -------------------------
74 * An error reporting function should look like this.
76 typedef void (*efunc) (int severity, const char *fmt, ...);
77 typedef void (*vefunc) (int severity, const char *fmt, va_list ap);
78 #ifdef __GNUC__
79 void nasm_error(int severity, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
80 #else
81 void nasm_error(int severity, const char *fmt, ...);
82 #endif
83 void nasm_set_verror(vefunc);
86 * These are the error severity codes which get passed as the first
87 * argument to an efunc.
90 #define ERR_DEBUG 0x00000008 /* put out debugging message */
91 #define ERR_WARNING 0x00000000 /* warn only: no further action */
92 #define ERR_NONFATAL 0x00000001 /* terminate assembly after phase */
93 #define ERR_FATAL 0x00000002 /* instantly fatal: exit with error */
94 #define ERR_PANIC 0x00000003 /* internal error: panic instantly
95 * and dump core for reference */
96 #define ERR_MASK 0x0000000F /* mask off the above codes */
97 #define ERR_NOFILE 0x00000010 /* don't give source file name/line */
98 #define ERR_USAGE 0x00000020 /* print a usage message */
99 #define ERR_PASS1 0x00000040 /* only print this error on pass one */
100 #define ERR_PASS2 0x00000080
101 #define ERR_NO_SEVERITY 0x00000100 /* suppress printing severity */
104 * These codes define specific types of suppressible warning.
107 #define ERR_WARN_MASK 0xFFFFF000 /* the mask for this feature */
108 #define ERR_WARN_SHR 12 /* how far to shift right */
110 #define WARN(x) ((x) << ERR_WARN_SHR)
111 #define WARN_IDX(x) (((x) & ERR_WARN_MASK) >> ERR_WARN_SHR)
113 #define ERR_WARN_TERM WARN( 0) /* treat warnings as errors */
114 #define ERR_WARN_MNP WARN( 1) /* macro-num-parameters warning */
115 #define ERR_WARN_MSR WARN( 2) /* macro self-reference */
116 #define ERR_WARN_MDP WARN( 3) /* macro default parameters check */
117 #define ERR_WARN_OL WARN( 4) /* orphan label (no colon, and
118 * alone on line) */
119 #define ERR_WARN_NOV WARN( 5) /* numeric overflow */
120 #define ERR_WARN_GNUELF WARN( 6) /* using GNU ELF extensions */
121 #define ERR_WARN_FL_OVERFLOW WARN( 7) /* FP overflow */
122 #define ERR_WARN_FL_DENORM WARN( 8) /* FP denormal */
123 #define ERR_WARN_FL_UNDERFLOW WARN( 9) /* FP underflow */
124 #define ERR_WARN_FL_TOOLONG WARN(10) /* FP too many digits */
125 #define ERR_WARN_USER WARN(11) /* %warning directives */
126 #define ERR_WARN_LOCK WARN(12) /* bad LOCK prefixes */
127 #define ERR_WARN_HLE WARN(13) /* bad HLE prefixes */
128 #define ERR_WARN_BND WARN(14) /* bad BND prefixes */
129 #define ERR_WARN_MAX 14 /* the highest numbered one */
132 * Wrappers around malloc, realloc and free. nasm_malloc will
133 * fatal-error and die rather than return NULL; nasm_realloc will
134 * do likewise, and will also guarantee to work right on being
135 * passed a NULL pointer; nasm_free will do nothing if it is passed
136 * a NULL pointer.
138 void *nasm_malloc(size_t);
139 void *nasm_zalloc(size_t);
140 void *nasm_realloc(void *, size_t);
141 void nasm_free(void *);
142 char *nasm_strdup(const char *);
143 char *nasm_strndup(const char *, size_t);
146 * Wrapper around fwrite() which fatal-errors on output failure.
148 void nasm_write(const void *, size_t, FILE *);
151 * NASM assert failure
153 no_return nasm_assert_failed(const char *, int, const char *);
154 #define nasm_assert(x) \
155 do { \
156 if (unlikely(!(x))) \
157 nasm_assert_failed(__FILE__,__LINE__,#x); \
158 } while (0)
161 * NASM failure at build time if x != 0
163 #define nasm_build_assert(x) (void)(sizeof(char[1-2*!!(x)]))
166 * ANSI doesn't guarantee the presence of `stricmp' or
167 * `strcasecmp'.
169 #if defined(HAVE_STRCASECMP)
170 #define nasm_stricmp strcasecmp
171 #elif defined(HAVE_STRICMP)
172 #define nasm_stricmp stricmp
173 #else
174 int nasm_stricmp(const char *, const char *);
175 #endif
177 #if defined(HAVE_STRNCASECMP)
178 #define nasm_strnicmp strncasecmp
179 #elif defined(HAVE_STRNICMP)
180 #define nasm_strnicmp strnicmp
181 #else
182 int nasm_strnicmp(const char *, const char *, size_t);
183 #endif
185 int nasm_memicmp(const char *, const char *, size_t);
187 #if defined(HAVE_STRSEP)
188 #define nasm_strsep strsep
189 #else
190 char *nasm_strsep(char **stringp, const char *delim);
191 #endif
193 /* This returns the numeric value of a given 'digit'. */
194 #define numvalue(c) ((c) >= 'a' ? (c) - 'a' + 10 : (c) >= 'A' ? (c) - 'A' + 10 : (c) - '0')
197 * Convert a string into a number, using NASM number rules. Sets
198 * `*error' to true if an error occurs, and false otherwise.
200 int64_t readnum(char *str, bool *error);
203 * Convert a character constant into a number. Sets
204 * `*warn' to true if an overflow occurs, and false otherwise.
205 * str points to and length covers the middle of the string,
206 * without the quotes.
208 int64_t readstrnum(char *str, int length, bool *warn);
211 * seg_init: Initialise the segment-number allocator.
212 * seg_alloc: allocate a hitherto unused segment number.
214 void seg_init(void);
215 int32_t seg_alloc(void);
218 * many output formats will be able to make use of this: a standard
219 * function to add an extension to the name of the input file
221 void standard_extension(char *inname, char *outname, char *extension);
224 * Utility macros...
226 * This is a useful #define which I keep meaning to use more often:
227 * the number of elements of a statically defined array.
229 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
232 * List handling
234 * list_for_each - regular iterator over list
235 * list_for_each_safe - the same but safe against list items removal
236 * list_last - find the last element in a list
238 #define list_for_each(pos, head) \
239 for (pos = head; pos; pos = pos->next)
240 #define list_for_each_safe(pos, n, head) \
241 for (pos = head, n = (pos ? pos->next : NULL); pos; \
242 pos = n, n = (n ? n->next : NULL))
243 #define list_last(pos, head) \
244 for (pos = head; pos && pos->next; pos = pos->next) \
246 #define list_reverse(head, prev, next) \
247 do { \
248 if (!head || !head->next) \
249 break; \
250 prev = NULL; \
251 while (head) { \
252 next = head->next; \
253 head->next = prev; \
254 prev = head; \
255 head = next; \
257 head = prev; \
258 } while (0)
261 * Power of 2 align helpers
263 #define ALIGN_MASK(v, mask) (((v) + (mask)) & ~(mask))
264 #define ALIGN(v, a) ALIGN_MASK(v, (a) - 1)
265 #define IS_ALIGNED(v, a) (((v) & ((a) - 1)) == 0)
268 * some handy macros that will probably be of use in more than one
269 * output format: convert integers into little-endian byte packed
270 * format in memory
273 #if X86_MEMORY
275 #define WRITECHAR(p,v) \
276 do { \
277 *(uint8_t *)(p) = (v); \
278 (p) += 1; \
279 } while (0)
281 #define WRITESHORT(p,v) \
282 do { \
283 *(uint16_t *)(p) = (v); \
284 (p) += 2; \
285 } while (0)
287 #define WRITELONG(p,v) \
288 do { \
289 *(uint32_t *)(p) = (v); \
290 (p) += 4; \
291 } while (0)
293 #define WRITEDLONG(p,v) \
294 do { \
295 *(uint64_t *)(p) = (v); \
296 (p) += 8; \
297 } while (0)
299 #define WRITEADDR(p,v,s) \
300 do { \
301 uint64_t _wa_v = (v); \
302 memcpy((p), &_wa_v, (s)); \
303 (p) += (s); \
304 } while (0)
306 #else /* !X86_MEMORY */
308 #define WRITECHAR(p,v) \
309 do { \
310 uint8_t *_wc_p = (uint8_t *)(p); \
311 uint8_t _wc_v = (v); \
312 _wc_p[0] = _wc_v; \
313 (p) = (void *)(_wc_p + 1); \
314 } while (0)
316 #define WRITESHORT(p,v) \
317 do { \
318 uint8_t *_ws_p = (uint8_t *)(p); \
319 uint16_t _ws_v = (v); \
320 _ws_p[0] = _ws_v; \
321 _ws_p[1] = _ws_v >> 8; \
322 (p) = (void *)(_ws_p + 2); \
323 } while (0)
325 #define WRITELONG(p,v) \
326 do { \
327 uint8_t *_wl_p = (uint8_t *)(p); \
328 uint32_t _wl_v = (v); \
329 _wl_p[0] = _wl_v; \
330 _wl_p[1] = _wl_v >> 8; \
331 _wl_p[2] = _wl_v >> 16; \
332 _wl_p[3] = _wl_v >> 24; \
333 (p) = (void *)(_wl_p + 4); \
334 } while (0)
336 #define WRITEDLONG(p,v) \
337 do { \
338 uint8_t *_wq_p = (uint8_t *)(p); \
339 uint64_t _wq_v = (v); \
340 _wq_p[0] = _wq_v; \
341 _wq_p[1] = _wq_v >> 8; \
342 _wq_p[2] = _wq_v >> 16; \
343 _wq_p[3] = _wq_v >> 24; \
344 _wq_p[4] = _wq_v >> 32; \
345 _wq_p[5] = _wq_v >> 40; \
346 _wq_p[6] = _wq_v >> 48; \
347 _wq_p[7] = _wq_v >> 56; \
348 (p) = (void *)(_wq_p + 8); \
349 } while (0)
351 #define WRITEADDR(p,v,s) \
352 do { \
353 int _wa_s = (s); \
354 uint64_t _wa_v = (v); \
355 while (_wa_s--) { \
356 WRITECHAR(p,_wa_v); \
357 _wa_v >>= 8; \
359 } while(0)
361 #endif
364 * and routines to do the same thing to a file
366 #define fwriteint8_t(d,f) putc(d,f)
367 void fwriteint16_t(uint16_t data, FILE * fp);
368 void fwriteint32_t(uint32_t data, FILE * fp);
369 void fwriteint64_t(uint64_t data, FILE * fp);
370 void fwriteaddr(uint64_t data, int size, FILE * fp);
373 * Binary search routine. Returns index into `array' of an entry
374 * matching `string', or <0 if no match. `array' is taken to
375 * contain `size' elements.
377 * bsi() is case sensitive, bsii() is case insensitive.
379 int bsi(const char *string, const char **array, int size);
380 int bsii(const char *string, const char **array, int size);
382 char *src_set_fname(char *newname);
383 int32_t src_set_linnum(int32_t newline);
384 int32_t src_get_linnum(void);
386 * src_get may be used if you simply want to know the source file and line.
387 * It is also used if you maintain private status about the source location
388 * It return 0 if the information was the same as the last time you
389 * checked, -1 if the name changed and (new-old) if just the line changed.
391 int src_get(int32_t *xline, char **xname);
393 char *nasm_strcat(const char *one, const char *two);
395 char *nasm_skip_spaces(const char *p);
396 char *nasm_skip_word(const char *p);
397 char *nasm_zap_spaces_fwd(char *p);
398 char *nasm_zap_spaces_rev(char *p);
399 char *nasm_trim_spaces(char *p);
400 char *nasm_get_word(char *p, char **tail);
401 char *nasm_opt_val(char *p, char **opt, char **val);
403 const char *prefix_name(int);
405 #define ZERO_BUF_SIZE 4096
406 extern const uint8_t zero_buffer[ZERO_BUF_SIZE];
407 void fwritezero(size_t bytes, FILE *fp);
409 static inline bool overflow_general(int64_t value, int bytes)
411 int sbit;
412 int64_t vmax, vmin;
414 if (bytes >= 8)
415 return false;
417 sbit = (bytes << 3) - 1;
418 vmax = ((int64_t)2 << sbit) - 1;
419 vmin = -((int64_t)1 << sbit);
421 return value < vmin || value > vmax;
424 static inline bool overflow_signed(int64_t value, int bytes)
426 int sbit;
427 int64_t vmax, vmin;
429 if (bytes >= 8)
430 return false;
432 sbit = (bytes << 3) - 1;
433 vmax = ((int64_t)1 << sbit) - 1;
434 vmin = -((int64_t)1 << sbit);
436 return value < vmin || value > vmax;
439 static inline bool overflow_unsigned(int64_t value, int bytes)
441 int sbit;
442 int64_t vmax, vmin;
444 if (bytes >= 8)
445 return false;
447 sbit = (bytes << 3) - 1;
448 vmax = ((int64_t)2 << sbit) - 1;
449 vmin = 0;
451 return value < vmin || value > vmax;
454 static inline int64_t signed_bits(int64_t value, int bits)
456 if (bits < 64) {
457 value &= ((int64_t)1 << bits) - 1;
458 if (value & (int64_t)1 << (bits - 1))
459 value |= (int64_t)-1 << bits;
461 return value;
464 int idata_bytes(int opcode);
466 /* check if value is power of 2 */
467 #define is_power2(v) ((v) && ((v) & ((v) - 1)) == 0)
470 * floor(log2(v))
472 int ilog2_32(uint32_t v);
473 int ilog2_64(uint64_t v);
476 * v == 0 ? 0 : is_power2(x) ? ilog2_X(v) : -1
478 int alignlog2_32(uint32_t v);
479 int alignlog2_64(uint64_t v);
481 #endif