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

/* symbols.h -
   Copyright 1987, 1990, 1992, 1993, 1994, 1995, 1997, 1999, 2000, 2001,
   2002, 2003, 2004, 2005 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 (char *s);
symbolS *symbol_find (const char *name);
symbolS *symbol_find_exact (const char *name);
symbolS *symbol_find_or_make (const char *name);
symbolS *symbol_make (const char *name);
symbolS *symbol_new (const char *name, segT segment, valueT value,
		     fragS * frag);
symbolS *symbol_create (const char *name, segT segment, valueT value,
			fragS * frag);
struct local_symbol *local_symbol_make (const char *name, segT section,
					valueT value, fragS * frag);
symbolS *symbol_temp_new (segT, valueT, fragS *);
symbolS *symbol_temp_new_now (void);
symbolS *symbol_temp_make (void);

symbolS *colon (const char *sym_name);
void local_colon (int n);
void symbol_begin (void);
void symbol_print_statistics (FILE *);
void symbol_table_insert (symbolS * symbolP);
valueT resolve_symbol_value (symbolS *);
void resolve_local_symbol_values (void);

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

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

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

extern void copy_symbol_attributes (symbolS *, symbolS *);

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

#ifdef BFD_ASSEMBLER
extern int S_IS_FUNCTION (symbolS *);
extern int S_IS_EXTERNAL (symbolS *);
extern int S_IS_WEAK (symbolS *);
extern int S_IS_COMMON (symbolS *);
extern int S_IS_DEFINED (symbolS *);
extern int S_FORCE_RELOC (symbolS *, int);
extern int S_IS_DEBUG (symbolS *);
extern int S_IS_LOCAL (symbolS *);
extern int S_IS_EXTERN (symbolS *);
extern int S_IS_STABD (symbolS *);
extern const char *S_GET_NAME (symbolS *);
extern segT S_GET_SEGMENT (symbolS *);
extern void S_SET_SEGMENT (symbolS *, segT);
extern void S_SET_EXTERNAL (symbolS *);
extern void S_SET_NAME (symbolS *, const char *);
extern void S_CLEAR_EXTERNAL (symbolS *);
extern void S_SET_WEAK (symbolS *);
extern void S_SET_THREAD_LOCAL (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 happened 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 (symbolS * symbolP);

#ifdef SYMBOLS_NEED_BACKPOINTERS

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

extern symbolS *symbol_previous (symbolS *);

#endif /* SYMBOLS_NEED_BACKPOINTERS */

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

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

extern symbolS *symbol_next (symbolS *);

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

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

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

#ifdef TC_SYMFIELD_TYPE
TC_SYMFIELD_TYPE *symbol_get_tc (symbolS *);
void symbol_set_tc (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,
be95a9c1	3	2002, 2003, 2004, 2005 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
74937d39 KH	50	char decode_local_label_name (char s);
	51	symbolS symbol_find (const char name);
	52	symbolS symbol_find_exact (const char name);
74937d39 KH	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 );
252b5132 RH	87
252b5132 RH	88	/* Get and set the values of symbols. These used to be macros. */
74937d39 KH	89	extern valueT S_GET_VALUE (symbolS *);
74937d39 KH	90	extern void S_SET_VALUE (symbolS *, valueT);
252b5132 RH	91
252b5132 RH	92	#ifdef BFD_ASSEMBLER
74937d39 KH	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_EXTERN (symbolS *);
	102	extern int S_IS_STABD (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 *);
977cdf5a	107	extern void S_SET_NAME (symbolS , const char );
74937d39 KH	108	extern void S_CLEAR_EXTERNAL (symbolS *);
	109	extern void S_SET_WEAK (symbolS *);
	110	extern void S_SET_THREAD_LOCAL (symbolS *);
252b5132 RH	111	#endif
252b5132 RH	112
49309057 ILT	113	#ifndef WORKING_DOT_WORD
	114	struct broken_word
	115	{
	116	/* Linked list -- one of these structures per ".word x-y+C"
	117	expression. */
	118	struct broken_word *next_broken_word;
	119	/* Segment and subsegment for broken word. */
	120	segT seg;
	121	subsegT subseg;
	122	/* Which frag is this broken word in? */
	123	fragS *frag;
	124	/* Where in the frag is it? */
	125	char *word_goes_here;
	126	/* Where to add the break. */
	127	fragS dispfrag; / where to add the break */
	128	/* Operands of expression. */
	129	symbolS *add;
	130	symbolS *sub;
	131	offsetT addnum;
	132
47eebc20	133	int added; /* nasty thing happened yet? */
49309057 ILT	134	/* 1: added and has a long-jump */
	135	/* 2: added but uses someone elses long-jump */
	136
	137	/* Pointer to broken_word with a similar long-jump. */
	138	struct broken_word *use_jump;
	139	};
	140	extern struct broken_word *broken_words;
	141	#endif /* ndef WORKING_DOT_WORD */
	142
	143	/*
	144	* Current means for getting from symbols to segments and vice verse.
	145	* This will change for infinite-segments support (e.g. COFF).
	146	*/
	147	extern const segT N_TYPE_seg[]; /* subseg.c */
	148
	149	#define SEGMENT_TO_SYMBOL_TYPE(seg) ( seg_N_TYPE [(int) (seg)] )
	150	extern const short seg_N_TYPE[];/* subseg.c */
	151
	152	#define N_REGISTER 30 /* Fake N_TYPE value for SEG_REGISTER */
	153
74937d39	154	void symbol_clear_list_pointers (symbolS * symbolP);
49309057 ILT	155
	156	#ifdef SYMBOLS_NEED_BACKPOINTERS
	157
74937d39 KH	158	void symbol_insert (symbolS * addme, symbolS * target,
	159	symbolS rootP, symbolS lastP);
	160	void symbol_remove (symbolS * symbolP, symbolS ** rootP,
	161	symbolS ** lastP);
49309057	162
74937d39	163	extern symbolS symbol_previous (symbolS );
49309057 ILT	164
	165	#endif /* SYMBOLS_NEED_BACKPOINTERS */
	166
74937d39 KH	167	void verify_symbol_chain (symbolS * rootP, symbolS * lastP);
	168	void verify_symbol_chain_2 (symbolS * symP);
	169
	170	void symbol_append (symbolS * addme, symbolS * target,
	171	symbolS rootP, symbolS lastP);
	172
	173	extern symbolS symbol_next (symbolS );
	174
	175	extern expressionS symbol_get_value_expression (symbolS );
	176	extern void symbol_set_value_expression (symbolS , const expressionS );
514d955d	177	extern offsetT symbol_X_add_number (symbolS );
74937d39 KH	178	extern void symbol_set_value_now (symbolS *);
	179	extern void symbol_set_frag (symbolS , fragS );
	180	extern fragS symbol_get_frag (symbolS );
	181	extern void symbol_mark_used (symbolS *);
	182	extern void symbol_clear_used (symbolS *);
	183	extern int symbol_used_p (symbolS *);
	184	extern void symbol_mark_used_in_reloc (symbolS *);
	185	extern void symbol_clear_used_in_reloc (symbolS *);
	186	extern int symbol_used_in_reloc_p (symbolS *);
	187	extern void symbol_mark_mri_common (symbolS *);
	188	extern void symbol_clear_mri_common (symbolS *);
	189	extern int symbol_mri_common_p (symbolS *);
	190	extern void symbol_mark_written (symbolS *);
	191	extern void symbol_clear_written (symbolS *);
	192	extern int symbol_written_p (symbolS *);
	193	extern void symbol_mark_resolved (symbolS *);
	194	extern int symbol_resolved_p (symbolS *);
	195	extern int symbol_section_p (symbolS *);
	196	extern int symbol_equated_p (symbolS *);
	197	extern int symbol_equated_reloc_p (symbolS *);
	198	extern int symbol_constant_p (symbolS *);
49309057 ILT	199
49309057 ILT	200	#ifdef BFD_ASSEMBLER
74937d39 KH	201	extern asymbol symbol_get_bfdsym (symbolS );
74937d39 KH	202	extern void symbol_set_bfdsym (symbolS , asymbol );
49309057 ILT	203	#endif
	204
	205	#ifdef OBJ_SYMFIELD_TYPE
74937d39 KH	206	OBJ_SYMFIELD_TYPE symbol_get_obj (symbolS );
74937d39 KH	207	void symbol_set_obj (symbolS , OBJ_SYMFIELD_TYPE );
49309057 ILT	208	#endif
	209
	210	#ifdef TC_SYMFIELD_TYPE
74937d39 KH	211	TC_SYMFIELD_TYPE symbol_get_tc (symbolS );
74937d39 KH	212	void symbol_set_tc (symbolS , TC_SYMFIELD_TYPE );
49309057	213	#endif