2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Dumps global variables and constants as gas assembler.
23 * @author Christian Wuerdig, Matthias Braun
46 #include "beemitter.h"
47 #include "be_dbgout.h"
49 typedef struct obstack obstack_t;
51 /** by default, we generate assembler code for the Linux gas */
52 be_gas_flavour_t be_gas_flavour = GAS_FLAVOUR_NORMAL;
55 * Return the pseudo-instruction to be issued for a section switch
56 * depending on the current flavour.
58 * @param section the section to switch to
60 * @return the pseudo-instruction
62 static const char *get_section_name(be_gas_section_t section) {
63 static const char *text[GAS_FLAVOUR_MAX][GAS_SECTION_MAX] = {
69 ".section\t.tbss,\"awT\",@nobits",
70 ".section\t.ctors,\"aw\",@progbits"
75 ".section .rdata,\"dr\"",
77 ".section\t.tbss,\"awT\",@nobits",
78 ".section\t.ctors,\"aw\",@progbits"
82 assert(be_gas_flavour >= 0 && be_gas_flavour < GAS_FLAVOUR_MAX);
83 assert(section >= 0 && section < GAS_SECTION_MAX);
84 return text[be_gas_flavour][section];
88 * Emit necessary code to switch to a section.
90 * @param env the emitter environment
91 * @param section the section to switch to
93 void be_gas_emit_switch_section(be_emit_env_t *env, be_gas_section_t section) {
94 be_emit_char(env, '\t');
95 be_emit_string(env, get_section_name(section));
96 be_emit_char(env, '\n');
97 be_emit_write_line(env);
101 * An environment containing all needed dumper data.
102 * Currently we create the file completely in memory first, then
103 * write it to the disk. This is an artifact from the old C-generating backend
104 * and even there NOT needed. So we might change it in the future.
106 typedef struct _be_gas_decl_env {
107 obstack_t *rodata_obst; /**< An obstack that will be filled with all rodata entities. */
108 obstack_t *data_obst; /**< An obstack that will be filled with the initialized entities. */
109 obstack_t *bss_obst; /**< An obstack that will be filled with the uninitialized entities. */
110 obstack_t *ctor_obst; /**< An obstack that will be filled with the constructor entities. */
111 const be_main_env_t *main_env; /**< The main backend environment, used for it's debug handle. */
112 waitq *worklist; /**< A worklist we use to place not yet handled entities on. */
115 /************************************************************************/
120 * @param obst the obstack where the data is written too
121 * @param tv the tarval
122 * @param bytes the width of the tarvals value in bytes
124 static void dump_arith_tarval(obstack_t *obst, tarval *tv, int bytes)
129 obstack_printf(obst, "0x%02x", get_tarval_sub_bits(tv, 0));
133 obstack_printf(obst, "0x%02x%02x", get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
137 obstack_printf(obst, "0x%02x%02x%02x%02x",
138 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
142 obstack_printf(obst, "0x%02x%02x%02x%02x%02x%02x%02x%02x",
143 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6), get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
144 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
152 obstack_printf(obst, "0x%02x%02x%02x%02x%02x%02x%02x%02x"
153 "%02x%02x%02x%02x%02x%02x%02x%02x",
154 get_tarval_sub_bits(tv, 15), get_tarval_sub_bits(tv, 16),
155 get_tarval_sub_bits(tv, 13), get_tarval_sub_bits(tv, 12),
156 get_tarval_sub_bits(tv, 11), get_tarval_sub_bits(tv, 10),
157 get_tarval_sub_bits(tv, 9), get_tarval_sub_bits(tv, 8),
158 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6),
159 get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
160 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2),
161 get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
166 fprintf(stderr, "Try to dump an tarval with %d bytes\n", bytes);
172 * Return the tarval of an atomic initializer.
174 * @param init a node representing the initializer (on teh const code irg)
178 static tarval *get_atomic_init_tv(ir_node *init)
181 ir_mode *mode = get_irn_mode(init);
183 switch (get_irn_opcode(init)) {
186 init = get_Cast_op(init);
190 init = get_Conv_op(init);
194 return get_Const_tarval(init);
197 switch (get_SymConst_kind(init)) {
198 case symconst_type_size:
199 return new_tarval_from_long(get_type_size_bytes(get_SymConst_type(init)), mode);
201 case symconst_type_align:
202 return new_tarval_from_long(get_type_alignment_bytes(get_SymConst_type(init)), mode);
204 case symconst_ofs_ent:
205 return new_tarval_from_long(get_entity_offset(get_SymConst_entity(init)), mode);
207 case symconst_enum_const:
208 return get_enumeration_value(get_SymConst_enum(init));
221 * Dump an atomic value.
223 * @param env the gas output environment
224 * @param obst an obstack the output is written to
225 * @param init a node representing the atomic value (on the const code irg)
227 static void do_dump_atomic_init(be_gas_decl_env_t *env, obstack_t *obst,
230 ir_mode *mode = get_irn_mode(init);
231 int bytes = get_mode_size_bytes(mode);
235 switch (get_irn_opcode(init)) {
238 do_dump_atomic_init(env, obst, get_Cast_op(init));
242 do_dump_atomic_init(env, obst, get_Conv_op(init));
246 tv = get_Const_tarval(init);
248 /* it's a arithmetic value */
249 dump_arith_tarval(obst, tv, bytes);
253 switch (get_SymConst_kind(init)) {
254 case symconst_addr_name:
255 obstack_printf(obst, "%s", get_id_str(get_SymConst_name(init)));
258 case symconst_addr_ent:
259 ent = get_SymConst_entity(init);
260 if(!entity_visited(ent)) {
261 waitq_put(env->worklist, ent);
262 mark_entity_visited(ent);
264 obstack_printf(obst, "%s", get_entity_ld_name(ent));
267 case symconst_ofs_ent:
268 ent = get_SymConst_entity(init);
269 #if 0 /* not needed, is it? */
270 if(!entity_visited(ent)) {
271 waitq_put(env->worklist, ent);
272 mark_entity_visited(ent);
275 obstack_printf(obst, "%d", get_entity_offset(ent));
278 case symconst_type_size:
279 obstack_printf(obst, "%d", get_type_size_bytes(get_SymConst_type(init)));
282 case symconst_type_align:
283 obstack_printf(obst, "%d", get_type_alignment_bytes(get_SymConst_type(init)));
286 case symconst_enum_const:
287 tv = get_enumeration_value(get_SymConst_enum(init));
288 dump_arith_tarval(obst, tv, bytes);
292 assert(!"dump_atomic_init(): don't know how to init from this SymConst");
297 do_dump_atomic_init(env, obst, get_Add_left(init));
298 obstack_printf(obst, " + ");
299 do_dump_atomic_init(env, obst, get_Add_right(init));
303 do_dump_atomic_init(env, obst, get_Sub_left(init));
304 obstack_printf(obst, " - ");
305 do_dump_atomic_init(env, obst, get_Sub_right(init));
309 do_dump_atomic_init(env, obst, get_Mul_left(init));
310 obstack_printf(obst, " * ");
311 do_dump_atomic_init(env, obst, get_Mul_right(init));
315 assert(0 && "dump_atomic_init(): unknown IR-node");
320 * Dumps the type for given size (.byte, .long, ...)
322 * @param obst an obstack the output is written to
323 * @param size the size in bytes
325 static void dump_size_type(obstack_t *obst, int size) {
329 obstack_printf(obst, "\t.byte\t");
333 obstack_printf(obst, "\t.value\t");
337 obstack_printf(obst, "\t.long\t");
341 obstack_printf(obst, "\t.quad\t");
346 /* handled in arith */
350 obstack_printf(obst, "\t.octa\t");
354 fprintf(stderr, "Try to dump a type with %d bytes\n", size);
360 * Dump an atomic value to an obstack.
362 * @param env the gas output environment
363 * @param obst an obstack the output is written to
364 * @param init a node representing the atomic value (on the const code irg)
366 static void dump_atomic_init(be_gas_decl_env_t *env, obstack_t *obst,
369 ir_mode *mode = get_irn_mode(init);
370 int bytes = get_mode_size_bytes(mode);
372 dump_size_type(obst, bytes);
373 do_dump_atomic_init(env, obst, init);
374 obstack_printf(obst, "\n");
377 /************************************************************************/
378 /* Routines to dump global variables */
379 /************************************************************************/
382 * Determine if an entity is a string constant
383 * @param ent The entity
384 * @return 1 if it is a string constant, 0 otherwise
386 static int ent_is_string_const(ir_entity *ent)
388 ir_type *type, *element_type;
392 type = get_entity_type(ent);
394 /* if it's an array */
395 if (!is_Array_type(type))
398 element_type = get_array_element_type(type);
400 /* and the array's element type is primitive */
401 if (!is_Primitive_type(element_type))
404 /* and the mode of the element type is an int of
405 * the same size as the byte mode */
406 mode = get_type_mode(element_type);
407 if (!mode_is_int(mode)
408 || get_mode_size_bits(mode) != get_mode_size_bits(mode_Bs))
411 /* if it contains only printable chars and a 0 at the end */
412 n = get_compound_ent_n_values(ent);
413 for (i = 0; i < n; ++i) {
414 ir_node *irn = get_compound_ent_value(ent, i);
415 if(get_irn_opcode(irn) != iro_Const)
418 c = (int) get_tarval_long(get_Const_tarval(irn));
420 if((i < n - 1 && !(isgraph(c) || isspace(c)))
421 || (i == n - 1 && c != '\0'))
425 /* then we can emit it as a string constant */
430 * Dump a string constant.
431 * No checks are made!!
433 * @param obst The obst to dump on.
434 * @param ent The entity to dump.
436 static void dump_string_cst(obstack_t *obst, ir_entity *ent)
443 obstack_printf(obst, "\t.string \"");
444 n = get_compound_ent_n_values(ent);
446 for (i = 0; i < n-1; ++i) {
450 irn = get_compound_ent_value(ent, i);
451 c = (int) get_tarval_long(get_Const_tarval(irn));
454 case '"' : obstack_printf(obst, "\\\""); break;
455 case '\n': obstack_printf(obst, "\\n"); break;
456 case '\r': obstack_printf(obst, "\\r"); break;
457 case '\t': obstack_printf(obst, "\\t"); break;
458 case '\\': obstack_printf(obst, "\\\\"); break;
461 obstack_printf(obst, "%c", c);
463 obstack_printf(obst, "\\%o", c);
467 obstack_printf(obst, "\"\n");
469 type = get_entity_type(ent);
470 type_size = get_type_size_bytes(type);
471 remaining_space = type_size - n;
472 assert(remaining_space >= 0);
473 if(remaining_space > 0) {
474 obstack_printf(obst, "\t.skip\t%d\n", remaining_space);
478 static void dump_array_init(be_gas_decl_env_t *env, obstack_t *obst,
481 const ir_type *ty = get_entity_type(ent);
486 /* potential spare values should be already included! */
487 for (i = 0; i < get_compound_ent_n_values(ent); ++i) {
488 ir_entity *step = get_compound_ent_value_member(ent, i);
489 ir_type *stype = get_entity_type(step);
491 if (get_type_mode(stype)) {
492 int align = (get_type_alignment_bits(stype) + 7) >> 3;
493 int n = size % align;
496 obstack_printf(obst, "\t.zero\t%d\n", align - n);
500 dump_atomic_init(env, obst, get_compound_ent_value(ent, i));
501 size += get_type_size_bytes(stype);
503 filler = get_type_size_bytes(ty) - size;
506 obstack_printf(obst, "\t.skip\t%d\n", filler);
509 enum normal_or_bitfield_kind {
515 enum normal_or_bitfield_kind kind;
518 unsigned char bf_val;
520 } normal_or_bitfield;
523 * Dump an initializer for a compound entity.
525 static void dump_compound_init(be_gas_decl_env_t *env, obstack_t *obst,
528 normal_or_bitfield *vals;
529 int i, j, n = get_compound_ent_n_values(ent);
532 /* Find the initializer size. Sorrily gcc support a nasty feature:
533 The last field of a compound may be a flexible array. This allows
534 initializers bigger than the type size. */
535 last_ofs = get_type_size_bytes(get_entity_type(ent));
536 for (i = 0; i < n; ++i) {
537 int offset = get_compound_ent_value_offset_bytes(ent, i);
538 int bits_remainder = get_compound_ent_value_offset_bit_remainder(ent, i);
539 const compound_graph_path *path = get_compound_ent_value_path(ent, i);
540 int path_len = get_compound_graph_path_length(path);
541 ir_entity *last_ent = get_compound_graph_path_node(path, path_len - 1);
542 int value_len = get_type_size_bits(get_entity_type(last_ent));
544 offset += (value_len + bits_remainder + 7) >> 3;
546 if (offset > last_ofs) {
552 * In the worst case, every initializer allocates one byte.
553 * Moreover, initializer might be big, do not allocate on stack.
555 vals = xcalloc(last_ofs, sizeof(vals[0]));
557 /* collect the values and store them at the offsets */
558 for (i = 0; i < n; ++i) {
559 const compound_graph_path *path = get_compound_ent_value_path(ent, i);
560 int path_len = get_compound_graph_path_length(path);
561 int offset = get_compound_ent_value_offset_bytes(ent, i);
562 int offset_bits = get_compound_ent_value_offset_bit_remainder(ent, i);
563 ir_node *value = get_compound_ent_value(ent, i);
564 ir_entity *last_ent = get_compound_graph_path_node(path, path_len - 1);
565 int value_len = get_type_size_bits(get_entity_type(last_ent));
567 assert(offset_bits >= 0);
569 if (offset_bits != 0 ||
570 (value_len != 8 && value_len != 16 && value_len != 32 && value_len != 64)) {
571 tarval *shift, *shifted;
572 tarval *tv = get_atomic_init_tv(value);
574 panic("Couldn't get numeric value for bitfield initializer '%s'\n",
575 get_entity_ld_name(ent));
577 tv = tarval_convert_to(tv, mode_Lu);
578 shift = new_tarval_from_long(offset_bits, mode_Is);
579 shifted = tarval_shl(tv, shift);
580 if (shifted == tarval_bad || shifted == tarval_undefined) {
581 panic("Couldn't shift numeric value for bitfield initializer '%s'\n",
582 get_entity_ld_name(ent));
585 for (j = 0; value_len > 0; ++j) {
586 assert(offset + j < last_ofs);
587 assert(vals[offset + j].kind == BITFIELD || vals[offset + j].v.value == NULL);
588 vals[offset + j].kind = BITFIELD;
589 vals[offset + j].v.bf_val |= get_tarval_sub_bits(shifted, j);
590 value_len -= 8 - offset_bits;
594 assert(offset < last_ofs);
595 assert(vals[offset].kind == NORMAL);
596 assert(vals[offset].v.value == NULL);
597 vals[offset].v.value = value;
601 /* now write them sorted */
602 for (i = 0; i < last_ofs; ) {
603 int space = 0, skip = 0;
604 if (vals[i].kind == NORMAL) {
605 if(vals[i].v.value != NULL) {
606 dump_atomic_init(env, obst, vals[i].v.value);
607 skip = get_mode_size_bytes(get_irn_mode(vals[i].v.value)) - 1;
612 assert(vals[i].kind == BITFIELD);
613 obstack_printf(obst, "\t.byte\t%d\n", vals[i].v.bf_val);
618 while (i < last_ofs && vals[i].kind == NORMAL && vals[i].v.value == NULL) {
627 obstack_printf(obst, "\t.skip\t%d\n", space);
633 * Dump a global entity.
635 * @param env the gas output environment
636 * @param ent the entity to be dumped
637 * @param emit_commons if non-zero, emit commons (non-local uninitialized entities)
639 static void dump_global(be_gas_decl_env_t *env, ir_entity *ent, int emit_commons)
642 ir_type *type = get_entity_type(ent);
643 const char *ld_name = get_entity_ld_name(ent);
644 ir_variability variability = get_entity_variability(ent);
645 ir_visibility visibility = get_entity_visibility(ent);
646 int align = get_type_alignment_bytes(type);
647 int emit_as_common = 0;
649 obst = env->data_obst;
650 if (is_Method_type(type)) {
651 if (get_method_img_section(ent) == section_constructors) {
652 obst = env->ctor_obst;
653 obstack_printf(obst, ".balign\t%d\n", align);
654 dump_size_type(obst, align);
655 obstack_printf(obst, "%s\n", ld_name);
658 } else if (variability == variability_constant) {
659 /* a constant entity, put it on the rdata */
660 obst = env->rodata_obst;
661 } else if (variability == variability_uninitialized) {
662 /* uninitialized entity put it in bss segment */
663 obst = env->bss_obst;
664 if(emit_commons && visibility != visibility_local)
668 be_dbg_variable(env->main_env->db_handle, obst, ent);
670 /* global or not global */
671 if (visibility == visibility_external_visible && !emit_as_common) {
672 obstack_printf(obst, ".global\t%s\n", ld_name);
673 } else if(visibility == visibility_external_allocated) {
674 obstack_printf(obst, ".global\t%s\n", ld_name);
675 /* we can return now... */
679 if (align > 1 && !emit_as_common) {
680 obstack_printf(obst, ".balign\t%d\n", align);
683 if (!emit_as_common) {
684 obstack_printf(obst, "%s:\n", ld_name);
687 if (variability == variability_uninitialized) {
689 if (be_gas_flavour == GAS_FLAVOUR_NORMAL)
690 obstack_printf(obst, "\t.comm %s,%d,%d\n",
691 ld_name, get_type_size_bytes(type), align);
693 obstack_printf(obst, "\t.comm %s,%d # %d\n",
694 ld_name, get_type_size_bytes(type), align);
696 obstack_printf(obst, "\t.zero %d\n", get_type_size_bytes(type));
698 } else if (is_atomic_type(type)) {
699 dump_atomic_init(env, obst, get_atomic_ent_value(ent));
700 } else if (ent_is_string_const(ent)) {
701 dump_string_cst(obst, ent);
702 } else if (is_Array_type(type)) {
703 dump_array_init(env, obst, ent);
704 } else if (is_compound_type(type)) {
705 dump_compound_init(env, obst, ent);
707 assert(0 && "unsupported type");
712 * Dumps declarations of global variables and the initialization code.
714 * @param gt a global like type, either the global or the TLS one
715 * @param env an environment
716 * @param emit_commons if non-zero, emit commons (non-local uninitialized entities)
717 * @param only_emit_marked if non-zero, external allocated entities that do not have
718 * its visited flag set are ignored
720 static void be_gas_dump_globals(ir_type *gt, be_gas_decl_env_t *env,
721 int emit_commons, int only_emit_marked)
723 int i, n = get_compound_n_members(gt);
724 waitq *worklist = new_waitq();
726 if(only_emit_marked) {
727 for (i = 0; i < n; i++) {
728 ir_entity *ent = get_compound_member(gt, i);
729 if(entity_visited(ent) ||
730 get_entity_visibility(ent) != visibility_external_allocated) {
731 waitq_put(worklist, ent);
732 mark_entity_visited(ent);
736 inc_master_type_visited();
737 for (i = 0; i < n; i++) {
738 ir_entity *ent = get_compound_member(gt, i);
739 mark_entity_visited(ent);
740 waitq_put(worklist, ent);
744 env->worklist = worklist;
746 while(!waitq_empty(worklist)) {
747 ir_entity *ent = waitq_get(worklist);
749 dump_global(env, ent, emit_commons);
753 env->worklist = NULL;
756 /************************************************************************/
758 /* Generate all entities. */
759 void be_gas_emit_decls(be_emit_env_t *emit, const be_main_env_t *main_env,
760 int only_emit_marked_entities)
762 be_gas_decl_env_t env;
763 obstack_t rodata, data, bss, ctor;
767 /* dump the global type */
768 obstack_init(&rodata);
773 env.rodata_obst = &rodata;
774 env.data_obst = &data;
776 env.ctor_obst = &ctor;
777 env.main_env = main_env;
779 be_gas_dump_globals(get_glob_type(), &env, 1, only_emit_marked_entities);
781 size = obstack_object_size(&data);
782 cp = obstack_finish(&data);
784 be_gas_emit_switch_section(emit, GAS_SECTION_DATA);
785 be_emit_string_len(emit, cp, size);
786 be_emit_write_line(emit);
789 size = obstack_object_size(&rodata);
790 cp = obstack_finish(&rodata);
792 be_gas_emit_switch_section(emit, GAS_SECTION_RODATA);
793 be_emit_string_len(emit, cp, size);
794 be_emit_write_line(emit);
797 size = obstack_object_size(&bss);
798 cp = obstack_finish(&bss);
800 be_gas_emit_switch_section(emit, GAS_SECTION_COMMON);
801 be_emit_string_len(emit, cp, size);
802 be_emit_write_line(emit);
805 size = obstack_object_size(&ctor);
806 cp = obstack_finish(&ctor);
808 be_gas_emit_switch_section(emit, GAS_SECTION_CTOR);
809 be_emit_string_len(emit, cp, size);
810 be_emit_write_line(emit);
813 obstack_free(&rodata, NULL);
814 obstack_free(&data, NULL);
815 obstack_free(&bss, NULL);
816 obstack_free(&ctor, NULL);
818 /* dump the Thread Local Storage */
821 env.rodata_obst = &data;
822 env.data_obst = &data;
823 env.bss_obst = &data;
824 env.ctor_obst = NULL;
826 be_gas_dump_globals(get_tls_type(), &env, 0, only_emit_marked_entities);
828 size = obstack_object_size(&data);
829 cp = obstack_finish(&data);
831 be_gas_emit_switch_section(emit, GAS_SECTION_TLS);
832 be_emit_cstring(emit, ".balign\t32\n");
833 be_emit_write_line(emit);
834 be_emit_string_len(emit, cp, size);
835 be_emit_write_line(emit);
838 obstack_free(&data, NULL);