Skip to contentSkip to conversation

libtraceevent: Added support for pkg-config and few other fixes related to transfoming traceevent into a library

PATCH Superseded Tzvetomir Stoyanov 3 participants 8 messages Sep 28, 2018 – Nov 20, 2018

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover libtraceevent: Added support for pkg-config and few other fixes related to transfoming traceevent into a library

Added support for pkg-config, which makes possible the library to be detected by autoconfig. Implemented new API tep_ref_get(), used by applications to get the tep handle reference count. Install trace-seq.h header file, which is part of the library API.

Tzvetomir Stoyanov (3):
tools/lib/traceevent: Implemented new API tep_ref_get() tools/lib/traceevent: Added support for pkg-config tools/lib/traceevent: Install trace-seq.h API header file

 tools/lib/traceevent/Makefile                 | 27 ++++++++++++++++---
 tools/lib/traceevent/event-parse.c            |  7 +++++
 tools/lib/traceevent/event-parse.h            |  1 +
 .../lib/traceevent/libtraceevent.pc.template  | 10 +++++++
 4 files changed, 42 insertions(+), 3 deletions(-)
 create mode 100644 tools/lib/traceevent/libtraceevent.pc.template
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/3 tools/lib/traceevent: Implemented new API tep_ref_get()

This patch implements new API of the tracevent library:
int tep_ref_get(struct tep_handle *pevent);
The API returns the reference counter "ref_count" of the tep handler. As "struct tep_handle" is internal only, its members cannot be accessed by the library users, the API is used to get the reference counter.

---
 tools/lib/traceevent/event-parse.c | 7 +++++++
 tools/lib/traceevent/event-parse.h | 1 +
 2 files changed, 8 insertions(+)
tools/lib/traceevent/event-parse.c +7 -0
index f327c990dedc..aa26d0e7c074 100644
@@ -6774,6 +6774,13 @@ void tep_ref(struct tep_handle *pevent)
 	pevent->ref_count++;
 }
 
+int tep_ref_get(struct tep_handle *pevent)
+{
+	if (pevent)
+		return pevent->ref_count;
+	return 0;
+}
+
 void tep_free_format_field(struct tep_format_field *field)
 {
 	free(field->type);
tools/lib/traceevent/event-parse.h +1 -0
index 100b0b7b29fc..cda21a67160e 100644
@@ -577,6 +577,7 @@ struct tep_handle *tep_alloc(void);
 void tep_free(struct tep_handle *pevent);
 void tep_ref(struct tep_handle *pevent);
 void tep_unref(struct tep_handle *pevent);
+int tep_ref_get(struct tep_handle *pevent);
 
 /* access to the internal parser */
 void tep_buffer_init(const char *buf, unsigned long long size);
Signature · 1 line
2.17.1
#2 lore raw

Re: [PATCH 1/3] tools/lib/traceevent: Implemented new API tep_ref_get()

Quoted 17 lines · On Fri, 28 Sep 2018 10:19:38 +0300 Tzvetomir Stoyanov <[email protected]>…

This patch implements new API of the tracevent library:
int tep_ref_get(struct tep_handle *pevent);
The API returns the reference counter "ref_count" of the tep handler. As "struct tep_handle" is internal only, its members cannot be accessed by the library users, the API is used to get the reference counter.

---
 tools/lib/traceevent/event-parse.c | 7 +++++++
 tools/lib/traceevent/event-parse.h | 1 +
 2 files changed, 8 insertions(+)
tools/lib/traceevent/event-parse.c +0 -0
index f327c990dedc..aa26d0e7c074 100644

tools/lib/traceevent/event-parse.c void tep_ref(struct tep_handle *pevent) · line 6777

Quoted 4 lines
tools/lib/traceevent/event-parse.c +1 -0
@@ -6774,6 +6774,13 @@ void tep_ref(struct tep_handle *pevent)
 	pevent->ref_count++;
 }
 
+int tep_ref_get(struct tep_handle *pevent)

Hmm, I'm thinking we should call this "tep_get_ref" as that fits more the naming convention of the Linux kernel.

-- Steve

Quoted 21 lines
tools/lib/traceevent/event-parse.c +6 -0
+{
+	if (pevent)
+		return pevent->ref_count;
+	return 0;
+}
+
 void tep_free_format_field(struct tep_format_field *field)
 {
 	free(field->type);
tools/lib/traceevent/event-parse.h +1 -0
index 100b0b7b29fc..cda21a67160e 100644
@@ -577,6 +577,7 @@ struct tep_handle *tep_alloc(void);
 void tep_free(struct tep_handle *pevent);
 void tep_ref(struct tep_handle *pevent);
 void tep_unref(struct tep_handle *pevent);
+int tep_ref_get(struct tep_handle *pevent);
 
 /* access to the internal parser */
 void tep_buffer_init(const char *buf, unsigned long long size);
#3 lore raw

Re: [PATCH 1/3] tools/lib/traceevent: Implemented new API tep_ref_get()

Quoted 24 lines · Steven Rostedt
Quoted 20 lines · On Fri, 28 Sep 2018 10:19:38 +0300 Tzvetomir Stoyanov <[email protected]>…

This patch implements new API of the tracevent library:
int tep_ref_get(struct tep_handle *pevent);
The API returns the reference counter "ref_count" of the tep handler. As "struct tep_handle" is internal only, its members cannot be accessed by the library users, the API is used to get the reference counter.

---
 tools/lib/traceevent/event-parse.c | 7 +++++++
 tools/lib/traceevent/event-parse.h | 1 +
 2 files changed, 8 insertions(+)
tools/lib/traceevent/event-parse.c +0 -0
index f327c990dedc..aa26d0e7c074 100644
@@ -6774,6 +6774,13 @@ void tep_ref(struct tep_handle *pevent)
      pevent->ref_count++;
 }
 
Quoted 6 lines

tools/lib/traceevent/event-parse.c void tep_ref(struct tep_handle *pevent) · line 6777

Quoted 1 line
tools/lib/traceevent/event-parse.c +1 -0
+int tep_ref_get(struct tep_handle *pevent)

Hmm, I'm thinking we should call this "tep_get_ref" as that fits more the naming convention of the Linux kernel.

-- Steve

Ok, going to send a V2 of this patch

Quoted 23 lines
Quoted 22 lines
tools/lib/traceevent/event-parse.c +6 -0
+{
+     if (pevent)
+             return pevent->ref_count;
+     return 0;
+}
+
 void tep_free_format_field(struct tep_format_field *field)
 {
      free(field->type);
tools/lib/traceevent/event-parse.h +1 -0
index 100b0b7b29fc..cda21a67160e 100644
@@ -577,6 +577,7 @@ struct tep_handle *tep_alloc(void);
 void tep_free(struct tep_handle *pevent);
 void tep_ref(struct tep_handle *pevent);
 void tep_unref(struct tep_handle *pevent);
+int tep_ref_get(struct tep_handle *pevent);
 
 /* access to the internal parser */
 void tep_buffer_init(const char *buf, unsigned long long size);
Signature · 2 lines
Tzvetomir (Ceco) Stoyanov
VMware Open Source Technology Center
#4 lore raw

PATCH 2/3 tools/lib/traceevent: Added support for pkg-config

In reply to Tzvetomir Stoyanov

This patch implements integration with pkg-config framework. pkg-config can be used by the library users to determine required CFLAGS and LDFLAGS in order to use the library

---
 tools/lib/traceevent/Makefile                 | 26 ++++++++++++++++---
 .../lib/traceevent/libtraceevent.pc.template  | 10 +++++++
 2 files changed, 33 insertions(+), 3 deletions(-)
 create mode 100644 tools/lib/traceevent/libtraceevent.pc.template
tools/lib/traceevent/Makefile +23 -3
index 0b4e833088a4..05ac0ec9bcd1 100644
@@ -25,6 +25,7 @@ endef
 $(call allow-override,CC,$(CROSS_COMPILE)gcc)
 $(call allow-override,AR,$(CROSS_COMPILE)ar)
 $(call allow-override,NM,$(CROSS_COMPILE)nm)
+$(call allow-override,PKG_CONFIG,pkg-config)
 
 EXT = -std=gnu99
 INSTALL = install
@@ -47,6 +48,8 @@ prefix ?= /usr/local
 libdir = $(prefix)/$(libdir_relative)
 man_dir = $(prefix)/share/man
 man_dir_SQ = '$(subst ','\'',$(man_dir))'
+pkgconfig_dir ?= $(word 1,$(shell $(PKG_CONFIG) 		\
+			--variable pc_path pkg-config | tr ":" " "))
 
 export man_dir man_dir_SQ INSTALL
 export DESTDIR DESTDIR_SQ
@@ -270,7 +273,19 @@ define do_generate_dynamic_list_file
 	fi
 endef
 
-install_lib: all_cmd install_plugins
+PKG_CONFIG_FILE = libtraceevent.pc
+define do_install_pkgconfig_file
+	if [ -n "${pkgconfig_dir}" ]; then 					\
+		cp -f ${PKG_CONFIG_FILE}.template ${PKG_CONFIG_FILE}; 		\
+		sed -i "s|INSTALL_PREFIX|${1}|g" ${PKG_CONFIG_FILE}; 		\
+		sed -i "s|LIB_VERSION|${EVENT_PARSE_VERSION}|g" ${PKG_CONFIG_FILE}; \
+		$(call do_install,$(PKG_CONFIG_FILE),$(pkgconfig_dir),644); 	\
+	else 									\
+		(echo Failed to locate pkg-config directory) 1>&2;		\
+	fi	
+endef
+
+install_lib: all_cmd install_plugins install_pkgconfig
 	$(call QUIET_INSTALL, $(LIB_TARGET)) \
 		$(call do_install_mkdir,$(libdir_SQ)); \
 		cp -fpR $(LIB_INSTALL) $(DESTDIR)$(libdir_SQ)
@@ -279,6 +294,10 @@ install_plugins: $(PLUGINS)
 	$(call QUIET_INSTALL, trace_plugins) \
 		$(call do_install_plugins, $(PLUGINS))
 
+install_pkgconfig:
+	$(call QUIET_INSTALL, $(PKG_CONFIG_FILE)) \
+		$(call do_install_pkgconfig_file,$(prefix))
+
 install_headers:
 	$(call QUIET_INSTALL, headers) \
 		$(call do_install,event-parse.h,$(prefix)/include/traceevent,644); \
@@ -289,8 +308,9 @@ install: install_lib
 
 clean:
 	$(call QUIET_CLEAN, libtraceevent) \
-		$(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd \
-		$(RM) TRACEEVENT-CFLAGS tags TAGS
+		$(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd; \
+		$(RM) TRACEEVENT-CFLAGS tags TAGS; \
+		$(RM) $(PKG_CONFIG_FILE)
 
 PHONY += force plugins
 force:
tools/lib/traceevent/libtraceevent.pc.template new file +10 -0
new file mode 100644
index 000000000000..7e5078aadf85
@@ -0,0 +1,10 @@
+prefix=INSTALL_PREFIX
+libdir=${prefix}/lib64
+includedir=${prefix}/include/traceevent
+
+Name: libtraceevent
+URL: https://git.kernel.org/pub/scm/linux/kernel/git/rostedt/trace-cmd.git/about/
+Description: traceevent library
+Version: LIB_VERSION
+Cflags: -I${includedir}
+Libs: -L${libdir} -ltraceevent
Signature · 1 line
2.17.1
#5 lore raw

Re: [PATCH 2/3] tools/lib/traceevent: Added support for pkg-config

Quoted 83 lines · Tzvetomir Stoyanov

This patch implements integration with pkg-config framework. pkg-config can be used by the library users to determine required CFLAGS and LDFLAGS in order to use the library

---
 tools/lib/traceevent/Makefile                 | 26 ++++++++++++++++---
 .../lib/traceevent/libtraceevent.pc.template  | 10 +++++++
 2 files changed, 33 insertions(+), 3 deletions(-)
 create mode 100644 tools/lib/traceevent/libtraceevent.pc.template
tools/lib/traceevent/Makefile +23 -3
index 0b4e833088a4..05ac0ec9bcd1 100644
@@ -25,6 +25,7 @@ endef
 $(call allow-override,CC,$(CROSS_COMPILE)gcc)
 $(call allow-override,AR,$(CROSS_COMPILE)ar)
 $(call allow-override,NM,$(CROSS_COMPILE)nm)
+$(call allow-override,PKG_CONFIG,pkg-config)
 
 EXT = -std=gnu99
 INSTALL = install
@@ -47,6 +48,8 @@ prefix ?= /usr/local
 libdir = $(prefix)/$(libdir_relative)
 man_dir = $(prefix)/share/man
 man_dir_SQ = '$(subst ','\'',$(man_dir))'
+pkgconfig_dir ?= $(word 1,$(shell $(PKG_CONFIG)                \
+                       --variable pc_path pkg-config | tr ":" " "))
 
 export man_dir man_dir_SQ INSTALL
 export DESTDIR DESTDIR_SQ
@@ -270,7 +273,19 @@ define do_generate_dynamic_list_file
        fi
 endef
 
-install_lib: all_cmd install_plugins
+PKG_CONFIG_FILE = libtraceevent.pc
+define do_install_pkgconfig_file
+       if [ -n "${pkgconfig_dir}" ]; then                                      \
+               cp -f ${PKG_CONFIG_FILE}.template ${PKG_CONFIG_FILE};           \
+               sed -i "s|INSTALL_PREFIX|${1}|g" ${PKG_CONFIG_FILE};            \
+               sed -i "s|LIB_VERSION|${EVENT_PARSE_VERSION}|g" ${PKG_CONFIG_FILE}; \
+               $(call do_install,$(PKG_CONFIG_FILE),$(pkgconfig_dir),644);     \
+       else                                                                    \
+               (echo Failed to locate pkg-config directory) 1>&2;              \
+       fi
+endef
+
+install_lib: all_cmd install_plugins install_pkgconfig
        $(call QUIET_INSTALL, $(LIB_TARGET)) \
                $(call do_install_mkdir,$(libdir_SQ)); \
                cp -fpR $(LIB_INSTALL) $(DESTDIR)$(libdir_SQ)
@@ -279,6 +294,10 @@ install_plugins: $(PLUGINS)
        $(call QUIET_INSTALL, trace_plugins) \
                $(call do_install_plugins, $(PLUGINS))
 
+install_pkgconfig:
+       $(call QUIET_INSTALL, $(PKG_CONFIG_FILE)) \
+               $(call do_install_pkgconfig_file,$(prefix))
+
 install_headers:
        $(call QUIET_INSTALL, headers) \
                $(call do_install,event-parse.h,$(prefix)/include/traceevent,644); \
@@ -289,8 +308,9 @@ install: install_lib
 
 clean:
        $(call QUIET_CLEAN, libtraceevent) \
-               $(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd \
-               $(RM) TRACEEVENT-CFLAGS tags TAGS
+               $(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd; \
+               $(RM) TRACEEVENT-CFLAGS tags TAGS; \
+               $(RM) $(PKG_CONFIG_FILE)
 
 PHONY += force plugins
 force:
tools/lib/traceevent/libtraceevent.pc.template new file +0 -0
new file mode 100644
index 000000000000..7e5078aadf85

tools/lib/traceevent/libtraceevent.pc.template line 6

Quoted 6 lines
tools/lib/traceevent/libtraceevent.pc.template new file +6 -0
@@ -0,0 +1,10 @@
+prefix=INSTALL_PREFIX
+libdir=${prefix}/lib64
+includedir=${prefix}/include/traceevent
+
+Name: libtraceevent
+URL: https://git.kernel.org/pub/scm/linux/kernel/git/rostedt/trace-cmd.git/about/

Shouldn't this rather point to the official repo at
https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/about ?

Quoted 7 lines
tools/lib/traceevent/libtraceevent.pc.template new file +4 -1
+Description: traceevent library
+Version: LIB_VERSION
+Cflags: -I${includedir}
+Libs: -L${libdir} -ltraceevent
--

2.17.1

#6 lore raw

Re: [PATCH 2/3] tools/lib/traceevent: Added support for pkg-config

In reply to Tzvetomir Stoyanov
Quoted 3 lines · On Fri, 28 Sep 2018 10:19:39 +0300 Tzvetomir Stoyanov <[email protected]>…

This patch implements integration with pkg-config framework. pkg-config can be used by the library users to determine required CFLAGS and LDFLAGS in order to use the library

Do we still need this patch. I thought that there was some issue with PowerTop where this wasn't working. If you think it's still useful then we'll keep it.

Thanks!

-- Steve

Quoted 89 lines
---
 tools/lib/traceevent/Makefile                 | 26 ++++++++++++++++---
 .../lib/traceevent/libtraceevent.pc.template  | 10 +++++++
 2 files changed, 33 insertions(+), 3 deletions(-)
 create mode 100644 tools/lib/traceevent/libtraceevent.pc.template
tools/lib/traceevent/Makefile +23 -3
index 0b4e833088a4..05ac0ec9bcd1 100644
@@ -25,6 +25,7 @@ endef
 $(call allow-override,CC,$(CROSS_COMPILE)gcc)
 $(call allow-override,AR,$(CROSS_COMPILE)ar)
 $(call allow-override,NM,$(CROSS_COMPILE)nm)
+$(call allow-override,PKG_CONFIG,pkg-config)
 
 EXT = -std=gnu99
 INSTALL = install
@@ -47,6 +48,8 @@ prefix ?= /usr/local
 libdir = $(prefix)/$(libdir_relative)
 man_dir = $(prefix)/share/man
 man_dir_SQ = '$(subst ','\'',$(man_dir))'
+pkgconfig_dir ?= $(word 1,$(shell $(PKG_CONFIG) 		\
+			--variable pc_path pkg-config | tr ":" " "))
 
 export man_dir man_dir_SQ INSTALL
 export DESTDIR DESTDIR_SQ
@@ -270,7 +273,19 @@ define do_generate_dynamic_list_file
 	fi
 endef
 
-install_lib: all_cmd install_plugins
+PKG_CONFIG_FILE = libtraceevent.pc
+define do_install_pkgconfig_file
+	if [ -n "${pkgconfig_dir}" ]; then 					\
+		cp -f ${PKG_CONFIG_FILE}.template ${PKG_CONFIG_FILE}; 		\
+		sed -i "s|INSTALL_PREFIX|${1}|g" ${PKG_CONFIG_FILE}; 		\
+		sed -i "s|LIB_VERSION|${EVENT_PARSE_VERSION}|g" ${PKG_CONFIG_FILE}; \
+		$(call do_install,$(PKG_CONFIG_FILE),$(pkgconfig_dir),644); 	\
+	else 									\
+		(echo Failed to locate pkg-config directory) 1>&2;		\
+	fi	
+endef
+
+install_lib: all_cmd install_plugins install_pkgconfig
 	$(call QUIET_INSTALL, $(LIB_TARGET)) \
 		$(call do_install_mkdir,$(libdir_SQ)); \
 		cp -fpR $(LIB_INSTALL) $(DESTDIR)$(libdir_SQ)
@@ -279,6 +294,10 @@ install_plugins: $(PLUGINS)
 	$(call QUIET_INSTALL, trace_plugins) \
 		$(call do_install_plugins, $(PLUGINS))
 
+install_pkgconfig:
+	$(call QUIET_INSTALL, $(PKG_CONFIG_FILE)) \
+		$(call do_install_pkgconfig_file,$(prefix))
+
 install_headers:
 	$(call QUIET_INSTALL, headers) \
 		$(call do_install,event-parse.h,$(prefix)/include/traceevent,644); \
@@ -289,8 +308,9 @@ install: install_lib
 
 clean:
 	$(call QUIET_CLEAN, libtraceevent) \
-		$(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd \
-		$(RM) TRACEEVENT-CFLAGS tags TAGS
+		$(RM) *.o *~ $(TARGETS) *.a *.so $(VERSION_FILES) .*.d .*.cmd; \
+		$(RM) TRACEEVENT-CFLAGS tags TAGS; \
+		$(RM) $(PKG_CONFIG_FILE)
 
 PHONY += force plugins
 force:
tools/lib/traceevent/libtraceevent.pc.template new file +10 -0
new file mode 100644
index 000000000000..7e5078aadf85
@@ -0,0 +1,10 @@
+prefix=INSTALL_PREFIX
+libdir=${prefix}/lib64
+includedir=${prefix}/include/traceevent
+
+Name: libtraceevent
+URL: https://git.kernel.org/pub/scm/linux/kernel/git/rostedt/trace-cmd.git/about/
+Description: traceevent library
+Version: LIB_VERSION
+Cflags: -I${includedir}
+Libs: -L${libdir} -ltraceevent
#7 lore raw

PATCH 3/3 tools/lib/traceevent: Install trace-seq.h API header file

In reply to Tzvetomir Stoyanov

This patch installs trace-seq.h header file on "make install".

---
 tools/lib/traceevent/Makefile | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
tools/lib/traceevent/Makefile +2 -1
index 05ac0ec9bcd1..f65243137d6d 100644
@@ -285,7 +285,7 @@ define do_install_pkgconfig_file
 	fi	
 endef
 
-install_lib: all_cmd install_plugins install_pkgconfig
+install_lib: all_cmd install_plugins install_headers install_pkgconfig
 	$(call QUIET_INSTALL, $(LIB_TARGET)) \
 		$(call do_install_mkdir,$(libdir_SQ)); \
 		cp -fpR $(LIB_INSTALL) $(DESTDIR)$(libdir_SQ)
@@ -302,6 +302,7 @@ install_headers:
 	$(call QUIET_INSTALL, headers) \
 		$(call do_install,event-parse.h,$(prefix)/include/traceevent,644); \
 		$(call do_install,event-utils.h,$(prefix)/include/traceevent,644); \
+		$(call do_install,trace-seq.h,$(prefix)/include/traceevent,644); \
 		$(call do_install,kbuffer.h,$(prefix)/include/traceevent,644)
 
 install: install_lib
Signature · 1 line
2.17.1