binutils-gdb/gdb/auxv.h
Andrew Burgess 1d506c26d9 Update copyright year range in header of all files managed by GDB
This commit is the result of the following actions:

  - Running gdb/copyright.py to update all of the copyright headers to
    include 2024,

  - Manually updating a few files the copyright.py script told me to
    update, these files had copyright headers embedded within the
    file,

  - Regenerating gdbsupport/Makefile.in to refresh it's copyright
    date,

  - Using grep to find other files that still mentioned 2023.  If
    these files were updated last year from 2022 to 2023 then I've
    updated them this year to 2024.

I'm sure I've probably missed some dates.  Feel free to fix them up as
you spot them.
2024-01-12 15:49:57 +00:00

92 lines
3.4 KiB
C++

/* Auxiliary vector support for GDB, the GNU debugger.
Copyright (C) 2004-2024 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef AUXV_H
#define AUXV_H
#include "target.h"
/* See "include/elf/common.h" for the definition of valid AT_* values. */
/* The default implementation of to_auxv_parse, used by the target
stack.
Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
Return 0 if *READPTR is already at the end of the buffer.
Return -1 if there is insufficient buffer for a whole entry.
Return 1 if an entry was read into *TYPEP and *VALP. */
extern int default_auxv_parse (struct target_ops *ops, const gdb_byte **readptr,
const gdb_byte *endptr, CORE_ADDR *typep,
CORE_ADDR *valp);
/* The SVR4 psABI implementation of to_auxv_parse, that uses an int to
store the type rather than long as assumed by the default parser.
Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
Return 0 if *READPTR is already at the end of the buffer.
Return -1 if there is insufficient buffer for a whole entry.
Return 1 if an entry was read into *TYPEP and *VALP. */
extern int svr4_auxv_parse (struct gdbarch *gdbarch, const gdb_byte **readptr,
const gdb_byte *endptr, CORE_ADDR *typep,
CORE_ADDR *valp);
/* Read auxv data from the current inferior's target stack. */
extern const std::optional<gdb::byte_vector> &target_read_auxv ();
/* Read auxv data from OPS. */
extern std::optional<gdb::byte_vector> target_read_auxv_raw (target_ops *ops);
/* Search AUXV for an entry with a_type matching MATCH.
OPS and GDBARCH are the target and architecture to use to parse auxv entries.
Return zero if no such entry was found, or -1 if there was
an error getting the information. On success, return 1 after
storing the entry's value field in *VALP. */
extern int target_auxv_search (const gdb::byte_vector &auxv,
target_ops *ops, gdbarch *gdbarch,
CORE_ADDR match, CORE_ADDR *valp);
/* Same as the above, but read the auxv data from the current inferior. Use
the current inferior's top target and arch to parse auxv entries. */
extern int target_auxv_search (CORE_ADDR match, CORE_ADDR *valp);
/* Print a description of a single AUXV entry on the specified file. */
enum auxv_format { AUXV_FORMAT_DEC, AUXV_FORMAT_HEX, AUXV_FORMAT_STR };
extern void fprint_auxv_entry (struct ui_file *file, const char *name,
const char *description,
enum auxv_format format, CORE_ADDR type,
CORE_ADDR val);
/* The default implementation of gdbarch_print_auxv_entry. */
extern void default_print_auxv_entry (struct gdbarch *gdbarch,
struct ui_file *file, CORE_ADDR type,
CORE_ADDR val);
extern target_xfer_partial_ftype memory_xfer_auxv;
#endif