Skip to contentSkip to conversation

kernel-shark: fix typo in sched_events.h

PATCH In review Hongzhan Chen 2 participants 8 messages Jan 10, 2022 – Jan 11, 2022

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/3 kernel-shark: fix typo in sched_events.h

fix typo in sched plugin and make it easier to read.

src/plugins/sched_events.h +2 -2
index 2c540fd..a2ba4b4 100644
@@ -9,8 +9,8 @@
  *  @brief   Plugin for Sched events.
  */
 
-#ifndef _KS_PLUGIN_SHED_H
-#define _KS_PLUGIN_SHED_H
+#ifndef _KS_PLUGIN_SCHED_H
+#define _KS_PLUGIN_SCHED_H
 
 // KernelShark
 #include "libkshark.h"
Signature · 1 line
2.17.1
#1 lore raw

PATCH v4 2/3 kernel-shark: Move common APIs and definitions out to avoid duplication

To avoid code duplication, move some common APIs and definitions out from plugin SchedEvent to share with other plugins.

src/KsPlugins.cpp +21 -0
index ad9f478..a288018 100644
@@ -414,3 +414,24 @@ void eventFieldIntervalPlot(KsCppArgV *argvCpp,
 			  << exc.what() << std::endl;
 	}
 }
+
+/**
+ * @brief Distance between the click and the shape. Used to decide if
+ *	  the double click action must be executed.
+ *
+ * @param x: X coordinate of the click.
+ * @param y: Y coordinate of the click.
+ *
+ * @returns If the click is inside the box, the distance is zero.
+ *	    Otherwise infinity.
+ */
+double LatencyBox::distance(int x, int y) const
+{
+	if (x < pointX(0) || x > pointX(2))
+		return std::numeric_limits<double>::max();
+
+	if (y < pointY(0) || y > pointY(1))
+		return std::numeric_limits<double>::max();
+
+	return 0;
+}
src/KsPlugins.hpp +54 -0

64 lines not on this page · raw message

src/plugins/SchedEvents.cpp +10 -61

112 lines not on this page · raw message

src/plugins/common_sched.h new file +53 -0

53 lines not on this page · raw message

src/plugins/sched_events.c +0 -30
index 198ed49..3bb9bc2 100644
@@ -22,36 +22,6 @@
 
 /** Plugin context instance. */
 
-//! @cond Doxygen_Suppress
-
-typedef unsigned long long tep_num_field_t;
-
-#define PREV_STATE_SHIFT	((int) ((sizeof(ks_num_field_t) - 1) * 8))
-
-#define PREV_STATE_MASK		(((ks_num_field_t) 1 << 8) - 1)
-
-#define PID_MASK		(((ks_num_field_t) 1 << PREV_STATE_SHIFT) - 1)
-
-//! @endcond
-
-static void plugin_sched_set_pid(ks_num_field_t *field,
-				 tep_num_field_t pid)
-{
-	*field &= ~PID_MASK;
-	*field = pid & PID_MASK;
-}
-
-/**
- * @brief Retrieve the PID value from the data field stored in the
- *	  kshark_data_container object.
- *
- * @param field: Input location for the data field.
- */
-__hidden int plugin_sched_get_pid(ks_num_field_t field)
-{
-	return field & PID_MASK;
-}
-
 /* Use the most significant byte to store the value of "prev_state". */
 static void plugin_sched_set_prev_state(ks_num_field_t *field,
 					tep_num_field_t prev_state)
src/plugins/sched_events.h +1 -4
index a2ba4b4..1032075 100644
@@ -15,6 +15,7 @@
 // KernelShark
 #include "libkshark.h"
 #include "libkshark-plugin.h"
+#include "plugins/common_sched.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -55,10 +56,6 @@ struct plugin_sched_context {
 
 KS_DECLARE_PLUGIN_CONTEXT_METHODS(struct plugin_sched_context)
 
-/** The type of the data field stored in the kshark_data_container object. */
-typedef int64_t ks_num_field_t;
-
-int plugin_sched_get_pid(ks_num_field_t field);
 
 int plugin_sched_get_prev_state(ks_num_field_t field);
 
Signature · 1 line
2.17.1
#2 lore raw

Re: [PATCH V4 2/3] kernel-shark: Move common APIs and definitions out to avoid duplication

Hi Hongzhan,

This patch breaks the build on my machine.
More comments below.

src/KsPlugins.cpp

Quoted 9 lines · Hongzhan Chen

To avoid code duplication, move some common APIs and definitions out from plugin SchedEvent to share with other plugins.

src/KsPlugins.cpp +0 -0
index ad9f478..a288018 100644

In this file we have a missing include. We need
#include <limits>

Quoted 55 lines
src/KsPlugins.cpp +21 -0
@@ -414,3 +414,24 @@ void eventFieldIntervalPlot(KsCppArgV *argvCpp,
  			  << exc.what() << std::endl;
  	}
  }
+
+/**
+ * @brief Distance between the click and the shape. Used to decide if
+ *	  the double click action must be executed.
+ *
+ * @param x: X coordinate of the click.
+ * @param y: Y coordinate of the click.
+ *
+ * @returns If the click is inside the box, the distance is zero.
+ *	    Otherwise infinity.
+ */
+double LatencyBox::distance(int x, int y) const
+{
+	if (x < pointX(0) || x > pointX(2))
+		return std::numeric_limits<double>::max();
+
+	if (y < pointY(0) || y > pointY(1))
+		return std::numeric_limits<double>::max();
+
+	return 0;
+}
src/KsPlugins.hpp +15 -0
index d41d094..5288f57 100644
@@ -13,6 +13,7 @@
  #define _KS_PLUGINS_H
 
  // C++
+#include <vector>
  #include <functional>
 
  // KernelShark
@@ -101,4 +102,57 @@ void eventFieldIntervalPlot(KsCppArgV *argvCpp,
  			    KsPlot::Color col,
  			    float size);
 
+/**
+ * This class represents the graphical element visualizing the latency between
+ * two events such as sched_waking and sched_switch events for common Linux
+ * kernel or cobalt_switch_contexts for Xenomai.
+ */
+class LatencyBox : public KsPlot::Rectangle
+{
+	/** On double click do. */
+	void _doubleClick() const override {}
+
+public:
+	/** The trace record data that corresponds to this LatencyBox. */
+	std::vector<kshark_data_field_int64 *>	_data;
+

src/KsPlugins.hpp void eventFieldIntervalPlot(KsCppArgV *argvCpp, · line 128

Quoted 10 lines
src/KsPlugins.hpp +10 -0
+	/**
+	 * @brief Distance between the click and the shape. Used to decide if
+	 *	  the double click action must be executed.
+	 *
+	 * @param x: X coordinate of the click.
+	 * @param y: Y coordinate of the click.
+	 *
+	 * @returns If the click is inside the box, the distance is zero.
+	 *	    Otherwise infinity.
+	 */

The documentation of the function must be provided above the implementation (in KsPlugins.cpp). No need to have a second copy here.

src/KsPlugins.hpp void eventFieldIntervalPlot(KsCppArgV *argvCpp, · line 136

Quoted 8 lines
src/KsPlugins.hpp +8 -0
+	double distance(int x, int y) const override;
+};
+
+template<class T> KsPlot::PlotObject *
+makeLatencyBox(std::vector<const KsPlot::Graph *> graph,
+			     std::vector<int> bins,
+			     std::vector<kshark_data_field_int64 *> data,
+			     KsPlot::Color col, float size)

This function needs documentation. Also please align the indentation of the parameters.

Quoted 157 lines
src/KsPlugins.hpp +21 -0
+{
+	LatencyBox *rec = new T;
+	rec->_data = data;
+
+	KsPlot::Point p0 = graph[0]->bin(bins[0])._base;
+	KsPlot::Point p1 = graph[0]->bin(bins[1])._base;
+	int height = graph[0]->height() * .3;
+
+	rec->setFill(false);
+	rec->setPoint(0, p0.x() - 1, p0.y() - height);
+	rec->setPoint(1, p0.x() - 1, p0.y() - 1);
+
+	rec->setPoint(3, p1.x() - 1, p1.y() - height);
+	rec->setPoint(2, p1.x() - 1, p1.y() - 1);
+
+	rec->_size = size;
+	rec->_color = col;
+
+	return rec;
+}
+
  #endif
src/plugins/SchedEvents.cpp +10 -61
index b73e45f..9119998 100644
@@ -11,9 +11,6 @@
   *	     preempted by another task.
   */
 
-// C++
-#include <vector>
-
  // KernelShark
  #include "libkshark.h"
  #include "libkshark-plugin.h"
@@ -24,7 +21,7 @@
 
  using namespace KsPlot;
 
-static KsMainWindow *ks_ptr;
+static KsMainWindow *ks4sched_ptr;
 
  /**
   * @brief Provide the plugin with a pointer to the KsMainWindow object (the GUI
@@ -32,72 +29,24 @@ static KsMainWindow *ks_ptr;
   */
  __hidden void *plugin_set_gui_ptr(void *gui_ptr)
  {
-	ks_ptr = static_cast<KsMainWindow *>(gui_ptr);
+	ks4sched_ptr = static_cast<KsMainWindow *>(gui_ptr);
  	return nullptr;
  }
 
  /**
- * This class represents the graphical element visualizing the latency between
- *  sched_waking and sched_switch events.
+ * This child class represents the graphical element visualizing the latency
+ * between sched_waking and sched_switch events. It is defined to re-implement
+ * the handler for double-click.
   */
-class LatencyBox : public Rectangle
+class SchedLatencyBox : public LatencyBox
  {
  	/** On double click do. */
  	void _doubleClick() const override
  	{
-		ks_ptr->markEntry(_data[1]->entry, DualMarkerState::B);
-		ks_ptr->markEntry(_data[0]->entry, DualMarkerState::A);
+		ks4sched_ptr->markEntry(_data[1]->entry, DualMarkerState::B);
+		ks4sched_ptr->markEntry(_data[0]->entry, DualMarkerState::A);
  	}
 
-public:
-	/** The trace record data that corresponds to this LatencyBox. */
-	std::vector<kshark_data_field_int64 *>	_data;
-
-	/**
-	 * @brief Distance between the click and the shape. Used to decide if
-	 *	  the double click action must be executed.
-	 *
-	 * @param x: X coordinate of the click.
-	 * @param y: Y coordinate of the click.
-	 *
-	 * @returns If the click is inside the box, the distance is zero.
-	 *	    Otherwise infinity.
-	 */
-	double distance(int x, int y) const override
-	{
-		if (x < pointX(0) || x > pointX(2))
-			return std::numeric_limits<double>::max();
-
-		if (y < pointY(0) || y > pointY(1))
-			return std::numeric_limits<double>::max();
-
-		return 0;
-	}
-};
-
-static PlotObject *makeShape(std::vector<const Graph *> graph,
-			     std::vector<int> bins,
-			     std::vector<kshark_data_field_int64 *> data,
-			     Color col, float size)
-{
-	LatencyBox *rec = new LatencyBox;
-	rec->_data = data;
-
-	Point p0 = graph[0]->bin(bins[0])._base;
-	Point p1 = graph[0]->bin(bins[1])._base;
-	int height = graph[0]->height() * .3;
-
-	rec->setFill(false);
-	rec->setPoint(0, p0.x() - 1, p0.y() - height);
-	rec->setPoint(1, p0.x() - 1, p0.y() - 1);
-
-	rec->setPoint(3, p1.x() - 1, p1.y() - height);
-	rec->setPoint(2, p1.x() - 1, p1.y() - 1);
-
-	rec->_size = size;
-	rec->_color = col;
-
-	return rec;
  };
 
  /*
@@ -191,14 +140,14 @@ __hidden void plugin_draw(kshark_cpp_argv *argv_c,
  	eventFieldIntervalPlot(argvCpp,
  			       plugin_ctx->sw_data, checkFieldSW,
  			       plugin_ctx->ss_data, checkEntryPid,
-			       makeShape,
+			       makeLatencyBox<SchedLatencyBox>,
  			       {0, 255, 0}, // Green
  			       -1);         // Default size
 
  	eventFieldIntervalPlot(argvCpp,
  			       plugin_ctx->ss_data, checkFieldSS,
  			       plugin_ctx->ss_data, checkEntryPid,
-			       makeShape,
+			       makeLatencyBox<SchedLatencyBox>,
  			       {255, 0, 0}, // Red
  			       -1);         // Default size
  }
src/plugins/common_sched.h new file +9 -0
new file mode 100644
index 0000000..40f6532
@@ -0,0 +1,53 @@
+/* SPDX-License-Identifier: LGPL-2.1 */
+
+/*
+ * Copyright (C) 2018 VMware Inc, Yordan Karadzhov (VMware) <[email protected]>
+ *               2021 Intel Inc, Hongzhan Chen <[email protected]>
+ */
+
+/**
+ *  @file    common_sched.h

src/plugins/common_sched.h line 19

Quoted 10 lines
src/plugins/common_sched.h new file +10 -0
+ *  @brief   Common definitions for sched plugins.
+ */
+
+#ifndef _KS_PLUGIN_COMMON_SCHED_H
+#define _KS_PLUGIN_COMMON_SCHED_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+

We need this new type (below) to be documented, because it is being used by the parameters of the functions. Add something like this:
/** The type of the numerical data field used by the 'tep' APIs. */

src/plugins/common_sched.h line 30

Quoted 11 lines
src/plugins/common_sched.h new file +11 -0
+typedef unsigned long long tep_num_field_t;
+
+/** The type of the data field stored in the kshark_data_container object. */
+typedef int64_t ks_num_field_t;
+
+#define PREV_STATE_SHIFT	((int) ((sizeof(ks_num_field_t) - 1) * 8))
+
+#define PREV_STATE_MASK		(((ks_num_field_t) 1 << 8) - 1)
+
+#define PID_MASK		(((ks_num_field_t) 1 << PREV_STATE_SHIFT) - 1)
+

We need documentation for those 3 definitions as well as for the function below.

Quoted 78 lines
src/plugins/common_sched.h new file +23 -0
+static inline void plugin_sched_set_pid(ks_num_field_t *field,
+				 tep_num_field_t pid)
+{
+	*field &= ~PID_MASK;
+	*field |= pid & PID_MASK;
+}
+
+/**
+ * @brief Retrieve the PID value from the data field stored in the
+ *	  kshark_data_container object.
+ *
+ * @param field: Input location for the data field.
+ */
+static inline int plugin_sched_get_pid(ks_num_field_t field)
+{
+	return field & PID_MASK;
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
src/plugins/sched_events.c +0 -30
index 198ed49..3bb9bc2 100644
@@ -22,36 +22,6 @@
 
  /** Plugin context instance. */
 
-//! @cond Doxygen_Suppress
-
-typedef unsigned long long tep_num_field_t;
-
-#define PREV_STATE_SHIFT	((int) ((sizeof(ks_num_field_t) - 1) * 8))
-
-#define PREV_STATE_MASK		(((ks_num_field_t) 1 << 8) - 1)
-
-#define PID_MASK		(((ks_num_field_t) 1 << PREV_STATE_SHIFT) - 1)
-
-//! @endcond
-
-static void plugin_sched_set_pid(ks_num_field_t *field,
-				 tep_num_field_t pid)
-{
-	*field &= ~PID_MASK;
-	*field = pid & PID_MASK;
-}
-
-/**
- * @brief Retrieve the PID value from the data field stored in the
- *	  kshark_data_container object.
- *
- * @param field: Input location for the data field.
- */
-__hidden int plugin_sched_get_pid(ks_num_field_t field)
-{
-	return field & PID_MASK;
-}
-
  /* Use the most significant byte to store the value of "prev_state". */
  static void plugin_sched_set_prev_state(ks_num_field_t *field,
  					tep_num_field_t prev_state)
src/plugins/sched_events.h +1 -0
index a2ba4b4..1032075 100644
@@ -15,6 +15,7 @@
  // KernelShark
  #include "libkshark.h"
  #include "libkshark-plugin.h"
+#include "plugins/common_sched.h"
 
  #ifdef __cplusplus
  extern "C" {

src/plugins/sched_events.h struct plugin_sched_context { · line 61

Quoted 10 lines
src/plugins/sched_events.h +0 -4
@@ -55,10 +56,6 @@ struct plugin_sched_context {
 
  KS_DECLARE_PLUGIN_CONTEXT_METHODS(struct plugin_sched_context)
 
-/** The type of the data field stored in the kshark_data_container object. */
-typedef int64_t ks_num_field_t;
-
-int plugin_sched_get_pid(ks_num_field_t field);
 
  int plugin_sched_get_prev_state(ks_num_field_t field);
 

Before sending the next version, please make sure that the code builds without any errors or warnings, including the building of the Doxygen documentation. If you don't know how to build the documentation, checkout the instructions in README.

Looking forward to see the final version of the patch.

Thanks!
Yordan

#3 lore raw

RE: [PATCH V4 2/3] kernel-shark: Move common APIs and definitions out to avoid duplication

Quoted 18 lines

-----Original Message-----
From: Yordan Karadzhov <[email protected]>
Sent: Monday, January 10, 2022 9:10 PM
To: Chen, Hongzhan <[email protected]>; [email protected]
Subject: Re: [PATCH V4 2/3] kernel-shark: Move common APIs and definitions out to avoid duplication

Hi Hongzhan,

This patch breaks the build on my machine.
More comments below.

Quoted 5 lines · Hongzhan Chen

To avoid code duplication, move some common APIs and definitions out from plugin SchedEvent to share with other plugins.

Quoted 8 lines

src/KsPlugins.cpp

Quoted 4 lines
src/KsPlugins.cpp +0 -0
index ad9f478..a288018 100644

In this file we have a missing include. We need
#include <limits>

I have not reproduced the issue on my machine. After google limits include thing, the issue you met I guess
is similar to https://discourse.vtk.org/t/compilation-error-include-limits-required-in-several-files/6496 which should be related to GCC version 11+ which remove some include dependences as described in http://gcc.gnu.org/gcc-11/porting_to.htmlbut
and we should include explicitly limits when compiled with GCC 11 but I am just using gcc version 7.5.0 (Ubuntu 7.5.0-3ubuntu1~18.04). After I upgrade to GCC 11.2 and I can reproduce limits issue now. I will modify it .Sorry for the inconvenience.

Regards

Hongzhan Chen

#4 lore raw

Re: [PATCH V4 2/3] kernel-shark: Move common APIs and definitions out to avoid duplication

Quoted 1 line · Hongzhan

I will modify it .Sorry for the inconvenience.

No worries.
cheers,
Y.

#5 lore raw

PATCH v4 3/3 kernel-shark: Add plugin for handling Xenomai cobalt_context_switch

In reply to Hongzhan Chen

For Xenomai-cobalt enabled system, cobalt_switch_context means that there is schedule and context switch in companion core(realtime core), which we may need to do special treatment and take correct action as main kernel sched_switch to visualize out-of-band state of realtime tasks running in cobalt core. To achive our target, we implement following:

1. store corresponding cobalt_switch_context events into container data.
2. modify pid stored in entry to be equal to next_pid to show correct color in cpu bar when cobalt_switch_context event happen.
3. show blue hollow box to mark out-of-band state according to cobalt_switch_context events.
4. clickable cobalt_switch_context plugin shapes.

src/plugins/CMakeLists.txt +4 -0
index 3e170fa..16f080b 100644
@@ -44,6 +44,10 @@ if (Qt5Widgets_FOUND AND TT_FONT_FILE)
                      SOURCE sched_events.c SchedEvents.cpp)
     list(APPEND PLUGIN_LIST "sched_events")
 
+    BUILD_GUI_PLUGIN(NAME xenomai_cobalt_switch_events
+                     SOURCE xenomai_cobalt_switch_events.c CobaltSwitchEvents.cpp)
+    list(APPEND PLUGIN_LIST "xenomai_cobalt_switch_events")
+
     BUILD_GUI_PLUGIN(NAME event_field_plot
                      MOC EventFieldDialog.hpp
                      SOURCE event_field_plot.c EventFieldDialog.cpp EventFieldPlot.cpp)
src/plugins/CobaltSwitchEvents.cpp new file +156 -0

156 lines not on this page · raw message

src/plugins/xenomai_cobalt_switch_events.c new file +174 -0

174 lines not on this page · raw message

src/plugins/xenomai_cobalt_switch_events.h new file +58 -0

58 lines not on this page · raw message

Signature · 1 line
2.17.1
#6 lore raw

Re: [PATCH V4 3/3] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch

src/plugins/CobaltSwitchEvents.cpp line 155

Quoted 6 lines · Hongzhan Chen
src/plugins/CobaltSwitchEvents.cpp new file +6 -0
+	eventFieldIntervalPlot(argvCpp,
+			       plugin_ctx->cs_data, checkFieldCS,
+			       plugin_ctx->cs_data, checkEntryPid,
+			       makeLatencyBox<XenomaiSwitchBox>,
+			       {0, 0, KS_COBALT_BLUE}, // Cobalt Blue
+			       -1);         // Default size

Hi Hongzhan,

I meant something different with my comment about 'cobalt blue'. Here you define the color with RGB coordinates (0, 0, 255). This means 255 on the blue axis and zeros on the red and green. This is what I meant by 'just blue'. The RGB coordinates of the 'cobalt blue' color are (0, 71, 171). This means it is some mixture between green and blue.

Cheers,
Yordan

#7 lore raw
In reply to Hongzhan Chen
Quoted 10 lines · Hongzhan Chen

fix typo in sched plugin and make it easier to read.

src/plugins/sched_events.h +0 -0
index 2c540fd..a2ba4b4 100644

src/plugins/sched_events.h line 16

Quoted 10 lines
src/plugins/sched_events.h +2 -2
@@ -9,8 +9,8 @@
   *  @brief   Plugin for Sched events.
   */
 
-#ifndef _KS_PLUGIN_SHED_H
-#define _KS_PLUGIN_SHED_H
+#ifndef _KS_PLUGIN_SCHED_H
+#define _KS_PLUGIN_SCHED_H
 
  // KernelShark
  #include "libkshark.h"

I applied this one.

Thanks,
Yordan