28 #include "be_dbgout.h"
31 /* Non-Stab Symbol and Stab Symbol Types */
33 N_UNDF = 0x00, /**< 0: Undefined symbol */
34 N_ABS = 0x02, /**< 2: File scope absolute symbol */
35 N_TEXT = 0x04, /**< 4: File scope text symbol */
36 N_DATA = 0x06, /**< 6: File scope data symbol */
37 N_BSS = 0x08, /**< 8: File scope BSS symbol */
38 N_INDR = 0x0A, /**< 10: Symbol is indirected to another symbol */
39 N_FN_SEQ = 0x0C, /**< 12: Same as N_FN, for Sequent compilers */
40 N_COMM = 0x12, /**< 18: Common--visible after shared library dynamic link */
41 N_SETA = 0x14, /**< 20: Absolute set element */
42 N_SETT = 0x17, /**< 23: Text segment set element */
43 N_SETD = 0x18, /**< 24: Data segment set element */
44 N_SETB = 0x1A, /**< 26: BSS segment set element */
45 N_SETV = 0x1C, /**< 28: Pointer to set vector */
46 N_WARNING = 0x1E, /**< 30: Print a warning message during linking */
47 N_FN = 0x1F, /**< 31: File name of a `.o' file */
48 N_GSYM = 0x20, /**< 32: Global symbol */
49 N_FNAME = 0x22, /**< 34: Function name (for BSD Fortran) */
50 N_FUN = 0x24, /**< 36: Function name */
51 N_STSYM = 0x26, /**< 38: Data segment file-scope variable */
52 N_LCSYM = 0x28, /**< 40: BSS segment file-scope variable */
53 N_MAIN = 0x2A, /**< 42: Name of main routine */
54 N_ROSYM = 0x2C, /**< 44: Variable in .rodata section */
55 N_PC = 0x30, /**< 48: Global symbol (for Pascal) */
56 N_NSYMS = 0x32, /**< 50: Number of symbols (according to Ultrix V4.0) */
57 N_NOMAP = 0x34, /**< 52: No DST map */
58 N_OBJ = 0x38, /**< 56: Object file (Solaris2) */
59 N_OPT = 0x3C, /**< 60: Debugger options (Solaris2) */
60 N_RSYM = 0x40, /**< 64: Register variable */
61 N_M2C = 0x42, /**< 66: Modula-2 compilation unit */
62 N_SLINE = 0x44, /**< 68: Line number in text segment */
63 N_DSLINE = 0x46, /**< 70: Line number in data segment */
64 N_BSLINE = 0x48, /**< 72: Line number in bss segment */
65 N_BROWS = 0x48, /**< 72: Sun source code browser, path to `.cb' file */
66 N_DEFD = 0x4A, /**< 74: GNU Modula2 definition module dependency */
67 N_FLINE = 0x4C, /**< 76: Function start/body/end line numbers (Solaris2) */
68 N_EHDECL = 0x50, /**< 80: GNU C++ exception variable */
69 N_MOD2 = 0x50, /**< 80: Modula2 info "for imc" (according to Ultrix V4.0) */
70 N_CATCH = 0x54, /**< 84: GNU C++ catch clause */
71 N_SSYM = 0x60, /**< 96: Structure of union element */
72 N_ENDM = 0x62, /**< 98: Last stab for module (Solaris2) */
73 N_SO = 0x64, /**< 100: Path and name of source file */
74 N_LSYM = 0x80, /**< 128: Stack variable */
75 N_BINCL = 0x82, /**< 130: Beginning of an include file (Sun only) */
76 N_SOL = 0x84, /**< 132: Name of include file */
77 N_PSYM = 0xA0, /**< 160: Parameter variable */
78 N_EINCL = 0xA2, /**< 162: End of an include file */
79 N_ENTRY = 0xA4, /**< 164: Alternate entry point */
80 N_LBRAC = 0xC0, /**< 192: Beginning of a lexical block */
81 N_EXCL = 0xC2, /**< 194: Place holder for a deleted include file */
82 N_SCOPE = 0xC4, /**< 196: Modula2 scope information (Sun linker) */
83 N_RBRAC = 0xE0, /**< 224: End of a lexical block */
84 N_BCOMM = 0xE2, /**< 226: Begin named common block */
85 N_ECOMM = 0xE4, /**< 228: End named common block */
86 N_ECOML = 0xE8, /**< 232: Member of a common block */
87 N_WITH = 0xEA, /**< 234: Pascal with statement: type,,0,0,offset (Solaris2) */
88 N_NBTEXT = 0xF0, /**< 240: Gould non-base registers */
89 N_NBDATA = 0xF2, /**< 242: Gould non-base registers */
90 N_NBBSS = 0xF4, /**< 244: Gould non-base registers */
91 N_NBSTS = 0xF6, /**< 246: Gould non-base registers */
92 N_NBLCS = 0xF8, /**< 248: Gould non-base registers */
98 typedef struct stabs_handle {
99 dbg_handle base; /**< the base class */
100 FILE *f; /**< the file write to */
101 entity *cur_ent; /**< current method entity */
102 const be_stack_layout_t *layout; /**< current stack layout */
103 unsigned next_type_nr; /**< next type number */
104 pmap *type_map; /**< a map from type to type number */
108 * Returns the stabs type number of a Firm type.
110 static unsigned get_type_number(stabs_handle *h, ir_type *tp) {
114 /* map to the void type */
117 entry = pmap_find(h->type_map, tp);
118 return entry ? PTR_TO_INT(entry->value) : 0;
119 } /* get_type_number */
122 * Assign a stabs type number to a Firm type.
124 static unsigned assign_type_number(stabs_handle *h, ir_type *tp) {
127 /* map to the void type */
130 num = h->next_type_nr++;
131 pmap_insert(h->type_map, tp, INT_TO_PTR(num));
133 } /* assign_type_number */
136 * generate the void type.
138 static void gen_void_type(stabs_handle *h) {
139 fprintf(h->f, "\t.stabs\t\"void:t%u=%u\",%d,0,0,0\n", 0, 0, N_LSYM);
140 } /* gen_void_type */
142 typedef struct walker_env {
147 /* a type is not ready: put it on the wait queue */
148 #define SET_TYPE_NOT_READY(wq, tp) \
150 set_type_link(tp, (void *)1); \
155 #define SET_TYPE_READY(tp) set_type_link(tp, NULL)
157 /* check whether a type is ready */
158 #define IS_TYPE_READY(tp) (get_type_link(tp) == NULL)
160 #ifdef EXPLICITE_PTR_TYPES
161 #define SKIP_PTR(tp) tp
163 #define SKIP_PTR(tp) (is_Pointer_type(tp) ? get_pointer_points_to_type(tp) : tp)
167 * Generates a primitive type.
169 * @param h the stabs handle
172 static void gen_primitive_type(stabs_handle *h, ir_type *tp)
174 ir_mode *mode = get_type_mode(tp);
177 if (mode == mode_T) {
178 /* jack and FirmJC compiler use mode_T for the void type.
179 Ignore it here as it's name is remapped to "void". */
183 if (0 && get_mode_size_bits(mode) & 7) {
184 /* this is a bitfield type, ignore it */
188 type_num = assign_type_number(h, tp);
190 if (mode_is_int(mode)) {
192 fprintf(h->f, "\t.stabs\t\"%s:t%u=r%u;", get_type_name(tp), type_num, type_num);
193 tarval_snprintf(buf, sizeof(buf), get_mode_min(mode));
194 fprintf(h->f, "%s;", buf);
195 tarval_snprintf(buf, sizeof(buf), get_mode_max(mode));
196 fprintf(h->f, "%s;\",%d,0,0,0\n", buf, N_LSYM);
197 } else if (mode_is_float(mode)) {
198 int size = get_type_size_bytes(tp);
199 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);
201 } /* gen_primitive_type */
204 * Generates an enum type
206 * @param h the stabs handle
209 static void gen_enum_type(stabs_handle *h, ir_type *tp) {
210 unsigned type_num = assign_type_number(h, tp);
213 fprintf(h->f, "\t.stabs\t\"%s:T%u=e", get_type_name(tp), type_num);
214 for (i = 0, n = get_enumeration_n_enums(tp); i < n; ++i) {
215 ir_enum_const *ec = get_enumeration_const(tp, i);
218 tarval_snprintf(buf, sizeof(buf), get_enumeration_value(ec));
219 fprintf(h->f, "%s:%s,", get_enumeration_name(ec), buf);
221 fprintf(h->f, ";\",%d,0,0,0\n", N_LSYM);
222 } /* gen_enum_type */
225 * Generates a pointer type
227 * @param h the stabs handle
230 static void gen_pointer_type(stabs_handle *h, ir_type *tp) {
231 unsigned type_num = assign_type_number(h, tp);
232 unsigned el_num = get_type_number(h, get_pointer_points_to_type(tp));
234 fprintf(h->f, "\t.stabs\t\"%s:t%u=*%u\",%d,0,0,0\n",
235 get_type_name(tp), type_num, el_num, N_LSYM);
236 } /* gen_pointer_type */
239 * Generates a struct/union type
241 * @param h the stabs handle
244 static void gen_struct_union_type(stabs_handle *h, ir_type *tp) {
245 unsigned type_num = assign_type_number(h, tp);
249 if (is_Struct_type(tp)) {
251 if (get_type_mode(tp) != NULL) {
252 /* this is a bitfield type, ignore it safely */
259 fprintf(h->f, "\t.stabs\t\"%s:T%u=%c%d",
260 get_type_name(tp), type_num, desc, get_type_size_bytes(tp));
262 for (i = 0, n = get_compound_n_members(tp); i < n; ++i) {
263 entity *ent = get_compound_member(tp, i);
264 ir_type *mtp = get_entity_type(ent);
267 ofs = get_entity_offset_bits(ent);
268 if (is_Struct_type(mtp) && get_type_mode(mtp) != NULL) {
269 /* this structure is a bitfield, skip */
272 for (i = 0, n = get_struct_n_members(mtp); i < n; ++i) {
273 entity *ent = get_struct_member(mtp, i);
274 ir_type *tp = get_entity_type(ent);
277 type_num = get_type_number(h, tp);
278 size = get_type_size_bits(tp);
279 bofs = ofs + get_entity_offset_bits(ent);
281 /* name:type, bit offset from the start of the struct', number of bits in the element. */
282 fprintf(h->f, "%s:%u,%d,%d;", get_entity_name(ent), type_num, bofs, size);
286 type_num = get_type_number(h, mtp);
287 size = get_type_size_bits(mtp);
289 /* name:type, bit offset from the start of the struct', number of bits in the element. */
290 fprintf(h->f, "%s:%u,%d,%d;", get_entity_name(ent), type_num, ofs, size);
293 fprintf(h->f, ";\",%d,0,0,0\n", N_LSYM);
294 } /* gen_struct_type */
297 * Generates an array type
299 * @param h the stabs handle
302 static void gen_array_type(stabs_handle *h, ir_type *tp) {
303 unsigned type_num = assign_type_number(h, tp);
304 int i, n = get_array_n_dimensions(tp);
308 NEW_ARR_A(int, perm, n);
309 for (i = 0; i < n; ++i) {
310 perm[i] = get_array_order(tp, i);
312 fprintf(h->f, "\t.stabs\t\"%s:t%u=a", get_type_name(tp), type_num);
314 for (i = 0; i < n; ++i) {
316 long min = get_array_lower_bound_int(tp, dim);
317 long max = get_array_upper_bound_int(tp, dim);
319 /* FIXME r1 must be integer type, but seems to work for now */
320 fprintf(h->f, "r1;%ld;%ld;", min, max-1);
323 etp = get_array_element_type(tp);
324 type_num = get_type_number(h, etp);
325 fprintf(h->f, "%d\",%d,0,0,0\n", type_num, N_LSYM);
326 } /* gen_array_type */
329 * Generates a method type
331 * @param h the stabs handle
334 static void gen_method_type(stabs_handle *h, ir_type *tp) {
335 unsigned type_num = assign_type_number(h, tp);
337 unsigned res_type_num;
338 int i, n = get_method_n_ress(tp);
341 rtp = get_method_res_type(tp, 0);
342 res_type_num = get_type_number(h, rtp);
344 fprintf(h->f, "\t.stabs\t\"%s:t%u=f%u", get_type_name(tp), type_num, res_type_num);
346 /* handle more than one return type */
347 for (i = 1; i < n; ++i) {
348 rtp = get_method_res_type(tp, i);
349 res_type_num = get_type_number(h, rtp);
350 fprintf(h->f, ",%u", res_type_num);
352 fprintf(h->f, "\",%d,0,0,0\n", N_LSYM);
353 } /* gen_method_type */
356 * type-walker: generate declaration for simple types,
357 * put all other types on a wait queue
359 static void walk_type(type_or_ent *tore, void *ctx)
364 if (get_kind(tore) == k_type) {
365 tp = (ir_type *)tore;
367 /* ignore the unknown type */
368 if (tp == firm_unknown_type)
374 switch (get_type_tpop_code(tp)) {
376 if (tp == get_glob_type()) {
383 SET_TYPE_NOT_READY(env->wq, tp);
386 case tpo_enumeration:
387 gen_enum_type(env->h, tp);
392 gen_primitive_type(env->h, tp);
398 SET_TYPE_NOT_READY(env->wq, tp);
402 /* must construct the pointer type */
403 SET_TYPE_NOT_READY(env->wq, tp);
407 /* the unknown type: ignore */
410 assert(! "Unknown tpop code");
415 * check, if a method type can be generated
417 static int is_method_type_ready(ir_type *tp)
422 for (i = get_method_n_ress(tp) - 1; i >= 0; --i) {
423 etp = SKIP_PTR(get_method_res_type(tp, i));
425 if (! IS_TYPE_READY(etp) && (! is_compound_type(etp) || is_Array_type(etp)))
429 for (i = get_method_n_params(tp) - 1; i >= 0; --i) {
430 etp = SKIP_PTR(get_method_param_type(tp, i));
432 if (! IS_TYPE_READY(etp) && (! is_compound_type(etp) || is_Array_type(etp)))
436 } /* is_method_type_ready */
439 * check, whether a compound type can be generated
441 static int is_compound_type_ready(ir_type *tp)
446 for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
447 etp = SKIP_PTR(get_entity_type(get_compound_member(tp, i)));
449 if (! IS_TYPE_READY(etp) && (! is_compound_type(etp) || is_Array_type(etp)))
453 } /* is_compound_type_ready */
456 * generate declaration for all types
458 static void finish_types(stabs_handle *h, waitq *wq)
462 while (! waitq_empty(wq)) {
465 switch (get_type_tpop_code(tp)) {
467 if (is_method_type_ready(tp)) {
468 gen_method_type(h, tp);
476 if (is_compound_type_ready(tp)) {
477 gen_struct_union_type(h, tp);
483 if (IS_TYPE_READY(get_array_element_type(tp))) {
484 gen_array_type(h, tp);
490 if (IS_TYPE_READY(get_pointer_points_to_type(tp))) {
491 gen_pointer_type(h, tp);
497 assert(! "Unknown tpop code");
500 /* still not ready, defer type output */
506 * generate all types.
508 static void gen_types(stabs_handle *h) {
512 env.wq = new_waitq();
513 type_walk(NULL, walk_type, &env);
514 finish_types(h, env.wq);
519 /* -------------------------- I/F ----------------------------- */
522 * start a new source object (compilation unit)
524 static void stabs_so(dbg_handle *handle, const char *filename) {
525 stabs_handle *h = (stabs_handle *)handle;
526 fprintf(h->f, "\t.stabs\t\"%s\",%d,0,0,.Ltext0\n", filename, N_SO);
532 static void stabs_main_program(dbg_handle *handle) {
533 stabs_handle *h = (stabs_handle *)handle;
534 ir_graph *irg = get_irp_main_irg();
536 fprintf(h->f, "\t.stabs\t\"%s\",%d,0,0,0\n", get_entity_name(get_irg_entity(irg)), N_MAIN);
538 } /* stabs_main_program */
541 * prints a line number
543 static void stabs_line(dbg_handle *handle, unsigned lineno, const char *address) {
544 stabs_handle *h = (stabs_handle *)handle;
545 fprintf(h->f, "\t.stabn\t%d, 0, %u, %s-%s\n", N_SLINE, lineno, address, get_entity_ld_name(h->cur_ent));
549 * dump the stabs for a method begin
551 static void stabs_method_begin(dbg_handle *handle, entity *ent, const be_stack_layout_t *layout) {
552 stabs_handle *h = (stabs_handle *)handle;
555 int i, n, between_size;
560 /* create the method entry */
561 mtp = get_entity_type(ent);
562 if (is_lowered_type(mtp))
563 mtp = get_associated_type(mtp);
564 if (get_method_n_ress(mtp) > 0)
565 rtp = get_method_res_type(mtp, 0);
568 type_num = get_type_number(h, rtp);
569 fprintf(h->f, "\t.stabs\t\"%s:%c%u\",%u,0,0,%s\n",
570 get_entity_name(ent),
571 get_entity_visibility(ent) == visibility_external_visible ? 'F' : 'f',
574 get_entity_ld_name(ent));
576 /* create parameter entries */
577 between_size = get_type_size_bytes(layout->between_type);
578 for (i = 0, n = get_method_n_params(mtp); i < n; ++i) {
579 ir_type *ptp = get_method_param_type(mtp, i);
580 const char *name = get_method_param_name(mtp, i);
581 unsigned type_num = get_type_number(h, ptp);
587 snprintf(buf, sizeof(buf), "arg%d", i);
590 /* check if this parameter has a stack entity. If it has, it
591 it transmitted on the stack, else in a register */
592 stack_ent = layout->param_map[i];
594 ofs = get_entity_offset_bytes(stack_ent) + between_size;
596 fprintf(h->f, "\t.stabs\t\"%s:p%u\",%d,0,0,%d\n", name, type_num, N_PSYM, ofs);
598 } /* stabs_method_begin */
601 * dump the stabs for a method end
603 static void stabs_method_end(dbg_handle *handle) {
604 stabs_handle *h = (stabs_handle *)handle;
605 entity *ent = h->cur_ent;
606 const be_stack_layout_t *layout = h->layout;
607 const char *ld_name = get_entity_ld_name(ent);
608 int i, n, frame_size;
609 static unsigned scope_nr = 0;
611 /* create entries for automatic variables on the stack */
612 frame_size = get_type_size_bytes(layout->frame_type);
613 for (i = 0, n = get_compound_n_members(layout->frame_type); i < n; ++i) {
614 entity *ent = get_compound_member(layout->frame_type, i);
619 /* ignore spill slots and other helper objects */
620 if (is_entity_compiler_generated(ent))
623 tp = get_entity_type(ent);
624 /* should not happen in backend but ... */
625 if (is_Method_type(tp))
627 type_num = get_type_number(h, tp);
628 ofs = -frame_size + get_entity_offset_bytes(ent);
630 fprintf(h->f, "\t.stabs\t\"%s:%u\",%d,0,0,%d\n",
631 get_entity_name(ent), type_num, N_LSYM, ofs);
633 /* we need a lexical block here */
634 fprintf(h->f, "\t.stabn\t%d,0,0,%s-%s\n", N_LBRAC, ld_name, ld_name);
635 fprintf(h->f, "\t.stabn\t%d,0,0,.Lscope%u-%s\n", N_RBRAC, scope_nr, ld_name);
636 fprintf(h->f, ".Lscope%u:\n", scope_nr);
641 } /* stabs_method_end */
646 static void stabs_types(dbg_handle *handle) {
647 stabs_handle *h = (stabs_handle *)handle;
649 /* allocate the zero for the void type */
656 * dump a variable in the global type
658 static void stabs_variable(dbg_handle *handle, struct obstack *obst, entity *ent) {
659 stabs_handle *h = (stabs_handle *)handle;
660 unsigned tp_num = get_type_number(h, get_entity_type(ent));
663 if (get_entity_visibility(ent) == visibility_external_visible) {
664 /* a global variable */
665 snprintf(buf, sizeof(buf), "\t.stabs\t\"%s:G%u\",%d,0,0,0\n",
666 get_entity_name(ent), tp_num, N_GSYM);
667 } else { /* some kind of local */
668 ir_variability variability = get_entity_variability(ent);
671 if (variability == variability_uninitialized)
673 else if (variability == variability_constant)
675 snprintf(buf, sizeof(buf), "\t.stabs\t\"%s:S%u\",%d,0,0,%s\n",
676 get_entity_name(ent), tp_num, kind, get_entity_ld_name(ent));
678 buf[sizeof(buf) - 1] = '\0';
681 obstack_printf(obst, "%s", buf);
683 fprintf(h->f, "%s", buf);
684 } /* stabs_variable */
687 * Close the stabs handler.
689 static void stabs_close(dbg_handle *handle) {
690 stabs_handle *h = (stabs_handle *)handle;
691 pmap_destroy(h->type_map);
695 /** The stabs operations. */
696 static const debug_ops stabs_ops = {
707 /* Opens the NULL handler */
708 dbg_handle *be_nulldbg_open(void) {
710 } /* be_nulldbg_open */
712 /* Opens a stabs handler */
713 dbg_handle *be_stabs_open(FILE *out) {
714 stabs_handle *h = xmalloc(sizeof(*h));
716 h->base.ops = &stabs_ops;
721 h->type_map = pmap_create_ex(64);
725 /** close a debug handler. */
726 void be_dbg_close(dbg_handle *h) {
727 if (h && h->ops->close)
732 * start a new source object (compilation unit)
734 void be_dbg_so(dbg_handle *h, const char *filename) {
736 h->ops->so(h, filename);
742 void be_dbg_main_program(dbg_handle *h) {
743 if (h && h->ops->main_program)
744 h->ops->main_program(h);
745 } /* be_dbg_main_program */
747 /** debug for a method begin */
748 void be_dbg_method_begin(dbg_handle *h, entity *ent, const be_stack_layout_t *layout) {
749 if (h && h->ops->method_begin)
750 h->ops->method_begin(h, ent, layout);
751 } /* be_dbg_method_begin */
753 /** debug for a method end */
754 void be_dbg_method_end(dbg_handle *h) {
755 if (h && h->ops->method_end)
756 h->ops->method_end(h);
757 } /* be_dbg_method_end */
759 /** debug for line number */
760 void be_dbg_line(dbg_handle *h, unsigned lineno, const char *address) {
761 if (h && h->ops->line)
762 h->ops->line(h, lineno, address);
766 void be_dbg_types(dbg_handle *h) {
767 if (h && h->ops->types)
772 void be_dbg_variable(dbg_handle *h, struct obstack *obst, entity *ent) {
773 if (h && h->ops->variable)
774 h->ops->variable(h, obst, ent);
775 } /* be_dbg_variable */