Skip to contentSkip to conversation

libtraceevent: Clean up source directory

PATCH New Steven Rostedt 1 participant 7 messages Dec 9, 2020 Kbuild

lore
Share & tools
lore
#0 lore raw

cover libtraceevent: Clean up source directory

Did some Makefile maintenance and cleaned up the source directory. Added a "lib" directory for the libraries to be installed in, and a "src" directory to hold the C code and header files. And some various other Makefile maintenance.

Steven Rostedt (VMware) (6):
libtraceevent: Use macro names for libtraceevent library binaries
libtraceevent: Remove "src" and "obj" from Makefile
libtraceevent: Move creation of PKG_CONFIG_FILE to after Makefile.include
libtraceevent: Have make clean honor the output (O=foo) directory
libtraceevent: Have binary libraries build into lib directory
libtraceevent: Move source files into src/ directory

----

 Makefile                                       | 53 ++++++++++++++++----------
 plugins/Makefile                               |  9 +++--
 Build => src/Build                             |  0
 src/Makefile                                   | 12 ++++++
 event-parse-api.c => src/event-parse-api.c     |  0
 event-parse-local.h => src/event-parse-local.h |  0
 event-parse.c => src/event-parse.c             |  0
 event-parse.h => src/event-parse.h             |  0
 event-plugin.c => src/event-plugin.c           |  0
 event-utils.h => src/event-utils.h             |  0
 kbuffer-parse.c => src/kbuffer-parse.c         |  0
 kbuffer.h => src/kbuffer.h                     |  0
 parse-filter.c => src/parse-filter.c           |  0
 parse-utils.c => src/parse-utils.c             |  0
 tep_strerror.c => src/tep_strerror.c           |  0
 trace-seq.c => src/trace-seq.c                 |  0
 trace-seq.h => src/trace-seq.h                 |  0
 17 files changed, 50 insertions(+), 24 deletions(-)
 rename Build => src/Build (100%)
 create mode 100644 src/Makefile
 rename event-parse-api.c => src/event-parse-api.c (100%)
 rename event-parse-local.h => src/event-parse-local.h (100%)
 rename event-parse.c => src/event-parse.c (100%)
 rename event-parse.h => src/event-parse.h (100%)
 rename event-plugin.c => src/event-plugin.c (100%)
 rename event-utils.h => src/event-utils.h (100%)
 rename kbuffer-parse.c => src/kbuffer-parse.c (100%)
 rename kbuffer.h => src/kbuffer.h (100%)
 rename parse-filter.c => src/parse-filter.c (100%)
 rename parse-utils.c => src/parse-utils.c (100%)
 rename tep_strerror.c => src/tep_strerror.c (100%)
 rename trace-seq.c => src/trace-seq.c (100%)
 rename trace-seq.h => src/trace-seq.h (100%)
#1 lore raw

PATCH 1/6 libtraceevent: Use macro names for libtraceevent library binaries

From: "Steven Rostedt (VMware)" <[email protected]>

In order to move the libtraceevent library binaries to their own location in the build directory, use macros for their names in the Makefile. This will facilitate the changes to have their final locations be updated.

---
 Makefile | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)
Makefile +8 -5
index ea00085091e4..e17e9674573b 100644
@@ -94,8 +94,11 @@ N		=
 
 EVENT_PARSE_VERSION = $(EP_VERSION).$(EP_PATCHLEVEL).$(EP_EXTRAVERSION)
 
-LIB_TARGET  = libtraceevent.a libtraceevent.so libtraceevent.so.$(EP_VERSION) libtraceevent.so.$(EVENT_PARSE_VERSION)
-LIB_INSTALL = libtraceevent.a libtraceevent.so*
+LIBTRACEEVENT_STATIC = libtraceevent.a
+LIBTRACEEVENT_SHARED = libtraceevent.so.$(EVENT_PARSE_VERSION)
+
+LIB_TARGET  = $(LIBTRACEEVENT_STATIC) libtraceevent.so libtraceevent.so.$(EP_VERSION) $(LIBTRACEEVENT_SHARED)
+LIB_INSTALL = $(LIBTRACEEVENT_STATIC) libtraceevent.so*
 LIB_INSTALL := $(addprefix $(OUTPUT),$(LIB_INSTALL))
 
 INCLUDES = -I. -I $(srctree)/include $(CONFIG_INCLUDES)
@@ -142,16 +145,16 @@ all_cmd: $(CMD_TARGETS)
 $(TE_IN): force
 	$(Q)$(MAKE) $(build)=libtraceevent
 
-$(OUTPUT)libtraceevent.so.$(EVENT_PARSE_VERSION): $(TE_IN)
+$(OUTPUT)$(LIBTRACEEVENT_SHARED): $(TE_IN)
 	$(QUIET_LINK)$(CC) --shared $(LDFLAGS) $^ -Wl,-soname,libtraceevent.so.$(EP_VERSION) -o $@  $(LIBS)
 
 $(OUTPUT)libtraceevent.so: $(OUTPUT)libtraceevent.so.$(EP_VERSION)
 	@ln -sf $(<F) $@
 
-$(OUTPUT)libtraceevent.so.$(EP_VERSION): $(OUTPUT)libtraceevent.so.$(EVENT_PARSE_VERSION)
+$(OUTPUT)libtraceevent.so.$(EP_VERSION): $(OUTPUT)$(LIBTRACEEVENT_SHARED)
 	@ln -sf $(<F) $@
 
-$(OUTPUT)libtraceevent.a: $(TE_IN)
+$(OUTPUT)$(LIBTRACEEVENT_STATIC): $(TE_IN)
 	$(QUIET_LINK)$(RM) $@; $(AR) rcs $@ $^
 
 $(OUTPUT)%.so: $(OUTPUT)%-in.o
Signature · 1 line
2.29.2
#2 lore raw

PATCH 2/6 libtraceevent: Remove "src" and "obj" from Makefile

In reply to Steven Rostedt

From: "Steven Rostedt (VMware)" <[email protected]>

"src" and "obj" variables are not used in the Makefile. There's no need to export them.

---
 Makefile         | 2 +-
 plugins/Makefile | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Makefile +1 -1
index e17e9674573b..3c2bd5619c3b 100644
@@ -75,7 +75,7 @@ srctree := $(CURDIR)
 #$(info Determined 'srctree' to be $(srctree))
 endif
 
-export prefix libdir src obj
+export prefix libdir
 
 # Shell quotes
 libdir_SQ = $(subst ','\'',$(libdir))
plugins/Makefile +1 -1
index f34bb5725cbc..8ae3882f9051 100644
@@ -81,7 +81,7 @@ srctree := $(patsubst %/,%,$(dir $(CURDIR)))
 #$(info Determined 'srctree' to be $(srctree))
 endif
 
-export prefix libdir src obj
+export prefix libdir
 
 # Shell quotes
 plugin_dir_SQ = $(subst ','\'',$(plugin_dir))
Signature · 1 line
2.29.2
#3 lore raw

PATCH 3/6 libtraceevent: Move creation of PKG_CONFIG_FILE to after Makefile.include

In reply to Steven Rostedt

From: "Steven Rostedt (VMware)" <[email protected]>

The creation of the PKG_CONFIG_FILE appends $(OUTPUT) to $(PKG_CONFIG_SOURCE_FILE) but this happens before the include of Makefile.include, that defines what $(OUTPUT) is. The end result is that the libtraceevent.pc file is not created in tho output directory that is specified.

---
 Makefile | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Makefile +3 -3
index 3c2bd5619c3b..3f96c1c7b4d6 100644
@@ -52,15 +52,15 @@ includedir_relative = traceevent
 includedir = $(prefix)/include/$(includedir_relative)
 includedir_SQ = '$(subst ','\'',$(includedir))'
 
-PKG_CONFIG_SOURCE_FILE = libtraceevent.pc
-PKG_CONFIG_FILE := $(addprefix $(OUTPUT),$(PKG_CONFIG_SOURCE_FILE))
-
 export man_dir man_dir_SQ INSTALL
 export DESTDIR DESTDIR_SQ
 export EVENT_PARSE_VERSION
 
 include scripts/Makefile.include
 
+PKG_CONFIG_SOURCE_FILE = libtraceevent.pc
+PKG_CONFIG_FILE := $(addprefix $(OUTPUT),$(PKG_CONFIG_SOURCE_FILE))
+
 # copy a bit from Linux kbuild
 
 ifeq ("$(origin V)", "command line")
Signature · 1 line
2.29.2
#4 lore raw

PATCH 4/6 libtraceevent: Have make clean honor the output (O=foo) directory

In reply to Steven Rostedt

From: "Steven Rostedt (VMware)" <[email protected]>

If "make O=/some/dir clean" is performed, the O=/some/dir is not honored, and the clean is performed on the current directory. If O= is specified on the command line, then the clean should perform the cleaning to that directory.

---
 Makefile         | 4 ++--
 plugins/Makefile | 5 +++--
 2 files changed, 5 insertions(+), 4 deletions(-)
Makefile +2 -2
index 3f96c1c7b4d6..330c8339f023 100644
@@ -255,8 +255,8 @@ install: install_lib
 
 clean: clean_plugins
 	$(call QUIET_CLEAN, libtraceevent) \
-		$(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd; \
-		$(RM) TRACEEVENT-CFLAGS tags TAGS; \
+		$(RM) $(OUTPUT)*.o $(OUTPUT)*~ $(TARGETS) $(OUTPUT)*.a $(OUTPUT)*.so $(VERSION_FILES) $(OUTPUT).*.d $(OUTPUT).*.cmd; \
+		$(RM) TRACEEVENT-CFLAGS $(OUTPUT)tags $(OUTPUT)TAGS; \
 		$(RM) $(PKG_CONFIG_FILE)
 
 PHONY += doc
plugins/Makefile +3 -2
index 8ae3882f9051..a8868d01b09b 100644
@@ -210,8 +210,9 @@ install: $(PLUGINS)
 
 clean:
 	$(call QUIET_CLEAN, trace_plugins) \
-		$(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd; \
-		$(RM) $(OUTPUT)libtraceevent-dynamic-list \
+		$(RM) $(OUTPUT)*.o $(OUTPUT)*~ $(TARGETS) $(OUTPUT)*.a $(OUTPUT)*.so $(VERSION_FILES) .*.d .*.cmd; \
+		$(RM) $(OUTPUT)libtraceevent-dynamic-list; \
+		$(RM) $(PLUGINS); \
 		$(RM) TRACEEVENT-CFLAGS tags TAGS;
 
 PHONY += force plugins
Signature · 1 line
2.29.2
#5 lore raw

PATCH 5/6 libtraceevent: Have binary libraries build into lib directory

In reply to Steven Rostedt

From: "Steven Rostedt (VMware)" <[email protected]>

To clean up the source directory, have the library binaries build into its own "lib" directory.

---
 Makefile | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)
Makefile +13 -7
index 330c8339f023..9ec880c0105b 100644
@@ -94,11 +94,15 @@ N		=
 
 EVENT_PARSE_VERSION = $(EP_VERSION).$(EP_PATCHLEVEL).$(EP_EXTRAVERSION)
 
-LIBTRACEEVENT_STATIC = libtraceevent.a
-LIBTRACEEVENT_SHARED = libtraceevent.so.$(EVENT_PARSE_VERSION)
+bdir = lib
 
-LIB_TARGET  = $(LIBTRACEEVENT_STATIC) libtraceevent.so libtraceevent.so.$(EP_VERSION) $(LIBTRACEEVENT_SHARED)
-LIB_INSTALL = $(LIBTRACEEVENT_STATIC) libtraceevent.so*
+export bdir
+
+LIBTRACEEVENT_STATIC = $(bdir)/libtraceevent.a
+LIBTRACEEVENT_SHARED = $(bdir)/libtraceevent.so.$(EVENT_PARSE_VERSION)
+
+LIB_TARGET  = $(LIBTRACEEVENT_STATIC) $(bdir)/libtraceevent.so $(bdir)/libtraceevent.so.$(EP_VERSION) $(LIBTRACEEVENT_SHARED)
+LIB_INSTALL = $(LIBTRACEEVENT_STATIC) $(bdir)/libtraceevent.so*
 LIB_INSTALL := $(addprefix $(OUTPUT),$(LIB_INSTALL))
 
 INCLUDES = -I. -I $(srctree)/include $(CONFIG_INCLUDES)
@@ -146,18 +150,20 @@ $(TE_IN): force
 	$(Q)$(MAKE) $(build)=libtraceevent
 
 $(OUTPUT)$(LIBTRACEEVENT_SHARED): $(TE_IN)
+	$(Q)mkdir -p $(OUTPUT)$(bdir)
 	$(QUIET_LINK)$(CC) --shared $(LDFLAGS) $^ -Wl,-soname,libtraceevent.so.$(EP_VERSION) -o $@  $(LIBS)
 
-$(OUTPUT)libtraceevent.so: $(OUTPUT)libtraceevent.so.$(EP_VERSION)
+$(OUTPUT)$(bdir)/libtraceevent.so: $(OUTPUT)$(bdir)/libtraceevent.so.$(EP_VERSION)
 	@ln -sf $(<F) $@
 
-$(OUTPUT)libtraceevent.so.$(EP_VERSION): $(OUTPUT)$(LIBTRACEEVENT_SHARED)
+$(OUTPUT)$(bdir)/libtraceevent.so.$(EP_VERSION): $(OUTPUT)$(LIBTRACEEVENT_SHARED)
 	@ln -sf $(<F) $@
 
 $(OUTPUT)$(LIBTRACEEVENT_STATIC): $(TE_IN)
+	$(Q)mkdir -p $(OUTPUT)$(bdir)
 	$(QUIET_LINK)$(RM) $@; $(AR) rcs $@ $^
 
-$(OUTPUT)%.so: $(OUTPUT)%-in.o
+$(OUTPUT)$(bdir)/%.so: $(OUTPUT)%-in.o
 	$(QUIET_LINK)$(CC) $(CFLAGS) -shared $(LDFLAGS) -nostartfiles -o $@ $^ $(LIBS)
 
 define make_version.h
Signature · 1 line
2.29.2
#6 lore raw

PATCH 6/6 libtraceevent: Move source files into src/ directory

In reply to Steven Rostedt

From: "Steven Rostedt (VMware)" <[email protected]>

To clean up the source directory, create a "src" directory to store the header and C files.

---
 Makefile                                       | 18 +++++++++++-------
 plugins/Makefile                               |  2 +-
 Build => src/Build                             |  0
 src/Makefile                                   | 12 ++++++++++++
 event-parse-api.c => src/event-parse-api.c     |  0
 event-parse-local.h => src/event-parse-local.h |  0
 event-parse.c => src/event-parse.c             |  0
 event-parse.h => src/event-parse.h             |  0
 event-plugin.c => src/event-plugin.c           |  0
 event-utils.h => src/event-utils.h             |  0
 kbuffer-parse.c => src/kbuffer-parse.c         |  0
 kbuffer.h => src/kbuffer.h                     |  0
 parse-filter.c => src/parse-filter.c           |  0
 parse-utils.c => src/parse-utils.c             |  0
 tep_strerror.c => src/tep_strerror.c           |  0
 trace-seq.c => src/trace-seq.c                 |  0
 trace-seq.h => src/trace-seq.h                 |  0
 17 files changed, 24 insertions(+), 8 deletions(-)
 rename Build => src/Build (100%)
 create mode 100644 src/Makefile
 rename event-parse-api.c => src/event-parse-api.c (100%)
 rename event-parse-local.h => src/event-parse-local.h (100%)
 rename event-parse.c => src/event-parse.c (100%)
 rename event-parse.h => src/event-parse.h (100%)
 rename event-plugin.c => src/event-plugin.c (100%)
 rename event-utils.h => src/event-utils.h (100%)
 rename kbuffer-parse.c => src/kbuffer-parse.c (100%)
 rename kbuffer.h => src/kbuffer.h (100%)
 rename parse-filter.c => src/parse-filter.c (100%)
 rename parse-utils.c => src/parse-utils.c (100%)
 rename tep_strerror.c => src/tep_strerror.c (100%)
 rename trace-seq.c => src/trace-seq.c (100%)
 rename trace-seq.h => src/trace-seq.h (100%)
Makefile +11 -7
index 9ec880c0105b..9044536d2fcf 100644
@@ -135,7 +135,7 @@ MAKEOVERRIDES=
 export srctree OUTPUT CC LD CFLAGS V
 build := -f $(srctree)/build/Makefile.build dir=. obj
 
-TE_IN      := $(OUTPUT)libtraceevent-in.o
+TE_IN      := $(OUTPUT)src/libtraceevent-in.o
 LIB_TARGET := $(addprefix $(OUTPUT),$(LIB_TARGET))
 
 CMD_TARGETS = $(LIB_TARGET) $(PKG_CONFIG_FILE)
@@ -147,7 +147,7 @@ all: all_cmd plugins
 all_cmd: $(CMD_TARGETS)
 
 $(TE_IN): force
-	$(Q)$(MAKE) $(build)=libtraceevent
+	$(Q)$(call descend,src,libtraceevent)
 
 $(OUTPUT)$(LIBTRACEEVENT_SHARED): $(TE_IN)
 	$(Q)mkdir -p $(OUTPUT)$(bdir)
@@ -252,14 +252,14 @@ install_pkgconfig: $(PKG_CONFIG_FILE)
 
 install_headers:
 	$(call QUIET_INSTALL, headers) \
-		$(call do_install,event-parse.h,$(includedir_SQ),644); \
-		$(call do_install,event-utils.h,$(includedir_SQ),644); \
-		$(call do_install,trace-seq.h,$(includedir_SQ),644); \
-		$(call do_install,kbuffer.h,$(includedir_SQ),644)
+		$(call do_install,src/event-parse.h,$(includedir_SQ),644); \
+		$(call do_install,src/event-utils.h,$(includedir_SQ),644); \
+		$(call do_install,src/trace-seq.h,$(includedir_SQ),644); \
+		$(call do_install,src/kbuffer.h,$(includedir_SQ),644)
 
 install: install_lib
 
-clean: clean_plugins
+clean: clean_plugins clean_src
 	$(call QUIET_CLEAN, libtraceevent) \
 		$(RM) $(OUTPUT)*.o $(OUTPUT)*~ $(TARGETS) $(OUTPUT)*.a $(OUTPUT)*.so $(VERSION_FILES) $(OUTPUT).*.d $(OUTPUT).*.cmd; \
 		$(RM) TRACEEVENT-CFLAGS $(OUTPUT)tags $(OUTPUT)TAGS; \
@@ -310,6 +310,10 @@ PHONY += clean_plugins
 clean_plugins:
 	$(call descend,plugins,clean)
 
+PHONY += clean_src
+clean_src:
+	$(call descend,src,clean)
+
 force:
 
 # Declare the contents of the .PHONY variable as phony.  We keep that
plugins/Makefile +1 -1
index a8868d01b09b..e8b8850a19a9 100644
@@ -93,7 +93,7 @@ CONFIG_FLAGS   =
 OBJ            = $@
 N              =
 
-INCLUDES = -I. -I.. -I $(srctree)/include $(CONFIG_INCLUDES)
+INCLUDES = -I. -I.. -I../src -I $(srctree)/include $(CONFIG_INCLUDES)
 
 # Set compile option CFLAGS
 ifdef EXTRA_CFLAGS
src/Build renamed from Build +0 -0
similarity index 100%
rename from Build
rename to src/Build
src/Makefile new file +12 -0
new file mode 100644
index 000000000000..c62104b77c86
@@ -0,0 +1,12 @@
+
+include ../scripts/Makefile.include
+
+build := -f $(srctree)/build/Makefile.build dir=. obj
+
+libtraceevent: $(libtraceevent-y)
+	$(Q)$(MAKE) $(build)=libtraceevent
+
+clean:
+	$(call QUIET_CLEAN, trace_src) \
+		$(RM) $(OUTPUT)*.o $(OUTPUT)*~ .*.d .*.cmd
+
src/event-parse-api.c renamed from event-parse-api.c +0 -0
similarity index 100%
rename from event-parse-api.c
rename to src/event-parse-api.c
src/event-parse-local.h renamed from event-parse-local.h +0 -0
similarity index 100%
rename from event-parse-local.h
rename to src/event-parse-local.h
src/event-parse.c renamed from event-parse.c +0 -0
similarity index 100%
rename from event-parse.c
rename to src/event-parse.c
src/event-parse.h renamed from event-parse.h +0 -0
similarity index 100%
rename from event-parse.h
rename to src/event-parse.h
src/event-plugin.c renamed from event-plugin.c +0 -0
similarity index 100%
rename from event-plugin.c
rename to src/event-plugin.c
src/event-utils.h renamed from event-utils.h +0 -0
similarity index 100%
rename from event-utils.h
rename to src/event-utils.h
src/kbuffer-parse.c renamed from kbuffer-parse.c +0 -0
similarity index 100%
rename from kbuffer-parse.c
rename to src/kbuffer-parse.c
src/kbuffer.h renamed from kbuffer.h +0 -0
similarity index 100%
rename from kbuffer.h
rename to src/kbuffer.h
src/parse-filter.c renamed from parse-filter.c +0 -0
similarity index 100%
rename from parse-filter.c
rename to src/parse-filter.c
src/parse-utils.c renamed from parse-utils.c +0 -0
similarity index 100%
rename from parse-utils.c
rename to src/parse-utils.c
src/tep_strerror.c renamed from tep_strerror.c +0 -0
similarity index 100%
rename from tep_strerror.c
rename to src/tep_strerror.c
src/trace-seq.c renamed from trace-seq.c +0 -0
similarity index 100%
rename from trace-seq.c
rename to src/trace-seq.c
src/trace-seq.h renamed from trace-seq.h +0 -0
similarity index 100%
rename from trace-seq.h
rename to src/trace-seq.h
Signature · 1 line
2.29.2