Fix comment.
[platform/upstream/binutils.git] / gas / config / tc-ppc.h
1 /* tc-ppc.h -- Header file for tc-ppc.c.
2    Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
3    2004, 2005, 2006, 2007 Free Software Foundation, Inc.
4    Written by Ian Lance Taylor, Cygnus Support.
5
6    This file is part of GAS, the GNU Assembler.
7
8    GAS is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3, or (at your option)
11    any later version.
12
13    GAS is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with GAS; see the file COPYING.  If not, write to the Free
20    Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
21    02110-1301, USA.  */
22
23 #define TC_PPC
24
25 struct fix;
26
27 /* Set the endianness we are using.  Default to big endian.  */
28 #ifndef TARGET_BYTES_BIG_ENDIAN
29 #define TARGET_BYTES_BIG_ENDIAN 1
30 #endif
31
32 /* If OBJ_COFF is defined, and TE_PE is not defined, we are assembling
33    XCOFF for AIX or PowerMac.  If TE_PE is defined, we are assembling
34    COFF for Windows NT.  */
35
36 #ifdef OBJ_COFF
37 #ifndef TE_PE
38 #define OBJ_XCOFF
39 #endif
40 #endif
41
42 /* The target BFD architecture.  */
43 #define TARGET_ARCH (ppc_arch ())
44 #define TARGET_MACH (ppc_mach ())
45 extern enum bfd_architecture ppc_arch (void);
46 extern unsigned long ppc_mach (void);
47
48 /* Whether or not the target is big endian */
49 extern int target_big_endian;
50
51 /* The target BFD format.  */
52 #define TARGET_FORMAT (ppc_target_format ())
53 extern char *ppc_target_format (void);
54
55 /* Permit temporary numeric labels.  */
56 #define LOCAL_LABELS_FB 1
57
58 /* $ is used to refer to the current location.  */
59 #define DOLLAR_DOT
60
61 /* Strings do not use backslash escapes under COFF.  */
62 #ifdef OBJ_COFF
63 #define NO_STRING_ESCAPES
64 #endif
65
66 #ifdef OBJ_ELF
67 #define DIFF_EXPR_OK            /* foo-. gets turned into PC relative relocs */
68 #endif
69
70 #if TARGET_BYTES_BIG_ENDIAN
71 #define PPC_BIG_ENDIAN 1
72 #else
73 #define PPC_BIG_ENDIAN 0
74 #endif
75
76 /* We don't need to handle .word strangely.  */
77 #define WORKING_DOT_WORD
78
79 #define MAX_MEM_FOR_RS_ALIGN_CODE 4
80 #define HANDLE_ALIGN(FRAGP)                                             \
81   if ((FRAGP)->fr_type == rs_align_code)                                \
82     ppc_handle_align (FRAGP);
83
84 extern void ppc_handle_align (struct frag *);
85
86 #define SUB_SEGMENT_ALIGN(SEG, FRCHAIN) 0
87
88 #define md_frag_check(FRAGP) \
89   if ((FRAGP)->has_code                                                 \
90       && (((FRAGP)->fr_address + (FRAGP)->insn_addr) & 3) != 0)         \
91     as_bad_where ((FRAGP)->fr_file, (FRAGP)->fr_line,                   \
92                   _("instruction address is not a multiple of 4"));
93 \f
94 #ifdef TE_PE
95
96 /* Question marks are permitted in symbol names.  */
97 #define LEX_QM 1
98
99 /* Don't adjust TOC relocs.  */
100 #define tc_fix_adjustable(FIX) ppc_pe_fix_adjustable (FIX)
101 extern int ppc_pe_fix_adjustable (struct fix *);
102
103 #endif
104
105 #ifdef OBJ_XCOFF
106
107 /* Declarations needed when generating XCOFF code.  XCOFF is an
108    extension of COFF, used only on the RS/6000.  Rather than create an
109    obj-xcoff, we just use obj-coff, and handle the extensions here in
110    tc-ppc.  */
111
112 /* We need to keep some information for symbols.  */
113 struct ppc_tc_sy
114 {
115   /* We keep a few linked lists of symbols.  */
116   symbolS *next;
117   /* Non-zero if the symbol should be output.  The RS/6000 assembler
118      only outputs symbols that are external or are mentioned in a
119      .globl or .lglobl statement.  */
120   int output;
121   /* The symbol class.  */
122   int class;
123   /* The real name, if the symbol was renamed.  */
124   char *real_name;
125   /* For a csect symbol, the subsegment we are using.  This is zero
126      for symbols that are not csects.  */
127   subsegT subseg;
128   /* For a csect or common symbol, the alignment to use.  */
129   int align;
130   /* For a function symbol, a symbol whose value is the size.  The
131      field is NULL if there is no size.  */
132   symbolS *size;
133   /* For a csect symbol, the last symbol which has been defined in
134      this csect, or NULL if none have been defined so far.  For a .bs
135      symbol, the referenced csect symbol.  */
136   symbolS *within;
137 };
138
139 #define TC_SYMFIELD_TYPE struct ppc_tc_sy
140
141 /* We need an additional auxent for function symbols.  */
142 #define OBJ_COFF_MAX_AUXENTRIES 2
143
144 /* Square and curly brackets are permitted in symbol names.  */
145 #define LEX_BR 3
146
147 /* Canonicalize the symbol name.  */
148 #define tc_canonicalize_symbol_name(name) ppc_canonicalize_symbol_name (name)
149 extern char *ppc_canonicalize_symbol_name (char *);
150
151 /* Get the symbol class from the name.  */
152 #define tc_symbol_new_hook(sym) ppc_symbol_new_hook (sym)
153 extern void ppc_symbol_new_hook (symbolS *);
154
155 /* Set the symbol class of a label based on the csect.  */
156 #define tc_frob_label(sym) ppc_frob_label (sym)
157 extern void ppc_frob_label (symbolS *);
158
159 /* TOC relocs requires special handling.  */
160 #define tc_fix_adjustable(FIX) ppc_fix_adjustable (FIX)
161 extern int ppc_fix_adjustable (struct fix *);
162
163 /* We need to set the section VMA.  */
164 #define tc_frob_section(sec) ppc_frob_section (sec)
165 extern void ppc_frob_section (asection *);
166
167 /* Finish up the symbol.  */
168 #define tc_frob_symbol(sym, punt) punt = ppc_frob_symbol (sym)
169 extern int ppc_frob_symbol (symbolS *);
170
171 /* Finish up the entire symtab.  */
172 #define tc_adjust_symtab() ppc_adjust_symtab ()
173 extern void ppc_adjust_symtab (void);
174
175 /* We also need to copy, in particular, the class of the symbol,
176    over what obj-coff would otherwise have copied.  */
177 #define OBJ_COPY_SYMBOL_ATTRIBUTES(dest,src)                    \
178 do {                                                            \
179   if (SF_GET_GET_SEGMENT (dest))                                \
180     S_SET_SEGMENT (dest, S_GET_SEGMENT (src));                  \
181   symbol_get_tc (dest)->size = symbol_get_tc (src)->size;       \
182   symbol_get_tc (dest)->align = symbol_get_tc (src)->align;     \
183   symbol_get_tc (dest)->class = symbol_get_tc (src)->class;     \
184   symbol_get_tc (dest)->within = symbol_get_tc (src)->within;   \
185 } while (0)
186
187 #endif /* OBJ_XCOFF */
188
189 extern const char       ppc_symbol_chars[];
190 #define tc_symbol_chars ppc_symbol_chars
191
192 #ifdef OBJ_ELF
193
194 /* Support for SHF_EXCLUDE and SHT_ORDERED */
195 extern int ppc_section_letter (int, char **);
196 extern int ppc_section_type (char *, size_t);
197 extern int ppc_section_word (char *, size_t);
198 extern int ppc_section_flags (int, int, int);
199
200 #define md_elf_section_letter(LETTER, PTR_MSG)  ppc_section_letter (LETTER, PTR_MSG)
201 #define md_elf_section_type(STR, LEN)           ppc_section_type (STR, LEN)
202 #define md_elf_section_word(STR, LEN)           ppc_section_word (STR, LEN)
203 #define md_elf_section_flags(FLAGS, ATTR, TYPE) ppc_section_flags (FLAGS, ATTR, TYPE)
204
205 #define tc_comment_chars ppc_comment_chars
206 extern const char *ppc_comment_chars;
207
208 /* Keep relocations relative to the GOT, or non-PC relative.  */
209 #define tc_fix_adjustable(FIX) ppc_fix_adjustable (FIX)
210 extern int ppc_fix_adjustable (struct fix *);
211
212 /* Values passed to md_apply_fix don't include symbol values.  */
213 #define MD_APPLY_SYM_VALUE(FIX) 0
214
215 #define tc_frob_file_before_adjust ppc_frob_file_before_adjust
216 extern void ppc_frob_file_before_adjust (void);
217
218 #endif /* OBJ_ELF */
219
220 #if defined (OBJ_ELF) || defined (OBJ_XCOFF)
221 #define TC_FORCE_RELOCATION(FIX) ppc_force_relocation (FIX)
222 extern int ppc_force_relocation (struct fix *);
223 #endif
224
225 /* call md_pcrel_from_section, not md_pcrel_from */
226 #define MD_PCREL_FROM_SECTION(FIX, SEC) md_pcrel_from_section(FIX, SEC)
227 extern long md_pcrel_from_section (struct fix *, segT);
228
229 #define md_parse_name(name, exp, mode, c) ppc_parse_name (name, exp)
230 extern int ppc_parse_name (const char *, struct expressionS *);
231
232 #define md_operand(x)
233
234 #define md_cleanup() ppc_cleanup ()
235 extern void ppc_cleanup (void);
236
237 #define TARGET_USE_CFIPOP 1
238
239 #define tc_cfi_frame_initial_instructions ppc_cfi_frame_initial_instructions
240 extern void ppc_cfi_frame_initial_instructions (void);
241
242 #define tc_regname_to_dw2regnum tc_ppc_regname_to_dw2regnum
243 extern int tc_ppc_regname_to_dw2regnum (char *);
244
245 extern int ppc_cie_data_alignment;
246
247 #define DWARF2_LINE_MIN_INSN_LENGTH     4
248 #define DWARF2_DEFAULT_RETURN_COLUMN    0x41
249 #define DWARF2_CIE_DATA_ALIGNMENT       ppc_cie_data_alignment