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

/* frags.h - Header file for the frag concept.
   Copyright (C) 1987, 92, 93, 94, 95, 97, 1998
   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.  */

#ifndef FRAGS_H
#define FRAGS_H

#ifdef ANSI_PROTOTYPES
struct obstack;
#endif

/*
 * A code fragment (frag) is some known number of chars, followed by some
 * unknown number of chars. Typically the unknown number of chars is an
 * instruction address whose size is yet unknown. We always know the greatest
 * possible size the unknown number of chars may become, and reserve that
 * much room at the end of the frag.
 * Once created, frags do not change address during assembly.
 * We chain the frags in (a) forward-linked list(s). The object-file address
 * of the 1st char of a frag is generally not known until after relax().
 * Many things at assembly time describe an address by {object-file-address
 * of a particular frag}+offset.

 BUG: it may be smarter to have a single pointer off to various different
 notes for different frag kinds. See how code pans
 */

struct frag
{
  /* Object file address. */
  addressT fr_address;
  /* Chain forward; ascending address order.  Rooted in frch_root. */
  struct frag *fr_next;

  /* (Fixed) number of chars we know we have.  May be 0. */
  offsetT fr_fix;
  /* (Variable) number of chars after above.  May be 0. */
  offsetT fr_var;
  /* For variable-length tail. */
  struct symbol *fr_symbol;
  /* For variable-length tail. */
  offsetT fr_offset;
  /* Points to opcode low addr byte, for relaxation.  */
  char *fr_opcode;

#ifndef NO_LISTING
  struct list_info_struct *line;
#endif

  /* What state is my tail in? */
  relax_stateT fr_type;
  relax_substateT fr_subtype;

#ifdef USING_CGEN
  /* Don't include this unless using CGEN to keep frag size down.  */
  struct {
    /* CGEN_INSN entry for this instruction.  */
    const struct cgen_insn *insn;
    /* Index into operand table.  */
    int opindex;
    /* Target specific data, usually reloc number.  */
    int opinfo;
  } fr_cgen;
#endif

#ifdef TC_FRAG_TYPE
  TC_FRAG_TYPE tc_frag_data;
#endif

  /* Where the frag was created, or where it became a variant frag.  */
  char *fr_file;
  unsigned int fr_line;

  /* Data begins here.  */
  char fr_literal[1];
};

#define SIZEOF_STRUCT_FRAG \
((char *)zero_address_frag.fr_literal-(char *)&zero_address_frag)
/* We want to say fr_literal[0] above. */

/* Current frag we are building.  This frag is incomplete.  It is,
   however, included in frchain_now.  The fr_fix field is bogus;
   instead, use frag_now_fix ().  */
COMMON fragS *frag_now;
extern addressT frag_now_fix PARAMS ((void));

/* For foreign-segment symbol fixups. */
COMMON fragS zero_address_frag;
/* For local common (N_BSS segment) fixups. */
COMMON fragS bss_address_frag;

#if 0
/*
 * A macro to speed up appending exactly 1 char
 * to current frag.
 */
/* JF changed < 1 to <= 1 to avoid a race conditon */
#define FRAG_APPEND_1_CHAR(datum)	\
{					\
  if (obstack_room( &frags ) <= 1) {\
    frag_wane (frag_now);	\
    frag_new (0);		\
  }				\
  obstack_1grow( &frags, datum );	\
}
#else
extern void frag_append_1_char PARAMS ((int));
#define FRAG_APPEND_1_CHAR(X) frag_append_1_char (X)
#endif


void frag_init PARAMS ((void));
fragS *frag_alloc PARAMS ((struct obstack *));
void frag_grow PARAMS ((unsigned int nchars));
char *frag_more PARAMS ((int nchars));
void frag_align PARAMS ((int alignment, int fill_character, int max));
void frag_align_pattern PARAMS ((int alignment,
				 const char *fill_pattern,
				 int n_fill,
				 int max));
void frag_new PARAMS ((int old_frags_var_max_size));
void frag_wane PARAMS ((fragS * fragP));

char *frag_variant PARAMS ((relax_stateT type,
			    int max_chars,
			    int var,
			    relax_substateT subtype,
			    symbolS * symbol,
			    offsetT offset,
			    char *opcode));

char *frag_var PARAMS ((relax_stateT type,
			int max_chars,
			int var,
			relax_substateT subtype,
			symbolS * symbol,
			offsetT offset,
			char *opcode));

#endif /* FRAGS_H */
Commit	Line	Data
252b5132 RH	1	/* frags.h - Header file for the frag concept.
	2	Copyright (C) 1987, 92, 93, 94, 95, 97, 1998
	3	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	#ifndef FRAGS_H
	23	#define FRAGS_H
	24
	25	#ifdef ANSI_PROTOTYPES
	26	struct obstack;
	27	#endif
	28
	29	/*
	30	* A code fragment (frag) is some known number of chars, followed by some
	31	* unknown number of chars. Typically the unknown number of chars is an
	32	* instruction address whose size is yet unknown. We always know the greatest
	33	* possible size the unknown number of chars may become, and reserve that
	34	* much room at the end of the frag.
	35	* Once created, frags do not change address during assembly.
	36	* We chain the frags in (a) forward-linked list(s). The object-file address
	37	* of the 1st char of a frag is generally not known until after relax().
	38	* Many things at assembly time describe an address by {object-file-address
	39	* of a particular frag}+offset.
	40
	41	BUG: it may be smarter to have a single pointer off to various different
	42	notes for different frag kinds. See how code pans
	43	*/
	44
	45	struct frag
	46	{
	47	/* Object file address. */
	48	addressT fr_address;
	49	/* Chain forward; ascending address order. Rooted in frch_root. */
	50	struct frag *fr_next;
	51
	52	/* (Fixed) number of chars we know we have. May be 0. */
	53	offsetT fr_fix;
	54	/* (Variable) number of chars after above. May be 0. */
	55	offsetT fr_var;
	56	/* For variable-length tail. */
	57	struct symbol *fr_symbol;
	58	/* For variable-length tail. */
	59	offsetT fr_offset;
	60	/* Points to opcode low addr byte, for relaxation. */
	61	char *fr_opcode;
	62
	63	#ifndef NO_LISTING
	64	struct list_info_struct *line;
65	#endif
66
67	/* What state is my tail in? */
68	relax_stateT fr_type;
69	relax_substateT fr_subtype;
70
71	#ifdef USING_CGEN
72	/* Don't include this unless using CGEN to keep frag size down. */
73	struct {
74	/* CGEN_INSN entry for this instruction. */
75	const struct cgen_insn *insn;
76	/* Index into operand table. */
77	int opindex;
78	/* Target specific data, usually reloc number. */
79	int opinfo;
80	} fr_cgen;
81	#endif
82
83	#ifdef TC_FRAG_TYPE
84	TC_FRAG_TYPE tc_frag_data;
85	#endif
86
87	/* Where the frag was created, or where it became a variant frag. */
88	char *fr_file;
89	unsigned int fr_line;
90
91	/* Data begins here. */
92	char fr_literal[1];
93	};
94
95	#define SIZEOF_STRUCT_FRAG \
96	((char )zero_address_frag.fr_literal-(char )&zero_address_frag)
97	/* We want to say fr_literal[0] above. */
98
99	/* Current frag we are building. This frag is incomplete. It is,
100	however, included in frchain_now. The fr_fix field is bogus;
101	instead, use frag_now_fix (). */
102	COMMON fragS *frag_now;
103	extern addressT frag_now_fix PARAMS ((void));
104
105	/* For foreign-segment symbol fixups. */
106	COMMON fragS zero_address_frag;
107	/* For local common (N_BSS segment) fixups. */
108	COMMON fragS bss_address_frag;
109
110	#if 0
111	/*
112	* A macro to speed up appending exactly 1 char
113	* to current frag.
114	*/
115	/* JF changed < 1 to <= 1 to avoid a race conditon */
116	#define FRAG_APPEND_1_CHAR(datum) \
117	{ \
118	if (obstack_room( &frags ) <= 1) {\
119	frag_wane (frag_now); \
120	frag_new (0); \
121	} \
122	obstack_1grow( &frags, datum ); \
123	}
124	#else
125	extern void frag_append_1_char PARAMS ((int));
126	#define FRAG_APPEND_1_CHAR(X) frag_append_1_char (X)
127	#endif
128
129
130	void frag_init PARAMS ((void));
131	fragS frag_alloc PARAMS ((struct obstack ));
132	void frag_grow PARAMS ((unsigned int nchars));
133	char *frag_more PARAMS ((int nchars));
134	void frag_align PARAMS ((int alignment, int fill_character, int max));
135	void frag_align_pattern PARAMS ((int alignment,
136	const char *fill_pattern,
137	int n_fill,
138	int max));
139	void frag_new PARAMS ((int old_frags_var_max_size));
140	void frag_wane PARAMS ((fragS * fragP));
141
142	char *frag_variant PARAMS ((relax_stateT type,
143	int max_chars,
144	int var,
145	relax_substateT subtype,
146	symbolS * symbol,
147	offsetT offset,
148	char *opcode));
149
150	char *frag_var PARAMS ((relax_stateT type,
151	int max_chars,
152	int var,
153	relax_substateT subtype,
154	symbolS * symbol,
155	offsetT offset,
156	char *opcode));
157
158	#endif /* FRAGS_H */