Commit 01474dc7 authored by Daniel Bristot de Oliveira's avatar Daniel Bristot de Oliveira
Browse files

tools/rtla: Use tools/build makefiles to build rtla 

Use tools/build/ makefiles to build rtla, inheriting the benefits of
it. For example, having a proper way to handle dependencies.

rtla is built using perf infra-structure when building inside the
kernel tree.

At this point, rtla diverges from perf in two points: Documentation
and tarball generation/build.

At the documentation level, rtla is one step ahead, placing the
documentation at Documentation/tools/rtla/, using the same build
tools as kernel documentation. The idea is to move perf
documentation to the same scheme and then share the same makefiles.

rtla has a tarball target that the (old) RHEL8 uses. The tarball was
kept using a simple standalone makefile for compatibility. The
standalone makefile shares most of the code, e.g., flags, with
regular buildings.

The tarball method was set as deprecated. If necessary, we can make
a rtla tarball like perf, which includes the entire tools/build.
But this would also require changes in the user side (the directory
structure changes, and probably the deps to build the package).

Inspired on perf and objtool.

Link: https://lkml.kernel.org/r/57563abf2715d22515c0c54a87cff3849eca5d52.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: default avatarLinus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: default avatarDaniel Bristot de Oliveira <bristot@kernel.org>
parent 9d56c88e

tools/tracing/rtla/.gitignore

+6 −1
Original line number Diff line number Diff line 
/rtla
 
# SPDX-License-Identifier: GPL-2.0-only

rtla

rtla-static

fixdep

feature

FEATURE-DUMP

tools/tracing/rtla/Build

0 → 100644
+1 −0
Original line number Diff line number Diff line 
rtla-y += src/

tools/tracing/rtla/Makefile

+73 −144
Original line number Diff line number Diff line 
NAME	:=	rtla

# 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)

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/rtla/.

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/rtla/

  # subdir is used by the ../Makefile in $(call descend,)

  ifneq ($(subdir),)

    OUTPUT        := $(OUTPUT)/$(subdir)

  endif

endif



LIBTRACEEVENT_MIN_VERSION = 1.5

LIBTRACEFS_MIN_VERSION = 1.3

ifneq ($(patsubst %/,,$(lastword $(OUTPUT))),)

  OUTPUT        := $(OUTPUT)/

endif



.PHONY:	all warnings show_warnings

all:	warnings rtla

RTLA		:= $(OUTPUT)rtla

RTLA_IN		:= $(RTLA)-in.o



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/ ";

VERSION		:= $(shell sh -c "make -sC ../../.. kernelversion | grep -v make")

DOCSRC		:= ../../../Documentation/tools/rtla/



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: $(RTLA)



include $(srctree)/tools/build/Makefile.include

include Makefile.rtla



# check for dependencies only on required targets

NON_CONFIG_TARGETS := clean install tarball 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



rtla: $(OBJ)

	$(CC) -o rtla $(LDFLAGS) $(OBJ) $(LIBS)



static: $(OBJ)

	$(CC) -o rtla-static $(LDFLAGS) --static $(OBJ) $(LIBS) -lpthread -ldl



.PHONY: install

install: doc_install

	$(MKDIR) -p $(DESTDIR)$(BINDIR)

	$(INSTALL) rtla -m 755 $(DESTDIR)$(BINDIR)

	$(STRIP) $(DESTDIR)$(BINDIR)/rtla

	@test ! -f $(DESTDIR)$(BINDIR)/osnoise || rm $(DESTDIR)$(BINDIR)/osnoise

	ln -s rtla $(DESTDIR)$(BINDIR)/osnoise

	@test ! -f $(DESTDIR)$(BINDIR)/hwnoise || rm $(DESTDIR)$(BINDIR)/hwnoise

	ln -s rtla $(DESTDIR)$(BINDIR)/hwnoise

	@test ! -f $(DESTDIR)$(BINDIR)/timerlat || rm $(DESTDIR)$(BINDIR)/timerlat

	ln -s rtla $(DESTDIR)$(BINDIR)/timerlat



.PHONY: clean tarball

clean: doc_clean

	@test ! -f rtla || rm rtla

	@test ! -f rtla-static || rm rtla-static

	@test ! -f src/rtla.o || rm src/rtla.o

	@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/rtla/* $(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



$(RTLA): $(RTLA_IN)

	$(QUIET_LINK)$(CC) $(LDFLAGS) -o $(RTLA) $(RTLA_IN) $(EXTLIBS)



static: $(RTLA_IN)

	$(eval LDFLAGS += -static)

	$(QUIET_LINK)$(CC) -static $(LDFLAGS) -o $(RTLA)-static $(RTLA_IN)  $(EXTLIBS)



rtla.%: fixdep FORCE

	make -f $(srctree)/tools/build/Makefile.build dir=. $@



$(RTLA_IN): fixdep FORCE

	make $(build)=rtla



clean: doc_clean fixdep-clean

	$(call QUIET_CLEAN, rtla)

	$(Q)find . -name '*.o' -delete -o -name '\.*.cmd' -delete -o -name '\.*.d' -delete

	$(Q)rm -f rtla rtla-static fixdep FEATURE-DUMP rtla-*

	$(Q)rm -rf feature

.PHONY: FORCE clean

tools/tracing/rtla/Makefile.config

0 → 100644
+47 −0
Original line number Diff line number Diff line 
# 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

tools/tracing/rtla/Makefile.rtla

0 → 100644
+80 −0
Original line number Diff line number Diff line 
# 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



CFLAGS		:= -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(WOPTS) $(CFLAGS)

LDFLAGS		:= -ggdb $(LDFLAGS)



RM		:= rm -rf

LN		:= ln -s

INSTALL		:= install

MKDIR		:= mkdir

STRIP		:= strip

BINDIR		:= /usr/bin



.PHONY: install

install: doc_install

	@$(MKDIR) -p $(DESTDIR)$(BINDIR)

	$(call QUIET_INSTALL,rtla)$(INSTALL) rtla -m 755 $(DESTDIR)$(BINDIR)

	@$(STRIP) $(DESTDIR)$(BINDIR)/rtla

	@test ! -f $(DESTDIR)$(BINDIR)/osnoise || $(RM) $(DESTDIR)$(BINDIR)/osnoise

	@$(LN) rtla $(DESTDIR)$(BINDIR)/osnoise

	@test ! -f $(DESTDIR)$(BINDIR)/hwnoise || $(RM) $(DESTDIR)$(BINDIR)/hwnoise

	@$(LN) -s rtla $(DESTDIR)$(BINDIR)/hwnoise

	@test ! -f $(DESTDIR)$(BINDIR)/timerlat || $(RM) $(DESTDIR)$(BINDIR)/timerlat

	@$(LN) -s rtla $(DESTDIR)$(BINDIR)/timerlat



.PHONY: doc doc_clean doc_install

doc:

	$(MAKE) -C $(DOCSRC)



doc_clean:

	$(MAKE) -C $(DOCSRC) clean



doc_install:

	$(MAKE) -C $(DOCSRC) install



# This section is neesary for the tarball, when the tarball

# support is removed, we can delete these entries.

NAME		:= rtla

DIRS		:= src

FILES		:= Makefile README.txt

CEXT		:= bz2

TARBALL		:= $(NAME)-$(VERSION).tar.$(CEXT)

TAROPTS		:= -cvjf $(TARBALL)

SRCTREE		:=	$(or $(BUILD_SRC),$(CURDIR))



tarball: clean

	$(RM) $(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/$(NAME)/* $(NAME)-$(VERSION)/Documentation/

	cp Makefile.standalone $(NAME)-$(VERSION)/Makefile

	cp Makefile.$(NAME) $(NAME)-$(VERSION)/

	tar $(TAROPTS) --exclude='*~' $(NAME)-$(VERSION)

	$(RM) $(NAME)-$(VERSION)

.PHONY: tarball