gdb/auxv.h

   1 /* Auxiliary vector support for GDB, the GNU debugger.
   2
   3    Copyright (C) 2004, 2005, 2006, 2007, 2008 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 AUXV_H
  21 #define AUXV_H
  22
  23 /* See "include/elf/common.h" for the definition of valid AT_* values.  */
  24
  25
  26 /* Avoid miscellaneous includes in this file, so that it can be
  27    included by nm-*.h for the procfs_xfer_auxv decl if that is
  28    used in NATIVE_XFER_AUXV.  */
  29 struct target_ops;              /* Forward declaration.  */
  30
  31
  32 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
  33    Return 0 if *READPTR is already at the end of the buffer.
  34    Return -1 if there is insufficient buffer for a whole entry.
  35    Return 1 if an entry was read into *TYPEP and *VALP.  */
  36 extern int target_auxv_parse (struct target_ops *ops,
  37                               gdb_byte **readptr, gdb_byte *endptr,
  38                               CORE_ADDR *typep, CORE_ADDR *valp);
  39
  40 /* Extract the auxiliary vector entry with a_type matching MATCH.
  41    Return zero if no such entry was found, or -1 if there was
  42    an error getting the information.  On success, return 1 after
  43    storing the entry's value field in *VALP.  */
  44 extern int target_auxv_search (struct target_ops *ops,
  45                                CORE_ADDR match, CORE_ADDR *valp);
  46
  47 /* Print the contents of the target's AUXV on the specified file. */
  48 extern int fprint_target_auxv (struct ui_file *file, struct target_ops *ops);
  49
  50
  51 /* This function is called like a to_xfer_partial hook,
  52    but must be called with TARGET_OBJECT_AUXV.
  53    It handles access via /proc/PID/auxv, which is the common method.
  54    This function is appropriate for doing:
  55            #define NATIVE_XFER_AUXV     procfs_xfer_auxv
  56    for a native target that uses inftarg.c's child_xfer_partial hook.  */
  57
  58 extern LONGEST procfs_xfer_auxv (struct target_ops *ops,
  59                                  int /* enum target_object */ object,
  60                                  const char *annex,
  61                                  gdb_byte *readbuf,
  62                                  const gdb_byte *writebuf,
  63                                  ULONGEST offset,
  64                                  LONGEST len);
  65
  66
  67 #endif