Skip to contentSkip to conversation

perf: Ensure symbols for plugins are exported

PATCH In review Mathias Krause 2 participants 5 messages Apr 12, 2015 – Apr 22, 2015 perf events

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 perf: Ensure symbols for plugins are exported

When building perf with perl or python support it implicitly gets linked with the -export-dynamic linker option through the additional linker flags, namely with -Wl,-E via perl or -Xlinker -export-dynamic via python. That flag is essential for the traceevent plugin support so we shouldn't rely on adding it implicitly.

Ensure perf's exported symbols can be used by dlopen()ed plugins by unconditionally adding this flag when linking perf. Otherwise plugins won't be able to access symbols in the perf binary.

This fixes the following warning / bug when trying to load plugins:

Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_xen.so' /home/minipli/.traceevent/plugins/plugin_xen.so: undefined symbol: trace_seq_printf
Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_function.so' /home/minipli/.traceevent/plugins/plugin_function.so: undefined symbol: warning
Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_sched_switch.so' /home/minipli/.traceevent/plugins/plugin_sched_switch.so: undefined symbol: pevent_unregister_event_handler [...]

Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Paul Mackerras <[email protected]>
Cc Peter Zijlstra <[email protected]>

---
This patch should go on top of tip.git#perf/core

 tools/perf/Makefile.perf |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
tools/perf/Makefile.perf +2 -1
index c43a20517591..2ab8525f366b 100644
@@ -250,7 +250,8 @@ ifdef ASCIIDOC8
   export ASCIIDOC8
 endif
 
-LIBS = -Wl,--whole-archive $(PERFLIBS) -Wl,--no-whole-archive -Wl,--start-group $(EXTLIBS) -Wl,--end-group
+LIBS  = -Wl,--export-dynamic -Wl,--whole-archive $(PERFLIBS) -Wl,--no-whole-archive
+LIBS += -Wl,--start-group $(EXTLIBS) -Wl,--end-group
 
 export INSTALL SHELL_PATH
 
Signature · 1 line
1.7.10.4
#1 lore raw
Quoted 12 lines · Mathias Krause

When building perf with perl or python support it implicitly gets linked with the -export-dynamic linker option through the additional linker flags, namely with -Wl,-E via perl or -Xlinker -export-dynamic via python. That flag is essential for the traceevent plugin support so we shouldn't rely on adding it implicitly.

Ensure perf's exported symbols can be used by dlopen()ed plugins by unconditionally adding this flag when linking perf. Otherwise plugins won't be able to access symbols in the perf binary.

This fixes the following warning / bug when trying to load plugins:

Quoted 7 lines

Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_xen.so' /home/minipli/.traceevent/plugins/plugin_xen.so: undefined symbol: trace_seq_printf
Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_function.so' /home/minipli/.traceevent/plugins/plugin_function.so: undefined symbol: warning
Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_sched_switch.so' /home/minipli/.traceevent/plugins/plugin_sched_switch.so: undefined symbol: pevent_unregister_event_handler [...]

hum, not sure now how -export-dynamic works but should this be rather in traceevent lib then?

jirka

#2 lore raw
Quoted 11 lines · Jiri Olsa
Quoted 10 lines · Mathias Krause

When building perf with perl or python support it implicitly gets linked with the -export-dynamic linker option through the additional linker flags, namely with -Wl,-E via perl or -Xlinker -export-dynamic via python. That flag is essential for the traceevent plugin support so we shouldn't rely on adding it implicitly.

Ensure perf's exported symbols can be used by dlopen()ed plugins by unconditionally adding this flag when linking perf. Otherwise plugins won't be able to access symbols in the perf binary.

Quoted 8 lines
Quoted 5 lines

This fixes the following warning / bug when trying to load plugins:

Warning: could not load plugin '/home/minipli/.traceevent/plugins/plugin_xen.so' /home/minipli/.traceevent/plugins/plugin_xen.so: undefined symbol: trace_seq_printf [...]

hum, not sure now how -export-dynamic works but should this be rather in traceevent lib then?

Nope. Here's the relevant excerpt from ld(1):

--export-dynamic
[...]
If you use "dlopen" to load a dynamic object which needs to refer back to the symbols defined by the program, rather than some other dynamic object, then you will probably need to use this option when linking the program itself.

So that flag has to be in the linker call for perf, as the plugins (which are dlopen()ed) want to access symbols within the perf binary (or more specific, within libperf.a / libtraceevent.a statically linked into perf).

Regards,
Mathias

Acked-by
#3 lore raw
Quoted 7 lines · Mathias Krause
Quoted 6 lines · Jiri Olsa
Quoted 5 lines · Mathias Krause

When building perf with perl or python support it implicitly gets linked with the -export-dynamic linker option through the additional linker flags, namely with -Wl,-E via perl or -Xlinker -export-dynamic via python. That flag is essential for the traceevent plugin support so we shouldn't rely on adding it implicitly.

I dont see the -E flag being added for perl on my setup, but I guess that could be different on each distro

maybe we should look for proper fix and export only needed symbols, anyway for this bugfix:

thanks,
jirka

#4 lore raw
Quoted 11 lines · Jiri Olsa
Quoted 7 lines · Mathias Krause
Quoted 6 lines · Jiri Olsa
Quoted 5 lines · Mathias Krause

When building perf with perl or python support it implicitly gets linked with the -export-dynamic linker option through the additional linker flags, namely with -Wl,-E via perl or -Xlinker -export-dynamic via python. That flag is essential for the traceevent plugin support so we shouldn't rely on adding it implicitly.

I dont see the -E flag being added for perl on my setup, but I guess that could be different on each distro

Yeah, seems so. On Debian I get the following:

$ perl -MExtUtils::Embed -e ldopts
-Wl,-E  -fstack-protector -L/usr/local/lib
-L/usr/lib/x86_64-linux-gnu/perl/5.20/CORE -lperl -ldl -lm -lpthread
-lc -lcrypt
$ python-config --ldflags
-L/usr/lib/python2.7/config-x86_64-linux-gnu -L/usr/lib -lpython2.7
-lpthread -ldl  -lutil -lm  -Xlinker -export-dynamic -Wl,-O1
-Wl,-Bsymbolic-functions

So, the -export-dynamic linker flag gets added by both -- perl and python.

However on CentOS 7 I don't see the -Wl,-E for perl either. But python still adds it. So the patch is even more needed as leaving out perf python support on such a distro would make it miss the flag, too.

Quoted 2 lines

maybe we should look for proper fix and export only needed symbols

Well, that would require maintaining a symbol file. Don't know if it's worth it :/

Quoted 3 lines

, anyway for this bugfix:

Thanks,
Mathias