Automatic date update in version.in
[binutils-gdb.git] / gdb / auxv.c
blob76fc821c07c3d7e7acb778ff5617bc728de9b318
1 /* Auxiliary vector support for GDB, the GNU debugger.
3 Copyright (C) 2004-2022 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
20 #include "defs.h"
21 #include "target.h"
22 #include "gdbtypes.h"
23 #include "command.h"
24 #include "inferior.h"
25 #include "valprint.h"
26 #include "gdbcore.h"
27 #include "observable.h"
28 #include "gdbsupport/filestuff.h"
29 #include "objfiles.h"
31 #include "auxv.h"
32 #include "elf/common.h"
34 #include <unistd.h>
35 #include <fcntl.h>
38 /* Implement the to_xfer_partial target_ops method. This function
39 handles access via /proc/PID/auxv, which is a common method for
40 native targets. */
42 static enum target_xfer_status
43 procfs_xfer_auxv (gdb_byte *readbuf,
44 const gdb_byte *writebuf,
45 ULONGEST offset,
46 ULONGEST len,
47 ULONGEST *xfered_len)
49 ssize_t l;
51 std::string pathname = string_printf ("/proc/%d/auxv", inferior_ptid.pid ());
52 scoped_fd fd
53 = gdb_open_cloexec (pathname, writebuf != NULL ? O_WRONLY : O_RDONLY, 0);
54 if (fd.get () < 0)
55 return TARGET_XFER_E_IO;
57 if (offset != (ULONGEST) 0
58 && lseek (fd.get (), (off_t) offset, SEEK_SET) != (off_t) offset)
59 l = -1;
60 else if (readbuf != NULL)
61 l = read (fd.get (), readbuf, (size_t) len);
62 else
63 l = write (fd.get (), writebuf, (size_t) len);
65 if (l < 0)
66 return TARGET_XFER_E_IO;
67 else if (l == 0)
68 return TARGET_XFER_EOF;
69 else
71 *xfered_len = (ULONGEST) l;
72 return TARGET_XFER_OK;
76 /* This function handles access via ld.so's symbol `_dl_auxv'. */
78 static enum target_xfer_status
79 ld_so_xfer_auxv (gdb_byte *readbuf,
80 const gdb_byte *writebuf,
81 ULONGEST offset,
82 ULONGEST len, ULONGEST *xfered_len)
84 struct bound_minimal_symbol msym;
85 CORE_ADDR data_address, pointer_address;
86 struct type *ptr_type = builtin_type (target_gdbarch ())->builtin_data_ptr;
87 size_t ptr_size = ptr_type->length ();
88 size_t auxv_pair_size = 2 * ptr_size;
89 gdb_byte *ptr_buf = (gdb_byte *) alloca (ptr_size);
90 LONGEST retval;
91 size_t block;
93 msym = lookup_minimal_symbol ("_dl_auxv", NULL, NULL);
94 if (msym.minsym == NULL)
95 return TARGET_XFER_E_IO;
97 if (msym.minsym->size () != ptr_size)
98 return TARGET_XFER_E_IO;
100 /* POINTER_ADDRESS is a location where the `_dl_auxv' variable
101 resides. DATA_ADDRESS is the inferior value present in
102 `_dl_auxv', therefore the real inferior AUXV address. */
104 pointer_address = msym.value_address ();
106 /* The location of the _dl_auxv symbol may no longer be correct if
107 ld.so runs at a different address than the one present in the
108 file. This is very common case - for unprelinked ld.so or with a
109 PIE executable. PIE executable forces random address even for
110 libraries already being prelinked to some address. PIE
111 executables themselves are never prelinked even on prelinked
112 systems. Prelinking of a PIE executable would block their
113 purpose of randomizing load of everything including the
114 executable.
116 If the memory read fails, return -1 to fallback on another
117 mechanism for retrieving the AUXV.
119 In most cases of a PIE running under valgrind there is no way to
120 find out the base addresses of any of ld.so, executable or AUXV
121 as everything is randomized and /proc information is not relevant
122 for the virtual executable running under valgrind. We think that
123 we might need a valgrind extension to make it work. This is PR
124 11440. */
126 if (target_read_memory (pointer_address, ptr_buf, ptr_size) != 0)
127 return TARGET_XFER_E_IO;
129 data_address = extract_typed_address (ptr_buf, ptr_type);
131 /* Possibly still not initialized such as during an inferior
132 startup. */
133 if (data_address == 0)
134 return TARGET_XFER_E_IO;
136 data_address += offset;
138 if (writebuf != NULL)
140 if (target_write_memory (data_address, writebuf, len) == 0)
142 *xfered_len = (ULONGEST) len;
143 return TARGET_XFER_OK;
145 else
146 return TARGET_XFER_E_IO;
149 /* Stop if trying to read past the existing AUXV block. The final
150 AT_NULL was already returned before. */
152 if (offset >= auxv_pair_size)
154 if (target_read_memory (data_address - auxv_pair_size, ptr_buf,
155 ptr_size) != 0)
156 return TARGET_XFER_E_IO;
158 if (extract_typed_address (ptr_buf, ptr_type) == AT_NULL)
159 return TARGET_XFER_EOF;
162 retval = 0;
163 block = 0x400;
164 gdb_assert (block % auxv_pair_size == 0);
166 while (len > 0)
168 if (block > len)
169 block = len;
171 /* Reading sizes smaller than AUXV_PAIR_SIZE is not supported.
172 Tails unaligned to AUXV_PAIR_SIZE will not be read during a
173 call (they should be completed during next read with
174 new/extended buffer). */
176 block &= -auxv_pair_size;
177 if (block == 0)
178 break;
180 if (target_read_memory (data_address, readbuf, block) != 0)
182 if (block <= auxv_pair_size)
183 break;
185 block = auxv_pair_size;
186 continue;
189 data_address += block;
190 len -= block;
192 /* Check terminal AT_NULL. This function is being called
193 indefinitely being extended its READBUF until it returns EOF
194 (0). */
196 while (block >= auxv_pair_size)
198 retval += auxv_pair_size;
200 if (extract_typed_address (readbuf, ptr_type) == AT_NULL)
202 *xfered_len = (ULONGEST) retval;
203 return TARGET_XFER_OK;
206 readbuf += auxv_pair_size;
207 block -= auxv_pair_size;
211 *xfered_len = (ULONGEST) retval;
212 return TARGET_XFER_OK;
215 /* Implement the to_xfer_partial target_ops method for
216 TARGET_OBJECT_AUXV. It handles access to AUXV. */
218 enum target_xfer_status
219 memory_xfer_auxv (struct target_ops *ops,
220 enum target_object object,
221 const char *annex,
222 gdb_byte *readbuf,
223 const gdb_byte *writebuf,
224 ULONGEST offset,
225 ULONGEST len, ULONGEST *xfered_len)
227 gdb_assert (object == TARGET_OBJECT_AUXV);
228 gdb_assert (readbuf || writebuf);
230 /* ld_so_xfer_auxv is the only function safe for virtual
231 executables being executed by valgrind's memcheck. Using
232 ld_so_xfer_auxv during inferior startup is problematic, because
233 ld.so symbol tables have not yet been relocated. So GDB uses
234 this function only when attaching to a process.
237 if (current_inferior ()->attach_flag != 0)
239 enum target_xfer_status ret;
241 ret = ld_so_xfer_auxv (readbuf, writebuf, offset, len, xfered_len);
242 if (ret != TARGET_XFER_E_IO)
243 return ret;
246 return procfs_xfer_auxv (readbuf, writebuf, offset, len, xfered_len);
249 /* This function compared to other auxv_parse functions: it takes the size of
250 the auxv type field as a parameter. */
252 static int
253 generic_auxv_parse (struct gdbarch *gdbarch, const gdb_byte **readptr,
254 const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp,
255 int sizeof_auxv_type)
257 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
258 const int sizeof_auxv_val = ptr_type->length ();
259 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
260 const gdb_byte *ptr = *readptr;
262 if (endptr == ptr)
263 return 0;
265 if (endptr - ptr < 2 * sizeof_auxv_val)
266 return -1;
268 *typep = extract_unsigned_integer (ptr, sizeof_auxv_type, byte_order);
269 /* Even if the auxv type takes less space than an auxv value, there is
270 padding after the type such that the value is aligned on a multiple of
271 its size (and this is why we advance by `sizeof_auxv_val` and not
272 `sizeof_auxv_type`). */
273 ptr += sizeof_auxv_val;
274 *valp = extract_unsigned_integer (ptr, sizeof_auxv_val, byte_order);
275 ptr += sizeof_auxv_val;
277 *readptr = ptr;
278 return 1;
281 /* See auxv.h. */
284 default_auxv_parse (struct target_ops *ops, const gdb_byte **readptr,
285 const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
287 struct gdbarch *gdbarch = target_gdbarch ();
288 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
289 const int sizeof_auxv_type = ptr_type->length ();
291 return generic_auxv_parse (gdbarch, readptr, endptr, typep, valp,
292 sizeof_auxv_type);
295 /* See auxv.h. */
298 svr4_auxv_parse (struct gdbarch *gdbarch, const gdb_byte **readptr,
299 const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
301 struct type *int_type = builtin_type (gdbarch)->builtin_int;
302 const int sizeof_auxv_type = int_type->length ();
304 return generic_auxv_parse (gdbarch, readptr, endptr, typep, valp,
305 sizeof_auxv_type);
308 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
310 Use the auxv_parse method from the current inferior's gdbarch, if defined,
311 else use the current inferior's target stack's auxv_parse.
313 Return 0 if *READPTR is already at the end of the buffer.
314 Return -1 if there is insufficient buffer for a whole entry.
315 Return 1 if an entry was read into *TYPEP and *VALP. */
316 static int
317 parse_auxv (const gdb_byte **readptr, const gdb_byte *endptr, CORE_ADDR *typep,
318 CORE_ADDR *valp)
320 struct gdbarch *gdbarch = target_gdbarch();
322 if (gdbarch_auxv_parse_p (gdbarch))
323 return gdbarch_auxv_parse (gdbarch, readptr, endptr, typep, valp);
325 return current_inferior ()->top_target ()->auxv_parse (readptr, endptr,
326 typep, valp);
330 /* Auxiliary Vector information structure. This is used by GDB
331 for caching purposes for each inferior. This helps reduce the
332 overhead of transfering data from a remote target to the local host. */
333 struct auxv_info
335 gdb::optional<gdb::byte_vector> data;
338 /* Per-inferior data key for auxv. */
339 static const registry<inferior>::key<auxv_info> auxv_inferior_data;
341 /* Invalidate INF's auxv cache. */
343 static void
344 invalidate_auxv_cache_inf (struct inferior *inf)
346 auxv_inferior_data.clear (inf);
349 /* Invalidate current inferior's auxv cache. */
351 static void
352 invalidate_auxv_cache (void)
354 invalidate_auxv_cache_inf (current_inferior ());
357 /* Fetch the auxv object from inferior INF. If auxv is cached already,
358 return a pointer to the cache. If not, fetch the auxv object from the
359 target and cache it. This function always returns a valid INFO pointer. */
361 static struct auxv_info *
362 get_auxv_inferior_data (struct target_ops *ops)
364 struct auxv_info *info;
365 struct inferior *inf = current_inferior ();
367 info = auxv_inferior_data.get (inf);
368 if (info == NULL)
370 info = auxv_inferior_data.emplace (inf);
371 info->data = target_read_alloc (ops, TARGET_OBJECT_AUXV, NULL);
374 return info;
377 /* Extract the auxiliary vector entry with a_type matching MATCH.
378 Return zero if no such entry was found, or -1 if there was
379 an error getting the information. On success, return 1 after
380 storing the entry's value field in *VALP. */
382 target_auxv_search (struct target_ops *ops, CORE_ADDR match, CORE_ADDR *valp)
384 CORE_ADDR type, val;
385 auxv_info *info = get_auxv_inferior_data (ops);
387 if (!info->data)
388 return -1;
390 const gdb_byte *data = info->data->data ();
391 const gdb_byte *ptr = data;
392 size_t len = info->data->size ();
394 while (1)
395 switch (parse_auxv (&ptr, data + len, &type, &val))
397 case 1: /* Here's an entry, check it. */
398 if (type == match)
400 *valp = val;
401 return 1;
403 break;
404 case 0: /* End of the vector. */
405 return 0;
406 default: /* Bogosity. */
407 return -1;
410 /*NOTREACHED*/
414 /* Print the description of a single AUXV entry on the specified file. */
416 void
417 fprint_auxv_entry (struct ui_file *file, const char *name,
418 const char *description, enum auxv_format format,
419 CORE_ADDR type, CORE_ADDR val)
421 gdb_printf (file, ("%-4s %-20s %-30s "),
422 plongest (type), name, description);
423 switch (format)
425 case AUXV_FORMAT_DEC:
426 gdb_printf (file, ("%s\n"), plongest (val));
427 break;
428 case AUXV_FORMAT_HEX:
429 gdb_printf (file, ("%s\n"), paddress (target_gdbarch (), val));
430 break;
431 case AUXV_FORMAT_STR:
433 struct value_print_options opts;
435 get_user_print_options (&opts);
436 if (opts.addressprint)
437 gdb_printf (file, ("%s "), paddress (target_gdbarch (), val));
438 val_print_string (builtin_type (target_gdbarch ())->builtin_char,
439 NULL, val, -1, file, &opts);
440 gdb_printf (file, ("\n"));
442 break;
446 /* The default implementation of gdbarch_print_auxv_entry. */
448 void
449 default_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file,
450 CORE_ADDR type, CORE_ADDR val)
452 const char *name = "???";
453 const char *description = "";
454 enum auxv_format format = AUXV_FORMAT_HEX;
456 switch (type)
458 #define TAG(tag, text, kind) \
459 case tag: name = #tag; description = text; format = kind; break
460 TAG (AT_NULL, _("End of vector"), AUXV_FORMAT_HEX);
461 TAG (AT_IGNORE, _("Entry should be ignored"), AUXV_FORMAT_HEX);
462 TAG (AT_EXECFD, _("File descriptor of program"), AUXV_FORMAT_DEC);
463 TAG (AT_PHDR, _("Program headers for program"), AUXV_FORMAT_HEX);
464 TAG (AT_PHENT, _("Size of program header entry"), AUXV_FORMAT_DEC);
465 TAG (AT_PHNUM, _("Number of program headers"), AUXV_FORMAT_DEC);
466 TAG (AT_PAGESZ, _("System page size"), AUXV_FORMAT_DEC);
467 TAG (AT_BASE, _("Base address of interpreter"), AUXV_FORMAT_HEX);
468 TAG (AT_FLAGS, _("Flags"), AUXV_FORMAT_HEX);
469 TAG (AT_ENTRY, _("Entry point of program"), AUXV_FORMAT_HEX);
470 TAG (AT_NOTELF, _("Program is not ELF"), AUXV_FORMAT_DEC);
471 TAG (AT_UID, _("Real user ID"), AUXV_FORMAT_DEC);
472 TAG (AT_EUID, _("Effective user ID"), AUXV_FORMAT_DEC);
473 TAG (AT_GID, _("Real group ID"), AUXV_FORMAT_DEC);
474 TAG (AT_EGID, _("Effective group ID"), AUXV_FORMAT_DEC);
475 TAG (AT_CLKTCK, _("Frequency of times()"), AUXV_FORMAT_DEC);
476 TAG (AT_PLATFORM, _("String identifying platform"), AUXV_FORMAT_STR);
477 TAG (AT_HWCAP, _("Machine-dependent CPU capability hints"),
478 AUXV_FORMAT_HEX);
479 TAG (AT_FPUCW, _("Used FPU control word"), AUXV_FORMAT_DEC);
480 TAG (AT_DCACHEBSIZE, _("Data cache block size"), AUXV_FORMAT_DEC);
481 TAG (AT_ICACHEBSIZE, _("Instruction cache block size"), AUXV_FORMAT_DEC);
482 TAG (AT_UCACHEBSIZE, _("Unified cache block size"), AUXV_FORMAT_DEC);
483 TAG (AT_IGNOREPPC, _("Entry should be ignored"), AUXV_FORMAT_DEC);
484 TAG (AT_BASE_PLATFORM, _("String identifying base platform"),
485 AUXV_FORMAT_STR);
486 TAG (AT_RANDOM, _("Address of 16 random bytes"), AUXV_FORMAT_HEX);
487 TAG (AT_HWCAP2, _("Extension of AT_HWCAP"), AUXV_FORMAT_HEX);
488 TAG (AT_EXECFN, _("File name of executable"), AUXV_FORMAT_STR);
489 TAG (AT_SECURE, _("Boolean, was exec setuid-like?"), AUXV_FORMAT_DEC);
490 TAG (AT_SYSINFO, _("Special system info/entry points"), AUXV_FORMAT_HEX);
491 TAG (AT_SYSINFO_EHDR, _("System-supplied DSO's ELF header"),
492 AUXV_FORMAT_HEX);
493 TAG (AT_L1I_CACHESHAPE, _("L1 Instruction cache information"),
494 AUXV_FORMAT_HEX);
495 TAG (AT_L1I_CACHESIZE, _("L1 Instruction cache size"), AUXV_FORMAT_HEX);
496 TAG (AT_L1I_CACHEGEOMETRY, _("L1 Instruction cache geometry"),
497 AUXV_FORMAT_HEX);
498 TAG (AT_L1D_CACHESHAPE, _("L1 Data cache information"), AUXV_FORMAT_HEX);
499 TAG (AT_L1D_CACHESIZE, _("L1 Data cache size"), AUXV_FORMAT_HEX);
500 TAG (AT_L1D_CACHEGEOMETRY, _("L1 Data cache geometry"),
501 AUXV_FORMAT_HEX);
502 TAG (AT_L2_CACHESHAPE, _("L2 cache information"), AUXV_FORMAT_HEX);
503 TAG (AT_L2_CACHESIZE, _("L2 cache size"), AUXV_FORMAT_HEX);
504 TAG (AT_L2_CACHEGEOMETRY, _("L2 cache geometry"), AUXV_FORMAT_HEX);
505 TAG (AT_L3_CACHESHAPE, _("L3 cache information"), AUXV_FORMAT_HEX);
506 TAG (AT_L3_CACHESIZE, _("L3 cache size"), AUXV_FORMAT_HEX);
507 TAG (AT_L3_CACHEGEOMETRY, _("L3 cache geometry"), AUXV_FORMAT_HEX);
508 TAG (AT_MINSIGSTKSZ, _("Minimum stack size for signal delivery"),
509 AUXV_FORMAT_HEX);
510 TAG (AT_SUN_UID, _("Effective user ID"), AUXV_FORMAT_DEC);
511 TAG (AT_SUN_RUID, _("Real user ID"), AUXV_FORMAT_DEC);
512 TAG (AT_SUN_GID, _("Effective group ID"), AUXV_FORMAT_DEC);
513 TAG (AT_SUN_RGID, _("Real group ID"), AUXV_FORMAT_DEC);
514 TAG (AT_SUN_LDELF, _("Dynamic linker's ELF header"), AUXV_FORMAT_HEX);
515 TAG (AT_SUN_LDSHDR, _("Dynamic linker's section headers"),
516 AUXV_FORMAT_HEX);
517 TAG (AT_SUN_LDNAME, _("String giving name of dynamic linker"),
518 AUXV_FORMAT_STR);
519 TAG (AT_SUN_LPAGESZ, _("Large pagesize"), AUXV_FORMAT_DEC);
520 TAG (AT_SUN_PLATFORM, _("Platform name string"), AUXV_FORMAT_STR);
521 TAG (AT_SUN_CAP_HW1, _("Machine-dependent CPU capability hints"),
522 AUXV_FORMAT_HEX);
523 TAG (AT_SUN_IFLUSH, _("Should flush icache?"), AUXV_FORMAT_DEC);
524 TAG (AT_SUN_CPU, _("CPU name string"), AUXV_FORMAT_STR);
525 TAG (AT_SUN_EMUL_ENTRY, _("COFF entry point address"), AUXV_FORMAT_HEX);
526 TAG (AT_SUN_EMUL_EXECFD, _("COFF executable file descriptor"),
527 AUXV_FORMAT_DEC);
528 TAG (AT_SUN_EXECNAME,
529 _("Canonicalized file name given to execve"), AUXV_FORMAT_STR);
530 TAG (AT_SUN_MMU, _("String for name of MMU module"), AUXV_FORMAT_STR);
531 TAG (AT_SUN_LDDATA, _("Dynamic linker's data segment address"),
532 AUXV_FORMAT_HEX);
533 TAG (AT_SUN_AUXFLAGS,
534 _("AF_SUN_ flags passed from the kernel"), AUXV_FORMAT_HEX);
535 TAG (AT_SUN_EMULATOR, _("Name of emulation binary for runtime linker"),
536 AUXV_FORMAT_STR);
537 TAG (AT_SUN_BRANDNAME, _("Name of brand library"), AUXV_FORMAT_STR);
538 TAG (AT_SUN_BRAND_AUX1, _("Aux vector for brand modules 1"),
539 AUXV_FORMAT_HEX);
540 TAG (AT_SUN_BRAND_AUX2, _("Aux vector for brand modules 2"),
541 AUXV_FORMAT_HEX);
542 TAG (AT_SUN_BRAND_AUX3, _("Aux vector for brand modules 3"),
543 AUXV_FORMAT_HEX);
544 TAG (AT_SUN_CAP_HW2, _("Machine-dependent CPU capability hints 2"),
545 AUXV_FORMAT_HEX);
548 fprint_auxv_entry (file, name, description, format, type, val);
551 /* Print the contents of the target's AUXV on the specified file. */
553 static int
554 fprint_target_auxv (struct ui_file *file, struct target_ops *ops)
556 struct gdbarch *gdbarch = target_gdbarch ();
557 CORE_ADDR type, val;
558 int ents = 0;
559 auxv_info *info = get_auxv_inferior_data (ops);
561 if (!info->data)
562 return -1;
564 const gdb_byte *data = info->data->data ();
565 const gdb_byte *ptr = data;
566 size_t len = info->data->size ();
568 while (parse_auxv (&ptr, data + len, &type, &val) > 0)
570 gdbarch_print_auxv_entry (gdbarch, file, type, val);
571 ++ents;
572 if (type == AT_NULL)
573 break;
576 return ents;
579 static void
580 info_auxv_command (const char *cmd, int from_tty)
582 if (! target_has_stack ())
583 error (_("The program has no auxiliary information now."));
584 else
586 int ents = fprint_target_auxv (gdb_stdout,
587 current_inferior ()->top_target ());
589 if (ents < 0)
590 error (_("No auxiliary vector found, or failed reading it."));
591 else if (ents == 0)
592 error (_("Auxiliary vector is empty."));
596 void _initialize_auxv ();
597 void
598 _initialize_auxv ()
600 add_info ("auxv", info_auxv_command,
601 _("Display the inferior's auxiliary vector.\n\
602 This is information provided by the operating system at program startup."));
604 /* Observers used to invalidate the auxv cache when needed. */
605 gdb::observers::inferior_exit.attach (invalidate_auxv_cache_inf, "auxv");
606 gdb::observers::inferior_appeared.attach (invalidate_auxv_cache_inf, "auxv");
607 gdb::observers::executable_changed.attach (invalidate_auxv_cache, "auxv");