sim/aarch64/simulator.h

   1 /* simulator.h -- Prototypes for AArch64 simulator functions.
   2
   3    Copyright (C) 2015-2024 Free Software Foundation, Inc.
   4
   5    Contributed by 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 #ifndef _SIMULATOR_H
  23 #define _SIMULATOR_H
  24
  25 #include <sys/types.h>
  26 #include <setjmp.h>
  27
  28 #include "sim-main.h"
  29 #include "decode.h"
  30
  31 #define TOP_LEVEL_RETURN_PC 0xffffffffffffffecULL
  32
  33 /* Call this to set the start stack pointer, frame pointer and pc
  34    before calling run or step.  Also sets link register to a special
  35    value (-20) so we can detect a top level return.  This function
  36    should be called from the sim setup routine running on the alt
  37    stack, and should pass in the current top of C stack for SP and
  38    the FP of the caller for fp.  PC should be sthe start of the
  39    AARCH64 code segment to be executed.  */
  40
  41 extern void         aarch64_init (sim_cpu *, uint64_t);
  42
  43 /* Call this to run from the current PC without stopping until we
  44    either return from the top frame, execute a halt or break or we
  45    hit an error.  */
  46
  47 extern void         aarch64_run (SIM_DESC);
  48 extern const char * aarch64_get_func (SIM_DESC, uint64_t);
  49 extern void         aarch64_init_LIT_table (void);
  50
  51 #endif /* _SIMULATOR_H */