binutils-gdb/sim/ppc/debug.h
Pedro Alves a6760b6154 [sim/ppc] Fix printf_filtered reference
Building a gdb that includes the PPC sim in C++ mode fails to link with:

(...)s.o compile-object-load.o compile-object-run.o compile-loc2c.o compile-c-support.o inflow.o    init.o \
          ../sim/ppc/libsim.a ../readline/libreadline.a ../opcodes/libopcodes.a ../bfd/libbfd.a -lz  ../libiberty/libiberty.a ../libdecnumber/libdecnumber.a    -ldl -ldl -lncurses -lm -ldl  -lguile-2.0 -lgc  -lpthread -ldl -lutil -lm -lpython2.7 -Xlinker -export-dynamic -lexpat -llzma -lbabeltrace -lbabeltrace-ctf  ../libiberty/libiberty.a  build-gnulib/import/libgnu.a
../sim/ppc/libsim.a(sim_calls.o): In function `sim_open':
/home/pedro/gdb/mygit/cxx-convertion/src/sim/ppc/sim_calls.c:73: undefined reference to `printf_filtered'
/home/pedro/gdb/mygit/cxx-convertion/src/sim/ppc/sim_calls.c:73: undefined reference to `printf_filtered'
../sim/ppc/libsim.a(sim_calls.o): In function `sim_close':
/home/pedro/gdb/mygit/cxx-convertion/src/sim/ppc/sim_calls.c:93: undefined reference to `printf_filtered'
/home/pedro/gdb/mygit/cxx-convertion/src/sim/ppc/sim_calls.c:93: undefined reference to `printf_filtered'
../sim/ppc/libsim.a(sim_calls.o): In function `sim_load':
/home/pedro/gdb/mygit/cxx-convertion/src/sim/ppc/sim_calls.c:102: undefined reference to `printf_filtered'
../sim/ppc/libsim.a(sim_calls.o):/home/pedro/gdb/mygit/cxx-convertion/src/sim/ppc/sim_calls.c:102: more undefined references to `printf_filtered' follow
collect2: error: ld returned 1 exit status

The undefined references come from TRACE macro calls, which expand to
calls to printf_filtered.

But note that the sim's 'printf_filtered' is actually a #define to
'sim_io_printf_filtered', in sim_callbacks.h :

 #define printf_filtered sim_io_printf_filtered

AFAICS, this is not meant to call gdb's printf_filtered function.  The
ChangeLog entry that added the printf_filtered macro reads:

 Tue Jul 30 21:12:24 1996  Andrew Cagney  <cagney@kremvax.highland.com.au>

	 * sim_callbacks.h (sim_io_printf_filtered): Replace
	 printf_filtered with a local simulator specific version.  Add
	 #define printf_filtered to simplify updating of existing code.

That is, just another incomplete/partial transition.  Maybe prior to
1996 this was really meant to call gdb's printf_filtered version.

The reference to printf_filtered appears because sim_calls.c, the
compilation unit that fails to link, has this at the top:

 #undef printf_filtered /* blow away the mapping */

presumably so that this further below:

 void
 sim_io_printf_filtered(const char *fmt,
			...)
 {
   (...)
   callbacks->printf_filtered(callbacks, "%s", message);
 }

works.  So those TRACE macros instances in sim_calls.c just happen to
work because gdb is linked in, which satisfies the 'printf_filtered'
reference, when GDB is built in C mode.  When built in C++ mode, the
problem is exposed, as GDB's printf_filtered is mangled.

The fix here is to make the TRACE macro call sim_io_printf_filtered
directly.

(Standalone "run" doesn't fail to link simply because the offending
routines are not part of its link.)

sim/ppc/ChangeLog
2015-11-17  Pedro Alves  <palves@redhat.com>

	* debug.h (TRACE, ITRACE, DTRACE, DITRACE, PTRACE): Call
	sim_io_printf_filtered instead of printf_filtered.
2015-11-17 19:21:21 +00:00

174 lines
4.0 KiB
C

/* This file is part of the program psim.
Copyright (C) 1994-1997, Andrew Cagney <cagney@highland.com.au>
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 _DEBUG_H_
#define _DEBUG_H_
#include "filter_filename.h"
typedef enum {
trace_invalid,
trace_tbd,
/**/
trace_gdb,
trace_os_emul,
/**/
trace_events,
trace_device_tree,
trace_devices,
trace_binary_device,
trace_com_device,
trace_console_device,
trace_core_device,
trace_disk_device,
trace_eeprom_device,
trace_file_device,
trace_glue_device,
trace_halt_device,
trace_htab_device,
trace_icu_device,
trace_ide_device,
trace_memory_device,
trace_opic_device,
trace_pal_device,
trace_pass_device,
trace_phb_device,
trace_sem_device,
trace_shm_device,
trace_stack_device,
trace_register_device,
trace_vm_device,
/**/
trace_disklabel_package,
/**/
trace_semantics,
trace_idecode,
trace_alu,
trace_load_store,
trace_model,
/**/
trace_vm,
trace_core,
trace_interrupts,
trace_psim,
trace_device_init,
trace_cpu,
trace_breakpoint,
trace_opts,
trace_print_info,
trace_print_device_tree,
trace_dump_device_tree,
nr_trace_options
} trace_options;
extern int ppc_trace[nr_trace_options];
/* simple */
#define TRACE(OBJECT, ARGS) \
do { \
if (WITH_TRACE) { \
if (ppc_trace[OBJECT]) { \
sim_io_printf_filtered("%s:%d: ", filter_filename(__FILE__), __LINE__); \
sim_io_printf_filtered ARGS; \
} \
} \
} while (0)
/* issue */
#define ITRACE(OBJECT, ARGS) \
do { \
if (WITH_TRACE) { \
if (ppc_trace[OBJECT]) { \
sim_io_printf_filtered("%s:%d:0x%08lx:%s ", itable[MY_INDEX].file, itable[MY_INDEX].line_nr, (long)cia, itable[MY_INDEX].name); \
sim_io_printf_filtered ARGS; \
} \
} \
} while (0)
/* device */
#define DTRACE(OBJECT, ARGS) \
do { \
if (WITH_TRACE) { \
int trace_device = device_trace(me); \
if (ppc_trace[trace_devices] \
|| ppc_trace[trace_##OBJECT##_device] \
|| trace_device) { \
sim_io_printf_filtered("%s:%d:%s:%s%s ", \
filter_filename(__FILE__), __LINE__, #OBJECT, \
trace_device ? device_path(me) : "", \
trace_device ? ":" : ""); \
sim_io_printf_filtered ARGS; \
} \
} \
} while (0)
/* device instance */
#define DITRACE(OBJECT, ARGS) \
do { \
if (WITH_TRACE) { \
device *me = device_instance_device(instance); \
int trace_device = device_trace(me); \
if (ppc_trace[trace_devices] \
|| ppc_trace[trace_##OBJECT##_device] \
|| trace_device) { \
sim_io_printf_filtered("%s:%d:%s:%s%s ", \
filter_filename(__FILE__), __LINE__, #OBJECT, \
trace_device ? device_path(me) : "", \
trace_device ? ":" : ""); \
sim_io_printf_filtered ARGS; \
} \
} \
} while (0)
/* package */
#define PTRACE(OBJECT, ARGS) \
do { \
if (WITH_TRACE) { \
if (ppc_trace[trace_##OBJECT##_package]) { \
sim_io_printf_filtered("%s:%d:%s: ", filter_filename(__FILE__), __LINE__, #OBJECT); \
sim_io_printf_filtered ARGS; \
} \
} \
} while (0)
#define ASSERT(EXPRESSION) \
do { \
if (WITH_ASSERT) { \
if (!(EXPRESSION)) { \
error("%s:%d: assertion failed - %s\n", \
filter_filename(__FILE__), __LINE__, #EXPRESSION); \
} \
} \
} while (0)
/* Parse OPTION updating the trace array */
extern void
trace_option(const char *option, int setting);
/* Output the list of trace options */
extern void trace_usage
(int verbose);
#endif /* _DEBUG_H_ */