[deliverable/binutils-gdb.git] / gas / symbols.h

/* symbols.h -
   Copyright 1987, 1990, 1992, 1993, 1994, 1995, 1997, 1999, 2000, 2001,
   2002, 2003 Free Software Foundation, Inc.

   This file is part of GAS, the GNU Assembler.

   GAS is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   GAS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with GAS; see the file COPYING.  If not, write to the Free
   Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.  */

#ifdef BFD_ASSEMBLER
/* The BFD code wants to walk the list in both directions.  */
#undef  SYMBOLS_NEED_BACKPOINTERS
#define SYMBOLS_NEED_BACKPOINTERS
#endif

#ifndef BFD_ASSEMBLER
/* The non-BFD code expects to be able to manipulate the symbol fields
   directly.  */
#include "struc-symbol.h"
#endif

extern struct obstack notes;	/* eg FixS live here.  */

extern struct obstack cond_obstack;	/* this is where we track .ifdef/.endif
				       (if we do that at all).  */

extern symbolS *symbol_rootP;	/* all the symbol nodes */
extern symbolS *symbol_lastP;	/* last struct symbol we made, or NULL */

extern symbolS abs_symbol;

extern int symbol_table_frozen;

/* This is non-zero if symbols are case sensitive, which is the
   default.  */
extern int symbols_case_sensitive;

char *decode_local_label_name PARAMS ((char *s));
symbolS *symbol_find PARAMS ((const char *name));
symbolS *symbol_find_exact PARAMS ((const char *name));
symbolS *symbol_find_base PARAMS ((const char *name, int strip_underscore));
symbolS *symbol_find_or_make PARAMS ((const char *name));
symbolS *symbol_make PARAMS ((const char *name));
symbolS *symbol_new PARAMS ((const char *name, segT segment, valueT value,
			     fragS * frag));
symbolS *symbol_create PARAMS ((const char *name, segT segment, valueT value,
				fragS * frag));
symbolS *colon PARAMS ((const char *sym_name));
void local_colon PARAMS ((int n));
void symbol_begin PARAMS ((void));
void symbol_print_statistics PARAMS ((FILE *));
void symbol_table_insert PARAMS ((symbolS * symbolP));
valueT resolve_symbol_value PARAMS ((symbolS *));
void resolve_local_symbol_values PARAMS ((void));

void print_symbol_value PARAMS ((symbolS *));
void print_expr PARAMS ((expressionS *));
void print_expr_1 PARAMS ((FILE *, expressionS *));
void print_symbol_value_1 PARAMS ((FILE *, symbolS *));

int dollar_label_defined PARAMS ((long l));
void dollar_label_clear PARAMS ((void));
void define_dollar_label PARAMS ((long l));
char *dollar_label_name PARAMS ((long l, int augend));

void fb_label_instance_inc PARAMS ((long label));
char *fb_label_name PARAMS ((long n, long augend));

extern void copy_symbol_attributes PARAMS ((symbolS *, symbolS *));

/* Get and set the values of symbols.  These used to be macros.  */
extern valueT S_GET_VALUE PARAMS ((symbolS *));
extern void S_SET_VALUE PARAMS ((symbolS *, valueT));

#ifdef BFD_ASSEMBLER
extern int S_IS_FUNCTION PARAMS ((symbolS *));
extern int S_IS_EXTERNAL PARAMS ((symbolS *));
extern int S_IS_WEAK PARAMS ((symbolS *));
extern int S_IS_COMMON PARAMS ((symbolS *));
extern int S_IS_DEFINED PARAMS ((symbolS *));
extern int S_FORCE_RELOC PARAMS ((symbolS *, int));
extern int S_IS_DEBUG PARAMS ((symbolS *));
extern int S_IS_LOCAL PARAMS ((symbolS *));
extern int S_IS_EXTERN PARAMS ((symbolS *));
extern int S_IS_STABD PARAMS ((symbolS *));
extern const char *S_GET_NAME PARAMS ((symbolS *));
extern segT S_GET_SEGMENT PARAMS ((symbolS *));
extern void S_SET_SEGMENT PARAMS ((symbolS *, segT));
extern void S_SET_EXTERNAL PARAMS ((symbolS *));
extern void S_SET_NAME PARAMS ((symbolS *, char *));
extern void S_CLEAR_EXTERNAL PARAMS ((symbolS *));
extern void S_SET_WEAK PARAMS ((symbolS *));
extern void S_SET_THREAD_LOCAL PARAMS ((symbolS *));
#endif

#ifndef WORKING_DOT_WORD
struct broken_word
  {
    /* Linked list -- one of these structures per ".word x-y+C"
       expression.  */
    struct broken_word *next_broken_word;
    /* Segment and subsegment for broken word.  */
    segT seg;
    subsegT subseg;
    /* Which frag is this broken word in?  */
    fragS *frag;
    /* Where in the frag is it?  */
    char *word_goes_here;
    /* Where to add the break.  */
    fragS *dispfrag;		/* where to add the break */
    /* Operands of expression.  */
    symbolS *add;
    symbolS *sub;
    offsetT addnum;

    int added;			/* nasty thing happend yet? */
    /* 1: added and has a long-jump */
    /* 2: added but uses someone elses long-jump */

    /* Pointer to broken_word with a similar long-jump.  */
    struct broken_word *use_jump;
  };
extern struct broken_word *broken_words;
#endif /* ndef WORKING_DOT_WORD */

/*
 * Current means for getting from symbols to segments and vice verse.
 * This will change for infinite-segments support (e.g. COFF).
 */
extern const segT N_TYPE_seg[];	/* subseg.c */

#define	SEGMENT_TO_SYMBOL_TYPE(seg)  ( seg_N_TYPE [(int) (seg)] )
extern const short seg_N_TYPE[];/* subseg.c */

#define	N_REGISTER	30	/* Fake N_TYPE value for SEG_REGISTER */

void symbol_clear_list_pointers PARAMS ((symbolS * symbolP));

#ifdef SYMBOLS_NEED_BACKPOINTERS

void symbol_insert PARAMS ((symbolS * addme, symbolS * target,
			    symbolS ** rootP, symbolS ** lastP));
void symbol_remove PARAMS ((symbolS * symbolP, symbolS ** rootP,
			    symbolS ** lastP));

extern symbolS *symbol_previous PARAMS ((symbolS *));

#endif /* SYMBOLS_NEED_BACKPOINTERS */

void verify_symbol_chain PARAMS ((symbolS * rootP, symbolS * lastP));
void verify_symbol_chain_2 PARAMS ((symbolS * symP));

void symbol_append PARAMS ((symbolS * addme, symbolS * target,
			    symbolS ** rootP, symbolS ** lastP));

extern symbolS *symbol_next PARAMS ((symbolS *));

extern expressionS *symbol_get_value_expression PARAMS ((symbolS *));
extern void symbol_set_value_expression PARAMS ((symbolS *,
						 const expressionS *));
extern void symbol_set_frag PARAMS ((symbolS *, fragS *));
extern fragS *symbol_get_frag PARAMS ((symbolS *));
extern void symbol_mark_used PARAMS ((symbolS *));
extern void symbol_clear_used PARAMS ((symbolS *));
extern int symbol_used_p PARAMS ((symbolS *));
extern void symbol_mark_used_in_reloc PARAMS ((symbolS *));
extern void symbol_clear_used_in_reloc PARAMS ((symbolS *));
extern int symbol_used_in_reloc_p PARAMS ((symbolS *));
extern void symbol_mark_mri_common PARAMS ((symbolS *));
extern void symbol_clear_mri_common PARAMS ((symbolS *));
extern int symbol_mri_common_p PARAMS ((symbolS *));
extern void symbol_mark_written PARAMS ((symbolS *));
extern void symbol_clear_written PARAMS ((symbolS *));
extern int symbol_written_p PARAMS ((symbolS *));
extern void symbol_mark_resolved PARAMS ((symbolS *));
extern int symbol_resolved_p PARAMS ((symbolS *));
extern int symbol_section_p PARAMS ((symbolS *));
extern int symbol_equated_p PARAMS ((symbolS *));
extern int symbol_equated_reloc_p PARAMS ((symbolS *));
extern int symbol_constant_p PARAMS ((symbolS *));

#ifdef BFD_ASSEMBLER
extern asymbol *symbol_get_bfdsym PARAMS ((symbolS *));
extern void symbol_set_bfdsym PARAMS ((symbolS *, asymbol *));
#endif

#ifdef OBJ_SYMFIELD_TYPE
OBJ_SYMFIELD_TYPE *symbol_get_obj PARAMS ((symbolS *));
void symbol_set_obj PARAMS ((symbolS *, OBJ_SYMFIELD_TYPE *));
#endif

#ifdef TC_SYMFIELD_TYPE
TC_SYMFIELD_TYPE *symbol_get_tc PARAMS ((symbolS *));
void symbol_set_tc PARAMS ((symbolS *, TC_SYMFIELD_TYPE *));
#endif
Commit	Line	Data
252b5132	1	/* symbols.h -
9758f3fc	2	Copyright 1987, 1990, 1992, 1993, 1994, 1995, 1997, 1999, 2000, 2001,
ae6063d4	3	2002, 2003 Free Software Foundation, Inc.
252b5132 RH	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
49309057 ILT	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
a01b9fa4	34	extern struct obstack notes; /* eg FixS live here. */
252b5132 RH	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 PARAMS ((char s));
9758f3fc AM	51	symbolS symbol_find PARAMS ((const char name));
	52	symbolS symbol_find_exact PARAMS ((const char name));
	53	symbolS symbol_find_base PARAMS ((const char name, int strip_underscore));
252b5132	54	symbolS symbol_find_or_make PARAMS ((const char name));
9758f3fc AM	55	symbolS symbol_make PARAMS ((const char name));
9758f3fc AM	56	symbolS symbol_new PARAMS ((const char name, segT segment, valueT value,
252b5132	57	fragS * frag));
9758f3fc	58	symbolS symbol_create PARAMS ((const char name, segT segment, valueT value,
252b5132 RH	59	fragS * frag));
	60	symbolS colon PARAMS ((const char sym_name));
	61	void local_colon PARAMS ((int n));
	62	void symbol_begin PARAMS ((void));
	63	void symbol_print_statistics PARAMS ((FILE *));
	64	void symbol_table_insert PARAMS ((symbolS * symbolP));
6386f3a7	65	valueT resolve_symbol_value PARAMS ((symbolS *));
49309057	66	void resolve_local_symbol_values PARAMS ((void));
252b5132 RH	67
	68	void print_symbol_value PARAMS ((symbolS *));
	69	void print_expr PARAMS ((expressionS *));
	70	void print_expr_1 PARAMS ((FILE , expressionS ));
	71	void print_symbol_value_1 PARAMS ((FILE , symbolS ));
	72
	73	int dollar_label_defined PARAMS ((long l));
	74	void dollar_label_clear PARAMS ((void));
	75	void define_dollar_label PARAMS ((long l));
	76	char *dollar_label_name PARAMS ((long l, int augend));
	77
	78	void fb_label_instance_inc PARAMS ((long label));
	79	char *fb_label_name PARAMS ((long n, long augend));
	80
	81	extern void copy_symbol_attributes PARAMS ((symbolS , symbolS ));
	82
	83	/* Get and set the values of symbols. These used to be macros. */
	84	extern valueT S_GET_VALUE PARAMS ((symbolS *));
	85	extern void S_SET_VALUE PARAMS ((symbolS *, valueT));
	86
	87	#ifdef BFD_ASSEMBLER
58b5739a	88	extern int S_IS_FUNCTION PARAMS ((symbolS *));
252b5132 RH	89	extern int S_IS_EXTERNAL PARAMS ((symbolS *));
	90	extern int S_IS_WEAK PARAMS ((symbolS *));
	91	extern int S_IS_COMMON PARAMS ((symbolS *));
	92	extern int S_IS_DEFINED PARAMS ((symbolS *));
ae6063d4	93	extern int S_FORCE_RELOC PARAMS ((symbolS *, int));
252b5132 RH	94	extern int S_IS_DEBUG PARAMS ((symbolS *));
	95	extern int S_IS_LOCAL PARAMS ((symbolS *));
	96	extern int S_IS_EXTERN PARAMS ((symbolS *));
	97	extern int S_IS_STABD PARAMS ((symbolS *));
9758f3fc	98	extern const char S_GET_NAME PARAMS ((symbolS ));
252b5132 RH	99	extern segT S_GET_SEGMENT PARAMS ((symbolS *));
	100	extern void S_SET_SEGMENT PARAMS ((symbolS *, segT));
	101	extern void S_SET_EXTERNAL PARAMS ((symbolS *));
	102	extern void S_SET_NAME PARAMS ((symbolS , char ));
	103	extern void S_CLEAR_EXTERNAL PARAMS ((symbolS *));
	104	extern void S_SET_WEAK PARAMS ((symbolS *));
00f7efb6	105	extern void S_SET_THREAD_LOCAL PARAMS ((symbolS *));
252b5132 RH	106	#endif
252b5132 RH	107
49309057 ILT	108	#ifndef WORKING_DOT_WORD
	109	struct broken_word
	110	{
	111	/* Linked list -- one of these structures per ".word x-y+C"
	112	expression. */
	113	struct broken_word *next_broken_word;
	114	/* Segment and subsegment for broken word. */
	115	segT seg;
	116	subsegT subseg;
	117	/* Which frag is this broken word in? */
	118	fragS *frag;
	119	/* Where in the frag is it? */
	120	char *word_goes_here;
	121	/* Where to add the break. */
	122	fragS dispfrag; / where to add the break */
	123	/* Operands of expression. */
	124	symbolS *add;
	125	symbolS *sub;
	126	offsetT addnum;
	127
	128	int added; /* nasty thing happend yet? */
	129	/* 1: added and has a long-jump */
	130	/* 2: added but uses someone elses long-jump */
	131
	132	/* Pointer to broken_word with a similar long-jump. */
	133	struct broken_word *use_jump;
	134	};
	135	extern struct broken_word *broken_words;
	136	#endif /* ndef WORKING_DOT_WORD */
	137
	138	/*
	139	* Current means for getting from symbols to segments and vice verse.
	140	* This will change for infinite-segments support (e.g. COFF).
	141	*/
	142	extern const segT N_TYPE_seg[]; /* subseg.c */
	143
	144	#define SEGMENT_TO_SYMBOL_TYPE(seg) ( seg_N_TYPE [(int) (seg)] )
	145	extern const short seg_N_TYPE[];/* subseg.c */
	146
	147	#define N_REGISTER 30 /* Fake N_TYPE value for SEG_REGISTER */
	148
	149	void symbol_clear_list_pointers PARAMS ((symbolS * symbolP));
	150
	151	#ifdef SYMBOLS_NEED_BACKPOINTERS
	152
	153	void symbol_insert PARAMS ((symbolS * addme, symbolS * target,
	154	symbolS rootP, symbolS lastP));
	155	void symbol_remove PARAMS ((symbolS * symbolP, symbolS ** rootP,
	156	symbolS ** lastP));
	157
	158	extern symbolS symbol_previous PARAMS ((symbolS ));
	159
	160	#endif /* SYMBOLS_NEED_BACKPOINTERS */
	161
	162	void verify_symbol_chain PARAMS ((symbolS * rootP, symbolS * lastP));
	163	void verify_symbol_chain_2 PARAMS ((symbolS * symP));
	164
	165	void symbol_append PARAMS ((symbolS * addme, symbolS * target,
	166	symbolS rootP, symbolS lastP));
	167
	168	extern symbolS symbol_next PARAMS ((symbolS ));
	169
	170	extern expressionS symbol_get_value_expression PARAMS ((symbolS ));
	171	extern void symbol_set_value_expression PARAMS ((symbolS *,
172	const expressionS *));
173	extern void symbol_set_frag PARAMS ((symbolS , fragS ));
174	extern fragS symbol_get_frag PARAMS ((symbolS ));
175	extern void symbol_mark_used PARAMS ((symbolS *));
176	extern void symbol_clear_used PARAMS ((symbolS *));
177	extern int symbol_used_p PARAMS ((symbolS *));
178	extern void symbol_mark_used_in_reloc PARAMS ((symbolS *));
179	extern void symbol_clear_used_in_reloc PARAMS ((symbolS *));
180	extern int symbol_used_in_reloc_p PARAMS ((symbolS *));
181	extern void symbol_mark_mri_common PARAMS ((symbolS *));
182	extern void symbol_clear_mri_common PARAMS ((symbolS *));
183	extern int symbol_mri_common_p PARAMS ((symbolS *));
184	extern void symbol_mark_written PARAMS ((symbolS *));
185	extern void symbol_clear_written PARAMS ((symbolS *));
186	extern int symbol_written_p PARAMS ((symbolS *));
187	extern void symbol_mark_resolved PARAMS ((symbolS *));
188	extern int symbol_resolved_p PARAMS ((symbolS *));
189	extern int symbol_section_p PARAMS ((symbolS *));
190	extern int symbol_equated_p PARAMS ((symbolS *));
e0890092	191	extern int symbol_equated_reloc_p PARAMS ((symbolS *));
49309057 ILT	192	extern int symbol_constant_p PARAMS ((symbolS *));
	193
	194	#ifdef BFD_ASSEMBLER
	195	extern asymbol symbol_get_bfdsym PARAMS ((symbolS ));
	196	extern void symbol_set_bfdsym PARAMS ((symbolS , asymbol ));
	197	#endif
	198
	199	#ifdef OBJ_SYMFIELD_TYPE
	200	OBJ_SYMFIELD_TYPE symbol_get_obj PARAMS ((symbolS ));
	201	void symbol_set_obj PARAMS ((symbolS , OBJ_SYMFIELD_TYPE ));
	202	#endif
	203
	204	#ifdef TC_SYMFIELD_TYPE
	205	TC_SYMFIELD_TYPE symbol_get_tc PARAMS ((symbolS ));
	206	void symbol_set_tc PARAMS ((symbolS , TC_SYMFIELD_TYPE ));
	207	#endif