update copyright message
[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 "be.h"
31 #include "beemitter.h"
32
33 /**
34  * Sections.
35  */
36 typedef enum section_t {
37         GAS_SECTION_TEXT   = 0,   /**< text section */
38         GAS_SECTION_DATA   = 1,   /**< data section */
39         GAS_SECTION_RODATA = 2,   /**< rodata section */
40         GAS_SECTION_COMMON = 3,   /**< common section */
41         GAS_SECTION_TLS    = 4,   /**< thread local storage section */
42         GAS_SECTION_CTOR   = 5,   /**< ctor section for instrumentation code init */
43         GAS_SECTION_MAX    = 6
44 } be_gas_section_t;
45
46 /**
47  * Support for some GAS "dialects".
48  */
49 typedef enum asm_flavour_t {
50         GAS_FLAVOUR_NORMAL = 0,  /**< normal gas (ELF) */
51         GAS_FLAVOUR_MINGW  = 1,  /**< MinGW variant (no-ELF) */
52         GAS_FLAVOUR_YASM   = 2,  /**< YASM GNU parser */
53         GAS_FLAVOUR_MAX    = 3
54 } be_gas_flavour_t;
55
56 /** The variable where the GAS dialect is stored. */
57 extern be_gas_flavour_t be_gas_flavour;
58
59 /**
60  * Generate all entities.
61  * @param env               the emitter environment
62  * @param main_env          the main backend environment
63  * @param emit_commons      if non-zero, emit commons (non-local uninitialized entities)
64  * @param only_emit_marked  if non-zero, external allocated entities that do not have
65  *                          its visited flag set are ignored
66  */
67 void be_gas_emit_decls(const be_main_env_t *main_env,
68                        int only_emit_marked_entities);
69
70 /**
71  * Switch the current output section to the given out.
72  *
73  * @param env      the emitter environment
74  * @param section  the new output section
75  */
76 void be_gas_emit_switch_section(be_gas_section_t section);
77
78 /**
79  * Return the label prefix for labeled blocks.
80  */
81 const char *be_gas_label_prefix(void);
82
83 #endif /* FIRM_BE_BEGNUAS_H */