tools/verification: Use tools/build makefiles on rv
authorDaniel Bristot de Oliveira <bristot@kernel.org>
Fri, 15 Mar 2024 16:44:05 +0000 (17:44 +0100)
committerDaniel Bristot de Oliveira <bristot@kernel.org>
Wed, 20 Mar 2024 04:39:06 +0000 (05:39 +0100)
Use tools/build/ makefiles to build rv, inheriting the benefits of
it. For example, having a proper way to handle dependencies.

Link: https://lkml.kernel.org/r/2a38a8f7b8dc65fa790381ec9ab42fb62beb2e25.1710519524.git.bristot@kernel.org
Cc: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Josh Poimboeuf <jpoimboe@kernel.org>
Cc: John Kacur <jkacur@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
tools/verification/rv/.gitignore [new file with mode: 0644]
tools/verification/rv/Build [new file with mode: 0644]
tools/verification/rv/Makefile
tools/verification/rv/Makefile.config [new file with mode: 0644]
tools/verification/rv/Makefile.rv [new file with mode: 0644]
tools/verification/rv/src/Build [new file with mode: 0644]

diff --git a/tools/verification/rv/.gitignore b/tools/verification/rv/.gitignore
new file mode 100644 (file)
index 0000000..34a4865
--- /dev/null
@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: GPL-2.0-only
+rv
+rv-static
+fixdep
+feature
+FEATURE-DUMP
diff --git a/tools/verification/rv/Build b/tools/verification/rv/Build
new file mode 100644 (file)
index 0000000..a44c223
--- /dev/null
@@ -0,0 +1 @@
+rv-y += src/
index 485f8aeddbe033f227faf32139630d2a616cbd66..411d62b3d8eb93abf85526ad33cafd783df86bc1 100644 (file)
-NAME   :=      rv
-# Follow the kernel version
-VERSION :=     $(shell cat VERSION 2> /dev/null || make -sC ../../.. kernelversion | grep -v make)
-
-# From libtracefs:
-# Makefiles suck: This macro sets a default value of $(2) for the
-# variable named by $(1), unless the variable has been set by
-# environment or command line. This is necessary for CC and AR
-# because make sets default values, so the simpler ?= approach
-# won't work as expected.
-define allow-override
-  $(if $(or $(findstring environment,$(origin $(1))),\
-            $(findstring command line,$(origin $(1)))),,\
-    $(eval $(1) = $(2)))
-endef
-
-# Allow setting CC and AR, or setting CROSS_COMPILE as a prefix.
-$(call allow-override,CC,$(CROSS_COMPILE)gcc)
-$(call allow-override,AR,$(CROSS_COMPILE)ar)
-$(call allow-override,STRIP,$(CROSS_COMPILE)strip)
-$(call allow-override,PKG_CONFIG,pkg-config)
-$(call allow-override,LD_SO_CONF_PATH,/etc/ld.so.conf.d/)
-$(call allow-override,LDCONFIG,ldconfig)
-
-INSTALL        =       install
-MKDIR  =       mkdir
-FOPTS  :=      -flto=auto -ffat-lto-objects -fexceptions -fstack-protector-strong \
-               -fasynchronous-unwind-tables -fstack-clash-protection
-WOPTS  :=      -Wall -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -Wp,-D_GLIBCXX_ASSERTIONS -Wno-maybe-uninitialized
-
-ifeq ($(CC),clang)
-  FOPTS := $(filter-out -ffat-lto-objects, $(FOPTS))
-  WOPTS := $(filter-out -Wno-maybe-uninitialized, $(WOPTS))
+# SPDX-License-Identifier: GPL-2.0-only
+
+ifeq ($(srctree),)
+  srctree      := $(patsubst %/,%,$(dir $(CURDIR)))
+  srctree      := $(patsubst %/,%,$(dir $(srctree)))
+  srctree      := $(patsubst %/,%,$(dir $(srctree)))
 endif
 
-TRACEFS_HEADERS        := $$($(PKG_CONFIG) --cflags libtracefs)
-
-CFLAGS :=      -O -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(MOPTS) $(WOPTS) $(TRACEFS_HEADERS) $(EXTRA_CFLAGS) -I include
-LDFLAGS        :=      -flto=auto -ggdb $(EXTRA_LDFLAGS)
-LIBS   :=      $$($(PKG_CONFIG) --libs libtracefs)
-
-SRC    :=      $(wildcard src/*.c)
-HDR    :=      $(wildcard src/*.h)
-OBJ    :=      $(SRC:.c=.o)
-DIRS   :=      src
-FILES  :=      Makefile README.txt
-CEXT   :=      bz2
-TARBALL        :=      $(NAME)-$(VERSION).tar.$(CEXT)
-TAROPTS        :=      -cvjf $(TARBALL)
-BINDIR :=      /usr/bin
-DATADIR        :=      /usr/share
-DOCDIR :=      $(DATADIR)/doc
-MANDIR :=      $(DATADIR)/man
-LICDIR :=      $(DATADIR)/licenses
-SRCTREE        :=      $(or $(BUILD_SRC),$(CURDIR))
-
-# If running from the tarball, man pages are stored in the Documentation
-# dir. If running from the kernel source, man pages are stored in
-# Documentation/tools/rv/.
-ifneq ($(wildcard Documentation/.*),)
-DOCSRC =       Documentation/
+include $(srctree)/tools/scripts/Makefile.include
+
+# O is an alias for OUTPUT
+OUTPUT          := $(O)
+
+ifeq ($(OUTPUT),)
+  OUTPUT       := $(CURDIR)/
 else
-DOCSRC =       $(SRCTREE)/../../../Documentation/tools/rv/
+  # subdir is used by the ../Makefile in $(call descend,)
+  ifneq ($(subdir),)
+    OUTPUT        := $(OUTPUT)/$(subdir)
+  endif
+endif
+
+ifneq ($(patsubst %/,,$(lastword $(OUTPUT))),)
+  OUTPUT := $(OUTPUT)/
 endif
 
-LIBTRACEEVENT_MIN_VERSION = 1.5
-LIBTRACEFS_MIN_VERSION = 1.3
+RV             := $(OUTPUT)rv
+RV_IN          := $(RV)-in.o
 
-.PHONY:        all warnings show_warnings
-all:   warnings rv
+VERSION                := $(shell sh -c "make -sC ../../.. kernelversion | grep -v make")
+DOCSRC         := ../../../Documentation/tools/rv/
 
-TEST_LIBTRACEEVENT = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEEVENT_MIN_VERSION) libtraceevent > /dev/null 2>&1 || echo n")
-ifeq ("$(TEST_LIBTRACEEVENT)", "n")
-WARNINGS = show_warnings
-MISSING_LIBS += echo "**   libtraceevent version $(LIBTRACEEVENT_MIN_VERSION) or higher";
-MISSING_PACKAGES += "libtraceevent-devel"
-MISSING_SOURCE += echo "**  https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/ ";
+FEATURE_TESTS  := libtraceevent
+FEATURE_TESTS  += libtracefs
+FEATURE_DISPLAY        := libtraceevent
+FEATURE_DISPLAY        += libtracefs
+
+ifeq ($(V),1)
+  Q            =
+else
+  Q            = @
 endif
 
-TEST_LIBTRACEFS = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEFS_MIN_VERSION) libtracefs > /dev/null 2>&1 || echo n")
-ifeq ("$(TEST_LIBTRACEFS)", "n")
-WARNINGS = show_warnings
-MISSING_LIBS += echo "**   libtracefs version $(LIBTRACEFS_MIN_VERSION) or higher";
-MISSING_PACKAGES += "libtracefs-devel"
-MISSING_SOURCE += echo "**  https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/ ";
+all: $(RV)
+
+include $(srctree)/tools/build/Makefile.include
+include Makefile.rv
+
+# check for dependencies only on required targets
+NON_CONFIG_TARGETS := clean install doc doc_clean doc_install
+
+config         := 1
+ifdef MAKECMDGOALS
+  ifeq ($(filter-out $(NON_CONFIG_TARGETS),$(MAKECMDGOALS)),)
+  config       := 0
+endif
 endif
 
-define show_dependencies
-       @echo "********************************************";                           \
-       echo "** NOTICE: Failed build dependencies";                                    \
-       echo "**";                                                                      \
-       echo "** Required Libraries:";                                                  \
-       $(MISSING_LIBS)                                                                 \
-       echo "**";                                                                      \
-       echo "** Consider installing the latest libtracefs from your";                  \
-       echo "** distribution, e.g., 'dnf install $(MISSING_PACKAGES)' on Fedora,";     \
-       echo "** or from source:";                                                      \
-       echo "**";                                                                      \
-       $(MISSING_SOURCE)                                                               \
-       echo "**";                                                                      \
-       echo "********************************************"
-endef
-
-show_warnings:
-       $(call show_dependencies);
-
-ifneq ("$(WARNINGS)", "")
-ERROR_OUT = $(error Please add the necessary dependencies)
-
-warnings: $(WARNINGS)
-       $(ERROR_OUT)
+ifeq ($(config),1)
+  include $(srctree)/tools/build/Makefile.feature
+  include Makefile.config
 endif
 
-rv: $(OBJ)
-       $(CC) -o rv $(LDFLAGS) $(OBJ) $(LIBS)
-
-.PHONY: install
-install: doc_install
-       $(MKDIR) -p $(DESTDIR)$(BINDIR)
-       $(INSTALL) rv -m 755 $(DESTDIR)$(BINDIR)
-       $(STRIP) $(DESTDIR)$(BINDIR)/rv
-
-.PHONY: clean tarball
-clean: doc_clean
-       @test ! -f rv || rm rv
-       @test ! -f $(TARBALL) || rm -f $(TARBALL)
-       @rm -rf *~ $(OBJ) *.tar.$(CEXT)
-
-tarball: clean
-       rm -rf $(NAME)-$(VERSION) && mkdir $(NAME)-$(VERSION)
-       echo $(VERSION) > $(NAME)-$(VERSION)/VERSION
-       cp -r $(DIRS) $(FILES) $(NAME)-$(VERSION)
-       mkdir $(NAME)-$(VERSION)/Documentation/
-       cp -rp $(SRCTREE)/../../../Documentation/tools/rv/* $(NAME)-$(VERSION)/Documentation/
-       tar $(TAROPTS) --exclude='*~' $(NAME)-$(VERSION)
-       rm -rf $(NAME)-$(VERSION)
-
-.PHONY: doc doc_clean doc_install
-doc:
-       $(MAKE) -C $(DOCSRC)
-
-doc_clean:
-       $(MAKE) -C $(DOCSRC) clean
-
-doc_install:
-       $(MAKE) -C $(DOCSRC) install
+CFLAGS         += $(INCLUDES) $(LIB_INCLUDES)
+
+export CFLAGS OUTPUT srctree
+
+$(RV): $(RV_IN)
+       $(QUIET_LINK)$(CC) $(LDFLAGS) -o $(RV) $(RV_IN) $(EXTLIBS)
+
+static: $(RV_IN)
+       $(eval LDFLAGS += -static)
+       $(QUIET_LINK)$(CC) $(LDFLAGS) -o $(RV)-static $(RV_IN) $(EXTLIBS)
+
+rv.%: fixdep FORCE
+       make -f $(srctree)/tools/build/Makefile.build dir=. $@
+
+$(RV_IN): fixdep FORCE
+       make $(build)=rv
+
+clean: doc_clean fixdep-clean
+       $(call QUIET_CLEAN, rv)
+       $(Q)find . -name '*.o' -delete -o -name '\.*.cmd' -delete -o -name '\.*.d' -delete
+       $(Q)rm -f rv rv-static fixdep FEATURE-DUMP rv-*
+       $(Q)rm -rf feature
+
+.PHONY: FORCE clean
diff --git a/tools/verification/rv/Makefile.config b/tools/verification/rv/Makefile.config
new file mode 100644 (file)
index 0000000..6d4ba77
--- /dev/null
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+STOP_ERROR :=
+
+LIBTRACEEVENT_MIN_VERSION = 1.5
+LIBTRACEFS_MIN_VERSION = 1.3
+
+define lib_setup
+  $(eval LIB_INCLUDES += $(shell sh -c "$(PKG_CONFIG) --cflags lib$(1)"))
+  $(eval EXTLIBS += -l$(1))
+endef
+
+$(call feature_check,libtraceevent)
+ifeq ($(feature-libtraceevent), 1)
+  $(call detected,CONFIG_LIBTRACEEVENT)
+
+  TEST = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEEVENT_MIN_VERSION) libtraceevent > /dev/null 2>&1 && echo y || echo n")
+  ifeq ($(TEST),n)
+    $(info libtraceevent version is too low, it must be at least $(LIBTRACEEVENT_MIN_VERSION))
+    STOP_ERROR := 1
+  endif
+
+  $(call lib_setup,traceevent)
+else
+  STOP_ERROR := 1
+  $(info libtraceevent is missing. Please install libtraceevent-dev/libtraceevent-devel)
+endif
+
+$(call feature_check,libtracefs)
+ifeq ($(feature-libtracefs), 1)
+  $(call detected,CONFIG_LIBTRACEFS)
+
+  TEST = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEFS_MIN_VERSION) libtracefs > /dev/null 2>&1 && echo y || echo n")
+  ifeq ($(TEST),n)
+    $(info libtracefs version is too low, it must be at least $(LIBTRACEFS_MIN_VERSION))
+    STOP_ERROR := 1
+  endif
+
+  $(call lib_setup,tracefs)
+else
+  STOP_ERROR := 1
+  $(info libtracefs is missing. Please install libtracefs-dev/libtracefs-devel)
+endif
+
+ifeq ($(STOP_ERROR),1)
+  $(error Please, check the errors above.)
+endif
diff --git a/tools/verification/rv/Makefile.rv b/tools/verification/rv/Makefile.rv
new file mode 100644 (file)
index 0000000..161baa2
--- /dev/null
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+define allow-override
+  $(if $(or $(findstring environment,$(origin $(1))),\
+            $(findstring command line,$(origin $(1)))),,\
+    $(eval $(1) = $(2)))
+endef
+
+# Allow setting CC and AR, or setting CROSS_COMPILE as a prefix.
+$(call allow-override,CC,$(CROSS_COMPILE)gcc)
+$(call allow-override,AR,$(CROSS_COMPILE)ar)
+$(call allow-override,STRIP,$(CROSS_COMPILE)strip)
+$(call allow-override,PKG_CONFIG,pkg-config)
+$(call allow-override,LD_SO_CONF_PATH,/etc/ld.so.conf.d/)
+$(call allow-override,LDCONFIG,ldconfig)
+export CC AR STRIP PKG_CONFIG LD_SO_CONF_PATH LDCONFIG
+
+FOPTS          :=-flto=auto -ffat-lto-objects -fexceptions -fstack-protector-strong    \
+               -fasynchronous-unwind-tables -fstack-clash-protection
+WOPTS          :=      -O -Wall -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2        \
+               -Wp,-D_GLIBCXX_ASSERTIONS -Wno-maybe-uninitialized
+
+ifeq ($(CC),clang)
+  FOPTS                := $(filter-out -flto=auto -ffat-lto-objects, $(FOPTS))
+  WOPTS                := $(filter-out -Wno-maybe-uninitialized, $(WOPTS))
+endif
+
+INCLUDE                := -Iinclude/
+CFLAGS         := -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(WOPTS) $(EXTRA_CFLAGS) $(INCLUDE)
+LDFLAGS                := -ggdb $(EXTRA_LDFLAGS)
+
+INSTALL                := install
+MKDIR          := mkdir
+STRIP          := strip
+BINDIR         := /usr/bin
+
+.PHONY: install
+install: doc_install
+       $(Q)$(MKDIR) -p $(DESTDIR)$(BINDIR)
+       $(call QUIET_INSTALL,rv)$(INSTALL) $(OUTPUT)rv -m 755 $(DESTDIR)$(BINDIR)
+       $(Q)@$(STRIP) $(DESTDIR)$(BINDIR)/rv
+
+.PHONY: doc doc_clean doc_install
+doc:
+       $(MAKE) -C $(DOCSRC)
+
+doc_clean:
+       $(MAKE) -C $(DOCSRC) clean
+
+doc_install:
+       $(MAKE) -C $(DOCSRC) install
diff --git a/tools/verification/rv/src/Build b/tools/verification/rv/src/Build
new file mode 100644 (file)
index 0000000..d781983
--- /dev/null
@@ -0,0 +1,4 @@
+rv-y += trace.o
+rv-y += utils.o
+rv-y += in_kernel.o
+rv-y += rv.o