Skip to contentSkip to conversation

Final preparation before adding the KernelShark GUI

PATCH Superseded Yordan Karadzhov 1 participant 5 messages Sep 21, 2018

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Final preparation before adding the KernelShark GUI

From: "Yordan Karadzhov (VMware)" <[email protected]>

Four small patches needed as a final preparation before introducing the first components of the Qt-based KernelShark GUI.

Yordan Karadzhov (VMware) (4):
kernel-shark-qt: Add kshark_get_X_easy() functions.
kernel-shark-qt: Add kshark_convert_nano() function
kernel-shark-qt: Add functions for fast filter clearing.
kernel-shark-qt: Rename the Cmake-generated header file.

 kernel-shark-qt/build/cmake_clean.sh |   2 +-
 kernel-shark-qt/build/deff.h.cmake   |   2 +-
 kernel-shark-qt/src/CMakeLists.txt   |   2 +-
 kernel-shark-qt/src/libkshark.c      | 191 ++++++++++++++++++++++++++-
 kernel-shark-qt/src/libkshark.h      |  18 +++
 5 files changed, 211 insertions(+), 4 deletions(-)
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/4 kernel-shark-qt: Add kshark_get_X_easy() functions.

From: "Yordan Karadzhov (VMware)" <[email protected]>

The kshark_get_X_easy() functions allow for an easy access to the tep_record's fields. Using these functions can be inefficient if you need access to more than one of the fields of the record.

---
 kernel-shark-qt/src/libkshark.c | 152 ++++++++++++++++++++++++++++++++
 kernel-shark-qt/src/libkshark.h |  10 +++
 2 files changed, 162 insertions(+)
kernel-shark-qt/src/libkshark.c +152 -0
index 506511d..9ccb3cc 100644
@@ -888,6 +888,158 @@ static const char *kshark_get_info(struct tep_handle *pe,
 	return seq.buffer;
 }
 
+/**
+ * @brief This function allows for an easy access to the original value of the
+ *	  Process Id as recorded in the tep_record object. The record is read
+ *	  from the file only in the case of an entry being touched by a plugin.
+ *	  Be aware that using the kshark_get_X_easy functions can be
+ *	  inefficient if you need an access to more than one of the data fields
+ *	  of the record.
+ *
+ * @param entry: Input location for the KernelShark entry.
+ *
+ * @returns The original value of the Process Id as recorded in the
+ *	    tep_record object.
+ */
+int kshark_get_pid_easy(struct kshark_entry *entry)
+{
+	int pid;
+
+	if (entry->visible & KS_PLUGIN_UNTOUCHED_MASK) {
+		pid = entry->pid;
+	} else {
+		struct kshark_context *kshark_ctx = NULL;
+		kshark_instance(&kshark_ctx);
+
+		struct tep_record *data = kshark_read_at(kshark_ctx,
+							 entry->offset);
+
+		pid = tep_data_pid(kshark_ctx->pevent, data);
+		free_record(data);
+	}
+
+	return pid;
+}
+
+/**
+ * @brief This function allows for an easy access to the original value of the
+ *	  Task name as recorded in the tep_record object. The record is read
+ *	  from the file only in the case of an entry being touched by a plugin.
+ *	  Be aware that using the kshark_get_X_easy functions can be
+ *	  inefficient if you need an access to more than one of the data fields
+ *	  of the record.
+ *
+ * @param entry: Input location for the KernelShark entry.
+ *
+ * @returns The original name of the task, retrieved from the Process Id
+ *	    recorded in the tep_record object.
+ */
+const char *kshark_get_task_easy(struct kshark_entry *entry)
+{
+	int pid = kshark_get_pid_easy(entry);
+
+	struct kshark_context *kshark_ctx = NULL;
+	kshark_instance(&kshark_ctx);
+
+	return tep_data_comm_from_pid(kshark_ctx->pevent, pid);
+}
+
+/**
+ * @brief This function allows for an easy access to the latency information
+ *	  recorded in the tep_record object. The record is read from the file
+ *	  using the offset field of kshark_entry. Be aware that using the
+ *	  kshark_get_X_easy functions can be inefficient if you need an access
+ *	  to more than one of the data fields of the record.
+ *
+ * @param entry: Input location for the KernelShark entry.
+ *
+ * @returns A string showing the latency information, coded into 5 fields:
+ * 	    interrupts disabled, need rescheduling, hard/soft interrupt,
+ *	    preempt count and lock depth.
+ */
+const char *kshark_get_latency_easy(struct kshark_entry *entry)
+{
+	const char *lat;
+	struct kshark_context *kshark_ctx = NULL;
+	kshark_instance(&kshark_ctx);
+
+	struct tep_record *data = kshark_read_at(kshark_ctx,
+						 entry->offset);
+
+	lat = kshark_get_latency(kshark_ctx->pevent, data);
+	free_record(data);
+
+	return lat;
+}
+
+/**
+ * @brief This function allows for an easy access to the original name of the
+ * 	  trace event as recorded in the tep_record object. The record is read
+ *	  from the file only in the case of an entry being touched by a plugin.
+ *	  Be aware that using the kshark_get_X_easy functions can be
+ *	  inefficient if you need an access to more than one of the data fields
+ *	  of the record.
+ *
+ * @param entry: Input location for the KernelShark entry.
+ *
+ * @returns The mane of the trace event recorded in the tep_record object on
+ * 	    success, otherwise "[UNKNOWN EVENT]".
+ */
+const char *kshark_get_event_name_easy(struct kshark_entry *entry)
+{
+	int event_id;
+	struct event_format *event;
+	struct kshark_context *kshark_ctx = NULL;
+	kshark_instance(&kshark_ctx);
+
+	if (entry->visible & KS_PLUGIN_UNTOUCHED_MASK) {
+		event_id = entry->event_id;
+	} else {
+		struct tep_record *data = kshark_read_at(kshark_ctx,
+							 entry->offset);
+		event_id = tep_data_type(kshark_ctx->pevent, data);
+		free_record(data);
+	}
+
+	event = tep_data_event_from_type(kshark_ctx->pevent, event_id);
+	if (event)
+		return event->name;
+
+	return "[UNKNOWN EVENT]";
+}
+
+/**
+ * @brief This function allows for an easy access to the tep_record's info
+ *	  streang. The record is read from the file using the offset field of
+ *	  kshark_entry. Be aware that using the kshark_get_X_easy functions can
+ *	  be inefficient if you need an access to more than one of the data
+ *	  fields of the record.
+ *
+ * @param entry: Input location for the KernelShark entry.
+ *
+ * @returns A string showing the data output of the trace event.
+ */
+const char *kshark_get_info_easy(struct kshark_entry *entry)
+{
+	struct kshark_context *kshark_ctx = NULL;
+	struct event_format *event;
+	const char *info;
+	int event_id;
+
+	if (!kshark_instance(&kshark_ctx))
+		return NULL;
+
+	struct tep_record *data = kshark_read_at(kshark_ctx,
+						    entry->offset);
+	event_id = tep_data_type(kshark_ctx->pevent, data);
+	event = tep_data_event_from_type(kshark_ctx->pevent, event_id);
+
+	info = kshark_get_info(kshark_ctx->pevent, data, event);
+	free_record(data);
+
+	return info;
+}
+
 /**
  * @brief Dump into a string the content of one entry. The function allocates
  *	  a null terminated string and returns a pointer to this string. The
kernel-shark-qt/src/libkshark.h +10 -0
index e846c85..a1f294a 100644
@@ -148,6 +148,16 @@ void kshark_close(struct kshark_context *kshark_ctx);
 
 void kshark_free(struct kshark_context *kshark_ctx);
 
+int kshark_get_pid_easy(struct kshark_entry *entry);
+
+const char *kshark_get_task_easy(struct kshark_entry *entry);
+
+const char *kshark_get_latency_easy(struct kshark_entry *entry);
+
+const char *kshark_get_event_name_easy(struct kshark_entry *entry);
+
+const char *kshark_get_info_easy(struct kshark_entry *entry);
+
 char* kshark_dump_entry(const struct kshark_entry *entry);
 
 struct tep_record *kshark_read_at(struct kshark_context *kshark_ctx,
Signature · 1 line
2.17.1
#2 lore raw

PATCH 2/4 kernel-shark-qt: Add kshark_convert_nano() function

In reply to Yordan Karadzhov

From: "Yordan Karadzhov (VMware)" <[email protected]>

kshark_convert_nano() is used to convert the original value of the timestamp of the trace records (having nanosecond precision) into two values representing the time in seconds and milliseconds.

---
 kernel-shark-qt/src/libkshark.c | 14 ++++++++++++++
 kernel-shark-qt/src/libkshark.h |  2 ++
 2 files changed, 16 insertions(+)
kernel-shark-qt/src/libkshark.c +14 -0
index 9ccb3cc..40625e5 100644
@@ -1040,6 +1040,20 @@ const char *kshark_get_info_easy(struct kshark_entry *entry)
 	return info;
 }
 
+/**
+ * @brief Convert the timestamp of the trace record (nanosecond precision) into
+ *	  seconds and microseconds.
+ *
+ * @param time: Input location for the timestamp.
+ * @param sec: Output location for value of the seconds.
+ * @param usec: Output location for value of the microseconds.
+ */
+void kshark_convert_nano(uint64_t time, uint64_t *sec, uint64_t *usec)
+{
+	*sec = time / 1000000000ULL;
+	*usec = (time / 1000) % 1000000;
+}
+
 /**
  * @brief Dump into a string the content of one entry. The function allocates
  *	  a null terminated string and returns a pointer to this string. The
kernel-shark-qt/src/libkshark.h +2 -0
index a1f294a..085b79c 100644
@@ -158,6 +158,8 @@ const char *kshark_get_event_name_easy(struct kshark_entry *entry);
 
 const char *kshark_get_info_easy(struct kshark_entry *entry);
 
+void kshark_convert_nano(uint64_t time, uint64_t *sec, uint64_t *usec);
+
 char* kshark_dump_entry(const struct kshark_entry *entry);
 
 struct tep_record *kshark_read_at(struct kshark_context *kshark_ctx,
Signature · 1 line
2.17.1
#3 lore raw

PATCH 3/4 kernel-shark-qt: Add functions for fast clearing of the filters.

In reply to Yordan Karadzhov

From: "Yordan Karadzhov (VMware)" <[email protected]>

The first added function checks if any Id filter is set.

The second added function is used to reset the "visible" field of each entry to the default value of "0xFF" (visible everywhere).

---
 kernel-shark-qt/src/libkshark.c | 28 +++++++++++++++++++++++++++-
 kernel-shark-qt/src/libkshark.h |  6 ++++++
 2 files changed, 33 insertions(+), 1 deletion(-)
kernel-shark-qt/src/libkshark.c +27 -1
index 40625e5..271e556 100644
@@ -427,7 +427,14 @@ static bool filter_is_set(struct tracecmd_filter_id *filter)
 	return filter && filter->count;
 }
 
-static bool kshark_filter_is_set(struct kshark_context *kshark_ctx)
+/**
+ * @brief Check if an Id filter is set.
+ *
+ * @param kshark_ctx: Input location for the session context pointer.
+ *
+ * @returns True if at least one Id filter is set, otherwise False.
+ */
+bool kshark_filter_is_set(struct kshark_context *kshark_ctx)
 {
 	return filter_is_set(kshark_ctx->show_task_filter) ||
 	       filter_is_set(kshark_ctx->hide_task_filter) ||
@@ -499,6 +506,25 @@ void kshark_filter_entries(struct kshark_context *kshark_ctx,
 	}
 }
 
+/**
+ * @brief This function loops over the array of entries specified by "data"
+ *	  and "n_entries" and resets the "visible" fields of each entry to
+ *	  the default value of "0xFF" (visible everywhere).
+ *
+ * @param kshark_ctx: Input location for the session context pointer.
+ * @param data: Input location for the trace data to be filtered.
+ * @param n_entries: The size of the inputted data.
+ */
+void kshark_clear_all_filters(struct kshark_context *kshark_ctx,
+			      struct kshark_entry **data,
+			      size_t n_entries)
+{
+	int i;
+
+	for (i = 0; i < n_entries; ++i)
+		data[i]->visible = 0xFF;
+}
+
 static void kshark_set_entry_values(struct kshark_context *kshark_ctx,
 				    struct tep_record *record,
 				    struct kshark_entry *entry)
kernel-shark-qt/src/libkshark.h +6 -0
index 085b79c..16730b9 100644
@@ -224,10 +224,16 @@ void kshark_filter_add_id(struct kshark_context *kshark_ctx,
 
 void kshark_filter_clear(struct kshark_context *kshark_ctx, int filter_id);
 
+bool kshark_filter_is_set(struct kshark_context *kshark_ctx);
+
 void kshark_filter_entries(struct kshark_context *kshark_ctx,
 			   struct kshark_entry **data,
 			   size_t n_entries);
 
+void kshark_clear_all_filters(struct kshark_context *kshark_ctx,
+			      struct kshark_entry **data,
+			      size_t n_entries);
+
 /** Search failed identifiers. */
 enum kshark_search_failed {
 	/** All entries have timestamps greater timestamps. */
Signature · 1 line
2.17.1
#4 lore raw

PATCH 4/4 kernel-shark-qt: Rename the Cmake-generated header file.

In reply to Yordan Karadzhov

From: "Yordan Karadzhov (VMware)" <[email protected]>

The name of the Cmake-generated header file is changed for "KsDeff.h" to "KsCmakeDef.hpp" in order to make it more explanatory. With the following patches the file will start contain C++ declarations.

---
 kernel-shark-qt/build/cmake_clean.sh | 2 +-
 kernel-shark-qt/build/deff.h.cmake   | 2 +-
 kernel-shark-qt/src/CMakeLists.txt   | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
kernel-shark-qt/build/cmake_clean.sh +1 -1
index acdbb43..4f984db 100755
@@ -6,6 +6,6 @@ rm -rf CMakeFiles/
 rm -rf src/
 rm -rf examples/
 rm -f ../lib/*
-rm -f ../src/KsDeff.h
+rm -f ../src/KsCmakeDef.hpp
 rm -f CMakeDoxyfile.in
 rm -f CMakeDoxygenDefaults.cmake
kernel-shark-qt/build/deff.h.cmake +1 -1
index 111fcdd..44ea08b 100644
@@ -1,5 +1,5 @@
  /**
- *  \file    KsDeff.h
+ *  \file    KsCmakeDef.hpp
  *  \brief   This File is generated by CMAKE
  */
 
kernel-shark-qt/src/CMakeLists.txt +1 -1
index 3365413..305cea7 100644
@@ -31,4 +31,4 @@ endif (OPENGL_FOUND AND GLUT_FOUND)
 add_subdirectory(plugins)
 
 configure_file( ${KS_DIR}/build/deff.h.cmake
-                ${KS_DIR}/src/KsDeff.h)
+                ${KS_DIR}/src/KsCmakeDef.hpp)
Signature · 1 line
2.17.1