xref: /netbsd-src/external/gpl3/binutils/dist/gas/cgen.h (revision 4d5abbe83f525258eb479e5fca29f25cb943f379)
1 /* GAS cgen support.
2    Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2005, 2007, 2011
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 3, or (at your option)
10    any later version.
11 
12    GAS is distributed in the hope that it will be useful, but WITHOUT
13    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
15    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, 51 Franklin Street - Fifth Floor, Boston, MA
20    02110-1301, USA.  */
21 
22 #ifndef GAS_CGEN_H
23 #define GAS_CGEN_H
24 
25 /* Opcode table handle.  */
26 extern CGEN_CPU_DESC gas_cgen_cpu_desc;
27 
28 /* Maximum number of fixups in an insn.
29    If you need to change this, allow target to override and do so there.  */
30 #ifndef GAS_CGEN_MAX_FIXUPS
31 #define GAS_CGEN_MAX_FIXUPS 3
32 #endif
33 
34 /* Struct defining result of gas_cgen_finish_insn.  */
35 typedef struct
36 {
37   /* Frag containing the insn */
38   fragS * frag;
39   /* Address of insn in frag.  */
40   char * addr;
41   /* Number of fixups this insn has.  */
42   int num_fixups;
43   /* Array of fixups.  */
44   fixS * fixups[GAS_CGEN_MAX_FIXUPS];
45 } finished_insnS;
46 
47 /* Callback for operand parsing.
48    The result is an error message or NULL for success.
49    The parsed value is stored in the bfd_vma *.  */
50 extern const char * gas_cgen_parse_operand
51      (CGEN_CPU_DESC, enum cgen_parse_operand_type,
52       const char **, int, int, enum cgen_parse_operand_result *,
53       bfd_vma *);
54 
55 /* Call this from md_assemble to initialize the assembler callback.  */
56 extern void gas_cgen_init_parse (void);
57 
58 /* Routines and macros for saving fixup chains.  */
59 extern void gas_cgen_save_fixups (int);
60 extern void gas_cgen_restore_fixups (int);
61 extern void gas_cgen_swap_fixups (int);
62 extern void gas_cgen_initialize_saved_fixups_array (void);
63 #define MAX_SAVED_FIXUP_CHAINS 50
64 
65 /* Add a register to the assembler's hash table.
66    This makes lets GAS parse registers for us.
67    ??? This isn't currently used, but it could be in the future.  */
68 extern void cgen_asm_record_register (char *, int);
69 
70 /* After CGEN_SYM (assemble_insn) is done, this is called to
71    output the insn and record any fixups.  */
72 extern void gas_cgen_finish_insn (const CGEN_INSN *,
73 				  CGEN_INSN_BYTES_PTR, unsigned int,
74 				  int, finished_insnS *);
75 
76 /* Record a fixup.  */
77 extern fixS * gas_cgen_record_fixup (fragS *, int, const CGEN_INSN *,
78 				     int, const CGEN_OPERAND *, int,
79 				     symbolS *, offsetT);
80 extern fixS * gas_cgen_record_fixup_exp (fragS *, int, const CGEN_INSN *,
81 					 int, const CGEN_OPERAND *, int,
82 					 expressionS *);
83 
84 extern bfd_reloc_code_real_type gas_cgen_pcrel_r_type (bfd_reloc_code_real_type);
85 
86 /* md_apply_fix handler.  */
87 extern void gas_cgen_md_apply_fix (fixS *, valueT *, segT);
88 
89 /* tc_gen_reloc handler.  */
90 extern arelent *gas_cgen_tc_gen_reloc (asection *, fixS *);
91 
92 /* Target supplied routine to lookup a reloc.  */
93 extern bfd_reloc_code_real_type
94 md_cgen_lookup_reloc (const CGEN_INSN *, const CGEN_OPERAND *, fixS *);
95 
96 /* Optional target supplied routine to record a fixup for an expression.  */
97 extern fixS *
98 md_cgen_record_fixup_exp (fragS *, int, const CGEN_INSN *, int,
99 			  const CGEN_OPERAND *, int, expressionS *);
100 
101 extern void gas_cgen_md_operand (expressionS *);
102 
103 /* Perform any cgen specific initialisation for gas.  */
104 extern void gas_cgen_begin (void);
105 
106 #endif /* GAS_CGEN_H */
107