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