2 // Copyright (C) 2005-2013 Red Hat Inc.
4 // This file is part of systemtap, and is free software. You can
5 // redistribute it and/or modify it under the terms of the GNU General
6 // Public License (GPL); either version 2, or (at your option) any
14 #include "translate.h"
25 #include <sys/types.h>
35 /* Adjust and run make_cmd to build a kernel module. */
37 run_make_cmd(systemtap_session
& s
, vector
<string
>& make_cmd
,
38 bool null_out
=false, bool null_err
=false)
40 assert_no_interrupts();
42 // PR14168: we used to unsetenv values here; instead do it via
43 // env(1) in make_any_make_cmd().
45 // Disable ccache to avoid saving files that will never be reused.
46 // (ccache is useless to us, because our compiler commands always
47 // include the randomized tmpdir path.)
48 // It's not critical if this fails, so the return is ignored.
49 (void) setenv("CCACHE_DISABLE", "1", 0);
52 make_cmd
.push_back("V=1");
53 else if (s
.verbose
> 1)
54 make_cmd
.push_back("--no-print-directory");
57 make_cmd
.push_back("-s");
58 make_cmd
.push_back("--no-print-directory");
61 // Exploit SMP parallelism, if available.
62 long smp
= sysconf(_SC_NPROCESSORS_ONLN
);
64 make_cmd
.push_back("-j" + lex_cast(smp
+1));
66 if (strverscmp (s
.kernel_base_release
.c_str(), "2.6.29") < 0)
68 // Older kernels, before linux commit #fd54f502841c1, include
69 // gratuitous "echo"s in their Makefile. We need to suppress
70 // that with this bluntness.
74 int rc
= stap_system (s
.verbose
, "kbuild", make_cmd
, null_out
, null_err
);
81 make_any_make_cmd(systemtap_session
& s
, const string
& dir
, const string
& target
)
83 vector
<string
> make_cmd
;
85 // PR14168: sanitize environment variables for kbuild invocation
86 make_cmd
.push_back("env");
87 make_cmd
.push_back("-uARCH");
88 make_cmd
.push_back("-uKBUILD_EXTMOD");
89 make_cmd
.push_back("-uCROSS_COMPILE");
90 make_cmd
.push_back("-uKBUILD_IMAGE");
91 make_cmd
.push_back("-uKCONFIG_CONFIG");
92 make_cmd
.push_back("-uINSTALL_PATH");
93 string newpath
= string("PATH=/usr/bin:/bin:") + (getenv("PATH") ?: "");
94 make_cmd
.push_back(newpath
.c_str());
96 make_cmd
.push_back("make");
97 make_cmd
.push_back("-C");
98 make_cmd
.push_back(s
.kernel_build_tree
);
99 make_cmd
.push_back("M=" + dir
); // need make-quoting?
100 make_cmd
.push_back(target
);
102 // Add architecture, except for old powerpc (RHBZ669082)
103 if (s
.architecture
!= "powerpc" ||
104 (strverscmp (s
.kernel_base_release
.c_str(), "2.6.15") >= 0))
105 make_cmd
.push_back("ARCH=" + s
.architecture
); // need make-quoting?
107 // PR13847: suppress debuginfo creation by default
108 make_cmd
.insert(make_cmd
.end(), "CONFIG_DEBUG_INFO=");
110 // Add any custom kbuild flags
111 make_cmd
.insert(make_cmd
.end(), s
.kbuildflags
.begin(), s
.kbuildflags
.end());
116 static vector
<string
>
117 make_make_cmd(systemtap_session
& s
, const string
& dir
)
119 return make_any_make_cmd(s
, dir
, "modules");
122 static vector
<string
>
123 make_make_objs_cmd(systemtap_session
& s
, const string
& dir
)
125 // Kbuild uses these rules to build external modules:
127 // module-dirs := $(addprefix _module_,$(KBUILD_EXTMOD))
128 // modules: $(module-dirs)
129 // @$(kecho) ' Building modules, stage 2.';
130 // $(Q)$(MAKE) -f $(srctree)/scripts/Makefile.modpost
132 // So if we're only interested in the stage 1 objects, we can
133 // cheat and make only the $(module-dirs) part.
134 return make_any_make_cmd(s
, dir
, "_module_" + dir
);
138 output_autoconf(systemtap_session
& s
, ofstream
& o
, const char *autoconf_c
,
139 const char *deftrue
, const char *deffalse
)
144 o
<< "if $(CHECK_BUILD) $(SYSTEMTAP_RUNTIME)/linux/" << autoconf_c
;
146 o
<< " > /dev/null 2>&1";
149 o
<< "echo \"#define " << deftrue
<< " 1\"";
151 o
<< "; else echo \"#define " << deffalse
<< " 1\"";
152 o
<< "; fi >> $@" << endl
;
156 void output_exportconf(systemtap_session
& s
, ofstream
& o
, const char *symbol
,
162 if (s
.kernel_exports
.find(symbol
) != s
.kernel_exports
.end())
163 o
<< "echo \"#define " << deftrue
<< " 1\"";
164 o
<< ">> $@" << endl
;
168 void output_dual_exportconf(systemtap_session
& s
, ofstream
& o
,
169 const char *symbol1
, const char *symbol2
,
175 if (s
.kernel_exports
.find(symbol1
) != s
.kernel_exports
.end()
176 && s
.kernel_exports
.find(symbol2
) != s
.kernel_exports
.end())
177 o
<< "echo \"#define " << deftrue
<< " 1\"";
178 o
<< ">> $@" << endl
;
182 void output_either_exportconf(systemtap_session
& s
, ofstream
& o
,
183 const char *symbol1
, const char *symbol2
,
189 if (s
.kernel_exports
.find(symbol1
) != s
.kernel_exports
.end()
190 || s
.kernel_exports
.find(symbol2
) != s
.kernel_exports
.end())
191 o
<< "echo \"#define " << deftrue
<< " 1\"";
192 o
<< ">> $@" << endl
;
197 compile_dyninst (systemtap_session
& s
)
199 const string module
= s
.tmpdir
+ "/" + s
.module_filename();
202 cmd
.push_back("gcc");
203 cmd
.push_back("--std=gnu99");
204 cmd
.push_back("-Wall");
205 cmd
.push_back("-Werror");
206 cmd
.push_back("-Wno-unused");
207 cmd
.push_back("-Wno-strict-aliasing");
209 // BZ855981/948279. Since dyninst/runtime.h includes __sync_* calls,
210 // the compiler may generate different code for it depending on -march.
211 // For example, if the default is i386, we may get references to auxiliary
212 // functions like __sync_add_and_fetch_4, which appear to be defined
213 // nowhere. We hack around this problem thusly:
214 if (s
.architecture
== "i386")
215 cmd
.push_back("-march=i586");
217 cmd
.push_back("-fvisibility=hidden");
218 cmd
.push_back("-O2");
219 cmd
.push_back("-I" + s
.runtime_path
);
220 cmd
.push_back("-D__DYNINST__");
221 for (size_t i
= 0; i
< s
.c_macros
.size(); ++i
)
222 cmd
.push_back("-D" + s
.c_macros
[i
]);
223 cmd
.push_back(s
.translated_source
);
224 cmd
.push_back("-pthread");
225 cmd
.push_back("-lrt");
226 cmd
.push_back("-fPIC");
227 cmd
.push_back("-shared");
229 cmd
.push_back(module
);
232 cmd
.push_back("-ftime-report");
236 int rc
= stap_system (s
.verbose
, cmd
);
244 compile_pass (systemtap_session
& s
)
246 if (s
.runtime_usermode_p())
247 return compile_dyninst (s
);
249 int rc
= uprobes_pass (s
);
256 // fill in a quick Makefile
257 string makefile_nm
= s
.tmpdir
+ "/Makefile";
258 ofstream
o (makefile_nm
.c_str());
262 // Clever hacks copied from vmware modules
265 superverbose
= "set -x;";
267 string redirecterrors
= "> /dev/null 2>&1";
271 // Support O= (or KBUILD_OUTPUT) option
272 o
<< "_KBUILD_CFLAGS := $(call flags,KBUILD_CFLAGS)" << endl
;
274 o
<< "stap_check_gcc = $(shell " << superverbose
<< " if $(CC) $(1) -S -o /dev/null -xc /dev/null > /dev/null 2>&1; then echo \"$(1)\"; else echo \"$(2)\"; fi)" << endl
;
275 o
<< "CHECK_BUILD := $(CC) $(NOSTDINC_FLAGS) $(KBUILD_CPPFLAGS) $(CPPFLAGS) $(LINUXINCLUDE) $(_KBUILD_CFLAGS) $(CFLAGS_KERNEL) $(EXTRA_CFLAGS) $(CFLAGS) -DKBUILD_BASENAME=\\\"" << s
.module_name
<< "\\\"" << (s
.omit_werror
? "" : " -Werror") << " -S -o /dev/null -xc " << endl
;
276 o
<< "stap_check_build = $(shell " << superverbose
<< " if $(CHECK_BUILD) $(1) " << redirecterrors
<< " ; then echo \"$(2)\"; else echo \"$(3)\"; fi)" << endl
;
278 o
<< "SYSTEMTAP_RUNTIME = \"" << s
.runtime_path
<< "\"" << endl
;
280 // "autoconf" options go here
282 // RHBZ 543529: early rhel6 kernels' module-signing kbuild logic breaks out-of-tree modules
283 o
<< "CONFIG_MODULE_SIG := n" << endl
;
285 string module_cflags
= "EXTRA_CFLAGS";
286 o
<< module_cflags
<< " :=" << endl
;
288 // XXX: This gruesome hack is needed on some kernels built with separate O=directory,
289 // where files like 2.6.27 x86's asm/mach-*/mach_mpspec.h are not found on the cpp path.
290 // This could be a bug in arch/x86/Makefile that names
291 // mflags-y += -Iinclude/asm-x86/mach-default
292 // but that path does not exist in an O= build tree.
293 o
<< module_cflags
<< " += -Iinclude2/asm/mach-default" << endl
;
294 if (s
.kernel_source_tree
!= "")
295 o
<< module_cflags
<< " += -I" + s
.kernel_source_tree
<< endl
;
298 // o << module_cflags << " += -Iusr/include" << endl;
299 // since such headers are cleansed of _KERNEL_ pieces that we need
301 o
<< "STAPCONF_HEADER := " << s
.tmpdir
<< "/" << s
.stapconf_name
<< endl
;
302 o
<< "$(STAPCONF_HEADER):" << endl
;
303 o
<< "\t@echo -n > $@" << endl
;
304 output_autoconf(s
, o
, "autoconf-hrtimer-rel.c", "STAPCONF_HRTIMER_REL", NULL
);
305 output_autoconf(s
, o
, "autoconf-generated-compile.c", "STAPCONF_GENERATED_COMPILE", NULL
);
306 output_autoconf(s
, o
, "autoconf-hrtimer-getset-expires.c", "STAPCONF_HRTIMER_GETSET_EXPIRES", NULL
);
307 output_autoconf(s
, o
, "autoconf-inode-private.c", "STAPCONF_INODE_PRIVATE", NULL
);
308 output_autoconf(s
, o
, "autoconf-constant-tsc.c", "STAPCONF_CONSTANT_TSC", NULL
);
309 output_autoconf(s
, o
, "autoconf-ktime-get-real.c", "STAPCONF_KTIME_GET_REAL", NULL
);
310 output_autoconf(s
, o
, "autoconf-x86-uniregs.c", "STAPCONF_X86_UNIREGS", NULL
);
311 output_autoconf(s
, o
, "autoconf-nameidata.c", "STAPCONF_NAMEIDATA_CLEANUP", NULL
);
312 output_dual_exportconf(s
, o
, "unregister_kprobes", "unregister_kretprobes", "STAPCONF_UNREGISTER_KPROBES");
313 output_autoconf(s
, o
, "autoconf-kprobe-symbol-name.c", "STAPCONF_KPROBE_SYMBOL_NAME", NULL
);
314 output_autoconf(s
, o
, "autoconf-real-parent.c", "STAPCONF_REAL_PARENT", NULL
);
315 output_autoconf(s
, o
, "autoconf-uaccess.c", "STAPCONF_LINUX_UACCESS_H", NULL
);
316 output_autoconf(s
, o
, "autoconf-oneachcpu-retry.c", "STAPCONF_ONEACHCPU_RETRY", NULL
);
317 output_autoconf(s
, o
, "autoconf-dpath-path.c", "STAPCONF_DPATH_PATH", NULL
);
318 output_exportconf(s
, o
, "synchronize_sched", "STAPCONF_SYNCHRONIZE_SCHED");
319 output_autoconf(s
, o
, "autoconf-task-uid.c", "STAPCONF_TASK_UID", NULL
);
320 output_dual_exportconf(s
, o
, "alloc_vm_area", "free_vm_area", "STAPCONF_VM_AREA");
321 output_autoconf(s
, o
, "autoconf-procfs-owner.c", "STAPCONF_PROCFS_OWNER", NULL
);
322 output_autoconf(s
, o
, "autoconf-alloc-percpu-align.c", "STAPCONF_ALLOC_PERCPU_ALIGN", NULL
);
323 output_autoconf(s
, o
, "autoconf-x86-gs.c", "STAPCONF_X86_GS", NULL
);
324 output_autoconf(s
, o
, "autoconf-grsecurity.c", "STAPCONF_GRSECURITY", NULL
);
325 output_autoconf(s
, o
, "autoconf-trace-printk.c", "STAPCONF_TRACE_PRINTK", NULL
);
326 output_autoconf(s
, o
, "autoconf-regset.c", "STAPCONF_REGSET", NULL
);
327 output_autoconf(s
, o
, "autoconf-utrace-regset.c", "STAPCONF_UTRACE_REGSET", NULL
);
328 output_autoconf(s
, o
, "autoconf-uprobe-get-pc.c", "STAPCONF_UPROBE_GET_PC", NULL
);
329 output_autoconf(s
, o
, "autoconf-hlist-4args.c", "STAPCONF_HLIST_4ARGS", NULL
);
330 output_exportconf(s
, o
, "tsc_khz", "STAPCONF_TSC_KHZ");
331 output_exportconf(s
, o
, "cpu_khz", "STAPCONF_CPU_KHZ");
332 output_exportconf(s
, o
, "__module_text_address", "STAPCONF_MODULE_TEXT_ADDRESS");
333 output_exportconf(s
, o
, "add_timer_on", "STAPCONF_ADD_TIMER_ON");
335 output_dual_exportconf(s
, o
, "probe_kernel_read", "probe_kernel_write", "STAPCONF_PROBE_KERNEL");
336 output_autoconf(s
, o
, "autoconf-hw_breakpoint_context.c",
337 "STAPCONF_HW_BREAKPOINT_CONTEXT", NULL
);
338 output_autoconf(s
, o
, "autoconf-save-stack-trace.c",
339 "STAPCONF_KERNEL_STACKTRACE", NULL
);
340 output_autoconf(s
, o
, "autoconf-save-stack-trace-no-bp.c",
341 "STAPCONF_KERNEL_STACKTRACE_NO_BP", NULL
);
342 output_autoconf(s
, o
, "autoconf-asm-syscall.c",
343 "STAPCONF_ASM_SYSCALL_H", NULL
);
344 output_autoconf(s
, o
, "autoconf-ring_buffer-flags.c", "STAPCONF_RING_BUFFER_FLAGS", NULL
);
345 output_autoconf(s
, o
, "autoconf-ring_buffer_lost_events.c", "STAPCONF_RING_BUFFER_LOST_EVENTS", NULL
);
346 output_autoconf(s
, o
, "autoconf-ring_buffer_read_prepare.c", "STAPCONF_RING_BUFFER_READ_PREPARE", NULL
);
347 output_autoconf(s
, o
, "autoconf-kallsyms-on-each-symbol.c", "STAPCONF_KALLSYMS_ON_EACH_SYMBOL", NULL
);
348 output_autoconf(s
, o
, "autoconf-walk-stack.c", "STAPCONF_WALK_STACK", NULL
);
349 output_autoconf(s
, o
, "autoconf-stacktrace_ops-warning.c",
350 "STAPCONF_STACKTRACE_OPS_WARNING", NULL
);
351 output_autoconf(s
, o
, "autoconf-mm-context-vdso.c", "STAPCONF_MM_CONTEXT_VDSO", NULL
);
352 output_autoconf(s
, o
, "autoconf-mm-context-vdso-base.c", "STAPCONF_MM_CONTEXT_VDSO_BASE", NULL
);
353 output_autoconf(s
, o
, "autoconf-blk-types.c", "STAPCONF_BLK_TYPES", NULL
);
354 output_autoconf(s
, o
, "autoconf-perf-structpid.c", "STAPCONF_PERF_STRUCTPID", NULL
);
355 output_autoconf(s
, o
, "perf_event_counter_context.c",
356 "STAPCONF_PERF_COUNTER_CONTEXT", NULL
);
357 output_autoconf(s
, o
, "perf_probe_handler_nmi.c",
358 "STAPCONF_PERF_HANDLER_NMI", NULL
);
359 output_exportconf(s
, o
, "path_lookup", "STAPCONF_PATH_LOOKUP");
360 output_exportconf(s
, o
, "kern_path_parent", "STAPCONF_KERN_PATH_PARENT");
361 output_exportconf(s
, o
, "vfs_path_lookup", "STAPCONF_VFS_PATH_LOOKUP");
362 output_exportconf(s
, o
, "proc_create_data", "STAPCONF_PROC_CREATE_DATA");
363 output_exportconf(s
, o
, "PDE_DATA", "STAPCONF_PDE_DATA");
364 output_autoconf(s
, o
, "autoconf-module-sect-attrs.c", "STAPCONF_MODULE_SECT_ATTRS", NULL
);
366 output_autoconf(s
, o
, "autoconf-utrace-via-tracepoints.c", "STAPCONF_UTRACE_VIA_TRACEPOINTS", NULL
);
367 output_autoconf(s
, o
, "autoconf-task_work-struct.c", "STAPCONF_TASK_WORK_STRUCT", NULL
);
368 output_autoconf(s
, o
, "autoconf-vm-area-pte.c", "STAPCONF_VM_AREA_PTE", NULL
);
369 output_autoconf(s
, o
, "autoconf-relay-umode_t.c", "STAPCONF_RELAY_UMODE_T", NULL
);
370 output_autoconf(s
, o
, "autoconf-fs_supers-hlist.c", "STAPCONF_FS_SUPERS_HLIST", NULL
);
372 // used by tapset/timestamp_monotonic.stp
373 output_exportconf(s
, o
, "cpu_clock", "STAPCONF_CPU_CLOCK");
374 output_exportconf(s
, o
, "local_clock", "STAPCONF_LOCAL_CLOCK");
376 // used by runtime/uprobe-inode.c
377 output_either_exportconf(s
, o
, "uprobe_register", "register_uprobe",
378 "STAPCONF_UPROBE_REGISTER_EXPORTED");
379 output_either_exportconf(s
, o
, "uprobe_unregister", "unregister_uprobe",
380 "STAPCONF_UPROBE_UNREGISTER_EXPORTED");
381 output_autoconf(s
, o
, "autoconf-old-inode-uprobes.c", "STAPCONF_OLD_INODE_UPROBES", NULL
);
382 output_autoconf(s
, o
, "autoconf-inode-uretprobes.c", "STAPCONF_INODE_URETPROBES", NULL
);
384 // used by tapsets.cxx inode uprobe generated code
385 output_exportconf(s
, o
, "uprobe_get_swbp_addr", "STAPCONF_UPROBE_GET_SWBP_ADDR_EXPORTED");
387 // used by runtime/loc2c-runtime.h
388 output_exportconf(s
, o
, "task_user_regset_view", "STAPCONF_TASK_USER_REGSET_VIEW_EXPORTED");
390 // used by runtime/stp_utrace.c
391 output_exportconf(s
, o
, "task_work_add", "STAPCONF_TASK_WORK_ADD_EXPORTED");
392 output_exportconf(s
, o
, "signal_wake_up_state", "STAPCONF_SIGNAL_WAKE_UP_STATE_EXPORTED");
393 output_exportconf(s
, o
, "signal_wake_up", "STAPCONF_SIGNAL_WAKE_UP_EXPORTED");
394 output_exportconf(s
, o
, "__lock_task_sighand", "STAPCONF___LOCK_TASK_SIGHAND_EXPORTED");
396 output_autoconf(s
, o
, "autoconf-pagefault_disable.c", "STAPCONF_PAGEFAULT_DISABLE", NULL
);
397 output_exportconf(s
, o
, "kallsyms_lookup_name", "STAPCONF_KALLSYMS");
398 output_autoconf(s
, o
, "autoconf-uidgid.c", "STAPCONF_LINUX_UIDGID_H", NULL
);
399 output_exportconf(s
, o
, "sigset_from_compat", "STAPCONF_SIGSET_FROM_COMPAT_EXPORTED");
401 o
<< module_cflags
<< " += -include $(STAPCONF_HEADER)" << endl
;
403 for (unsigned i
=0; i
<s
.c_macros
.size(); i
++)
404 o
<< "EXTRA_CFLAGS += -D " << lex_cast_qstring(s
.c_macros
[i
]) << endl
; // XXX right quoting?
407 o
<< "EXTRA_CFLAGS += -ftime-report -Q" << endl
;
409 // XXX: unfortunately, -save-temps can't work since linux kbuild cwd
412 // if (s.keep_tmpdir)
413 // o << "CFLAGS += -fverbose-asm -save-temps" << endl;
415 // Kernels can be compiled with CONFIG_CC_OPTIMIZE_FOR_SIZE to select
416 // -Os, otherwise -O2 is the default.
417 o
<< "EXTRA_CFLAGS += -freorder-blocks" << endl
; // improve on -Os
419 // We used to allow the user to override default optimization when so
420 // requested by adding a -O[0123s] so they could determine the
421 // time/space/speed tradeoffs themselves, but we cannot guantantee that
422 // the (un)optimized code actually compiles and/or generates functional
423 // code, so we had to remove it.
424 // o << "EXTRA_CFLAGS += " << s.gcc_flags << endl; // Add -O[0123s]
426 // o << "CFLAGS += -fno-unit-at-a-time" << endl;
428 // 256 bytes should be enough for anybody
429 // XXX this doesn't validate varargs, per gcc bug #41633
430 o
<< "EXTRA_CFLAGS += $(call cc-option,-Wframe-larger-than=256)" << endl
;
432 // Assumes linux 2.6 kbuild
433 o
<< "EXTRA_CFLAGS += -Wno-unused" << (s
.omit_werror
? "" : " -Werror") << endl
;
434 #if CHECK_POINTER_ARITH_PR5947
435 o
<< "EXTRA_CFLAGS += -Wpointer-arith" << endl
;
437 o
<< "EXTRA_CFLAGS += -I\"" << s
.runtime_path
<< "\"" << endl
;
438 // XXX: this may help ppc toc overflow
439 // o << "CFLAGS := $(subst -Os,-O2,$(CFLAGS)) -fminimal-toc" << endl;
440 o
<< "obj-m := " << s
.module_name
<< ".o" << endl
;
442 // print out all the auxiliary source (->object) file names
443 o
<< s
.module_name
<< "-y := ";
444 for (unsigned i
=0; i
<s
.auxiliary_outputs
.size(); i
++)
446 string srcname
= s
.auxiliary_outputs
[i
]->filename
;
447 assert (srcname
!= "" && srcname
.rfind('/') != string::npos
);
448 string objname
= srcname
.substr(srcname
.rfind('/')+1); // basename
449 assert (objname
!= "" && objname
[objname
.size()-1] == 'c');
450 objname
[objname
.size()-1] = 'o'; // now objname
453 // and once again, for the translated_source file. It can't simply
454 // be named MODULENAME.c, since kbuild doesn't allow a foo.ko file
455 // consisting of multiple .o's to have foo.o/foo.c as a source.
456 // (It uses ld -r -o foo.o EACH.o EACH.o).
458 string srcname
= s
.translated_source
;
459 assert (srcname
!= "" && srcname
.rfind('/') != string::npos
);
460 string objname
= srcname
.substr(srcname
.rfind('/')+1); // basename
461 assert (objname
!= "" && objname
[objname
.size()-1] == 'c');
462 objname
[objname
.size()-1] = 'o'; // now objname
467 // add all stapconf dependencies
468 o
<< s
.translated_source
<< ": $(STAPCONF_HEADER)" << endl
;
469 for (unsigned i
=0; i
<s
.auxiliary_outputs
.size(); i
++)
470 o
<< s
.auxiliary_outputs
[i
]->filename
<< ": $(STAPCONF_HEADER)" << endl
;
475 // Generate module directory pathname and make sure it exists.
476 string module_dir
= s
.kernel_build_tree
;
477 string module_dir_makefile
= module_dir
+ "/Makefile";
479 rc
= stat(module_dir_makefile
.c_str(), &st
);
482 clog
<< _F("Checking \" %s \" failed with error: %s\nEnsure kernel development headers & makefiles are installed.",
483 module_dir_makefile
.c_str(), strerror(errno
)) << endl
;
489 vector
<string
> make_cmd
= make_make_cmd(s
, s
.tmpdir
);
490 rc
= run_make_cmd(s
, make_cmd
);
497 * If uprobes was built as part of the kernel build (either built-in
498 * or as a module), the uprobes exports should show up. This is to be
499 * as distinct from the stap-built uprobes.ko from the runtime.
502 kernel_built_uprobes (systemtap_session
& s
)
504 if (s
.runtime_usermode_p())
505 return true; // sort of, via dyninst
507 // see also tapsets.cxx:kernel_supports_inode_uprobes()
508 return ((s
.kernel_config
["CONFIG_ARCH_SUPPORTS_UPROBES"] == "y" && s
.kernel_config
["CONFIG_UPROBES"] == "y") ||
509 (s
.kernel_exports
.find("unregister_uprobe") != s
.kernel_exports
.end()));
513 make_uprobes (systemtap_session
& s
)
516 clog
<< _("Pass 4, preamble: (re)building SystemTap's version of uprobes.")
519 // create a subdirectory for the uprobes module
520 string
dir(s
.tmpdir
+ "/uprobes");
521 if (create_dir(dir
.c_str()) != 0)
523 s
.print_warning("failed to create directory for build uprobes.");
528 // create a simple Makefile
529 string
makefile(dir
+ "/Makefile");
530 ofstream
omf(makefile
.c_str());
531 omf
<< "obj-m := uprobes.o" << endl
;
532 // RHBZ 655231: later rhel6 kernels' module-signing kbuild logic breaks out-of-tree modules
533 omf
<< "CONFIG_MODULE_SIG := n" << endl
;
536 // create a simple #include-chained source file
537 string
runtimesourcefile(s
.runtime_path
+ "/linux/uprobes/uprobes.c");
538 string
sourcefile(dir
+ "/uprobes.c");
539 ofstream
osrc(sourcefile
.c_str());
540 osrc
<< "#include \"" << runtimesourcefile
<< "\"" << endl
;
542 // pass --modinfo k=v to uprobes build too
543 for (unsigned i
= 0; i
< s
.modinfos
.size(); i
++)
545 const string
& mi
= s
.modinfos
[i
];
546 size_t loc
= mi
.find('=');
547 string tag
= mi
.substr (0, loc
);
548 string value
= mi
.substr (loc
+1);
549 osrc
<< "MODULE_INFO(" << tag
<< "," << lex_cast_qstring(value
) << ");" << endl
;
555 vector
<string
> make_cmd
= make_make_cmd(s
, dir
);
556 int rc
= run_make_cmd(s
, make_cmd
);
557 if (!rc
&& !copy_file(dir
+ "/Module.symvers",
558 s
.tmpdir
+ "/Module.symvers"))
562 clog
<< _("uprobes rebuild exit code: ") << rc
<< endl
;
566 s
.uprobes_path
= dir
+ "/uprobes.ko";
571 get_cached_uprobes(systemtap_session
& s
)
573 s
.uprobes_hash
= s
.use_cache
? find_uprobes_hash(s
) : "";
574 if (!s
.uprobes_hash
.empty())
576 // NB: We always put uprobes.ko in its own directory, especially so
577 // stap-serverd can more easily locate it.
578 string
dir(s
.tmpdir
+ "/uprobes");
579 if (create_dir(dir
.c_str()) != 0)
582 string cacheko
= s
.uprobes_hash
+ ".ko";
583 string tmpko
= dir
+ "/uprobes.ko";
585 // The symvers file still needs to go in the script module's directory.
586 string cachesyms
= s
.uprobes_hash
+ ".symvers";
587 string tmpsyms
= s
.tmpdir
+ "/Module.symvers";
589 if (get_file_size(cacheko
) > 0 && copy_file(cacheko
, tmpko
) &&
590 get_file_size(cachesyms
) > 0 && copy_file(cachesyms
, tmpsyms
))
592 s
.uprobes_path
= tmpko
;
600 set_cached_uprobes(systemtap_session
& s
)
602 if (s
.use_cache
&& !s
.uprobes_hash
.empty())
604 string cacheko
= s
.uprobes_hash
+ ".ko";
605 string tmpko
= s
.tmpdir
+ "/uprobes/uprobes.ko";
606 copy_file(tmpko
, cacheko
);
608 string cachesyms
= s
.uprobes_hash
+ ".symvers";
609 string tmpsyms
= s
.tmpdir
+ "/uprobes/Module.symvers";
610 copy_file(tmpsyms
, cachesyms
);
615 uprobes_pass (systemtap_session
& s
)
617 if (!s
.need_uprobes
|| kernel_built_uprobes(s
))
620 if (s
.kernel_config
["CONFIG_UTRACE"] != string("y"))
622 clog
<< _("user-space process-tracking facilities not available [man error::process-tracking]") << endl
;
628 * We need to use the version of uprobes that comes with SystemTap. Try to
629 * get it from the cache first. If not found, build it and try to save it to
630 * the cache for future reuse.
633 if (!get_cached_uprobes(s
))
635 rc
= make_uprobes(s
);
637 set_cached_uprobes(s
);
646 make_dyninst_run_command (systemtap_session
& s
, const string
& remotedir
,
647 const string
& version
)
650 cmd
.push_back(getenv("SYSTEMTAP_STAPDYN") ?: BINDIR
"/stapdyn");
652 // use slightly less verbosity
653 for (unsigned i
=1; i
<s
.verbose
; i
++)
655 if (s
.suppress_warnings
)
661 cmd
.push_back(s
.cmd
);
667 cmd
.push_back(lex_cast(s
.target_pid
));
670 if (!s
.output_file
.empty())
673 cmd
.push_back(s
.output_file
);
676 cmd
.push_back((remotedir
.empty() ? s
.tmpdir
: remotedir
)
677 + "/" + s
.module_filename());
679 // add module arguments
680 cmd
.insert(cmd
.end(), s
.globalopts
.begin(), s
.globalopts
.end());
686 make_run_command (systemtap_session
& s
, const string
& remotedir
,
687 const string
& version
)
689 if (s
.runtime_usermode_p())
690 return make_dyninst_run_command(s
, remotedir
, version
);
692 // for now, just spawn staprun
693 vector
<string
> staprun_cmd
;
694 staprun_cmd
.push_back(getenv("SYSTEMTAP_STAPRUN") ?: BINDIR
"/staprun");
696 // use slightly less verbosity
697 for (unsigned i
=1; i
<s
.verbose
; i
++)
698 staprun_cmd
.push_back("-v");
699 if (s
.suppress_warnings
)
700 staprun_cmd
.push_back("-w");
702 if (!s
.output_file
.empty())
704 staprun_cmd
.push_back("-o");
705 staprun_cmd
.push_back(s
.output_file
);
710 staprun_cmd
.push_back("-c");
711 staprun_cmd
.push_back(s
.cmd
);
716 staprun_cmd
.push_back("-t");
717 staprun_cmd
.push_back(lex_cast(s
.target_pid
));
722 staprun_cmd
.push_back("-b");
723 staprun_cmd
.push_back(lex_cast(s
.buffer_size
));
726 if (s
.need_uprobes
&& !kernel_built_uprobes(s
))
729 if (!s
.uprobes_path
.empty() &&
730 strverscmp("1.4", version
.c_str()) <= 0)
732 if (remotedir
.empty())
733 opt_u
.append(s
.uprobes_path
);
735 opt_u
.append(remotedir
+ "/" + basename(s
.uprobes_path
.c_str()));
737 staprun_cmd
.push_back(opt_u
);
741 staprun_cmd
.push_back(s
.output_file
.empty() ? "-L" : "-D");
743 if(!s
.modname_given
&& (strverscmp("1.6", version
.c_str()) <= 0))
744 staprun_cmd
.push_back("-R");
746 if (!s
.size_option
.empty())
748 staprun_cmd
.push_back("-S");
749 staprun_cmd
.push_back(s
.size_option
);
754 staprun_cmd
.push_back("-C");
755 staprun_cmd
.push_back("auto");
758 staprun_cmd
.push_back((remotedir
.empty() ? s
.tmpdir
: remotedir
)
759 + "/" + s
.module_filename());
761 // add module arguments
762 staprun_cmd
.insert(staprun_cmd
.end(),
763 s
.globalopts
.begin(), s
.globalopts
.end());
769 // Build tiny kernel modules to query tracepoints.
770 // Given a (header-file -> test-contents) map, compile them ASAP, and return
771 // a (header-file -> obj-filename) map.
774 make_tracequeries(systemtap_session
& s
, const map
<string
,string
>& contents
)
776 static unsigned tick
= 0;
777 string
basename("tracequery_kmod_" + lex_cast(++tick
));
778 map
<string
,string
> objs
;
780 // create a subdirectory for the module
781 string
dir(s
.tmpdir
+ "/" + basename
);
782 if (create_dir(dir
.c_str()) != 0)
784 s
.print_warning("failed to create directory for querying tracepoints.");
789 // create a simple Makefile
790 string
makefile(dir
+ "/Makefile");
791 ofstream
omf(makefile
.c_str());
792 // force debuginfo generation, and relax implicit functions
793 omf
<< "EXTRA_CFLAGS := -g -Wno-implicit-function-declaration" << (s
.omit_werror
? "" : " -Werror") << endl
;
794 // RHBZ 655231: later rhel6 kernels' module-signing kbuild logic breaks out-of-tree modules
795 omf
<< "CONFIG_MODULE_SIG := n" << endl
;
797 if (s
.kernel_source_tree
!= "")
798 omf
<< "EXTRA_CFLAGS += -I" + s
.kernel_source_tree
<< endl
;
800 omf
<< "obj-m := " << endl
;
801 // write out each header-specific source file into a separate file
802 for (map
<string
,string
>::const_iterator it
= contents
.begin(); it
!= contents
.end(); it
++)
804 string sbasename
= basename
+ "_" + lex_cast(++tick
); // suffixed
806 // write out source code
807 string srcname
= dir
+ "/" + sbasename
+ ".c";
808 string src
= it
->second
;
809 ofstream
osrc(srcname
.c_str());
814 clog
<< _F("Processing tracepoint header %s with query %s",
815 it
->first
.c_str(), srcname
.c_str())
818 // arrange to build it
819 omf
<< "obj-m += " + sbasename
+ ".o" << endl
; // NB: without <dir> prefix
820 objs
[it
->first
] = dir
+ "/" + sbasename
+ ".o";
825 vector
<string
> make_cmd
= make_make_objs_cmd(s
, dir
);
826 make_cmd
.push_back ("-i"); // ignore errors, give rc 0 even in case of tracepoint header nits
827 bool quiet
= (s
.verbose
< 4);
828 int rc
= run_make_cmd(s
, make_cmd
, quiet
, quiet
);
832 // Sometimes we fail a tracequery due to PR9993 / PR11649 type
833 // kernel trace header problems. In this case, due to PR12729, we
834 // used to get a lovely "Warning: make exited with status: 2" but no
835 // other useful diagnostic. -vvvv would let a user see what's up,
836 // but the user can't fix the problem even with that.
842 // Build a tiny kernel module to query type information
844 make_typequery_kmod(systemtap_session
& s
, const vector
<string
>& headers
, string
& name
)
846 static unsigned tick
= 0;
847 string
basename("typequery_kmod_" + lex_cast(++tick
));
849 // create a subdirectory for the module
850 string
dir(s
.tmpdir
+ "/" + basename
);
851 if (create_dir(dir
.c_str()) != 0)
853 s
.print_warning("failed to create directory for querying types.");
858 name
= dir
+ "/" + basename
+ ".ko";
860 // create a simple Makefile
861 string
makefile(dir
+ "/Makefile");
862 ofstream
omf(makefile
.c_str());
863 omf
<< "EXTRA_CFLAGS := -g -fno-eliminate-unused-debug-types" << endl
;
865 // RHBZ 655231: later rhel6 kernels' module-signing kbuild logic breaks out-of-tree modules
866 omf
<< "CONFIG_MODULE_SIG := n" << endl
;
868 // NB: We use -include instead of #include because that gives us more power.
869 // Using #include searches relative to the source's path, which in this case
870 // is /tmp/..., so that's not helpful. Using -include will search relative
871 // to the cwd, which will be the kernel build root. This means if you have a
872 // full kernel build tree, it's possible to get at types that aren't in the
873 // normal include path, e.g.:
874 // @cast(foo, "bsd_acct_struct", "kernel<kernel/acct.c>")->...
875 omf
<< "CFLAGS_" << basename
<< ".o :=";
876 for (size_t i
= 0; i
< headers
.size(); ++i
)
877 omf
<< " -include " << lex_cast_qstring(headers
[i
]); // XXX right quoting?
880 omf
<< "obj-m := " + basename
+ ".o" << endl
;
883 // create our empty source file
884 string
source(dir
+ "/" + basename
+ ".c");
885 ofstream
osrc(source
.c_str());
889 vector
<string
> make_cmd
= make_make_cmd(s
, dir
);
890 bool quiet
= (s
.verbose
< 4);
891 int rc
= run_make_cmd(s
, make_cmd
, quiet
, quiet
);
898 // Build a tiny user module to query type information
900 make_typequery_umod(systemtap_session
& s
, const vector
<string
>& headers
, string
& name
)
902 static unsigned tick
= 0;
904 name
= s
.tmpdir
+ "/typequery_umod_" + lex_cast(++tick
) + ".so";
908 // NB: As with kmod, using -include makes relative paths more useful. The
909 // cwd in this case will be the cwd of stap itself though, which may be
910 // trickier to deal with. It might be better to "cd `dirname $script`"
913 cmd
.push_back("gcc");
914 cmd
.push_back("-shared");
916 cmd
.push_back("-fno-eliminate-unused-debug-types");
917 cmd
.push_back("-xc");
918 cmd
.push_back("/dev/null");
921 for (size_t i
= 0; i
< headers
.size(); ++i
)
923 cmd
.push_back("-include");
924 cmd
.push_back(headers
[i
]);
926 bool quiet
= (s
.verbose
< 4);
927 int rc
= stap_system (s
.verbose
, cmd
, quiet
, quiet
);
935 make_typequery(systemtap_session
& s
, string
& module
)
939 vector
<string
> headers
;
940 bool kernel
= startswith(module
, "kernel");
942 for (size_t end
, i
= kernel
? 6 : 0; i
< module
.size(); i
= end
+ 1)
944 if (module
[i
] != '<')
946 end
= module
.find('>', ++i
);
947 if (end
== string::npos
)
949 string header
= module
.substr(i
, end
- i
);
950 vector
<string
> matches
;
951 if (regexp_match(header
, "^[a-zA-Z0-9/_.+-]+$", matches
))
952 s
.print_warning("skipping malformed @cast header \""+ header
+ "\"");
954 headers
.push_back(header
);
960 rc
= make_typequery_kmod(s
, headers
, new_module
);
962 rc
= make_typequery_umod(s
, headers
, new_module
);
970 /* vim: set sw=2 ts=8 cino=>4,n-2,{2,^-2,t0,(0,u0,w1,M1 : */