2 * Copyright (C) 1995-2008 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
44 #include "beemitter.h"
45 #include "be_dbgout.h"
47 /** by default, we generate assembler code for the Linux gas */
48 object_file_format_t be_gas_object_file_format = OBJECT_FILE_FORMAT_ELF;
49 bool be_gas_emit_types = true;
50 char be_gas_elf_type_char = '@';
52 static be_gas_section_t current_section = (be_gas_section_t) -1;
55 * An environment containing all needed dumper data.
56 * Currently we create the file completely in memory first, then
57 * write it to the disk. This is an artifact from the old C-generating backend
58 * and even there NOT needed. So we might change it in the future.
60 typedef struct _be_gas_decl_env {
61 be_gas_section_t section;
62 const be_main_env_t *main_env;
65 static void emit_section_macho(be_gas_section_t section)
67 be_gas_section_t base = section & GAS_SECTION_TYPE_MASK;
68 be_gas_section_t flags = section & ~GAS_SECTION_TYPE_MASK;
71 if (current_section == section)
73 current_section = section;
78 case GAS_SECTION_TEXT: name = "text"; break;
79 case GAS_SECTION_DATA: name = "data"; break;
80 case GAS_SECTION_RODATA: name = "const"; break;
81 case GAS_SECTION_BSS: name = "data"; break;
82 case GAS_SECTION_CONSTRUCTORS: name = "mod_init_func"; break;
83 case GAS_SECTION_DESTRUCTORS: name = "mod_term_func"; break;
84 case GAS_SECTION_PIC_TRAMPOLINES: name = "section\t__IMPORT,__jump_table,symbol_stubs,self_modifying_code+pure_instructions,5"; break;
85 case GAS_SECTION_PIC_SYMBOLS: name = "section\t__IMPORT,__pointers,non_lazy_symbol_pointers"; break;
86 case GAS_SECTION_CSTRING: name = "cstring"; break;
87 default: panic("unsupported scetion type 0x%X", section);
89 be_emit_irprintf("\t.%s\n", name);
91 } else if (flags & GAS_SECTION_FLAG_COMDAT) {
93 case GAS_SECTION_TEXT: name = "section __TEXT,__textcoal_nt,coalesced,pure_instructions"; break;
95 case GAS_SECTION_DATA: name = "section __DATA,__datacoal_nt,coalesced"; break;
96 case GAS_SECTION_RODATA: name = "section __TEXT,__const_coal,coalesced"; break;
97 case GAS_SECTION_CSTRING: name = "section __TEXT,__const_coal,coalesced"; break;
98 default: panic("unsupported scetion type 0x%X", section);
101 panic("unsupported section type 0x%X\n", section);
105 static void emit_section(be_gas_section_t section, const ir_entity *entity)
107 be_gas_section_t base = section & GAS_SECTION_TYPE_MASK;
108 be_gas_section_t flags = section & ~GAS_SECTION_TYPE_MASK;
109 static const char *const basename[] = {
110 "text", "data", "rodata", "bss", "ctors", "dtors"
112 static const char *const type[] = {
113 "progbits", "progbits", "progbits", "nobits", "init_array", "fini_array"
116 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
117 emit_section_macho(section);
121 if (current_section == section && !(section & GAS_SECTION_FLAG_COMDAT))
123 current_section = section;
128 case GAS_SECTION_TEXT:
129 be_emit_cstring("\t.text\n");
130 be_emit_write_line();
132 case GAS_SECTION_DATA:
133 be_emit_cstring("\t.data\n");
134 be_emit_write_line();
136 case GAS_SECTION_RODATA:
137 be_emit_cstring("\t.section\t.rodata\n");
138 be_emit_write_line();
140 case GAS_SECTION_BSS:
141 be_emit_cstring("\t.bss\n");
142 be_emit_write_line();
149 assert(base < sizeof(basename)/sizeof(basename[0]));
150 be_emit_cstring("\t.section\t.");
152 if (flags & GAS_SECTION_FLAG_TLS)
154 be_emit_string(basename[base]);
155 if (flags & GAS_SECTION_FLAG_COMDAT) {
157 be_gas_emit_entity(entity);
161 be_emit_cstring(",\"");
162 if (be_gas_object_file_format != OBJECT_FILE_FORMAT_COFF)
164 if (base != GAS_SECTION_RODATA)
166 if (flags & GAS_SECTION_FLAG_TLS)
168 if (flags & GAS_SECTION_FLAG_COMDAT)
170 be_emit_cstring("\",");
171 be_emit_char(be_gas_elf_type_char);
172 be_emit_string(type[base]);
174 if (flags & GAS_SECTION_FLAG_COMDAT) {
176 be_gas_emit_entity(entity);
177 be_emit_cstring(",comdat");
180 be_emit_write_line();
183 void be_gas_emit_switch_section(be_gas_section_t section)
185 /* you have to produce a switch_section call with entity manually
186 * for comdat sections */
187 assert( !(section & GAS_SECTION_FLAG_COMDAT));
189 emit_section(section, NULL);
192 static tarval *get_initializer_tarval(const ir_initializer_t *initializer)
194 if (initializer->kind == IR_INITIALIZER_TARVAL)
195 return initializer->tarval.value;
196 if (initializer->kind == IR_INITIALIZER_CONST) {
197 ir_node *node = initializer->consti.value;
198 if (is_Const(node)) {
199 return get_Const_tarval(node);
202 return get_tarval_undefined();
205 static int initializer_is_string_const(const ir_initializer_t *initializer)
208 int found_printable = 0;
210 if (initializer->kind != IR_INITIALIZER_COMPOUND)
213 len = initializer->compound.n_initializers;
216 for (i = 0; i < len; ++i) {
220 ir_initializer_t *sub_initializer
221 = initializer->compound.initializers[i];
223 tv = get_initializer_tarval(sub_initializer);
224 if (!tarval_is_constant(tv))
227 mode = get_tarval_mode(tv);
228 if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
231 c = get_tarval_long(tv);
232 if (isgraph(c) || isspace(c))
237 if (i == len - 1 && c != '\0')
241 return found_printable;
244 static bool initializer_is_null(const ir_initializer_t *initializer)
246 switch (initializer->kind) {
247 case IR_INITIALIZER_NULL:
249 case IR_INITIALIZER_TARVAL: {
250 tarval *tv = initializer->tarval.value;
251 return tarval_is_null(tv);
253 case IR_INITIALIZER_CONST: {
254 ir_node *value = initializer->consti.value;
255 if (!is_Const(value))
257 return is_Const_null(value);
259 case IR_INITIALIZER_COMPOUND: {
261 for (i = 0; i < initializer->compound.n_initializers; ++i) {
262 ir_initializer_t *subinitializer
263 = initializer->compound.initializers[i];
264 if (!initializer_is_null(subinitializer))
270 panic("invalid initializer in initializer_is_null");
274 * Determine if an entity is a string constant
275 * @param ent The entity
276 * @return 1 if it is a string constant, 0 otherwise
278 static int entity_is_string_const(const ir_entity *ent)
280 ir_type *type, *element_type;
284 type = get_entity_type(ent);
286 /* if it's an array */
287 if (!is_Array_type(type))
290 element_type = get_array_element_type(type);
292 /* and the array's element type is primitive */
293 if (!is_Primitive_type(element_type))
296 /* and the mode of the element type is an int of
297 * the same size as the byte mode */
298 mode = get_type_mode(element_type);
299 if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
302 if (ent->initializer != NULL) {
303 return initializer_is_string_const(ent->initializer);
304 } else if (entity_has_compound_ent_values(ent)) {
305 int found_printable = 0;
306 /* if it contains only printable chars and a 0 at the end */
307 n = get_compound_ent_n_values(ent);
308 for (i = 0; i < n; ++i) {
309 ir_node *irn = get_compound_ent_value(ent, i);
313 c = (int) get_tarval_long(get_Const_tarval(irn));
315 if (isgraph(c) || isspace(c))
320 if (i == n - 1 && c != '\0')
323 return found_printable;
329 static bool entity_is_null(const ir_entity *entity)
331 if (entity->initializer != NULL) {
332 return initializer_is_null(entity->initializer);
333 } else if (entity_has_compound_ent_values(entity)) {
334 /* I'm too lazy to implement this case as compound graph paths will be
335 * remove anyway in the future */
337 /* uninitialized, NULL is fine */
341 static bool is_comdat(const ir_entity *entity)
343 ir_linkage linkage = get_entity_linkage(entity);
344 return (linkage & IR_LINKAGE_MERGE)
345 && (linkage & IR_LINKAGE_GARBAGE_COLLECT);
348 static be_gas_section_t determine_basic_section(const ir_entity *entity)
352 if (is_method_entity(entity))
353 return GAS_SECTION_TEXT;
355 linkage = get_entity_linkage(entity);
356 if (linkage & IR_LINKAGE_CONSTANT) {
357 /* mach-o is the only one with a cstring section */
358 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O
359 && entity_is_string_const(entity))
360 return GAS_SECTION_CSTRING;
362 return GAS_SECTION_RODATA;
364 if (entity_is_null(entity))
365 return GAS_SECTION_BSS;
367 return GAS_SECTION_DATA;
370 static be_gas_section_t determine_section(be_gas_decl_env_t *env,
371 const ir_entity *entity)
373 ir_type *owner = get_entity_owner(entity);
375 if (owner == get_segment_type(IR_SEGMENT_GLOBAL)) {
376 be_gas_section_t section = determine_basic_section(entity);
377 if (is_comdat(entity))
378 section |= GAS_SECTION_FLAG_COMDAT;
380 } else if (env != NULL && owner == env->main_env->pic_symbols_type) {
381 return GAS_SECTION_PIC_SYMBOLS;
382 } else if (env != NULL && owner == env->main_env->pic_trampolines_type) {
383 return GAS_SECTION_PIC_TRAMPOLINES;
384 } else if (owner == get_segment_type(IR_SEGMENT_CONSTRUCTORS)) {
385 return GAS_SECTION_CONSTRUCTORS;
386 } else if (owner == get_segment_type(IR_SEGMENT_DESTRUCTORS)) {
387 return GAS_SECTION_DESTRUCTORS;
388 } else if (owner == get_segment_type(IR_SEGMENT_THREAD_LOCAL)) {
389 be_gas_section_t section = determine_basic_section(entity);
390 if (is_comdat(entity))
391 section |= GAS_SECTION_FLAG_COMDAT;
393 return section | GAS_SECTION_FLAG_TLS;
396 panic("Couldn't determine section for %+F?!?", entity);
399 static void emit_weak(const ir_entity *entity)
401 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
402 be_emit_cstring("\t.weak_reference ");
404 be_emit_cstring("\t.weak ");
406 be_gas_emit_entity(entity);
408 be_emit_write_line();
411 static void emit_visibility(const ir_entity *entity)
413 ir_linkage linkage = get_entity_linkage(entity);
415 if (get_entity_linkage(entity) & IR_LINKAGE_WEAK) {
417 /* Note: .weak seems to imply .globl so no need to output .globl */
418 } else if (get_entity_visibility(entity) == ir_visibility_default) {
419 be_emit_cstring(".globl ");
420 be_gas_emit_entity(entity);
422 be_emit_write_line();
425 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O
426 && (linkage & IR_LINKAGE_HIDDEN_USER)) {
427 be_emit_cstring("\t.no_dead_strip ");
428 be_gas_emit_entity(entity);
430 be_emit_write_line();
434 void be_gas_emit_function_prolog(const ir_entity *entity, unsigned po2alignment)
436 be_gas_section_t section = determine_section(NULL, entity);
437 emit_section(section, entity);
439 /* write the begin line (makes the life easier for scripts parsing the
441 be_emit_write_line();
442 be_emit_cstring("# -- Begin ");
443 be_gas_emit_entity(entity);
445 be_emit_write_line();
447 if (po2alignment > 0) {
448 const char *fill_byte = "";
449 unsigned maximum_skip = (1 << po2alignment) - 1;
450 /* gcc fills space between function with 0x90... */
451 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
454 be_emit_cstring("\t.p2align ");
455 be_emit_irprintf("%u,%s,%u\n", po2alignment, fill_byte, maximum_skip);
456 be_emit_write_line();
458 emit_visibility(entity);
460 switch (be_gas_object_file_format) {
461 case OBJECT_FILE_FORMAT_ELF:
462 be_emit_cstring("\t.type\t");
463 be_gas_emit_entity(entity);
464 be_emit_cstring(", ");
465 be_emit_char(be_gas_elf_type_char);
466 be_emit_cstring("function\n");
467 be_emit_write_line();
469 case OBJECT_FILE_FORMAT_COFF:
470 be_emit_cstring("\t.def\t");
471 be_gas_emit_entity(entity);
472 be_emit_cstring(";");
473 if (get_entity_visibility(entity) == ir_visibility_local) {
474 be_emit_cstring("\t.scl\t3;");
476 be_emit_cstring("\t.scl\t2;");
478 be_emit_cstring("\t.type\t32;\t.endef\n");
479 be_emit_write_line();
481 case OBJECT_FILE_FORMAT_MACH_O:
484 be_gas_emit_entity(entity);
485 be_emit_cstring(":\n");
486 be_emit_write_line();
489 void be_gas_emit_function_epilog(const ir_entity *entity)
491 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_ELF) {
492 be_emit_cstring("\t.size\t");
493 be_gas_emit_entity(entity);
494 be_emit_cstring(", .-");
495 be_gas_emit_entity(entity);
497 be_emit_write_line();
500 be_emit_cstring("# -- End ");
501 be_gas_emit_entity(entity);
503 be_emit_write_line();
506 /************************************************************************/
511 * @param tv the tarval
512 * @param bytes the width of the tarvals value in bytes
514 static void emit_arith_tarval(tarval *tv, int bytes)
518 be_emit_irprintf("0x%02x", get_tarval_sub_bits(tv, 0));
522 be_emit_irprintf("0x%02x%02x", get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
526 be_emit_irprintf("0x%02x%02x%02x%02x",
527 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
531 be_emit_irprintf("0x%02x%02x%02x%02x%02x%02x%02x%02x",
532 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6), get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
533 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
537 /* Beware: Mixed endian output! One little endian number emitted as
538 * three longs. Each long initializer is written in big endian. */
540 "\t.long\t0x%02x%02x%02x%02x\n"
541 "\t.long\t0x%02x%02x%02x%02x\n"
542 "\t.long\t0x%02x%02x%02x%02x",
543 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2),
544 get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0),
545 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6),
546 get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
547 get_tarval_sub_bits(tv, 11), get_tarval_sub_bits(tv, 10),
548 get_tarval_sub_bits(tv, 9), get_tarval_sub_bits(tv, 8)
553 /* Beware: Mixed endian output! One little endian number emitted as
554 * three longs. Each long initializer is written in big endian. */
556 "\t.long\t0x%02x%02x%02x%02x\n"
557 "\t.long\t0x%02x%02x%02x%02x\n"
558 "\t.long\t0x%02x%02x%02x%02x\n"
559 "\t.long\t0x%02x%02x%02x%02x",
560 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2),
561 get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0),
562 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6),
563 get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
564 get_tarval_sub_bits(tv, 11), get_tarval_sub_bits(tv, 10),
565 get_tarval_sub_bits(tv, 9), get_tarval_sub_bits(tv, 8),
566 get_tarval_sub_bits(tv, 15), get_tarval_sub_bits(tv, 14),
567 get_tarval_sub_bits(tv, 13), get_tarval_sub_bits(tv, 12)
572 panic("Can't dump a tarval with %d bytes", bytes);
576 * Return the label prefix for labeled instructions.
578 const char *be_gas_insn_label_prefix(void)
584 * Return the tarval of an atomic initializer.
586 * @param init a node representing the initializer (on the const code irg)
590 static tarval *get_atomic_init_tv(ir_node *init)
593 ir_mode *mode = get_irn_mode(init);
595 switch (get_irn_opcode(init)) {
598 init = get_Cast_op(init);
602 init = get_Conv_op(init);
606 return get_Const_tarval(init);
609 switch (get_SymConst_kind(init)) {
610 case symconst_type_size:
611 return new_tarval_from_long(get_type_size_bytes(get_SymConst_type(init)), mode);
613 case symconst_type_align:
614 return new_tarval_from_long(get_type_alignment_bytes(get_SymConst_type(init)), mode);
616 case symconst_ofs_ent:
617 return new_tarval_from_long(get_entity_offset(get_SymConst_entity(init)), mode);
619 case symconst_enum_const:
620 return get_enumeration_value(get_SymConst_enum(init));
633 * Dump an atomic value.
635 * @param env the gas output environment
636 * @param init a node representing the atomic value (on the const code irg)
638 static void do_emit_atomic_init(be_gas_decl_env_t *env, ir_node *init)
640 ir_mode *mode = get_irn_mode(init);
641 int bytes = get_mode_size_bytes(mode);
645 init = skip_Id(init);
647 switch (get_irn_opcode(init)) {
649 do_emit_atomic_init(env, get_Cast_op(init));
653 do_emit_atomic_init(env, get_Conv_op(init));
657 tv = get_Const_tarval(init);
659 /* it's a arithmetic value */
660 emit_arith_tarval(tv, bytes);
664 switch (get_SymConst_kind(init)) {
665 case symconst_addr_name:
666 be_emit_ident(get_SymConst_name(init));
669 case symconst_addr_ent:
670 ent = get_SymConst_entity(init);
671 be_gas_emit_entity(ent);
674 case symconst_ofs_ent:
675 ent = get_SymConst_entity(init);
676 be_emit_irprintf("%d", get_entity_offset(ent));
679 case symconst_type_size:
680 be_emit_irprintf("%u", get_type_size_bytes(get_SymConst_type(init)));
683 case symconst_type_align:
684 be_emit_irprintf("%u", get_type_alignment_bytes(get_SymConst_type(init)));
687 case symconst_enum_const:
688 tv = get_enumeration_value(get_SymConst_enum(init));
689 emit_arith_tarval(tv, bytes);
693 assert(!"emit_atomic_init(): don't know how to init from this SymConst");
698 if (!mode_is_int(mode) && !mode_is_reference(mode)) {
699 panic("Constant must be int or pointer for '+' to work");
701 do_emit_atomic_init(env, get_Add_left(init));
702 be_emit_cstring(" + ");
703 do_emit_atomic_init(env, get_Add_right(init));
707 if (!mode_is_int(mode) && !mode_is_reference(mode)) {
708 panic("Constant must be int or pointer for '-' to work");
710 do_emit_atomic_init(env, get_Sub_left(init));
711 be_emit_cstring(" - ");
712 do_emit_atomic_init(env, get_Sub_right(init));
716 if (!mode_is_int(mode) && !mode_is_reference(mode)) {
717 panic("Constant must be int or pointer for '*' to work");
719 do_emit_atomic_init(env, get_Mul_left(init));
720 be_emit_cstring(" * ");
721 do_emit_atomic_init(env, get_Mul_right(init));
725 be_emit_cstring("0");
729 panic("emit_atomic_init(): unsupported IR-node %+F", init);
734 * Dumps the type for given size (.byte, .long, ...)
736 * @param size the size in bytes
738 static void emit_size_type(size_t size)
742 be_emit_cstring("\t.byte\t");
746 be_emit_cstring("\t.short\t");
750 be_emit_cstring("\t.long\t");
754 be_emit_cstring("\t.quad\t");
759 case 16: /* Note: .octa does not work on mac */
760 /* handled in arith */
764 panic("Try to dump a type with %u bytes", (unsigned)size);
769 * Emit an atomic value.
771 * @param env the gas output environment
772 * @param init a node representing the atomic value (on the const code irg)
774 static void emit_atomic_init(be_gas_decl_env_t *env, ir_node *init)
776 ir_mode *mode = get_irn_mode(init);
777 int bytes = get_mode_size_bytes(mode);
779 emit_size_type(bytes);
780 do_emit_atomic_init(env, init);
782 be_emit_write_line();
785 /************************************************************************/
786 /* Routines to dump global variables */
787 /************************************************************************/
790 * Dump a string constant.
791 * No checks are made!!
793 * @param ent The entity to dump.
795 static void emit_string_cst(const ir_entity *ent)
803 len = get_compound_ent_n_values(ent);
805 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
806 be_emit_cstring("\t.ascii \"");
808 be_emit_cstring("\t.string \"");
812 for (i = 0; i < output_len; ++i) {
816 irn = get_compound_ent_value(ent, i);
817 c = (int) get_tarval_long(get_Const_tarval(irn));
820 case '"' : be_emit_cstring("\\\""); break;
821 case '\n': be_emit_cstring("\\n"); break;
822 case '\r': be_emit_cstring("\\r"); break;
823 case '\t': be_emit_cstring("\\t"); break;
824 case '\\': be_emit_cstring("\\\\"); break;
829 be_emit_irprintf("\\%o", c);
833 be_emit_cstring("\"\n");
834 be_emit_write_line();
836 type = get_entity_type(ent);
837 type_size = get_type_size_bytes(type);
838 remaining_space = type_size - len;
839 assert(remaining_space >= 0);
840 if (remaining_space > 0) {
841 be_emit_irprintf("\t.space\t%d\n", remaining_space);
845 static void emit_string_initializer(const ir_initializer_t *initializer)
849 len = initializer->compound.n_initializers;
850 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
851 be_emit_cstring("\t.ascii \"");
853 be_emit_cstring("\t.string \"");
857 for (i = 0; i < len; ++i) {
858 const ir_initializer_t *sub_initializer
859 = get_initializer_compound_value(initializer, i);
861 tarval *tv = get_initializer_tarval(sub_initializer);
862 int c = get_tarval_long(tv);
865 case '"' : be_emit_cstring("\\\""); break;
866 case '\n': be_emit_cstring("\\n"); break;
867 case '\r': be_emit_cstring("\\r"); break;
868 case '\t': be_emit_cstring("\\t"); break;
869 case '\\': be_emit_cstring("\\\\"); break;
874 be_emit_irprintf("\\%o", c);
878 be_emit_cstring("\"\n");
879 be_emit_write_line();
882 enum normal_or_bitfield_kind {
889 enum normal_or_bitfield_kind kind;
893 unsigned char bf_val;
895 } normal_or_bitfield;
897 static int is_type_variable_size(ir_type *type)
904 static size_t get_initializer_size(const ir_initializer_t *initializer,
907 switch (get_initializer_kind(initializer)) {
908 case IR_INITIALIZER_TARVAL:
909 assert(get_tarval_mode(get_initializer_tarval_value(initializer)) == get_type_mode(type));
910 return get_type_size_bytes(type);
911 case IR_INITIALIZER_CONST:
912 case IR_INITIALIZER_NULL:
913 return get_type_size_bytes(type);
914 case IR_INITIALIZER_COMPOUND:
915 if (!is_type_variable_size(type)) {
916 return get_type_size_bytes(type);
919 = get_initializer_compound_n_entries(initializer);
921 unsigned initializer_size = get_type_size_bytes(type);
922 for (i = 0; i < n_entries; ++i) {
923 ir_entity *entity = get_compound_member(type, i);
924 ir_type *type = get_entity_type(entity);
926 const ir_initializer_t *sub_initializer
927 = get_initializer_compound_value(initializer, i);
929 unsigned offset = get_entity_offset(entity);
930 unsigned size = get_initializer_size(sub_initializer, type);
932 if (offset + size > initializer_size) {
933 initializer_size = offset + size;
936 return initializer_size;
940 panic("found invalid initializer");
944 static normal_or_bitfield *glob_vals;
945 static size_t max_vals;
948 static void emit_bitfield(normal_or_bitfield *vals, size_t offset_bits,
949 const ir_initializer_t *initializer, ir_type *type)
951 unsigned char last_bits = 0;
952 ir_mode *mode = get_type_mode(type);
954 unsigned char curr_bits;
958 switch (get_initializer_kind(initializer)) {
959 case IR_INITIALIZER_NULL:
961 case IR_INITIALIZER_TARVAL:
962 tv = get_initializer_tarval_value(initializer);
964 case IR_INITIALIZER_CONST: {
965 ir_node *node = get_initializer_const_value(initializer);
966 if (!is_Const(node)) {
967 panic("bitfield initializer not a Const node");
969 tv = get_Const_tarval(node);
972 case IR_INITIALIZER_COMPOUND:
973 panic("bitfield initializer is compound");
976 panic("Couldn't get numeric value for bitfield initializer");
978 tv = tarval_convert_to(tv, get_type_mode(type));
980 /* normalize offset */
981 vals += offset_bits >> 3;
983 value_len = get_mode_size_bits(mode);
985 /* combine bits with existing bits */
986 for (j = 0; value_len + (int) offset_bits > 0; ++j) {
987 assert((size_t) (vals - glob_vals) + j < max_vals);
988 assert(vals[j].kind == BITFIELD ||
989 (vals[j].kind == NORMAL && vals[j].v.value == NULL));
990 vals[j].kind = BITFIELD;
991 curr_bits = get_tarval_sub_bits(tv, j);
993 |= (last_bits >> (8 - offset_bits)) | (curr_bits << offset_bits);
995 last_bits = curr_bits;
999 static void emit_ir_initializer(normal_or_bitfield *vals,
1000 const ir_initializer_t *initializer,
1003 assert((size_t) (vals - glob_vals) < max_vals);
1005 switch (get_initializer_kind(initializer)) {
1006 case IR_INITIALIZER_NULL:
1008 case IR_INITIALIZER_TARVAL: {
1011 assert(vals->kind != BITFIELD);
1012 vals->kind = TARVAL;
1013 vals->v.tarval = get_initializer_tarval_value(initializer);
1014 assert(get_type_mode(type) == get_tarval_mode(vals->v.tarval));
1015 for (i = 1; i < get_type_size_bytes(type); ++i) {
1016 vals[i].kind = NORMAL;
1017 vals[i].v.value = NULL;
1021 case IR_INITIALIZER_CONST: {
1024 assert(vals->kind != BITFIELD);
1025 vals->kind = NORMAL;
1026 vals->v.value = get_initializer_const_value(initializer);
1027 for (i = 1; i < get_type_size_bytes(type); ++i) {
1028 vals[i].kind = NORMAL;
1029 vals[i].v.value = NULL;
1033 case IR_INITIALIZER_COMPOUND: {
1035 size_t n = get_initializer_compound_n_entries(initializer);
1037 if (is_Array_type(type)) {
1038 ir_type *element_type = get_array_element_type(type);
1039 size_t skip = get_type_size_bytes(element_type);
1040 size_t alignment = get_type_alignment_bytes(element_type);
1041 size_t misalign = skip % alignment;
1042 if (misalign != 0) {
1043 skip += alignment - misalign;
1046 for (i = 0; i < n; ++i) {
1047 ir_initializer_t *sub_initializer
1048 = get_initializer_compound_value(initializer, i);
1050 emit_ir_initializer(vals, sub_initializer, element_type);
1055 size_t n_members, i;
1056 assert(is_compound_type(type));
1057 n_members = get_compound_n_members(type);
1058 for (i = 0; i < n_members; ++i) {
1059 ir_entity *member = get_compound_member(type, i);
1060 size_t offset = get_entity_offset(member);
1061 ir_type *subtype = get_entity_type(member);
1062 ir_mode *mode = get_type_mode(subtype);
1063 ir_initializer_t *sub_initializer;
1065 assert(i < get_initializer_compound_n_entries(initializer));
1067 = get_initializer_compound_value(initializer, i);
1071 = get_entity_offset_bits_remainder(member);
1072 size_t value_len = get_mode_size_bits(mode);
1074 if (offset_bits != 0 ||
1075 (value_len != 8 && value_len != 16 && value_len != 32
1076 && value_len != 64)) {
1077 emit_bitfield(&vals[offset], offset_bits,
1078 sub_initializer, subtype);
1083 emit_ir_initializer(&vals[offset], sub_initializer, subtype);
1090 panic("invalid ir_initializer kind found");
1093 static void emit_initializer(be_gas_decl_env_t *env, const ir_entity *entity)
1095 const ir_initializer_t *initializer = entity->initializer;
1097 normal_or_bitfield *vals;
1101 if (initializer_is_string_const(initializer)) {
1102 emit_string_initializer(initializer);
1106 type = get_entity_type(entity);
1107 size = get_initializer_size(initializer, type);
1113 * In the worst case, every initializer allocates one byte.
1114 * Moreover, initializer might be big, do not allocate on stack.
1116 vals = XMALLOCNZ(normal_or_bitfield, size);
1123 emit_ir_initializer(vals, initializer, type);
1125 /* now write values sorted */
1126 for (k = 0; k < size; ) {
1129 if (vals[k].kind == NORMAL) {
1130 if (vals[k].v.value != NULL) {
1131 emit_atomic_init(env, vals[k].v.value);
1132 elem_size = get_mode_size_bytes(get_irn_mode(vals[k].v.value));
1136 } else if (vals[k].kind == TARVAL) {
1137 tarval *tv = vals[k].v.tarval;
1138 size_t size = get_mode_size_bytes(get_tarval_mode(tv));
1143 emit_size_type(size);
1144 emit_arith_tarval(tv, size);
1146 be_emit_write_line();
1148 assert(vals[k].kind == BITFIELD);
1149 be_emit_irprintf("\t.byte\t%d\n", vals[k].v.bf_val);
1150 be_emit_write_line();
1154 while (k < size && vals[k].kind == NORMAL && vals[k].v.value == NULL) {
1161 be_emit_irprintf("\t.space\t%d\n", space);
1162 be_emit_write_line();
1168 static void emit_compound_graph_init(be_gas_decl_env_t *env,
1169 const ir_entity *ent)
1171 normal_or_bitfield *vals;
1173 unsigned k, last_ofs;
1175 if (entity_is_string_const(ent)) {
1176 emit_string_cst(ent);
1180 n = get_compound_ent_n_values(ent);
1182 /* Find the initializer size. Sorrily gcc support a nasty feature:
1183 The last field of a compound may be a flexible array. This allows
1184 initializers bigger than the type size. */
1185 last_ofs = get_type_size_bytes(get_entity_type(ent));
1186 for (i = 0; i < n; ++i) {
1187 unsigned offset = get_compound_ent_value_offset_bytes(ent, i);
1188 unsigned bits_remainder = get_compound_ent_value_offset_bit_remainder(ent, i);
1189 ir_node *value = get_compound_ent_value(ent, i);
1190 unsigned value_len = get_mode_size_bits(get_irn_mode(value));
1192 offset += (value_len + bits_remainder + 7) >> 3;
1194 if (offset > last_ofs) {
1200 * In the worst case, every initializer allocates one byte.
1201 * Moreover, initializer might be big, do not allocate on stack.
1203 vals = XMALLOCNZ(normal_or_bitfield, last_ofs);
1205 /* collect the values and store them at the offsets */
1206 for (i = 0; i < n; ++i) {
1207 unsigned offset = get_compound_ent_value_offset_bytes(ent, i);
1208 int offset_bits = get_compound_ent_value_offset_bit_remainder(ent, i);
1209 ir_node *value = get_compound_ent_value(ent, i);
1210 int value_len = get_mode_size_bits(get_irn_mode(value));
1212 assert(offset_bits >= 0);
1214 if (offset_bits != 0 ||
1215 (value_len != 8 && value_len != 16 && value_len != 32 && value_len != 64)) {
1216 tarval *tv = get_atomic_init_tv(value);
1217 unsigned char curr_bits, last_bits = 0;
1219 panic("Couldn't get numeric value for bitfield initializer '%s'",
1220 get_entity_ld_name(ent));
1222 /* normalize offset */
1223 offset += offset_bits >> 3;
1226 for (j = 0; value_len + offset_bits > 0; ++j) {
1227 assert(offset + j < last_ofs);
1228 assert(vals[offset + j].kind == BITFIELD || vals[offset + j].v.value == NULL);
1229 vals[offset + j].kind = BITFIELD;
1230 curr_bits = get_tarval_sub_bits(tv, j);
1231 vals[offset + j].v.bf_val |= (last_bits >> (8 - offset_bits)) | (curr_bits << offset_bits);
1233 last_bits = curr_bits;
1238 assert(offset < last_ofs);
1239 assert(vals[offset].kind == NORMAL);
1240 for (i = 1; i < value_len / 8; ++i) {
1241 assert(vals[offset + i].v.value == NULL);
1243 vals[offset].v.value = value;
1247 /* now write them sorted */
1248 for (k = 0; k < last_ofs; ) {
1249 int space = 0, skip = 0;
1250 if (vals[k].kind == NORMAL) {
1251 if (vals[k].v.value != NULL) {
1252 emit_atomic_init(env, vals[k].v.value);
1253 skip = get_mode_size_bytes(get_irn_mode(vals[k].v.value)) - 1;
1258 assert(vals[k].kind == BITFIELD);
1259 be_emit_irprintf("\t.byte\t%d\n", vals[k].v.bf_val);
1263 while (k < last_ofs && vals[k].kind == NORMAL && vals[k].v.value == NULL) {
1272 be_emit_irprintf("\t.space\t%d\n", space);
1273 be_emit_write_line();
1279 static void emit_align(unsigned p2alignment)
1281 be_emit_irprintf("\t.p2align\t%u\n", log2_floor(p2alignment));
1282 be_emit_write_line();
1285 static unsigned get_effective_entity_alignment(const ir_entity *entity)
1287 unsigned alignment = get_entity_alignment(entity);
1288 if (alignment == 0) {
1289 ir_type *type = get_entity_type(entity);
1290 alignment = get_type_alignment_bytes(type);
1295 static void emit_common(const ir_entity *entity)
1297 unsigned size = get_type_size_bytes(get_entity_type(entity));
1298 unsigned alignment = get_effective_entity_alignment(entity);
1300 if (get_entity_linkage(entity) & IR_LINKAGE_WEAK) {
1304 switch (be_gas_object_file_format) {
1305 case OBJECT_FILE_FORMAT_MACH_O:
1306 be_emit_cstring("\t.comm ");
1307 be_gas_emit_entity(entity);
1308 be_emit_irprintf(",%u,%u\n", size, log2_floor(alignment));
1309 be_emit_write_line();
1311 case OBJECT_FILE_FORMAT_ELF:
1312 be_emit_cstring("\t.comm ");
1313 be_gas_emit_entity(entity);
1314 be_emit_irprintf(",%u,%u\n", size, alignment);
1315 be_emit_write_line();
1317 case OBJECT_FILE_FORMAT_COFF:
1318 be_emit_cstring("\t.comm ");
1319 be_gas_emit_entity(entity);
1320 be_emit_irprintf(",%u # %u\n", size, alignment);
1321 be_emit_write_line();
1324 panic("invalid object file format");
1327 static void emit_local_common(const ir_entity *entity)
1329 unsigned size = get_type_size_bytes(get_entity_type(entity));
1330 unsigned alignment = get_effective_entity_alignment(entity);
1332 if (get_entity_linkage(entity) & IR_LINKAGE_WEAK) {
1336 switch (be_gas_object_file_format) {
1337 case OBJECT_FILE_FORMAT_MACH_O:
1338 be_emit_cstring("\t.lcomm ");
1339 be_gas_emit_entity(entity);
1340 be_emit_irprintf(",%u,%u\n", size, log2_floor(alignment));
1341 be_emit_write_line();
1343 case OBJECT_FILE_FORMAT_ELF:
1344 be_emit_cstring("\t.local ");
1345 be_gas_emit_entity(entity);
1346 be_emit_cstring("\n");
1347 be_emit_write_line();
1348 be_emit_cstring("\t.comm ");
1349 be_gas_emit_entity(entity);
1350 be_emit_irprintf(",%u,%u\n", size, alignment);
1351 be_emit_write_line();
1353 case OBJECT_FILE_FORMAT_COFF:
1354 be_emit_cstring("\t.lcomm ");
1355 be_gas_emit_entity(entity);
1356 be_emit_irprintf(",%u # %u\n", size, alignment);
1357 be_emit_write_line();
1360 panic("invalid object file format");
1363 static void emit_indirect_symbol(const ir_entity *entity, be_gas_section_t section)
1365 /* we can only do PIC code on macho so far */
1366 assert(be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O);
1368 be_gas_emit_entity(entity);
1369 be_emit_cstring(":\n");
1370 be_emit_write_line();
1371 be_emit_cstring("\t.indirect_symbol ");
1372 be_emit_ident(get_entity_ident(entity));
1374 be_emit_write_line();
1375 if (section == GAS_SECTION_PIC_TRAMPOLINES) {
1376 be_emit_cstring("\thlt ; hlt ; hlt ; hlt ; hlt\n");
1377 be_emit_write_line();
1379 assert(section == GAS_SECTION_PIC_SYMBOLS);
1380 be_emit_cstring("\t.long 0\n");
1381 be_emit_write_line();
1385 char const *be_gas_get_private_prefix(void)
1388 be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O ? "L" :
1392 void be_gas_emit_entity(const ir_entity *entity)
1394 if (entity->type == firm_code_type) {
1395 ir_label_t label = get_entity_label(entity);
1396 be_emit_irprintf("%s_%lu", be_gas_get_private_prefix(), label);
1400 if (get_entity_visibility(entity) == ir_visibility_private) {
1401 be_emit_string(be_gas_get_private_prefix());
1403 be_emit_ident(get_entity_ld_ident(entity));
1406 void be_gas_emit_block_name(const ir_node *block)
1408 if (has_Block_entity(block)) {
1409 ir_entity *entity = get_Block_entity(block);
1410 be_gas_emit_entity(entity);
1412 be_emit_irprintf("%s%ld", be_gas_get_private_prefix(), get_irn_node_nr(block));
1417 * Dump a global entity.
1419 * @param env the gas output environment
1420 * @param ent the entity to be dumped
1422 static void emit_global(be_gas_decl_env_t *env, const ir_entity *entity)
1424 ir_type *type = get_entity_type(entity);
1425 ident *ld_ident = get_entity_ld_ident(entity);
1426 unsigned alignment = get_effective_entity_alignment(entity);
1427 be_gas_section_t section = determine_section(env, entity);
1428 ir_visibility visibility = get_entity_visibility(entity);
1429 ir_linkage linkage = get_entity_linkage(entity);
1431 /* block labels are already emittet in the code */
1432 if (type == firm_code_type)
1435 /* we already emitted all methods. Except for the trampolines which
1436 * the assembler/linker generates */
1437 if (is_Method_type(type) && section != GAS_SECTION_PIC_TRAMPOLINES) {
1438 /* functions with graph are already emitted with
1439 * be_gas_emit_function_prolog */
1440 if (get_entity_irg(entity) == NULL) {
1441 emit_visibility(entity);
1446 be_dbg_variable(entity);
1448 if (section == GAS_SECTION_BSS) {
1449 ir_visibility visibility = get_entity_visibility(entity);
1451 switch (visibility) {
1452 case ir_visibility_local:
1453 case ir_visibility_private:
1454 emit_local_common(entity);
1456 case ir_visibility_default:
1457 if (linkage & IR_LINKAGE_MERGE) {
1458 emit_common(entity);
1462 case ir_visibility_external:
1463 if (linkage & IR_LINKAGE_MERGE)
1464 panic("merge link semantic not supported for extern entities");
1469 emit_visibility(entity);
1470 if (visibility == ir_visibility_external) {
1471 /* nothing to do for externally defined values */
1475 if (!is_po2(alignment))
1476 panic("alignment not a power of 2");
1478 emit_section(section, entity);
1480 if (section == GAS_SECTION_PIC_TRAMPOLINES
1481 || section == GAS_SECTION_PIC_SYMBOLS) {
1482 emit_indirect_symbol(entity, section);
1487 if (alignment > 1) {
1488 emit_align(alignment);
1490 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_ELF
1491 && be_gas_emit_types) {
1492 be_emit_cstring("\t.type\t");
1493 be_gas_emit_entity(entity);
1494 be_emit_cstring(", ");
1495 be_emit_char(be_gas_elf_type_char);
1496 be_emit_cstring("object\n\t.size\t");\
1497 be_gas_emit_entity(entity);
1498 be_emit_irprintf(", %u\n", get_type_size_bytes(type));
1501 if (get_id_str(ld_ident)[0] != '\0') {
1502 be_gas_emit_entity(entity);
1503 be_emit_cstring(":\n");
1504 be_emit_write_line();
1507 if (entity_is_null(entity)) {
1508 be_emit_irprintf("\t.space %u\n", get_type_size_bytes(type));
1509 be_emit_write_line();
1510 } else if (entity_has_compound_ent_values(entity)) {
1511 emit_compound_graph_init(env, entity);
1513 assert(entity->initializer != NULL);
1514 emit_initializer(env, entity);
1519 * Dumps declarations of global variables and the initialization code.
1521 * @param gt a global like type, either the global or the TLS one
1522 * @param env an environment
1524 static void be_gas_emit_globals(ir_type *gt, be_gas_decl_env_t *env)
1526 int i, n = get_compound_n_members(gt);
1528 for (i = 0; i < n; i++) {
1529 ir_entity *ent = get_compound_member(gt, i);
1530 emit_global(env, ent);
1534 /************************************************************************/
1536 /* Generate all entities. */
1537 void be_gas_emit_decls(const be_main_env_t *main_env)
1539 be_gas_decl_env_t env;
1540 memset(&env, 0, sizeof(env));
1542 /* dump global type */
1543 env.main_env = main_env;
1544 env.section = (be_gas_section_t) -1;
1546 be_gas_emit_globals(get_glob_type(), &env);
1547 be_gas_emit_globals(get_tls_type(), &env);
1548 be_gas_emit_globals(get_segment_type(IR_SEGMENT_CONSTRUCTORS), &env);
1549 be_gas_emit_globals(get_segment_type(IR_SEGMENT_DESTRUCTORS), &env);
1550 be_gas_emit_globals(main_env->pic_symbols_type, &env);
1551 be_gas_emit_globals(main_env->pic_trampolines_type, &env);
1554 * ".subsections_via_symbols marks object files which are OK to divide
1555 * their section contents into individual blocks".
1556 * From my understanding this means no label points in the middle of an
1557 * object which we want to address as a whole. Firm code should be fine
1560 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
1561 be_emit_cstring("\t.subsections_via_symbols\n");
1562 be_emit_write_line();