cc68b6741cced10aa1d8194c17e5e8ce915d2861
[libfirm] / ir / be / bestabs.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Stabs support.
23  * @author  Michael Beck
24  * @date    11.9.2006
25  * @version $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <assert.h>
34
35 #include "obst.h"
36 #include "irprog.h"
37 #include "irgraph.h"
38 #include "tv.h"
39 #include "xmalloc.h"
40 #include "pmap.h"
41 #include "pdeq.h"
42 #include "irtools.h"
43 #include "obst.h"
44 #include "array.h"
45 #include "be_dbgout.h"
46 #include "beabi.h"
47
48 /* Non-Stab Symbol and Stab Symbol Types */
49 enum stabs_types {
50         N_UNDF    = 0x00,    /**< 0: Undefined symbol */
51         N_ABS     = 0x02,    /**< 2: File scope absolute symbol */
52         N_TEXT    = 0x04,    /**< 4: File scope text symbol */
53         N_DATA    = 0x06,    /**< 6: File scope data symbol */
54         N_BSS     = 0x08,    /**< 8: File scope BSS symbol */
55         N_INDR    = 0x0A,    /**< 10: Symbol is indirected to another symbol */
56         N_FN_SEQ  = 0x0C,    /**< 12: Same as N_FN, for Sequent compilers */
57         N_COMM    = 0x12,    /**< 18: Common--visible after shared library dynamic link */
58         N_SETA    = 0x14,    /**< 20: Absolute set element */
59         N_SETT    = 0x17,    /**< 23: Text segment set element */
60         N_SETD    = 0x18,    /**< 24: Data segment set element */
61         N_SETB    = 0x1A,    /**< 26: BSS segment set element */
62         N_SETV    = 0x1C,    /**< 28: Pointer to set vector */
63         N_WARNING = 0x1E,    /**< 30: Print a warning message during linking */
64         N_FN      = 0x1F,    /**< 31: File name of a `.o' file */
65         N_GSYM    = 0x20,    /**< 32: Global symbol */
66         N_FNAME   = 0x22,    /**< 34: Function name (for BSD Fortran) */
67         N_FUN     = 0x24,    /**< 36: Function name */
68         N_STSYM   = 0x26,    /**< 38: Data segment file-scope variable */
69         N_LCSYM   = 0x28,    /**< 40: BSS segment file-scope variable */
70         N_MAIN    = 0x2A,    /**< 42: Name of main routine */
71         N_ROSYM   = 0x2C,    /**< 44: Variable in .rodata section */
72         N_PC      = 0x30,    /**< 48: Global symbol (for Pascal) */
73         N_NSYMS   = 0x32,    /**< 50: Number of symbols (according to Ultrix V4.0) */
74         N_NOMAP   = 0x34,    /**< 52: No DST map */
75         N_OBJ     = 0x38,    /**< 56: Object file (Solaris2) */
76         N_OPT     = 0x3C,    /**< 60: Debugger options (Solaris2) */
77         N_RSYM    = 0x40,    /**< 64: Register variable */
78         N_M2C     = 0x42,    /**< 66: Modula-2 compilation unit */
79         N_SLINE   = 0x44,    /**< 68: Line number in text segment */
80         N_DSLINE  = 0x46,    /**< 70: Line number in data segment */
81         N_BSLINE  = 0x48,    /**< 72: Line number in bss segment */
82         N_BROWS   = 0x48,    /**< 72: Sun source code browser, path to `.cb' file */
83         N_DEFD    = 0x4A,    /**< 74: GNU Modula2 definition module dependency */
84         N_FLINE   = 0x4C,    /**< 76: Function start/body/end line numbers (Solaris2) */
85         N_EHDECL  = 0x50,    /**< 80: GNU C++ exception variable */
86         N_MOD2    = 0x50,    /**< 80: Modula2 info "for imc" (according to Ultrix V4.0) */
87         N_CATCH   = 0x54,    /**< 84: GNU C++ catch clause */
88         N_SSYM    = 0x60,    /**< 96: Structure of union element */
89         N_ENDM    = 0x62,    /**< 98: Last stab for module (Solaris2) */
90         N_SO      = 0x64,    /**< 100: Path and name of source file */
91         N_LSYM    = 0x80,    /**< 128: Stack variable */
92         N_BINCL   = 0x82,    /**< 130: Beginning of an include file (Sun only) */
93         N_SOL     = 0x84,    /**< 132: Name of include file */
94         N_PSYM    = 0xA0,    /**< 160: Parameter variable */
95         N_EINCL   = 0xA2,    /**< 162: End of an include file */
96         N_ENTRY   = 0xA4,    /**< 164: Alternate entry point */
97         N_LBRAC   = 0xC0,    /**< 192: Beginning of a lexical block */
98         N_EXCL    = 0xC2,    /**< 194: Place holder for a deleted include file */
99         N_SCOPE   = 0xC4,    /**< 196: Modula2 scope information (Sun linker) */
100         N_RBRAC   = 0xE0,    /**< 224: End of a lexical block */
101         N_BCOMM   = 0xE2,    /**< 226: Begin named common block */
102         N_ECOMM   = 0xE4,    /**< 228: End named common block */
103         N_ECOML   = 0xE8,    /**< 232: Member of a common block */
104         N_WITH    = 0xEA,    /**< 234: Pascal with statement: type,,0,0,offset (Solaris2) */
105         N_NBTEXT  = 0xF0,    /**< 240: Gould non-base registers */
106         N_NBDATA  = 0xF2,    /**< 242: Gould non-base registers */
107         N_NBBSS   = 0xF4,    /**< 244: Gould non-base registers */
108         N_NBSTS   = 0xF6,    /**< 246: Gould non-base registers */
109         N_NBLCS   = 0xF8,    /**< 248: Gould non-base registers */
110 };
111
112 /**
113  * The stabs handle.
114  */
115 typedef struct stabs_handle {
116         dbg_handle              base;         /**< the base class */
117         FILE                    *f;           /**< the file write to */
118         ir_entity               *cur_ent;     /**< current method entity */
119         const be_stack_layout_t *layout;      /**< current stack layout */
120         unsigned                next_type_nr; /**< next type number */
121         pmap                    *type_map;    /**< a map from type to type number */
122         const char              *main_file;   /**< name of the main source file */
123         const char              *curr_file;   /**< name of the current source file */
124 } stabs_handle;
125
126 /**
127  * Returns the stabs type number of a Firm type.
128  */
129 static unsigned get_type_number(stabs_handle *h, ir_type *tp) {
130         pmap_entry *entry;
131         unsigned num;
132
133         if (tp == NULL) {
134                 /* map to the void type */
135                 return 0;
136         }
137         entry = pmap_find(h->type_map, tp);
138         if (! entry) {
139                 num = h->next_type_nr++;
140                 pmap_insert(h->type_map, tp, INT_TO_PTR(num));
141         } else {
142                 num = PTR_TO_INT(entry->value);
143         }
144         return num;
145 }  /* get_type_number */
146
147 /**
148  * Map a given Type to void by assigned the type number 0.
149  */
150 static void map_to_void(stabs_handle *h, ir_type *tp) {
151         pmap_insert(h->type_map, tp, INT_TO_PTR(0));
152 }
153
154 /**
155  * generate the void type.
156  */
157 static void gen_void_type(stabs_handle *h) {
158         fprintf(h->f, "\t.stabs\t\"void:t%u=%u\",%d,0,0,0\n", 0, 0, N_LSYM);
159 }  /* gen_void_type */
160
161 typedef struct walker_env {
162         stabs_handle *h;
163         waitq        *wq;
164 } wenv_t;
165
166 /* a type is not ready: put it on the wait queue */
167 #define SET_TYPE_NOT_READY(wq, tp) \
168   do { \
169     set_type_link(tp, (void *)1);  \
170     waitq_put(wq, tp);             \
171   } while(0)
172
173 /* a the is ready */
174 #define SET_TYPE_READY(tp)     set_type_link(tp, NULL)
175
176 /* check whether a type is ready */
177 #define IS_TYPE_READY(tp)      (get_type_link(tp) == NULL)
178
179 #ifdef EXPLICITE_PTR_TYPES
180 #define SKIP_PTR(tp)  tp
181 #else
182 #define SKIP_PTR(tp)   (is_Pointer_type(tp) ? get_pointer_points_to_type(tp) : tp)
183 #endif
184
185 /**
186  * Generates a primitive type.
187  *
188  * @param h    the stabs handle
189  * @param tp   the type
190  */
191 static void gen_primitive_type(stabs_handle *h, ir_type *tp) {
192         ir_mode *mode = get_type_mode(tp);
193         unsigned type_num;
194
195         SET_TYPE_READY(tp);
196         if (mode == mode_T) {
197                 /* firmcc, jack and the FirmJC compiler use mode_T for the void type.
198                 Ignore it here as it's name is remapped to "void". */
199                 map_to_void(h, tp);
200                 return;
201         }  /* if */
202
203         if (0 && get_mode_size_bits(mode) & 7) {
204                 /* this is a bitfield type, ignore it */
205                 return;
206         }  /* if */
207
208         type_num = get_type_number(h, tp);
209
210         if (mode_is_int(mode)) {
211                 char buf[64];
212                 fprintf(h->f, "\t.stabs\t\"%s:t%u=r%u;", get_type_name(tp), type_num, type_num);
213                 tarval_snprintf(buf, sizeof(buf), get_mode_min(mode));
214                 fprintf(h->f, "%s;", buf);
215                 tarval_snprintf(buf, sizeof(buf), get_mode_max(mode));
216                 fprintf(h->f, "%s;\",%d,0,0,0\n", buf, N_LSYM);
217         } else if (mode_is_float(mode)) {
218                 int size = get_type_size_bytes(tp);
219                 fprintf(h->f, "\t.stabs\t\"%s:t%u=r1;%d;0;\",%d,0,0,0\n", get_type_name(tp), type_num, size, N_LSYM);
220         }
221 }  /* gen_primitive_type */
222
223 /**
224  * Generates an enum type
225  *
226  * @param h    the stabs handle
227  * @param tp   the type
228  */
229 static void gen_enum_type(stabs_handle *h, ir_type *tp) {
230         unsigned type_num = get_type_number(h, tp);
231         int i, n;
232
233         SET_TYPE_READY(tp);
234         fprintf(h->f, "\t.stabs\t\"%s:T%u=e", get_type_name(tp), type_num);
235         for (i = 0, n = get_enumeration_n_enums(tp); i < n; ++i) {
236                 ir_enum_const *ec = get_enumeration_const(tp, i);
237                 char buf[64];
238
239                 tarval_snprintf(buf, sizeof(buf), get_enumeration_value(ec));
240                 fprintf(h->f, "%s:%s,", get_enumeration_name(ec), buf);
241         }
242         fprintf(h->f, ";\",%d,0,0,0\n", N_LSYM);
243 }  /* gen_enum_type */
244
245 /**
246  * print a pointer type
247  */
248 void print_pointer_type(stabs_handle *h, ir_type *tp, int local) {
249         unsigned     type_num = local ? h->next_type_nr++ : get_type_number(h, tp);
250         ir_type      *el_tp   = get_pointer_points_to_type(tp);
251         unsigned     el_num   = get_type_number(h, el_tp);
252
253         fprintf(h->f, "%u=*%u", type_num, el_num);
254 }
255
256 /**
257  * Generates a pointer type
258  *
259  * @param env  the walker environment
260  * @param tp   the type
261  */
262 static void gen_pointer_type(wenv_t *env, ir_type *tp) {
263         stabs_handle *h       = env->h;
264         ir_type      *el_tp   = get_pointer_points_to_type(tp);
265
266         SET_TYPE_READY(tp);
267         if (! IS_TYPE_READY(el_tp))
268                 waitq_put(env->wq, el_tp);
269
270         fprintf(h->f, "\t.stabs\t\"%s:t", get_type_name(tp));
271         print_pointer_type(h, tp, 0);
272         fprintf(h->f, "\",%d,0,0,0\n", N_LSYM);
273 }  /* gen_pointer_type */
274
275 /**
276  * print an array type
277  */
278 static void print_array_type(stabs_handle *h, ir_type *tp, int local) {
279         ir_type      *etp     = get_array_element_type(tp);
280         int          i, n     = get_array_n_dimensions(tp);
281         unsigned     type_num = local ? h->next_type_nr++ : get_type_number(h, tp);
282         int          *perm;
283
284         fprintf(h->f, "%u=a", type_num);
285         NEW_ARR_A(int, perm, n);
286         for (i = 0; i < n; ++i) {
287                 perm[i] = get_array_order(tp, i);
288         }
289
290         for (i = 0; i < n; ++i) {
291                 int dim = perm[i];
292
293                 if (is_Const(get_array_lower_bound(tp, dim)) && is_Const(get_array_upper_bound(tp, dim))) {
294                         long min = get_array_lower_bound_int(tp, dim);
295                         long max = get_array_upper_bound_int(tp, dim);
296
297                         /* FIXME r1 must be integer type, but seems to work for now */
298                         fprintf(h->f, "r1;%ld;%ld;", min, max-1);
299                 }
300         }
301
302         type_num = get_type_number(h, etp);
303         fprintf(h->f, "%d", type_num);
304 }
305
306 /**
307  * Generates an array type
308  *
309  * @param env  the walker environment
310  * @param tp   the type
311  */
312 static void gen_array_type(wenv_t *env, ir_type *tp) {
313         stabs_handle *h   = env->h;
314         ir_type      *etp = get_array_element_type(tp);
315
316         SET_TYPE_READY(tp);
317         if (! IS_TYPE_READY(etp))
318                 waitq_put(env->wq, etp);
319
320         fprintf(h->f, "\t.stabs\t\"%s:t", get_type_name(tp));
321
322         print_array_type(h, tp, 0);
323
324         fprintf(h->f, "\",%d,0,0,0\n", N_LSYM);
325 }  /* gen_array_type */
326
327 /**
328  * Generates a struct/union type
329  *
330  * @param env  the walker environment
331  * @param tp   the type
332  */
333 static void gen_struct_union_type(wenv_t *env, ir_type *tp) {
334         stabs_handle *h       = env->h;
335         unsigned     type_num = get_type_number(h, tp);
336         int          i, n;
337         char         desc = 's';
338
339         SET_TYPE_READY(tp);
340         if (is_Struct_type(tp)) {
341                 desc = 's';
342                 if (get_type_mode(tp) != NULL) {
343                         /* this is a bitfield type, ignore it safely */
344                         return;
345                 }
346         }
347         else if (is_Union_type(tp))
348                 desc = 'u';
349
350         fprintf(h->f, "\t.stabs\t\"%s:Tt%u=%c%d",
351                 get_type_name(tp), type_num, desc, get_type_size_bytes(tp));
352
353         for (i = 0, n = get_compound_n_members(tp); i < n; ++i) {
354                 ir_entity *ent = get_compound_member(tp, i);
355                 ir_type   *mtp = get_entity_type(ent);
356                 int ofs, size;
357
358                 if (! IS_TYPE_READY(mtp))
359                         waitq_put(env->wq, mtp);
360                 ofs  = get_entity_offset(ent);
361                 if (is_Struct_type(mtp) && get_type_mode(mtp) != NULL) {
362                         /* this structure is a bitfield, skip */
363                         int i, n;
364
365                         for (i = 0, n = get_struct_n_members(mtp); i < n; ++i) {
366                                 ir_entity *ent = get_struct_member(mtp, i);
367                                 ir_type *tp = get_entity_type(ent);
368                                 int bofs;
369
370                                 type_num = get_type_number(h, tp);
371                                 size = get_type_size_bits(tp);
372                                 bofs = (ofs + get_entity_offset(ent)) * 8 + get_entity_offset_bits_remainder(ent);
373
374                                 /* name:type, bit offset from the start of the struct', number of bits in the element. */
375                                 fprintf(h->f, "%s:%u,%d,%d;", get_entity_name(ent), type_num, bofs, size);
376                         }
377                 } else {
378                         /* no bitfield */
379                         fprintf(h->f, "%s:", get_entity_name(ent));
380
381                         if (is_Array_type(mtp)) {
382                                 /* use a local array definition */
383                                 print_array_type(h, mtp, 1);
384                         } else if (is_Pointer_type(mtp)) {
385                                 /* use local pointer definition */
386                                 print_pointer_type(h, mtp, 1);
387                         } else {
388                                 type_num = get_type_number(h, mtp);
389
390                                 /* name:type, bit offset from the start of the struct', number of bits in the element. */
391                                 fprintf(h->f, "%u", type_num);
392                         }
393                         size = get_type_size_bits(mtp);
394                         fprintf(h->f, ",%d,%d;", ofs * 8, size);
395                 }
396         }
397         fprintf(h->f, ";\",%d,0,0,0\n", N_LSYM);
398 }  /* gen_struct_type */
399
400 /**
401  * Generates a method type
402  *
403  * @param env  the walker environment
404  * @param tp   the type
405  */
406 static void gen_method_type(wenv_t *env, ir_type *tp) {
407         stabs_handle *h       = env->h;
408         unsigned     type_num = get_type_number(h, tp);
409         ir_type *rtp = NULL;
410         unsigned res_type_num;
411         int i, n = get_method_n_ress(tp);
412
413         SET_TYPE_READY(tp);
414         if (n > 0) {
415                 rtp = get_method_res_type(tp, 0);
416                 if (! IS_TYPE_READY(rtp))
417                         waitq_put(env->wq, rtp);
418         }
419         res_type_num = get_type_number(h, rtp);
420
421         fprintf(h->f, "\t.stabs\t\"%s:t%u=f%u", get_type_name(tp), type_num, res_type_num);
422
423         /* handle more than one return type */
424         for (i = 1; i < n; ++i) {
425                 rtp = get_method_res_type(tp, i);
426                 if (! IS_TYPE_READY(rtp))
427                         waitq_put(env->wq, rtp);
428                 res_type_num = get_type_number(h, rtp);
429                 fprintf(h->f, ",%u", res_type_num);
430         }
431         fprintf(h->f, "\",%d,0,0,0\n", N_LSYM);
432 }  /* gen_method_type */
433
434 /**
435  * type-walker: generate declaration for simple types,
436  * put all other types on a wait queue
437  */
438 static void walk_type(type_or_ent *tore, void *ctx)
439 {
440         wenv_t *env = ctx;
441         ir_type  *tp;
442
443         if (get_kind(tore) == k_type) {
444                 tp = (ir_type *)tore;
445
446                 /* ignore the unknown type */
447                 if (tp == firm_unknown_type)
448                         return;
449         } else {
450                 return;
451         }  /* if */
452
453         switch (get_type_tpop_code(tp)) {
454         case tpo_class:
455                 if (tp == get_glob_type()) {
456                         SET_TYPE_READY(tp);
457                         break;
458                 }
459                 /* fall through */
460         case tpo_struct:
461         case tpo_union:
462                 gen_struct_union_type(env, tp);
463                 break;
464
465         case tpo_enumeration:
466                 gen_enum_type(env->h, tp);
467                 break;
468
469         case tpo_primitive:
470                 gen_primitive_type(env->h, tp);
471                 break;
472
473         case tpo_method:
474                 gen_method_type(env, tp);
475                 break;
476
477         case tpo_array:
478                 gen_array_type(env, tp);
479                 break;
480
481         case tpo_pointer:
482                 gen_pointer_type(env, tp);
483                 break;
484
485         case tpo_unknown:
486                 /* the unknown type: ignore */
487                 SET_TYPE_READY(tp);
488                 break;
489         default:
490                 assert(! "Unknown tpop code");
491         }  /* switch */
492 }  /* walk_type */
493
494 /**
495  * generate declaration for all types
496  */
497 static void finish_types(wenv_t *env)
498 {
499         waitq *wq = env->wq;
500         ir_type *tp;
501
502         while (! waitq_empty(wq)) {
503                 tp = waitq_get(wq);
504                 if (IS_TYPE_READY(tp))
505                         continue;
506
507                 switch (get_type_tpop_code(tp)) {
508                 case tpo_method:
509                         gen_method_type(env, tp);
510                         break;
511                 case tpo_class:
512                 case tpo_union:
513                 case tpo_struct:
514                         gen_struct_union_type(env, tp);
515                         break;
516                 case tpo_enumeration:
517                         gen_enum_type(env->h, tp);
518                         break;
519                 case tpo_primitive:
520                         gen_primitive_type(env->h, tp);
521                         break;
522                 case tpo_array:
523                         gen_array_type(env, tp);
524                         break;
525                 case tpo_pointer:
526                         gen_pointer_type(env, tp);
527                         break;
528                 case tpo_unknown:
529                         /* the unknown type: ignore */
530                         SET_TYPE_READY(tp);
531                         break;
532                 default:
533                         assert(! "Unknown tpop code");
534                 }  /* switch */
535         }  /* while */
536 }  /* finish_types */
537
538 /**
539  * generate all types.
540  */
541 static void gen_types(stabs_handle *h) {
542         wenv_t env;
543
544         env.h  = h;
545         env.wq = new_waitq();
546         type_walk(NULL, walk_type, &env);
547         finish_types(&env);
548         del_waitq(env.wq);
549 }  /* gen_types */
550
551
552 /* -------------------------- I/F ----------------------------- */
553
554 /**
555  * start a new source object (compilation unit)
556  */
557 static void stabs_so(dbg_handle *handle, const char *filename) {
558         stabs_handle *h = (stabs_handle *)handle;
559         h->main_file = h->curr_file = filename;
560         fprintf(h->f, "\t.stabs\t\"%s\",%d,0,0,.Ltext0\n", filename, N_SO);
561 }  /* stabs_so */
562
563 /**
564  * end an include file
565  */
566 static void stabs_include_end(dbg_handle *handle) {
567         stabs_handle *h = (stabs_handle *)handle;
568         h->curr_file = h->main_file;
569 }  /* stabs_include_end */
570
571 /**
572  * start an include file
573  */
574 static void stabs_include_begin(dbg_handle *handle, const char *filename) {
575         stabs_handle *h = (stabs_handle *)handle;
576         if (h->main_file != h->curr_file)
577                 stabs_include_end(handle);
578         h->curr_file = filename;
579         fprintf(h->f, "\t.stabs\t\"%s\",%d,0,0,0\n", filename, N_SOL);
580 }  /* stabs_include_begin */
581
582 /**
583  * Main Program
584  */
585 static void stabs_main_program(dbg_handle *handle) {
586         stabs_handle *h = (stabs_handle *)handle;
587         ir_graph *irg = get_irp_main_irg();
588         if (irg) {
589                 fprintf(h->f, "\t.stabs\t\"%s\",%d,0,0,0\n", get_entity_name(get_irg_entity(irg)), N_MAIN);
590         }
591 }  /* stabs_main_program */
592
593 /**
594  * prints a line number
595  */
596 static void stabs_line(dbg_handle *handle, unsigned lineno, const char *address) {
597         stabs_handle *h = (stabs_handle *)handle;
598         fprintf(h->f, "\t.stabn\t%d, 0, %u, %s-%s\n", N_SLINE, lineno, address, get_entity_ld_name(h->cur_ent));
599 }  /* stabs_line */
600
601 /**
602  * dump the stabs for a method begin
603  */
604 static void stabs_method_begin(dbg_handle *handle, ir_entity *ent, const be_stack_layout_t *layout) {
605         stabs_handle *h = (stabs_handle *)handle;
606         ir_type      *mtp, *rtp;
607         unsigned     type_num;
608         int          i, n, between_size;
609
610         h->cur_ent = ent;
611         h->layout  = layout;
612
613         /* create the method entry */
614         mtp = get_entity_type(ent);
615         if (is_lowered_type(mtp))
616                 mtp = get_associated_type(mtp);
617         if (get_method_n_ress(mtp) > 0)
618                 rtp = get_method_res_type(mtp, 0);
619         else
620                 rtp = NULL;
621         type_num = get_type_number(h, rtp);
622         fprintf(h->f, "\t.stabs\t\"%s:%c%u\",%u,0,0,%s\n",
623                 get_entity_name(ent),
624                 get_entity_visibility(ent) == visibility_external_visible ? 'F' : 'f',
625                 type_num,
626                 N_FUN,
627                 get_entity_ld_name(ent));
628
629         /* create parameter entries */
630         between_size = get_type_size_bytes(layout->between_type);
631         for (i = 0, n = get_method_n_params(mtp); i < n; ++i) {
632                 ir_type *ptp      = get_method_param_type(mtp, i);
633         const char *name  = get_method_param_name(mtp, i);
634                 unsigned type_num = get_type_number(h, ptp);
635         char buf[16];
636         int ofs = 0;
637                 ir_entity *stack_ent;
638
639         if (! name) {
640           snprintf(buf, sizeof(buf), "arg%d", i);
641           name = buf;
642         }
643                 /* check if this parameter has a stack entity. If it has, it
644                    it transmitted on the stack, else in a register */
645                 stack_ent = layout->param_map[i];
646                 if (stack_ent) {
647                         ofs = get_entity_offset(stack_ent) + between_size;
648                 }
649                 fprintf(h->f, "\t.stabs\t\"%s:p", name);
650                 if (is_Array_type(ptp)) {
651                         /* use a local array definition */
652                         print_array_type(h, ptp, 1);
653                 } else if (is_Pointer_type(ptp)) {
654                         /* use local pointer definition */
655                         print_pointer_type(h, ptp, 1);
656                 } else {
657                         type_num = get_type_number(h, ptp);
658
659                         /* name:type, bit offset from the start of the struct', number of bits in the element. */
660                         fprintf(h->f, "%u", type_num);
661                 }
662
663                 fprintf(h->f, "\",%d,0,0,%d\n", N_PSYM, ofs);
664         }
665 }  /* stabs_method_begin */
666
667 /**
668  * dump the stabs for a method end
669  */
670 static void stabs_method_end(dbg_handle *handle) {
671         stabs_handle            *h = (stabs_handle *)handle;
672         ir_entity               *ent = h->cur_ent;
673         const be_stack_layout_t *layout = h->layout;
674         const char              *ld_name = get_entity_ld_name(ent);
675         int                     i, n, frame_size;
676         static unsigned         scope_nr = 0;
677
678         /* create entries for automatic variables on the stack */
679         frame_size = get_type_size_bytes(layout->frame_type);
680         for (i = 0, n = get_compound_n_members(layout->frame_type); i < n; ++i) {
681                 ir_entity *ent = get_compound_member(layout->frame_type, i);
682                 ir_type *tp;
683                 int ofs;
684                 unsigned type_num;
685
686                 /* ignore spill slots and other helper objects */
687                 if (is_entity_compiler_generated(ent))
688                         continue;
689
690                 tp = get_entity_type(ent);
691                 /* should not happen in backend but ... */
692                 if (is_Method_type(tp))
693                         continue;
694                 type_num = get_type_number(h, tp);
695                 ofs      = -frame_size + get_entity_offset(ent);
696
697                 fprintf(h->f, "\t.stabs\t\"%s:%u\",%d,0,0,%d\n",
698                         get_entity_name(ent), type_num, N_LSYM, ofs);
699         }
700         /* we need a lexical block here */
701         fprintf(h->f, "\t.stabn\t%d,0,0,%s-%s\n", N_LBRAC, ld_name, ld_name);
702         fprintf(h->f, "\t.stabn\t%d,0,0,.Lscope%u-%s\n", N_RBRAC, scope_nr, ld_name);
703         fprintf(h->f, ".Lscope%u:\n", scope_nr);
704         ++scope_nr;
705
706         h->cur_ent = NULL;
707         h->layout  = NULL;
708 }  /* stabs_method_end */
709
710 /**
711  * dump types
712  */
713 static void stabs_types(dbg_handle *handle) {
714         stabs_handle *h = (stabs_handle *)handle;
715
716         /* allocate the zero for the void type */
717         h->next_type_nr++;
718         gen_void_type(h);
719         gen_types(h);
720 }  /* stabs_types */
721
722 /**
723  * dump a variable in the global type
724  */
725 static void stabs_variable(dbg_handle *handle, struct obstack *obst, ir_entity *ent) {
726         stabs_handle *h = (stabs_handle *)handle;
727         unsigned tp_num = get_type_number(h, get_entity_type(ent));
728         char buf[1024];
729
730         if (get_entity_visibility(ent) == visibility_external_visible) {
731                 /* a global variable */
732                 snprintf(buf, sizeof(buf), "\t.stabs\t\"%s:G%u\",%d,0,0,0\n",
733                         get_entity_name(ent), tp_num, N_GSYM);
734         } else { /* some kind of local */
735                 ir_variability variability = get_entity_variability(ent);
736                 int kind = N_STSYM;
737
738                 if (variability == variability_uninitialized)
739                         kind = N_LCSYM;
740                 else if (variability == variability_constant)
741                         kind = N_ROSYM;
742                 snprintf(buf, sizeof(buf), "\t.stabs\t\"%s:S%u\",%d,0,0,%s\n",
743                         get_entity_name(ent), tp_num, kind, get_entity_ld_name(ent));
744         }
745         buf[sizeof(buf) - 1] = '\0';
746
747         if (obst)
748                 obstack_printf(obst, "%s", buf);
749         else
750                 fprintf(h->f, "%s", buf);
751 }  /* stabs_variable */
752
753 /**
754  * Close the stabs handler.
755  */
756 static void stabs_close(dbg_handle *handle) {
757         stabs_handle *h = (stabs_handle *)handle;
758         pmap_destroy(h->type_map);
759         free(h);
760 }  /* stabs_close */
761
762 /** The stabs operations. */
763 static const debug_ops stabs_ops = {
764         stabs_close,
765         stabs_so,
766     stabs_include_begin,
767     stabs_include_end,
768         stabs_main_program,
769         stabs_method_begin,
770         stabs_method_end,
771         stabs_line,
772         stabs_types,
773         stabs_variable
774 };
775
776 /* Opens the NULL handler */
777 dbg_handle *be_nulldbg_open(void) {
778         return NULL;
779 }  /* be_nulldbg_open */
780
781 /* Opens a stabs handler */
782 dbg_handle *be_stabs_open(FILE *out) {
783         stabs_handle *h = xmalloc(sizeof(*h));
784
785         h->base.ops     = &stabs_ops;
786         h->f            = out;
787         h->cur_ent      = NULL;
788         h->layout       = NULL;
789         h->next_type_nr = 0;
790         h->type_map     = pmap_create_ex(64);
791         h->main_file    = NULL;
792         h->curr_file    = NULL;
793
794         return &h->base;
795 }  /* stabs_open */
796
797 /** close a debug handler. */
798 void be_dbg_close(dbg_handle *h) {
799         if (h && h->ops->close)
800                 h->ops->close(h);
801 }  /* be_dbg_close */
802
803 /**
804  * start a new source object (compilation unit)
805  */
806 void be_dbg_so(dbg_handle *h, const char *filename) {
807         if (h && h->ops->so)
808                 h->ops->so(h, filename);
809 }  /* be_dbg_begin */
810
811 /**
812  * start an include file
813  */
814 void be_dbg_include_begin(dbg_handle *h, const char *filename) {
815         if (h && h->ops->include_begin)
816                 h->ops->include_begin(h, filename);
817 }  /* stabs_include_begin */
818
819 /**
820  * end an include file
821  */
822 void be_dbg_include_end(dbg_handle *h) {
823         if (h && h->ops->include_end)
824                 h->ops->include_end(h);
825 }  /* stabs_include_end */
826
827 /**
828  * Main program
829  */
830 void be_dbg_main_program(dbg_handle *h) {
831         if (h && h->ops->main_program)
832                 h->ops->main_program(h);
833 }  /* be_dbg_main_program */
834
835 /** debug for a method begin */
836 void be_dbg_method_begin(dbg_handle *h, ir_entity *ent, const be_stack_layout_t *layout) {
837         if (h && h->ops->method_begin)
838                 h->ops->method_begin(h, ent, layout);
839 }  /* be_dbg_method_begin */
840
841 /** debug for a method end */
842 void be_dbg_method_end(dbg_handle *h) {
843         if (h && h->ops->method_end)
844                 h->ops->method_end(h);
845 }  /* be_dbg_method_end */
846
847 /** debug for line number */
848 void be_dbg_line(dbg_handle *h, unsigned lineno, const char *address) {
849         if (h && h->ops->line)
850                 h->ops->line(h, lineno, address);
851 }  /* be_dbg_line */
852
853 /** dump types */
854 void be_dbg_types(dbg_handle *h) {
855         if (h && h->ops->types)
856                 h->ops->types(h);
857 }  /* be_dbg_types */
858
859 /** dump a global */
860 void be_dbg_variable(dbg_handle *h, struct obstack *obst, ir_entity *ent) {
861         if (h && h->ops->variable)
862                 h->ops->variable(h, obst, ent);
863 }  /* be_dbg_variable */