1 /* Handle JIT code generation in the inferior for GDB, the GNU Debugger.
3 Copyright (C) 2009, 2010, 2011 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/>. */
23 #include "jit-reader.h"
25 #include "breakpoint.h"
27 #include "dictionary.h"
28 #include "frame-unwind.h"
38 #include "gdb-dlfcn.h"
40 #include "exceptions.h"
42 static const char *jit_reader_dir
= NULL
;
44 static const struct objfile_data
*jit_objfile_data
;
46 static const char *const jit_break_name
= "__jit_debug_register_code";
48 static const char *const jit_descriptor_name
= "__jit_debug_descriptor";
50 static const struct inferior_data
*jit_inferior_data
= NULL
;
52 static void jit_inferior_init (struct gdbarch
*gdbarch
);
54 /* An unwinder is registered for every gdbarch. This key is used to
55 remember if the unwinder has been registered for a particular
58 static struct gdbarch_data
*jit_gdbarch_data
;
60 /* Non-zero if we want to see trace of jit level stuff. */
62 static int jit_debug
= 0;
65 show_jit_debug (struct ui_file
*file
, int from_tty
,
66 struct cmd_list_element
*c
, const char *value
)
68 fprintf_filtered (file
, _("JIT debugging is %s.\n"), value
);
77 /* Openning the file is a no-op. */
80 mem_bfd_iovec_open (struct bfd
*abfd
, void *open_closure
)
85 /* Closing the file is just freeing the base/size pair on our side. */
88 mem_bfd_iovec_close (struct bfd
*abfd
, void *stream
)
94 /* For reading the file, we just need to pass through to target_read_memory and
95 fix up the arguments and return values. */
98 mem_bfd_iovec_pread (struct bfd
*abfd
, void *stream
, void *buf
,
99 file_ptr nbytes
, file_ptr offset
)
102 struct target_buffer
*buffer
= (struct target_buffer
*) stream
;
104 /* If this read will read all of the file, limit it to just the rest. */
105 if (offset
+ nbytes
> buffer
->size
)
106 nbytes
= buffer
->size
- offset
;
108 /* If there are no more bytes left, we've reached EOF. */
112 err
= target_read_memory (buffer
->base
+ offset
, (gdb_byte
*) buf
, nbytes
);
119 /* For statting the file, we only support the st_size attribute. */
122 mem_bfd_iovec_stat (struct bfd
*abfd
, void *stream
, struct stat
*sb
)
124 struct target_buffer
*buffer
= (struct target_buffer
*) stream
;
126 sb
->st_size
= buffer
->size
;
130 /* One reader that has been loaded successfully, and can potentially be used to
133 static struct jit_reader
135 struct gdb_reader_funcs
*functions
;
137 } *loaded_jit_reader
= NULL
;
139 typedef struct gdb_reader_funcs
* (reader_init_fn_type
) (void);
140 static const char *reader_init_fn_sym
= "gdb_init_reader";
142 /* Try to load FILE_NAME as a JIT debug info reader. */
144 static struct jit_reader
*
145 jit_reader_load (const char *file_name
)
148 reader_init_fn_type
*init_fn
;
149 struct jit_reader
*new_reader
= NULL
;
150 struct gdb_reader_funcs
*funcs
= NULL
;
151 struct cleanup
*old_cleanups
;
154 fprintf_unfiltered (gdb_stdlog
, _("Opening shared object %s.\n"),
156 so
= gdb_dlopen (file_name
);
157 old_cleanups
= make_cleanup_dlclose (so
);
159 init_fn
= gdb_dlsym (so
, reader_init_fn_sym
);
161 error (_("Could not locate initialization function: %s."),
164 if (gdb_dlsym (so
, "plugin_is_GPL_compatible") == NULL
)
165 error (_("Reader not GPL compatible."));
168 if (funcs
->reader_version
!= GDB_READER_INTERFACE_VERSION
)
169 error (_("Reader version does not match GDB version."));
171 new_reader
= XZALLOC (struct jit_reader
);
172 new_reader
->functions
= funcs
;
173 new_reader
->handle
= so
;
175 discard_cleanups (old_cleanups
);
179 /* Provides the jit-reader-load command. */
182 jit_reader_load_command (char *args
, int from_tty
)
186 struct cleanup
*prev_cleanup
;
189 error (_("No reader name provided."));
191 if (loaded_jit_reader
!= NULL
)
192 error (_("JIT reader already loaded. Run jit-reader-unload first."));
194 so_name
= xstrprintf ("%s/%s", jit_reader_dir
, args
);
195 prev_cleanup
= make_cleanup (xfree
, so_name
);
197 loaded_jit_reader
= jit_reader_load (so_name
);
198 do_cleanups (prev_cleanup
);
201 /* Provides the jit-reader-unload command. */
204 jit_reader_unload_command (char *args
, int from_tty
)
206 if (!loaded_jit_reader
)
207 error (_("No JIT reader loaded."));
209 loaded_jit_reader
->functions
->destroy (loaded_jit_reader
->functions
);
211 gdb_dlclose (loaded_jit_reader
->handle
);
212 xfree (loaded_jit_reader
);
213 loaded_jit_reader
= NULL
;
216 /* Open a BFD from the target's memory. */
219 bfd_open_from_target_memory (CORE_ADDR addr
, ULONGEST size
, char *target
)
221 const char *filename
= xstrdup ("<in-memory>");
222 struct target_buffer
*buffer
= xmalloc (sizeof (struct target_buffer
));
226 return bfd_openr_iovec (filename
, target
,
234 /* Per-inferior structure recording the addresses in the inferior. */
236 struct jit_inferior_data
238 CORE_ADDR breakpoint_addr
; /* &__jit_debug_register_code() */
239 CORE_ADDR descriptor_addr
; /* &__jit_debug_descriptor */
242 /* Remember OBJFILE has been created for struct jit_code_entry located
243 at inferior address ENTRY. */
246 add_objfile_entry (struct objfile
*objfile
, CORE_ADDR entry
)
248 CORE_ADDR
*entry_addr_ptr
;
250 entry_addr_ptr
= xmalloc (sizeof (CORE_ADDR
));
251 *entry_addr_ptr
= entry
;
252 set_objfile_data (objfile
, jit_objfile_data
, entry_addr_ptr
);
255 /* Return jit_inferior_data for current inferior. Allocate if not already
258 static struct jit_inferior_data
*
259 get_jit_inferior_data (void)
261 struct inferior
*inf
;
262 struct jit_inferior_data
*inf_data
;
264 inf
= current_inferior ();
265 inf_data
= inferior_data (inf
, jit_inferior_data
);
266 if (inf_data
== NULL
)
268 inf_data
= XZALLOC (struct jit_inferior_data
);
269 set_inferior_data (inf
, jit_inferior_data
, inf_data
);
276 jit_inferior_data_cleanup (struct inferior
*inf
, void *arg
)
281 /* Helper function for reading the global JIT descriptor from remote
285 jit_read_descriptor (struct gdbarch
*gdbarch
,
286 struct jit_descriptor
*descriptor
,
287 CORE_ADDR descriptor_addr
)
290 struct type
*ptr_type
;
294 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
296 /* Figure out how big the descriptor is on the remote and how to read it. */
297 ptr_type
= builtin_type (gdbarch
)->builtin_data_ptr
;
298 ptr_size
= TYPE_LENGTH (ptr_type
);
299 desc_size
= 8 + 2 * ptr_size
; /* Two 32-bit ints and two pointers. */
300 desc_buf
= alloca (desc_size
);
302 /* Read the descriptor. */
303 err
= target_read_memory (descriptor_addr
, desc_buf
, desc_size
);
305 error (_("Unable to read JIT descriptor from remote memory!"));
307 /* Fix the endianness to match the host. */
308 descriptor
->version
= extract_unsigned_integer (&desc_buf
[0], 4, byte_order
);
309 descriptor
->action_flag
=
310 extract_unsigned_integer (&desc_buf
[4], 4, byte_order
);
311 descriptor
->relevant_entry
= extract_typed_address (&desc_buf
[8], ptr_type
);
312 descriptor
->first_entry
=
313 extract_typed_address (&desc_buf
[8 + ptr_size
], ptr_type
);
316 /* Helper function for reading a JITed code entry from remote memory. */
319 jit_read_code_entry (struct gdbarch
*gdbarch
,
320 CORE_ADDR code_addr
, struct jit_code_entry
*code_entry
)
323 struct type
*ptr_type
;
328 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
330 /* Figure out how big the entry is on the remote and how to read it. */
331 ptr_type
= builtin_type (gdbarch
)->builtin_data_ptr
;
332 ptr_size
= TYPE_LENGTH (ptr_type
);
333 entry_size
= 3 * ptr_size
+ 8; /* Three pointers and one 64-bit int. */
334 entry_buf
= alloca (entry_size
);
336 /* Read the entry. */
337 err
= target_read_memory (code_addr
, entry_buf
, entry_size
);
339 error (_("Unable to read JIT code entry from remote memory!"));
341 /* Fix the endianness to match the host. */
342 ptr_type
= builtin_type (gdbarch
)->builtin_data_ptr
;
343 code_entry
->next_entry
= extract_typed_address (&entry_buf
[0], ptr_type
);
344 code_entry
->prev_entry
=
345 extract_typed_address (&entry_buf
[ptr_size
], ptr_type
);
346 code_entry
->symfile_addr
=
347 extract_typed_address (&entry_buf
[2 * ptr_size
], ptr_type
);
349 align_bytes
= gdbarch_long_long_align_bit (gdbarch
) / 8;
351 off
= (off
+ (align_bytes
- 1)) & ~(align_bytes
- 1);
353 code_entry
->symfile_size
=
354 extract_unsigned_integer (&entry_buf
[off
], 8, byte_order
);
357 /* Proxy object for building a block. */
361 /* gdb_blocks are linked into a tree structure. Next points to the
362 next node at the same depth as this block and parent to the
364 struct gdb_block
*next
, *parent
;
366 /* Points to the "real" block that is being built out of this
367 instance. This block will be added to a blockvector, which will
368 then be added to a symtab. */
369 struct block
*real_block
;
371 /* The first and last code address corresponding to this block. */
372 CORE_ADDR begin
, end
;
374 /* The name of this block (if any). If this is non-NULL, the
375 FUNCTION symbol symbol is set to this value. */
379 /* Proxy object for building a symtab. */
383 /* The list of blocks in this symtab. These will eventually be
384 converted to real blocks. */
385 struct gdb_block
*blocks
;
387 /* The number of blocks inserted. */
390 /* A mapping between line numbers to PC. */
391 struct linetable
*linetable
;
393 /* The source file for this symtab. */
394 const char *file_name
;
395 struct gdb_symtab
*next
;
398 /* Proxy object for building an object. */
402 struct gdb_symtab
*symtabs
;
405 /* The type of the `private' data passed around by the callback
408 typedef CORE_ADDR jit_dbg_reader_data
;
410 /* The reader calls into this function to read data off the targets
413 static enum gdb_status
414 jit_target_read_impl (GDB_CORE_ADDR target_mem
, void *gdb_buf
, int len
)
416 int result
= target_read_memory ((CORE_ADDR
) target_mem
, gdb_buf
, len
);
423 /* The reader calls into this function to create a new gdb_object
424 which it can then pass around to the other callbacks. Right now,
425 all that is required is allocating the memory. */
427 static struct gdb_object
*
428 jit_object_open_impl (struct gdb_symbol_callbacks
*cb
)
430 /* CB is not required right now, but sometime in the future we might
431 need a handle to it, and we'd like to do that without breaking
433 return XZALLOC (struct gdb_object
);
436 /* Readers call into this function to open a new gdb_symtab, which,
437 again, is passed around to other callbacks. */
439 static struct gdb_symtab
*
440 jit_symtab_open_impl (struct gdb_symbol_callbacks
*cb
,
441 struct gdb_object
*object
,
442 const char *file_name
)
444 struct gdb_symtab
*ret
;
446 /* CB stays unused. See comment in jit_object_open_impl. */
448 ret
= XZALLOC (struct gdb_symtab
);
449 ret
->file_name
= file_name
? xstrdup (file_name
) : xstrdup ("");
450 ret
->next
= object
->symtabs
;
451 object
->symtabs
= ret
;
455 /* Returns true if the block corresponding to old should be placed
456 before the block corresponding to new in the final blockvector. */
459 compare_block (const struct gdb_block
*const old
,
460 const struct gdb_block
*const new)
464 if (old
->begin
< new->begin
)
466 else if (old
->begin
== new->begin
)
468 if (old
->end
> new->end
)
477 /* Called by readers to open a new gdb_block. This function also
478 inserts the new gdb_block in the correct place in the corresponding
481 static struct gdb_block
*
482 jit_block_open_impl (struct gdb_symbol_callbacks
*cb
,
483 struct gdb_symtab
*symtab
, struct gdb_block
*parent
,
484 GDB_CORE_ADDR begin
, GDB_CORE_ADDR end
, const char *name
)
486 struct gdb_block
*block
= XZALLOC (struct gdb_block
);
488 block
->next
= symtab
->blocks
;
489 block
->begin
= (CORE_ADDR
) begin
;
490 block
->end
= (CORE_ADDR
) end
;
491 block
->name
= name
? xstrdup (name
) : NULL
;
492 block
->parent
= parent
;
494 /* Ensure that the blocks are inserted in the correct (reverse of
495 the order expected by blockvector). */
496 if (compare_block (symtab
->blocks
, block
))
498 symtab
->blocks
= block
;
502 struct gdb_block
*i
= symtab
->blocks
;
506 /* Guaranteed to terminate, since compare_block (NULL, _)
508 if (compare_block (i
->next
, block
))
510 block
->next
= i
->next
;
521 /* Readers call this to add a line mapping (from PC to line number) to
525 jit_symtab_line_mapping_add_impl (struct gdb_symbol_callbacks
*cb
,
526 struct gdb_symtab
*stab
, int nlines
,
527 struct gdb_line_mapping
*map
)
534 stab
->linetable
= xmalloc (sizeof (struct linetable
)
535 + (nlines
- 1) * sizeof (struct linetable_entry
));
536 stab
->linetable
->nitems
= nlines
;
537 for (i
= 0; i
< nlines
; i
++)
539 stab
->linetable
->item
[i
].pc
= (CORE_ADDR
) map
[i
].pc
;
540 stab
->linetable
->item
[i
].line
= map
[i
].line
;
544 /* Called by readers to close a gdb_symtab. Does not need to do
545 anything as of now. */
548 jit_symtab_close_impl (struct gdb_symbol_callbacks
*cb
,
549 struct gdb_symtab
*stab
)
551 /* Right now nothing needs to be done here. We may need to do some
552 cleanup here in the future (again, without breaking the plugin
556 /* Transform STAB to a proper symtab, and add it it OBJFILE. */
559 finalize_symtab (struct gdb_symtab
*stab
, struct objfile
*objfile
)
561 struct symtab
*symtab
;
562 struct gdb_block
*gdb_block_iter
, *gdb_block_iter_tmp
;
563 struct block
*block_iter
;
564 int actual_nblocks
, i
, blockvector_size
;
565 CORE_ADDR begin
, end
;
567 actual_nblocks
= FIRST_LOCAL_BLOCK
+ stab
->nblocks
;
569 symtab
= allocate_symtab (stab
->file_name
, objfile
);
570 /* JIT compilers compile in memory. */
571 symtab
->dirname
= NULL
;
573 /* Copy over the linetable entry if one was provided. */
576 int size
= ((stab
->linetable
->nitems
- 1)
577 * sizeof (struct linetable_entry
)
578 + sizeof (struct linetable
));
579 LINETABLE (symtab
) = obstack_alloc (&objfile
->objfile_obstack
, size
);
580 memcpy (LINETABLE (symtab
), stab
->linetable
, size
);
584 LINETABLE (symtab
) = NULL
;
587 blockvector_size
= (sizeof (struct blockvector
)
588 + (actual_nblocks
- 1) * sizeof (struct block
*));
589 symtab
->blockvector
= obstack_alloc (&objfile
->objfile_obstack
,
592 /* (begin, end) will contain the PC range this entire blockvector
595 BLOCKVECTOR_MAP (symtab
->blockvector
) = NULL
;
596 begin
= stab
->blocks
->begin
;
597 end
= stab
->blocks
->end
;
598 BLOCKVECTOR_NBLOCKS (symtab
->blockvector
) = actual_nblocks
;
600 /* First run over all the gdb_block objects, creating a real block
601 object for each. Simultaneously, keep setting the real_block
603 for (i
= (actual_nblocks
- 1), gdb_block_iter
= stab
->blocks
;
604 i
>= FIRST_LOCAL_BLOCK
;
605 i
--, gdb_block_iter
= gdb_block_iter
->next
)
607 struct block
*new_block
= allocate_block (&objfile
->objfile_obstack
);
608 struct symbol
*block_name
= obstack_alloc (&objfile
->objfile_obstack
,
609 sizeof (struct symbol
));
611 BLOCK_DICT (new_block
) = dict_create_linear (&objfile
->objfile_obstack
,
613 /* The address range. */
614 BLOCK_START (new_block
) = (CORE_ADDR
) gdb_block_iter
->begin
;
615 BLOCK_END (new_block
) = (CORE_ADDR
) gdb_block_iter
->end
;
618 memset (block_name
, 0, sizeof (struct symbol
));
619 SYMBOL_DOMAIN (block_name
) = VAR_DOMAIN
;
620 SYMBOL_CLASS (block_name
) = LOC_BLOCK
;
621 SYMBOL_SYMTAB (block_name
) = symtab
;
622 SYMBOL_BLOCK_VALUE (block_name
) = new_block
;
624 block_name
->ginfo
.name
= obsavestring (gdb_block_iter
->name
,
625 strlen (gdb_block_iter
->name
),
626 &objfile
->objfile_obstack
);
628 BLOCK_FUNCTION (new_block
) = block_name
;
630 BLOCKVECTOR_BLOCK (symtab
->blockvector
, i
) = new_block
;
631 if (begin
> BLOCK_START (new_block
))
632 begin
= BLOCK_START (new_block
);
633 if (end
< BLOCK_END (new_block
))
634 end
= BLOCK_END (new_block
);
636 gdb_block_iter
->real_block
= new_block
;
639 /* Now add the special blocks. */
641 for (i
= 0; i
< FIRST_LOCAL_BLOCK
; i
++)
643 struct block
*new_block
= allocate_block (&objfile
->objfile_obstack
);
644 BLOCK_DICT (new_block
) = dict_create_linear (&objfile
->objfile_obstack
,
646 BLOCK_SUPERBLOCK (new_block
) = block_iter
;
647 block_iter
= new_block
;
649 BLOCK_START (new_block
) = (CORE_ADDR
) begin
;
650 BLOCK_END (new_block
) = (CORE_ADDR
) end
;
652 BLOCKVECTOR_BLOCK (symtab
->blockvector
, i
) = new_block
;
655 /* Fill up the superblock fields for the real blocks, using the
656 real_block fields populated earlier. */
657 for (gdb_block_iter
= stab
->blocks
;
659 gdb_block_iter
= gdb_block_iter
->next
)
661 if (gdb_block_iter
->parent
!= NULL
)
662 BLOCK_SUPERBLOCK (gdb_block_iter
->real_block
) =
663 gdb_block_iter
->parent
->real_block
;
667 gdb_block_iter
= stab
->blocks
;
669 for (gdb_block_iter
= stab
->blocks
, gdb_block_iter_tmp
= gdb_block_iter
->next
;
671 gdb_block_iter
= gdb_block_iter_tmp
)
673 xfree ((void *) gdb_block_iter
->name
);
674 xfree (gdb_block_iter
);
676 xfree (stab
->linetable
);
677 xfree ((char *) stab
->file_name
);
681 /* Called when closing a gdb_objfile. Converts OBJ to a proper
685 jit_object_close_impl (struct gdb_symbol_callbacks
*cb
,
686 struct gdb_object
*obj
)
688 struct gdb_symtab
*i
, *j
;
689 struct objfile
*objfile
;
690 jit_dbg_reader_data
*priv_data
;
692 priv_data
= cb
->priv_data
;
694 objfile
= allocate_objfile (NULL
, 0);
695 objfile
->gdbarch
= target_gdbarch
;
697 objfile
->msymbols
= obstack_alloc (&objfile
->objfile_obstack
,
698 sizeof (struct minimal_symbol
));
699 memset (objfile
->msymbols
, 0, sizeof (struct minimal_symbol
));
701 xfree (objfile
->name
);
702 objfile
->name
= xstrdup ("<< JIT compiled code >>");
705 for (i
= obj
->symtabs
; i
; i
= j
)
708 finalize_symtab (i
, objfile
);
710 add_objfile_entry (objfile
, *priv_data
);
714 /* Try to read CODE_ENTRY using the loaded jit reader (if any).
715 ENTRY_ADDR is the address of the struct jit_code_entry in the
716 inferior address space. */
719 jit_reader_try_read_symtab (struct jit_code_entry
*code_entry
,
720 CORE_ADDR entry_addr
)
724 struct jit_dbg_reader
*i
;
725 jit_dbg_reader_data priv_data
;
726 struct gdb_reader_funcs
*funcs
;
727 volatile struct gdb_exception e
;
728 struct gdb_symbol_callbacks callbacks
=
730 jit_object_open_impl
,
731 jit_symtab_open_impl
,
733 jit_symtab_close_impl
,
734 jit_object_close_impl
,
736 jit_symtab_line_mapping_add_impl
,
737 jit_target_read_impl
,
742 priv_data
= entry_addr
;
744 if (!loaded_jit_reader
)
747 gdb_mem
= xmalloc (code_entry
->symfile_size
);
750 TRY_CATCH (e
, RETURN_MASK_ALL
)
751 if (target_read_memory (code_entry
->symfile_addr
, gdb_mem
,
752 code_entry
->symfile_size
))
759 funcs
= loaded_jit_reader
->functions
;
760 if (funcs
->read (funcs
, &callbacks
, gdb_mem
, code_entry
->symfile_size
)
766 if (jit_debug
&& status
== 0)
767 fprintf_unfiltered (gdb_stdlog
,
768 "Could not read symtab using the loaded JIT reader.\n");
772 /* Try to read CODE_ENTRY using BFD. ENTRY_ADDR is the address of the
773 struct jit_code_entry in the inferior address space. */
776 jit_bfd_try_read_symtab (struct jit_code_entry
*code_entry
,
777 CORE_ADDR entry_addr
,
778 struct gdbarch
*gdbarch
)
781 struct section_addr_info
*sai
;
782 struct bfd_section
*sec
;
783 struct objfile
*objfile
;
784 struct cleanup
*old_cleanups
;
786 const struct bfd_arch_info
*b
;
789 fprintf_unfiltered (gdb_stdlog
,
790 "jit_register_code, symfile_addr = %s, "
791 "symfile_size = %s\n",
792 paddress (gdbarch
, code_entry
->symfile_addr
),
793 pulongest (code_entry
->symfile_size
));
795 nbfd
= bfd_open_from_target_memory (code_entry
->symfile_addr
,
796 code_entry
->symfile_size
, gnutarget
);
799 puts_unfiltered (_("Error opening JITed symbol file, ignoring it.\n"));
803 /* Check the format. NOTE: This initializes important data that GDB uses!
804 We would segfault later without this line. */
805 if (!bfd_check_format (nbfd
, bfd_object
))
807 printf_unfiltered (_("\
808 JITed symbol file is not an object file, ignoring it.\n"));
813 /* Check bfd arch. */
814 b
= gdbarch_bfd_arch_info (gdbarch
);
815 if (b
->compatible (b
, bfd_get_arch_info (nbfd
)) != b
)
816 warning (_("JITed object file architecture %s is not compatible "
817 "with target architecture %s."), bfd_get_arch_info
818 (nbfd
)->printable_name
, b
->printable_name
);
820 /* Read the section address information out of the symbol file. Since the
821 file is generated by the JIT at runtime, it should all of the absolute
822 addresses that we care about. */
823 sai
= alloc_section_addr_info (bfd_count_sections (nbfd
));
824 old_cleanups
= make_cleanup_free_section_addr_info (sai
);
826 for (sec
= nbfd
->sections
; sec
!= NULL
; sec
= sec
->next
)
827 if ((bfd_get_section_flags (nbfd
, sec
) & (SEC_ALLOC
|SEC_LOAD
)) != 0)
829 /* We assume that these virtual addresses are absolute, and do not
830 treat them as offsets. */
831 sai
->other
[i
].addr
= bfd_get_section_vma (nbfd
, sec
);
832 sai
->other
[i
].name
= xstrdup (bfd_get_section_name (nbfd
, sec
));
833 sai
->other
[i
].sectindex
= sec
->index
;
837 /* This call takes ownership of NBFD. It does not take ownership of SAI. */
838 objfile
= symbol_file_add_from_bfd (nbfd
, 0, sai
, OBJF_SHARED
, NULL
);
840 do_cleanups (old_cleanups
);
841 add_objfile_entry (objfile
, entry_addr
);
844 /* This function registers code associated with a JIT code entry. It uses the
845 pointer and size pair in the entry to read the symbol file from the remote
846 and then calls symbol_file_add_from_local_memory to add it as though it were
847 a symbol file added by the user. */
850 jit_register_code (struct gdbarch
*gdbarch
,
851 CORE_ADDR entry_addr
, struct jit_code_entry
*code_entry
)
854 const struct bfd_arch_info
*b
;
855 struct jit_inferior_data
*inf_data
= get_jit_inferior_data ();
858 fprintf_unfiltered (gdb_stdlog
,
859 "jit_register_code, symfile_addr = %s, "
860 "symfile_size = %s\n",
861 paddress (gdbarch
, code_entry
->symfile_addr
),
862 pulongest (code_entry
->symfile_size
));
864 success
= jit_reader_try_read_symtab (code_entry
, entry_addr
);
867 jit_bfd_try_read_symtab (code_entry
, entry_addr
, gdbarch
);
870 /* This function unregisters JITed code and frees the corresponding
874 jit_unregister_code (struct objfile
*objfile
)
876 free_objfile (objfile
);
879 /* Look up the objfile with this code entry address. */
881 static struct objfile
*
882 jit_find_objf_with_entry_addr (CORE_ADDR entry_addr
)
884 struct objfile
*objf
;
885 CORE_ADDR
*objf_entry_addr
;
889 objf_entry_addr
= (CORE_ADDR
*) objfile_data (objf
, jit_objfile_data
);
890 if (objf_entry_addr
!= NULL
&& *objf_entry_addr
== entry_addr
)
896 /* (Re-)Initialize the jit breakpoint if necessary.
897 Return 0 on success. */
900 jit_breakpoint_re_set_internal (struct gdbarch
*gdbarch
,
901 struct jit_inferior_data
*inf_data
)
903 if (inf_data
->breakpoint_addr
== 0)
905 struct minimal_symbol
*reg_symbol
;
907 /* Lookup the registration symbol. If it is missing, then we assume
908 we are not attached to a JIT. */
909 reg_symbol
= lookup_minimal_symbol (jit_break_name
, NULL
, NULL
);
910 if (reg_symbol
== NULL
)
912 inf_data
->breakpoint_addr
= SYMBOL_VALUE_ADDRESS (reg_symbol
);
913 if (inf_data
->breakpoint_addr
== 0)
916 /* If we have not read the jit descriptor yet (e.g. because the JITer
917 itself is in a shared library which just got loaded), do so now. */
918 if (inf_data
->descriptor_addr
== 0)
919 jit_inferior_init (gdbarch
);
925 fprintf_unfiltered (gdb_stdlog
,
926 "jit_breakpoint_re_set_internal, "
927 "breakpoint_addr = %s\n",
928 paddress (gdbarch
, inf_data
->breakpoint_addr
));
930 /* Put a breakpoint in the registration symbol. */
931 create_jit_event_breakpoint (gdbarch
, inf_data
->breakpoint_addr
);
936 /* The private data passed around in the frame unwind callback
939 struct jit_unwind_private
941 /* Cached register values. See jit_frame_sniffer to see how this
943 struct gdb_reg_value
**registers
;
945 /* The frame being unwound. */
946 struct frame_info
*this_frame
;
949 /* Sets the value of a particular register in this frame. */
952 jit_unwind_reg_set_impl (struct gdb_unwind_callbacks
*cb
, int dwarf_regnum
,
953 struct gdb_reg_value
*value
)
955 struct jit_unwind_private
*priv
;
958 priv
= cb
->priv_data
;
960 gdb_reg
= gdbarch_dwarf2_reg_to_regnum (get_frame_arch (priv
->this_frame
),
965 fprintf_unfiltered (gdb_stdlog
,
966 _("Could not recognize DWARF regnum %d"),
971 gdb_assert (priv
->registers
);
972 priv
->registers
[gdb_reg
] = value
;
976 reg_value_free_impl (struct gdb_reg_value
*value
)
981 /* Get the value of register REGNUM in the previous frame. */
983 static struct gdb_reg_value
*
984 jit_unwind_reg_get_impl (struct gdb_unwind_callbacks
*cb
, int regnum
)
986 struct jit_unwind_private
*priv
;
987 struct gdb_reg_value
*value
;
989 struct gdbarch
*frame_arch
;
991 priv
= cb
->priv_data
;
992 frame_arch
= get_frame_arch (priv
->this_frame
);
994 gdb_reg
= gdbarch_dwarf2_reg_to_regnum (frame_arch
, regnum
);
995 size
= register_size (frame_arch
, gdb_reg
);
996 value
= xmalloc (sizeof (struct gdb_reg_value
) + size
- 1);
997 value
->defined
= frame_register_read (priv
->this_frame
, gdb_reg
,
1000 value
->free
= reg_value_free_impl
;
1004 /* gdb_reg_value has a free function, which must be called on each
1005 saved register value. */
1008 jit_dealloc_cache (struct frame_info
*this_frame
, void *cache
)
1010 struct jit_unwind_private
*priv_data
= cache
;
1011 struct gdbarch
*frame_arch
;
1014 gdb_assert (priv_data
->registers
);
1015 frame_arch
= get_frame_arch (priv_data
->this_frame
);
1017 for (i
= 0; i
< gdbarch_num_regs (frame_arch
); i
++)
1018 if (priv_data
->registers
[i
] && priv_data
->registers
[i
]->free
)
1019 priv_data
->registers
[i
]->free (priv_data
->registers
[i
]);
1021 xfree (priv_data
->registers
);
1025 /* The frame sniffer for the pseudo unwinder.
1027 While this is nominally a frame sniffer, in the case where the JIT
1028 reader actually recognizes the frame, it does a lot more work -- it
1029 unwinds the frame and saves the corresponding register values in
1030 the cache. jit_frame_prev_register simply returns the saved
1034 jit_frame_sniffer (const struct frame_unwind
*self
,
1035 struct frame_info
*this_frame
, void **cache
)
1037 struct jit_inferior_data
*inf_data
;
1038 struct jit_unwind_private
*priv_data
;
1039 struct jit_dbg_reader
*iter
;
1040 struct gdb_unwind_callbacks callbacks
;
1041 struct gdb_reader_funcs
*funcs
;
1043 inf_data
= get_jit_inferior_data ();
1045 callbacks
.reg_get
= jit_unwind_reg_get_impl
;
1046 callbacks
.reg_set
= jit_unwind_reg_set_impl
;
1047 callbacks
.target_read
= jit_target_read_impl
;
1049 if (loaded_jit_reader
== NULL
)
1052 funcs
= loaded_jit_reader
->functions
;
1054 gdb_assert (!*cache
);
1056 *cache
= XZALLOC (struct jit_unwind_private
);
1058 priv_data
->registers
=
1059 XCALLOC (gdbarch_num_regs (get_frame_arch (this_frame
)),
1060 struct gdb_reg_value
*);
1061 priv_data
->this_frame
= this_frame
;
1063 callbacks
.priv_data
= priv_data
;
1065 /* Try to coax the provided unwinder to unwind the stack */
1066 if (funcs
->unwind (funcs
, &callbacks
) == GDB_SUCCESS
)
1069 fprintf_unfiltered (gdb_stdlog
, _("Successfully unwound frame using "
1074 fprintf_unfiltered (gdb_stdlog
, _("Could not unwind frame using "
1077 jit_dealloc_cache (this_frame
, *cache
);
1084 /* The frame_id function for the pseudo unwinder. Relays the call to
1085 the loaded plugin. */
1088 jit_frame_this_id (struct frame_info
*this_frame
, void **cache
,
1089 struct frame_id
*this_id
)
1091 struct jit_unwind_private
private;
1092 struct gdb_frame_id frame_id
;
1093 struct gdb_reader_funcs
*funcs
;
1094 struct gdb_unwind_callbacks callbacks
;
1096 private.registers
= NULL
;
1097 private.this_frame
= this_frame
;
1099 /* We don't expect the frame_id function to set any registers, so we
1100 set reg_set to NULL. */
1101 callbacks
.reg_get
= jit_unwind_reg_get_impl
;
1102 callbacks
.reg_set
= NULL
;
1103 callbacks
.target_read
= jit_target_read_impl
;
1104 callbacks
.priv_data
= &private;
1106 gdb_assert (loaded_jit_reader
);
1107 funcs
= loaded_jit_reader
->functions
;
1109 frame_id
= funcs
->get_frame_id (funcs
, &callbacks
);
1110 *this_id
= frame_id_build (frame_id
.stack_address
, frame_id
.code_address
);
1113 /* Pseudo unwinder function. Reads the previously fetched value for
1114 the register from the cache. */
1116 static struct value
*
1117 jit_frame_prev_register (struct frame_info
*this_frame
, void **cache
, int reg
)
1119 struct jit_unwind_private
*priv
= *cache
;
1120 struct gdb_reg_value
*value
;
1123 return frame_unwind_got_optimized (this_frame
, reg
);
1125 gdb_assert (priv
->registers
);
1126 value
= priv
->registers
[reg
];
1127 if (value
&& value
->defined
)
1128 return frame_unwind_got_bytes (this_frame
, reg
, value
->value
);
1130 return frame_unwind_got_optimized (this_frame
, reg
);
1133 /* Relay everything back to the unwinder registered by the JIT debug
1136 static const struct frame_unwind jit_frame_unwind
=
1139 default_frame_unwind_stop_reason
,
1141 jit_frame_prev_register
,
1148 /* This is the information that is stored at jit_gdbarch_data for each
1151 struct jit_gdbarch_data_type
1153 /* Has the (pseudo) unwinder been prepended? */
1154 int unwinder_registered
;
1157 /* Check GDBARCH and prepend the pseudo JIT unwinder if needed. */
1160 jit_prepend_unwinder (struct gdbarch
*gdbarch
)
1162 struct jit_gdbarch_data_type
*data
;
1164 data
= gdbarch_data (gdbarch
, jit_gdbarch_data
);
1165 if (!data
->unwinder_registered
)
1167 frame_unwind_prepend_unwinder (gdbarch
, &jit_frame_unwind
);
1168 data
->unwinder_registered
= 1;
1172 /* Register any already created translations. */
1175 jit_inferior_init (struct gdbarch
*gdbarch
)
1177 struct jit_descriptor descriptor
;
1178 struct jit_code_entry cur_entry
;
1179 struct jit_inferior_data
*inf_data
;
1180 CORE_ADDR cur_entry_addr
;
1183 fprintf_unfiltered (gdb_stdlog
, "jit_inferior_init\n");
1185 jit_prepend_unwinder (gdbarch
);
1187 inf_data
= get_jit_inferior_data ();
1188 if (jit_breakpoint_re_set_internal (gdbarch
, inf_data
) != 0)
1191 if (inf_data
->descriptor_addr
== 0)
1193 struct minimal_symbol
*desc_symbol
;
1195 /* Lookup the descriptor symbol and cache the addr. If it is
1196 missing, we assume we are not attached to a JIT and return early. */
1197 desc_symbol
= lookup_minimal_symbol (jit_descriptor_name
, NULL
, NULL
);
1198 if (desc_symbol
== NULL
)
1201 inf_data
->descriptor_addr
= SYMBOL_VALUE_ADDRESS (desc_symbol
);
1202 if (inf_data
->descriptor_addr
== 0)
1207 fprintf_unfiltered (gdb_stdlog
,
1208 "jit_inferior_init, descriptor_addr = %s\n",
1209 paddress (gdbarch
, inf_data
->descriptor_addr
));
1211 /* Read the descriptor so we can check the version number and load
1212 any already JITed functions. */
1213 jit_read_descriptor (gdbarch
, &descriptor
, inf_data
->descriptor_addr
);
1215 /* Check that the version number agrees with that we support. */
1216 if (descriptor
.version
!= 1)
1217 error (_("Unsupported JIT protocol version in descriptor!"));
1219 /* If we've attached to a running program, we need to check the descriptor
1220 to register any functions that were already generated. */
1221 for (cur_entry_addr
= descriptor
.first_entry
;
1222 cur_entry_addr
!= 0;
1223 cur_entry_addr
= cur_entry
.next_entry
)
1225 jit_read_code_entry (gdbarch
, cur_entry_addr
, &cur_entry
);
1227 /* This hook may be called many times during setup, so make sure we don't
1228 add the same symbol file twice. */
1229 if (jit_find_objf_with_entry_addr (cur_entry_addr
) != NULL
)
1232 jit_register_code (gdbarch
, cur_entry_addr
, &cur_entry
);
1236 /* Exported routine to call when an inferior has been created. */
1239 jit_inferior_created_hook (void)
1241 jit_inferior_init (target_gdbarch
);
1244 /* Exported routine to call to re-set the jit breakpoints,
1245 e.g. when a program is rerun. */
1248 jit_breakpoint_re_set (void)
1250 jit_breakpoint_re_set_internal (target_gdbarch
,
1251 get_jit_inferior_data ());
1254 /* Reset inferior_data, so sybols will be looked up again, and jit_breakpoint
1258 jit_reset_inferior_data_and_breakpoints (void)
1260 struct jit_inferior_data
*inf_data
;
1262 /* Force jit_inferior_init to re-lookup of jit symbol addresses. */
1263 inf_data
= get_jit_inferior_data ();
1264 inf_data
->breakpoint_addr
= 0;
1265 inf_data
->descriptor_addr
= 0;
1267 /* Remove any existing JIT breakpoint(s). */
1268 remove_jit_event_breakpoints ();
1270 jit_inferior_init (target_gdbarch
);
1273 /* Wrapper to match the observer function pointer prototype. */
1276 jit_inferior_created_observer (struct target_ops
*objfile
, int from_tty
)
1278 jit_reset_inferior_data_and_breakpoints ();
1281 /* This function cleans up any code entries left over when the
1282 inferior exits. We get left over code when the inferior exits
1283 without unregistering its code, for example when it crashes. */
1286 jit_inferior_exit_hook (struct inferior
*inf
)
1288 struct objfile
*objf
;
1289 struct objfile
*temp
;
1291 ALL_OBJFILES_SAFE (objf
, temp
)
1292 if (objfile_data (objf
, jit_objfile_data
) != NULL
)
1293 jit_unregister_code (objf
);
1297 jit_executable_changed_observer (void)
1299 jit_reset_inferior_data_and_breakpoints ();
1303 jit_event_handler (struct gdbarch
*gdbarch
)
1305 struct jit_descriptor descriptor
;
1306 struct jit_code_entry code_entry
;
1307 CORE_ADDR entry_addr
;
1308 struct objfile
*objf
;
1310 /* Read the descriptor from remote memory. */
1311 jit_read_descriptor (gdbarch
, &descriptor
,
1312 get_jit_inferior_data ()->descriptor_addr
);
1313 entry_addr
= descriptor
.relevant_entry
;
1315 /* Do the corresponding action. */
1316 switch (descriptor
.action_flag
)
1321 jit_read_code_entry (gdbarch
, entry_addr
, &code_entry
);
1322 jit_register_code (gdbarch
, entry_addr
, &code_entry
);
1324 case JIT_UNREGISTER
:
1325 objf
= jit_find_objf_with_entry_addr (entry_addr
);
1327 printf_unfiltered (_("Unable to find JITed code "
1328 "entry at address: %s\n"),
1329 paddress (gdbarch
, entry_addr
));
1331 jit_unregister_code (objf
);
1335 error (_("Unknown action_flag value in JIT descriptor!"));
1340 /* Called to free the data allocated to the jit_inferior_data slot. */
1343 free_objfile_data (struct objfile
*objfile
, void *data
)
1348 /* Initialize the jit_gdbarch_data slot with an instance of struct
1349 jit_gdbarch_data_type */
1352 jit_gdbarch_data_init (struct obstack
*obstack
)
1354 struct jit_gdbarch_data_type
*data
;
1356 data
= obstack_alloc (obstack
, sizeof (struct jit_gdbarch_data_type
));
1357 data
->unwinder_registered
= 0;
1361 /* Provide a prototype to silence -Wmissing-prototypes. */
1363 extern void _initialize_jit (void);
1366 _initialize_jit (void)
1368 jit_reader_dir
= relocate_gdb_directory (JIT_READER_DIR
,
1369 JIT_READER_DIR_RELOCATABLE
);
1370 add_setshow_zinteger_cmd ("jit", class_maintenance
, &jit_debug
,
1371 _("Set JIT debugging."),
1372 _("Show JIT debugging."),
1373 _("When non-zero, JIT debugging is enabled."),
1376 &setdebuglist
, &showdebuglist
);
1378 observer_attach_inferior_created (jit_inferior_created_observer
);
1379 observer_attach_inferior_exit (jit_inferior_exit_hook
);
1380 observer_attach_executable_changed (jit_executable_changed_observer
);
1382 register_objfile_data_with_cleanup (NULL
, free_objfile_data
);
1384 register_inferior_data_with_cleanup (jit_inferior_data_cleanup
);
1385 jit_gdbarch_data
= gdbarch_data_register_pre_init (jit_gdbarch_data_init
);
1386 if (is_dl_available ())
1388 add_com ("jit-reader-load", no_class
, jit_reader_load_command
, _("\
1389 Load FILE as debug info reader and unwinder for JIT compiled code.\n\
1390 Usage: jit-reader-load FILE\n\
1391 Try to load file FILE as a debug info reader (and unwinder) for\n\
1392 JIT compiled code. The file is loaded from " JIT_READER_DIR
",\n\
1393 relocated relative to the GDB executable if required."));
1394 add_com ("jit-reader-unload", no_class
, jit_reader_unload_command
, _("\
1395 Unload the currently loaded JIT debug info reader.\n\
1396 Usage: jit-reader-unload FILE\n\n\
1397 Do \"help jit-reader-load\" for info on loading debug info readers."));