Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

tracing: Rework __assign_str() and __string() to not duplicate getting the string

The TRACE_EVENT() macro handles dynamic strings by having:

TP_PROTO(struct some_struct *s),
TP_ARGS(s),
TP_STRUCT__entry(
__string(my_string, s->string)
),
TP_fast_assign(
__assign_str(my_string, s->string);
)
TP_printk("%s", __get_str(my_string))

There's even some code that may call a function helper to find the
s->string value. The problem with the above is that the work to get the
s->string is done twice. Once at the __string() and again in the
__assign_str().

But the __string() uses dynamic_array() which has a helper structure that
is created holding the offsets and length of the string fields. Instead of
finding the string twice, just save it off in another field from that
helper structure, and have __assign_str() use that instead.

Note, this also means that the second parameter of __assign_str() isn't
even used anymore, and may be removed in the future.

Link: https://lore.kernel.org/linux-trace-kernel/20240222211442.634192653@goodmis.org

Cc: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Chuck Lever <chuck.lever@oracle.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

+20 -11
+2 -2
include/trace/stages/stage2_data_offsets.h
··· 24 24 #define __array(type, item, len) 25 25 26 26 #undef __dynamic_array 27 - #define __dynamic_array(type, item, len) u32 item; 27 + #define __dynamic_array(type, item, len) u32 item; const void *item##_ptr_; 28 28 29 29 #undef __string 30 30 #define __string(item, src) __dynamic_array(char, item, -1) ··· 45 45 #define __sockaddr(field, len) __dynamic_array(u8, field, len) 46 46 47 47 #undef __rel_dynamic_array 48 - #define __rel_dynamic_array(type, item, len) u32 item; 48 + #define __rel_dynamic_array(type, item, len) u32 item; const void *item##_ptr_; 49 49 50 50 #undef __rel_string 51 51 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
+10 -5
include/trace/stages/stage5_get_offsets.h
··· 47 47 48 48 #undef __string 49 49 #define __string(item, src) __dynamic_array(char, item, \ 50 - strlen((src) ? (const char *)(src) : "(null)") + 1) 50 + strlen((src) ? (const char *)(src) : "(null)") + 1) \ 51 + __data_offsets->item##_ptr_ = src; 51 52 52 53 #undef __string_len 53 - #define __string_len(item, src, len) __dynamic_array(char, item, (len) + 1) 54 + #define __string_len(item, src, len) __dynamic_array(char, item, (len) + 1)\ 55 + __data_offsets->item##_ptr_ = src; 54 56 55 57 #undef __vstring 56 58 #define __vstring(item, fmt, ap) __dynamic_array(char, item, \ ··· 69 67 __data_size += __item_length; 70 68 71 69 #undef __rel_string 72 - #define __rel_string(item, src) __rel_dynamic_array(char, item, \ 73 - strlen((src) ? (const char *)(src) : "(null)") + 1) 70 + #define __rel_string(item, src) __rel_dynamic_array(char, item, \ 71 + strlen((src) ? (const char *)(src) : "(null)") + 1) \ 72 + __data_offsets->item##_ptr_ = src; 74 73 75 74 #undef __rel_string_len 76 - #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, (len) + 1) 75 + #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, (len) + 1)\ 76 + __data_offsets->item##_ptr_ = src; 77 + 77 78 /* 78 79 * __bitmask_size_in_bytes_raw is the number of bytes needed to hold 79 80 * num_possible_cpus().
+8 -4
include/trace/stages/stage6_event_callback.h
··· 32 32 33 33 #undef __assign_str 34 34 #define __assign_str(dst, src) \ 35 - strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)"); 35 + strcpy(__get_str(dst), __data_offsets.dst##_ptr_ ? \ 36 + __data_offsets.dst##_ptr_ : "(null)") 36 37 37 38 #undef __assign_str_len 38 39 #define __assign_str_len(dst, src, len) \ 39 40 do { \ 40 - memcpy(__get_str(dst), (src), (len)); \ 41 + memcpy(__get_str(dst), __data_offsets.dst##_ptr_ ? \ 42 + __data_offsets.dst##_ptr_ : "(null)", len); \ 41 43 __get_str(dst)[len] = '\0'; \ 42 44 } while(0) 43 45 ··· 94 92 95 93 #undef __assign_rel_str 96 94 #define __assign_rel_str(dst, src) \ 97 - strcpy(__get_rel_str(dst), (src) ? (const char *)(src) : "(null)"); 95 + strcpy(__get_rel_str(dst), __data_offsets.dst##_ptr_ ? \ 96 + __data_offsets.dst##_ptr_ : "(null)") 98 97 99 98 #undef __assign_rel_str_len 100 99 #define __assign_rel_str_len(dst, src, len) \ 101 100 do { \ 102 - memcpy(__get_rel_str(dst), (src), (len)); \ 101 + memcpy(__get_rel_str(dst), __data_offsets.dst##_ptr_ ? \ 102 + __data_offsets.dst##_ptr_ : "(null)", len); \ 103 103 __get_rel_str(dst)[len] = '\0'; \ 104 104 } while (0) 105 105