1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2017 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
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
50 * tolower table -- avoids a function call on some platforms.
51 * NOTE: unlike the tolower() function in ctype, EOF is *NOT*
52 * a permitted value, for obvious reasons.
54 void tolower_init(void);
55 extern unsigned char nasm_tolower_tab
[256];
56 #define nasm_tolower(x) nasm_tolower_tab[(unsigned char)(x)]
58 /* Wrappers around <ctype.h> functions */
59 /* These are only valid for values that cannot include EOF */
60 #define nasm_isspace(x) isspace((unsigned char)(x))
61 #define nasm_isalpha(x) isalpha((unsigned char)(x))
62 #define nasm_isdigit(x) isdigit((unsigned char)(x))
63 #define nasm_isalnum(x) isalnum((unsigned char)(x))
64 #define nasm_isxdigit(x) isxdigit((unsigned char)(x))
67 * -------------------------
68 * Error reporting functions
69 * -------------------------
73 * An error reporting function should look like this.
75 void printf_func(2, 3) nasm_error(int severity
, const char *fmt
, ...);
76 no_return
printf_func(2, 3) nasm_fatal(int flags
, const char *fmt
, ...);
77 no_return
printf_func(2, 3) nasm_panic(int flags
, const char *fmt
, ...);
78 no_return
nasm_panic_from_macro(const char *file
, int line
);
79 #define panic() nasm_panic_from_macro(__FILE__, __LINE__);
81 typedef void (*vefunc
) (int severity
, const char *fmt
, va_list ap
);
82 extern vefunc nasm_verror
;
83 static inline vefunc
nasm_set_verror(vefunc ve
)
85 vefunc old_verror
= nasm_verror
;
91 * These are the error severity codes which get passed as the first
92 * argument to an efunc.
95 #define ERR_DEBUG 0x00000000 /* put out debugging message */
96 #define ERR_WARNING 0x00000001 /* warn only: no further action */
97 #define ERR_NONFATAL 0x00000002 /* terminate assembly after phase */
98 #define ERR_FATAL 0x00000006 /* instantly fatal: exit with error */
99 #define ERR_PANIC 0x00000007 /* internal error: panic instantly
100 * and dump core for reference */
101 #define ERR_MASK 0x00000007 /* mask off the above codes */
102 #define ERR_NOFILE 0x00000010 /* don't give source file name/line */
103 #define ERR_USAGE 0x00000020 /* print a usage message */
104 #define ERR_PASS1 0x00000040 /* only print this error on pass one */
105 #define ERR_PASS2 0x00000080
107 #define ERR_NO_SEVERITY 0x00000100 /* suppress printing severity */
108 #define ERR_PP_PRECOND 0x00000200 /* for preprocessor use */
109 #define ERR_PP_LISTMACRO 0x00000400 /* from preproc->error_list_macros() */
112 * These codes define specific types of suppressible warning.
115 #define ERR_WARN_MASK 0xFFFFF000 /* the mask for this feature */
116 #define ERR_WARN_SHR 12 /* how far to shift right */
118 #define WARN(x) ((x) << ERR_WARN_SHR)
119 #define WARN_IDX(x) (((x) & ERR_WARN_MASK) >> ERR_WARN_SHR)
121 #define ERR_WARN_TERM WARN( 0) /* treat warnings as errors */
122 #define ERR_WARN_MNP WARN( 1) /* macro-num-parameters warning */
123 #define ERR_WARN_MSR WARN( 2) /* macro self-reference */
124 #define ERR_WARN_MDP WARN( 3) /* macro default parameters check */
125 #define ERR_WARN_OL WARN( 4) /* orphan label (no colon, and
127 #define ERR_WARN_NOV WARN( 5) /* numeric overflow */
128 #define ERR_WARN_GNUELF WARN( 6) /* using GNU ELF extensions */
129 #define ERR_WARN_FL_OVERFLOW WARN( 7) /* FP overflow */
130 #define ERR_WARN_FL_DENORM WARN( 8) /* FP denormal */
131 #define ERR_WARN_FL_UNDERFLOW WARN( 9) /* FP underflow */
132 #define ERR_WARN_FL_TOOLONG WARN(10) /* FP too many digits */
133 #define ERR_WARN_USER WARN(11) /* %warning directives */
134 #define ERR_WARN_LOCK WARN(12) /* bad LOCK prefixes */
135 #define ERR_WARN_HLE WARN(13) /* bad HLE prefixes */
136 #define ERR_WARN_BND WARN(14) /* bad BND prefixes */
137 #define ERR_WARN_ZEXTRELOC WARN(15) /* relocation zero-extended */
138 #define ERR_WARN_PTR WARN(16) /* not a NASM keyword */
139 #define ERR_WARN_MAX 16 /* the highest numbered one */
142 * Wrappers around malloc, realloc and free. nasm_malloc will
143 * fatal-error and die rather than return NULL; nasm_realloc will
144 * do likewise, and will also guarantee to work right on being
145 * passed a NULL pointer; nasm_free will do nothing if it is passed
148 void * safe_malloc(1) nasm_malloc(size_t);
149 void * safe_malloc(1) nasm_zalloc(size_t);
150 void * safe_malloc2(1,2) nasm_calloc(size_t, size_t);
151 void * safe_realloc(2) nasm_realloc(void *, size_t);
152 void nasm_free(void *);
153 char * safe_alloc
nasm_strdup(const char *);
154 char * safe_alloc
nasm_strndup(const char *, size_t);
156 /* Assert the argument is a pointer without evaluating it */
157 #define nasm_assert_pointer(p) ((void)sizeof(*(p)))
159 #define nasm_new(p) ((p) = nasm_zalloc(sizeof(*(p))))
160 #define nasm_newn(p,n) ((p) = nasm_calloc(sizeof(*(p)),(n)))
162 * This is broken on platforms where there are pointers which don't
163 * match void * in their internal layout. It unfortunately also
164 * loses any "const" part of the argument, although hopefully the
165 * compiler will warn in that case.
167 #define nasm_delete(p) \
169 void **_pp = (void **)&(p); \
170 nasm_assert_pointer(p); \
174 #define nasm_zero(p) (memset((p), 0, sizeof(*(p))))
177 * Wrapper around fwrite() which fatal-errors on output failure.
179 void nasm_write(const void *, size_t, FILE *);
182 * NASM assert failure
184 no_return
nasm_assert_failed(const char *, int, const char *);
185 #define nasm_assert(x) \
187 if (unlikely(!(x))) \
188 nasm_assert_failed(__FILE__,__LINE__,#x); \
192 * NASM failure at build time if the argument is false
195 # define nasm_static_assert(x) static_assert(x, #x)
196 #elif defined(HAVE_FUNC_ATTRIBUTE_ERROR) && defined(__OPTIMIZE__)
197 # define nasm_static_assert(x) \
199 extern void __attribute__((error("assertion " #x " failed"))) \
200 _nasm_static_fail(void); \
201 _nasm_static_fail(); \
204 /* See http://www.drdobbs.com/compile-time-assertions/184401873 */
205 # define nasm_static_assert(x) \
206 do { enum { _static_assert_failed = 1/(!!(x)) }; } while (0)
210 * ANSI doesn't guarantee the presence of `stricmp' or
213 #if defined(HAVE_STRCASECMP)
214 #define nasm_stricmp strcasecmp
215 #elif defined(HAVE_STRICMP)
216 #define nasm_stricmp stricmp
218 int pure_func
nasm_stricmp(const char *, const char *);
221 #if defined(HAVE_STRNCASECMP)
222 #define nasm_strnicmp strncasecmp
223 #elif defined(HAVE_STRNICMP)
224 #define nasm_strnicmp strnicmp
226 int pure_func
nasm_strnicmp(const char *, const char *, size_t);
229 int pure_func
nasm_memicmp(const char *, const char *, size_t);
231 #if defined(HAVE_STRSEP)
232 #define nasm_strsep strsep
234 char *nasm_strsep(char **stringp
, const char *delim
);
237 #ifndef HAVE_DECL_STRNLEN
238 size_t pure_func
strnlen(const char *, size_t);
241 /* This returns the numeric value of a given 'digit'. */
242 #define numvalue(c) ((c) >= 'a' ? (c) - 'a' + 10 : (c) >= 'A' ? (c) - 'A' + 10 : (c) - '0')
245 * Convert a string into a number, using NASM number rules. Sets
246 * `*error' to true if an error occurs, and false otherwise.
248 int64_t readnum(char *str
, bool *error
);
251 * Convert a character constant into a number. Sets
252 * `*warn' to true if an overflow occurs, and false otherwise.
253 * str points to and length covers the middle of the string,
254 * without the quotes.
256 int64_t readstrnum(char *str
, int length
, bool *warn
);
259 * seg_init: Initialise the segment-number allocator.
260 * seg_alloc: allocate a hitherto unused segment number.
262 void pure_func
seg_init(void);
263 int32_t pure_func
seg_alloc(void);
266 * many output formats will be able to make use of this: a standard
267 * function to add an extension to the name of the input file
269 void standard_extension(char *inname
, char *outname
, char *extension
);
274 * This is a useful #define which I keep meaning to use more often:
275 * the number of elements of a statically defined array.
277 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
282 * list_for_each - regular iterator over list
283 * list_for_each_safe - the same but safe against list items removal
284 * list_last - find the last element in a list
286 #define list_for_each(pos, head) \
287 for (pos = head; pos; pos = pos->next)
288 #define list_for_each_safe(pos, n, head) \
289 for (pos = head, n = (pos ? pos->next : NULL); pos; \
290 pos = n, n = (n ? n->next : NULL))
291 #define list_last(pos, head) \
292 for (pos = head; pos && pos->next; pos = pos->next) \
294 #define list_reverse(head, prev, next) \
296 if (!head || !head->next) \
309 * Power of 2 align helpers
311 #undef ALIGN_MASK /* Some BSD flavors define these in system headers */
313 #define ALIGN_MASK(v, mask) (((v) + (mask)) & ~(mask))
314 #define ALIGN(v, a) ALIGN_MASK(v, (a) - 1)
315 #define IS_ALIGNED(v, a) (((v) & ((a) - 1)) == 0)
318 * some handy macros that will probably be of use in more than one
319 * output format: convert integers into little-endian byte packed
325 #define WRITECHAR(p,v) \
327 *(uint8_t *)(p) = (v); \
331 #define WRITESHORT(p,v) \
333 *(uint16_t *)(p) = (v); \
337 #define WRITELONG(p,v) \
339 *(uint32_t *)(p) = (v); \
343 #define WRITEDLONG(p,v) \
345 *(uint64_t *)(p) = (v); \
349 #define WRITEADDR(p,v,s) \
351 uint64_t _wa_v = (v); \
352 memcpy((p), &_wa_v, (s)); \
356 #else /* !X86_MEMORY */
358 #define WRITECHAR(p,v) \
360 uint8_t *_wc_p = (uint8_t *)(p); \
361 uint8_t _wc_v = (v); \
363 (p) = (void *)(_wc_p + 1); \
366 #define WRITESHORT(p,v) \
368 uint8_t *_ws_p = (uint8_t *)(p); \
369 uint16_t _ws_v = (v); \
371 _ws_p[1] = _ws_v >> 8; \
372 (p) = (void *)(_ws_p + 2); \
375 #define WRITELONG(p,v) \
377 uint8_t *_wl_p = (uint8_t *)(p); \
378 uint32_t _wl_v = (v); \
380 _wl_p[1] = _wl_v >> 8; \
381 _wl_p[2] = _wl_v >> 16; \
382 _wl_p[3] = _wl_v >> 24; \
383 (p) = (void *)(_wl_p + 4); \
386 #define WRITEDLONG(p,v) \
388 uint8_t *_wq_p = (uint8_t *)(p); \
389 uint64_t _wq_v = (v); \
391 _wq_p[1] = _wq_v >> 8; \
392 _wq_p[2] = _wq_v >> 16; \
393 _wq_p[3] = _wq_v >> 24; \
394 _wq_p[4] = _wq_v >> 32; \
395 _wq_p[5] = _wq_v >> 40; \
396 _wq_p[6] = _wq_v >> 48; \
397 _wq_p[7] = _wq_v >> 56; \
398 (p) = (void *)(_wq_p + 8); \
401 #define WRITEADDR(p,v,s) \
404 uint64_t _wa_v = (v); \
406 WRITECHAR(p,_wa_v); \
414 * and routines to do the same thing to a file
416 #define fwriteint8_t(d,f) putc(d,f)
417 void fwriteint16_t(uint16_t data
, FILE * fp
);
418 void fwriteint32_t(uint32_t data
, FILE * fp
);
419 void fwriteint64_t(uint64_t data
, FILE * fp
);
420 void fwriteaddr(uint64_t data
, int size
, FILE * fp
);
423 * Binary search routine. Returns index into `array' of an entry
424 * matching `string', or <0 if no match. `array' is taken to
425 * contain `size' elements.
427 * bsi() is case sensitive, bsii() is case insensitive.
429 int bsi(const char *string
, const char **array
, int size
);
430 int bsii(const char *string
, const char **array
, int size
);
433 * These functions are used to keep track of the source code file and name.
437 const char *src_set_fname(const char *newname
);
438 const char *src_get_fname(void);
439 int32_t src_set_linnum(int32_t newline
);
440 int32_t src_get_linnum(void);
441 /* Can be used when there is no need for the old information */
442 void src_set(int32_t line
, const char *filename
);
444 * src_get gets both the source file name and line.
445 * It is also used if you maintain private status about the source location
446 * It return 0 if the information was the same as the last time you
447 * checked, -2 if the name changed and (new-old) if just the line changed.
449 int32_t src_get(int32_t *xline
, const char **xname
);
451 char *nasm_strcat(const char *one
, const char *two
);
453 char *nasm_skip_spaces(const char *p
);
454 char *nasm_skip_word(const char *p
);
455 char *nasm_zap_spaces_fwd(char *p
);
456 char *nasm_zap_spaces_rev(char *p
);
457 char *nasm_trim_spaces(char *p
);
458 char *nasm_get_word(char *p
, char **tail
);
459 char *nasm_opt_val(char *p
, char **opt
, char **val
);
462 * Converts a relative pathname rel_path into an absolute path name.
464 * The buffer returned must be freed by the caller
466 char *nasm_realpath(const char *rel_path
);
468 const char * pure_func
prefix_name(int);
471 * Wrappers around fopen()... for future change to a dedicated structure
474 NF_BINARY
= 0x00000000, /* Binary file (default) */
475 NF_TEXT
= 0x00000001, /* Text file */
476 NF_NONFATAL
= 0x00000000, /* Don't die on open failure (default) */
477 NF_FATAL
= 0x00000002, /* Die on open failure */
478 NF_FORMAP
= 0x00000004 /* Intended to use nasm_map_file() */
481 FILE *nasm_open_read(const char *filename
, enum file_flags flags
);
482 FILE *nasm_open_write(const char *filename
, enum file_flags flags
);
484 /* Probe for existence of a file */
485 bool nasm_file_exists(const char *filename
);
487 #define ZERO_BUF_SIZE 65536 /* Default value */
488 #if defined(BUFSIZ) && (BUFSIZ > ZERO_BUF_SIZE)
489 # undef ZERO_BUF_SIZE
490 # define ZERO_BUF_SIZE BUFSIZ
492 extern const uint8_t zero_buffer
[ZERO_BUF_SIZE
];
494 /* Missing fseeko/ftello */
496 # undef off_t /* Just in case it is a macro */
497 # ifdef HAVE__FSEEKI64
498 # define fseeko _fseeki64
499 # define ftello _ftelli64
500 # define off_t int64_t
502 # define fseeko fseek
503 # define ftello ftell
508 const void *nasm_map_file(FILE *fp
, off_t start
, off_t len
);
509 void nasm_unmap_file(const void *p
, size_t len
);
510 off_t
nasm_file_size(FILE *f
);
511 off_t
nasm_file_size_by_path(const char *pathname
);
512 void fwritezero(off_t bytes
, FILE *fp
);
514 static inline bool const_func
overflow_general(int64_t value
, int bytes
)
522 sbit
= (bytes
<< 3) - 1;
523 vmax
= ((int64_t)2 << sbit
) - 1;
524 vmin
= -((int64_t)1 << sbit
);
526 return value
< vmin
|| value
> vmax
;
529 static inline bool const_func
overflow_signed(int64_t value
, int bytes
)
537 sbit
= (bytes
<< 3) - 1;
538 vmax
= ((int64_t)1 << sbit
) - 1;
539 vmin
= -((int64_t)1 << sbit
);
541 return value
< vmin
|| value
> vmax
;
544 static inline bool const_func
overflow_unsigned(int64_t value
, int bytes
)
552 sbit
= (bytes
<< 3) - 1;
553 vmax
= ((int64_t)2 << sbit
) - 1;
556 return value
< vmin
|| value
> vmax
;
559 static inline int64_t const_func
signed_bits(int64_t value
, int bits
)
562 value
&= ((int64_t)1 << bits
) - 1;
563 if (value
& (int64_t)1 << (bits
- 1))
564 value
|= (int64_t)((uint64_t)-1 << bits
);
569 int const_func
idata_bytes(int opcode
);
571 /* check if value is power of 2 */
572 #define is_power2(v) ((v) && ((v) & ((v) - 1)) == 0)
577 int const_func
ilog2_32(uint32_t v
);
578 int const_func
ilog2_64(uint64_t v
);
581 * v == 0 ? 0 : is_power2(x) ? ilog2_X(v) : -1
583 int const_func
alignlog2_32(uint32_t v
);
584 int const_func
alignlog2_64(uint64_t v
);