ia64-hpux patches from Steve Ellcey.
[binutils.git] / gas / cgen.c
blobe3cb1c83ae6715326e99ba76987d22558387471e
1 /* GAS interface for targets using CGEN: Cpu tools GENerator.
2 Copyright (C) 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
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 2, or (at your option)
9 any later version.
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.
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 Software
18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
20 #include <setjmp.h>
21 #include "ansidecl.h"
22 #include "libiberty.h"
23 #include "bfd.h"
24 #include "symcat.h"
25 #include "cgen-desc.h"
26 #include "as.h"
27 #include "subsegs.h"
28 #include "cgen.h"
30 /* Opcode table descriptor, must be set by md_begin. */
32 CGEN_CPU_DESC gas_cgen_cpu_desc;
34 /* Callback to insert a register into the symbol table.
35 A target may choose to let GAS parse the registers.
36 ??? Not currently used. */
38 void
39 cgen_asm_record_register (name, number)
40 char *name;
41 int number;
43 /* Use symbol_create here instead of symbol_new so we don't try to
44 output registers into the object file's symbol table. */
45 symbol_table_insert (symbol_create (name, reg_section,
46 number, &zero_address_frag));
49 /* We need to keep a list of fixups. We can't simply generate them as
50 we go, because that would require us to first create the frag, and
51 that would screw up references to ``.''.
53 This is used by cpu's with simple operands. It keeps knowledge of what
54 an `expressionS' is and what a `fixup' is out of CGEN which for the time
55 being is preferable.
57 OPINDEX is the index in the operand table.
58 OPINFO is something the caller chooses to help in reloc determination. */
60 struct fixup {
61 int opindex;
62 int opinfo;
63 expressionS exp;
66 static struct fixup fixups[GAS_CGEN_MAX_FIXUPS];
67 static int num_fixups;
69 /* Prepare to parse an instruction.
70 ??? May wish to make this static and delete calls in md_assemble. */
72 void
73 gas_cgen_init_parse ()
75 num_fixups = 0;
78 /* Queue a fixup. */
80 static void
81 queue_fixup (opindex, opinfo, expP)
82 int opindex;
83 int opinfo;
84 expressionS * expP;
86 /* We need to generate a fixup for this expression. */
87 if (num_fixups >= GAS_CGEN_MAX_FIXUPS)
88 as_fatal (_("too many fixups"));
89 fixups[num_fixups].exp = *expP;
90 fixups[num_fixups].opindex = opindex;
91 fixups[num_fixups].opinfo = opinfo;
92 ++ num_fixups;
95 /* The following three functions allow a backup of the fixup chain to be made,
96 and to have this backup be swapped with the current chain. This allows
97 certain ports, eg the m32r, to swap two instructions and swap their fixups
98 at the same time. */
99 /* ??? I think with cgen_asm_finish_insn (or something else) there is no
100 more need for this. */
102 static struct fixup saved_fixups[GAS_CGEN_MAX_FIXUPS];
103 static int saved_num_fixups;
105 void
106 gas_cgen_save_fixups ()
108 saved_num_fixups = num_fixups;
110 memcpy (saved_fixups, fixups, sizeof (fixups[0]) * num_fixups);
112 num_fixups = 0;
115 void
116 gas_cgen_restore_fixups ()
118 num_fixups = saved_num_fixups;
120 memcpy (fixups, saved_fixups, sizeof (fixups[0]) * num_fixups);
122 saved_num_fixups = 0;
125 void
126 gas_cgen_swap_fixups ()
128 int tmp;
129 struct fixup tmp_fixup;
131 if (num_fixups == 0)
133 gas_cgen_restore_fixups ();
135 else if (saved_num_fixups == 0)
137 gas_cgen_save_fixups ();
139 else
141 tmp = saved_num_fixups;
142 saved_num_fixups = num_fixups;
143 num_fixups = tmp;
145 for (tmp = GAS_CGEN_MAX_FIXUPS; tmp--;)
147 tmp_fixup = saved_fixups [tmp];
148 saved_fixups [tmp] = fixups [tmp];
149 fixups [tmp] = tmp_fixup;
154 /* Default routine to record a fixup.
155 This is a cover function to fix_new.
156 It exists because we record INSN with the fixup.
158 FRAG and WHERE are their respective arguments to fix_new_exp.
159 LENGTH is in bits.
160 OPINFO is something the caller chooses to help in reloc determination.
162 At this point we do not use a bfd_reloc_code_real_type for
163 operands residing in the insn, but instead just use the
164 operand index. This lets us easily handle fixups for any
165 operand type. We pick a BFD reloc type in md_apply_fix. */
167 fixS *
168 gas_cgen_record_fixup (frag, where, insn, length, operand, opinfo, symbol, offset)
169 fragS * frag;
170 int where;
171 const CGEN_INSN * insn;
172 int length;
173 const CGEN_OPERAND * operand;
174 int opinfo;
175 symbolS * symbol;
176 offsetT offset;
178 fixS *fixP;
180 /* It may seem strange to use operand->attrs and not insn->attrs here,
181 but it is the operand that has a pc relative relocation. */
183 fixP = fix_new (frag, where, length / 8, symbol, offset,
184 CGEN_OPERAND_ATTR_VALUE (operand, CGEN_OPERAND_PCREL_ADDR),
185 (bfd_reloc_code_real_type)
186 ((int) BFD_RELOC_UNUSED
187 + (int) operand->type));
188 fixP->fx_cgen.insn = insn;
189 fixP->fx_cgen.opinfo = opinfo;
191 return fixP;
194 /* Default routine to record a fixup given an expression.
195 This is a cover function to fix_new_exp.
196 It exists because we record INSN with the fixup.
198 FRAG and WHERE are their respective arguments to fix_new_exp.
199 LENGTH is in bits.
200 OPINFO is something the caller chooses to help in reloc determination.
202 At this point we do not use a bfd_reloc_code_real_type for
203 operands residing in the insn, but instead just use the
204 operand index. This lets us easily handle fixups for any
205 operand type. We pick a BFD reloc type in md_apply_fix. */
207 fixS *
208 gas_cgen_record_fixup_exp (frag, where, insn, length, operand, opinfo, exp)
209 fragS * frag;
210 int where;
211 const CGEN_INSN * insn;
212 int length;
213 const CGEN_OPERAND * operand;
214 int opinfo;
215 expressionS * exp;
217 fixS *fixP;
219 /* It may seem strange to use operand->attrs and not insn->attrs here,
220 but it is the operand that has a pc relative relocation. */
222 fixP = fix_new_exp (frag, where, length / 8, exp,
223 CGEN_OPERAND_ATTR_VALUE (operand, CGEN_OPERAND_PCREL_ADDR),
224 (bfd_reloc_code_real_type)
225 ((int) BFD_RELOC_UNUSED
226 + (int) operand->type));
227 fixP->fx_cgen.insn = insn;
228 fixP->fx_cgen.opinfo = opinfo;
230 return fixP;
233 /* Used for communication between the next two procedures. */
234 static jmp_buf expr_jmp_buf;
235 static int expr_jmp_buf_p;
237 /* Callback for cgen interface. Parse the expression at *STRP.
238 The result is an error message or NULL for success (in which case
239 *STRP is advanced past the parsed text).
240 WANT is an indication of what the caller is looking for.
241 If WANT == CGEN_ASM_PARSE_INIT the caller is beginning to try to match
242 a table entry with the insn, reset the queued fixups counter.
243 An enum cgen_parse_operand_result is stored in RESULTP.
244 OPINDEX is the operand's table entry index.
245 OPINFO is something the caller chooses to help in reloc determination.
246 The resulting value is stored in VALUEP. */
248 const char *
249 gas_cgen_parse_operand (cd, want, strP, opindex, opinfo, resultP, valueP)
250 CGEN_CPU_DESC cd ATTRIBUTE_UNUSED;
251 enum cgen_parse_operand_type want;
252 const char **strP;
253 int opindex;
254 int opinfo;
255 enum cgen_parse_operand_result *resultP;
256 bfd_vma *valueP;
258 #ifdef __STDC__
259 /* These are volatile to survive the setjmp. */
260 char * volatile hold;
261 enum cgen_parse_operand_result * volatile resultP_1;
262 #else
263 static char *hold;
264 static enum cgen_parse_operand_result *resultP_1;
265 #endif
266 const char *errmsg = NULL;
267 expressionS exp;
269 if (want == CGEN_PARSE_OPERAND_INIT)
271 gas_cgen_init_parse ();
272 return NULL;
275 resultP_1 = resultP;
276 hold = input_line_pointer;
277 input_line_pointer = (char *) *strP;
279 /* We rely on md_operand to longjmp back to us.
280 This is done via gas_cgen_md_operand. */
281 if (setjmp (expr_jmp_buf) != 0)
283 expr_jmp_buf_p = 0;
284 input_line_pointer = (char *) hold;
285 *resultP_1 = CGEN_PARSE_OPERAND_RESULT_ERROR;
286 return "illegal operand";
289 expr_jmp_buf_p = 1;
290 expression (&exp);
291 expr_jmp_buf_p = 0;
293 *strP = input_line_pointer;
294 input_line_pointer = hold;
296 /* FIXME: Need to check `want'. */
298 switch (exp.X_op)
300 case O_illegal:
301 errmsg = _("illegal operand");
302 *resultP = CGEN_PARSE_OPERAND_RESULT_ERROR;
303 break;
304 case O_absent:
305 errmsg = _("missing operand");
306 *resultP = CGEN_PARSE_OPERAND_RESULT_ERROR;
307 break;
308 case O_constant:
309 *valueP = exp.X_add_number;
310 *resultP = CGEN_PARSE_OPERAND_RESULT_NUMBER;
311 break;
312 case O_register:
313 *valueP = exp.X_add_number;
314 *resultP = CGEN_PARSE_OPERAND_RESULT_REGISTER;
315 break;
316 default:
317 queue_fixup (opindex, opinfo, &exp);
318 *valueP = 0;
319 *resultP = CGEN_PARSE_OPERAND_RESULT_QUEUED;
320 break;
323 return errmsg;
326 /* md_operand handler to catch unrecognized expressions and halt the
327 parsing process so the next entry can be tried.
329 ??? This could be done differently by adding code to `expression'. */
331 void
332 gas_cgen_md_operand (expressionP)
333 expressionS *expressionP ATTRIBUTE_UNUSED;
335 /* Don't longjmp if we're not called from within cgen_parse_operand(). */
336 if (expr_jmp_buf_p)
337 longjmp (expr_jmp_buf, 1);
340 /* Finish assembling instruction INSN.
341 BUF contains what we've built up so far.
342 LENGTH is the size of the insn in bits.
343 RELAX_P is non-zero if relaxable insns should be emitted as such.
344 Otherwise they're emitted in non-relaxable forms.
345 The "result" is stored in RESULT if non-NULL. */
347 void
348 gas_cgen_finish_insn (insn, buf, length, relax_p, result)
349 const CGEN_INSN *insn;
350 CGEN_INSN_BYTES_PTR buf;
351 unsigned int length;
352 int relax_p;
353 finished_insnS *result;
355 int i;
356 int relax_operand;
357 char *f;
358 unsigned int byte_len = length / 8;
360 /* ??? Target foo issues various warnings here, so one might want to provide
361 a hook here. However, our caller is defined in tc-foo.c so there
362 shouldn't be a need for a hook. */
364 /* Write out the instruction.
365 It is important to fetch enough space in one call to `frag_more'.
366 We use (f - frag_now->fr_literal) to compute where we are and we
367 don't want frag_now to change between calls.
369 Relaxable instructions: We need to ensure we allocate enough
370 space for the largest insn. */
372 if (CGEN_INSN_ATTR_VALUE (insn, CGEN_INSN_RELAX))
373 /* These currently shouldn't get here. */
374 abort ();
376 /* Is there a relaxable insn with the relaxable operand needing a fixup? */
378 relax_operand = -1;
379 if (relax_p && CGEN_INSN_ATTR_VALUE (insn, CGEN_INSN_RELAXABLE))
381 /* Scan the fixups for the operand affected by relaxing
382 (i.e. the branch address). */
384 for (i = 0; i < num_fixups; ++i)
386 if (CGEN_OPERAND_ATTR_VALUE (cgen_operand_lookup_by_num (gas_cgen_cpu_desc, fixups[i].opindex),
387 CGEN_OPERAND_RELAX))
389 relax_operand = i;
390 break;
395 if (relax_operand != -1)
397 int max_len;
398 fragS *old_frag;
400 #ifdef TC_CGEN_MAX_RELAX
401 max_len = TC_CGEN_MAX_RELAX (insn, byte_len);
402 #else
403 max_len = CGEN_MAX_INSN_SIZE;
404 #endif
405 /* Ensure variable part and fixed part are in same fragment. */
406 /* FIXME: Having to do this seems like a hack. */
407 frag_grow (max_len);
409 /* Allocate space for the fixed part. */
410 f = frag_more (byte_len);
412 /* Create a relaxable fragment for this instruction. */
413 old_frag = frag_now;
415 frag_var (rs_machine_dependent,
416 max_len - byte_len /* max chars */,
417 0 /* variable part already allocated */,
418 /* FIXME: When we machine generate the relax table,
419 machine generate a macro to compute subtype. */
420 1 /* subtype */,
421 fixups[relax_operand].exp.X_add_symbol,
422 fixups[relax_operand].exp.X_add_number,
425 /* Record the operand number with the fragment so md_convert_frag
426 can use gas_cgen_md_record_fixup to record the appropriate reloc. */
427 old_frag->fr_cgen.insn = insn;
428 old_frag->fr_cgen.opindex = fixups[relax_operand].opindex;
429 old_frag->fr_cgen.opinfo = fixups[relax_operand].opinfo;
430 if (result)
431 result->frag = old_frag;
433 else
435 f = frag_more (byte_len);
436 if (result)
437 result->frag = frag_now;
440 /* If we're recording insns as numbers (rather than a string of bytes),
441 target byte order handling is deferred until now. */
442 #if CGEN_INT_INSN_P
443 cgen_put_insn_value (gas_cgen_cpu_desc, f, length, *buf);
444 #else
445 memcpy (f, buf, byte_len);
446 #endif
448 /* Create any fixups. */
449 for (i = 0; i < num_fixups; ++i)
451 fixS *fixP;
452 const CGEN_OPERAND *operand =
453 cgen_operand_lookup_by_num (gas_cgen_cpu_desc, fixups[i].opindex);
455 /* Don't create fixups for these. That's done during relaxation.
456 We don't need to test for CGEN_INSN_RELAX as they can't get here
457 (see above). */
458 if (relax_p
459 && CGEN_INSN_ATTR_VALUE (insn, CGEN_INSN_RELAXABLE)
460 && CGEN_OPERAND_ATTR_VALUE (operand, CGEN_OPERAND_RELAX))
461 continue;
463 #ifndef md_cgen_record_fixup_exp
464 #define md_cgen_record_fixup_exp gas_cgen_record_fixup_exp
465 #endif
467 fixP = md_cgen_record_fixup_exp (frag_now, f - frag_now->fr_literal,
468 insn, length, operand,
469 fixups[i].opinfo,
470 &fixups[i].exp);
471 if (result)
472 result->fixups[i] = fixP;
475 if (result)
477 result->num_fixups = num_fixups;
478 result->addr = f;
482 /* Apply a fixup to the object code. This is called for all the
483 fixups we generated by the call to fix_new_exp, above. In the call
484 above we used a reloc code which was the largest legal reloc code
485 plus the operand index. Here we undo that to recover the operand
486 index. At this point all symbol values should be fully resolved,
487 and we attempt to completely resolve the reloc. If we can not do
488 that, we determine the correct reloc code and put it back in the fixup. */
490 /* FIXME: This function handles some of the fixups and bfd_install_relocation
491 handles the rest. bfd_install_relocation (or some other bfd function)
492 should handle them all. */
495 gas_cgen_md_apply_fix3 (fixP, valueP, seg)
496 fixS * fixP;
497 valueT * valueP;
498 segT seg ATTRIBUTE_UNUSED;
500 char *where = fixP->fx_frag->fr_literal + fixP->fx_where;
501 valueT value;
502 /* Canonical name, since used a lot. */
503 CGEN_CPU_DESC cd = gas_cgen_cpu_desc;
505 /* FIXME FIXME FIXME: The value we are passed in *valuep includes
506 the symbol values. Since we are using BFD_ASSEMBLER, if we are
507 doing this relocation the code in write.c is going to call
508 bfd_install_relocation, which is also going to use the symbol
509 value. That means that if the reloc is fully resolved we want to
510 use *valuep since bfd_install_relocation is not being used.
511 However, if the reloc is not fully resolved we do not want to use
512 *valuep, and must use fx_offset instead. However, if the reloc
513 is PC relative, we do want to use *valuep since it includes the
514 result of md_pcrel_from. This is confusing. */
516 if (fixP->fx_addsy == (symbolS *) NULL)
518 value = *valueP;
519 fixP->fx_done = 1;
521 else if (fixP->fx_pcrel)
522 value = *valueP;
523 else
525 value = fixP->fx_offset;
526 if (fixP->fx_subsy != (symbolS *) NULL)
528 if (S_GET_SEGMENT (fixP->fx_subsy) == absolute_section)
529 value -= S_GET_VALUE (fixP->fx_subsy);
530 else
532 /* We don't actually support subtracting a symbol. */
533 as_bad_where (fixP->fx_file, fixP->fx_line,
534 _("expression too complex"));
539 if ((int) fixP->fx_r_type >= (int) BFD_RELOC_UNUSED)
541 int opindex = (int) fixP->fx_r_type - (int) BFD_RELOC_UNUSED;
542 const CGEN_OPERAND *operand = cgen_operand_lookup_by_num (cd, opindex);
543 const char *errmsg;
544 bfd_reloc_code_real_type reloc_type;
545 CGEN_FIELDS *fields = alloca (CGEN_CPU_SIZEOF_FIELDS (cd));
546 const CGEN_INSN *insn = fixP->fx_cgen.insn;
548 /* If the reloc has been fully resolved finish the operand here. */
549 /* FIXME: This duplicates the capabilities of code in BFD. */
550 if (fixP->fx_done
551 /* FIXME: If partial_inplace isn't set bfd_install_relocation won't
552 finish the job. Testing for pcrel is a temporary hack. */
553 || fixP->fx_pcrel)
555 CGEN_CPU_SET_FIELDS_BITSIZE (cd) (fields, CGEN_INSN_BITSIZE (insn));
556 CGEN_CPU_SET_VMA_OPERAND (cd) (cd, opindex, fields, (bfd_vma) value);
558 #if CGEN_INT_INSN_P
560 CGEN_INSN_INT insn_value =
561 cgen_get_insn_value (cd, where, CGEN_INSN_BITSIZE (insn));
563 /* ??? 0 is passed for `pc'. */
564 errmsg = CGEN_CPU_INSERT_OPERAND (cd) (cd, opindex, fields,
565 &insn_value, (bfd_vma) 0);
566 cgen_put_insn_value (cd, where, CGEN_INSN_BITSIZE (insn),
567 insn_value);
569 #else
570 /* ??? 0 is passed for `pc'. */
571 errmsg = CGEN_CPU_INSERT_OPERAND (cd) (cd, opindex, fields, where,
572 (bfd_vma) 0);
573 #endif
574 if (errmsg)
575 as_bad_where (fixP->fx_file, fixP->fx_line, "%s", errmsg);
578 if (fixP->fx_done)
579 return 1;
581 /* The operand isn't fully resolved. Determine a BFD reloc value
582 based on the operand information and leave it to
583 bfd_install_relocation. Note that this doesn't work when
584 partial_inplace == false. */
586 reloc_type = md_cgen_lookup_reloc (insn, operand, fixP);
587 if (reloc_type != BFD_RELOC_NONE)
589 fixP->fx_r_type = reloc_type;
591 else
593 as_bad_where (fixP->fx_file, fixP->fx_line,
594 _("unresolved expression that must be resolved"));
595 fixP->fx_done = 1;
596 return 1;
599 else if (fixP->fx_done)
601 /* We're finished with this fixup. Install it because
602 bfd_install_relocation won't be called to do it. */
603 switch (fixP->fx_r_type)
605 case BFD_RELOC_8:
606 md_number_to_chars (where, value, 1);
607 break;
608 case BFD_RELOC_16:
609 md_number_to_chars (where, value, 2);
610 break;
611 case BFD_RELOC_32:
612 md_number_to_chars (where, value, 4);
613 break;
614 /* FIXME: later add support for 64 bits. */
615 default:
616 as_bad_where (fixP->fx_file, fixP->fx_line,
617 _("internal error: can't install fix for reloc type %d (`%s')"),
618 fixP->fx_r_type, bfd_get_reloc_code_name (fixP->fx_r_type));
619 break;
622 else
624 /* bfd_install_relocation will be called to finish things up. */
627 /* Tuck `value' away for use by tc_gen_reloc.
628 See the comment describing fx_addnumber in write.h.
629 This field is misnamed (or misused :-). */
630 fixP->fx_addnumber = value;
632 return 1;
635 /* Translate internal representation of relocation info to BFD target format.
637 FIXME: To what extent can we get all relevant targets to use this? */
639 arelent *
640 gas_cgen_tc_gen_reloc (section, fixP)
641 asection * section ATTRIBUTE_UNUSED;
642 fixS * fixP;
644 arelent *reloc;
646 reloc = (arelent *) xmalloc (sizeof (arelent));
648 reloc->howto = bfd_reloc_type_lookup (stdoutput, fixP->fx_r_type);
649 if (reloc->howto == (reloc_howto_type *) NULL)
651 as_bad_where (fixP->fx_file, fixP->fx_line,
652 _("internal error: can't export reloc type %d (`%s')"),
653 fixP->fx_r_type, bfd_get_reloc_code_name (fixP->fx_r_type));
654 return NULL;
657 assert (!fixP->fx_pcrel == !reloc->howto->pc_relative);
659 reloc->sym_ptr_ptr = (asymbol **) xmalloc (sizeof (asymbol *));
660 *reloc->sym_ptr_ptr = symbol_get_bfdsym (fixP->fx_addsy);
662 /* Use fx_offset for these cases. */
663 if (fixP->fx_r_type == BFD_RELOC_VTABLE_ENTRY
664 || fixP->fx_r_type == BFD_RELOC_VTABLE_INHERIT)
665 reloc->addend = fixP->fx_offset;
666 else
667 reloc->addend = fixP->fx_addnumber;
669 reloc->address = fixP->fx_frag->fr_address + fixP->fx_where;
670 return reloc;