2005-04-20 H.J. Lu <hongjiu.lu@intel.com>
[external/binutils.git] / gas / symbols.h
1 /* symbols.h -
2    Copyright 1987, 1990, 1992, 1993, 1994, 1995, 1997, 1999, 2000, 2001,
3    2002, 2003, 2004, 2005 Free Software Foundation, Inc.
4
5    This file is part of GAS, the GNU Assembler.
6
7    GAS is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2, or (at your option)
10    any later version.
11
12    GAS is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with GAS; see the file COPYING.  If not, write to the Free
19    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #ifdef BFD_ASSEMBLER
23 /* The BFD code wants to walk the list in both directions.  */
24 #undef  SYMBOLS_NEED_BACKPOINTERS
25 #define SYMBOLS_NEED_BACKPOINTERS
26 #endif
27
28 #ifndef BFD_ASSEMBLER
29 /* The non-BFD code expects to be able to manipulate the symbol fields
30    directly.  */
31 #include "struc-symbol.h"
32 #endif
33
34 extern struct obstack notes;    /* eg FixS live here.  */
35
36 extern struct obstack cond_obstack;     /* this is where we track .ifdef/.endif
37                                        (if we do that at all).  */
38
39 extern symbolS *symbol_rootP;   /* all the symbol nodes */
40 extern symbolS *symbol_lastP;   /* last struct symbol we made, or NULL */
41
42 extern symbolS abs_symbol;
43
44 extern int symbol_table_frozen;
45
46 /* This is non-zero if symbols are case sensitive, which is the
47    default.  */
48 extern int symbols_case_sensitive;
49
50 char *decode_local_label_name (char *s);
51 symbolS *symbol_find (const char *name);
52 symbolS *symbol_find_exact (const char *name);
53 symbolS *symbol_find_or_make (const char *name);
54 symbolS *symbol_make (const char *name);
55 symbolS *symbol_new (const char *name, segT segment, valueT value,
56                      fragS * frag);
57 symbolS *symbol_create (const char *name, segT segment, valueT value,
58                         fragS * frag);
59 struct local_symbol *local_symbol_make (const char *name, segT section,
60                                         valueT value, fragS * frag);
61 symbolS *symbol_temp_new (segT, valueT, fragS *);
62 symbolS *symbol_temp_new_now (void);
63 symbolS *symbol_temp_make (void);
64
65 symbolS *colon (const char *sym_name);
66 void local_colon (int n);
67 void symbol_begin (void);
68 void symbol_print_statistics (FILE *);
69 void symbol_table_insert (symbolS * symbolP);
70 valueT resolve_symbol_value (symbolS *);
71 void resolve_local_symbol_values (void);
72
73 void print_symbol_value (symbolS *);
74 void print_expr (expressionS *);
75 void print_expr_1 (FILE *, expressionS *);
76 void print_symbol_value_1 (FILE *, symbolS *);
77
78 int dollar_label_defined (long l);
79 void dollar_label_clear (void);
80 void define_dollar_label (long l);
81 char *dollar_label_name (long l, int augend);
82
83 void fb_label_instance_inc (long label);
84 char *fb_label_name (long n, long augend);
85
86 extern void copy_symbol_attributes (symbolS *, symbolS *);
87
88 /* Get and set the values of symbols.  These used to be macros.  */
89 extern valueT S_GET_VALUE (symbolS *);
90 extern void S_SET_VALUE (symbolS *, valueT);
91
92 #ifdef BFD_ASSEMBLER
93 extern int S_IS_FUNCTION (symbolS *);
94 extern int S_IS_EXTERNAL (symbolS *);
95 extern int S_IS_WEAK (symbolS *);
96 extern int S_IS_COMMON (symbolS *);
97 extern int S_IS_DEFINED (symbolS *);
98 extern int S_FORCE_RELOC (symbolS *, int);
99 extern int S_IS_DEBUG (symbolS *);
100 extern int S_IS_LOCAL (symbolS *);
101 extern int S_IS_STABD (symbolS *);
102 extern const char *S_GET_NAME (symbolS *);
103 extern segT S_GET_SEGMENT (symbolS *);
104 extern void S_SET_SEGMENT (symbolS *, segT);
105 extern void S_SET_EXTERNAL (symbolS *);
106 extern void S_SET_NAME (symbolS *, const char *);
107 extern void S_CLEAR_EXTERNAL (symbolS *);
108 extern void S_SET_WEAK (symbolS *);
109 extern void S_SET_THREAD_LOCAL (symbolS *);
110 #endif
111
112 #ifndef WORKING_DOT_WORD
113 struct broken_word
114   {
115     /* Linked list -- one of these structures per ".word x-y+C"
116        expression.  */
117     struct broken_word *next_broken_word;
118     /* Segment and subsegment for broken word.  */
119     segT seg;
120     subsegT subseg;
121     /* Which frag is this broken word in?  */
122     fragS *frag;
123     /* Where in the frag is it?  */
124     char *word_goes_here;
125     /* Where to add the break.  */
126     fragS *dispfrag;            /* where to add the break */
127     /* Operands of expression.  */
128     symbolS *add;
129     symbolS *sub;
130     offsetT addnum;
131
132     int added;                  /* nasty thing happened yet? */
133     /* 1: added and has a long-jump */
134     /* 2: added but uses someone elses long-jump */
135
136     /* Pointer to broken_word with a similar long-jump.  */
137     struct broken_word *use_jump;
138   };
139 extern struct broken_word *broken_words;
140 #endif /* ndef WORKING_DOT_WORD */
141
142 /*
143  * Current means for getting from symbols to segments and vice verse.
144  * This will change for infinite-segments support (e.g. COFF).
145  */
146 extern const segT N_TYPE_seg[]; /* subseg.c */
147
148 #define SEGMENT_TO_SYMBOL_TYPE(seg)  ( seg_N_TYPE [(int) (seg)] )
149 extern const short seg_N_TYPE[];/* subseg.c */
150
151 #define N_REGISTER      30      /* Fake N_TYPE value for SEG_REGISTER */
152
153 void symbol_clear_list_pointers (symbolS * symbolP);
154
155 #ifdef SYMBOLS_NEED_BACKPOINTERS
156
157 void symbol_insert (symbolS * addme, symbolS * target,
158                     symbolS ** rootP, symbolS ** lastP);
159 void symbol_remove (symbolS * symbolP, symbolS ** rootP,
160                     symbolS ** lastP);
161
162 extern symbolS *symbol_previous (symbolS *);
163
164 #endif /* SYMBOLS_NEED_BACKPOINTERS */
165
166 void verify_symbol_chain (symbolS * rootP, symbolS * lastP);
167 void verify_symbol_chain_2 (symbolS * symP);
168
169 void symbol_append (symbolS * addme, symbolS * target,
170                     symbolS ** rootP, symbolS ** lastP);
171
172 extern symbolS *symbol_next (symbolS *);
173
174 extern expressionS *symbol_get_value_expression (symbolS *);
175 extern void symbol_set_value_expression (symbolS *, const expressionS *);
176 extern offsetT *symbol_X_add_number (symbolS *);
177 extern void symbol_set_value_now (symbolS *);
178 extern void symbol_set_frag (symbolS *, fragS *);
179 extern fragS *symbol_get_frag (symbolS *);
180 extern void symbol_mark_used (symbolS *);
181 extern void symbol_clear_used (symbolS *);
182 extern int symbol_used_p (symbolS *);
183 extern void symbol_mark_used_in_reloc (symbolS *);
184 extern void symbol_clear_used_in_reloc (symbolS *);
185 extern int symbol_used_in_reloc_p (symbolS *);
186 extern void symbol_mark_mri_common (symbolS *);
187 extern void symbol_clear_mri_common (symbolS *);
188 extern int symbol_mri_common_p (symbolS *);
189 extern void symbol_mark_written (symbolS *);
190 extern void symbol_clear_written (symbolS *);
191 extern int symbol_written_p (symbolS *);
192 extern void symbol_mark_resolved (symbolS *);
193 extern int symbol_resolved_p (symbolS *);
194 extern int symbol_section_p (symbolS *);
195 extern int symbol_equated_p (symbolS *);
196 extern int symbol_equated_reloc_p (symbolS *);
197 extern int symbol_constant_p (symbolS *);
198
199 #ifdef BFD_ASSEMBLER
200 extern asymbol *symbol_get_bfdsym (symbolS *);
201 extern void symbol_set_bfdsym (symbolS *, asymbol *);
202 #endif
203
204 #ifdef OBJ_SYMFIELD_TYPE
205 OBJ_SYMFIELD_TYPE *symbol_get_obj (symbolS *);
206 void symbol_set_obj (symbolS *, OBJ_SYMFIELD_TYPE *);
207 #endif
208
209 #ifdef TC_SYMFIELD_TYPE
210 TC_SYMFIELD_TYPE *symbol_get_tc (symbolS *);
211 void symbol_set_tc (symbolS *, TC_SYMFIELD_TYPE *);
212 #endif