Skip to contentSkip to conversation

Remove redundant trace-cmd plugin handling logic

PATCH Superseded Tzvetomir Stoyanov (VMware) 1 participant 3 messages Oct 4, 2019 Kbuild

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v5 cover Remove redundant trace-cmd plugin handling logic

Currently there are no trace-cmd related plugins, all of them are designed to be used with libtraceeevnt. As both libtraceevent and trace-cmd have logic for managing plugins, the one in trace-cmd is redundant. Those redundant code is removed and replaced with calls to libtraceeevnt plugin APIs. When trace-cmd has to load any plugins, it uses libtraceeevnt to do the job.

All existing plugins are moved from plugins/ to lib/traceevent/plugins directory, as all of them are designed to be used with the traceevent library.

An initial infrastructure for trace-cmd specific plugins is added - new lib/trace-cmd/plugins directory and an initial set of APIs for working with trace-cmd plugins.

[
changes:
- Removed accepted patches from the patch set.
- Moved logic which loads traceevent development plugins from libtraceevent to trace-cmd application.
]

Tzvetomir Stoyanov (VMware) (2):
trace-cmd: Load libtraceevent plugins from build folder, if exists.
trace-cmd: Add initial infrastructure for trace-cmd specific plugins.

 .gitignore                       |   1 +
 Makefile                         |  40 +++-
 include/trace-cmd/trace-cmd.h    |  42 +++++
 include/traceevent/event-parse.h |   3 +
 lib/trace-cmd/Makefile           |   1 +
 lib/trace-cmd/plugins/Makefile   |  58 ++++++
 lib/trace-cmd/trace-input.c      |   7 +-
 lib/trace-cmd/trace-plugin.c     | 313 +++++++++++++++++++++++++++++++
 lib/trace-cmd/trace-util.c       |  46 +++++
 lib/traceevent/event-plugin.c    |  38 ++++
 tracecmd/trace-check-events.c    |   7 +-
 tracecmd/trace-list.c            |  14 +-
 12 files changed, 538 insertions(+), 32 deletions(-)
 create mode 100644 lib/trace-cmd/plugins/Makefile
 create mode 100644 lib/trace-cmd/trace-plugin.c
Signature · 1 line
2.21.0
#1 lore raw

PATCH v5 1/2 trace-cmd: Load libtraceevent plugins from build folder, if exists.

When a development version of trace-cmd is built and run on the machine, by default it loads only installed plugins, from system directories. Thus, the development plugins will not be loaded. To simplify the development process, a new logic is added:
At plugins load time, check the location of trace-cmd application and look for "plugins" directory around it. If found, load plugins from it. Those plugins will be loaded last, so in case of duplication the "development" plugins win.
A two new APIs are introduced to libtraceevent, in order to accomplish this logic:
tep_load_plugins_dir() - loads tep plugins from a specific directory. tep_plugins_append() - Append two plugin lists.

---
 include/trace-cmd/trace-cmd.h    |  2 ++
 include/traceevent/event-parse.h |  3 +++
 lib/trace-cmd/trace-input.c      |  7 +----
 lib/trace-cmd/trace-util.c       | 46 ++++++++++++++++++++++++++++++++
 lib/traceevent/event-plugin.c    | 38 ++++++++++++++++++++++++++
 tracecmd/trace-check-events.c    |  7 +----
 tracecmd/trace-list.c            | 14 ++--------
 7 files changed, 93 insertions(+), 24 deletions(-)
include/trace-cmd/trace-cmd.h +2 -0
index 4090eba..f692783 100644
@@ -24,6 +24,8 @@ void tracecmd_parse_ftrace_printk(struct tep_handle *pevent, char *file, unsigne
 extern int tracecmd_disable_sys_plugins;
 extern int tracecmd_disable_plugins;
 
+struct tep_plugin_list *trace_load_tep_plugins(struct tep_handle *tep);
+
 char **tracecmd_event_systems(const char *tracing_dir);
 char **tracecmd_system_events(const char *tracing_dir, const char *system);
 struct tep_handle *tracecmd_local_events(const char *tracing_dir);
include/traceevent/event-parse.h +3 -0
index 5dff952..10320d5 100644
@@ -380,6 +380,9 @@ struct tep_plugin_list;
 #define INVALID_PLUGIN_LIST_OPTION	((char **)((unsigned long)-1))
 
 struct tep_plugin_list *tep_load_plugins(struct tep_handle *tep);
+struct tep_plugin_list *tep_load_plugins_dir(struct tep_handle *tep, char *path);
+void tep_plugins_append(struct tep_plugin_list *list1,
+			struct tep_plugin_list *list2);
 void tep_unload_plugins(struct tep_plugin_list *plugin_list,
 			struct tep_handle *tep);
 void tep_load_plugins_hook(struct tep_handle *tep, const char *suffix,
lib/trace-cmd/trace-input.c +1 -6
index 6102eb3..bdeb2bc 100644
@@ -2886,15 +2886,10 @@ struct tracecmd_input *tracecmd_alloc_fd(int fd)
 	if (!handle->pevent)
 		goto failed_read;
 
-	if (tracecmd_disable_plugins)
-		tep_set_flag(handle->pevent, TEP_DISABLE_PLUGINS);
-	if (tracecmd_disable_sys_plugins)
-		tep_set_flag(handle->pevent, TEP_DISABLE_SYS_PLUGINS);
-
 	/* register default ftrace functions first */
 	tracecmd_ftrace_overrides(handle, &handle->finfo);
 
-	handle->plugin_list = tep_load_plugins(handle->pevent);
+	handle->plugin_list = trace_load_tep_plugins(handle->pevent);
 
 	tep_set_file_bigendian(handle->pevent, buf[0]);
 	tep_set_local_bigendian(handle->pevent, tracecmd_host_bigendian());
lib/trace-cmd/trace-util.c +46 -0

52 lines not on this page · raw message

lib/traceevent/event-plugin.c +38 -0
index 6ea4ac0..ce9d53c 100644
@@ -599,6 +599,44 @@ tep_load_plugins(struct tep_handle *tep)
 	return list;
 }
 
+/**
+ * tep_load_plugins_dir - load traceevent plugins from a directory
+ * @tep: Trace event handler.
+ * @path: Path to a directory. All files with extension .so in that
+ *	  directory will be loaded as plugins.
+ *
+ * Returns a list of loaded plugins
+ */
+struct tep_plugin_list*
+tep_load_plugins_dir(struct tep_handle *tep, char *path)
+{
+	struct tep_plugin_list *list = NULL;
+
+	if (tep && tep->flags & TEP_DISABLE_PLUGINS)
+		return NULL;
+
+	load_plugins_dir(tep, ".so", path, load_plugin, &list);
+	return list;
+}
+
+/**
+ * tep_plugins_append - Concatenate two plugin lists.
+ * @list1: The first plugin list.
+ * @list2: The second plugin list.
+ *
+ * The second plugin list (list2) is appended to the first one (list1).
+ */
+void tep_plugins_append(struct tep_plugin_list *list1,
+			struct tep_plugin_list *list2)
+{
+	struct tep_plugin_list *list = list1;
+
+	while (list && list->next)
+		list = list->next;
+	if (list)
+		list->next = list2;
+}
+
 void
 tep_unload_plugins(struct tep_plugin_list *plugin_list, struct tep_handle *tep)
 {
tracecmd/trace-check-events.c +1 -6
index b09fcd0..eb840c6 100644
@@ -43,12 +43,7 @@ void trace_check_events(int argc, char **argv)
 	if (!pevent)
 		exit(EINVAL);
 
-	if (tracecmd_disable_plugins)
-		tep_set_flag(pevent, TEP_DISABLE_PLUGINS);
-	if (tracecmd_disable_sys_plugins)
-		tep_set_flag(pevent, TEP_DISABLE_SYS_PLUGINS);
-
-	list = tep_load_plugins(pevent);
+	list = trace_load_tep_plugins(pevent);
 	ret = tracecmd_fill_local_events(tracing, pevent, &parsing_failures);
 	if (ret || parsing_failures)
 		ret = EINVAL;
tracecmd/trace-list.c +2 -12
index 65099a5..840eeac 100644
@@ -317,14 +317,9 @@ static void show_plugin_options(void)
 	if (!pevent)
 		die("Can not allocate pevent\n");
 
-	if (tracecmd_disable_plugins)
-		tep_set_flag(pevent, TEP_DISABLE_PLUGINS);
-	if (tracecmd_disable_sys_plugins)
-		tep_set_flag(pevent, TEP_DISABLE_SYS_PLUGINS);
-
 	trace_seq_init(&s);
 
-	list = tep_load_plugins(pevent);
+	list = trace_load_tep_plugins(pevent);
 	tep_plugin_print_options(&s);
 	trace_seq_do_printf(&s);
 	tep_unload_plugins(list, pevent);
@@ -348,14 +343,9 @@ static void show_plugins(void)
 	if (!pevent)
 		die("Can not allocate pevent\n");
 
-	if (tracecmd_disable_plugins)
-		tep_set_flag(pevent, TEP_DISABLE_PLUGINS);
-	if (tracecmd_disable_sys_plugins)
-		tep_set_flag(pevent, TEP_DISABLE_SYS_PLUGINS);
-
 	trace_seq_init(&s);
 
-	list = tep_load_plugins(pevent);
+	list = trace_load_tep_plugins(pevent);
 	tep_print_plugins(&s, "  ", "\n", list);
 
 	trace_seq_do_printf(&s);
Signature · 1 line
2.21.0
#2 lore raw

PATCH v5 2/2 trace-cmd: Add initial infrastructure for trace-cmd specific plugins.

In reply to Tzvetomir Stoyanov (VMware)

Create a new directory lib/trace-cmd/plugins, where the libtracecmd plugins will be placed. Plugins compilation is integrated in
the trace-cmd build process. New plugins are installed in $(HOME)/.local/lib/trace-cmd/plugins or $(libdir)/trace-cmd/plugins directories. Current python_plugin.so is part of libtraceevent plugins, so the python plugins path is changed from
$(HOME)/.trace-cmd/python to $(HOME)/.local/lib/traceevent/python and
$(libdir)/trace-cmd/python to $(libdir)/traceevent/python

Added an initial set of APIs for working with trace-cmd plugins.

---
 .gitignore                     |   1 +
 Makefile                       |  40 ++++-
 include/trace-cmd/trace-cmd.h  |  40 +++++
 lib/trace-cmd/Makefile         |   1 +
 lib/trace-cmd/plugins/Makefile |  58 ++++++
 lib/trace-cmd/trace-plugin.c   | 313 +++++++++++++++++++++++++++++++++
 6 files changed, 445 insertions(+), 8 deletions(-)
 create mode 100644 lib/trace-cmd/plugins/Makefile
 create mode 100644 lib/trace-cmd/trace-plugin.c
.gitignore +1 -0
index 20bb5a3..6759e51 100644
@@ -20,3 +20,4 @@ TAGS
 cscope*
 traceevent_plugin_dir
 trace_python_dir
+tracecmd_plugin_dir
Makefile +32 -8
index bbdf15e..ab76f1f 100644
@@ -57,14 +57,17 @@ export DESTDIR DESTDIR_SQ
 
 ifeq ($(prefix),$(HOME))
 plugin_traceevent_dir = $(HOME)/.local/lib/traceevent/plugins
-python_dir = $(HOME)/.trace-cmd/python
+plugin_tracecmd_dir = $(libdir)/trace-cmd/plugins
+python_dir ?= $(libdir)/traceevent/python
 var_dir = $(HOME)/.trace-cmd/
 else
 plugin_traceevent_dir = $(libdir)/traceevent/plugins
 python_dir ?= $(libdir)/trace-cmd/python
 PLUGIN_DIR_TRACEEVENT = -DPLUGIN_TRACEEVENT_DIR="$(plugin_traceevent_dir)"
+PLUGIN_DIR_TRACECMD = -DPLUGIN_TRACECMD_DIR="$(plugin_tracecmd_dir)"
 PYTHON_DIR = -DPYTHON_DIR="$(python_dir)"
 PLUGIN_DIR_TRACEEVENT_SQ = '$(subst ','\'',$(PLUGIN_DIR_TRACEEVENT))'
+PLUGIN_DIR_TRACECMD_SQ = '$(subst ','\'',$(PLUGIN_DIR_TRACECMD))'
 PYTHON_DIR_SQ = '$(subst ','\'',$(PYTHON_DIR))'
 var_dir = /var
 endif
@@ -73,6 +76,7 @@ endif
 bindir_SQ = $(subst ','\'',$(bindir))
 bindir_relative_SQ = $(subst ','\'',$(bindir_relative))
 plugin_traceevent_dir_SQ = $(subst ','\'',$(plugin_traceevent_dir))
+plugin_tracecmd_dir_SQ = $(subst ','\'',$(plugin_tracecmd_dir))
 python_dir_SQ = $(subst ','\'',$(python_dir))
 
 VAR_DIR = -DVAR_DIR="$(var_dir)"
@@ -86,9 +90,11 @@ HELP_DIR_SQ = '$(subst ','\'',$(HELP_DIR))'
 BASH_COMPLETE_DIR ?= /etc/bash_completion.d
 
 export PLUGIN_DIR_TRACEEVENT
+export PLUGIN_DIR_TRACECMD
 export PYTHON_DIR
 export PYTHON_DIR_SQ
 export plugin_traceevent_dir_SQ
+export plugin_tracecmd_dir_SQ
 export python_dir_SQ
 export var_dir
 
@@ -239,7 +245,8 @@ LIBS += -laudit
 endif
 
 # Append required CFLAGS
-override CFLAGS += $(INCLUDES) $(PLUGIN_DIR_TRACEEVENT_SQ) $(VAR_DIR)
+override CFLAGS += $(INCLUDES) $(VAR_DIR)
+override CFLAGS += $(PLUGIN_DIR_TRACEEVENT_SQ) $(PLUGIN_DIR_TRACECMD_SQ)
 override CFLAGS += $(udis86-flags) $(blk-flags)
 override LDFLAGS += $(udis86-ldflags)
 
@@ -268,13 +275,16 @@ gui: force $(CMD_TARGETS) $(kshark-dir)/build/Makefile
 	@echo "gui build complete"
 	@echo "  kernelshark located at $(kshark-dir)/bin"
 
-trace-cmd: force $(LIBTRACEEVENT_STATIC) $(LIBTRACECMD_STATIC)
+trace-cmd: force $(LIBTRACEEVENT_STATIC) $(LIBTRACECMD_STATIC) \
+	force $(obj)/lib/trace-cmd/plugins/tracecmd_plugin_dir
 	$(Q)$(MAKE) -C $(src)/tracecmd $(obj)/tracecmd/$@
 
-$(LIBTRACEEVENT_SHARED): force $(obj)/lib/traceevent/plugins/traceevent_plugin_dir
+$(LIBTRACEEVENT_SHARED): force $(obj)/lib/traceevent/plugins/trace_python_dir \
+			 $(obj)/lib/traceevent/plugins/traceevent_plugin_dir
 	$(Q)$(MAKE) -C $(src)/lib/traceevent $@
 
-$(LIBTRACEEVENT_STATIC): force $(obj)/lib/traceevent/plugins/traceevent_plugin_dir
+$(LIBTRACEEVENT_STATIC): force $(obj)/lib/traceevent/plugins/trace_python_dir \
+			 $(obj)/lib/traceevent/plugins/traceevent_plugin_dir
 	$(Q)$(MAKE) -C $(src)/lib/traceevent $@
 
 $(LIBTRACECMD_STATIC): force
@@ -290,12 +300,21 @@ libtracecmd.so: $(LIBTRACECMD_SHARED)
 
 libs: $(LIBTRACECMD_SHARED) $(LIBTRACEEVENT_SHARED)
 
-plugins: force $(obj)/lib/traceevent/plugins/traceevent_plugin_dir $(obj)/lib/traceevent/plugins/trace_python_dir
+plugins_traceevent: force $(obj)/lib/traceevent/plugins/traceevent_plugin_dir \
+		   $(obj)/lib/traceevent/plugins/trace_python_dir
 	$(Q)$(MAKE) -C $(src)/lib/traceevent/plugins
 
+plugins_tracecmd: force $(obj)/lib/trace-cmd/plugins/tracecmd_plugin_dir
+	$(Q)$(MAKE) -C $(src)/lib/trace-cmd/plugins
+
+plugins: plugins_traceevent plugins_tracecmd
+
 $(obj)/lib/traceevent/plugins/traceevent_plugin_dir: force
 	$(Q)$(MAKE) -C $(src)/lib/traceevent/plugins $@
 
+$(obj)/lib/trace-cmd/plugins/tracecmd_plugin_dir: force
+	$(Q)$(MAKE) -C $(src)/lib/trace-cmd/plugins $@
+
 $(obj)/lib/traceevent/plugins/trace_python_dir: force
 	$(Q)$(MAKE) -C $(src)/lib/traceevent/plugins $@
 
@@ -322,8 +341,12 @@ cscope: force
 	$(RM) cscope*
 	$(call find_tag_files) | cscope -b -q
 
-install_plugins: force
-	$(Q)$(MAKE) -C $(src)/lib/traceevent/plugins $@
+install_plugins_traceevent: force
+	$(Q)$(MAKE) -C $(src)/lib/traceevent/plugins install_plugins
+install_plugins_tracecmd: force
+	$(Q)$(MAKE) -C $(src)/lib/trace-cmd/plugins install_plugins
+
+install_plugins: install_plugins_traceevent install_plugins_tracecmd
 
 install_python: force
 	$(Q)$(MAKE) -C $(src)/python $@
@@ -371,6 +394,7 @@ clean:
 	$(MAKE) -C $(src)/lib/traceevent clean
 	$(MAKE) -C $(src)/lib/trace-cmd clean
 	$(MAKE) -C $(src)/lib/traceevent/plugins clean
+	$(MAKE) -C $(src)/lib/trace-cmd/plugins clean
 	$(MAKE) -C $(src)/python clean
 	$(MAKE) -C $(src)/tracecmd clean
 	if [ -f $(kshark-dir)/build/Makefile ]; then $(MAKE) -C $(kshark-dir)/build clean; fi
include/trace-cmd/trace-cmd.h +40 -0
index f692783..c914067 100644
@@ -54,6 +54,46 @@ struct tracecmd_output;
 struct tracecmd_recorder;
 struct hook_list;
 
+/* --- tracecmd plugins --- */
+
+extern int tracecmd_disable_sys_plugins;
+extern int tracecmd_disable_plugins;
+
+enum tracecmd_context {
+	TRACECMD_INPUT,
+	TRACECMD_OUTPUT,
+};
+
+enum tracecmd_plugin_flag {
+	TRACECMD_DISABLE_SYS_PLUGINS	= 1,
+	TRACECMD_DISABLE_PLUGINS	= 1 << 1,
+};
+
+struct trace_plugin_context;
+
+struct trace_plugin_context *
+tracecmd_plugin_context_create(enum tracecmd_context context, void *data);
+
+void tracecmd_plugin_set_flag(struct trace_plugin_context *context,
+			      enum tracecmd_plugin_flag flag);
+
+#define TRACECMD_PLUGIN_LOADER tracecmd_plugin_loader
+#define TRACECMD_PLUGIN_UNLOADER tracecmd_plugin_unloader
+#define TRACECMD_PLUGIN_ALIAS tracecmd_plugin_alias
+#define _MAKE_STR(x)	#x
+#define MAKE_STR(x)	_MAKE_STR(x)
+#define TRACECMD_PLUGIN_LOADER_NAME MAKE_STR(TRACECMD_PLUGIN_LOADER)
+#define TRACECMD_PLUGIN_UNLOADER_NAME MAKE_STR(TRACECMD_PLUGIN_UNLOADER)
+#define TRACECMD_PLUGIN_ALIAS_NAME MAKE_STR(TRACECMD_PLUGIN_ALIAS)
+
+typedef int (*tracecmd_plugin_load_func)(struct trace_plugin_context *trace);
+typedef int (*tracecmd_plugin_unload_func)(struct trace_plugin_context *trace);
+
+struct tracecmd_input *
+tracecmd_plugin_context_input(struct trace_plugin_context *trace_context);
+struct tracecmd_output *
+tracecmd_plugin_context_output(struct trace_plugin_context *trace_context);
+
 void tracecmd_set_quiet(struct tracecmd_output *handle, bool set_quiet);
 bool tracecmd_get_quiet(struct tracecmd_output *handle);
 
lib/trace-cmd/Makefile +1 -0
index 3b4b5aa..6f3e6b1 100644
@@ -15,6 +15,7 @@ OBJS += trace-recorder.o
 OBJS += trace-util.o
 OBJS += trace-filter-hash.o
 OBJS += trace-msg.o
+OBJS += trace-plugin.o
 
 # Additional util objects
 OBJS += trace-blk-hack.o
lib/trace-cmd/plugins/Makefile new file +58 -0

58 lines not on this page · raw message

lib/trace-cmd/trace-plugin.c new file +313 -0

313 lines not on this page · raw message

Signature · 1 line
2.21.0