Coverage Report

Created: 2026-07-25 10:20

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/binutils-gdb/opcodes/mmix-dis.c
Line
Count
Source
1
/* mmix-dis.c -- Disassemble MMIX instructions.
2
   Copyright (C) 2000-2026 Free Software Foundation, Inc.
3
   Written by Hans-Peter Nilsson (hp@bitrange.com)
4
5
   This file is part of the GNU opcodes library.
6
7
   This library 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
   It 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 this file; see the file COPYING.  If not, write to the Free
19
   Software Foundation, 51 Franklin Street - Fifth Floor, Boston,
20
   MA 02110-1301, USA.  */
21
22
#include "sysdep.h"
23
#include <stdio.h>
24
#include "opcode/mmix.h"
25
#include "disassemble.h"
26
#include "libiberty.h"
27
#include "bfd.h"
28
#include "opintl.h"
29
30
#define BAD_CASE(x)           \
31
0
  do                \
32
0
   {               \
33
0
     opcodes_error_handler (_("bad case %d (%s) in %s:%d"),  \
34
0
          x, #x, __FILE__, __LINE__);    \
35
0
     abort ();              \
36
0
   }                \
37
0
 while (0)
38
39
#define FATAL_DEBUG           \
40
0
 do                \
41
0
   {               \
42
0
     opcodes_error_handler (_("internal: non-debugged code " \
43
0
            "(test-case missing): %s:%d"),  \
44
0
          __FILE__, __LINE__);    \
45
0
     abort ();              \
46
0
   }                \
47
0
 while (0)
48
49
#define ROUND_MODE(n)         \
50
1.65k
 ((n) == 1 ? "ROUND_OFF" : (n) == 2 ? "ROUND_UP" :  \
51
1.28k
  (n) == 3 ? "ROUND_DOWN" : (n) == 4 ? "ROUND_NEAR" :  \
52
442
  _("(unknown)"))
53
54
65.6k
#define INSN_IMMEDIATE_BIT (IMM_OFFSET_BIT << 24)
55
14.5k
#define INSN_BACKWARD_OFFSET_BIT (1 << 24)
56
57
316k
#define MAX_REG_NAME_LEN       256
58
1.04k
#define MAX_SPEC_REG_NAME_LEN  32
59
struct mmix_dis_info
60
 {
61
   const char *reg_name[MAX_REG_NAME_LEN];
62
   const char *spec_reg_name[MAX_SPEC_REG_NAME_LEN];
63
64
   /* Waste a little memory so we don't have to allocate each separately.
65
      We could have an array with static contents for these, but on the
66
      other hand, we don't have to.  */
67
   char basic_reg_name[MAX_REG_NAME_LEN][sizeof ("$255")];
68
 };
69
70
/* Initialize a target-specific array in INFO.  */
71
72
static bool
73
initialize_mmix_dis_info (struct disassemble_info *info)
74
350
{
75
350
  struct mmix_dis_info *minfop = malloc (sizeof (struct mmix_dis_info));
76
350
  long i;
77
78
350
  if (minfop == NULL)
79
0
    return false;
80
81
350
  memset (minfop, 0, sizeof (*minfop));
82
83
  /* Initialize register names from register symbols.  If there's no
84
     register section, then there are no register symbols.  */
85
350
  if ((info->section != NULL && info->section->owner != NULL)
86
266
      || (info->symbols != NULL
87
0
    && info->symbols[0] != NULL
88
0
    && bfd_asymbol_bfd (info->symbols[0]) != NULL))
89
84
    {
90
84
      bfd *abfd = info->section && info->section->owner != NULL
91
84
  ? info->section->owner
92
84
  : bfd_asymbol_bfd (info->symbols[0]);
93
84
      asection *reg_section = bfd_get_section_by_name (abfd, "*REG*");
94
95
84
      if (reg_section != NULL)
96
39
  {
97
    /* The returned symcount *does* include the ending NULL.  */
98
39
    long symsize = bfd_get_symtab_upper_bound (abfd);
99
39
    asymbol **syms = malloc (symsize);
100
39
    long nsyms;
101
102
39
    if (syms == NULL)
103
0
      {
104
0
        FATAL_DEBUG;
105
0
        free (minfop);
106
0
        return false;
107
0
      }
108
39
    nsyms = bfd_canonicalize_symtab (abfd, syms);
109
110
    /* We use the first name for a register.  If this is MMO, then
111
       it's the name with the first sequence number, presumably the
112
       first in the source.  */
113
1.91k
    for (i = 0; i < nsyms && syms[i] != NULL; i++)
114
1.87k
      {
115
1.87k
        if (syms[i]->section == reg_section
116
394
      && syms[i]->value < MAX_REG_NAME_LEN
117
394
      && minfop->reg_name[syms[i]->value] == NULL)
118
83
    minfop->reg_name[syms[i]->value] = syms[i]->name;
119
1.87k
      }
120
39
    free (syms);
121
39
  }
122
84
    }
123
124
  /* Fill in the rest with the canonical names.  */
125
89.9k
  for (i = 0; i < MAX_REG_NAME_LEN; i++)
126
89.6k
    if (minfop->reg_name[i] == NULL)
127
89.5k
      {
128
89.5k
  sprintf (minfop->basic_reg_name[i], "$%ld", i);
129
89.5k
  minfop->reg_name[i] = minfop->basic_reg_name[i];
130
89.5k
      }
131
132
  /* We assume it's actually a one-to-one mapping of number-to-name.  */
133
11.5k
  for (i = 0; mmix_spec_regs[i].name != NULL; i++)
134
11.2k
    minfop->spec_reg_name[mmix_spec_regs[i].number] = mmix_spec_regs[i].name;
135
136
350
  info->private_data = (void *) minfop;
137
350
  return true;
138
350
}
139
140
/* A table indexed by the first byte is constructed as we disassemble each
141
   tetrabyte.  The contents is a pointer into mmix_insns reflecting the
142
   first found entry with matching match-bits and lose-bits.  Further
143
   entries are considered one after one until the operand constraints
144
   match or the match-bits and lose-bits do not match.  Normally a
145
   "further entry" will just show that there was no other match.  */
146
147
static const struct mmix_opcode *
148
get_opcode (unsigned long insn)
149
172k
{
150
172k
  static const struct mmix_opcode **opcodes = NULL;
151
172k
  const struct mmix_opcode *opcodep = mmix_opcodes;
152
172k
  unsigned int opcode_part = (insn >> 24) & 255;
153
154
172k
  if (opcodes == NULL)
155
2
    opcodes = xcalloc (256, sizeof (struct mmix_opcode *));
156
157
172k
  opcodep = opcodes[opcode_part];
158
172k
  if (opcodep == NULL
159
40.6k
      || (opcodep->match & insn) != opcodep->match
160
40.6k
      || (opcodep->lose & insn) != 0)
161
132k
    {
162
      /* Search through the table.  */
163
9.95M
      for (opcodep = mmix_opcodes; opcodep->name != NULL; opcodep++)
164
9.94M
  {
165
    /* FIXME: Break out this into an initialization function.  */
166
9.94M
    if ((opcodep->match & (opcode_part << 24)) == opcode_part
167
2
        && (opcodep->lose & (opcode_part << 24)) == 0)
168
2
      opcodes[opcode_part] = opcodep;
169
170
9.94M
    if ((opcodep->match & insn) == opcodep->match
171
4.32M
        && (opcodep->lose & insn) == 0)
172
126k
      break;
173
9.94M
  }
174
132k
    }
175
176
172k
  if (opcodep->name == NULL)
177
5.77k
    return NULL;
178
179
  /* Check constraints.  If they don't match, loop through the next opcode
180
     entries.  */
181
167k
  do
182
167k
    {
183
167k
      switch (opcodep->operands)
184
167k
  {
185
    /* These have no restraint on what can be in the lower three
186
       bytes.  */
187
15.3k
  case mmix_operands_regs:
188
20.4k
  case mmix_operands_reg_yz:
189
35.3k
  case mmix_operands_regs_z_opt:
190
76.0k
  case mmix_operands_regs_z:
191
77.7k
  case mmix_operands_jmp:
192
78.5k
  case mmix_operands_pushgo:
193
79.2k
  case mmix_operands_pop:
194
80.3k
  case mmix_operands_sync:
195
83.7k
  case mmix_operands_x_regs_z:
196
86.1k
  case mmix_operands_neg:
197
87.3k
  case mmix_operands_pushj:
198
98.9k
  case mmix_operands_regaddr:
199
99.5k
  case mmix_operands_get:
200
99.7k
  case mmix_operands_set:
201
100k
  case mmix_operands_save:
202
100k
  case mmix_operands_unsave:
203
155k
  case mmix_operands_xyz_opt:
204
155k
    return opcodep;
205
206
    /* For a ROUND_MODE, the middle byte must be 0..4.  */
207
7.33k
  case mmix_operands_roundregs_z:
208
10.5k
  case mmix_operands_roundregs:
209
10.5k
    {
210
10.5k
      int midbyte = (insn >> 8) & 255;
211
212
10.5k
      if (midbyte <= 4)
213
3.82k
        return opcodep;
214
10.5k
    }
215
6.68k
  break;
216
217
6.68k
  case mmix_operands_put:
218
    /* A "PUT".  If it is "immediate", then no restrictions,
219
       otherwise we have to make sure the register number is < 32.  */
220
607
    if ((insn & INSN_IMMEDIATE_BIT)
221
383
        || ((insn >> 16) & 255) < 32)
222
469
      return opcodep;
223
138
    break;
224
225
173
  case mmix_operands_resume:
226
    /* Middle bytes must be zero.  */
227
173
    if ((insn & 0x00ffff00) == 0)
228
173
      return opcodep;
229
0
    break;
230
231
0
  default:
232
0
    BAD_CASE (opcodep->operands);
233
167k
  }
234
235
6.82k
      opcodep++;
236
6.82k
    }
237
167k
  while ((opcodep->match & insn) == opcodep->match
238
0
   && (opcodep->lose & insn) == 0);
239
240
  /* If we got here, we had no match.  */
241
6.82k
  return NULL;
242
167k
}
243
244
static inline const char *
245
get_reg_name (const struct mmix_dis_info * minfop, unsigned int x)
246
223k
{
247
223k
  if (x >= MAX_REG_NAME_LEN)
248
0
    return _("*illegal*");
249
223k
  return minfop->reg_name[x];
250
223k
}
251
252
static inline const char *
253
get_spec_reg_name (const struct mmix_dis_info * minfop, unsigned int x)
254
1.04k
{
255
1.04k
  if (x >= MAX_SPEC_REG_NAME_LEN)
256
126
    return _("*illegal*");
257
922
  return minfop->spec_reg_name[x];
258
1.04k
}
259
260
/* The main disassembly function.  */
261
262
int
263
print_insn_mmix (bfd_vma memaddr, struct disassemble_info *info)
264
172k
{
265
172k
  unsigned char buffer[4];
266
172k
  unsigned long insn;
267
172k
  unsigned int x, y, z;
268
172k
  const struct mmix_opcode *opcodep;
269
172k
  int status = (*info->read_memory_func) (memaddr, buffer, 4, info);
270
172k
  struct mmix_dis_info *minfop;
271
272
172k
  if (status != 0)
273
192
    {
274
192
      (*info->memory_error_func) (status, memaddr, info);
275
192
      return -1;
276
192
    }
277
278
  /* FIXME: Is -1 suitable?  */
279
172k
  if (info->private_data == NULL
280
350
      && ! initialize_mmix_dis_info (info))
281
0
    return -1;
282
283
172k
  minfop = (struct mmix_dis_info *) info->private_data;
284
172k
  x = buffer[1];
285
172k
  y = buffer[2];
286
172k
  z = buffer[3];
287
288
172k
  insn = bfd_getb32 (buffer);
289
290
172k
  opcodep = get_opcode (insn);
291
292
172k
  if (opcodep == NULL)
293
12.5k
    {
294
12.5k
      (*info->fprintf_func) (info->stream, _("*unknown*"));
295
12.5k
      return 4;
296
12.5k
    }
297
298
160k
  (*info->fprintf_func) (info->stream, "%s ", opcodep->name);
299
300
  /* Present bytes in the order they are laid out in memory.  */
301
160k
  info->display_endian = BFD_ENDIAN_BIG;
302
303
160k
  info->insn_info_valid = 1;
304
160k
  info->bytes_per_chunk = 4;
305
160k
  info->branch_delay_insns = 0;
306
160k
  info->target = 0;
307
160k
  switch (opcodep->type)
308
160k
    {
309
72.2k
    case mmix_type_normal:
310
75.1k
    case mmix_type_memaccess_block:
311
75.1k
      info->insn_type = dis_nonbranch;
312
75.1k
      break;
313
314
2.95k
    case mmix_type_branch:
315
2.95k
      info->insn_type = dis_branch;
316
2.95k
      break;
317
318
11.3k
    case mmix_type_condbranch:
319
11.3k
      info->insn_type = dis_condbranch;
320
11.3k
      break;
321
322
4.69k
    case mmix_type_memaccess_octa:
323
4.69k
      info->insn_type = dis_dref;
324
4.69k
      info->data_size = 8;
325
4.69k
      break;
326
327
3.65k
    case mmix_type_memaccess_tetra:
328
3.65k
      info->insn_type = dis_dref;
329
3.65k
      info->data_size = 4;
330
3.65k
      break;
331
332
1.35k
    case mmix_type_memaccess_wyde:
333
1.35k
      info->insn_type = dis_dref;
334
1.35k
      info->data_size = 2;
335
1.35k
      break;
336
337
4.96k
    case mmix_type_memaccess_byte:
338
4.96k
      info->insn_type = dis_dref;
339
4.96k
      info->data_size = 1;
340
4.96k
      break;
341
342
56.0k
    case mmix_type_jsr:
343
56.0k
      info->insn_type = dis_jsr;
344
56.0k
      break;
345
346
0
    default:
347
0
      BAD_CASE(opcodep->type);
348
160k
    }
349
350
160k
  switch (opcodep->operands)
351
160k
    {
352
15.3k
    case mmix_operands_regs:
353
      /*  All registers: "$X,$Y,$Z".  */
354
15.3k
      (*info->fprintf_func) (info->stream, "%s,%s,%s",
355
15.3k
           get_reg_name (minfop, x),
356
15.3k
           get_reg_name (minfop, y),
357
15.3k
           get_reg_name (minfop, z));
358
15.3k
      break;
359
360
5.04k
    case mmix_operands_reg_yz:
361
      /* Like SETH - "$X,YZ".  */
362
5.04k
      (*info->fprintf_func) (info->stream, "%s,0x%x",
363
5.04k
           get_reg_name (minfop, x), y * 256 + z);
364
5.04k
      break;
365
366
14.8k
    case mmix_operands_regs_z_opt:
367
55.5k
    case mmix_operands_regs_z:
368
56.3k
    case mmix_operands_pushgo:
369
      /* The regular "$X,$Y,$Z|Z".  */
370
56.3k
      if (insn & INSN_IMMEDIATE_BIT)
371
26.2k
  (*info->fprintf_func) (info->stream, "%s,%s,%d",
372
26.2k
             get_reg_name (minfop, x),
373
26.2k
             get_reg_name (minfop, y), z);
374
30.1k
      else
375
30.1k
  (*info->fprintf_func) (info->stream, "%s,%s,%s",
376
30.1k
             get_reg_name (minfop, x),
377
30.1k
             get_reg_name (minfop, y),
378
30.1k
             get_reg_name (minfop, z));
379
56.3k
      break;
380
381
1.75k
    case mmix_operands_jmp:
382
      /* Address; only JMP.  */
383
1.75k
      {
384
1.75k
  bfd_signed_vma offset = (x * 65536 + y * 256 + z) * 4;
385
386
1.75k
  if (insn & INSN_BACKWARD_OFFSET_BIT)
387
725
    offset -= (256 * 65536) * 4;
388
389
1.75k
  info->target = memaddr + offset;
390
1.75k
  (*info->print_address_func) (memaddr + offset, info);
391
1.75k
      }
392
1.75k
      break;
393
394
2.36k
    case mmix_operands_roundregs_z:
395
      /* Two registers, like FLOT, possibly with rounding: "$X,$Z|Z"
396
   "$X,ROUND_MODE,$Z|Z".  */
397
2.36k
      if (y != 0)
398
783
  {
399
783
    if (insn & INSN_IMMEDIATE_BIT)
400
398
      (*info->fprintf_func) (info->stream, "%s,%s,%d",
401
398
           get_reg_name (minfop, x),
402
398
           ROUND_MODE (y), z);
403
385
    else
404
385
      (*info->fprintf_func) (info->stream, "%s,%s,%s",
405
385
           get_reg_name (minfop, x),
406
385
           ROUND_MODE (y),
407
385
           get_reg_name (minfop, z));
408
783
  }
409
1.58k
      else
410
1.58k
  {
411
1.58k
    if (insn & INSN_IMMEDIATE_BIT)
412
988
      (*info->fprintf_func) (info->stream, "%s,%d",
413
988
           get_reg_name (minfop, x), z);
414
596
    else
415
596
      (*info->fprintf_func) (info->stream, "%s,%s",
416
596
           get_reg_name (minfop, x),
417
596
           get_reg_name (minfop, z));
418
1.58k
  }
419
2.36k
      break;
420
421
724
    case mmix_operands_pop:
422
      /* Like POP - "X,YZ".  */
423
724
      (*info->fprintf_func) (info->stream, "%d,%d", x, y*256 + z);
424
724
      break;
425
426
1.46k
    case mmix_operands_roundregs:
427
      /* Two registers, possibly with rounding: "$X,$Z" or
428
   "$X,ROUND_MODE,$Z".  */
429
1.46k
      if (y != 0)
430
874
  (*info->fprintf_func) (info->stream, "%s,%s,%s",
431
874
             get_reg_name (minfop, x),
432
874
             ROUND_MODE (y),
433
874
             get_reg_name (minfop, z));
434
586
      else
435
586
  (*info->fprintf_func) (info->stream, "%s,%s",
436
586
             get_reg_name (minfop, x),
437
586
             get_reg_name (minfop, z));
438
1.46k
      break;
439
440
1.01k
    case mmix_operands_sync:
441
  /* Like SYNC - "XYZ".  */
442
1.01k
      (*info->fprintf_func) (info->stream, "%u",
443
1.01k
           x * 65536 + y * 256 + z);
444
1.01k
      break;
445
446
3.47k
    case mmix_operands_x_regs_z:
447
      /* Like SYNCD - "X,$Y,$Z|Z".  */
448
3.47k
      if (insn & INSN_IMMEDIATE_BIT)
449
1.17k
  (*info->fprintf_func) (info->stream, "%d,%s,%d",
450
1.17k
             x, get_reg_name (minfop, y), z);
451
2.29k
      else
452
2.29k
  (*info->fprintf_func) (info->stream, "%d,%s,%s",
453
2.29k
             x, get_reg_name (minfop, y),
454
2.29k
             get_reg_name (minfop, z));
455
3.47k
      break;
456
457
2.37k
    case mmix_operands_neg:
458
      /* Like NEG and NEGU - "$X,Y,$Z|Z".  */
459
2.37k
      if (insn & INSN_IMMEDIATE_BIT)
460
1.21k
  (*info->fprintf_func) (info->stream, "%s,%d,%d",
461
1.21k
             get_reg_name (minfop, x), y, z);
462
1.15k
      else
463
1.15k
  (*info->fprintf_func) (info->stream, "%s,%d,%s",
464
1.15k
             get_reg_name (minfop, x), y,
465
1.15k
             get_reg_name (minfop, z));
466
2.37k
      break;
467
468
1.15k
    case mmix_operands_pushj:
469
12.7k
    case mmix_operands_regaddr:
470
      /* Like GETA or branches - "$X,Address".  */
471
12.7k
      {
472
12.7k
  bfd_signed_vma offset = (y * 256 + z) * 4;
473
474
12.7k
  if (insn & INSN_BACKWARD_OFFSET_BIT)
475
6.21k
    offset -= 65536 * 4;
476
477
12.7k
  info->target = memaddr + offset;
478
479
12.7k
  (*info->fprintf_func) (info->stream, "%s,", get_reg_name (minfop, x));
480
12.7k
  (*info->print_address_func) (memaddr + offset, info);
481
12.7k
      }
482
12.7k
      break;
483
484
579
    case mmix_operands_get:
485
      /* GET - "X,spec_reg".  */
486
579
      (*info->fprintf_func) (info->stream, "%s,%s",
487
579
           get_reg_name (minfop, x),
488
579
           get_spec_reg_name (minfop, z));
489
579
      break;
490
491
469
    case mmix_operands_put:
492
      /* PUT - "spec_reg,$Z|Z".  */
493
469
      if (insn & INSN_IMMEDIATE_BIT)
494
224
  (*info->fprintf_func) (info->stream, "%s,%d",
495
224
             get_spec_reg_name (minfop, x), z);
496
245
      else
497
245
  (*info->fprintf_func) (info->stream, "%s,%s",
498
245
             get_spec_reg_name (minfop, x),
499
245
             get_reg_name (minfop, z));
500
469
      break;
501
502
283
    case mmix_operands_set:
503
      /*  Two registers, "$X,$Y".  */
504
283
      (*info->fprintf_func) (info->stream, "%s,%s",
505
283
           get_reg_name (minfop, x),
506
283
           get_reg_name (minfop, y));
507
283
      break;
508
509
633
    case mmix_operands_save:
510
      /* SAVE - "$X,0".  */
511
633
      (*info->fprintf_func) (info->stream, "%s,0", minfop->reg_name[x]);
512
633
      break;
513
514
52
    case mmix_operands_unsave:
515
      /* UNSAVE - "0,$Z".  */
516
52
      (*info->fprintf_func) (info->stream, "0,%s", minfop->reg_name[z]);
517
52
      break;
518
519
55.2k
    case mmix_operands_xyz_opt:
520
      /* Like SWYM or TRAP - "X,Y,Z".  */
521
55.2k
      (*info->fprintf_func) (info->stream, "%d,%d,%d", x, y, z);
522
55.2k
      break;
523
524
173
    case mmix_operands_resume:
525
      /* Just "Z", like RESUME.  */
526
173
      (*info->fprintf_func) (info->stream, "%d", z);
527
173
      break;
528
529
0
    default:
530
0
      (*info->fprintf_func) (info->stream, _("*unknown operands type: %d*"),
531
0
           opcodep->operands);
532
0
      break;
533
160k
    }
534
535
160k
  return 4;
536
160k
}