gdb/target/target.h

   1 /* Declarations for common target functions.
   2
   3    Copyright (C) 1986-2016 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program 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 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef TARGET_COMMON_H
  21 #define TARGET_COMMON_H
  22
  23 #include "target/waitstatus.h"
  24 /* This header is a stopgap until more code is shared.  */
  25
  26 /* Read LEN bytes of target memory at address MEMADDR, placing the
  27    results in GDB's memory at MYADDR.  Return zero for success,
  28    nonzero if any error occurs.  This function must be provided by
  29    the client.  Implementations of this function may define and use
  30    their own error codes, but functions in the common, nat and target
  31    directories must treat the return code as opaque.  No guarantee is
  32    made about the contents of the data at MYADDR if any error
  33    occurs.  */
  34
  35 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
  36                                ssize_t len);
  37
  38 /* Read an unsigned 32-bit integer in the target's format from target
  39    memory at address MEMADDR, storing the result in GDB's format in
  40    GDB's memory at RESULT.  Return zero for success, nonzero if any
  41    error occurs.  This function must be provided by the client.
  42    Implementations of this function may define and use their own error
  43    codes, but functions in the common, nat and target directories must
  44    treat the return code as opaque.  No guarantee is made about the
  45    contents of the data at RESULT if any error occurs.  */
  46
  47 extern int target_read_uint32 (CORE_ADDR memaddr, uint32_t *result);
  48
  49 /* Write LEN bytes from MYADDR to target memory at address MEMADDR.
  50    Return zero for success, nonzero if any error occurs.  This
  51    function must be provided by the client.  Implementations of this
  52    function may define and use their own error codes, but functions
  53    in the common, nat and target directories must treat the return
  54    code as opaque.  No guarantee is made about the contents of the
  55    data at MEMADDR if any error occurs.  */
  56
  57 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
  58                                 ssize_t len);
  59
  60 /* Cause the target to stop in a continuable fashion--for instance,
  61    under Unix, this should act like SIGSTOP--and wait for the target
  62    to be stopped before returning.  This function must be provided by
  63    the client.  */
  64
  65 extern void target_stop_and_wait (ptid_t ptid);
  66
  67 /* Restart a target previously stopped.  No signal is delivered to the
  68    target.  This function must be provided by the client.  */
  69
  70 extern void target_continue_no_signal (ptid_t ptid);
  71
  72 /* Restart a target previously stopped.  SIGNAL is delivered to the
  73    target.  This function must be provided by the client.  */
  74
  75 extern void target_continue (ptid_t ptid, enum gdb_signal signal);
  76
  77 #endif /* TARGET_COMMON_H */