added --print-search-dirs command line option
[fw/sdcc] / src / SDCCglobl.h
1 /* SDCCglobl.h - global macros etc required by all files */
2
3 #ifndef SDCCGLOBL_H
4 #define SDCCGLOBL_H
5
6 #include <memory.h>
7 #include <assert.h>
8 #include <stdlib.h>
9 #include <setjmp.h>
10 #include <stdio.h>
11
12 #include "SDCCset.h"
13
14
15 /*
16  * Define host port dependant constants etc.
17  */
18
19 #define UNIX_DIR_SEPARATOR_CHAR    '/'
20
21 #ifdef _WIN32       /* WIN32 native */
22
23 #  define NATIVE_WIN32          1
24 #  ifdef __MINGW32__  /* GCC MINGW32 depends on configure */
25 #    include "sdccconf.h"
26 #  else
27 #    include "sdcc_vc.h"
28 #    define PATH_MAX  _MAX_PATH
29 #  endif
30
31 #else               /* Assume Un*x style system */
32 #  include "sdccconf.h"
33 #endif
34
35 #include "SDCCerr.h"
36
37 #define SPACE ' '
38 #define ZERO  0
39
40 #include <limits.h>             /* PATH_MAX                  */
41 #ifndef PATH_MAX                /* POSIX, but not required   */
42 #  define PATH_MAX 255          /* define a reasonable value */
43 #endif
44
45 #define  MAX_REG_PARMS  1
46 typedef int bool;
47
48 #ifndef max
49 #  define max(a,b) (a > b ? a : b)
50 #endif
51
52 #ifndef min
53 #  define min(a,b) (a < b ? a : b)
54 #endif
55
56 #ifndef THROWS
57 #define THROWS
58 #define THROW_NONE  0
59 #define THROW_SRC   1
60 #define THROW_DEST  2
61 #define THROW_BOTH  3
62 #endif
63
64 /* size's in bytes  */
65 #define CHARSIZE    port->s.char_size
66 #define SHORTSIZE   port->s.short_size
67 #define INTSIZE     port->s.int_size
68 #define LONGSIZE    port->s.long_size
69 #define PTRSIZE     port->s.ptr_size
70 #define FPTRSIZE    port->s.fptr_size
71 #define GPTRSIZE    port->s.gptr_size
72 #define BITSIZE     port->s.bit_size
73 #define FLOATSIZE   port->s.float_size
74 #define MAXBASESIZE port->s.max_base_size
75
76 #define  SMALL_MODEL 0
77 #define  LARGE_MODEL 1
78 #define  TRUE 1
79 #define  FALSE 0
80
81 #define MAX_TVAR 6
82 #define INITIAL_INLINEASM 4*1024
83 #define DEFPOOLSTACK(type,size)     \
84     type       *type##Pool        ; \
85     type *type##FreeStack [size]  ; \
86     int   type##StackPtr = 0      ;
87
88 #define PUSH(x,y)   x##FreeStack[x##StackPtr++] = y
89 #define PEEK(x)     x##FreeStack[x##StackPtr-1]
90 #define POP(type)   type##FreeStack[--type##StackPtr]
91 /* #define POP(x)    (x##StackPtr ? x##FreeStack[--x##StackPtr] :       \
92    (assert(x##StackPtr),0)) */
93 #ifdef UNIX
94 #define EMPTY(x)        (x##StackPtr <= 1 ? 1 : 0)
95 #else
96 #define EMPTY(x)        (x##StackPtr == 0 ? 1 : 0)
97 #endif
98
99
100 #define COPYTYPE(start,end,from) (end = getSpec (start = from))
101
102
103 /* general purpose stack related macros */
104 #define  STACK_DCL(stack,type,size)                                   \
105          typedef  type  t_##stack   ;                                 \
106          t_##stack   stack[size]    ;                                 \
107          t_##stack   (*p_##stack) = stack;
108
109 /* define extern stack */
110 #define EXTERN_STACK_DCL(stack,type,size)                             \
111         typedef type t_##stack     ;                                  \
112         extern t_##stack stack[size] ;                                \
113         extern t_##stack *p_##stack;
114
115 #define  STACK_EMPTY(stack)     ((p_##stack) <= stack )
116 #define  STACK_FULL(stack)      ((p_##stack) >= (stack +              \
117                                 sizeof(stack)/sizeof(*stack))         )
118
119 #define  STACK_PUSH_(stack, x)  (*++p_##stack = (x))
120 #define  STACK_POP_(stack)      (*p_##stack--)
121
122 #define  STACK_PUSH(stack, x)   (STACK_FULL(stack)                    \
123                                 ? (STACK_ERR(1, stack), *p_##stack)   \
124                                 : STACK_PUSH_(stack,x)                )
125
126 #define  STACK_POP(stack)       (STACK_EMPTY(stack)                   \
127                                 ? (STACK_ERR(-1, stack), *p_##stack)  \
128                                 : STACK_POP_(stack)                   )
129
130 #define  STACK_PEEK(stack)      (STACK_EMPTY(stack)                   \
131                                 ? (STACK_ERR(0, stack), *p_##stack)   \
132                                 : *p_##stack                          )
133
134 #define  STACK_ERR(o, stack)    (fatal(1, E_STACK_VIOLATION, #stack,  \
135                                         (o < 0)                       \
136                                         ? "underflow"                 \
137                                         : (o > 0)                     \
138                                           ? "overflow"                \
139                                           : "empty"))
140
141 /* optimization options */
142 struct optimize
143   {
144     unsigned global_cse;
145     unsigned ptrArithmetic;
146     unsigned label1;
147     unsigned label2;
148     unsigned label3;
149     unsigned label4;
150     unsigned loopInvariant;
151     unsigned loopInduction;
152     unsigned noJTabBoundary;
153     unsigned noLoopReverse;
154   };
155
156 /** Build model.
157     Used in options.model.A bit each as port.supported_models is an OR
158     of these. 
159 */
160 enum
161   {
162     MODEL_SMALL = 1,
163     MODEL_COMPACT = 2,
164     MODEL_MEDIUM = 4,
165     MODEL_LARGE = 8,
166     MODEL_FLAT24 = 16,
167     MODEL_PAGE0 = 32 /* for the xa51 port */
168   };
169
170 /* overlay segment name and the functions
171    that belong to it. used by pragma overlay */
172 typedef struct {
173     char *osname;       /* overlay segment name */
174     int  nfuncs;        /* number of functions in this overlay */
175     char *funcs[128];   /* function name that belong to this */
176 } olay;
177
178 /* other command line options */
179 struct options
180   {
181     int model;                  /* see MODEL_* defines above */
182     int stackAuto;              /* Stack Automatic  */
183     int useXstack;              /* use Xternal Stack */
184     int stack10bit;             /* use 10 bit stack (flat24 model only) */
185     int dump_raw;               /* dump after intermediate code generation */
186     int dump_gcse;              /* dump after gcse */
187     int dump_loop;              /* dump after loop optimizations */
188     int dump_kill;              /* dump after dead code elimination */
189     int dump_range;             /* dump after live range analysis */
190     int dump_pack;              /* dump after register packing */
191     int dump_rassgn;            /* dump after register assignment */
192     int dump_tree;              /* dump front-end tree before lowering to iCode */
193     int cc_only;                /* compile only flag              */
194     int intlong_rent;           /* integer & long support routines reentrant */
195     int float_rent;             /* floating point routines are reentrant */
196     int out_fmt;                /* 1 = motorola S19 format 0 = intel Hex format */
197     int cyclomatic;             /* print cyclomatic information */
198     int noOverlay;              /* don't overlay local variables & parameters */
199     int mainreturn;             /* issue a return after main */
200     int xram_movc;              /* use movc instead of movx to read xram (mcs51) */
201     int nopeep;                 /* no peep hole optimization */
202     int asmpeep;                /* pass inline assembler thru peep hole */
203     int debug;                  /* generate extra debug info */
204     int c1mode;                 /* Act like c1 - no pre-proc, asm or link */
205     char *peep_file;            /* additional rules for peep hole */
206     int nostdlib;               /* Don't use standard lib files */
207     int nostdinc;               /* Don't use standard include files */
208     int noRegParams;            /* Disable passing some parameters in registers */
209     int verbose;                /* Show what the compiler is doing */
210     int shortis8bits;           /* treat short like int or char */
211     int lessPedantic;           /* disable some warnings */
212     int profile;                /* Turn on extra profiling information */
213     int ommitFramePtr;          /* Turn off the frame pointer. */
214     int useAccelerator;         /* use ds390 Arithmetic Accelerator */
215     char *calleeSaves[128];     /* list of functions using callee save */
216     char *excludeRegs[32];      /* registers excluded from saving */
217     int noiv;                   /* do not generate irq vector table entries */
218     int all_callee_saves;       /* callee saves for all functions */
219     int stack_probe;            /* insert call to function __stack_probe */
220     int tini_libid;             /* library ID for TINI */
221     int protect_sp_update;      /* DS390 - will disable interrupts during ESP:SP updates */
222     int parms_in_bank1;         /* DS390 - use reg bank1 to pass parameters */
223     olay olays[128];            /* overlay segments used in #pragma OVERLAY */
224     /* starting address of the segments */
225     int xstack_loc;             /* initial location of external stack */
226     int stack_loc;              /* initial value of internal stack pointer */
227     int xdata_loc;              /* xternal ram starts at address */
228     int data_loc;               /* interram start location       */
229     int idata_loc;              /* indirect address space        */
230     int code_loc;               /* code location start           */
231     int iram_size;              /* internal ram size (used only for error checking) */   
232     int xram_size;              /* external ram size (used only for error checking) */
233     bool xram_size_set;         /* since xram_size=0 is a possibility */
234     int code_size;              /* code size (used only for error checking) */    
235     int verboseExec;            /* show what we are doing */
236     int noXinitOpt;             /* don't optimize initialized xdata */
237     int noCcodeInAsm;           /* hide c-code from asm */
238     int iCodeInAsm;             /* show i-code in asm */
239     int printSearchDirs;        /* display the directories in the compiler's search path */
240   };
241
242 /* forward definition for variables accessed globally */
243 extern int noAssemble;         /* no assembly, stop after code generation */
244 extern char *yytext;
245 extern char *currFname;
246 extern char *fullSrcFileName;   /* full name for the source file; */
247                                 /* can be NULL while linking without compiling */
248 extern char *fullDstFileName;   /* full name for the output file; */
249                                 /* only given by -o, otherwise NULL */
250 extern char *dstFileName;       /* destination file name without extension */
251 extern char *dstPath;           /* path for the output files; */
252                                 /* "" is equivalent with cwd */
253 extern char *moduleName;        /* module name is source file without path and extension */
254                                 /* can be NULL while linking without compiling */
255 extern int currLineno;          /* current line number    */
256 extern int yylineno;            /* line number of the current file SDCC.lex */
257 extern FILE *yyin;              /* */
258 extern FILE *asmFile;           /* assembly output file */
259 extern FILE *cdbFile;           /* debugger symbol file */
260 extern int NestLevel;           /* NestLevel                 SDCC.y   */
261 extern int stackPtr;            /* stack pointer             SDCC.y   */
262 extern int xstackPtr;           /* external stack pointer    SDCC.y   */
263 extern int reentrant;           /* /X flag has been sent     SDCC.y */
264 extern char buffer[PATH_MAX * 2];/* general buffer           SDCCmain.c   */
265 extern int currRegBank;         /* register bank being used  SDCCgens.c   */
266 extern int RegBankUsed[4];      /* JCF: register banks used  SDCCmain.c   */
267 extern struct symbol *currFunc; /* current function    SDCCgens.c */
268 extern int cNestLevel;          /* block nest level  SDCCval.c      */
269 extern int currBlockno;         /* sequentail block number */
270 extern struct optimize optimize;
271 extern struct options options;
272 extern unsigned maxInterrupts;
273
274 /* Visible from SDCCmain.c */
275 extern int nrelFiles;
276 extern char *relFiles[128];
277 extern char *libFiles[128];
278 extern int nlibFiles;
279 extern char *libPaths[128];
280 extern int nlibPaths;
281
282 void setParseWithComma (set **, char *);
283 void parseWithComma (char **, char *);
284
285 /** Creates a temporary file a'la tmpfile which avoids the bugs
286     in cygwin wrt c:\tmp.
287     Scans, in order: TMP, TEMP, TMPDIR, else uses tmpfile().
288 */
289 FILE *tempfile (void);
290
291 /** Creates a temporary file name a'la tmpnam which avoids the bugs
292     in cygwin wrt c:\tmp.
293     Scans, in order: TMP, TEMP, TMPDIR, else uses tmpfile().
294 */
295 char *tempfilename (void);
296
297 /** An assert() macro that will go out through sdcc's error
298     system.
299 */
300 #define wassertl(a,s)   ((a) ? 0 : \
301         (werror (E_INTERNAL_ERROR,__FILE__,__LINE__, s), 0))
302
303 #define wassert(a)    wassertl(a,"code generator internal error")
304
305 #define DUMP_RAW0 1
306 #define DUMP_RAW1 DUMP_RAW0+1
307 #define DUMP_CSE DUMP_RAW1+1
308 #define DUMP_DFLOW DUMP_CSE+1
309 #define DUMP_GCSE DUMP_DFLOW+1
310 #define DUMP_DEADCODE DUMP_GCSE+1
311 #define DUMP_LOOP DUMP_DEADCODE+1
312 #define DUMP_LOOPG DUMP_LOOP+1
313 #define DUMP_LOOPD DUMP_LOOPG+1
314 #define DUMP_RANGE DUMP_LOOPD+1
315 #define DUMP_PACK DUMP_RANGE+1
316 #define DUMP_RASSGN DUMP_PACK+1
317 #define DUMP_LRANGE DUMP_RASSGN+1
318
319 struct _dumpFiles {
320   int id;
321   char *ext;
322   FILE *filePtr;
323 };
324
325 extern struct _dumpFiles dumpFiles[];
326
327 /* Buffer which can be used to hold a file name; assume it will
328  * be trashed by any function call within SDCC.
329  */
330 extern char scratchFileName[PATH_MAX];
331
332 #endif