sim/common/sim-basics.h

   1 /* The common simulator framework for GDB, the GNU Debugger.
   2
   3    Copyright 2002-2021 Free Software Foundation, Inc.
   4
   5    Contributed by Andrew Cagney and Red Hat.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22
  23 #ifndef SIM_BASICS_H
  24 #define SIM_BASICS_H
  25
  26
  27 /* Basic configuration */
  28
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 /* Basic host dependant mess - hopefully <stdio.h> + <stdarg.h> will
  34    bring potential conflicts out in the open */
  35
  36 #include <stdarg.h>
  37 #include <stdio.h>
  38 #include <setjmp.h>
  39
  40
  41 #ifndef NULL
  42 #define NULL 0
  43 #endif
  44
  45
  46 #ifndef min
  47 #define min(a, b) ((a) < (b) ? (a) : (b))
  48 #endif
  49 #ifndef max
  50 #define max(a, b) ((a) > (b) ? (a) : (b))
  51 #endif
  52
  53
  54 /* Global types that code manipulates */
  55
  56 struct hw;
  57 struct _sim_fpu;
  58
  59
  60 /* Generic address space (maps) and access attributes */
  61
  62 enum {
  63   read_map = 0,
  64   write_map = 1,
  65   exec_map = 2,
  66   io_map = 3,
  67   nr_maps = 32, /* something small */
  68 };
  69
  70 enum {
  71   access_invalid = 0,
  72   access_read = 1 << read_map,
  73   access_write = 1 << write_map,
  74   access_exec = 1 << exec_map,
  75   access_io = 1 << io_map,
  76 };
  77
  78 enum {
  79   access_read_write = (access_read | access_write),
  80   access_read_exec = (access_read | access_exec),
  81   access_write_exec = (access_write | access_exec),
  82   access_read_write_exec = (access_read | access_write | access_exec),
  83   access_read_io = (access_read | access_io),
  84   access_write_io = (access_write | access_io),
  85   access_read_write_io = (access_read | access_write | access_io),
  86   access_exec_io = (access_exec | access_io),
  87   access_read_exec_io = (access_read | access_exec | access_io),
  88   access_write_exec_io = (access_write | access_exec | access_io),
  89   access_read_write_exec_io = (access_read | access_write | access_exec | access_io),
  90 };
  91
  92
  93 /* disposition of an object when things are reset */
  94
  95 typedef enum {
  96   permenant_object,
  97   temporary_object,
  98 } object_disposition;
  99
 100
 101 /* Memory transfer types */
 102
 103 typedef enum _transfer_type {
 104   read_transfer,
 105   write_transfer,
 106 } transfer_type;
 107
 108
 109 /* directions */
 110
 111 typedef enum {
 112   bidirect_port,
 113   input_port,
 114   output_port,
 115 } port_direction;
 116
 117
 118 \f
 119 /* Basic definitions - ordered so that nothing calls what comes after it.  */
 120
 121 #include "ansidecl.h"
 122 #include "sim/callback.h"
 123 #include "sim/sim.h"
 124
 125 #include "sim-config.h"
 126
 127 #include "sim-inline.h"
 128
 129 #include "sim-types.h"
 130 #include "sim-bits.h"
 131 #include "sim-endian.h"
 132 #include "sim-signal.h"
 133
 134 #include "sim-utils.h"
 135
 136 #include "libiberty.h"
 137
 138 /* Note: Only the simpler interfaces are defined here.  More heavy
 139    weight objects, such as core and events, are defined in the more
 140    serious sim-base.h header. */
 141
 142 #endif /* SIM_BASICS_H */