1 /* Load module for 'compile' command.
2 
3    Copyright (C) 2014-2020 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 #include "defs.h"
21 #include "compile-object-load.h"
22 #include "compile-internal.h"
23 #include "command.h"
24 #include "objfiles.h"
25 #include "gdbcore.h"
26 #include "readline/tilde.h"
27 #include "bfdlink.h"
28 #include "gdbcmd.h"
29 #include "regcache.h"
30 #include "inferior.h"
31 #include "gdbthread.h"
32 #include "compile.h"
33 #include "block.h"
34 #include "arch-utils.h"
35 #include <algorithm>
36 
37 /* Add inferior mmap memory range ADDR..ADDR+SIZE (exclusive) to the
38    list.  */
39 
40 void
add(CORE_ADDR addr,CORE_ADDR size)41 munmap_list::add (CORE_ADDR addr, CORE_ADDR size)
42 {
43   struct munmap_item item = { addr, size };
44   items.push_back (item);
45 }
46 
47 /* Destroy an munmap_list.  */
48 
~munmap_list()49 munmap_list::~munmap_list ()
50 {
51   for (auto &item : items)
52     {
53       try
54 	{
55 	  gdbarch_infcall_munmap (target_gdbarch (), item.addr, item.size);
56 	}
57       catch (const gdb_exception_error &ex)
58 	{
59 	  /* There's not much the user can do, so just ignore
60 	     this.  */
61 	}
62     }
63 }
64 
65 /* Helper data for setup_sections.  */
66 
67 struct setup_sections_data
68 {
69   /* Size of all recent sections with matching LAST_PROT.  */
70   CORE_ADDR last_size;
71 
72   /* First section matching LAST_PROT.  */
73   asection *last_section_first;
74 
75   /* Memory protection like the prot parameter of gdbarch_infcall_mmap. */
76   unsigned last_prot;
77 
78   /* Maximum of alignments of all sections matching LAST_PROT.
79      This value is always at least 1.  This value is always a power of 2.  */
80   CORE_ADDR last_max_alignment;
81 
82   /* List of inferior mmap ranges where setup_sections should add its
83      next range.  */
84   std::unique_ptr<struct munmap_list> munmap_list;
85 };
86 
87 /* Place all ABFD sections next to each other obeying all constraints.  */
88 
89 static void
setup_sections(bfd * abfd,asection * sect,void * data_voidp)90 setup_sections (bfd *abfd, asection *sect, void *data_voidp)
91 {
92   struct setup_sections_data *data = (struct setup_sections_data *) data_voidp;
93   CORE_ADDR alignment;
94   unsigned prot;
95 
96   if (sect != NULL)
97     {
98       /* It is required by later bfd_get_relocated_section_contents.  */
99       if (sect->output_section == NULL)
100 	sect->output_section = sect;
101 
102       if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
103 	return;
104 
105       /* Make the memory always readable.  */
106       prot = GDB_MMAP_PROT_READ;
107       if ((bfd_section_flags (sect) & SEC_READONLY) == 0)
108 	prot |= GDB_MMAP_PROT_WRITE;
109       if ((bfd_section_flags (sect) & SEC_CODE) != 0)
110 	prot |= GDB_MMAP_PROT_EXEC;
111 
112       if (compile_debug)
113 	fprintf_unfiltered (gdb_stdlog,
114 			    "module \"%s\" section \"%s\" size %s prot %u\n",
115 			    bfd_get_filename (abfd),
116 			    bfd_section_name (sect),
117 			    paddress (target_gdbarch (),
118 				      bfd_section_size (sect)),
119 			    prot);
120     }
121   else
122     prot = -1;
123 
124   if (sect == NULL
125       || (data->last_prot != prot && bfd_section_size (sect) != 0))
126     {
127       CORE_ADDR addr;
128       asection *sect_iter;
129 
130       if (data->last_size != 0)
131 	{
132 	  addr = gdbarch_infcall_mmap (target_gdbarch (), data->last_size,
133 				       data->last_prot);
134 	  data->munmap_list->add (addr, data->last_size);
135 	  if (compile_debug)
136 	    fprintf_unfiltered (gdb_stdlog,
137 				"allocated %s bytes at %s prot %u\n",
138 				paddress (target_gdbarch (), data->last_size),
139 				paddress (target_gdbarch (), addr),
140 				data->last_prot);
141 	}
142       else
143 	addr = 0;
144 
145       if ((addr & (data->last_max_alignment - 1)) != 0)
146 	error (_("Inferior compiled module address %s "
147 		 "is not aligned to BFD required %s."),
148 	       paddress (target_gdbarch (), addr),
149 	       paddress (target_gdbarch (), data->last_max_alignment));
150 
151       for (sect_iter = data->last_section_first; sect_iter != sect;
152 	   sect_iter = sect_iter->next)
153 	if ((bfd_section_flags (sect_iter) & SEC_ALLOC) != 0)
154 	  bfd_set_section_vma (sect_iter, addr + bfd_section_vma (sect_iter));
155 
156       data->last_size = 0;
157       data->last_section_first = sect;
158       data->last_prot = prot;
159       data->last_max_alignment = 1;
160     }
161 
162   if (sect == NULL)
163     return;
164 
165   alignment = ((CORE_ADDR) 1) << bfd_section_alignment (sect);
166   data->last_max_alignment = std::max (data->last_max_alignment, alignment);
167 
168   data->last_size = (data->last_size + alignment - 1) & -alignment;
169 
170   bfd_set_section_vma (sect, data->last_size);
171 
172   data->last_size += bfd_section_size (sect);
173   data->last_size = (data->last_size + alignment - 1) & -alignment;
174 }
175 
176 /* Helper for link_callbacks callbacks vector.  */
177 
178 static void
link_callbacks_multiple_definition(struct bfd_link_info * link_info,struct bfd_link_hash_entry * h,bfd * nbfd,asection * nsec,bfd_vma nval)179 link_callbacks_multiple_definition (struct bfd_link_info *link_info,
180 				    struct bfd_link_hash_entry *h, bfd *nbfd,
181 				    asection *nsec, bfd_vma nval)
182 {
183   bfd *abfd = link_info->input_bfds;
184 
185   if (link_info->allow_multiple_definition)
186     return;
187   warning (_("Compiled module \"%s\": multiple symbol definitions: %s"),
188 	   bfd_get_filename (abfd), h->root.string);
189 }
190 
191 /* Helper for link_callbacks callbacks vector.  */
192 
193 static void
link_callbacks_warning(struct bfd_link_info * link_info,const char * xwarning,const char * symbol,bfd * abfd,asection * section,bfd_vma address)194 link_callbacks_warning (struct bfd_link_info *link_info, const char *xwarning,
195                         const char *symbol, bfd *abfd, asection *section,
196 			bfd_vma address)
197 {
198   warning (_("Compiled module \"%s\" section \"%s\": warning: %s"),
199 	   bfd_get_filename (abfd), bfd_section_name (section),
200 	   xwarning);
201 }
202 
203 /* Helper for link_callbacks callbacks vector.  */
204 
205 static void
link_callbacks_undefined_symbol(struct bfd_link_info * link_info,const char * name,bfd * abfd,asection * section,bfd_vma address,bfd_boolean is_fatal)206 link_callbacks_undefined_symbol (struct bfd_link_info *link_info,
207 				 const char *name, bfd *abfd, asection *section,
208 				 bfd_vma address, bfd_boolean is_fatal)
209 {
210   warning (_("Cannot resolve relocation to \"%s\" "
211 	     "from compiled module \"%s\" section \"%s\"."),
212 	   name, bfd_get_filename (abfd), bfd_section_name (section));
213 }
214 
215 /* Helper for link_callbacks callbacks vector.  */
216 
217 static void
link_callbacks_reloc_overflow(struct bfd_link_info * link_info,struct bfd_link_hash_entry * entry,const char * name,const char * reloc_name,bfd_vma addend,bfd * abfd,asection * section,bfd_vma address)218 link_callbacks_reloc_overflow (struct bfd_link_info *link_info,
219 			       struct bfd_link_hash_entry *entry,
220 			       const char *name, const char *reloc_name,
221 			       bfd_vma addend, bfd *abfd, asection *section,
222 			       bfd_vma address)
223 {
224 }
225 
226 /* Helper for link_callbacks callbacks vector.  */
227 
228 static void
link_callbacks_reloc_dangerous(struct bfd_link_info * link_info,const char * message,bfd * abfd,asection * section,bfd_vma address)229 link_callbacks_reloc_dangerous (struct bfd_link_info *link_info,
230 				const char *message, bfd *abfd,
231 				asection *section, bfd_vma address)
232 {
233   warning (_("Compiled module \"%s\" section \"%s\": dangerous "
234 	     "relocation: %s\n"),
235 	   bfd_get_filename (abfd), bfd_section_name (section),
236 	   message);
237 }
238 
239 /* Helper for link_callbacks callbacks vector.  */
240 
241 static void
link_callbacks_unattached_reloc(struct bfd_link_info * link_info,const char * name,bfd * abfd,asection * section,bfd_vma address)242 link_callbacks_unattached_reloc (struct bfd_link_info *link_info,
243 				 const char *name, bfd *abfd, asection *section,
244 				 bfd_vma address)
245 {
246   warning (_("Compiled module \"%s\" section \"%s\": unattached "
247 	     "relocation: %s\n"),
248 	   bfd_get_filename (abfd), bfd_section_name (section),
249 	   name);
250 }
251 
252 /* Helper for link_callbacks callbacks vector.  */
253 
254 static void link_callbacks_einfo (const char *fmt, ...)
255   ATTRIBUTE_PRINTF (1, 2);
256 
257 static void
link_callbacks_einfo(const char * fmt,...)258 link_callbacks_einfo (const char *fmt, ...)
259 {
260   va_list ap;
261 
262   va_start (ap, fmt);
263   std::string str = string_vprintf (fmt, ap);
264   va_end (ap);
265 
266   warning (_("Compile module: warning: %s"), str.c_str ());
267 }
268 
269 /* Helper for bfd_get_relocated_section_contents.
270    Only these symbols are set by bfd_simple_get_relocated_section_contents
271    but bfd/ seems to use even the NULL ones without checking them first.  */
272 
273 static const struct bfd_link_callbacks link_callbacks =
274 {
275   NULL, /* add_archive_element */
276   link_callbacks_multiple_definition, /* multiple_definition */
277   NULL, /* multiple_common */
278   NULL, /* add_to_set */
279   NULL, /* constructor */
280   link_callbacks_warning, /* warning */
281   link_callbacks_undefined_symbol, /* undefined_symbol */
282   link_callbacks_reloc_overflow, /* reloc_overflow */
283   link_callbacks_reloc_dangerous, /* reloc_dangerous */
284   link_callbacks_unattached_reloc, /* unattached_reloc */
285   NULL, /* notice */
286   link_callbacks_einfo, /* einfo */
287   NULL, /* info */
288   NULL, /* minfo */
289   NULL, /* override_segment_assignment */
290 };
291 
292 struct link_hash_table_cleanup_data
293 {
link_hash_table_cleanup_datalink_hash_table_cleanup_data294   explicit link_hash_table_cleanup_data (bfd *abfd_)
295     : abfd (abfd_),
296       link_next (abfd->link.next)
297   {
298   }
299 
~link_hash_table_cleanup_datalink_hash_table_cleanup_data300   ~link_hash_table_cleanup_data ()
301   {
302     if (abfd->is_linker_output)
303       (*abfd->link.hash->hash_table_free) (abfd);
304     abfd->link.next = link_next;
305   }
306 
307   DISABLE_COPY_AND_ASSIGN (link_hash_table_cleanup_data);
308 
309 private:
310 
311   bfd *abfd;
312   bfd *link_next;
313 };
314 
315 /* Relocate and store into inferior memory each section SECT of ABFD.  */
316 
317 static void
copy_sections(bfd * abfd,asection * sect,void * data)318 copy_sections (bfd *abfd, asection *sect, void *data)
319 {
320   asymbol **symbol_table = (asymbol **) data;
321   bfd_byte *sect_data_got;
322   struct bfd_link_info link_info;
323   struct bfd_link_order link_order;
324   CORE_ADDR inferior_addr;
325 
326   if ((bfd_section_flags (sect) & (SEC_ALLOC | SEC_LOAD))
327       != (SEC_ALLOC | SEC_LOAD))
328     return;
329 
330   if (bfd_section_size (sect) == 0)
331     return;
332 
333   /* Mostly a copy of bfd_simple_get_relocated_section_contents which GDB
334      cannot use as it does not report relocations to undefined symbols.  */
335   memset (&link_info, 0, sizeof (link_info));
336   link_info.output_bfd = abfd;
337   link_info.input_bfds = abfd;
338   link_info.input_bfds_tail = &abfd->link.next;
339 
340   struct link_hash_table_cleanup_data cleanup_data (abfd);
341 
342   abfd->link.next = NULL;
343   link_info.hash = bfd_link_hash_table_create (abfd);
344 
345   link_info.callbacks = &link_callbacks;
346 
347   memset (&link_order, 0, sizeof (link_order));
348   link_order.next = NULL;
349   link_order.type = bfd_indirect_link_order;
350   link_order.offset = 0;
351   link_order.size = bfd_section_size (sect);
352   link_order.u.indirect.section = sect;
353 
354   gdb::unique_xmalloc_ptr<gdb_byte> sect_data
355     ((bfd_byte *) xmalloc (bfd_section_size (sect)));
356 
357   sect_data_got = bfd_get_relocated_section_contents (abfd, &link_info,
358 						      &link_order,
359 						      sect_data.get (),
360 						      FALSE, symbol_table);
361 
362   if (sect_data_got == NULL)
363     error (_("Cannot map compiled module \"%s\" section \"%s\": %s"),
364 	   bfd_get_filename (abfd), bfd_section_name (sect),
365 	   bfd_errmsg (bfd_get_error ()));
366   gdb_assert (sect_data_got == sect_data.get ());
367 
368   inferior_addr = bfd_section_vma (sect);
369   if (0 != target_write_memory (inferior_addr, sect_data.get (),
370 				bfd_section_size (sect)))
371     error (_("Cannot write compiled module \"%s\" section \"%s\" "
372 	     "to inferior memory range %s-%s."),
373 	   bfd_get_filename (abfd), bfd_section_name (sect),
374 	   paddress (target_gdbarch (), inferior_addr),
375 	   paddress (target_gdbarch (),
376 		     inferior_addr + bfd_section_size (sect)));
377 }
378 
379 /* Fetch the type of COMPILE_I_EXPR_PTR_TYPE and COMPILE_I_EXPR_VAL
380    symbols in OBJFILE so we can calculate how much memory to allocate
381    for the out parameter.  This avoids needing a malloc in the generated
382    code.  Throw an error if anything fails.
383    GDB first tries to compile the code with COMPILE_I_PRINT_ADDRESS_SCOPE.
384    If it finds user tries to print an array type this function returns
385    NULL.  Caller will then regenerate the code with
386    COMPILE_I_PRINT_VALUE_SCOPE, recompiles it again and finally runs it.
387    This is because __auto_type array-to-pointer type conversion of
388    COMPILE_I_EXPR_VAL which gets detected by COMPILE_I_EXPR_PTR_TYPE
389    preserving the array type.  */
390 
391 static struct type *
get_out_value_type(struct symbol * func_sym,struct objfile * objfile,enum compile_i_scope_types scope)392 get_out_value_type (struct symbol *func_sym, struct objfile *objfile,
393 		    enum compile_i_scope_types scope)
394 {
395   struct symbol *gdb_ptr_type_sym;
396   /* Initialize it just to avoid a GCC false warning.  */
397   struct symbol *gdb_val_sym = NULL;
398   struct type *gdb_ptr_type, *gdb_type_from_ptr, *gdb_type, *retval;
399   /* Initialize it just to avoid a GCC false warning.  */
400   const struct block *block = NULL;
401   const struct blockvector *bv;
402   int nblocks = 0;
403   int block_loop = 0;
404 
405   lookup_name_info func_matcher (GCC_FE_WRAPPER_FUNCTION,
406 				 symbol_name_match_type::SEARCH_NAME);
407 
408   bv = SYMTAB_BLOCKVECTOR (func_sym->owner.symtab);
409   nblocks = BLOCKVECTOR_NBLOCKS (bv);
410 
411   gdb_ptr_type_sym = NULL;
412   for (block_loop = 0; block_loop < nblocks; block_loop++)
413     {
414       struct symbol *function = NULL;
415       const struct block *function_block;
416 
417       block = BLOCKVECTOR_BLOCK (bv, block_loop);
418       if (BLOCK_FUNCTION (block) != NULL)
419 	continue;
420       gdb_val_sym = block_lookup_symbol (block,
421 					 COMPILE_I_EXPR_VAL,
422 					 symbol_name_match_type::SEARCH_NAME,
423 					 VAR_DOMAIN);
424       if (gdb_val_sym == NULL)
425 	continue;
426 
427       function_block = block;
428       while (function_block != BLOCKVECTOR_BLOCK (bv, STATIC_BLOCK)
429 	     && function_block != BLOCKVECTOR_BLOCK (bv, GLOBAL_BLOCK))
430 	{
431 	  function_block = BLOCK_SUPERBLOCK (function_block);
432 	  function = BLOCK_FUNCTION (function_block);
433 	  if (function != NULL)
434 	    break;
435 	}
436       if (function != NULL
437 	  && (BLOCK_SUPERBLOCK (function_block)
438 	      == BLOCKVECTOR_BLOCK (bv, STATIC_BLOCK))
439 	  && symbol_matches_search_name (function, func_matcher))
440 	break;
441     }
442   if (block_loop == nblocks)
443     error (_("No \"%s\" symbol found"), COMPILE_I_EXPR_VAL);
444 
445   gdb_type = SYMBOL_TYPE (gdb_val_sym);
446   gdb_type = check_typedef (gdb_type);
447 
448   gdb_ptr_type_sym = block_lookup_symbol (block, COMPILE_I_EXPR_PTR_TYPE,
449 					  symbol_name_match_type::SEARCH_NAME,
450 					  VAR_DOMAIN);
451   if (gdb_ptr_type_sym == NULL)
452     error (_("No \"%s\" symbol found"), COMPILE_I_EXPR_PTR_TYPE);
453   gdb_ptr_type = SYMBOL_TYPE (gdb_ptr_type_sym);
454   gdb_ptr_type = check_typedef (gdb_ptr_type);
455   if (gdb_ptr_type->code () != TYPE_CODE_PTR)
456     error (_("Type of \"%s\" is not a pointer"), COMPILE_I_EXPR_PTR_TYPE);
457   gdb_type_from_ptr = check_typedef (TYPE_TARGET_TYPE (gdb_ptr_type));
458 
459   if (types_deeply_equal (gdb_type, gdb_type_from_ptr))
460     {
461       if (scope != COMPILE_I_PRINT_ADDRESS_SCOPE)
462 	error (_("Expected address scope in compiled module \"%s\"."),
463 	       objfile_name (objfile));
464       return gdb_type;
465     }
466 
467   if (gdb_type->code () != TYPE_CODE_PTR)
468     error (_("Invalid type code %d of symbol \"%s\" "
469 	     "in compiled module \"%s\"."),
470 	   gdb_type_from_ptr->code (), COMPILE_I_EXPR_VAL,
471 	   objfile_name (objfile));
472 
473   retval = gdb_type_from_ptr;
474   switch (gdb_type_from_ptr->code ())
475     {
476     case TYPE_CODE_ARRAY:
477       gdb_type_from_ptr = TYPE_TARGET_TYPE (gdb_type_from_ptr);
478       break;
479     case TYPE_CODE_FUNC:
480       break;
481     default:
482       error (_("Invalid type code %d of symbol \"%s\" "
483 	       "in compiled module \"%s\"."),
484 	     gdb_type_from_ptr->code (), COMPILE_I_EXPR_PTR_TYPE,
485 	     objfile_name (objfile));
486     }
487   if (!types_deeply_equal (gdb_type_from_ptr,
488 			   TYPE_TARGET_TYPE (gdb_type)))
489     error (_("Referenced types do not match for symbols \"%s\" and \"%s\" "
490 	     "in compiled module \"%s\"."),
491 	   COMPILE_I_EXPR_PTR_TYPE, COMPILE_I_EXPR_VAL,
492 	   objfile_name (objfile));
493   if (scope == COMPILE_I_PRINT_ADDRESS_SCOPE)
494     return NULL;
495   return retval;
496 }
497 
498 /* Fetch the type of first parameter of FUNC_SYM.
499    Return NULL if FUNC_SYM has no parameters.  Throw an error otherwise.  */
500 
501 static struct type *
get_regs_type(struct symbol * func_sym,struct objfile * objfile)502 get_regs_type (struct symbol *func_sym, struct objfile *objfile)
503 {
504   struct type *func_type = SYMBOL_TYPE (func_sym);
505   struct type *regsp_type, *regs_type;
506 
507   /* No register parameter present.  */
508   if (func_type->num_fields () == 0)
509     return NULL;
510 
511   regsp_type = check_typedef (func_type->field (0).type ());
512   if (regsp_type->code () != TYPE_CODE_PTR)
513     error (_("Invalid type code %d of first parameter of function \"%s\" "
514 	     "in compiled module \"%s\"."),
515 	   regsp_type->code (), GCC_FE_WRAPPER_FUNCTION,
516 	   objfile_name (objfile));
517 
518   regs_type = check_typedef (TYPE_TARGET_TYPE (regsp_type));
519   if (regs_type->code () != TYPE_CODE_STRUCT)
520     error (_("Invalid type code %d of dereferenced first parameter "
521 	     "of function \"%s\" in compiled module \"%s\"."),
522 	   regs_type->code (), GCC_FE_WRAPPER_FUNCTION,
523 	   objfile_name (objfile));
524 
525   return regs_type;
526 }
527 
528 /* Store all inferior registers required by REGS_TYPE to inferior memory
529    starting at inferior address REGS_BASE.  */
530 
531 static void
store_regs(struct type * regs_type,CORE_ADDR regs_base)532 store_regs (struct type *regs_type, CORE_ADDR regs_base)
533 {
534   struct gdbarch *gdbarch = target_gdbarch ();
535   int fieldno;
536 
537   for (fieldno = 0; fieldno < regs_type->num_fields (); fieldno++)
538     {
539       const char *reg_name = TYPE_FIELD_NAME (regs_type, fieldno);
540       ULONGEST reg_bitpos = TYPE_FIELD_BITPOS (regs_type, fieldno);
541       ULONGEST reg_bitsize = TYPE_FIELD_BITSIZE (regs_type, fieldno);
542       ULONGEST reg_offset;
543       struct type *reg_type
544 	= check_typedef (regs_type->field (fieldno).type ());
545       ULONGEST reg_size = TYPE_LENGTH (reg_type);
546       int regnum;
547       struct value *regval;
548       CORE_ADDR inferior_addr;
549 
550       if (strcmp (reg_name, COMPILE_I_SIMPLE_REGISTER_DUMMY) == 0)
551 	continue;
552 
553       if ((reg_bitpos % 8) != 0 || reg_bitsize != 0)
554 	error (_("Invalid register \"%s\" position %s bits or size %s bits"),
555 	       reg_name, pulongest (reg_bitpos), pulongest (reg_bitsize));
556       reg_offset = reg_bitpos / 8;
557 
558       if (reg_type->code () != TYPE_CODE_INT
559 	  && reg_type->code () != TYPE_CODE_PTR)
560 	error (_("Invalid register \"%s\" type code %d"), reg_name,
561 	       reg_type->code ());
562 
563       regnum = compile_register_name_demangle (gdbarch, reg_name);
564 
565       regval = value_from_register (reg_type, regnum, get_current_frame ());
566       if (value_optimized_out (regval))
567 	error (_("Register \"%s\" is optimized out."), reg_name);
568       if (!value_entirely_available (regval))
569 	error (_("Register \"%s\" is not available."), reg_name);
570 
571       inferior_addr = regs_base + reg_offset;
572       if (0 != target_write_memory (inferior_addr, value_contents (regval),
573 				    reg_size))
574 	error (_("Cannot write register \"%s\" to inferior memory at %s."),
575 	       reg_name, paddress (gdbarch, inferior_addr));
576     }
577 }
578 
579 /* Load the object file specified in FILE_NAMES into inferior memory.
580    Throw an error otherwise.  Caller must fully dispose the return
581    value by calling compile_object_run.  Returns NULL only for
582    COMPILE_I_PRINT_ADDRESS_SCOPE when COMPILE_I_PRINT_VALUE_SCOPE
583    should have been used instead.  */
584 
585 struct compile_module *
compile_object_load(const compile_file_names & file_names,enum compile_i_scope_types scope,void * scope_data)586 compile_object_load (const compile_file_names &file_names,
587 		     enum compile_i_scope_types scope, void *scope_data)
588 {
589   struct setup_sections_data setup_sections_data;
590   CORE_ADDR regs_addr, out_value_addr = 0;
591   struct symbol *func_sym;
592   struct type *func_type;
593   struct bound_minimal_symbol bmsym;
594   long storage_needed;
595   asymbol **symbol_table, **symp;
596   long number_of_symbols, missing_symbols;
597   struct compile_module *retval;
598   struct type *regs_type, *out_value_type = NULL;
599   char **matching;
600   struct objfile *objfile;
601   int expect_parameters;
602   struct type *expect_return_type;
603 
604   gdb::unique_xmalloc_ptr<char> filename
605     (tilde_expand (file_names.object_file ()));
606 
607   gdb_bfd_ref_ptr abfd (gdb_bfd_open (filename.get (), gnutarget));
608   if (abfd == NULL)
609     error (_("\"%s\": could not open as compiled module: %s"),
610           filename.get (), bfd_errmsg (bfd_get_error ()));
611 
612   if (!bfd_check_format_matches (abfd.get (), bfd_object, &matching))
613     error (_("\"%s\": not in loadable format: %s"),
614 	   filename.get (),
615 	   gdb_bfd_errmsg (bfd_get_error (), matching).c_str ());
616 
617   if ((bfd_get_file_flags (abfd.get ()) & (EXEC_P | DYNAMIC)) != 0)
618     error (_("\"%s\": not in object format."), filename.get ());
619 
620   setup_sections_data.last_size = 0;
621   setup_sections_data.last_section_first = abfd->sections;
622   setup_sections_data.last_prot = -1;
623   setup_sections_data.last_max_alignment = 1;
624   setup_sections_data.munmap_list.reset (new struct munmap_list);
625 
626   bfd_map_over_sections (abfd.get (), setup_sections, &setup_sections_data);
627   setup_sections (abfd.get (), NULL, &setup_sections_data);
628 
629   storage_needed = bfd_get_symtab_upper_bound (abfd.get ());
630   if (storage_needed < 0)
631     error (_("Cannot read symbols of compiled module \"%s\": %s"),
632 	   filename.get (), bfd_errmsg (bfd_get_error ()));
633 
634   /* SYMFILE_VERBOSE is not passed even if FROM_TTY, user is not interested in
635      "Reading symbols from ..." message for automatically generated file.  */
636   objfile_up objfile_holder (symbol_file_add_from_bfd (abfd.get (),
637 						       filename.get (),
638 						       0, NULL, 0, NULL));
639   objfile = objfile_holder.get ();
640 
641   func_sym = lookup_global_symbol_from_objfile (objfile,
642 						GLOBAL_BLOCK,
643 						GCC_FE_WRAPPER_FUNCTION,
644 						VAR_DOMAIN).symbol;
645   if (func_sym == NULL)
646     error (_("Cannot find function \"%s\" in compiled module \"%s\"."),
647 	   GCC_FE_WRAPPER_FUNCTION, objfile_name (objfile));
648   func_type = SYMBOL_TYPE (func_sym);
649   if (func_type->code () != TYPE_CODE_FUNC)
650     error (_("Invalid type code %d of function \"%s\" in compiled "
651 	     "module \"%s\"."),
652 	   func_type->code (), GCC_FE_WRAPPER_FUNCTION,
653 	   objfile_name (objfile));
654 
655   switch (scope)
656     {
657     case COMPILE_I_SIMPLE_SCOPE:
658       expect_parameters = 1;
659       expect_return_type = builtin_type (target_gdbarch ())->builtin_void;
660       break;
661     case COMPILE_I_RAW_SCOPE:
662       expect_parameters = 0;
663       expect_return_type = builtin_type (target_gdbarch ())->builtin_void;
664       break;
665     case COMPILE_I_PRINT_ADDRESS_SCOPE:
666     case COMPILE_I_PRINT_VALUE_SCOPE:
667       expect_parameters = 2;
668       expect_return_type = builtin_type (target_gdbarch ())->builtin_void;
669       break;
670     default:
671       internal_error (__FILE__, __LINE__, _("invalid scope %d"), scope);
672     }
673   if (func_type->num_fields () != expect_parameters)
674     error (_("Invalid %d parameters of function \"%s\" in compiled "
675 	     "module \"%s\"."),
676 	   func_type->num_fields (), GCC_FE_WRAPPER_FUNCTION,
677 	   objfile_name (objfile));
678   if (!types_deeply_equal (expect_return_type, TYPE_TARGET_TYPE (func_type)))
679     error (_("Invalid return type of function \"%s\" in compiled "
680 	     "module \"%s\"."),
681 	   GCC_FE_WRAPPER_FUNCTION, objfile_name (objfile));
682 
683   /* The memory may be later needed
684      by bfd_generic_get_relocated_section_contents
685      called from default_symfile_relocate.  */
686   symbol_table = (asymbol **) obstack_alloc (&objfile->objfile_obstack,
687 					     storage_needed);
688   number_of_symbols = bfd_canonicalize_symtab (abfd.get (), symbol_table);
689   if (number_of_symbols < 0)
690     error (_("Cannot parse symbols of compiled module \"%s\": %s"),
691 	   filename.get (), bfd_errmsg (bfd_get_error ()));
692 
693   missing_symbols = 0;
694   for (symp = symbol_table; symp < symbol_table + number_of_symbols; symp++)
695     {
696       asymbol *sym = *symp;
697 
698       if (sym->flags != 0)
699 	continue;
700       sym->flags = BSF_GLOBAL;
701       sym->section = bfd_abs_section_ptr;
702       if (strcmp (sym->name, "_GLOBAL_OFFSET_TABLE_") == 0)
703 	{
704 	  if (compile_debug)
705 	    fprintf_unfiltered (gdb_stdlog,
706 				"ELF symbol \"%s\" relocated to zero\n",
707 				sym->name);
708 
709 	  /* It seems to be a GCC bug, with -mcmodel=large there should be no
710 	     need for _GLOBAL_OFFSET_TABLE_.  Together with -fPIE the data
711 	     remain PC-relative even with _GLOBAL_OFFSET_TABLE_ as zero.  */
712 	  sym->value = 0;
713 	  continue;
714 	}
715       bmsym = lookup_minimal_symbol (sym->name, NULL, NULL);
716       switch (bmsym.minsym == NULL
717 	      ? mst_unknown : MSYMBOL_TYPE (bmsym.minsym))
718 	{
719 	case mst_text:
720 	case mst_bss:
721 	case mst_data:
722 	  sym->value = BMSYMBOL_VALUE_ADDRESS (bmsym);
723 	  if (compile_debug)
724 	    fprintf_unfiltered (gdb_stdlog,
725 				"ELF mst_text symbol \"%s\" relocated to %s\n",
726 				sym->name,
727 				paddress (target_gdbarch (), sym->value));
728 	  break;
729 	case mst_text_gnu_ifunc:
730 	  sym->value = gnu_ifunc_resolve_addr (target_gdbarch (),
731 					       BMSYMBOL_VALUE_ADDRESS (bmsym));
732 	  if (compile_debug)
733 	    fprintf_unfiltered (gdb_stdlog,
734 				"ELF mst_text_gnu_ifunc symbol \"%s\" "
735 				"relocated to %s\n",
736 				sym->name,
737 				paddress (target_gdbarch (), sym->value));
738 	  break;
739 	default:
740 	  warning (_("Could not find symbol \"%s\" "
741 		     "for compiled module \"%s\"."),
742 		   sym->name, filename.get ());
743 	  missing_symbols++;
744 	}
745     }
746   if (missing_symbols)
747     error (_("%ld symbols were missing, cannot continue."), missing_symbols);
748 
749   bfd_map_over_sections (abfd.get (), copy_sections, symbol_table);
750 
751   regs_type = get_regs_type (func_sym, objfile);
752   if (regs_type == NULL)
753     regs_addr = 0;
754   else
755     {
756       /* Use read-only non-executable memory protection.  */
757       regs_addr = gdbarch_infcall_mmap (target_gdbarch (),
758 					TYPE_LENGTH (regs_type),
759 					GDB_MMAP_PROT_READ);
760       gdb_assert (regs_addr != 0);
761       setup_sections_data.munmap_list->add (regs_addr, TYPE_LENGTH (regs_type));
762       if (compile_debug)
763 	fprintf_unfiltered (gdb_stdlog,
764 			    "allocated %s bytes at %s for registers\n",
765 			    paddress (target_gdbarch (),
766 				      TYPE_LENGTH (regs_type)),
767 			    paddress (target_gdbarch (), regs_addr));
768       store_regs (regs_type, regs_addr);
769     }
770 
771   if (scope == COMPILE_I_PRINT_ADDRESS_SCOPE
772       || scope == COMPILE_I_PRINT_VALUE_SCOPE)
773     {
774       out_value_type = get_out_value_type (func_sym, objfile, scope);
775       if (out_value_type == NULL)
776 	return NULL;
777       check_typedef (out_value_type);
778       out_value_addr = gdbarch_infcall_mmap (target_gdbarch (),
779 					     TYPE_LENGTH (out_value_type),
780 					     (GDB_MMAP_PROT_READ
781 					      | GDB_MMAP_PROT_WRITE));
782       gdb_assert (out_value_addr != 0);
783       setup_sections_data.munmap_list->add (out_value_addr,
784 					    TYPE_LENGTH (out_value_type));
785       if (compile_debug)
786 	fprintf_unfiltered (gdb_stdlog,
787 			    "allocated %s bytes at %s for printed value\n",
788 			    paddress (target_gdbarch (),
789 				      TYPE_LENGTH (out_value_type)),
790 			    paddress (target_gdbarch (), out_value_addr));
791     }
792 
793   retval = XNEW (struct compile_module);
794   retval->objfile = objfile_holder.release ();
795   retval->source_file = xstrdup (file_names.source_file ());
796   retval->func_sym = func_sym;
797   retval->regs_addr = regs_addr;
798   retval->scope = scope;
799   retval->scope_data = scope_data;
800   retval->out_value_type = out_value_type;
801   retval->out_value_addr = out_value_addr;
802   retval->munmap_list_head = setup_sections_data.munmap_list.release ();
803 
804   return retval;
805 }
806