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
45 #include "beemitter.h"
46 #include "be_dbgout.h"
48 /** by default, we generate assembler code for the Linux gas */
49 object_file_format_t be_gas_object_file_format = OBJECT_FILE_FORMAT_ELF;
50 bool be_gas_emit_types = true;
51 char be_gas_elf_type_char = '@';
53 static be_gas_section_t current_section = (be_gas_section_t) -1;
56 * An environment containing all needed dumper data.
57 * Currently we create the file completely in memory first, then
58 * write it to the disk. This is an artifact from the old C-generating backend
59 * and even there NOT needed. So we might change it in the future.
61 typedef struct be_gas_decl_env {
62 be_gas_section_t section;
63 const be_main_env_t *main_env;
66 static void emit_section_macho(be_gas_section_t section)
68 be_gas_section_t base = section & GAS_SECTION_TYPE_MASK;
69 be_gas_section_t flags = section & ~GAS_SECTION_TYPE_MASK;
72 if (current_section == section)
74 current_section = section;
79 case GAS_SECTION_TEXT: name = "text"; break;
80 case GAS_SECTION_DATA: name = "data"; break;
81 case GAS_SECTION_RODATA: name = "const"; break;
82 case GAS_SECTION_BSS: name = "data"; break;
83 case GAS_SECTION_CONSTRUCTORS: name = "mod_init_func"; break;
84 case GAS_SECTION_DESTRUCTORS: name = "mod_term_func"; break;
85 case GAS_SECTION_PIC_TRAMPOLINES: name = "section\t__IMPORT,__jump_table,symbol_stubs,self_modifying_code+pure_instructions,5"; break;
86 case GAS_SECTION_PIC_SYMBOLS: name = "section\t__IMPORT,__pointers,non_lazy_symbol_pointers"; break;
87 case GAS_SECTION_CSTRING: name = "cstring"; break;
88 default: panic("unsupported scetion type 0x%X", section);
90 be_emit_irprintf("\t.%s\n", name);
92 } else if (flags & GAS_SECTION_FLAG_COMDAT) {
94 case GAS_SECTION_TEXT: name = "section __TEXT,__textcoal_nt,coalesced,pure_instructions"; break;
96 case GAS_SECTION_DATA: name = "section __DATA,__datacoal_nt,coalesced"; break;
97 case GAS_SECTION_RODATA: name = "section __TEXT,__const_coal,coalesced"; break;
98 case GAS_SECTION_CSTRING: name = "section __TEXT,__const_coal,coalesced"; break;
99 default: panic("unsupported scetion type 0x%X", section);
102 panic("unsupported section type 0x%X\n", section);
106 static void emit_section_sparc(be_gas_section_t section, const ir_entity *entity)
108 be_gas_section_t base = section & GAS_SECTION_TYPE_MASK;
109 be_gas_section_t flags = section & ~GAS_SECTION_TYPE_MASK;
110 static const char *const basename[] = {
111 "text", "data", "rodata", "bss", "ctors", "dtors"
114 if (current_section == section && !(section & GAS_SECTION_FLAG_COMDAT))
116 current_section = section;
118 be_emit_cstring("\t.section\t\".");
120 /* Part1: section-name */
121 if (flags & GAS_SECTION_FLAG_TLS)
123 assert(base < (be_gas_section_t)ARRAY_SIZE(basename));
124 be_emit_string(basename[base]);
126 if (flags & GAS_SECTION_FLAG_COMDAT) {
128 be_gas_emit_entity(entity);
132 /* for the simple sections we're done here */
136 be_emit_cstring(",#alloc");
139 case GAS_SECTION_TEXT: be_emit_cstring(",#execinstr"); break;
140 case GAS_SECTION_DATA:
141 case GAS_SECTION_BSS: be_emit_cstring(",#write"); break;
146 if (flags & GAS_SECTION_FLAG_TLS) {
147 be_emit_cstring(",#tls");
152 be_emit_write_line();
155 static void emit_section(be_gas_section_t section, const ir_entity *entity)
157 be_gas_section_t base = section & GAS_SECTION_TYPE_MASK;
158 be_gas_section_t flags = section & ~GAS_SECTION_TYPE_MASK;
159 static const char *const basename[] = {
160 "text", "data", "rodata", "bss", "ctors", "dtors"
162 static const char *const type[] = {
163 "progbits", "progbits", "progbits", "nobits", "init_array", "fini_array"
166 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
167 emit_section_macho(section);
169 } else if(be_gas_object_file_format == OBJECT_FILE_FORMAT_ELF_SPARC) {
170 emit_section_sparc(section, entity);
174 if (current_section == section && !(section & GAS_SECTION_FLAG_COMDAT))
176 current_section = section;
181 case GAS_SECTION_TEXT:
182 be_emit_cstring("\t.text\n");
183 be_emit_write_line();
185 case GAS_SECTION_DATA:
186 be_emit_cstring("\t.data\n");
187 be_emit_write_line();
189 case GAS_SECTION_RODATA:
190 be_emit_cstring("\t.section\t.rodata\n");
191 be_emit_write_line();
193 case GAS_SECTION_BSS:
194 be_emit_cstring("\t.bss\n");
195 be_emit_write_line();
202 assert(base < (be_gas_section_t) ARRAY_SIZE(basename));
203 be_emit_cstring("\t.section\t.");
205 if (flags & GAS_SECTION_FLAG_TLS)
207 be_emit_string(basename[base]);
208 if (flags & GAS_SECTION_FLAG_COMDAT) {
210 be_gas_emit_entity(entity);
214 be_emit_cstring(",\"");
215 if (be_gas_object_file_format != OBJECT_FILE_FORMAT_COFF)
217 if (base == GAS_SECTION_TEXT)
219 if (base != GAS_SECTION_RODATA && base != GAS_SECTION_TEXT)
221 if (flags & GAS_SECTION_FLAG_TLS)
223 if (flags & GAS_SECTION_FLAG_COMDAT)
226 if (be_gas_object_file_format != OBJECT_FILE_FORMAT_COFF) {
227 be_emit_cstring("\",");
228 be_emit_char(be_gas_elf_type_char);
229 be_emit_string(type[base]);
232 if (flags & GAS_SECTION_FLAG_COMDAT) {
234 be_gas_emit_entity(entity);
235 be_emit_cstring(",comdat");
238 be_emit_write_line();
243 void be_gas_emit_switch_section(be_gas_section_t section)
245 /* you have to produce a switch_section call with entity manually
246 * for comdat sections */
247 assert( !(section & GAS_SECTION_FLAG_COMDAT));
249 emit_section(section, NULL);
252 static ir_tarval *get_initializer_tarval(const ir_initializer_t *initializer)
254 if (initializer->kind == IR_INITIALIZER_TARVAL)
255 return initializer->tarval.value;
256 if (initializer->kind == IR_INITIALIZER_CONST) {
257 ir_node *node = initializer->consti.value;
258 if (is_Const(node)) {
259 return get_Const_tarval(node);
262 return get_tarval_undefined();
265 static bool initializer_is_string_const(const ir_initializer_t *initializer)
268 bool found_printable = false;
270 if (initializer->kind != IR_INITIALIZER_COMPOUND)
273 len = initializer->compound.n_initializers;
276 for (i = 0; i < len; ++i) {
280 ir_initializer_t *sub_initializer
281 = initializer->compound.initializers[i];
283 tv = get_initializer_tarval(sub_initializer);
284 if (!tarval_is_constant(tv))
287 mode = get_tarval_mode(tv);
288 if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
291 c = get_tarval_long(tv);
292 if (isgraph(c) || isspace(c))
293 found_printable = true;
297 if (i == len - 1 && c != '\0')
301 return found_printable;
304 static bool initializer_is_null(const ir_initializer_t *initializer)
306 switch (initializer->kind) {
307 case IR_INITIALIZER_NULL:
309 case IR_INITIALIZER_TARVAL: {
310 ir_tarval *tv = initializer->tarval.value;
311 return tarval_is_null(tv);
313 case IR_INITIALIZER_CONST: {
314 ir_node *value = initializer->consti.value;
315 if (!is_Const(value))
317 return is_Const_null(value);
319 case IR_INITIALIZER_COMPOUND: {
321 for (i = 0; i < initializer->compound.n_initializers; ++i) {
322 ir_initializer_t *subinitializer
323 = initializer->compound.initializers[i];
324 if (!initializer_is_null(subinitializer))
330 panic("invalid initializer in initializer_is_null");
334 * Determine if an entity is a string constant
335 * @param ent The entity
336 * @return 1 if it is a string constant, 0 otherwise
338 static int entity_is_string_const(const ir_entity *ent)
340 ir_type *type, *element_type;
344 type = get_entity_type(ent);
346 /* if it's an array */
347 if (!is_Array_type(type))
350 element_type = get_array_element_type(type);
352 /* and the array's element type is primitive */
353 if (!is_Primitive_type(element_type))
356 /* and the mode of the element type is an int of
357 * the same size as the byte mode */
358 mode = get_type_mode(element_type);
359 if (!mode_is_int(mode) || get_mode_size_bits(mode) != 8)
362 if (ent->initializer != NULL) {
363 return initializer_is_string_const(ent->initializer);
364 } else if (entity_has_compound_ent_values(ent)) {
365 int found_printable = 0;
366 /* if it contains only printable chars and a 0 at the end */
367 n = get_compound_ent_n_values(ent);
368 for (i = 0; i < n; ++i) {
369 ir_node *irn = get_compound_ent_value(ent, i);
373 c = (int) get_tarval_long(get_Const_tarval(irn));
375 if (isgraph(c) || isspace(c))
380 if (i == n - 1 && c != '\0')
383 return found_printable;
389 static bool entity_is_null(const ir_entity *entity)
391 if (entity->initializer != NULL) {
392 return initializer_is_null(entity->initializer);
393 } else if (entity_has_compound_ent_values(entity)) {
394 /* I'm too lazy to implement this case as compound graph paths will be
395 * remove anyway in the future */
398 /* uninitialized, NULL is fine */
402 static bool is_comdat(const ir_entity *entity)
404 ir_linkage linkage = get_entity_linkage(entity);
405 return (linkage & IR_LINKAGE_MERGE)
406 && (linkage & IR_LINKAGE_GARBAGE_COLLECT);
409 static be_gas_section_t determine_basic_section(const ir_entity *entity)
413 if (is_method_entity(entity))
414 return GAS_SECTION_TEXT;
416 linkage = get_entity_linkage(entity);
417 if (linkage & IR_LINKAGE_CONSTANT) {
418 /* mach-o is the only one with a cstring section */
419 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O
420 && entity_is_string_const(entity))
421 return GAS_SECTION_CSTRING;
423 return GAS_SECTION_RODATA;
425 if (entity_is_null(entity))
426 return GAS_SECTION_BSS;
428 return GAS_SECTION_DATA;
431 static be_gas_section_t determine_section(be_gas_decl_env_t *env,
432 const ir_entity *entity)
434 ir_type *owner = get_entity_owner(entity);
436 if (owner == get_segment_type(IR_SEGMENT_GLOBAL)) {
437 be_gas_section_t section = determine_basic_section(entity);
438 if (is_comdat(entity))
439 section |= GAS_SECTION_FLAG_COMDAT;
441 } else if (env != NULL && owner == env->main_env->pic_symbols_type) {
442 return GAS_SECTION_PIC_SYMBOLS;
443 } else if (env != NULL && owner == env->main_env->pic_trampolines_type) {
444 return GAS_SECTION_PIC_TRAMPOLINES;
445 } else if (owner == get_segment_type(IR_SEGMENT_CONSTRUCTORS)) {
446 return GAS_SECTION_CONSTRUCTORS;
447 } else if (owner == get_segment_type(IR_SEGMENT_DESTRUCTORS)) {
448 return GAS_SECTION_DESTRUCTORS;
449 } else if (owner == get_segment_type(IR_SEGMENT_THREAD_LOCAL)) {
450 be_gas_section_t section = determine_basic_section(entity);
451 if (is_comdat(entity))
452 section |= GAS_SECTION_FLAG_COMDAT;
454 return section | GAS_SECTION_FLAG_TLS;
457 /* the java frontend keeps some functions inside classes */
458 if (is_Class_type(owner)) {
459 return determine_basic_section(entity);
462 panic("Couldn't determine section for %+F?!?", entity);
465 static void emit_weak(const ir_entity *entity)
467 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
468 be_emit_cstring("\t.weak_reference ");
470 be_emit_cstring("\t.weak ");
472 be_gas_emit_entity(entity);
474 be_emit_write_line();
477 static void emit_visibility(const ir_entity *entity)
479 ir_linkage linkage = get_entity_linkage(entity);
481 if (get_entity_linkage(entity) & IR_LINKAGE_WEAK) {
483 /* Note: .weak seems to imply .globl so no need to output .globl */
484 } else if (get_entity_visibility(entity) == ir_visibility_default) {
485 be_emit_cstring(".globl ");
486 be_gas_emit_entity(entity);
488 be_emit_write_line();
491 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O
492 && (linkage & IR_LINKAGE_HIDDEN_USER)) {
493 be_emit_cstring("\t.no_dead_strip ");
494 be_gas_emit_entity(entity);
496 be_emit_write_line();
500 void be_gas_emit_function_prolog(const ir_entity *entity, unsigned po2alignment)
502 be_gas_section_t section = determine_section(NULL, entity);
503 emit_section(section, entity);
505 /* write the begin line (makes the life easier for scripts parsing the
507 be_emit_write_line();
508 be_emit_cstring("# -- Begin ");
509 be_gas_emit_entity(entity);
511 be_emit_write_line();
513 if (po2alignment > 0) {
514 const char *fill_byte = "";
515 unsigned maximum_skip = (1 << po2alignment) - 1;
516 /* gcc fills space between function with 0x90... */
517 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
520 be_emit_cstring("\t.p2align ");
521 be_emit_irprintf("%u,%s,%u\n", po2alignment, fill_byte, maximum_skip);
522 be_emit_write_line();
524 emit_visibility(entity);
526 switch (be_gas_object_file_format) {
527 case OBJECT_FILE_FORMAT_ELF:
528 case OBJECT_FILE_FORMAT_ELF_SPARC:
529 be_emit_cstring("\t.type\t");
530 be_gas_emit_entity(entity);
531 be_emit_cstring(", ");
532 be_emit_char(be_gas_elf_type_char);
533 be_emit_cstring("function\n");
534 be_emit_write_line();
536 case OBJECT_FILE_FORMAT_COFF:
537 be_emit_cstring("\t.def\t");
538 be_gas_emit_entity(entity);
539 be_emit_cstring(";");
540 if (get_entity_visibility(entity) == ir_visibility_local) {
541 be_emit_cstring("\t.scl\t3;");
543 be_emit_cstring("\t.scl\t2;");
545 be_emit_cstring("\t.type\t32;\t.endef\n");
546 be_emit_write_line();
548 case OBJECT_FILE_FORMAT_MACH_O:
551 be_gas_emit_entity(entity);
552 be_emit_cstring(":\n");
553 be_emit_write_line();
556 void be_gas_emit_function_epilog(const ir_entity *entity)
558 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_ELF) {
559 be_emit_cstring("\t.size\t");
560 be_gas_emit_entity(entity);
561 be_emit_cstring(", .-");
562 be_gas_emit_entity(entity);
564 be_emit_write_line();
567 be_emit_cstring("# -- End ");
568 be_gas_emit_entity(entity);
570 be_emit_write_line();
576 * @param tv the tarval
577 * @param bytes the width of the tarvals value in bytes
579 static void emit_arith_tarval(ir_tarval *tv, int bytes)
583 be_emit_irprintf("0x%02x", get_tarval_sub_bits(tv, 0));
587 be_emit_irprintf("0x%02x%02x", get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
591 be_emit_irprintf("0x%02x%02x%02x%02x",
592 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
596 be_emit_irprintf("0x%02x%02x%02x%02x%02x%02x%02x%02x",
597 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6), get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
598 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
602 /* Beware: Mixed endian output! One little endian number emitted as
603 * three longs. Each long initializer is written in big endian. */
605 "\t.long\t0x%02x%02x%02x%02x\n"
606 "\t.long\t0x%02x%02x%02x%02x\n"
607 "\t.long\t0x%02x%02x%02x%02x",
608 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2),
609 get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0),
610 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6),
611 get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
612 get_tarval_sub_bits(tv, 11), get_tarval_sub_bits(tv, 10),
613 get_tarval_sub_bits(tv, 9), get_tarval_sub_bits(tv, 8)
618 /* Beware: Mixed endian output! One little endian number emitted as
619 * three longs. Each long initializer is written in big endian. */
621 "\t.long\t0x%02x%02x%02x%02x\n"
622 "\t.long\t0x%02x%02x%02x%02x\n"
623 "\t.long\t0x%02x%02x%02x%02x\n"
624 "\t.long\t0x%02x%02x%02x%02x",
625 get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2),
626 get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0),
627 get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6),
628 get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
629 get_tarval_sub_bits(tv, 11), get_tarval_sub_bits(tv, 10),
630 get_tarval_sub_bits(tv, 9), get_tarval_sub_bits(tv, 8),
631 get_tarval_sub_bits(tv, 15), get_tarval_sub_bits(tv, 14),
632 get_tarval_sub_bits(tv, 13), get_tarval_sub_bits(tv, 12)
637 panic("Can't dump a tarval with %d bytes", bytes);
641 * Return the label prefix for labeled instructions.
643 const char *be_gas_insn_label_prefix(void)
649 * Return the tarval of an atomic initializer.
651 * @param init a node representing the initializer (on the const code irg)
655 static ir_tarval *get_atomic_init_tv(ir_node *init)
658 ir_mode *mode = get_irn_mode(init);
660 switch (get_irn_opcode(init)) {
663 init = get_Cast_op(init);
667 init = get_Conv_op(init);
671 return get_Const_tarval(init);
674 switch (get_SymConst_kind(init)) {
675 case symconst_type_size:
676 return new_tarval_from_long(get_type_size_bytes(get_SymConst_type(init)), mode);
678 case symconst_type_align:
679 return new_tarval_from_long(get_type_alignment_bytes(get_SymConst_type(init)), mode);
681 case symconst_ofs_ent:
682 return new_tarval_from_long(get_entity_offset(get_SymConst_entity(init)), mode);
684 case symconst_enum_const:
685 return get_enumeration_value(get_SymConst_enum(init));
698 * Dump an atomic value.
700 * @param env the gas output environment
701 * @param init a node representing the atomic value (on the const code irg)
703 static void do_emit_atomic_init(be_gas_decl_env_t *env, ir_node *init)
705 ir_mode *mode = get_irn_mode(init);
706 int bytes = get_mode_size_bytes(mode);
710 init = skip_Id(init);
712 switch (get_irn_opcode(init)) {
714 do_emit_atomic_init(env, get_Cast_op(init));
718 do_emit_atomic_init(env, get_Conv_op(init));
722 tv = get_Const_tarval(init);
724 /* it's a arithmetic value */
725 emit_arith_tarval(tv, bytes);
729 switch (get_SymConst_kind(init)) {
730 case symconst_addr_ent:
731 ent = get_SymConst_entity(init);
732 be_gas_emit_entity(ent);
735 case symconst_ofs_ent:
736 ent = get_SymConst_entity(init);
737 be_emit_irprintf("%d", get_entity_offset(ent));
740 case symconst_type_size:
741 be_emit_irprintf("%u", get_type_size_bytes(get_SymConst_type(init)));
744 case symconst_type_align:
745 be_emit_irprintf("%u", get_type_alignment_bytes(get_SymConst_type(init)));
748 case symconst_enum_const:
749 tv = get_enumeration_value(get_SymConst_enum(init));
750 emit_arith_tarval(tv, bytes);
754 assert(!"emit_atomic_init(): don't know how to init from this SymConst");
759 if (!mode_is_int(mode) && !mode_is_reference(mode)) {
760 panic("Constant must be int or pointer for '+' to work");
762 do_emit_atomic_init(env, get_Add_left(init));
763 be_emit_cstring(" + ");
764 do_emit_atomic_init(env, get_Add_right(init));
768 if (!mode_is_int(mode) && !mode_is_reference(mode)) {
769 panic("Constant must be int or pointer for '-' to work");
771 do_emit_atomic_init(env, get_Sub_left(init));
772 be_emit_cstring(" - ");
773 do_emit_atomic_init(env, get_Sub_right(init));
777 if (!mode_is_int(mode) && !mode_is_reference(mode)) {
778 panic("Constant must be int or pointer for '*' to work");
780 do_emit_atomic_init(env, get_Mul_left(init));
781 be_emit_cstring(" * ");
782 do_emit_atomic_init(env, get_Mul_right(init));
786 be_emit_cstring("0");
790 panic("emit_atomic_init(): unsupported IR-node %+F", init);
795 * Dumps the type for given size (.byte, .long, ...)
797 * @param size the size in bytes
799 static void emit_size_type(size_t size)
803 be_emit_cstring("\t.byte\t");
807 be_emit_cstring("\t.short\t");
811 be_emit_cstring("\t.long\t");
815 be_emit_cstring("\t.quad\t");
820 case 16: /* Note: .octa does not work on mac */
821 /* handled in arith */
825 panic("Try to dump a type with %u bytes", (unsigned)size);
830 * Emit an atomic value.
832 * @param env the gas output environment
833 * @param init a node representing the atomic value (on the const code irg)
835 static void emit_atomic_init(be_gas_decl_env_t *env, ir_node *init)
837 ir_mode *mode = get_irn_mode(init);
838 int bytes = get_mode_size_bytes(mode);
840 emit_size_type(bytes);
841 do_emit_atomic_init(env, init);
843 be_emit_write_line();
847 * Dump a string constant.
848 * No checks are made!!
850 * @param ent The entity to dump.
852 static void emit_string_cst(const ir_entity *ent)
860 len = get_compound_ent_n_values(ent);
862 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
863 be_emit_cstring("\t.ascii \"");
865 be_emit_cstring("\t.string \"");
869 for (i = 0; i < output_len; ++i) {
873 irn = get_compound_ent_value(ent, i);
874 c = (int) get_tarval_long(get_Const_tarval(irn));
877 case '"' : be_emit_cstring("\\\""); break;
878 case '\n': be_emit_cstring("\\n"); break;
879 case '\r': be_emit_cstring("\\r"); break;
880 case '\t': be_emit_cstring("\\t"); break;
881 case '\\': be_emit_cstring("\\\\"); break;
886 be_emit_irprintf("\\%o", c);
890 be_emit_cstring("\"\n");
891 be_emit_write_line();
893 type = get_entity_type(ent);
894 type_size = get_type_size_bytes(type);
895 remaining_space = type_size - len;
896 assert(remaining_space >= 0);
897 if (remaining_space > 0) {
898 be_emit_irprintf("\t.space\t%d, 0\n", remaining_space);
902 static size_t emit_string_initializer(const ir_initializer_t *initializer)
906 len = initializer->compound.n_initializers;
907 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
908 be_emit_cstring("\t.ascii \"");
910 be_emit_cstring("\t.string \"");
914 for (i = 0; i < len; ++i) {
915 const ir_initializer_t *sub_initializer
916 = get_initializer_compound_value(initializer, i);
918 ir_tarval *tv = get_initializer_tarval(sub_initializer);
919 int c = get_tarval_long(tv);
922 case '"' : be_emit_cstring("\\\""); break;
923 case '\n': be_emit_cstring("\\n"); break;
924 case '\r': be_emit_cstring("\\r"); break;
925 case '\t': be_emit_cstring("\\t"); break;
926 case '\\': be_emit_cstring("\\\\"); break;
931 be_emit_irprintf("\\%o", c);
935 be_emit_cstring("\"\n");
936 be_emit_write_line();
938 return initializer->compound.n_initializers;
941 typedef enum normal_or_bitfield_kind {
946 } normal_or_bitfield_kind;
949 normal_or_bitfield_kind kind;
953 unsigned char bf_val;
954 const ir_initializer_t *string;
956 } normal_or_bitfield;
958 static int is_type_variable_size(ir_type *type)
965 static size_t get_initializer_size(const ir_initializer_t *initializer,
968 switch (get_initializer_kind(initializer)) {
969 case IR_INITIALIZER_TARVAL:
970 assert(get_tarval_mode(get_initializer_tarval_value(initializer)) == get_type_mode(type));
971 return get_type_size_bytes(type);
972 case IR_INITIALIZER_CONST:
973 case IR_INITIALIZER_NULL:
974 return get_type_size_bytes(type);
975 case IR_INITIALIZER_COMPOUND:
976 if (!is_type_variable_size(type)) {
977 return get_type_size_bytes(type);
980 = get_initializer_compound_n_entries(initializer);
982 unsigned initializer_size = get_type_size_bytes(type);
983 for (i = 0; i < n_entries; ++i) {
984 ir_entity *entity = get_compound_member(type, i);
985 ir_type *type = get_entity_type(entity);
987 const ir_initializer_t *sub_initializer
988 = get_initializer_compound_value(initializer, i);
990 unsigned offset = get_entity_offset(entity);
991 unsigned size = get_initializer_size(sub_initializer, type);
993 if (offset + size > initializer_size) {
994 initializer_size = offset + size;
997 return initializer_size;
1001 panic("found invalid initializer");
1005 static normal_or_bitfield *glob_vals;
1006 static size_t max_vals;
1009 static void emit_bitfield(normal_or_bitfield *vals, size_t offset_bits,
1010 const ir_initializer_t *initializer, ir_type *type)
1012 static const size_t BITS_PER_BYTE = 8;
1013 ir_mode *mode = get_type_mode(type);
1014 ir_tarval *tv = NULL;
1018 bool big_endian = be_get_backend_param()->byte_order_big_endian;
1020 switch (get_initializer_kind(initializer)) {
1021 case IR_INITIALIZER_NULL:
1023 case IR_INITIALIZER_TARVAL:
1024 tv = get_initializer_tarval_value(initializer);
1026 case IR_INITIALIZER_CONST: {
1027 ir_node *node = get_initializer_const_value(initializer);
1028 if (!is_Const(node)) {
1029 panic("bitfield initializer not a Const node");
1031 tv = get_Const_tarval(node);
1034 case IR_INITIALIZER_COMPOUND:
1035 panic("bitfield initializer is compound");
1038 panic("Couldn't get numeric value for bitfield initializer");
1040 tv = tarval_convert_to(tv, get_type_mode(type));
1042 value_len = get_type_size_bytes(get_primitive_base_type(type));
1044 end = get_mode_size_bits(mode);
1045 while (bit_offset < end) {
1046 size_t src_offset = bit_offset / BITS_PER_BYTE;
1047 size_t src_offset_bits = bit_offset % BITS_PER_BYTE;
1048 size_t dst_offset = (bit_offset+offset_bits) / BITS_PER_BYTE;
1049 size_t dst_offset_bits = (bit_offset+offset_bits) % BITS_PER_BYTE;
1050 size_t src_bits_len = end-bit_offset;
1051 size_t dst_bits_len = BITS_PER_BYTE-dst_offset_bits;
1052 unsigned char curr_bits;
1053 normal_or_bitfield *val;
1054 if (src_bits_len > dst_bits_len)
1055 src_bits_len = dst_bits_len;
1058 val = &vals[value_len - dst_offset - 1];
1060 val = &vals[dst_offset];
1063 assert((val-glob_vals) < (ptrdiff_t) max_vals);
1064 assert(val->kind == BITFIELD ||
1065 (val->kind == NORMAL && val->v.value == NULL));
1066 val->kind = BITFIELD;
1067 curr_bits = get_tarval_sub_bits(tv, src_offset);
1068 curr_bits = curr_bits >> src_offset_bits;
1069 if (src_offset_bits + src_bits_len > 8) {
1070 unsigned next_bits = get_tarval_sub_bits(tv, src_offset+1);
1071 curr_bits |= next_bits << (8 - src_offset_bits);
1073 curr_bits &= (1 << src_bits_len) - 1;
1074 val->v.bf_val |= curr_bits << dst_offset_bits;
1076 bit_offset += dst_bits_len;
1080 static void emit_ir_initializer(normal_or_bitfield *vals,
1081 const ir_initializer_t *initializer,
1084 assert((size_t) (vals - glob_vals) < max_vals);
1086 if (initializer_is_string_const(initializer)) {
1087 assert(vals->kind != BITFIELD);
1088 vals->kind = STRING;
1089 vals->v.string = initializer;
1093 switch (get_initializer_kind(initializer)) {
1094 case IR_INITIALIZER_NULL:
1096 case IR_INITIALIZER_TARVAL: {
1099 assert(vals->kind != BITFIELD);
1100 vals->kind = TARVAL;
1101 vals->v.tarval = get_initializer_tarval_value(initializer);
1102 assert(get_type_mode(type) == get_tarval_mode(vals->v.tarval));
1103 for (i = 1; i < get_type_size_bytes(type); ++i) {
1104 vals[i].kind = NORMAL;
1105 vals[i].v.value = NULL;
1109 case IR_INITIALIZER_CONST: {
1112 assert(vals->kind != BITFIELD);
1113 vals->kind = NORMAL;
1114 vals->v.value = get_initializer_const_value(initializer);
1115 for (i = 1; i < get_type_size_bytes(type); ++i) {
1116 vals[i].kind = NORMAL;
1117 vals[i].v.value = NULL;
1121 case IR_INITIALIZER_COMPOUND: {
1123 size_t n = get_initializer_compound_n_entries(initializer);
1125 if (is_Array_type(type)) {
1126 ir_type *element_type = get_array_element_type(type);
1127 size_t skip = get_type_size_bytes(element_type);
1128 size_t alignment = get_type_alignment_bytes(element_type);
1129 size_t misalign = skip % alignment;
1130 if (misalign != 0) {
1131 skip += alignment - misalign;
1134 for (i = 0; i < n; ++i) {
1135 ir_initializer_t *sub_initializer
1136 = get_initializer_compound_value(initializer, i);
1138 emit_ir_initializer(vals, sub_initializer, element_type);
1143 size_t n_members, i;
1144 assert(is_compound_type(type));
1145 n_members = get_compound_n_members(type);
1146 for (i = 0; i < n_members; ++i) {
1147 ir_entity *member = get_compound_member(type, i);
1148 size_t offset = get_entity_offset(member);
1149 ir_type *subtype = get_entity_type(member);
1150 ir_mode *mode = get_type_mode(subtype);
1151 ir_initializer_t *sub_initializer;
1153 assert(i < get_initializer_compound_n_entries(initializer));
1155 = get_initializer_compound_value(initializer, i);
1159 = get_entity_offset_bits_remainder(member);
1160 size_t value_len = get_mode_size_bits(mode);
1162 if (offset_bits != 0 ||
1163 (value_len != 8 && value_len != 16 && value_len != 32
1164 && value_len != 64) ||
1165 (is_Primitive_type(subtype) && get_primitive_base_type(subtype) != NULL)) {
1166 emit_bitfield(&vals[offset], offset_bits,
1167 sub_initializer, subtype);
1172 emit_ir_initializer(&vals[offset], sub_initializer, subtype);
1179 panic("invalid ir_initializer kind found");
1182 static void emit_initializer(be_gas_decl_env_t *env, const ir_entity *entity)
1184 const ir_initializer_t *initializer = entity->initializer;
1186 normal_or_bitfield *vals;
1190 if (initializer_is_string_const(initializer)) {
1191 emit_string_initializer(initializer);
1195 type = get_entity_type(entity);
1196 size = get_initializer_size(initializer, type);
1202 * In the worst case, every initializer allocates one byte.
1203 * Moreover, initializer might be big, do not allocate on stack.
1205 vals = XMALLOCNZ(normal_or_bitfield, size);
1212 emit_ir_initializer(vals, initializer, type);
1214 /* now write values sorted */
1215 for (k = 0; k < size; ) {
1218 normal_or_bitfield_kind kind = vals[k].kind;
1221 if (vals[k].v.value != NULL) {
1222 emit_atomic_init(env, vals[k].v.value);
1223 elem_size = get_mode_size_bytes(get_irn_mode(vals[k].v.value));
1229 ir_tarval *tv = vals[k].v.tarval;
1230 size_t size = get_mode_size_bytes(get_tarval_mode(tv));
1235 emit_size_type(size);
1236 emit_arith_tarval(tv, size);
1238 be_emit_write_line();
1242 elem_size = emit_string_initializer(vals[k].v.string);
1245 be_emit_irprintf("\t.byte\t%d\n", vals[k].v.bf_val);
1246 be_emit_write_line();
1251 while (k < size && vals[k].kind == NORMAL && vals[k].v.value == NULL) {
1258 be_emit_irprintf("\t.space\t%d, 0\n", space);
1259 be_emit_write_line();
1265 static void emit_compound_graph_init(be_gas_decl_env_t *env,
1266 const ir_entity *ent)
1268 normal_or_bitfield *vals;
1270 unsigned k, last_ofs;
1272 if (entity_is_string_const(ent)) {
1273 emit_string_cst(ent);
1277 n = get_compound_ent_n_values(ent);
1279 /* Find the initializer size. Sorrily gcc support a nasty feature:
1280 The last field of a compound may be a flexible array. This allows
1281 initializers bigger than the type size. */
1282 last_ofs = get_type_size_bytes(get_entity_type(ent));
1283 for (i = 0; i < n; ++i) {
1284 unsigned offset = get_compound_ent_value_offset_bytes(ent, i);
1285 unsigned bits_remainder = get_compound_ent_value_offset_bit_remainder(ent, i);
1286 ir_node *value = get_compound_ent_value(ent, i);
1287 unsigned value_len = get_mode_size_bits(get_irn_mode(value));
1289 offset += (value_len + bits_remainder + 7) >> 3;
1291 if (offset > last_ofs) {
1297 * In the worst case, every initializer allocates one byte.
1298 * Moreover, initializer might be big, do not allocate on stack.
1300 vals = XMALLOCNZ(normal_or_bitfield, last_ofs);
1302 /* collect the values and store them at the offsets */
1303 for (i = 0; i < n; ++i) {
1304 unsigned offset = get_compound_ent_value_offset_bytes(ent, i);
1305 int offset_bits = get_compound_ent_value_offset_bit_remainder(ent, i);
1306 ir_node *value = get_compound_ent_value(ent, i);
1307 int value_len = get_mode_size_bits(get_irn_mode(value));
1309 assert(offset_bits >= 0);
1311 if (offset_bits != 0 ||
1312 (value_len != 8 && value_len != 16 && value_len != 32 && value_len != 64)) {
1313 ir_tarval *tv = get_atomic_init_tv(value);
1314 unsigned char curr_bits, last_bits = 0;
1316 panic("Couldn't get numeric value for bitfield initializer '%s'",
1317 get_entity_ld_name(ent));
1319 /* normalize offset */
1320 offset += offset_bits >> 3;
1323 for (j = 0; value_len + offset_bits > 0; ++j) {
1324 assert(offset + j < last_ofs);
1325 assert(vals[offset + j].kind == BITFIELD || vals[offset + j].v.value == NULL);
1326 vals[offset + j].kind = BITFIELD;
1327 curr_bits = get_tarval_sub_bits(tv, j);
1328 vals[offset + j].v.bf_val |= (last_bits >> (8 - offset_bits)) | (curr_bits << offset_bits);
1330 last_bits = curr_bits;
1335 assert(offset < last_ofs);
1336 assert(vals[offset].kind == NORMAL);
1337 for (i = 1; i < value_len / 8; ++i) {
1338 assert(vals[offset + i].v.value == NULL);
1340 vals[offset].v.value = value;
1344 /* now write them sorted */
1345 for (k = 0; k < last_ofs; ) {
1346 int space = 0, skip = 0;
1347 if (vals[k].kind == NORMAL) {
1348 if (vals[k].v.value != NULL) {
1349 emit_atomic_init(env, vals[k].v.value);
1350 skip = get_mode_size_bytes(get_irn_mode(vals[k].v.value)) - 1;
1355 assert(vals[k].kind == BITFIELD);
1356 be_emit_irprintf("\t.byte\t%d\n", vals[k].v.bf_val);
1360 while (k < last_ofs && vals[k].kind == NORMAL && vals[k].v.value == NULL) {
1369 be_emit_irprintf("\t.space\t%d, 0\n", space);
1370 be_emit_write_line();
1376 static void emit_align(unsigned p2alignment)
1378 be_emit_irprintf("\t.p2align\t%u\n", log2_floor(p2alignment));
1379 be_emit_write_line();
1382 static unsigned get_effective_entity_alignment(const ir_entity *entity)
1384 unsigned alignment = get_entity_alignment(entity);
1385 if (alignment == 0) {
1386 ir_type *type = get_entity_type(entity);
1387 alignment = get_type_alignment_bytes(type);
1392 static void emit_common(const ir_entity *entity)
1394 unsigned size = get_type_size_bytes(get_entity_type(entity));
1395 unsigned alignment = get_effective_entity_alignment(entity);
1397 if (get_entity_linkage(entity) & IR_LINKAGE_WEAK) {
1401 switch (be_gas_object_file_format) {
1402 case OBJECT_FILE_FORMAT_MACH_O:
1403 be_emit_cstring("\t.comm ");
1404 be_gas_emit_entity(entity);
1405 be_emit_irprintf(",%u,%u\n", size, log2_floor(alignment));
1406 be_emit_write_line();
1408 case OBJECT_FILE_FORMAT_ELF:
1409 case OBJECT_FILE_FORMAT_ELF_SPARC:
1410 be_emit_cstring("\t.comm ");
1411 be_gas_emit_entity(entity);
1412 be_emit_irprintf(",%u,%u\n", size, alignment);
1413 be_emit_write_line();
1415 case OBJECT_FILE_FORMAT_COFF:
1416 be_emit_cstring("\t.comm ");
1417 be_gas_emit_entity(entity);
1418 be_emit_irprintf(",%u # %u\n", size, alignment);
1419 be_emit_write_line();
1422 panic("invalid object file format");
1425 static void emit_local_common(const ir_entity *entity)
1427 unsigned size = get_type_size_bytes(get_entity_type(entity));
1428 unsigned alignment = get_effective_entity_alignment(entity);
1430 if (get_entity_linkage(entity) & IR_LINKAGE_WEAK) {
1434 switch (be_gas_object_file_format) {
1435 case OBJECT_FILE_FORMAT_MACH_O:
1436 be_emit_cstring("\t.lcomm ");
1437 be_gas_emit_entity(entity);
1438 be_emit_irprintf(",%u,%u\n", size, log2_floor(alignment));
1439 be_emit_write_line();
1441 case OBJECT_FILE_FORMAT_ELF:
1442 case OBJECT_FILE_FORMAT_ELF_SPARC:
1443 be_emit_cstring("\t.local ");
1444 be_gas_emit_entity(entity);
1445 be_emit_cstring("\n");
1446 be_emit_write_line();
1447 be_emit_cstring("\t.comm ");
1448 be_gas_emit_entity(entity);
1449 be_emit_irprintf(",%u,%u\n", size, alignment);
1450 be_emit_write_line();
1452 case OBJECT_FILE_FORMAT_COFF:
1453 be_emit_cstring("\t.lcomm ");
1454 be_gas_emit_entity(entity);
1455 be_emit_irprintf(",%u # %u\n", size, alignment);
1456 be_emit_write_line();
1459 panic("invalid object file format");
1462 static void emit_indirect_symbol(const ir_entity *entity, be_gas_section_t section)
1464 /* we can only do PIC code on macho so far */
1465 assert(be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O);
1467 be_gas_emit_entity(entity);
1468 be_emit_cstring(":\n");
1469 be_emit_write_line();
1470 be_emit_cstring("\t.indirect_symbol ");
1471 be_emit_ident(get_entity_ident(entity));
1473 be_emit_write_line();
1474 if (section == GAS_SECTION_PIC_TRAMPOLINES) {
1475 be_emit_cstring("\thlt ; hlt ; hlt ; hlt ; hlt\n");
1476 be_emit_write_line();
1478 assert(section == GAS_SECTION_PIC_SYMBOLS);
1479 be_emit_cstring("\t.long 0\n");
1480 be_emit_write_line();
1484 char const *be_gas_get_private_prefix(void)
1486 return be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O ? "L" : ".L";
1489 void be_gas_emit_entity(const ir_entity *entity)
1491 if (entity->type == firm_code_type) {
1492 ir_label_t label = get_entity_label(entity);
1493 be_emit_irprintf("%s_%lu", be_gas_get_private_prefix(), label);
1497 if (get_entity_visibility(entity) == ir_visibility_private) {
1498 be_emit_string(be_gas_get_private_prefix());
1500 be_emit_ident(get_entity_ld_ident(entity));
1503 void be_gas_emit_block_name(const ir_node *block)
1505 if (has_Block_entity(block)) {
1506 ir_entity *entity = get_Block_entity(block);
1507 be_gas_emit_entity(entity);
1509 be_emit_irprintf("%s%ld", be_gas_get_private_prefix(), get_irn_node_nr(block));
1514 * Dump a global entity.
1516 * @param env the gas output environment
1517 * @param ent the entity to be dumped
1519 static void emit_global(be_gas_decl_env_t *env, const ir_entity *entity)
1521 ir_type *type = get_entity_type(entity);
1522 ident *ld_ident = get_entity_ld_ident(entity);
1523 unsigned alignment = get_effective_entity_alignment(entity);
1524 be_gas_section_t section = determine_section(env, entity);
1525 ir_visibility visibility = get_entity_visibility(entity);
1526 ir_linkage linkage = get_entity_linkage(entity);
1528 /* block labels are already emittet in the code */
1529 if (type == firm_code_type)
1532 /* we already emitted all methods. Except for the trampolines which
1533 * the assembler/linker generates */
1534 if (is_Method_type(type) && section != GAS_SECTION_PIC_TRAMPOLINES) {
1535 /* functions with graph are already emitted with
1536 * be_gas_emit_function_prolog */
1537 if (get_entity_irg(entity) == NULL) {
1538 emit_visibility(entity);
1543 be_dbg_variable(entity);
1545 if (section == GAS_SECTION_BSS) {
1546 switch (visibility) {
1547 case ir_visibility_local:
1548 case ir_visibility_private:
1549 emit_local_common(entity);
1551 case ir_visibility_default:
1552 if (linkage & IR_LINKAGE_MERGE) {
1553 emit_common(entity);
1557 case ir_visibility_external:
1558 if (linkage & IR_LINKAGE_MERGE)
1559 panic("merge link semantic not supported for extern entities");
1564 emit_visibility(entity);
1565 if (visibility == ir_visibility_external) {
1566 /* nothing to do for externally defined values */
1570 if (!is_po2(alignment))
1571 panic("alignment not a power of 2");
1573 emit_section(section, entity);
1575 if (section == GAS_SECTION_PIC_TRAMPOLINES
1576 || section == GAS_SECTION_PIC_SYMBOLS) {
1577 emit_indirect_symbol(entity, section);
1582 if (alignment > 1) {
1583 emit_align(alignment);
1585 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_ELF
1586 && be_gas_emit_types
1587 && visibility != ir_visibility_private) {
1588 be_emit_cstring("\t.type\t");
1589 be_gas_emit_entity(entity);
1590 be_emit_cstring(", ");
1591 be_emit_char(be_gas_elf_type_char);
1592 be_emit_cstring("object\n\t.size\t");\
1593 be_gas_emit_entity(entity);
1594 be_emit_irprintf(", %u\n", get_type_size_bytes(type));
1597 if (get_id_str(ld_ident)[0] != '\0') {
1598 be_gas_emit_entity(entity);
1599 be_emit_cstring(":\n");
1600 be_emit_write_line();
1603 if (entity_is_null(entity)) {
1604 be_emit_irprintf("\t.space %u, 0\n", get_type_size_bytes(type));
1605 be_emit_write_line();
1606 } else if (entity_has_compound_ent_values(entity)) {
1607 emit_compound_graph_init(env, entity);
1609 assert(entity->initializer != NULL);
1610 emit_initializer(env, entity);
1615 * Dumps declarations of global variables and the initialization code.
1617 * @param gt a global like type, either the global or the TLS one
1618 * @param env an environment
1620 static void be_gas_emit_globals(ir_type *gt, be_gas_decl_env_t *env)
1622 int i, n = get_compound_n_members(gt);
1624 for (i = 0; i < n; i++) {
1625 ir_entity *ent = get_compound_member(gt, i);
1626 emit_global(env, ent);
1630 /* Generate all entities. */
1631 void be_gas_emit_decls(const be_main_env_t *main_env)
1633 be_gas_decl_env_t env;
1634 memset(&env, 0, sizeof(env));
1636 /* dump global type */
1637 env.main_env = main_env;
1638 env.section = (be_gas_section_t) -1;
1640 be_gas_emit_globals(get_glob_type(), &env);
1641 be_gas_emit_globals(get_tls_type(), &env);
1642 be_gas_emit_globals(get_segment_type(IR_SEGMENT_CONSTRUCTORS), &env);
1643 be_gas_emit_globals(get_segment_type(IR_SEGMENT_DESTRUCTORS), &env);
1644 be_gas_emit_globals(main_env->pic_symbols_type, &env);
1645 be_gas_emit_globals(main_env->pic_trampolines_type, &env);
1648 * ".subsections_via_symbols marks object files which are OK to divide
1649 * their section contents into individual blocks".
1650 * From my understanding this means no label points in the middle of an
1651 * object which we want to address as a whole. Firm code should be fine
1654 if (be_gas_object_file_format == OBJECT_FILE_FORMAT_MACH_O) {
1655 be_emit_cstring("\t.subsections_via_symbols\n");
1656 be_emit_write_line();