The APIs are renamed in order to match the naming convention used in
the library. The patch adds documentation add well.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@xxxxxxxxx>
---
Documentation/libtracefs-hist.txt | 15 ++++++++++++++-
include/tracefs.h | 6 +++---
src/tracefs-hist.c | 24 +++++++++++++++++++++---
3 files changed, 38 insertions(+), 7 deletions(-)
diff --git a/Documentation/libtracefs-hist.txt b/Documentation/libtracefs-hist.txt
index c8230e5..e3145c9 100644
--- a/Documentation/libtracefs-hist.txt
+++ b/Documentation/libtracefs-hist.txt
@@ -5,7 +5,8 @@ NAME
----
tracefs_hist_alloc, tracefs_hist_free, tracefs_hist_add_key, tracefs_hist_add_value, tracefs_hist_add_name, tracefs_hist_start,
tracefs_hist_destory, tracefs_hist_add_sort_key, tracefs_hist_set_sort_key, tracefs_hist_sort_key_direction
-tracefs_hist_echo_cmd, tracefs_hist_echo_fmt - Create and update event histograms
+tracefs_hist_echo_cmd, tracefs_hist_echo_fmt, tracefs_hist_get_name, tracefs_hist_get_event,
+tracefs_hist_get_system - Create, update and describe event histograms
SYNOPSIS
--------
@@ -73,6 +74,12 @@ int tracefs_hist_command(struct tracefs_instance pass:[*]instance,
int tracefs_hist_echo_fmt(struct trace_seq pass:[*]s, struct tracefs_instance pass:[*]instance,
struct tracefs_hist pass:[*]hist);
+tracefs_hist_get_name(struct tracefs_hist pass:[*]hist);
+
+tracefs_hist_get_event(struct tracefs_hist pass:[*]hist);
+
+tracefs_hist_get_system(struct tracefs_hist pass:[*]hist);
+
--
DESCRIPTION
@@ -190,6 +197,12 @@ that would be done by *tracefs_hist_command*(3).
*tracefs_hist_echo_fmt*() prints the raw format that describes the state of the
histogram in the given _instance_, or NULL for the top level, into the _seq_.
+*tracefs_hist_get_name*() prints the name of the histogram.
+
+*tracefs_hist_get_event*() prints the event name of the histogram.
+
+*tracefs_hist_get_system*() prints the system name of the histogram.
+
*tracefs_hist_command*() is called to process a command on the histogram
_hist_ for its event in the given _instance_, or NULL for the top level.
The _cmd_ can be one of:
diff --git a/include/tracefs.h b/include/tracefs.h
index c2a6db7..7c03086 100644
--- a/include/tracefs.h
+++ b/include/tracefs.h
@@ -354,9 +354,9 @@ struct tracefs_hist *
tracefs_hist_alloc_nd(struct tep_handle *tep,
const char *system, const char *event_name,
struct tracefs_hist_axis *axes);
-const char *tracefs_get_hist_name(struct tracefs_hist *hist);
-const char *tracefs_get_hist_event(struct tracefs_hist *hist);
-const char *tracefs_get_hist_system(struct tracefs_hist *hist);
+const char *tracefs_hist_get_name(struct tracefs_hist *hist);
+const char *tracefs_hist_get_event(struct tracefs_hist *hist);
+const char *tracefs_hist_get_system(struct tracefs_hist *hist);
int tracefs_hist_add_key(struct tracefs_hist *hist, const char *key,
enum tracefs_hist_key_type type);
int tracefs_hist_add_value(struct tracefs_hist *hist, const char *value);
diff --git a/src/tracefs-hist.c b/src/tracefs-hist.c
index 9beafe0..837d4e1 100644
--- a/src/tracefs-hist.c
+++ b/src/tracefs-hist.c
@@ -41,17 +41,35 @@ struct tracefs_hist {
unsigned int filter_state;
};
-const char *tracefs_get_hist_name(struct tracefs_hist *hist)
+/*
+ * tracefs_hist_get_name - get the name of the histogram
+ * @hist: The histogram to get the name for
+ *
+ * Returns name string on succes or NULL on error.
+ */
+const char *tracefs_hist_get_name(struct tracefs_hist *hist)
{
return hist ? hist->name : NULL;
}
-const char *tracefs_get_hist_event(struct tracefs_hist *hist)
+/*
+ * tracefs_hist_get_event - get the event name of the histogram
+ * @hist: The histogram to get the event name for
+ *
+ * Returns event name string on succes or NULL on error.
+ */
+const char *tracefs_hist_get_event(struct tracefs_hist *hist)
{
return hist ? hist->event_name : NULL;
}
-const char *tracefs_get_hist_system(struct tracefs_hist *hist)
+/*
+ * tracefs_hist_get_system - get the system name of the histogram
+ * @hist: The histogram to get the system name for
+ *
+ * Returns system name string on succes or NULL on error.
+ */
+const char *tracefs_hist_get_system(struct tracefs_hist *hist)
{
return hist ? hist->system : NULL;
}
--
2.32.0
|