Skip to contentSkip to conversation

tools/resolve_btfids: Install subcmd headers

PATCH Superseded Ian Rogers 2 participants 5 messages Jan 12, 2023 – Jan 16, 2023 BPF

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Ian Rogers

author
#0 lore raw

PATCH 1/1 tools/resolve_btfids: Install subcmd headers

Previously tools/lib/subcmd was added to the include path, switch to installing the headers and then including from that directory. This avoids dependencies on headers internal to tools/lib/subcmd. Add the missing subcmd directory to the affected #include.

---
 tools/bpf/resolve_btfids/Makefile | 19 ++++++++++++++-----
 tools/bpf/resolve_btfids/main.c   |  2 +-
 2 files changed, 15 insertions(+), 6 deletions(-)
tools/bpf/resolve_btfids/Makefile +14 -5
index 19a3112e271a..de7d29cf43d6 100644
@@ -35,21 +35,29 @@ SUBCMD_SRC := $(srctree)/tools/lib/subcmd/
 BPFOBJ     := $(OUTPUT)/libbpf/libbpf.a
 LIBBPF_OUT := $(abspath $(dir $(BPFOBJ)))/
 SUBCMDOBJ  := $(OUTPUT)/libsubcmd/libsubcmd.a
+SUBCMD_OUT := $(abspath $(dir $(SUBCMDOBJ)))/
 
 LIBBPF_DESTDIR := $(LIBBPF_OUT)
 LIBBPF_INCLUDE := $(LIBBPF_DESTDIR)include
 
+SUBCMD_DESTDIR := $(SUBCMD_OUT)
+SUBCMD_INCLUDE := $(SUBCMD_DESTDIR)include
+
 BINARY     := $(OUTPUT)/resolve_btfids
 BINARY_IN  := $(BINARY)-in.o
 
 all: $(BINARY)
 
+prepare: $(SUBCMDOBJ)
+
 $(OUTPUT) $(OUTPUT)/libsubcmd $(LIBBPF_OUT):
 	$(call msg,MKDIR,,$@)
 	$(Q)mkdir -p $(@)
 
 $(SUBCMDOBJ): fixdep FORCE | $(OUTPUT)/libsubcmd
-	$(Q)$(MAKE) -C $(SUBCMD_SRC) OUTPUT=$(abspath $(dir $@))/ $(abspath $@)
+	$(Q)$(MAKE) -C $(SUBCMD_SRC) OUTPUT=$(SUBCMD_OUT) \
+		    DESTDIR=$(SUBCMD_DESTDIR) prefix= \
+		    $(abspath $@) install_headers
 
 $(BPFOBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(LIBBPF_OUT)
 	$(Q)$(MAKE) $(submake_extras) -C $(LIBBPF_SRC) OUTPUT=$(LIBBPF_OUT)    \
@@ -60,14 +68,14 @@ CFLAGS += -g \
           -I$(srctree)/tools/include \
           -I$(srctree)/tools/include/uapi \
           -I$(LIBBPF_INCLUDE) \
-          -I$(SUBCMD_SRC)
+          -I$(SUBCMD_INCLUDE)
 
 LIBS = -lelf -lz
 
 export srctree OUTPUT CFLAGS Q
 include $(srctree)/tools/build/Makefile.include
 
-$(BINARY_IN): $(BPFOBJ) fixdep FORCE | $(OUTPUT)
+$(BINARY_IN): $(BPFOBJ) fixdep FORCE prepare | $(OUTPUT)
 	$(Q)$(MAKE) $(build)=resolve_btfids
 
 $(BINARY): $(BPFOBJ) $(SUBCMDOBJ) $(BINARY_IN)
@@ -79,7 +87,8 @@ clean_objects := $(wildcard $(OUTPUT)/*.o                \
                             $(OUTPUT)/.*.o.d             \
                             $(LIBBPF_OUT)                \
                             $(LIBBPF_DESTDIR)            \
-                            $(OUTPUT)/libsubcmd          \
+                            $(SUBCMD_OUT)                \
+                            $(SUBCMD_DESTDIR)            \
                             $(OUTPUT)/resolve_btfids)
 
 ifneq ($(clean_objects),)
@@ -96,4 +105,4 @@ tags:
 
 FORCE:
 
-.PHONY: all FORCE clean tags
+.PHONY: all FORCE clean tags prepare
tools/bpf/resolve_btfids/main.c +1 -1
index 80cd7843c677..77058174082d 100644
@@ -75,7 +75,7 @@
 #include <linux/err.h>
 #include <bpf/btf.h>
 #include <bpf/libbpf.h>
-#include <parse-options.h>
+#include <subcmd/parse-options.h>
 
 #define BTF_IDS_SECTION	".BTF_ids"
 #define BTF_ID		"__BTF_ID__"
Signature · 1 line
2.39.0.314.g84b9a713c41-goog
#1 lore raw
Quoted 10 lines · Ian Rogers

Previously tools/lib/subcmd was added to the include path, switch to installing the headers and then including from that directory. This avoids dependencies on headers internal to tools/lib/subcmd. Add the missing subcmd directory to the affected #include.

---
 tools/bpf/resolve_btfids/Makefile | 19 ++++++++++++++-----
 tools/bpf/resolve_btfids/main.c   |  2 +-
 2 files changed, 15 insertions(+), 6 deletions(-)

this depends on changes that went to Arnaldo's tree right? I can't apply this on bpf-next/master

Quoted 13 lines
tools/bpf/resolve_btfids/Makefile +1 -0
index 19a3112e271a..de7d29cf43d6 100644
@@ -35,21 +35,29 @@ SUBCMD_SRC := $(srctree)/tools/lib/subcmd/
 BPFOBJ     := $(OUTPUT)/libbpf/libbpf.a
 LIBBPF_OUT := $(abspath $(dir $(BPFOBJ)))/
 SUBCMDOBJ  := $(OUTPUT)/libsubcmd/libsubcmd.a
+SUBCMD_OUT := $(abspath $(dir $(SUBCMDOBJ)))/
 
 LIBBPF_DESTDIR := $(LIBBPF_OUT)
 LIBBPF_INCLUDE := $(LIBBPF_DESTDIR)include

tools/bpf/resolve_btfids/Makefile SUBCMD_SRC := $(srctree)/tools/lib/subcmd/ · line 51

Quoted 10 lines
tools/bpf/resolve_btfids/Makefile +4 -0
 
+SUBCMD_DESTDIR := $(SUBCMD_OUT)
+SUBCMD_INCLUDE := $(SUBCMD_DESTDIR)include
+
 BINARY     := $(OUTPUT)/resolve_btfids
 BINARY_IN  := $(BINARY)-in.o
 
 all: $(BINARY)
 
+prepare: $(SUBCMDOBJ)

do we need special target for that? we already have BPFOBJ dependency placed in the BINARY_IN as prereq

why not place both as BINARY_IN prereq, or is there some other reason for new 'prepare' target?

jirka

Quoted 62 lines
tools/bpf/resolve_btfids/Makefile +9 -5
+
 $(OUTPUT) $(OUTPUT)/libsubcmd $(LIBBPF_OUT):
 	$(call msg,MKDIR,,$@)
 	$(Q)mkdir -p $(@)
 
 $(SUBCMDOBJ): fixdep FORCE | $(OUTPUT)/libsubcmd
-	$(Q)$(MAKE) -C $(SUBCMD_SRC) OUTPUT=$(abspath $(dir $@))/ $(abspath $@)
+	$(Q)$(MAKE) -C $(SUBCMD_SRC) OUTPUT=$(SUBCMD_OUT) \
+		    DESTDIR=$(SUBCMD_DESTDIR) prefix= \
+		    $(abspath $@) install_headers
 
 $(BPFOBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(LIBBPF_OUT)
 	$(Q)$(MAKE) $(submake_extras) -C $(LIBBPF_SRC) OUTPUT=$(LIBBPF_OUT)    \
@@ -60,14 +68,14 @@ CFLAGS += -g \
           -I$(srctree)/tools/include \
           -I$(srctree)/tools/include/uapi \
           -I$(LIBBPF_INCLUDE) \
-          -I$(SUBCMD_SRC)
+          -I$(SUBCMD_INCLUDE)
 
 LIBS = -lelf -lz
 
 export srctree OUTPUT CFLAGS Q
 include $(srctree)/tools/build/Makefile.include
 
-$(BINARY_IN): $(BPFOBJ) fixdep FORCE | $(OUTPUT)
+$(BINARY_IN): $(BPFOBJ) fixdep FORCE prepare | $(OUTPUT)
 	$(Q)$(MAKE) $(build)=resolve_btfids
 
 $(BINARY): $(BPFOBJ) $(SUBCMDOBJ) $(BINARY_IN)
@@ -79,7 +87,8 @@ clean_objects := $(wildcard $(OUTPUT)/*.o                \
                             $(OUTPUT)/.*.o.d             \
                             $(LIBBPF_OUT)                \
                             $(LIBBPF_DESTDIR)            \
-                            $(OUTPUT)/libsubcmd          \
+                            $(SUBCMD_OUT)                \
+                            $(SUBCMD_DESTDIR)            \
                             $(OUTPUT)/resolve_btfids)
 
 ifneq ($(clean_objects),)
@@ -96,4 +105,4 @@ tags:
 
 FORCE:
 
-.PHONY: all FORCE clean tags
+.PHONY: all FORCE clean tags prepare
tools/bpf/resolve_btfids/main.c +1 -1
index 80cd7843c677..77058174082d 100644
@@ -75,7 +75,7 @@
 #include <linux/err.h>
 #include <bpf/btf.h>
 #include <bpf/libbpf.h>
-#include <parse-options.h>
+#include <subcmd/parse-options.h>
 
 #define BTF_IDS_SECTION	".BTF_ids"
 #define BTF_ID		"__BTF_ID__"
Signature · 1 line
2.39.0.314.g84b9a713c41-goog
author
#2 lore raw
Quoted 7 lines · Jiri Olsa
Quoted 5 lines · Ian Rogers

Previously tools/lib/subcmd was added to the include path, switch to installing the headers and then including from that directory. This avoids dependencies on headers internal to tools/lib/subcmd. Add the missing subcmd directory to the affected #include.

Quoted 8 lines
Quoted 5 lines
---
 tools/bpf/resolve_btfids/Makefile | 19 ++++++++++++++-----
 tools/bpf/resolve_btfids/main.c   |  2 +-
 2 files changed, 15 insertions(+), 6 deletions(-)

this depends on changes that went to Arnaldo's tree right? I can't apply this on bpf-next/master

Hmm.. sorry for that. I did the work on the master branch of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

Quoted 20 lines
Quoted 20 lines
tools/bpf/resolve_btfids/Makefile +4 -0
index 19a3112e271a..de7d29cf43d6 100644
@@ -35,21 +35,29 @@ SUBCMD_SRC := $(srctree)/tools/lib/subcmd/
 BPFOBJ     := $(OUTPUT)/libbpf/libbpf.a
 LIBBPF_OUT := $(abspath $(dir $(BPFOBJ)))/
 SUBCMDOBJ  := $(OUTPUT)/libsubcmd/libsubcmd.a
+SUBCMD_OUT := $(abspath $(dir $(SUBCMDOBJ)))/
 
 LIBBPF_DESTDIR := $(LIBBPF_OUT)
 LIBBPF_INCLUDE := $(LIBBPF_DESTDIR)include
 
+SUBCMD_DESTDIR := $(SUBCMD_OUT)
+SUBCMD_INCLUDE := $(SUBCMD_DESTDIR)include
+
 BINARY     := $(OUTPUT)/resolve_btfids
 BINARY_IN  := $(BINARY)-in.o
 
Quoted 6 lines

tools/bpf/resolve_btfids/Makefile SUBCMD_SRC := $(srctree)/tools/lib/subcmd/ · line 51

Quoted 3 lines
tools/bpf/resolve_btfids/Makefile +1 -0
 all: $(BINARY)
 
+prepare: $(SUBCMDOBJ)

do we need special target for that? we already have BPFOBJ dependency placed in the BINARY_IN as prereq

BPFOBJ is $(OUTPUT)/libbpf/libbpf.a which is needed at link time. The prepare step is one we have elsewhere and it creates things like the header files necessary to compile the C code, so we need it earlier is the answer.

Quoted 2 lines

why not place both as BINARY_IN prereq, or is there some other reason for new 'prepare' target?

I was trying to follow the convention elsewhere in the tree of having a prepare target that does things like get the necessary header files ready. Having prepare is useful because if an additional dependency is added, then it just needs to be added to prepare. It could be tedious to list all the dependencies for every C file, although Makefile.build handles most of that. It isn't clear to me why $(BPFOBJ) is a dependency of $(BINARY_IN) as it is already a dependency of $(BINARY).

Thanks,
Ian

Quoted 64 lines

jirka

Quoted 62 lines
tools/bpf/resolve_btfids/Makefile +9 -5
+
 $(OUTPUT) $(OUTPUT)/libsubcmd $(LIBBPF_OUT):
      $(call msg,MKDIR,,$@)
      $(Q)mkdir -p $(@)
 
 $(SUBCMDOBJ): fixdep FORCE | $(OUTPUT)/libsubcmd
-     $(Q)$(MAKE) -C $(SUBCMD_SRC) OUTPUT=$(abspath $(dir $@))/ $(abspath $@)
+     $(Q)$(MAKE) -C $(SUBCMD_SRC) OUTPUT=$(SUBCMD_OUT) \
+                 DESTDIR=$(SUBCMD_DESTDIR) prefix= \
+                 $(abspath $@) install_headers
 
 $(BPFOBJ): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(LIBBPF_OUT)
      $(Q)$(MAKE) $(submake_extras) -C $(LIBBPF_SRC) OUTPUT=$(LIBBPF_OUT)    \
@@ -60,14 +68,14 @@ CFLAGS += -g \
           -I$(srctree)/tools/include \
           -I$(srctree)/tools/include/uapi \
           -I$(LIBBPF_INCLUDE) \
-          -I$(SUBCMD_SRC)
+          -I$(SUBCMD_INCLUDE)
 
 LIBS = -lelf -lz
 
 export srctree OUTPUT CFLAGS Q
 include $(srctree)/tools/build/Makefile.include
 
-$(BINARY_IN): $(BPFOBJ) fixdep FORCE | $(OUTPUT)
+$(BINARY_IN): $(BPFOBJ) fixdep FORCE prepare | $(OUTPUT)
      $(Q)$(MAKE) $(build)=resolve_btfids
 
 $(BINARY): $(BPFOBJ) $(SUBCMDOBJ) $(BINARY_IN)
@@ -79,7 +87,8 @@ clean_objects := $(wildcard $(OUTPUT)/*.o                \
                             $(OUTPUT)/.*.o.d             \
                             $(LIBBPF_OUT)                \
                             $(LIBBPF_DESTDIR)            \
-                            $(OUTPUT)/libsubcmd          \
+                            $(SUBCMD_OUT)                \
+                            $(SUBCMD_DESTDIR)            \
                             $(OUTPUT)/resolve_btfids)
 
 ifneq ($(clean_objects),)
@@ -96,4 +105,4 @@ tags:
 
 FORCE:
 
-.PHONY: all FORCE clean tags
+.PHONY: all FORCE clean tags prepare
tools/bpf/resolve_btfids/main.c +1 -2
index 80cd7843c677..77058174082d 100644
@@ -75,7 +75,7 @@
 #include <linux/err.h>
 #include <bpf/btf.h>
 #include <bpf/libbpf.h>
-#include <parse-options.h>
+#include <subcmd/parse-options.h>
 
 #define BTF_IDS_SECTION      ".BTF_ids"
 #define BTF_ID               "__BTF_ID__"
--

2.39.0.314.g84b9a713c41-goog

#3 lore raw
Quoted 52 lines · Ian Rogers
Quoted 7 lines · Jiri Olsa
Quoted 5 lines · Ian Rogers

Previously tools/lib/subcmd was added to the include path, switch to installing the headers and then including from that directory. This avoids dependencies on headers internal to tools/lib/subcmd. Add the missing subcmd directory to the affected #include.

Quoted 8 lines
Quoted 5 lines
---
 tools/bpf/resolve_btfids/Makefile | 19 ++++++++++++++-----
 tools/bpf/resolve_btfids/main.c   |  2 +-
 2 files changed, 15 insertions(+), 6 deletions(-)

this depends on changes that went to Arnaldo's tree right? I can't apply this on bpf-next/master

Hmm.. sorry for that. I did the work on the master branch of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

Quoted 20 lines
Quoted 20 lines
tools/bpf/resolve_btfids/Makefile +4 -0
index 19a3112e271a..de7d29cf43d6 100644
@@ -35,21 +35,29 @@ SUBCMD_SRC := $(srctree)/tools/lib/subcmd/
 BPFOBJ     := $(OUTPUT)/libbpf/libbpf.a
 LIBBPF_OUT := $(abspath $(dir $(BPFOBJ)))/
 SUBCMDOBJ  := $(OUTPUT)/libsubcmd/libsubcmd.a
+SUBCMD_OUT := $(abspath $(dir $(SUBCMDOBJ)))/
 
 LIBBPF_DESTDIR := $(LIBBPF_OUT)
 LIBBPF_INCLUDE := $(LIBBPF_DESTDIR)include
 
+SUBCMD_DESTDIR := $(SUBCMD_OUT)
+SUBCMD_INCLUDE := $(SUBCMD_DESTDIR)include
+
 BINARY     := $(OUTPUT)/resolve_btfids
 BINARY_IN  := $(BINARY)-in.o
 
Quoted 6 lines

tools/bpf/resolve_btfids/Makefile SUBCMD_SRC := $(srctree)/tools/lib/subcmd/ · line 51

Quoted 3 lines
tools/bpf/resolve_btfids/Makefile +1 -0
 all: $(BINARY)
 
+prepare: $(SUBCMDOBJ)

do we need special target for that? we already have BPFOBJ dependency placed in the BINARY_IN as prereq

BPFOBJ is $(OUTPUT)/libbpf/libbpf.a which is needed at link time. The prepare step is one we have elsewhere and it creates things like the header files necessary to compile the C code, so we need it earlier is the answer.

Quoted 8 lines
Quoted 2 lines

why not place both as BINARY_IN prereq, or is there some other reason for new 'prepare' target?

I was trying to follow the convention elsewhere in the tree of having a prepare target that does things like get the necessary header files ready. Having prepare is useful because if an additional dependency is added, then it just needs to be added to prepare. It could be tedious to list all the dependencies for every C file, although Makefile.build

ok, could we maybe add the BPFOBJ in prepare target as well?

Quoted 2 lines

handles most of that. It isn't clear to me why $(BPFOBJ) is a dependency of $(BINARY_IN) as it is already a dependency of $(BINARY).

I think that if you specify OUTPUT then we need the libbpf headers to be created before we go to compile resolve_btfids objects

thanks,
jirka

author
#4 lore raw
Quoted 57 lines · Jiri Olsa
Quoted 55 lines · Ian Rogers
Quoted 7 lines · Jiri Olsa
Quoted 5 lines · Ian Rogers

Previously tools/lib/subcmd was added to the include path, switch to installing the headers and then including from that directory. This avoids dependencies on headers internal to tools/lib/subcmd. Add the missing subcmd directory to the affected #include.

Quoted 8 lines
Quoted 5 lines
---
 tools/bpf/resolve_btfids/Makefile | 19 ++++++++++++++-----
 tools/bpf/resolve_btfids/main.c   |  2 +-
 2 files changed, 15 insertions(+), 6 deletions(-)

this depends on changes that went to Arnaldo's tree right? I can't apply this on bpf-next/master

Hmm.. sorry for that. I did the work on the master branch of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

Quoted 20 lines
Quoted 20 lines
tools/bpf/resolve_btfids/Makefile +4 -0
index 19a3112e271a..de7d29cf43d6 100644
@@ -35,21 +35,29 @@ SUBCMD_SRC := $(srctree)/tools/lib/subcmd/
 BPFOBJ     := $(OUTPUT)/libbpf/libbpf.a
 LIBBPF_OUT := $(abspath $(dir $(BPFOBJ)))/
 SUBCMDOBJ  := $(OUTPUT)/libsubcmd/libsubcmd.a
+SUBCMD_OUT := $(abspath $(dir $(SUBCMDOBJ)))/
 
 LIBBPF_DESTDIR := $(LIBBPF_OUT)
 LIBBPF_INCLUDE := $(LIBBPF_DESTDIR)include
 
+SUBCMD_DESTDIR := $(SUBCMD_OUT)
+SUBCMD_INCLUDE := $(SUBCMD_DESTDIR)include
+
 BINARY     := $(OUTPUT)/resolve_btfids
 BINARY_IN  := $(BINARY)-in.o
 
Quoted 6 lines

tools/bpf/resolve_btfids/Makefile SUBCMD_SRC := $(srctree)/tools/lib/subcmd/ · line 51

Quoted 3 lines
tools/bpf/resolve_btfids/Makefile +1 -0
 all: $(BINARY)
 
+prepare: $(SUBCMDOBJ)

do we need special target for that? we already have BPFOBJ dependency placed in the BINARY_IN as prereq

BPFOBJ is $(OUTPUT)/libbpf/libbpf.a which is needed at link time. The prepare step is one we have elsewhere and it creates things like the header files necessary to compile the C code, so we need it earlier is the answer.

Quoted 2 lines

why not place both as BINARY_IN prereq, or is there some other reason for new 'prepare' target?

Quoted 7 lines
Quoted 5 lines

I was trying to follow the convention elsewhere in the tree of having a prepare target that does things like get the necessary header files ready. Having prepare is useful because if an additional dependency is added, then it just needs to be added to prepare. It could be tedious to list all the dependencies for every C file, although Makefile.build

ok, could we maybe add the BPFOBJ in prepare target as well?

Agreed, added to v2.

Quoted 8 lines
Quoted 2 lines

handles most of that. It isn't clear to me why $(BPFOBJ) is a dependency of $(BINARY_IN) as it is already a dependency of $(BINARY).

I think that if you specify OUTPUT then we need the libbpf headers to be created before we go to compile resolve_btfids objects

thanks,
jirka

Yep. I also noticed that this code is doing the "CC=$(HOSTCC)" thing. The problem with that is Makefile.include (line 2) will set things like CFLAGS based on CC and then you change it. I sent out some objtool build cleanup for this:
https://lore.kernel.org/lkml/[email protected]/
I'll add a patch for this in v2.

Thanks,
Ian