45c05c250fb88f27a65d1e3df97146a5d035d2bd
[libfirm] / ir / be / begnuas.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Dumps global variables and constants as gas assembler.
23  * @author      Christian Wuerdig, Matthias Braun
24  * @date        04.11.2005
25  * @version     $Id$
26  */
27 #ifndef FIRM_BE_BEGNUAS_H
28 #define FIRM_BE_BEGNUAS_H
29
30 #include <stdbool.h>
31 #include "be_types.h"
32 #include "beemitter.h"
33
34 typedef enum {
35         GAS_SECTION_TEXT,            /**< text section - program code */
36         GAS_SECTION_DATA,            /**< data section - arbitrary data */
37         GAS_SECTION_RODATA,          /**< rodata section - read-only data */
38         GAS_SECTION_BSS,             /**< bss section - zero initialized data */
39         GAS_SECTION_CONSTRUCTORS,    /**< ctors section */
40         GAS_SECTION_DESTRUCTORS,     /**< dtors section */
41         GAS_SECTION_CSTRING,         /**< section for constant strings */
42         GAS_SECTION_PIC_TRAMPOLINES, /**< trampolines for pic codes */
43         GAS_SECTION_PIC_SYMBOLS,     /**< contains resolved pic symbols */
44         GAS_SECTION_DEBUG_INFO,      /**< dwarf debug info */
45         GAS_SECTION_DEBUG_ABBREV,    /**< dwarf debug abbrev */
46         GAS_SECTION_DEBUG_LINE,      /**< dwarf debug line */
47         GAS_SECTION_DEBUG_PUBNAMES,  /**< dwarf pub names */
48         GAS_SECTION_LAST = GAS_SECTION_DEBUG_PUBNAMES,
49         GAS_SECTION_TYPE_MASK    = 0xFF,
50
51         GAS_SECTION_FLAG_TLS     = 1 << 8,  /**< thread local flag */
52         GAS_SECTION_FLAG_COMDAT  = 1 << 9   /**< thread local version of _BSS */
53 } be_gas_section_t;
54 ENUM_BITSET(be_gas_section_t)
55
56 typedef enum object_file_format_t {
57         OBJECT_FILE_FORMAT_ELF,    /**< Executable and Linkable Format (unixes) */
58         OBJECT_FILE_FORMAT_COFF,   /**< Common Object File Format (Windows) */
59         OBJECT_FILE_FORMAT_MACH_O, /**< Mach Object File Format (OS/X) */
60         OBJECT_FILE_FORMAT_LAST = OBJECT_FILE_FORMAT_MACH_O
61 } object_file_format_t;
62
63 typedef enum elf_variant_t {
64         ELF_VARIANT_NORMAL,
65         ELF_VARIANT_SPARC
66 } elf_variant_t;
67
68 /** The variable where the GAS dialect is stored. */
69 extern object_file_format_t be_gas_object_file_format;
70 extern bool                 be_gas_emit_types;
71 extern elf_variant_t        be_gas_elf_variant;
72
73 /**
74  * the .type directive needs to specify @function, #function or %function
75  * depending on the target architecture
76  */
77 extern char                 be_gas_elf_type_char;
78
79 /**
80  * Switch the current output section to the given out.
81  *
82  * @param section  the new output section
83  */
84 void be_gas_emit_switch_section(be_gas_section_t section);
85
86 /**
87  * emit assembler instructions necessary before starting function code
88  */
89 void be_gas_emit_function_prolog(const ir_entity *entity,
90                                  unsigned po2alignment);
91
92 void be_gas_emit_function_epilog(const ir_entity *entity);
93
94 char const *be_gas_get_private_prefix(void);
95
96 /**
97  * emit ld_ident of an entity and performs additional mangling if necessary.
98  * (mangling is necessary for ir_visibility_private for example).
99  * Emits a block label for type_code entities.
100  */
101 void be_gas_emit_entity(const ir_entity *entity);
102
103 /**
104  * Emit (a private) symbol name for a firm block
105  */
106 void be_gas_emit_block_name(const ir_node *block);
107
108 /**
109  * Starts emitting a compilation unit. This emits:
110  *  - global assembler snippets
111  *  - debug info
112  */
113 void be_gas_begin_compilation_unit(const be_main_env_t *env);
114
115 /**
116  * ends a compilation unit. This emits:
117  *  - global declarations/variables
118  *  - debug info
119  */
120 void be_gas_end_compilation_unit(const be_main_env_t *env);
121
122 /**
123  * Return the label prefix for labeled instructions.
124  */
125 const char *be_gas_insn_label_prefix(void);
126
127 typedef ir_node* (*get_cfop_target_func)(const ir_node *cfop);
128
129 /**
130  * Emits a jump table for switch operations
131  */
132 void emit_jump_table(const ir_node *node, long default_pn, ir_entity *table,
133                      get_cfop_target_func get_cfop_target);
134
135 #endif