kernel-shark: Move common APIs and definitions out to avoid duplication
PATCH 1/2 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.hpp +63 -0
@@ -13,6 +13,7 @@ #define _KS_PLUGINS_H // C++ +#include <vector> #include <functional> // KernelShark
@@ -101,4 +102,66 @@ 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; + + /** + * @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; + } +}; + +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) +{ + 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 +7 -59
108 lines not on this page · raw message
src/plugins/common_sched.h new file +52 -0
52 lines not on this page · raw message
src/plugins/sched_events.c +0 -30
@@ -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 +3 -6
@@ -9,12 +9,13 @@* @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" #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
PATCH 2/2 kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
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/libkshark-tepdata.c +1 -0
@@ -1208,6 +1208,7 @@ static void kshark_tep_init_methods(struct kshark_generic_stream_interface *inte/** A list of built in default plugins for FTRACE (trace-cmd) data. */ const char *tep_plugin_names[] = {"sched_events" , +"xenomai_cobalt_switch_events" ,"missed_events" ,"kvm_combo" , };
src/plugins/CMakeLists.txt +4 -0
@@ -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 +57 -0
57 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
Hi Hongzhan and Jan,
Have you decided something about the way this plugin will be maintained?
Quoted 23 lines · Hongzhan Chen
For Xenomai-cobalt enabled system,
cobalt_switch_contextmeans 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 kernelsched_switchto visualize out-of-band state of realtime tasks running in cobalt core. To achive our target, we implement following:1. store corresponding
cobalt_switch_contextevents into container data.
2. modify pid stored in entry to be equal tonext_pidto show correct color in cpu bar whencobalt_switch_contextevent happen.
3. show blue hollow box to mark out-of-band state according tocobalt_switch_contextevents.
4. clickablecobalt_switch_contextplugin shapes.Signed-off-by Hongzhan Chen <[email protected]>src/libkshark-tepdata.c +0
-0
src/libkshark-tepdata.c static void kshark_tep_init_methods(struct kshark_generic_stream_interface *inte · line 1211
Quoted 4 lines
src/libkshark-tepdata.c +1
-0@@ -1208,6 +1208,7 @@ static void kshark_tep_init_methods(struct kshark_generic_stream_interface *inte/** A list of built in default plugins for FTRACE (trace-cmd) data. */ const char *tep_plugin_names[] = {"sched_events" , +"xenomai_cobalt_switch_events" ,
I am not sure we want to make this plugin load by default. Even if we do so, this change must go with a separate patch.
Quoted 8 lines
src/libkshark-tepdata.c +0
-0"missed_events" , "kvm_combo", };src/plugins/CMakeLists.txt +0
-0
src/plugins/CMakeLists.txt if (Qt5Widgets_FOUND AND TT_FONT_FILE) · line 50
Quoted 7 lines
src/plugins/CMakeLists.txt +4
-0@@ -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") +
You do not need this if the plugin will live in its own repository.
Quoted 153 lines
src/plugins/CMakeLists.txt +0
-0BUILD_GUI_PLUGIN(NAME event_field_plot MOC EventFieldDialog.hpp SOURCE event_field_plot.c EventFieldDialog.cpp EventFieldPlot.cpp)src/plugins/CobaltSwitchEvents.cpp new file +144
-0@@ -0,0 +1,156 @@ +// SPDX-License-Identifier: LGPL-2.1 + +/* + * Copyright (C) 2021 Intel Inc, Hongzhan Chen <[email protected]> + */ + +/** + * @file CobaltSwitchEvents.cpp + * @brief Defines a callback function for Xenomai Cobalt context switch + * events used to plot in blue the out-of-band state of the task + */ + +// KernelShark +#include "libkshark.h" +#include "libkshark-plugin.h" +#include "plugins/xenomai_cobalt_switch_events.h" +#include "KsPlotTools.hpp" +#include "KsPlugins.hpp" +#include "KsMainWindow.hpp" + +static KsMainWindow *ks_xenomai_ptr; + +/** + * @brief Provide the plugin with a pointer to the KsMainWindow object (the GUI + * itself) such that the plugin can manipulate the GUI. + */ +__hidden void *plugin_set_gui_ptr(void *gui_ptr) +{ + ks_xenomai_ptr = static_cast<KsMainWindow *>(gui_ptr); + return nullptr; +} + +/** + * This class represents the graphical element visualizing OOB state between + * two cobalt_switch_context events. + */ +class XenomaiSwitchBox : public LatencyBox +{ + /** On double click do. */ + void _doubleClick() const override + { + ks_xenomai_ptr->markEntry(_data[1]->entry, DualMarkerState::B); + ks_xenomai_ptr->markEntry(_data[0]->entry, DualMarkerState::A); + } + +}; + +/* + * Ideally, the cobalt_switch_context has to be the last trace event recorded before + * the task is preempted. Because of this, when the data is loaded (the first pass), + * the "pid" field of the cobalt_switch_context entries gets edited by this plugin + * to be equal to the "next pid" of the cobalt_switch_context event. However, in + * reality the cobalt_switch_context event may be followed by some trailing events + * from the same task (printk events for example). This has the effect of extending + * the graph of the task outside of the actual duration of the task. The "second + * pass" over the data is used to fix this problem. It takes advantage of the + * "next" field of the entry (this field is set during the first pass) to search + * for trailing events after the "cobalt_switch_context". In addition, when + * we find that it try to switch in-band because next-pid is zero, we prefer to + * skip this event because it try to leave oob not enterring. + */ +static void secondPass(plugin_cobalt_context *plugin_ctx) +{ + kshark_data_container *cSS; + kshark_entry *e; + int pid_rec, switch_inband; + + cSS = plugin_ctx->cs_data; + for (ssize_t i = 0; i < cSS->size; ++i) { + switch_inband = plugin_cobalt_check_switch_inband( + cSS->data[i]->field); + + /* we skip cobalt_switch_context that try to + * switch into in-band state because we just handle + * out-of-band + */ + if (switch_inband) + continue; + pid_rec = plugin_sched_get_pid(cSS->data[i]->field); + e = cSS->data[i]->entry; + if (!e->next || e->pid == 0 || + e->event_id == e->next->event_id || + pid_rec != e->next->pid) + continue; + + e = e->next; + /* Find all trailing events. */ + for (; e->next; e = e->next) { + if (e->pid == plugin_sched_get_pid( + cSS->data[i]->field)) { + /* + * Change the "pid" to be equal to the "next + * pid" of the cobalt_switch_context event + * and leave a sign that you edited this + * entry. + */ + e->pid = cSS->data[i]->entry->pid; + e->visible &= ~KS_PLUGIN_UNTOUCHED_MASK; + + /* This is the last trailing event, we finish + * this round. + */ + if (e->next->pid != plugin_sched_get_pid( + cSS->data[i]->field)) + break; + } + } + } +} + +/** + * @brief Plugin's draw function. + * + * @param argv_c: A C pointer to be converted to KsCppArgV (C++ struct). + * @param sd: Data stream identifier. + * @param pid: Process Id. + * @param draw_action: Draw action identifier. + */ +__hidden void plugin_cobalt_draw(kshark_cpp_argv *argv_c, + int sd, int pid, int draw_action) +{ + plugin_cobalt_context *plugin_ctx; + + if (!(draw_action & KSHARK_TASK_DRAW) || pid == 0) + return; + + plugin_ctx = __get_context(sd); + if (!plugin_ctx) + return; + + KsCppArgV *argvCpp = KS_ARGV_TO_CPP(argv_c); + + if (!plugin_ctx->second_pass_done) { + /* The second pass is not done yet. */ + secondPass(plugin_ctx); + plugin_ctx->second_pass_done = true; + } + + IsApplicableFunc checkFieldCS = [=] (kshark_data_container *d, + ssize_t i) { + return !(plugin_cobalt_check_switch_inband(d->data[i]->field)) && + d->data[i]->entry->pid == pid; + }; +
src/plugins/CobaltSwitchEvents.cpp line 154
Quoted 10 lines
src/plugins/CobaltSwitchEvents.cpp new file +10
-0+ IsApplicableFunc checkEntryPid = [=] (kshark_data_container *d, + ssize_t i) { + return plugin_sched_get_pid(d->data[i]->field) == pid; + }; + + eventFieldIntervalPlot(argvCpp, + plugin_ctx->cs_data, checkFieldCS, + plugin_ctx->cs_data, checkEntryPid, + makeLatencyBox<XenomaiSwitchBox>, + {0, 0, 255}, // Blue
Perhaps you can use 'cobalt blue' instead of just blue ;-)
cheers,
Yordan
Quoted 246 lines
src/plugins/CobaltSwitchEvents.cpp new file +2
-0+ -1); // Default size +}src/plugins/xenomai_cobalt_switch_events.c new file +174
-0@@ -0,0 +1,174 @@ +// SPDX-License-Identifier: LGPL-2.1 + +/* +* Copyright (C) 2021 Intel Inc, Hongzhan Chen <[email protected]> +*/ + +/** +* @file xenomai_cobalt_switch_events.c +* @brief handle xenomai cobalt switch context event +*/ + +// C +#include <stdlib.h> +#include <stdio.h> + +// trace-cmd +#include <trace-cmd.h> + +// KernelShark +#include "plugins/xenomai_cobalt_switch_events.h" +#include "libkshark-tepdata.h" + +/** Plugin context instance. */ + +//! @cond Doxygen_Suppress + +#define SWITCH_INBAND_SHIFT PREV_STATE_SHIFT + +#define SWITCH_INBAND_MASK PREV_STATE_MASK + +//! @endcond + +static void cobalt_free_context (struct plugin_cobalt_context *plugin_ctx) +{ +if (!plugin_ctx) +return ; + +kshark_free_data_container (plugin_ctx->cs_data); +} + +/* Use the most significant byte to store state marking switch in-band. */ +static void plugin_cobalt_set_switch_inband_state (ks_num_field_t *field, +ks_num_field_t inband_state) +{ +unsigned long long mask =SWITCH_INBAND_MASK <<SWITCH_INBAND_SHIFT ; + *field &= ~mask; + *field |= (inband_state &SWITCH_INBAND_MASK ) <<SWITCH_INBAND_SHIFT ; +} + +/** +* @brief Retrieve the state of switch-in-band from the data field stored in +* the kshark_data_container object. +* +* @param field: Input location for the data field. +*/ +__hidden int plugin_cobalt_check_switch_inband(ks_num_field_t field) +{ +unsigned long long mask =SWITCH_INBAND_MASK <<SWITCH_INBAND_SHIFT ; + +return (field & mask) >>SWITCH_INBAND_SHIFT ; +} + +/** A general purpose macro is used to define plugin context. */ +KS_DEFINE_PLUGIN_CONTEXT(struct plugin_cobalt_context, cobalt_free_context); + +static bool plugin_cobalt_init_context (struct kshark_data_stream *stream, +struct plugin_cobalt_context *plugin_ctx) +{ +struct tep_event *event; + +if (!kshark_is_tep (stream)) +return false; + + plugin_ctx->tep =kshark_get_tep (stream); + + event =tep_find_event_by_name (plugin_ctx->tep, +"cobalt_core" ,"cobalt_switch_context" ); +if (!event) +return false; + + plugin_ctx->cobalt_switch_event = event; + plugin_ctx->cobalt_switch_next_field = +tep_find_any_field (event,"next_pid" ); + + plugin_ctx->second_pass_done = false; + + plugin_ctx->cs_data =kshark_init_data_container (); +if (!plugin_ctx->cs_data) +return false; + +return true; +} + +static void plugin_cobalt_switch_action (struct kshark_data_stream *stream, +void *rec,struct kshark_entry *entry) +{ +struct tep_record *record = (struct tep_record *) rec; +struct plugin_cobalt_context *plugin_ctx; +unsigned long long next_pid; +ks_num_field_t ks_field; +int ret; + + plugin_ctx =__get_context (stream->stream_id); +if (!plugin_ctx) +return ; + + ret =tep_read_number_field (plugin_ctx->cobalt_switch_next_field, + record->data, &next_pid); + +if (ret ==0 && next_pid >=0 ) { +plugin_sched_set_pid (&ks_field, entry->pid); +if (next_pid ==0 ) { +plugin_cobalt_set_switch_inband_state (&ks_field, +SWITCH_INBAND_STATE ); + } + +kshark_data_container_append (plugin_ctx->cs_data, + entry, ks_field); + +if (next_pid >0 ) + entry->pid = next_pid; + } +} + +/** Load this plugin. */ +int KSHARK_PLOT_PLUGIN_INITIALIZER (struct kshark_data_stream *stream) +{ +struct plugin_cobalt_context *plugin_ctx; + + plugin_ctx =__init (stream->stream_id); +if (!plugin_ctx || !plugin_cobalt_init_context (stream, plugin_ctx)) { +__close (stream->stream_id); +return 0 ; + } + +if (plugin_ctx->cobalt_switch_event) { +kshark_register_event_handler (stream, + plugin_ctx->cobalt_switch_event->id, + plugin_cobalt_switch_action); + } + +kshark_register_draw_handler (stream, plugin_cobalt_draw); + +return 1 ; +} + +/** Unload this plugin. */ +int KSHARK_PLOT_PLUGIN_DEINITIALIZER (struct kshark_data_stream *stream) +{ +struct plugin_cobalt_context *plugin_ctx =__get_context (stream->stream_id); +int ret =0 ; + +if (plugin_ctx) { +if (plugin_ctx->cobalt_switch_event) { +kshark_unregister_event_handler (stream, + plugin_ctx->cobalt_switch_event->id, + plugin_cobalt_switch_action); + } + +kshark_unregister_draw_handler (stream, plugin_cobalt_draw); + + ret =1 ; + } + +__close (stream->stream_id); + +return ret; +} + +/** Initialize the control interface of the plugin. */ +void *KSHARK_MENU_PLUGIN_INITIALIZER (void *gui_ptr) +{ +return plugin_set_gui_ptr (gui_ptr); +}src/plugins/xenomai_cobalt_switch_events.h new file +57
-0@@ -0,0 +1,57 @@ +/* SPDX-License-Identifier: LGPL-2.1 */ + +/* +* Copyright (C) 2021 Intel Inc, Hongzhan Chen<[email protected]> +*/ + +/** +* @file xenomai_cobalt_switch_events.h +* @brief Plugin for xenomai cobalt switch context event +*/ + +#ifndef _KS_PLUGIN_SHED_H +#define _KS_PLUGIN_SHED_H + +// KernelShark +#include "libkshark.h" +#include "plugins/common_sched.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define SWITCH_INBAND_STATE 1 + +/** Structure representing a plugin-specific context. */ +struct plugin_cobalt_context { +/** Page event used to parse the page. */ +struct tep_handle *tep; + +/** Pointer to the cobalt_switch_event object. */ +struct tep_event *cobalt_switch_event; + +/** Pointer to the cobalt_switch_next_field format descriptor. */ +struct tep_format_field *cobalt_switch_next_field; + +/** True if the second pass is already done. */ +bool second_pass_done; + +/** Data container for cobalt_switch_context data. */ +struct kshark_data_container *cs_data; + +}; + +KS_DECLARE_PLUGIN_CONTEXT_METHODS (struct plugin_cobalt_context ) + +int plugin_cobalt_check_switch_inband(ks_num_field_t field); + +void plugin_cobalt_draw (struct kshark_cpp_argv *argv,int sd,int pid, +int draw_action); + +void *plugin_set_gui_ptr (void *gui_ptr); + +#ifdef __cplusplus +} +#endif + +#endif
Re: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
Quoted 4 lines · Yordan Karadzhov
Hi Hongzhan and Jan,
Have you decided something about the way this plugin will be maintained?
No decision yet. I'm still waiting for an answer on
https://lore.kernel.org/linux-trace-devel/[email protected]/
regarding maintenance of different tracepoint revisions. That would be implicit when keeping the plugin in lock-step with the tracepoints in the same repo.
But then the question would be how mature the interface lifecycle management of kernelshark and libs is /wrt external plugins. Those may need to account for potential changes in those APIs over the time, right?
We will likely pick the path that is least inconvenient.
[...]
Quoted 8 lines
Quoted 5 lines
+ eventFieldIntervalPlot(argvCpp,
+plugin_ctx->cs_data, checkFieldCS, +plugin_ctx->cs_data, checkEntryPid, + makeLatencyBox<XenomaiSwitchBox>, + {0, 0, 255}, // BluePerhaps you can use 'cobalt blue' instead of just blue ;-)
Makes sense ;)
Seriously: Is there some caption somewhere that explains the meaning of colors? If so, how to hook into that?
Thanks,
Jan
Signature · 2 lines
Siemens AG, Technology Competence Center Embedded Linux
Re: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
Quoted 11 lines · Jan Kiszka
Quoted 4 lines · Yordan Karadzhov
Hi Hongzhan and Jan,
Have you decided something about the way this plugin will be maintained?
No decision yet. I'm still waiting for an answer on
https://lore.kernel.org/linux-trace-devel/[email protected]/
regarding maintenance of different tracepoint revisions. That would be implicit when keeping the plugin in lock-step with the tracepoints in the same repo.
OK.
Quoted 5 lines
But then the question would be how mature the interface lifecycle management of kernelshark and libs is /wrt external plugins. Those may need to account for potential changes in those APIs over the time, right?
The APIs are not supposed to change. I cannot give you an absolute guarantee, but we will do our best to keep the interface stable. Anyway, even if we have to do some minor changes in the future, it will be our responsibility to communicate this and help with fixing all external plugins we are aware of.
The whole idea behind the design of this interface is to be friendly for external plugins.
Quoted 10 lines
We will likely pick the path that is least inconvenient.
[...]
Quoted 6 lines
Quoted 5 lines
+ eventFieldIntervalPlot(argvCpp,
+plugin_ctx->cs_data, checkFieldCS, +plugin_ctx->cs_data, checkEntryPid, + makeLatencyBox<XenomaiSwitchBox>, + {0, 0, 255}, // Blue
Quoted 7 lines
Quoted 2 lines
Perhaps you can use 'cobalt blue' instead of just blue ;-)
Makes sense ;)
Seriously: Is there some caption somewhere that explains the meaning of colors? If so, how to hook into that?
So far we do not have special convention for the meaning of the colors.
Thanks,
Yordan
Quoted 4 lines
Thanks,
Jan
Re: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
Quoted 24 lines · Yordan Karadzhov
Quoted 6 lines · Jan Kiszka
Quoted 4 lines · Yordan Karadzhov
Hi Hongzhan and Jan,
Have you decided something about the way this plugin will be maintained?
Quoted 6 lines
No decision yet. I'm still waiting for an answer on
https://lore.kernel.org/linux-trace-devel/[email protected]/regarding maintenance of different tracepoint revisions. That would be implicit when keeping the plugin in lock-step with the tracepoints in the same repo.
OK.
Quoted 5 lines
But then the question would be how mature the interface lifecycle management of kernelshark and libs is /wrt external plugins. Those may need to account for potential changes in those APIs over the time, right?
Quoted 9 lines
The APIs are not supposed to change. I cannot give you an absolute guarantee, but we will do our best to keep the interface stable. Anyway, even if we have to do some minor changes in the future, it will be our responsibility to communicate this and help with fixing all external plugins we are aware of.
The whole idea behind the design of this interface is to be friendly for external plugins.
OK, that sound motivating to look into the external path. I suppose only the auto-loading topic should be improved then.
Quoted 13 lines
Quoted 13 lines
We will likely pick the path that is least inconvenient.
[...]
Quoted 8 lines
Quoted 5 lines
+ eventFieldIntervalPlot(argvCpp,
+plugin_ctx->cs_data, checkFieldCS, +plugin_ctx->cs_data, checkEntryPid, + makeLatencyBox<XenomaiSwitchBox>, + {0, 0, 255}, // BluePerhaps you can use 'cobalt blue' instead of just blue ;-)
Quoted 7 lines
Quoted 4 lines
Makes sense ;)
Seriously: Is there some caption somewhere that explains the meaning of colors? If so, how to hook into that?
So far we do not have special convention for the meaning of the colors.
But also no textual description of their semantics yet, right? Where could this be added best to the UI?
Jan
Signature · 2 lines
Siemens AG, Technology Competence Center Embedded Linux
Re: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
Quoted 6 lines · Jan Kiszka
Quoted 3 lines
The whole idea behind the design of this interface is to be friendly for external plugins.
OK, that sound motivating to look into the external path. I suppose only the auto-loading topic should be improved then.
Sounds like a plan.
Y.
RE: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomai cobalt_context_switch
Quoted 10 lines
-----Original Message-----
From: Yordan Karadzhov <[email protected]>
Sent: Friday, January 7, 2022 8:31 PM
To: Kiszka, Jan <[email protected]>; Chen, Hongzhan <[email protected]>; [email protected]
Subject: Re: [PATCH 2/2] kernel-shark: Add plugin for handling Xenomaicobalt_context_switchOn 7.01.22 ?. 14:27 ?., Jan Kiszka wrote:
Quoted 8 lines
Quoted 6 lines
Quoted 3 lines
The whole idea behind the design of this interface is to be friendly for external plugins.
OK, that sound motivating to look into the external path. I suppose only the auto-loading topic should be improved then.
Sounds like a plan.
Thanks for all your comments to make the thing clear for me. Please review my V4 patchset.
Regards
Hongzhan Chen
Quoted 2 lines
Y.
Hi Hongzhan,
This patch needs few final touches before going upstream. See my comments below.
Quoted 36 lines · Hongzhan Chen
To avoid code duplication, move some common APIs and definitions out from plugin SchedEvent to share with other plugins.
Signed-off-by Hongzhan Chen <[email protected]>src/KsPlugins.hpp +16
-0@@ -13,6 +13,7 @@ #define _KS_PLUGINS_H // C++ +#include <vector> #include <functional> // KernelShark@@ -101,4 +102,66 @@ 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 129
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. + */ + double distance(int x, int y) const override
Move the implementation to src/KsPlugins.cpp
Quoted 53 lines
src/KsPlugins.hpp +37
-0+ { + 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; + } +}; + +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) +{ + 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; +} + #endifsrc/plugins/SchedEvents.cpp +0
-3@@ -11,9 +11,6 @@ * preempted by another task. */ -// C++ -#include <vector> - // KernelShark #include "libkshark.h" #include "libkshark-plugin.h"
src/plugins/SchedEvents.cpp line 24
Quoted 5 lines
src/plugins/SchedEvents.cpp +1
-1@@ -24,7 +21,7 @@ using namespace KsPlot; -static KsMainWindow *ks_ptr; +static KsMainWindow *ks_schedevent_ptr;
This name is a bit confusing. It reads as pointer to a sched event while it is a pointer to the KS GUI. What about ks4sched_ptr?
Quoted 13 lines
src/plugins/SchedEvents.cpp +1
-1/** * @brief Provide the plugin with a pointer to the KsMainWindow object (the GUI@@ -32,7 +29,7 @@ static KsMainWindow *ks_ptr; */ __hidden void *plugin_set_gui_ptr(void *gui_ptr) { - ks_ptr = static_cast<KsMainWindow *>(gui_ptr); + ks_schedevent_ptr = static_cast<KsMainWindow *>(gui_ptr); return nullptr; }
src/plugins/SchedEvents.cpp __hidden void *plugin_set_gui_ptr(void *gui_ptr) · line 38
Quoted 2 lines
src/plugins/SchedEvents.cpp +0
-0@@ -40,64 +37,15 @@ __hidden void *plugin_set_gui_ptr(void *gui_ptr) * This class represents the graphical element visualizing the latency between * sched_waking and sched_switch events.
Add here one sentence explaining that this child class is defined to re-implement the handler for double-click.
Quoted 88 lines
src/plugins/SchedEvents.cpp +5
-54*/ -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); + ks_schedevent_ptr->markEntry(_data[1]->entry, DualMarkerState::B); + ks_schedevent_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 +139,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 +0
-0
src/plugins/common_sched.h line 4
Quoted 4 lines
src/plugins/common_sched.h new file +4
-0@@ -0,0 +1,52 @@ +/* SPDX-License-Identifier: LGPL-2.1 */ + +/* +* Copyright (C) 2021 Intel Inc, Hongzhan Chen <[email protected]>
Since this is a 'copy-paste' code I think you should keep the original copyright statement on top and add the new one (2021, Intel, Hongzhan) on the next line.
src/plugins/common_sched.h line 9
Quoted 5 lines
src/plugins/common_sched.h new file +5
-0+*/ + +/** +* @file common_sched.h +* @brief Plugin for common sched.
Perhaps you mean 'Common definitions for sched plugins?'
Quoted 15 lines
src/plugins/common_sched.h new file +15
-0+*/ + +#ifndef _KS_PLUGIN_COMMON_SCHED_H +#define _KS_PLUGIN_COMMON_SCHED_H + +#ifdef __cplusplus +extern "C" { +#endif + +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))
src/plugins/common_sched.h line 34
Quoted 10 lines
src/plugins/common_sched.h new file +10
-0+ +#define PREV_STATE_MASK (((ks_num_field_t) 1 << 8) - 1) + +#define PID_MASK (((ks_num_field_t) 1 << PREV_STATE_SHIFT) - 1) + +static inline void plugin_sched_set_pid (ks_num_field_t *field, +tep_num_field_t pid) +{ + *field &= ~PID_MASK ; + *field = pid &PID_MASK ;
Hmm, this looks like a bug in the schedevent plugin. This line should be
*field |= pid & PID_MASK;
Quoted 64 lines
src/plugins/common_sched.h new file +18
-0+} + +/** +* @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@@ -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 +0
-0
src/plugins/sched_events.h line 13
Quoted 7 lines
src/plugins/sched_events.h +2
-2@@ -9,12 +9,13 @@* @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
Good catch, please make this a separate patch.
Thanks!
Yordan
Quoted 20 lines
src/plugins/sched_events.h +1
-4// KernelShark #include "libkshark.h" #include "libkshark-plugin.h" +#include "plugins/common_sched.h" #ifdef __cplusplusextern "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);