diff mbox series

[3/6] libtracefs: Encapsulate "struct tracefs_options_mask"

Message ID 20210402131947.346235-4-y.karadz@gmail.com (mailing list archive)
State Superseded
Headers show
Series Refactor the APIs for tracing options | expand

Commit Message

Yordan Karadzhov April 2, 2021, 1:19 p.m. UTC 
The definition of the mask gets hidden from the user. This way we will
be able to modify this definition in the future, without breaking the
API. Such a modification will be compulsory, if too many new tracing
options are added in the future. Note that encapsulating the mask
definition, requires two API methods to be eliminated, however those
methods have no particular use-cases for the moment.

Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
 include/tracefs.h   |  6 +-----
 src/tracefs-tools.c | 33 +++++++++++----------------------
 2 files changed, 12 insertions(+), 27 deletions(-)

Comments

Steven Rostedt April 2, 2021, 2:13 p.m. UTC | #1 
On Fri,  2 Apr 2021 16:19:44 +0300
"Yordan Karadzhov (VMware)" <y.karadz@gmail.com> wrote:

> @@ -197,6 +201,13 @@ enum tracefs_option_id tracefs_option_id(const char *name)
>  	return TRACEFS_OPTION_INVALID;
>  }
>  
> +static void tracefs_option_set(struct tracefs_options_mask *options,
> +			       enum tracefs_option_id id)

Patch is fine, but lets rename this function to:

	trace_option_set()

As functions named "tracefs_*()" should be used only by functions that are
for the API or will be for the API (staging functions).

-- Steve


> +{
> +	if (options && id > TRACEFS_OPTION_INVALID)
> +		options->mask |= (1ULL << (id - 1));
> +}
> +
>  static struct tracefs_options_mask *trace_get_options(struct tracefs_instance *instance,
>  						      bool enabled)
>  {
diff mbox series

Patch

diff --git a/include/tracefs.h b/include/tracefs.h
index 5c4e50d..0665e8d 100644
--- a/include/tracefs.h
+++ b/include/tracefs.h
@@ -131,11 +131,7 @@  enum tracefs_option_id {
 };
 #define TRACEFS_OPTION_MAX (TRACEFS_OPTION_VERBOSE + 1)
 
-struct tracefs_options_mask {
-	unsigned long long	mask;
-};
-void tracefs_option_set(struct tracefs_options_mask *options, enum tracefs_option_id id);
-void tracefs_option_clear(struct tracefs_options_mask *options, enum tracefs_option_id id);
+struct tracefs_options_mask;
 bool tracefs_option_is_set(struct tracefs_options_mask *options,
 			   enum tracefs_option_id id);
 struct tracefs_options_mask *tracefs_options_get_supported(struct tracefs_instance *instance);
diff --git a/src/tracefs-tools.c b/src/tracefs-tools.c
index 3b5f773..11a4c8c 100644
--- a/src/tracefs-tools.c
+++ b/src/tracefs-tools.c
@@ -19,6 +19,10 @@ 
 
 #define TRACE_CTRL	"tracing_on"
 
+struct tracefs_options_mask {
+	unsigned long long	mask;
+};
+
 static const char * const options_map[] = {
 	"unknown",
 	"annotate",
@@ -197,6 +201,13 @@  enum tracefs_option_id tracefs_option_id(const char *name)
 	return TRACEFS_OPTION_INVALID;
 }
 
+static void tracefs_option_set(struct tracefs_options_mask *options,
+			       enum tracefs_option_id id)
+{
+	if (options && id > TRACEFS_OPTION_INVALID)
+		options->mask |= (1ULL << (id - 1));
+}
+
 static struct tracefs_options_mask *trace_get_options(struct tracefs_instance *instance,
 						      bool enabled)
 {
@@ -366,25 +377,3 @@  bool tracefs_option_is_set(struct tracefs_options_mask *options,
 		return options->mask & (1ULL << (id - 1));
 	return false;
 }
-
-/**
- * tracefs_option_set - Set option in options bitmask
- * @options: Pointer to a bitmask with options
- * @id: trace option id
- */
-void tracefs_option_set(struct tracefs_options_mask *options, enum tracefs_option_id id)
-{
-	if (options && id > TRACEFS_OPTION_INVALID)
-		options->mask |= (1ULL << (id - 1));
-}
-
-/**
- * tracefs_option_clear - Clear option from options bitmask
- * @options: Pointer to a bitmask with options
- * @id: trace option id
- */
-void tracefs_option_clear(struct tracefs_options_mask *options, enum tracefs_option_id id)
-{
-	if (options && id > TRACEFS_OPTION_INVALID)
-		options->mask &= ~(1ULL << (id - 1));
-}