Skip to contentSkip to conversation

tools/rtla: Explicitly list libtraceevent dependency

PATCH In review Daniel Wagner 3 participants 9 messages Jan 10, 2023 Real-time Linux Analysis (rtla) tools

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tools/rtla: Explicitly list libtraceevent dependency

The current libtracefs.pkg file lists the dependency on libtraceevent ("pkg-config --libs libtracefs" -> "-ltracefs -ltraceevent").

Dan Nicholson's Guide to pkg-config[1] stats that "Libs: The link flags specific to this package and any required libraries that don't support pkg-config". Thus the current libtracefs.pkg is not correct.

rtla is depending on libtraceevent but it doesn't express this in 'pkg-config' part to retrieve the correct build flags.

In order to be able to update the "Libs:" section in the libtracefs project we need to list the dependency explicitly to avoid future linker failures.

[1] https://people.freedesktop.org/~dbn/pkg-config-guide.html

---

I've got this fallout with because I am using libtraceevent and libtracefs build with Meson. Meson generates different pkg files which seems to align with Dan's Guide.

 tools/tracing/rtla/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/tracing/rtla/Makefile +1 -1
index 22e28b76f800..0664e2db22c1 100644
@@ -32,7 +32,7 @@ TRACEFS_HEADERS	:= $$($(PKG_CONFIG) --cflags libtracefs)
 
 CFLAGS	:=	-O -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(MOPTS) $(WOPTS) $(TRACEFS_HEADERS) $(EXTRA_CFLAGS)
 LDFLAGS	:=	-ggdb $(EXTRA_LDFLAGS)
-LIBS	:=	$$($(PKG_CONFIG) --libs libtracefs)
+LIBS	:=	$$($(PKG_CONFIG) --libs libtracefs libtraceevent)
 
 SRC	:=	$(wildcard src/*.c)
 HDR	:=	$(wildcard src/*.h)
Signature · 1 line
2.39.0
#1 lore raw
Quoted 8 lines · Daniel Wagner

The current libtracefs.pkg file lists the dependency on libtraceevent ("pkg-config --libs libtracefs" -> "-ltracefs -ltraceevent").

Dan Nicholson's Guide to pkg-config[1] stats that "Libs: The link flags specific to this package and any required libraries that don't support pkg-config". Thus the current libtracefs.pkg is not correct.

Quoted 6 lines

rtla is depending on libtraceevent but it doesn't express this in 'pkg-config' part to retrieve the correct build flags.

In order to be able to update the "Libs:" section in the libtracefs project we need to list the dependency explicitly to avoid future linker failures.

I am ok with it. Steve?

-- Daniel

#2 lore raw
Quoted 9 lines · Daniel Bristot de Oliveira
Quoted 8 lines · Daniel Wagner

The current libtracefs.pkg file lists the dependency on libtraceevent ("pkg-config --libs libtracefs" -> "-ltracefs -ltraceevent").

Dan Nicholson's Guide to pkg-config[1] stats that "Libs: The link flags specific to this package and any required libraries that don't support pkg-config". Thus the current libtracefs.pkg is not correct.

Quoted 8 lines
Quoted 6 lines

rtla is depending on libtraceevent but it doesn't express this in 'pkg-config' part to retrieve the correct build flags.

In order to be able to update the "Libs:" section in the libtracefs project we need to list the dependency explicitly to avoid future linker failures.

I am ok with it. Steve?

FWIW, this is change is also backwards compatible, meaning if you have system which has a libtracefs.pkg installed which lists libtraceevent in its Libs:
section the 'pkg-config --libs libtracefs libtraceevent' command will return the identically string which is '-ltracefs -ltraceevent'.

#3 lore raw
Quoted 17 lines · Daniel Wagner
Quoted 16 lines · Daniel Bristot de Oliveira
Quoted 14 lines · Daniel Wagner

The current libtracefs.pkg file lists the dependency on libtraceevent ("pkg-config --libs libtracefs" -> "-ltracefs -ltraceevent").

Dan Nicholson's Guide to pkg-config[1] stats that "Libs: The link flags specific to this package and any required libraries that don't support pkg-config". Thus the current libtracefs.pkg is not correct.

rtla is depending on libtraceevent but it doesn't express this in 'pkg-config' part to retrieve the correct build flags.

In order to be able to update the "Libs:" section in the libtracefs project we need to list the dependency explicitly to avoid future linker failures.

Quoted 6 lines
Quoted 1 line

I am ok with it. Steve?

FWIW, this is change is also backwards compatible, meaning if you have system which has a libtracefs.pkg installed which lists libtraceevent in its Libs:
section the 'pkg-config --libs libtracefs libtraceevent' command will return the identically string which is '-ltracefs -ltraceevent'.

Yeah, we know it. I've added both in the initial implementation, but Steven suggested using only libtracefs because it depends on libtraceevent anyways. That is why I am re-checking with him.

-- Daniel

#4 lore raw
Quoted 8 lines · Daniel Bristot de Oliveira

FWIW, this is change is also backwards compatible, meaning if you have system

Quoted 3 lines

which has a libtracefs.pkg installed which lists libtraceevent in its Libs:
section the 'pkg-config --libs libtracefs libtraceevent' command will return the identically string which is '-ltracefs -ltraceevent'.

Yeah, we know it. I've added both in the initial implementation, but Steven suggested using only libtracefs because it depends on libtraceevent anyways. That is why I am re-checking with him.

Just to clarify, the generated pkg file by Meson is adding the libtraceevent dependency in the private section. So this part should be okay. I would be surprised if Meson would get this wrong at this point.

$ cat .build/meson-private/libtracefs.pc
prefix=/tmp/trace-cmd
includedir=${prefix}/include
libdir=${prefix}/lib64

Name: libtracefs
Description: Manage trace fs
URL: https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
Version: 1.6.3
Requires.private: libtraceevent >= 1.7.0
Libs: -L${libdir} -ltracefs
Cflags: -I${includedir}/libtracefs

maintainer
#5 lore raw
Quoted 3 lines · On Tue, 10 Jan 2023 15:45:36 +0100 Daniel Wagner <[email protected]> wrote:

Just to clarify, the generated pkg file by Meson is adding the libtraceevent dependency in the private section. So this part should be okay. I would be surprised if Meson would get this wrong at this point.

No that's incorrect.

There's many interfaces that require the libtraceevent header files to work with libtracefs. Anything that uses libtracefs must also use libtraceevent, as libtracefs is really just an extension of libtraceevent.

Quoted 11 lines
$ cat .build/meson-private/libtracefs.pc
prefix=/tmp/trace-cmd
includedir=${prefix}/include
libdir=${prefix}/lib64

Name: libtracefs
Description: Manage trace fs
URL: https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
Version: 1.6.3
Requires.private: libtraceevent >= 1.7.0

This is incorrect.

-- Steve

Quoted 2 lines

Libs: -L${libdir} -ltracefs
Cflags: -I${includedir}/libtracefs

maintainer
#6 lore raw
Quoted 3 lines · On Tue, 10 Jan 2023 09:51:37 -0500 Steven Rostedt <[email protected]> wrote:

There's many interfaces that require the libtraceevent header files to work with libtracefs. Anything that uses libtracefs must also use libtraceevent, as libtracefs is really just an extension of libtraceevent.

Although, I will say, since I hate the libtraceevent interface so much, I may like to hide it via a fully functional libtracefs interface that hides it :-) In which case, this would be correct!

-- Steve

#7 lore raw
Quoted 6 lines · Steven Rostedt
Quoted 3 lines · On Tue, 10 Jan 2023 09:51:37 -0500 Steven Rostedt <[email protected]> wrote:

There's many interfaces that require the libtraceevent header files to work with libtracefs. Anything that uses libtracefs must also use libtraceevent, as libtracefs is really just an extension of libtraceevent.

Okay, in this case I am going update the Meson build to add the necessary explicit dependency:

++ b/src/meson.build
@@ -50,6 +50,7 @@ libtracefs_static = static_library(
pkg = import('pkgconfig')
pkg.generate(
libtracefs,
+ libraries: [libtraceevent_dep],
subdirs: 'libtracefs',
filebase: meson.project_name(),
name: meson.project_name(),

$ cat /tmp/trace-cmd/lib64/pkgconfig/libtracefs.pc
prefix=/tmp/trace-cmd
includedir=${prefix}/include
libdir=${prefix}/lib64

Name: libtracefs
Description: Manage trace fs
URL: https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
Version: 1.6.3
Requires: libtraceevent >= 1.7.0
Libs: -L${libdir} -ltracefs
Cflags: -I${includedir}/libtracefs

$ PKG_CONFIG_PATH=/tmp/trace-cmd
$ pkg-config --libs libtracefs
-L/tmp/trace-cmd/lib64 -ltracefs -ltraceevent
maintainer
#8 lore raw
In reply to Daniel Wagner
Quoted 8 lines · On Tue, 10 Jan 2023 14:18:05 +0100 Daniel Wagner <[email protected]> wrote:

The current libtracefs.pkg file lists the dependency on libtraceevent ("pkg-config --libs libtracefs" -> "-ltracefs -ltraceevent").

Dan Nicholson's Guide to pkg-config[1] stats that "Libs: The link flags specific to this package and any required libraries that don't support pkg-config". Thus the current libtracefs.pkg is not correct.

Quoted 8 lines

rtla is depending on libtraceevent but it doesn't express this in 'pkg-config' part to retrieve the correct build flags.

In order to be able to update the "Libs:" section in the libtracefs project we need to list the dependency explicitly to avoid future linker failures.

[1] https://people.freedesktop.org/~dbn/pkg-config-guide.html

The Libs: field in tracefs only shows the -ltracefs and not -ltraceevent. It follows this rule. It's the "Requires:" tag that pulls in -ltraceevent, correctly.

Quoted 16 lines

---

I've got this fallout with because I am using libtraceevent and libtracefs build with Meson. Meson generates different pkg files which seems to align with Dan's Guide.

 tools/tracing/rtla/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/tracing/rtla/Makefile +0 -0
index 22e28b76f800..0664e2db22c1 100644

tools/tracing/rtla/Makefile TRACEFS_HEADERS := $$($(PKG_CONFIG) --cflags libtracefs) · line 35

Quoted 5 lines
tools/tracing/rtla/Makefile +1 -1
@@ -32,7 +32,7 @@ TRACEFS_HEADERS	:= $$($(PKG_CONFIG) --cflags libtracefs)
 
 CFLAGS	:=	-O -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(MOPTS) $(WOPTS) $(TRACEFS_HEADERS) $(EXTRA_CFLAGS)
 LDFLAGS	:=	-ggdb $(EXTRA_LDFLAGS)
-LIBS	:=	$$($(PKG_CONFIG) --libs libtracefs)
+LIBS	:=	$$($(PKG_CONFIG) --libs libtracefs libtraceevent)

I'm still confused as to why this is needed.

According to Dan's document:

Requires: A list of packages required by this package. The versions of these packages may be specified using the comparison operators =, <, >, <= or >=. Requires.private: A list of private packages required by this package but not exposed to applications. The version specific rules from the Requires field also apply here.

The "Requires" is exported to other applications. It's the private that is not.

What is this trying to fix?

-- Steve

Quoted 3 lines
tools/tracing/rtla/Makefile +0 -0
 SRC	:=	$(wildcard src/*.c)
 HDR	:=	$(wildcard src/*.h)