Introduce GCC plugin infrastructure
Subsystems (9)
v7 cover Introduce GCC plugin infrastructure
This patch set introduce the GCC plugin infrastructure with examples for testing and documentation.
GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis.
The infrastructure supports all gcc versions from 4.5 to 6.0, building out-of-tree modules and building in a separate directory. Cross-compilation is supported too but currently only the x86, arm and arm64 architectures enables plugins.
This infrastructure was ported from grsecurity/PaX. It is a CII project supported by the Linux Foundation.
Emese Revfy (6):
Shared library support
GCC plugin infrastructure
The GCC plugin infrastructure supports the arm and arm64 architectures too Add Cyclomatic complexity plugin
Documentations of the GCC plugin infrastructre
Add sancov plugin
Changes from v6:
* Disable the sancov plugin whenever KCOV_INSTRUMENT is disabled (Reported-by: Huang Ying <[email protected]>)
* Disable KCOV/sancov plugin because this is not a regular kernel code (Reported-by: Huang Ying <[email protected]>)
* Removed unnecessary gcc plugin cflags
(Signed-off-by: Masahiro Yamada <[email protected]>)
* Removed unnecessary gcc plugin aflags
Changes from v5:
* Set important properties on the external fndecl (Add sancov plugin)
* Revert documentation change too (Shared library support)
(Suggested-by: Kees Cook <[email protected]>)
* The GCC plugin infrastructure now supports the arm and arm64 architectures too (Signed-off-by: David Brown <[email protected]>)
* Simplify the computation of PLUGINCC (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Simplify the invocation of gcc-plugin.sh (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Make use of multi-depend (Shared library support)
(Suggested-by: Masahiro Yamada <[email protected]>)
* Remove unnecessary exports (GCC plugin infrastructure)
(Suggested-by: Masahiro Yamada <[email protected]>)
* Simplify Makefile by using addprefix (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Moved the gcc plugins from tools/ to scripts/ (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Removed plugins from KBUILD_CFLAGS_32 (GCC plugin infrastructure)
* Remove gcc-plugin target everywhere
(Suggested-by and partly Written-by: Masahiro Yamada <[email protected]>)
* There is no leaf gcc attribute in gcc-4.5 (Add sancov plugin)
* Added support to the sancov plugin with kcov (Add sancov plugin)
Changes from v4:
* Moved shared library support from the GCC plugin infrastructure patch into a different patch
* Update gcc-*.h from PaX
* Fixed gcc-common.h for gcc 6
* Added pass cloning support to the gcc pass generators
* Disable all plugins in vdso because it is userland code
* Add sancov gcc plugin: another use case for gcc plugin support in the kernel is when there is a feature in the latest gcc version and we would like to use it with older gcc versions as well (e.g., distros).
Changes from v3:
* Fix some indentation related warnings
(Suggested by checkpatch.pl)
* Add maintainer entries
* Don't run gcc_plugin.sh when the GCC_PLUGINS option is disabled or unsupported (Reported-by: Fengguang Wu <[email protected]>)
Changes from v2:
* Fixed incorrectly encoded characters
* Generate the GIMPLE, IPA, SIMPLE_IPA and RTL pass structures (Suggested-by: Rasmus Villemoes <[email protected]>)
* Write plugin related warning messages to stderr instead of stdout (Suggested-by: Kees Cook <[email protected]>)
* Mention the installation of the gcc plugin headers (Documentation)
Changes from v1:
* Move the gcc-plugins make target into a separate Makefile because there may be a lot of plugins (Suggested-by: Rasmus Villemoes)
* Simplify the dependencies of the plugin related config option (Suggested-by: Kees Cook <[email protected]>)
* Removed the unnecessary example plugin
--- Documentation/dontdiff | 1 + Documentation/gcc-plugins.txt | 83 +++ Documentation/kbuild/makefiles.txt | 39 +- Documentation/kernel-parameters.txt | 5 + MAINTAINERS | 8 + Makefile | 25 +- arch/Kconfig | 36 + arch/arm/Kconfig | 1 + arch/arm64/Kconfig | 1 + arch/x86/Kconfig | 1 + arch/x86/entry/vdso/Makefile | 3 +- arch/x86/purgatory/Makefile | 2 + lib/Kconfig.debug | 2 + scripts/Makefile | 2 +- scripts/Makefile.build | 2 +- scripts/Makefile.clean | 3 +- scripts/Makefile.gcc-plugins | 40 + scripts/Makefile.host | 70 +- scripts/gcc-plugin.sh | 51 ++ scripts/gcc-plugins/Makefile | 24 + scripts/gcc-plugins/cyc_complexity_plugin.c | 73 ++ scripts/gcc-plugins/gcc-common.h | 830 +++++++++++++++++++++ scripts/gcc-plugins/gcc-generate-gimple-pass.h | 175 +++++ scripts/gcc-plugins/gcc-generate-ipa-pass.h | 289 +++++++ scripts/gcc-plugins/gcc-generate-rtl-pass.h | 175 +++++ scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h | 175 +++++ scripts/gcc-plugins/sancov_plugin.c | 144 ++++ scripts/link-vmlinux.sh | 2 +- scripts/package/builddeb | 1 + 29 files changed, 2239 insertions(+), 25 deletions(-)
PATCH v7 1/6 Shared library support
Infrastructure for building independent shared library targets. This effectively also reverts commit 62e2210798ed38928ab24841e8b4878a (Masahiro Yamada, kbuild: drop shared library support from Makefile.host).
--- Documentation/kbuild/makefiles.txt | 39 ++++++++++++++++----- scripts/Makefile.build | 2 +- scripts/Makefile.clean | 3 +- scripts/Makefile.host | 70 +++++++++++++++++++++++++++++++++++++- 4 files changed, 103 insertions(+), 11 deletions(-)
Documentation/kbuild/makefiles.txt +31 -8
@@ -23,10 +23,11 @@ This document describes the Linux kernel Makefiles. === 4 Host Program support --- 4.1 Simple Host Program --- 4.2 Composite Host Programs - --- 4.3 Using C++ for host programs - --- 4.4 Controlling compiler options for host programs - --- 4.5 When host programs are actually built - --- 4.6 Using hostprogs-$(CONFIG_FOO) + --- 4.3 Defining shared libraries + --- 4.4 Using C++ for host programs + --- 4.5 Controlling compiler options for host programs + --- 4.6 When host programs are actually built + --- 4.7 Using hostprogs-$(CONFIG_FOO) === 5 Kbuild clean infrastructure
@@ -643,7 +644,29 @@ Both possibilities are described in the following. Finally, the two .o files are linked to the executable, lxdialog. Note: The syntax <executable>-y is not permitted for host-programs. ---- 4.3 Using C++ for host programs +--- 4.3 Defining shared libraries + + Objects with extension .so are considered shared libraries, and + will be compiled as position independent objects. + Kbuild provides support for shared libraries, but the usage + shall be restricted. + In the following example the libkconfig.so shared library is used + to link the executable conf. + + Example: + #scripts/kconfig/Makefile + hostprogs-y := conf + conf-objs := conf.o libkconfig.so + libkconfig-objs := expr.o type.o + + Shared libraries always require a corresponding -objs line, and + in the example above the shared library libkconfig is composed by + the two objects expr.o and type.o. + expr.o and type.o will be built as position independent code and + linked as a shared library libkconfig.so. C++ is not supported for + shared libraries. + +--- 4.4 Using C++ for host programs kbuild offers support for host programs written in C++. This was introduced solely to support kconfig, and is not recommended
@@ -666,7 +689,7 @@ Both possibilities are described in the following. qconf-cxxobjs := qconf.o qconf-objs := check.o ---- 4.4 Controlling compiler options for host programs +--- 4.5 Controlling compiler options for host programs When compiling host programs, it is possible to set specific flags. The programs will always be compiled utilising $(HOSTCC) passed
@@ -694,7 +717,7 @@ Both possibilities are described in the following. When linking qconf, it will be passed the extra option "-L$(QTDIR)/lib". ---- 4.5 When host programs are actually built +--- 4.6 When host programs are actually built Kbuild will only build host-programs when they are referenced as a prerequisite.
@@ -725,7 +748,7 @@ Both possibilities are described in the following. This will tell kbuild to build lxdialog even if not referenced in any rule. ---- 4.6 Using hostprogs-$(CONFIG_FOO) +--- 4.7 Using hostprogs-$(CONFIG_FOO) A typical pattern in a Kbuild file looks like this:
scripts/Makefile.build +1 -1
@@ -60,7 +60,7 @@ endif endif # Do not include host rules unless needed -ifneq ($(hostprogs-y)$(hostprogs-m),) +ifneq ($(hostprogs-y)$(hostprogs-m)$(hostlibs-y)$(hostlibs-m)$(hostcxxlibs-y)$(hostcxxlibs-m),) include scripts/Makefile.host endif
scripts/Makefile.clean +2 -1
@@ -38,7 +38,8 @@ subdir-ymn := $(addprefix $(obj)/,$(subdir-ymn)) __clean-files := $(extra-y) $(extra-m) $(extra-) \ $(always) $(targets) $(clean-files) \ $(host-progs) \ - $(hostprogs-y) $(hostprogs-m) $(hostprogs-) + $(hostprogs-y) $(hostprogs-m) $(hostprogs-) \ + $(hostlibs-y) $(hostlibs-m) $(hostlibs-) __clean-files := $(filter-out $(no-clean-files), $(__clean-files))
scripts/Makefile.host +69 -1
93 lines not on this page · raw message
Signature · 1 line
2.4.1
PATCH v7 2/6 GCC plugin infrastructure
In reply to Emese RevfyThis patch allows to build the whole kernel with GCC plugins. It was ported from grsecurity/PaX. The infrastructure supports building out-of-tree modules and building in a separate directory. Cross-compilation is supported too but currently only the x86 architecture enables plugins.
The directory of the gcc plugins is tools/gcc. You can use a file or a directory there. The plugins compile with these options:
* -fno-rtti: gcc is compiled with this option so the plugins must use it too
* -fno-exceptions: this is inherited from gcc too
* -fasynchronous-unwind-tables: this is inherited from gcc too
* -ggdb: it is useful for debugging a plugin (better backtrace on internal errors)
* -Wno-narrowing: to suppress warnings from gcc headers (ipa-utils.h)
* -Wno-unused-variable: to suppress warnings from gcc headers (gcc_version variable, plugin-version.h)
The infrastructure introduces a new Makefile target called gcc-plugins. It supports all gcc versions from 4.5 to 6.0. The scripts/gcc-plugin.sh script chooses the proper host compiler (gcc-4.7 can be built by either gcc or g++). This script also checks the availability of the included headers in tools/gcc/gcc-common.h.
The gcc-common.h header contains frequently included headers for GCC plugins and it has a compatibility layer for the supported gcc versions.
The gcc-generate-*-pass.h headers automatically generate the registration structures for GIMPLE, SIMPLE_IPA, IPA and RTL passes.
Note that 'make clean' keeps the *.so files (only the distclean or mrproper targets clean all) because they are needed for out-of-tree modules.
--- Documentation/dontdiff | 1 + MAINTAINERS | 8 + Makefile | 17 +- arch/Kconfig | 13 + arch/x86/Kconfig | 1 + arch/x86/entry/vdso/Makefile | 3 +- scripts/Makefile | 2 +- scripts/Makefile.gcc-plugins | 20 + scripts/gcc-plugin.sh | 51 ++ scripts/gcc-plugins/Makefile | 15 + scripts/gcc-plugins/gcc-common.h | 830 +++++++++++++++++++++ scripts/gcc-plugins/gcc-generate-gimple-pass.h | 175 +++++ scripts/gcc-plugins/gcc-generate-ipa-pass.h | 289 +++++++ scripts/gcc-plugins/gcc-generate-rtl-pass.h | 175 +++++ scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h | 175 +++++ scripts/link-vmlinux.sh | 2 +- scripts/package/builddeb | 1 + 17 files changed, 1772 insertions(+), 6 deletions(-) create mode 100644 scripts/Makefile.gcc-plugins create mode 100755 scripts/gcc-plugin.sh create mode 100644 scripts/gcc-plugins/Makefile create mode 100644 scripts/gcc-plugins/gcc-common.h create mode 100644 scripts/gcc-plugins/gcc-generate-gimple-pass.h create mode 100644 scripts/gcc-plugins/gcc-generate-ipa-pass.h create mode 100644 scripts/gcc-plugins/gcc-generate-rtl-pass.h create mode 100644 scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h
Documentation/dontdiff +1 -0
@@ -3,6 +3,7 @@ *.bc *.bin *.bz2 +*.c.[012]*.* *.cis *.cpio *.csp
MAINTAINERS +8 -0
@@ -4777,6 +4777,14 @@ L: [email protected] S: Odd Fixes (e.g., new signatures) F: drivers/scsi/fdomain.* +GCC PLUGINS +M: Kees Cook <[email protected]> +R: Emese Revfy <[email protected]> +L: [email protected] +S: Maintained +F: scripts/gcc-plugins/ +F: Documentation/gcc-plugins.txt + GCOV BASED KERNEL PROFILING M: Peter Oberparleiter <[email protected]> S: Maintained
Makefile +14 -3
@@ -418,6 +418,8 @@ export KBUILD_AFLAGS_MODULE KBUILD_CFLAGS_MODULE KBUILD_LDFLAGS_MODULE export KBUILD_AFLAGS_KERNEL KBUILD_CFLAGS_KERNEL export KBUILD_ARFLAGS +export PLUGINCC GCC_PLUGINS_CFLAGS + # When compiling out-of-tree modules, put MODVERDIR in the module # tree rather than in the kernel tree. The kernel tree might # even be read-only.
@@ -548,7 +550,7 @@ ifeq ($(KBUILD_EXTMOD),) # in parallel PHONY += scripts scripts: scripts_basic include/config/auto.conf include/config/tristate.conf \ - asm-generic + asm-generic gcc-plugins $(Q)$(MAKE) $(build)=$(@) # Objects we will link into vmlinux / subdirs we need to visit
@@ -623,6 +625,15 @@ endif # Tell gcc to never replace conditional load with a non-conditional one KBUILD_CFLAGS += $(call cc-option,--param=allow-store-data-races=0) +PHONY += gcc-plugins +gcc-plugins: scripts_basic +ifdef CONFIG_GCC_PLUGINS + $(Q)$(MAKE) $(build)=scripts/gcc-plugins +endif + @: + +include scripts/Makefile.gcc-plugins + ifdef CONFIG_READABLE_ASM # Disable optimizations that make assembler listings hard to read. # reorder blocks reorders the control in the function
@@ -1018,7 +1029,7 @@ prepare1: prepare2 $(version_h) include/generated/utsrelease.h \ archprepare: archheaders archscripts prepare1 scripts_basic -prepare0: archprepare +prepare0: archprepare gcc-plugins FORCE $(Q)$(MAKE) $(build)=. # All the preparing..
@@ -1275,7 +1286,7 @@ distclean: mrproper @find $(srctree) $(RCS_FIND_IGNORE) \ \( -name '*.orig' -o -name '*.rej' -o -name '*~' \ -o -name '*.bak' -o -name '#*#' -o -name '.*.orig' \ - -o -name '.*.rej' -o -name '*%' -o -name 'core' \) \ + -o -name '.*.rej' -o -name '*.so' -o -name '*%' -o -name 'core' \) \ -type f -print | xargs rm -f
arch/Kconfig +13 -0
@@ -353,6 +353,19 @@ config SECCOMP_FILTER See Documentation/prctl/seccomp_filter.txt for details. +config HAVE_GCC_PLUGINS + bool + help + An arch should select this symbol if it supports building with + GCC plugins. + +menuconfig GCC_PLUGINS + bool "GCC plugins" + depends on HAVE_GCC_PLUGINS + help + GCC plugins are loadable modules that provide extra features to the + compiler. They are useful for runtime instrumentation and static analysis. + config HAVE_CC_STACKPROTECTOR bool help
arch/x86/Kconfig +1 -0
@@ -155,6 +155,7 @@ config X86 select SYSCTL_EXCEPTION_TRACE select USER_STACKTRACE_SUPPORT select VIRT_TO_BUS + select HAVE_GCC_PLUGINS select X86_DEV_DMA_OPS if X86_64 select X86_FEATURE_NAMES if PROC_FS select HAVE_STACK_VALIDATION if X86_64
arch/x86/entry/vdso/Makefile +2 -1
@@ -75,7 +75,7 @@ CFL := $(PROFILING) -mcmodel=small -fPIC -O2 -fasynchronous-unwind-tables -m64 \ -fno-omit-frame-pointer -foptimize-sibling-calls \ -DDISABLE_BRANCH_PROFILING -DBUILD_VDSO -$(vobjs): KBUILD_CFLAGS += $(CFL) +$(vobjs): KBUILD_CFLAGS := $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS)) $(CFL) # # vDSO code runs in userspace and -pg doesn't help with profiling anyway.
@@ -145,6 +145,7 @@ KBUILD_CFLAGS_32 := $(filter-out -m64,$(KBUILD_CFLAGS)) KBUILD_CFLAGS_32 := $(filter-out -mcmodel=kernel,$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 := $(filter-out -fno-pic,$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 := $(filter-out -mfentry,$(KBUILD_CFLAGS_32)) +KBUILD_CFLAGS_32 := $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 += -m32 -msoft-float -mregparm=0 -fpic KBUILD_CFLAGS_32 += $(call cc-option, -fno-stack-protector) KBUILD_CFLAGS_32 += $(call cc-option, -foptimize-sibling-calls)
scripts/Makefile +1 -1
@@ -47,4 +47,4 @@ subdir-$(CONFIG_DTC) += dtc subdir-$(CONFIG_GDB_SCRIPTS) += gdb # Let clean descend into subdirs -subdir- += basic kconfig package +subdir- += basic kconfig package gcc-plugins
scripts/Makefile.gcc-plugins new file +20 -0
@@ -0,0 +1,20 @@ +ifdef CONFIG_GCC_PLUGINS + __PLUGINCC := $(call cc-ifversion, -ge, 0408, $(HOSTCXX), $(HOSTCC)) + PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + + GCC_PLUGINS_CFLAGS := $(addprefix -fplugin=$(objtree)/scripts/gcc-plugins/, $(gcc-plugin-y)) + + ifeq ($(PLUGINCC),) + ifneq ($(GCC_PLUGINS_CFLAGS),) + ifeq ($(call cc-ifversion, -ge, 0405, y), y) + PLUGINCC := $(shell $(CONFIG_SHELL) -x $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + $(error error, your gcc installation does not support plugins, perhaps the necessary headers are missing?) + else + $(error error, your gcc version does not support plugins, you should upgrade it to gcc 4.5 at least) + endif + endif + endif + + KBUILD_CFLAGS += $(GCC_PLUGINS_CFLAGS) + +endif
scripts/gcc-plugin.sh new file +51 -0
51 lines not on this page · raw message
scripts/gcc-plugins/Makefile new file +15 -0
@@ -0,0 +1,15 @@ +GCC_PLUGINS_DIR := $(shell $(CC) -print-file-name=plugin) + +ifeq ($(PLUGINCC),$(HOSTCC)) +HOSTLIBS := hostlibs +HOST_EXTRACFLAGS += -I$(GCC_PLUGINS_DIR)/include -I$(src) -std=gnu99 -ggdb +export HOST_EXTRACFLAGS +else +HOSTLIBS := hostcxxlibs +HOST_EXTRACXXFLAGS += -I$(GCC_PLUGINS_DIR)/include -I$(src) -std=gnu++98 -fno-rtti -fno-exceptions -fasynchronous-unwind-tables -ggdb -Wno-narrowing -Wno-unused-variable +export HOST_EXTRACXXFLAGS +endif + +export GCCPLUGINS_DIR HOSTLIBS + +always := $($(HOSTLIBS)-y)
scripts/gcc-plugins/gcc-common.h new file +830 -0
830 lines not on this page · raw message
scripts/gcc-plugins/gcc-generate-gimple-pass.h new file +175 -0
175 lines not on this page · raw message
scripts/gcc-plugins/gcc-generate-ipa-pass.h new file +289 -0
289 lines not on this page · raw message
scripts/gcc-plugins/gcc-generate-rtl-pass.h new file +175 -0
175 lines not on this page · raw message
scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h new file +175 -0
175 lines not on this page · raw message
scripts/link-vmlinux.sh +1 -1
@@ -180,7 +180,7 @@ else fi; # final build of init/ -${MAKE} -f "${srctree}/scripts/Makefile.build" obj=init +${MAKE} -f "${srctree}/scripts/Makefile.build" obj=init GCC_PLUGINS_CFLAGS="${GCC_PLUGINS_CFLAGS}" kallsymso="" kallsyms_vmlinux=""
scripts/package/builddeb +1 -0
@@ -326,6 +326,7 @@ fi (cd $srctree; find arch/$SRCARCH -name module.lds -o -name Kbuild.platforms -o -name Platform) >> "$objtree/debian/hdrsrcfiles" (cd $srctree; find $(find arch/$SRCARCH -name include -o -name scripts -type d) -type f) >> "$objtree/debian/hdrsrcfiles" (cd $objtree; find arch/$SRCARCH/include Module.symvers include scripts -type f) >> "$objtree/debian/hdrobjfiles" +(cd $objtree; find scripts/gcc-plugins -name \*.so -o -name gcc-common.h) >> "$objtree/debian/hdrobjfiles" destdir=$kernel_headers_dir/usr/src/linux-headers-$version mkdir -p "$destdir" (cd $srctree; tar -c -f - -T -) < "$objtree/debian/hdrsrcfiles" | (cd $destdir; tar -xf -)
Signature · 1 line
2.4.1
PATCH v7 3/6 The GCC plugin infrastructure supports the arm and arm64 architectures too
In reply to Emese RevfyThe GCC plugin infrastructure supports the arm and arm64 architectures too
--- arch/arm/Kconfig | 1 + arch/arm64/Kconfig | 1 + 2 files changed, 2 insertions(+)
arch/arm/Kconfig +1 -0
@@ -55,6 +55,7 @@ config ARM select HAVE_FUNCTION_GRAPH_TRACER if (!THUMB2_KERNEL) select HAVE_FUNCTION_TRACER if (!XIP_KERNEL) select HAVE_GENERIC_DMA_COHERENT + select HAVE_GCC_PLUGINS select HAVE_HW_BREAKPOINT if (PERF_EVENTS && (CPU_V6 || CPU_V6K || CPU_V7)) select HAVE_IDE if PCI || ISA || PCMCIA select HAVE_IRQ_TIME_ACCOUNTING
arch/arm64/Kconfig +1 -0
@@ -76,6 +76,7 @@ config ARM64 select HAVE_FTRACE_MCOUNT_RECORD select HAVE_FUNCTION_TRACER select HAVE_FUNCTION_GRAPH_TRACER + select HAVE_GCC_PLUGINS select HAVE_GENERIC_DMA_COHERENT select HAVE_HW_BREAKPOINT if PERF_EVENTS select HAVE_IRQ_TIME_ACCOUNTING
Signature · 1 line
2.4.1
PATCH v7 4/6 Add Cyclomatic complexity GCC plugin
In reply to Emese RevfyAdd a very simple plugin to demonstrate the GCC plugin infrastructure. This GCC plugin computes the cyclomatic complexity of each function.
The complexity M of a function's control flow graph is defined as:
M = E - N + 2P
where
E = the number of edges
N = the number of nodes
P = the number of connected components (exit nodes).
--- arch/Kconfig | 12 +++++ scripts/Makefile.gcc-plugins | 2 + scripts/gcc-plugins/Makefile | 4 ++ scripts/gcc-plugins/cyc_complexity_plugin.c | 73 +++++++++++++++++++++++++++++ 4 files changed, 91 insertions(+) create mode 100644 scripts/gcc-plugins/cyc_complexity_plugin.c
arch/Kconfig +12 -0
@@ -366,6 +366,18 @@ menuconfig GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. +config GCC_PLUGIN_CYC_COMPLEXITY + bool "Compute the cyclomatic complexity of a function" + depends on GCC_PLUGINS + help + The complexity M of a function's control flow graph is defined as: + M = E - N + 2P + where + + E = the number of edges + N = the number of nodes + P = the number of connected components (exit nodes). + config HAVE_CC_STACKPROTECTOR bool help
scripts/Makefile.gcc-plugins +2 -0
@@ -2,6 +2,8 @@ ifdef CONFIG_GCC_PLUGINS __PLUGINCC := $(call cc-ifversion, -ge, 0408, $(HOSTCXX), $(HOSTCC)) PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + gcc-plugin-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) += cyc_complexity_plugin.so + GCC_PLUGINS_CFLAGS := $(addprefix -fplugin=$(objtree)/scripts/gcc-plugins/, $(gcc-plugin-y)) ifeq ($(PLUGINCC),)
scripts/gcc-plugins/Makefile +4 -0
@@ -12,4 +12,8 @@ endif export GCCPLUGINS_DIR HOSTLIBS +$(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) := cyc_complexity_plugin.so + always := $($(HOSTLIBS)-y) + +cyc_complexity_plugin-objs := cyc_complexity_plugin.o
scripts/gcc-plugins/cyc_complexity_plugin.c new file +73 -0
73 lines not on this page · raw message
Signature · 1 line
2.4.1
PATCH v7 5/6 Documentation for the GCC plugin infrastructure
In reply to Emese RevfyThis is the GCC infrastructure documentation about its operation, how to add and use a new plugin with an example.
--- Documentation/gcc-plugins.txt | 83 +++++++++++++++++++++++++++++++++++++++++++ arch/Kconfig | 2 ++ 2 files changed, 85 insertions(+) create mode 100644 Documentation/gcc-plugins.txt
Documentation/gcc-plugins.txt new file +83 -0
@@ -0,0 +1,83 @@ +GCC plugin infrastructure +========================= + + +1. Introduction +=============== + +GCC plugins are loadable modules that provide extra features to the +compiler [1]. They are useful for runtime instrumentation and static analysis. +We can analyse, change and add further code during compilation via +callbacks [2], GIMPLE [3], IPA [4] and RTL passes [5]. + +The GCC plugin infrastructure of the kernel supports all gcc versions from +4.5 to 6.0, building out-of-tree modules, cross-compilation and building in a +separate directory. + +Currently the GCC plugin infrastructure supports only the x86, arm and arm64 +architectures. + +This infrastructure was ported from grsecurity [6] and PaX [7]. + +-- +[1] https://gcc.gnu.org/onlinedocs/gccint/Plugins.html +[2] https://gcc.gnu.org/onlinedocs/gccint/Plugin-API.html#Plugin-API +[3] https://gcc.gnu.org/onlinedocs/gccint/GIMPLE.html +[4] https://gcc.gnu.org/onlinedocs/gccint/IPA.html +[5] https://gcc.gnu.org/onlinedocs/gccint/RTL.html +[6] https://grsecurity.net/ +[7] https://pax.grsecurity.net/ + + +2. Files +======== + +$(src)/scripts/gcc-plugins + This is the directory of the GCC plugins. + +$(src)/scripts/gcc-plugins/gcc-common.h + This is a compatibility header for GCC plugins. + It should be always included instead of individual gcc headers. + +$(src)/scripts/gcc-plugin.sh + This script checks the availability of the included headers in + gcc-common.h and chooses the proper host compiler to build the plugins + (gcc-4.7 can be built by either gcc or g++). + +$(src)/scripts/gcc-plugins/gcc-generate-gimple-pass.h +$(src)/scripts/gcc-plugins/gcc-generate-ipa-pass.h +$(src)/scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h +$(src)/scripts/gcc-plugins/gcc-generate-rtl-pass.h + These headers automatically generate the registration structures for + GIMPLE, SIMPLE_IPA, IPA and RTL passes. They support all gcc versions + from 4.5 to 6.0. + They should be preferred to creating the structures by hand. + + +3. Usage +======== + +You must install the gcc plugin headers for your gcc version, +e.g., on Ubuntu for gcc-4.9: + + apt-get install gcc-4.9-plugin-dev + +Enable a GCC plugin based feature in the kernel config: + + CONFIG_GCC_PLUGIN_CYC_COMPLEXITY = y + +To compile only the plugin(s): + + make gcc-plugins + +or just run the kernel make and compile the whole kernel with +the cyclomatic complexity GCC plugin. + + +4. How to add a new GCC plugin +============================== + +The GCC plugins are in $(src)/scripts/gcc-plugins/. You can use a file or a directory +here. It must be added to $(src)/scripts/gcc-plugins/Makefile, +$(src)/scripts/Makefile.gcc-plugins and $(src)/arch/Kconfig. +See the cyc_complexity_plugin.c (CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) GCC plugin.
arch/Kconfig +2 -0
@@ -366,6 +366,8 @@ menuconfig GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. + See Documentation/gcc-plugins.txt for details. + config GCC_PLUGIN_CYC_COMPLEXITY bool "Compute the cyclomatic complexity of a function" depends on GCC_PLUGINS
Signature · 1 line
2.4.1
PATCH v7 6/6 Add sancov plugin
In reply to Emese RevfyThe sancov gcc plugin inserts a __sanitizer_cov_trace_pc() call at the start of basic blocks.
This plugin is a helper plugin for the kcov feature. It supports all gcc versions with plugin support (from gcc-4.5 on).
It is based on the gcc commit "Add fuzzing coverage support" by Dmitry Vyukov
(https://gcc.gnu.org/viewcvs/gcc?limit_changes=0&view=revision&revision=231296).
--- Makefile | 10 +-- arch/Kconfig | 9 +++ arch/x86/purgatory/Makefile | 2 + lib/Kconfig.debug | 2 + scripts/Makefile.gcc-plugins | 18 +++++ scripts/gcc-plugins/Makefile | 5 ++ scripts/gcc-plugins/sancov_plugin.c | 144 ++++++++++++++++++++++++++++++++++++ 7 files changed, 181 insertions(+), 9 deletions(-) create mode 100644 scripts/gcc-plugins/sancov_plugin.c
Makefile +1 -9
@@ -365,7 +365,7 @@ LDFLAGS_MODULE = CFLAGS_KERNEL = AFLAGS_KERNEL = CFLAGS_GCOV = -fprofile-arcs -ftest-coverage -CFLAGS_KCOV = -fsanitize-coverage=trace-pc +CFLAGS_KCOV := $(call cc-option,-fsanitize-coverage=trace-pc,) # Use USERINCLUDE when you must reference the UAPI directories only.
@@ -685,14 +685,6 @@ endif endif KBUILD_CFLAGS += $(stackp-flag) -ifdef CONFIG_KCOV - ifeq ($(call cc-option, $(CFLAGS_KCOV)),) - $(warning Cannot use CONFIG_KCOV: \ - -fsanitize-coverage=trace-pc is not supported by compiler) - CFLAGS_KCOV = - endif -endif - ifeq ($(cc-name),clang) KBUILD_CPPFLAGS += $(call cc-option,-Qunused-arguments,) KBUILD_CPPFLAGS += $(call cc-option,-Wno-unknown-warning-option,)
arch/Kconfig +9 -0
@@ -380,6 +380,15 @@ config GCC_PLUGIN_CYC_COMPLEXITY N = the number of nodes P = the number of connected components (exit nodes). +config GCC_PLUGIN_SANCOV + bool + depends on GCC_PLUGINS + help + This plugin inserts a __sanitizer_cov_trace_pc() call at the start of + basic blocks. It supports all gcc versions with plugin support (from + gcc-4.5 on). It is based on the commit "Add fuzzing coverage support" + by Dmitry Vyukov <[email protected]>. + config HAVE_CC_STACKPROTECTOR bool help
arch/x86/purgatory/Makefile +2 -0
@@ -8,6 +8,8 @@ PURGATORY_OBJS = $(addprefix $(obj)/,$(purgatory-y)) LDFLAGS_purgatory.ro := -e purgatory_start -r --no-undefined -nostdlib -z nodefaultlib targets += purgatory.ro +KCOV_INSTRUMENT := n + # Default KBUILD_CFLAGS can have -pg option set when FTRACE is enabled. That # in turn leaves some undefined symbols like __fentry__ in purgatory and not # sure how to relocate those. Like kexec-tools, use custom flags.
lib/Kconfig.debug +2 -0
@@ -708,6 +708,8 @@ config KCOV bool "Code coverage for fuzzing" depends on ARCH_HAS_KCOV select DEBUG_FS + select GCC_PLUGINS + select GCC_PLUGIN_SANCOV help KCOV exposes kernel code coverage information in a form suitable for coverage-guided fuzzing (randomized testing).
scripts/Makefile.gcc-plugins +18 -0
@@ -2,8 +2,23 @@ ifdef CONFIG_GCC_PLUGINS __PLUGINCC := $(call cc-ifversion, -ge, 0408, $(HOSTCXX), $(HOSTCC)) PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + SANCOV_PLUGIN := -fplugin=$(objtree)/scripts/gcc-plugins/sancov_plugin.so + gcc-plugin-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) += cyc_complexity_plugin.so + ifdef CONFIG_GCC_PLUGIN_SANCOV + ifeq ($(CFLAGS_KCOV),) + # It is needed because of the gcc-plugin.sh and gcc version checks. + gcc-plugin-$(CONFIG_GCC_PLUGIN_SANCOV) += sancov_plugin.so + + ifneq ($(PLUGINCC),) + CFLAGS_KCOV := $(SANCOV_PLUGIN) + else + $(error Cannot use CONFIG_KCOV: -fsanitize-coverage=trace-pc is not supported by compiler) + endif + endif + endif + GCC_PLUGINS_CFLAGS := $(addprefix -fplugin=$(objtree)/scripts/gcc-plugins/, $(gcc-plugin-y)) ifeq ($(PLUGINCC),)
@@ -15,6 +30,9 @@ ifdef CONFIG_GCC_PLUGINS $(error error, your gcc version does not support plugins, you should upgrade it to gcc 4.5 at least) endif endif + else + # SANCOV_PLUGIN can be only in CFLAGS_KCOV because avoid duplication. + GCC_PLUGINS_CFLAGS := $(filter-out $(SANCOV_PLUGIN), $(GCC_PLUGINS_CFLAGS)) endif KBUILD_CFLAGS += $(GCC_PLUGINS_CFLAGS)
scripts/gcc-plugins/Makefile +5 -0
@@ -14,6 +14,11 @@ export GCCPLUGINS_DIR HOSTLIBS $(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) := cyc_complexity_plugin.so +ifeq ($(CFLAGS_KCOV), -fplugin=$(objtree)/scripts/gcc-plugins/sancov_plugin.so) + $(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_SANCOV) += sancov_plugin.so +endif + always := $($(HOSTLIBS)-y) cyc_complexity_plugin-objs := cyc_complexity_plugin.o +sancov_plugin-objs := sancov_plugin.o
scripts/gcc-plugins/sancov_plugin.c new file +144 -0
144 lines not on this page · raw message
Signature · 1 line
2.4.1
Re: [PATCH v7 6/6] Add sancov plugin
Quoted 7 lines · Emese Revfy
The sancov gcc plugin inserts a
__sanitizer_cov_trace_pc()call at the start of basic blocks.This plugin is a helper plugin for the kcov feature. It supports all gcc versions with plugin support (from gcc-4.5 on).
It is based on the gcc commit "Add fuzzing coverage support" by Dmitry Vyukov
(https://gcc.gnu.org/viewcvs/gcc?limit_changes=0&view=revision&revision=231296).
+syzkaller mailing list
Quoted 293 lines
Signed-off-by Emese Revfy <[email protected]>--- Makefile | 10 +-- arch/Kconfig | 9 +++ arch/x86/purgatory/Makefile | 2 + lib/Kconfig.debug | 2 + scripts/Makefile.gcc-plugins | 18 +++++ scripts/gcc-plugins/Makefile | 5 ++ scripts/gcc-plugins/sancov_plugin.c | 144 ++++++++++++++++++++++++++++++++++++ 7 files changed, 181 insertions(+), 9 deletions(-) create mode 100644 scripts/gcc-plugins/sancov_plugin.cMakefile +1
-9@@ -365,7 +365,7 @@ LDFLAGS_MODULE = CFLAGS_KERNEL = AFLAGS_KERNEL = CFLAGS_GCOV = -fprofile-arcs -ftest-coverage -CFLAGS_KCOV = -fsanitize-coverage=trace-pc +CFLAGS_KCOV := $(call cc-option,-fsanitize-coverage=trace-pc,) # Use USERINCLUDE when you must reference the UAPI directories only.@@ -685,14 +685,6 @@ endif endif KBUILD_CFLAGS += $(stackp-flag) -ifdef CONFIG_KCOV - ifeq ($(call cc-option, $(CFLAGS_KCOV)),) - $(warning Cannot use CONFIG_KCOV: \ - -fsanitize-coverage=trace-pc is not supported by compiler) - CFLAGS_KCOV = - endif -endif - ifeq ($(cc-name),clang) KBUILD_CPPFLAGS += $(call cc-option,-Qunused-arguments,) KBUILD_CPPFLAGS += $(call cc-option,-Wno-unknown-warning-option,)arch/Kconfig +9
-0@@ -380,6 +380,15 @@ config GCC_PLUGIN_CYC_COMPLEXITY N = the number of nodes P = the number of connected components (exit nodes). +config GCC_PLUGIN_SANCOV + bool + depends on GCC_PLUGINS + help + This plugin inserts a __sanitizer_cov_trace_pc() call at the start of + basic blocks. It supports all gcc versions with plugin support (from + gcc-4.5 on). It is based on the commit "Add fuzzing coverage support" + by Dmitry Vyukov <[email protected]>. + config HAVE_CC_STACKPROTECTOR bool helparch/x86/purgatory/Makefile +2
-0@@ -8,6 +8,8 @@ PURGATORY_OBJS = $(addprefix $(obj)/,$(purgatory-y)) LDFLAGS_purgatory.ro := -e purgatory_start -r --no-undefined -nostdlib -z nodefaultlib targets += purgatory.ro +KCOV_INSTRUMENT := n + # Default KBUILD_CFLAGS can have -pg option set when FTRACE is enabled. That # in turn leaves some undefined symbols like __fentry__ in purgatory and not # sure how to relocate those. Like kexec-tools, use custom flags.lib/Kconfig.debug +2
-0@@ -708,6 +708,8 @@ config KCOV bool "Code coverage for fuzzing" depends on ARCH_HAS_KCOV select DEBUG_FS + select GCC_PLUGINS + select GCC_PLUGIN_SANCOV help KCOV exposes kernel code coverage information in a form suitable for coverage-guided fuzzing (randomized testing).scripts/Makefile.gcc-plugins +18
-0@@ -2,8 +2,23 @@ ifdef CONFIG_GCC_PLUGINS __PLUGINCC := $(call cc-ifversion, -ge, 0408, $(HOSTCXX), $(HOSTCC)) PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + SANCOV_PLUGIN := -fplugin=$(objtree)/scripts/gcc-plugins/sancov_plugin.so + gcc-plugin-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) += cyc_complexity_plugin.so + ifdef CONFIG_GCC_PLUGIN_SANCOV + ifeq ($(CFLAGS_KCOV),) + # It is needed because of the gcc-plugin.sh and gcc version checks. + gcc-plugin-$(CONFIG_GCC_PLUGIN_SANCOV) += sancov_plugin.so + + ifneq ($(PLUGINCC),) + CFLAGS_KCOV := $(SANCOV_PLUGIN) + else + $(error Cannot use CONFIG_KCOV: -fsanitize-coverage=trace-pc is not supported by compiler) + endif + endif + endif + GCC_PLUGINS_CFLAGS := $(addprefix -fplugin=$(objtree)/scripts/gcc-plugins/, $(gcc-plugin-y)) ifeq ($(PLUGINCC),)@@ -15,6 +30,9 @@ ifdef CONFIG_GCC_PLUGINS $(error error, your gcc version does not support plugins, you should upgrade it to gcc 4.5 at least) endif endif + else + # SANCOV_PLUGIN can be only in CFLAGS_KCOV because avoid duplication. + GCC_PLUGINS_CFLAGS := $(filter-out $(SANCOV_PLUGIN), $(GCC_PLUGINS_CFLAGS)) endif KBUILD_CFLAGS += $(GCC_PLUGINS_CFLAGS)scripts/gcc-plugins/Makefile +5
-0@@ -14,6 +14,11 @@ export GCCPLUGINS_DIR HOSTLIBS $(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) := cyc_complexity_plugin.so +ifeq ($(CFLAGS_KCOV), -fplugin=$(objtree)/scripts/gcc-plugins/sancov_plugin.so) + $(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_SANCOV) += sancov_plugin.so +endif + always := $($(HOSTLIBS)-y) cyc_complexity_plugin-objs := cyc_complexity_plugin.o +sancov_plugin-objs := sancov_plugin.oscripts/gcc-plugins/sancov_plugin.c new file +144
-1@@ -0,0 +1,144 @@ +/* +* Copyright 2011-2016 by Emese Revfy <[email protected]> +* Licensed under the GPL v2, or (at your option) v3 +* +* Homepage: +* https://github.com/ephox-gcc-plugins/sancov +* +* This plugin inserts a __sanitizer_cov_trace_pc() call at the start of basic blocks. +* It supports all gcc versions with plugin support (from gcc-4.5 on). +* It is based on the commit "Add fuzzing coverage support" by Dmitry Vyukov <[email protected]>. +* +* You can read about it more here: +* https://gcc.gnu.org/viewcvs/gcc?limit_changes=0&view=revision&revision=231296 +* http://lwn.net/Articles/674854/ +* https://github.com/google/syzkaller +* https://lwn.net/Articles/677764/ +* +* Usage: +* make run +*/ + +#include "gcc-common.h" + +int plugin_is_GPL_compatible; + +tree sancov_fndecl; + +static struct plugin_info sancov_plugin_info = { + .version ="20160402" , + .help ="sancov plugin\n" , +}; + +static unsigned int sancov_execute (void ) +{ +basic_block bb; + +/* Remove this line when this plugin and kcov will be in the kernel. +if (!strcmp(DECL_NAME_POINTER(current_function_decl), DECL_NAME_POINTER(sancov_fndecl))) +return 0; +*/ + + FOR_EACH_BB_FN(bb, cfun) { +const_gimple stmt; +gcall *gcall; +gimple_stmt_iterator gsi =gsi_after_labels (bb); + +if (gsi_end_p (gsi)) +continue ; + + stmt =gsi_stmt (gsi); + gcall =as_a_gcall (gimple_build_call (sancov_fndecl,0 )); +gimple_set_location (gcall,gimple_location (stmt)); +gsi_insert_before (&gsi, gcall,GSI_SAME_STMT ); + } +return 0 ; +} + +#define PASS_NAME sancov + +#define NO_GATE +#define TODO_FLAGS_FINISH TODO_dump_func | TODO_verify_stmts | TODO_update_ssa_no_phi | TODO_verify_flow + +#include "gcc-generate-gimple-pass.h" + +static void sancov_start_unit(void __unused *gcc_data, void __unused *user_data) +{ +tree leaf_attr, nothrow_attr; +tree BT_FN_VOID =build_function_type_list (void_type_node,NULL_TREE ); + + sancov_fndecl =build_fn_decl ("__sanitizer_cov_trace_pc" ,BT_FN_VOID ); + +DECL_ASSEMBLER_NAME (sancov_fndecl); +TREE_PUBLIC (sancov_fndecl) =1 ; +DECL_EXTERNAL (sancov_fndecl) =1 ; +DECL_ARTIFICIAL (sancov_fndecl) =1 ; +DECL_PRESERVE_P (sancov_fndecl) =1 ; +DECL_UNINLINABLE (sancov_fndecl) =1 ; +TREE_USED (sancov_fndecl) =1 ; + + nothrow_attr =tree_cons (get_identifier ("nothrow" ),NULL ,NULL ); +decl_attributes (&sancov_fndecl, nothrow_attr,0 ); +gcc_assert (TREE_NOTHROW (sancov_fndecl)); +#if BUILDING_GCC_VERSION >4005 + leaf_attr =tree_cons (get_identifier ("leaf" ),NULL ,NULL ); +decl_attributes (&sancov_fndecl, leaf_attr,0 ); +#endif +} + +int plugin_init (struct plugin_name_args *plugin_info,struct plugin_gcc_version *version) +{ +int i; +struct register_pass_info sancov_plugin_pass_info; +const char *const plugin_name = plugin_info->base_name; +const int argc = plugin_info->argc; +const struct plugin_argument *const argv = plugin_info->argv; +bool enable = true; + +static const struct ggc_root_tab gt_ggc_r_gt_sancov[] = { + { + .base = &sancov_fndecl, + .nelt =1 , + .stride =sizeof (sancov_fndecl), + .cb = >_ggc_mx_tree_node, + .pchw = >_pch_nx_tree_node + }, +LAST_GGC_ROOT_TAB + }; + +/* BBs can be split afterwards?? */ + sancov_plugin_pass_info.pass =make_sancov_pass (); +#if BUILDING_GCC_VERSION >=4009 + sancov_plugin_pass_info.reference_pass_name ="asan" ; +#else + sancov_plugin_pass_info.reference_pass_name ="nrv" ; +#endif + sancov_plugin_pass_info.ref_pass_instance_number =0 ; + sancov_plugin_pass_info.pos_op =PASS_POS_INSERT_BEFORE ; + +if (!plugin_default_version_check (version, &gcc_version)) { +error (G_ ("incompatible gcc/plugin versions" )); +return 1 ; + } + +for (i =0 ; i < argc; ++i) { +if (!strcmp (argv[i].key,"no-sancov" )) { + enable = false; +continue ; + } +error (G_ ("unkown option '-fplugin-arg-%s-%s'" ), plugin_name, argv[i].key); + } + +register_callback (plugin_name,PLUGIN_INFO ,NULL , &sancov_plugin_info); + +if (!enable) +return 0 ; + +#if BUILDING_GCC_VERSION <6000 +register_callback (plugin_name,PLUGIN_START_UNIT , &sancov_start_unit,NULL ); +register_callback (plugin_name,PLUGIN_REGISTER_GGC_ROOTS ,NULL , (void *)>_ggc_r_gt_sancov); +register_callback (plugin_name,PLUGIN_PASS_MANAGER_SETUP ,NULL , &sancov_plugin_pass_info); +#endif + +return 0 ; +} --2.4.1
Quoted 81 lines · Emese Revfy
This patch set introduce the GCC plugin infrastructure with examples for testing and documentation.
GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis.
The infrastructure supports all gcc versions from 4.5 to 6.0, building out-of-tree modules and building in a separate directory. Cross-compilation is supported too but currently only the x86, arm and arm64 architectures enables plugins.
This infrastructure was ported from grsecurity/PaX. It is a CII project supported by the Linux Foundation.
Emese Revfy (6):
Shared library support
GCC plugin infrastructure
The GCC plugin infrastructure supports the arm and arm64 architectures too Add Cyclomatic complexity plugin
Documentations of the GCC plugin infrastructre
Add sancov pluginChanges from v6:
* Disable the sancov plugin wheneverKCOV_INSTRUMENTis disabled (Reported-by: Huang Ying <[email protected]>)
* Disable KCOV/sancov plugin because this is not a regular kernel code (Reported-by: Huang Ying <[email protected]>)
* Removed unnecessary gcc plugin cflags
(Signed-off-by: Masahiro Yamada <[email protected]>)
* Removed unnecessary gcc plugin aflagsChanges from v5:
* Set important properties on the external fndecl (Add sancov plugin)
* Revert documentation change too (Shared library support)
(Suggested-by: Kees Cook <[email protected]>)
* The GCC plugin infrastructure now supports the arm and arm64 architectures too (Signed-off-by: David Brown <[email protected]>)
* Simplify the computation of PLUGINCC (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Simplify the invocation ofgcc-plugin.sh(GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Make use of multi-depend (Shared library support)
(Suggested-by: Masahiro Yamada <[email protected]>)
* Remove unnecessary exports (GCC plugin infrastructure)
(Suggested-by: Masahiro Yamada <[email protected]>)
* SimplifyMakefileby using addprefix (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Moved the gcc plugins fromtools/toscripts/(GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Removed plugins fromKBUILD_CFLAGS_32(GCC plugin infrastructure)
* Remove gcc-plugin target everywhere
(Suggested-by and partly Written-by: Masahiro Yamada <[email protected]>)
* There is no leaf gcc attribute in gcc-4.5 (Add sancov plugin)
* Added support to the sancov plugin with kcov (Add sancov plugin)Changes from v4:
* Moved shared library support from the GCC plugin infrastructure patch into a different patch
* Update gcc-*.h from PaX
* Fixedgcc-common.hfor gcc 6
* Added pass cloning support to the gcc pass generators
* Disable all plugins in vdso because it is userland code
* Add sancov gcc plugin: another use case for gcc plugin support in the kernel is when there is a feature in the latest gcc version and we would like to use it with older gcc versions as well (e.g., distros).Changes from v3:
* Fix some indentation related warnings
(Suggested by checkpatch.pl)
* Add maintainer entries
* Don't rungcc_plugin.shwhen theGCC_PLUGINSoption is disabled or unsupported (Reported-by: Fengguang Wu <[email protected]>)Changes from v2:
* Fixed incorrectly encoded characters
* Generate the GIMPLE, IPA,SIMPLE_IPAand RTL pass structures (Suggested-by: Rasmus Villemoes <[email protected]>)
* Write plugin related warning messages to stderr instead of stdout (Suggested-by: Kees Cook <[email protected]>)
* Mention the installation of the gcc plugin headers (Documentation)
Quoted 6 lines
Changes from v1:
* Move the gcc-plugins make target into a separateMakefilebecause there may be a lot of plugins (Suggested-by: Rasmus Villemoes)
* Simplify the dependencies of the plugin related config option (Suggested-by: Kees Cook <[email protected]>)
* Removed the unnecessary example plugin
This looks really good to me! Masahiro are there any other things you see here that need fixing? Michal, does this look like it's ready for -next? I'd be happy to carry it via one of my trees if you want.
-Kees
Quoted 32 lines
--- Documentation/dontdiff | 1 + Documentation/gcc-plugins.txt | 83 +++ Documentation/kbuild/makefiles.txt | 39 +- Documentation/kernel-parameters.txt | 5 + MAINTAINERS | 8 + Makefile | 25 +- arch/Kconfig | 36 + arch/arm/Kconfig | 1 + arch/arm64/Kconfig | 1 + arch/x86/Kconfig | 1 + arch/x86/entry/vdso/Makefile | 3 +- arch/x86/purgatory/Makefile | 2 + lib/Kconfig.debug | 2 + scripts/Makefile | 2 +- scripts/Makefile.build | 2 +- scripts/Makefile.clean | 3 +- scripts/Makefile.gcc-plugins | 40 + scripts/Makefile.host | 70 +- scripts/gcc-plugin.sh | 51 ++ scripts/gcc-plugins/Makefile | 24 + scripts/gcc-plugins/cyc_complexity_plugin.c | 73 ++ scripts/gcc-plugins/gcc-common.h | 830 +++++++++++++++++++++ scripts/gcc-plugins/gcc-generate-gimple-pass.h | 175 +++++ scripts/gcc-plugins/gcc-generate-ipa-pass.h | 289 +++++++ scripts/gcc-plugins/gcc-generate-rtl-pass.h | 175 +++++ scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h | 175 +++++ scripts/gcc-plugins/sancov_plugin.c | 144 ++++ scripts/link-vmlinux.sh | 2 +- scripts/package/builddeb | 1 + 29 files changed, 2239 insertions(+), 25 deletions(-)
Signature · 2 lines
Kees Cook Chrome OS & Brillo Security
2016-04-27 5:40 GMT+09:00 Kees Cook <[email protected]>:
Quoted 89 lines · Emese Revfy
Quoted 81 lines
This patch set introduce the GCC plugin infrastructure with examples for testing and documentation.
GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis.
The infrastructure supports all gcc versions from 4.5 to 6.0, building out-of-tree modules and building in a separate directory. Cross-compilation is supported too but currently only the x86, arm and arm64 architectures enables plugins.
This infrastructure was ported from grsecurity/PaX. It is a CII project supported by the Linux Foundation.
Emese Revfy (6):
Shared library support
GCC plugin infrastructure
The GCC plugin infrastructure supports the arm and arm64 architectures too Add Cyclomatic complexity plugin
Documentations of the GCC plugin infrastructre
Add sancov pluginChanges from v6:
* Disable the sancov plugin wheneverKCOV_INSTRUMENTis disabled (Reported-by: Huang Ying <[email protected]>)
* Disable KCOV/sancov plugin because this is not a regular kernel code (Reported-by: Huang Ying <[email protected]>)
* Removed unnecessary gcc plugin cflags
(Signed-off-by: Masahiro Yamada <[email protected]>)
* Removed unnecessary gcc plugin aflagsChanges from v5:
* Set important properties on the external fndecl (Add sancov plugin)
* Revert documentation change too (Shared library support)
(Suggested-by: Kees Cook <[email protected]>)
* The GCC plugin infrastructure now supports the arm and arm64 architectures too (Signed-off-by: David Brown <[email protected]>)
* Simplify the computation of PLUGINCC (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Simplify the invocation ofgcc-plugin.sh(GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Make use of multi-depend (Shared library support)
(Suggested-by: Masahiro Yamada <[email protected]>)
* Remove unnecessary exports (GCC plugin infrastructure)
(Suggested-by: Masahiro Yamada <[email protected]>)
* SimplifyMakefileby using addprefix (GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Moved the gcc plugins fromtools/toscripts/(GCC plugin infrastructure) (Suggested-by: Masahiro Yamada <[email protected]>)
* Removed plugins fromKBUILD_CFLAGS_32(GCC plugin infrastructure)
* Remove gcc-plugin target everywhere
(Suggested-by and partly Written-by: Masahiro Yamada <[email protected]>)
* There is no leaf gcc attribute in gcc-4.5 (Add sancov plugin)
* Added support to the sancov plugin with kcov (Add sancov plugin)Changes from v4:
* Moved shared library support from the GCC plugin infrastructure patch into a different patch
* Update gcc-*.h from PaX
* Fixedgcc-common.hfor gcc 6
* Added pass cloning support to the gcc pass generators
* Disable all plugins in vdso because it is userland code
* Add sancov gcc plugin: another use case for gcc plugin support in the kernel is when there is a feature in the latest gcc version and we would like to use it with older gcc versions as well (e.g., distros).Changes from v3:
* Fix some indentation related warnings
(Suggested by checkpatch.pl)
* Add maintainer entries
* Don't rungcc_plugin.shwhen theGCC_PLUGINSoption is disabled or unsupported (Reported-by: Fengguang Wu <[email protected]>)Changes from v2:
* Fixed incorrectly encoded characters
* Generate the GIMPLE, IPA,SIMPLE_IPAand RTL pass structures (Suggested-by: Rasmus Villemoes <[email protected]>)
* Write plugin related warning messages to stderr instead of stdout (Suggested-by: Kees Cook <[email protected]>)
* Mention the installation of the gcc plugin headers (Documentation)Quoted 6 lines
Changes from v1:
* Move the gcc-plugins make target into a separateMakefilebecause there may be a lot of plugins (Suggested-by: Rasmus Villemoes)
* Simplify the dependencies of the plugin related config option (Suggested-by: Kees Cook <[email protected]>)
* Removed the unnecessary example plugin
Quoted 3 lines
This looks really good to me! Masahiro are there any other things you see here that need fixing? Michal, does this look like it's ready for -next? I'd be happy to carry it via one of my trees if you want.
I am busy these days, but hopefully I will manage to find some time to review this series this weekend.
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 1/6] Shared library support
In reply to Emese RevfyHi Emese,
2016-04-23 3:21 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 41 lines
Infrastructure for building independent shared library targets. This effectively also reverts commit
62e2210798ed38928ab24841e8b4878a(Masahiro Yamada, kbuild: drop shared library support from Makefile.host).Signed-off-by Emese Revfy <[email protected]>--- Documentation/kbuild/makefiles.txt | 39 ++++++++++++++++----- scripts/Makefile.build | 2 +- scripts/Makefile.clean | 3 +- scripts/Makefile.host | 70 +++++++++++++++++++++++++++++++++++++- 4 files changed, 103 insertions(+), 11 deletions(-)Documentation/kbuild/makefiles.txt +9
-5@@ -23,10 +23,11 @@ This document describes the Linux kernel Makefiles. === 4 Host Program support --- 4.1 Simple Host Program --- 4.2 Composite Host Programs - --- 4.3 Using C++ for host programs - --- 4.4 Controlling compiler options for host programs - --- 4.5 When host programs are actually built - --- 4.6 Using hostprogs-$(CONFIG_FOO) + --- 4.3 Defining shared libraries + --- 4.4 Using C++ for host programs + --- 4.5 Controlling compiler options for host programs + --- 4.6 When host programs are actually built + --- 4.7 Using hostprogs-$(CONFIG_FOO) === 5 Kbuild clean infrastructure@@ -643,7 +644,29 @@ Both possibilities are described in the following. Finally, the two .o files are linked to the executable, lxdialog. Note: The syntax <executable>-y is not permitted for host-programs. ---- 4.3 Using C++ for host programs +--- 4.3 Defining shared libraries + + Objects with extension .so are considered shared libraries, and + will be compiled as position independent objects.
Documentation/kbuild/makefiles.txt Both possibilities are described in the following. · line 660
Quoted 10 lines
Documentation/kbuild/makefiles.txt +10
-0+ Kbuild provides support for shared libraries, but the usage + shall be restricted. + In the following example the libkconfig.so shared library is used + to link the executable conf. + + Example: + #scripts/kconfig/Makefile + hostprogs-y := conf + conf-objs := conf.o libkconfig.so + libkconfig-objs := expr.o type.o
Do you use this case?
Documentation/kbuild/makefiles.txt Both possibilities are described in the following. · line 667
Quoted 6 lines
Documentation/kbuild/makefiles.txt +6
-0+ Shared libraries always require a corresponding -objs line, and + in the example above the shared library libkconfig is composed by + the two objects expr.o and type.o. + expr.o and type.o will be built as position independent code and + linked as a shared library libkconfig.so. C++ is not supported for + shared libraries.
You are supporting C++ shared libraries.
Please do not revert as is, but change the comments to make sense.
In the first place,
I am wondering if we need to revive this documentation. What this commit is only interested in *.so generation, not host program support.
Quoted 16 lines
scripts/Makefile.build +1
-1@@ -60,7 +60,7 @@ endif endif # Do not include host rules unless needed -ifneq ($(hostprogs-y)$(hostprogs-m),) +ifneq ($(hostprogs-y)$(hostprogs-m)$(hostlibs-y)$(hostlibs-m)$(hostcxxlibs-y)$(hostcxxlibs-m),) include scripts/Makefile.host endifscripts/Makefile.clean +0
-0
scripts/Makefile.clean subdir-ymn := $(addprefix $(obj)/,$(subdir-ymn)) · line 42
Quoted 6 lines
scripts/Makefile.clean +2
-1@@ -38,7 +38,8 @@ subdir-ymn := $(addprefix $(obj)/,$(subdir-ymn)) __clean-files := $(extra-y) $(extra-m) $(extra-) \ $(always) $(targets) $(clean-files) \ $(host-progs) \ - $(hostprogs-y) $(hostprogs-m) $(hostprogs-) + $(hostprogs-y) $(hostprogs-m) $(hostprogs-) \ + $(hostlibs-y) $(hostlibs-m) $(hostlibs-)
$(hostcxxlibs-y)$(hostcxxlibs-m) is missing here.
BTW, are you planning to support hostlibs without .so extention in the future?
You are changing the top Makefile to clean with "*.so" pattern rule.
Do you need to change both the top Makefile and Makefile.clean for belt-and-braces cleaning?
Quoted 9 lines
scripts/Makefile.clean +0
-0__clean-files := $(filter-out $(no-clean-files), $(__clean-files))scripts/Makefile.host +0
-0@@ -20,7 +20,25 @@ # Will compile qconf as a C++ program, and menu as a C program. # They are linked as C++ code to the executable qconf
scripts/Makefile.host line 31
Quoted 10 lines
scripts/Makefile.host +9
-0+# hostprogs-y := conf +# conf-objs := conf.o libkconfig.so +# libkconfig-objs := expr.o type.o +# Will create a shared library named libkconfig.so that consists of +# expr.o and type.o (they are both compiled as C code and the object files +# are made as position independent code). +# conf.c is compiled as a C program, and conf.o is linked together with +# libkconfig.so as the executable conf. +# Note: Shared libraries consisting of C++ files are not supported
Again, do you need to support "hostprogs-y" based on .so library?
Quoted 13 lines
scripts/Makefile.host +8
-0+# hostcc-option +# Usage: cflags-y += $(call hostcc-option,-march=winchip-c6,-march=i586) + +hostcc-option = $(call try-run,\ + $(HOSTCC) $(HOSTCFLAGS) $(HOST_EXTRACFLAGS) $(1) -c -x c /dev/null -o "$$TMP",$(1),$(2)) + __hostprogs := $(sort $(hostprogs-y) $(hostprogs-m)) +__hostlibs := $(sort $(hostlibs-y) $(hostlibs-m)) +__hostcxxlibs := $(sort $(hostcxxlibs-y) $(hostcxxlibs-m)) # C code # Executables compiled from a single .c file
scripts/Makefile.host host-cxxmulti := $(foreach m,$(__hostprogs),$(if $($(m)-cxxobjs),$(m))) · line 66
Quoted 7 lines
scripts/Makefile.host +4
-0@@ -42,6 +60,18 @@ host-cxxmulti := $(foreach m,$(__hostprogs),$(if $($(m)-cxxobjs),$(m))) # C++ Object (.o) files compiled from .cc files host-cxxobjs := $(sort $(foreach m,$(host-cxxmulti),$($(m)-cxxobjs))) +# Shared libaries (only .c supported) +# Shared libraries (.so) - all .so files referenced in "xxx-objs" +host-cshlib := $(sort $(filter %.so, $(__hostlibs))) +host-cxxshlib := $(sort $(filter %.so, $(__hostcxxlibs)))
Do you use $(filter %.so, ...) on purpose?
i.e. are you planning to support both hostlibs with/without .so?
scripts/Makefile.host host-cxxmulti := $(foreach m,$(__hostprogs),$(if $($(m)-cxxobjs),$(m))) · line 69
Quoted 3 lines
scripts/Makefile.host +3
-0+# Remove .so files from "xxx-objs" +host-cobjs := $(filter-out %.so,$(host-cobjs)) +host-cxxobjs := $(filter-out %.so,$(host-cxxobjs))
Why do you need to do this?
Quoted 20 lines
scripts/Makefile.host +8
-0+# Object (.o) files used by the shared libaries +host-cshobjs := $(sort $(foreach m,$(host-cshlib),$($(m:.so=-objs)))) +host-cxxshobjs := $(sort $(foreach m,$(host-cxxshlib),$($(m:.so=-objs)))) + # output directory for programs/.o files # hostprogs-y := tools/build may have been specified. # Retrieve also directory of .o files from prog-objs or prog-cxxobjs notation@@ -56,6 +86,10 @@ host-cmulti := $(addprefix $(obj)/,$(host-cmulti)) host-cobjs := $(addprefix $(obj)/,$(host-cobjs)) host-cxxmulti := $(addprefix $(obj)/,$(host-cxxmulti)) host-cxxobjs := $(addprefix $(obj)/,$(host-cxxobjs)) +host-cshlib := $(addprefix $(obj)/,$(host-cshlib)) +host-cxxshlib := $(addprefix $(obj)/,$(host-cxxshlib)) +host-cshobjs := $(addprefix $(obj)/,$(host-cshobjs)) +host-cxxshobjs := $(addprefix $(obj)/,$(host-cxxshobjs)) host-objdirs := $(addprefix $(obj)/,$(host-objdirs)) obj-dirs += $(host-objdirs)@@ -124,5 +158,39 @@ quiet_cmd_host-cxxobjs = HOSTCXX $@ $(host-cxxobjs): $(obj)/%.o: $(src)/%.cc FORCE
scripts/Makefile.host quiet_cmd_host-cxxobjs = HOSTCXX $@ · line 168
Quoted 10 lines
scripts/Makefile.host +8
-0$(call if_changed_dep,host-cxxobjs) +# Compile .c file, create position independent .o file +# host-cshobjs -> .o +quiet_cmd_host-cshobjs = HOSTCC -fPIC $@ + cmd_host-cshobjs = $(HOSTCC) $(hostc_flags) -fPIC -c -o $@ $< +$(host-cshobjs): $(obj)/%.o: $(src)/%.c FORCE + $(call if_changed_dep,host-cshobjs) + +# Compile .c file, create position independent .o file
Please explain why c++ compiler should be used to compile .c files.
This is not clear, so worth commenting.
Quoted 5 lines
scripts/Makefile.host +5
-0+# host-cxxshobjs -> .o +quiet_cmd_host-cxxshobjs = HOSTCXX -fPIC $@ + cmd_host-cxxshobjs = $(HOSTCXX) $(hostcxx_flags) -fPIC -c -o $@ $< +$(host-cxxshobjs): $(obj)/%.o: $(src)/%.c FORCE + $(call if_changed_dep,host-cxxshobjs)
scripts/Makefile.host quiet_cmd_host-cxxobjs = HOSTCXX $@ · line 183
Quoted 10 lines
scripts/Makefile.host +10
-0+ +# Link a shared library, based on position independent .o files +# *.o -> .so shared library (host-cshlib) +quiet_cmd_host-cshlib = HOSTLLD -shared $@ + cmd_host-cshlib = $(HOSTCC) $(HOSTLDFLAGS) -shared -o $@ \ + $(addprefix $(obj)/,$($(@F:.so=-objs))) \ + $(HOST_LOADLIBES) $(HOSTLOADLIBES_$(@F)) +$(host-cshlib): FORCE + $(call if_changed,host-cshlib) +$(call multi_depend, $(host-cshlib), .so, -objs -cshobjs)
should be
$(call multi_depend, $(host-cshlib), .so, -objs)
scripts/Makefile.host quiet_cmd_host-cxxobjs = HOSTCXX $@ · line 193
Quoted 9 lines
scripts/Makefile.host +9
-0+# Link a shared library, based on position independent .o files +# *.o -> .so shared library (host-cxxshlib) +quiet_cmd_host-cxxshlib = HOSTLLD -shared $@ + cmd_host-cxxshlib = $(HOSTCXX) $(HOSTLDFLAGS) -shared -o $@ \ + $(addprefix $(obj)/,$($(@F:.so=-objs))) \ + $(HOST_LOADLIBES) $(HOSTLOADLIBES_$(@F)) +$(host-cxxshlib): FORCE + $(call if_changed,host-cxxshlib) +$(call multi_depend, $(host-cxxshlib), .so, -objs -cxxshobjs)
should be
$(call multi_depend, $(host-cxxshlib), .so, -objs)
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 2/6] GCC plugin infrastructure
In reply to Emese RevfyHi Emese,
2016-04-23 3:22 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 4 lines
This patch allows to build the whole kernel with GCC plugins. It was ported from grsecurity/PaX. The infrastructure supports building out-of-tree modules and building in a separate directory. Cross-compilation is supported too but currently only the x86 architecture enables plugins.
Only x86 architecture *at this point*,
but you will add ARM support right after this commit.
Squash 2/6 and 3/6 together and rephrase this comment?
(Instead, you may mention that the ARM portion was tested by David.)
Quoted 1 line
The directory of the gcc plugins is
tools/gcc.
scripts/gcc-plugins.
Quoted 6 lines
MAINTAINERS +0
-0@@ -4777,6 +4777,14 @@ L: [email protected] S: Odd Fixes (e.g., new signatures)
MAINTAINERS L: [email protected] · line 4787
Quoted 10 lines
MAINTAINERS +8
-0F: drivers/scsi/fdomain.* +GCC PLUGINS +M: Kees Cook <[email protected]> +R: Emese Revfy <[email protected]> +L: [email protected] +S: Maintained +F: scripts/gcc-plugins/ +F: Documentation/gcc-plugins.txt +
scripts/gcc-plugin.sh should be also maintained by you guys.
Add an entry for that,
or move the gcc-plugin.sh script into scripts/gcc-plugins/
Quoted 14 lines
arch/x86/entry/vdso/Makefile +1
-1@@ -75,7 +75,7 @@ CFL := $(PROFILING) -mcmodel=small -fPIC -O2 -fasynchronous-unwind-tables -m64 \ -fno-omit-frame-pointer -foptimize-sibling-calls \ -DDISABLE_BRANCH_PROFILING -DBUILD_VDSO -$(vobjs): KBUILD_CFLAGS += $(CFL) +$(vobjs): KBUILD_CFLAGS := $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS)) $(CFL) # # vDSO code runs in userspace and -pg doesn't help with profiling anyway.
arch/x86/entry/vdso/Makefile KBUILD_CFLAGS_32 := $(filter-out -m64,$(KBUILD_CFLAGS)) · line 151
Quoted 7 lines
arch/x86/entry/vdso/Makefile +1
-0@@ -145,6 +145,7 @@ KBUILD_CFLAGS_32 := $(filter-out -m64,$(KBUILD_CFLAGS)) KBUILD_CFLAGS_32 := $(filter-out -mcmodel=kernel,$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 := $(filter-out -fno-pic,$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 := $(filter-out -mfentry,$(KBUILD_CFLAGS_32)) +KBUILD_CFLAGS_32 := $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 += -m32 -msoft-float -mregparm=0 -fpic KBUILD_CFLAGS_32 += $(call cc-option, -fno-stack-protector) KBUILD_CFLAGS_32 += $(call cc-option, -foptimize-sibling-calls)
Looks like gcc-plugins should be omitted only for this directory. Please tell me why.
I am not familiar with x86 architecture, so this is not clear to me.
Quoted 6 lines
scripts/gcc-plugins/Makefile new file +0
-0
scripts/gcc-plugins/Makefile line 9
Quoted 9 lines
scripts/gcc-plugins/Makefile new file +9
-0@@ -0,0 +1,15 @@ +GCC_PLUGINS_DIR := $(shell $(CC) -print-file-name=plugin) + +ifeq ($(PLUGINCC),$(HOSTCC)) +HOSTLIBS := hostlibs +HOST_EXTRACFLAGS += -I$(GCC_PLUGINS_DIR)/include -I$(src) -std=gnu99 -ggdb +export HOST_EXTRACFLAGS +else +HOSTLIBS := hostcxxlibs +HOST_EXTRACXXFLAGS += -I$(GCC_PLUGINS_DIR)/include -I$(src) -std=gnu++98 -fno-rtti -fno-exceptions -fasynchronous-unwind-tables -ggdb -Wno-narrowing -Wno-unused-variable
This line is too long.
Please split into multiple lines.
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 3/6] The GCC plugin infrastructure supports the arm and arm64 architectures too
In reply to Emese RevfyHi Emese, David
2016-04-23 3:23 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 1 line
The GCC plugin infrastructure supports the arm and arm64 architectures too
You need not repeat the same sentence in the body of the git-log.
Quoted 1 line
Signed-off-by David Brown <[email protected]>
The author of this patch is Emese Revfy,
but it is only signed-off by David Brown.
As I mentioned in 2/6,
is it possible to squash this into 2/6 unless David is against doing so?
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 4/6] Add Cyclomatic complexity GCC plugin
In reply to Emese RevfyHi Emese,
2016-04-23 3:24 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 18 lines
scripts/Makefile.gcc-plugins +2
-0@@ -2,6 +2,8 @@ ifdef CONFIG_GCC_PLUGINS __PLUGINCC := $(call cc-ifversion, -ge, 0408, $(HOSTCXX), $(HOSTCC)) PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + gcc-plugin-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) += cyc_complexity_plugin.so + GCC_PLUGINS_CFLAGS := $(addprefix -fplugin=$(objtree)/scripts/gcc-plugins/, $(gcc-plugin-y)) ifeq ($(PLUGINCC),)scripts/gcc-plugins/Makefile +0
-0
scripts/gcc-plugins/Makefile endif · line 15
Quoted 4 lines
scripts/gcc-plugins/Makefile +1
-0@@ -12,4 +12,8 @@ endif export GCCPLUGINS_DIR HOSTLIBS +$(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) := cyc_complexity_plugin.so
I noticed we need to add the same string into "gcc-plugin-y" and "$(HOSTLIBS)-y"
Maybe can we do like this?
$(HOSTLIBS)-y := $(gcc-plugin-y)
Quoted 3 lines
scripts/gcc-plugins/Makefile +2
-0always := $($(HOSTLIBS)-y) + +cyc_complexity_plugin-objs := cyc_complexity_plugin.o
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 5/6] Documentation for the GCC plugin infrastructure
In reply to Emese RevfyHi Emese,
2016-04-23 3:26 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 4 lines
This is the GCC infrastructure documentation about its operation, how to add and use a new plugin with an example.
Signed-off-by Emese Revfy <[email protected]>
Perhaps, this documentation should be included in 2/6 ?
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 1/6] Shared library support
In reply to Masahiro YamadaQuoted 4 lines · On Mon, 2 May 2016 14:03:00 +0900 Masahiro Yamada…
In the first place,
I am wondering if we need to revive this documentation. What this commit is only interested in *.so generation, not host program support.
I agree that we don't need this documentation. I'll remove it.
Quoted 16 lines
scripts/Makefile.host quiet_cmd_host-cxxobjs = HOSTCXX $@ · line 168
Quoted 12 lines
scripts/Makefile.host +8
-0@@ -124,5 +158,39 @@ quiet_cmd_host-cxxobjs = HOSTCXX $@ $(host-cxxobjs): $(obj)/%.o: $(src)/%.cc FORCE $(call if_changed_dep,host-cxxobjs) +# Compile .c file, create position independent .o file +# host-cshobjs -> .o +quiet_cmd_host-cshobjs = HOSTCC -fPIC $@ + cmd_host-cshobjs = $(HOSTCC) $(hostc_flags) -fPIC -c -o $@ $< +$(host-cshobjs): $(obj)/%.o: $(src)/%.c FORCE + $(call if_changed_dep,host-cshobjs) + +# Compile .c file, create position independent .o filePlease explain why c++ compiler should be used to compile .c files.
Quoted 1 line
This is not clear, so worth commenting.
Where do you think that the C++ compiler is used above? I think HOSTCC can only be C compiler.
Signature · 1 line
Emese
Re: [kernel-hardening] Re: [PATCH v7 2/6] GCC plugin infrastructure
In reply to Masahiro YamadaOn Mon, 2 May 2016 14:07:35 +0900
Masahiro Yamada <[email protected]> wrote:
Hi,
Quoted 11 lines
Quoted 11 lines
arch/x86/entry/vdso/Makefile +1
-1@@ -75,7 +75,7 @@ CFL := $(PROFILING) -mcmodel=small -fPIC -O2 -fasynchronous-unwind-tables -m64 \ -fno-omit-frame-pointer -foptimize-sibling-calls \ -DDISABLE_BRANCH_PROFILING -DBUILD_VDSO -$(vobjs): KBUILD_CFLAGS += $(CFL) +$(vobjs): KBUILD_CFLAGS := $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS)) $(CFL)
Quoted 15 lines
arch/x86/entry/vdso/Makefile KBUILD_CFLAGS_32 := $(filter-out -m64,$(KBUILD_CFLAGS)) · line 151
Quoted 10 lines
arch/x86/entry/vdso/Makefile +1
-0# # vDSO code runs in userspace and -pg doesn't help with profiling anyway.@@ -145,6 +145,7 @@ KBUILD_CFLAGS_32 := $(filter-out -m64,$(KBUILD_CFLAGS)) KBUILD_CFLAGS_32 := $(filter-out -mcmodel=kernel,$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 := $(filter-out -fno-pic,$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 := $(filter-out -mfentry,$(KBUILD_CFLAGS_32)) +KBUILD_CFLAGS_32 := $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS_32)) KBUILD_CFLAGS_32 += -m32 -msoft-float -mregparm=0 -fpic KBUILD_CFLAGS_32 += $(call cc-option, -fno-stack-protector) KBUILD_CFLAGS_32 += $(call cc-option, -foptimize-sibling-calls)Looks like gcc-plugins should be omitted only for this directory. Please tell me why.
I am not familiar with x86 architecture, so this is not clear to me.
The vdso is userland code so in general kernel instrumentation/analysis doesn't apply to it.
Signature · 1 line
Emese
Re: [PATCH v7 5/6] Documentation for the GCC plugin infrastructure
In reply to Masahiro YamadaOn Mon, 2 May 2016 14:10:21 +0900
Masahiro Yamada <[email protected]> wrote:
Hi,
Quoted 8 lines
2016-04-23 3:26 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 4 lines
This is the GCC infrastructure documentation about its operation, how to add and use a new plugin with an example.
Signed-off-by Emese Revfy <[email protected]>Perhaps, this documentation should be included in 2/6 ?
Ok, I will move it there.
Signature · 1 line
Emese
Re: [PATCH v7 1/6] Shared library support
In reply to Emese RevfyHi Emese,
2016-05-03 2:56 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 26 lines
Quoted 4 lines · On Mon, 2 May 2016 14:03:00 +0900 Masahiro Yamada…
In the first place,
I am wondering if we need to revive this documentation. What this commit is only interested in *.so generation, not host program support.I agree that we don't need this documentation. I'll remove it.
Quoted 16 lines
scripts/Makefile.host quiet_cmd_host-cxxobjs = HOSTCXX $@ · line 168
Quoted 12 lines
scripts/Makefile.host +8
-0@@ -124,5 +158,39 @@ quiet_cmd_host-cxxobjs = HOSTCXX $@ $(host-cxxobjs): $(obj)/%.o: $(src)/%.cc FORCE $(call if_changed_dep,host-cxxobjs) +# Compile .c file, create position independent .o file +# host-cshobjs -> .o +quiet_cmd_host-cshobjs = HOSTCC -fPIC $@ + cmd_host-cshobjs = $(HOSTCC) $(hostc_flags) -fPIC -c -o $@ $< +$(host-cshobjs): $(obj)/%.o: $(src)/%.c FORCE + $(call if_changed_dep,host-cshobjs) + +# Compile .c file, create position independent .o filePlease explain why c++ compiler should be used to compile .c files.
Quoted 4 lines
Quoted 1 line
This is not clear, so worth commenting.
Where do you think that the C++ compiler is used above? I think HOSTCC can only be C compiler.
Not above, but *below*.
This comment "Compile .c file, create position independent .o file" is for the following code block.
# Compile .c file, create position independent .o file
# host-cxxshobjs -> .o
quiet_cmd_host-cxxshobjs = HOSTCXX -fPIC $@
cmd_host-cxxshobjs = $(HOSTCXX) $(hostcxx_flags) -fPIC -c -o $@ $<
$(host-cxxshobjs): $(obj)/%.o: $(src)/%.c FORCE
$(call if_changed_dep,host-cxxshobjs)We generally use HOSTCC to compile *.c files,
and HOSTCXX to compile *.cc files.
But, here, you mention to use HOSTCXX to compile .c files such as cyc_complexity_plugin.c, sancov_plugin.c, etc.
This is not straight-forward. It is worthwhile to comment the reason.
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 1/6] Shared library support
In reply to Emese RevfyHi Emese,
2016-05-03 2:56 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 9 lines
Quoted 4 lines · On Mon, 2 May 2016 14:03:00 +0900 Masahiro Yamada…
In the first place,
I am wondering if we need to revive this documentation. What this commit is only interested in *.so generation, not host program support.I agree that we don't need this documentation. I'll remove it.
OK.
Also, rephrase the git-log of this patch.
This patch is almost your original code,
not reverting 62e2210798ed38928ab24841e8b4878a.
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 1/6] Shared library support
In reply to Masahiro YamadaOn Mon, 2 May 2016 14:03:00 +0900
Masahiro Yamada <[email protected]> wrote:
Hi,
Quoted 15 lines
scripts/Makefile.clean subdir-ymn := $(addprefix $(obj)/,$(subdir-ymn)) · line 42
Quoted 11 lines
scripts/Makefile.clean +2
-1@@ -38,7 +38,8 @@ subdir-ymn := $(addprefix $(obj)/,$(subdir-ymn)) __clean-files := $(extra-y) $(extra-m) $(extra-) \ $(always) $(targets) $(clean-files) \ $(host-progs) \ - $(hostprogs-y) $(hostprogs-m) $(hostprogs-) + $(hostprogs-y) $(hostprogs-m) $(hostprogs-) \ + $(hostlibs-y) $(hostlibs-m) $(hostlibs-)$(hostcxxlibs-y)$(hostcxxlibs-m) is missing here.
Quoted 7 lines
BTW, are you planning to support hostlibs without .so extention in the future?
You are changing the top
Makefileto clean with "*.so" pattern rule.Do you need to change both the top
Makefileand Makefile.clean for belt-and-braces cleaning?
It doesn't delete the *.so files without the hunk from the top Makefile. The mrproper and distclean targets remove them with this patch:
https://github.com/ephox-gcc-plugins/gcc-plugins_linux-next/commit/f23b7eb247ccc9f1007e53313af343980dd52591
But I think this isn't the best solution much like doing it from the top Makefile.
Signature · 1 line
Emese
Re: [PATCH v7 1/6] Shared library support
In reply to Masahiro YamadaOn Tue, 3 May 2016 11:00:56 +0900
Masahiro Yamada <[email protected]> wrote:
Hi,
Quoted 10 lines
# Compile .c file, create position independent .o file
# host-cxxshobjs -> .o quiet_cmd_host-cxxshobjs = HOSTCXX -fPIC $@ cmd_host-cxxshobjs = $(HOSTCXX) $(hostcxx_flags) -fPIC -c -o $@ $< $(host-cxxshobjs): $(obj)/%.o: $(src)/%.c FORCE $(call if_changed_dep,host-cxxshobjs)
Quoted 8 lines
We generally use HOSTCC to compile *.c files,
and HOSTCXX to compile *.cc files.But, here, you mention to use HOSTCXX to compile .c files such as
cyc_complexity_plugin.c,sancov_plugin.c, etc.This is not straight-forward. It is worthwhile to comment the reason.
I wrote a comment about it here:
https://github.com/ephox-gcc-plugins/gcc-plugins_linux-next/commit/74f6343a7f13c071e00c417332051e25f15009ea
Signature · 1 line
Emese
Re: [PATCH v7 1/6] Shared library support
Hi Emese,
2016-05-04 6:29 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 19 lines
On Tue, 3 May 2016 11:00:56 +0900
Masahiro Yamada <[email protected]> wrote:Hi,
Quoted 14 lines
# Compile .c file, create position independent .o file
# host-cxxshobjs -> .o quiet_cmd_host-cxxshobjs = HOSTCXX -fPIC $@ cmd_host-cxxshobjs = $(HOSTCXX) $(hostcxx_flags) -fPIC -c -o $@ $< $(host-cxxshobjs): $(obj)/%.o: $(src)/%.c FORCE $(call if_changed_dep,host-cxxshobjs)We generally use HOSTCC to compile *.c files,
and HOSTCXX to compile *.cc files.
Quoted 8 lines
Quoted 4 lines
But, here, you mention to use HOSTCXX to compile .c files such as
cyc_complexity_plugin.c,sancov_plugin.c, etc.This is not straight-forward. It is worthwhile to comment the reason.
I wrote a comment about it here:
https://github.com/ephox-gcc-plugins/gcc-plugins_linux-next/commit/74f6343a7f13c071e00c417332051e25f15009ea
+# Note that plugin capable gcc versions can be either C or C++ based +# therefore plugin source files have to be compilable in both C and C++ mode. +# This is why a C++ compiler is invoked on a .c file.
Thanks.
Please let me confirm if I understood correctly.
We generally have to do something with the name-space conflict (with 'extern "C"') in the mixture of C/C++.
Depending on the GCC version,
GCC-plugin-related libraries could be built for C or C++.
So, we need to check the GCC version and choose correct one from C or C++.
Am I right?
Signature · 2 lines
Best Regards Masahiro Yamada
Re: [PATCH v7 1/6] Shared library support
Quoted 43 lines · On Wed, 4 May 2016 13:09:05 +0900 Masahiro Yamada…
Hi Emese,
2016-05-04 6:29 GMT+09:00 Emese Revfy <[email protected]>:
Quoted 27 lines
On Tue, 3 May 2016 11:00:56 +0900
Masahiro Yamada <[email protected]> wrote:Hi,
Quoted 10 lines
# Compile .c file, create position independent .o file
# host-cxxshobjs -> .o quiet_cmd_host-cxxshobjs = HOSTCXX -fPIC $@ cmd_host-cxxshobjs = $(HOSTCXX) $(hostcxx_flags) -fPIC -c -o $@ $< $(host-cxxshobjs): $(obj)/%.o: $(src)/%.c FORCE $(call if_changed_dep,host-cxxshobjs)Quoted 8 lines
We generally use HOSTCC to compile *.c files,
and HOSTCXX to compile *.cc files.But, here, you mention to use HOSTCXX to compile .c files such as
cyc_complexity_plugin.c,sancov_plugin.c, etc.This is not straight-forward. It is worthwhile to comment the reason.
I wrote a comment about it here:
https://github.com/ephox-gcc-plugins/gcc-plugins_linux-next/commit/74f6343a7f13c071e00c417332051e25f15009ea(quoted diff) +3
-0+# Note that plugin capable gcc versions can be either C or C++ based +# therefore plugin source files have to be compilable in both C and C++ mode. +# This is why a C++ compiler is invoked on a .c file.Thanks.
Please let me confirm if I understood correctly.
Quoted 8 lines
We generally have to do something with the name-space conflict (with 'extern "C"') in the mixture of C/C++.
Depending on the GCC version,
GCC-plugin-related libraries could be built for C or C++.So, we need to check the GCC version and choose correct one from C or C++.
The plugin source files have to be compilable by both versions because gcc versions 4.5 and 4.6 are compiled by a C compiler, gcc-4.7 can be compiled by a C or a C++ compiler, and versions 4.8+ can only be compiled by a C++ compiler.
Signature · 1 line
Emese
Re: [PATCH v7 1/6] Shared library support
In reply to Emese RevfyQuoted 7 lines · On Tue, 3 May 2016 23:25:27 +0200 Emese Revfy <[email protected]> wrote:
Quoted 2 lines
Do you need to change both the top
Makefileand Makefile.clean for belt-and-braces cleaning?It doesn't delete the *.so files without the hunk from the top
Makefile. The mrproper and distclean targets remove them with this patch:
https://github.com/ephox-gcc-plugins/gcc-plugins_linux-next/commit/f23b7eb247ccc9f1007e53313af343980dd52591
But I think this isn't the best solution much like doing it from the topMakefile.
Do you think this patch will be good enough? In this case I can resend the patch set.
Signature · 1 line
Emese
Re: [PATCH v7 2/6] GCC plugin infrastructure
In reply to Emese RevfyDocumentation/dontdiff line 9
Quoted 12 lines · Emese Revfy
Documentation/dontdiff +1
-0@@ -3,6 +3,7 @@ *.bc *.bin *.bz2 +*.c.[012]*.* *.cis *.cpio *.csp
Hi Emese,
Where are these files generated? It should be added to .gitignore and the clean or mrproper rule if it's needed.
Michal
Re: [PATCH v7 2/6] GCC plugin infrastructure
Quoted 16 lines · On Wed, 11 May 2016 13:24:30 +0200 Michal Marek <[email protected]> wrote:
Documentation/dontdiff line 9
Quoted 12 lines · Emese Revfy
Documentation/dontdiff +1
-0@@ -3,6 +3,7 @@ *.bc *.bin *.bz2 +*.c.[012]*.* *.cis *.cpio *.cspHi Emese,
Quoted 2 lines
Where are these files generated? It should be added to .gitignore and the clean or mrproper rule if it's needed.
Hi,
Yes, they are generated by gcc options -fdump-* (if someone gives them in EXTRA_CFLAGS). I'll add these files to .gitignore and the clean rules.
Signature · 1 line
Emese