tools/lib/traceevent: Separate out tep_strerror() for strerror_r() issues
PATCH v4 1/1 tools/lib/traceevent: Separate out tep_strerror() for strerror_r() issues
From: "Steven Rostedt (VMware)" <[email protected]>
While working on having PowerTop use libtracevent as a shared object library, Tzvetomir hit "str_error_r not defined". This was added by commit c3cec9e68f12d ("tools lib traceevent: Use str_error_r()") because strerror_r() has two definitions, where one is GNU specific, and the other is XSI complient. The strerror_r() is in a wrapper str_error_r() to keep the code from having to worry about which compiler is being used.
The problem is that str_error_r() is external to libtraceevent, and not part of the library. If it is used as a shared object then the tools using it will need to define that function. I do not want that function defined in libtraceevent itself, as it is out of scope for that library.
As there's only a single instance of this call, and its in the traceevent library's own tep_strerror() function, we can copy what was done in perf, and create yet another external file that undefs _GNU_SOURCE to use the more portable version of the function. We don't need to worry about the errors that strerror_r() returns. If the buffer isn't big enough, we simply truncate it.
--- tools/lib/traceevent/Build | 1 + tools/lib/traceevent/event-parse.c | 30 --------------------- tools/lib/traceevent/tep_strerror.c | 53 +++++++++++++++++++++++++++++++++++++ 3 files changed, 54 insertions(+), 30 deletions(-) create mode 100644 tools/lib/traceevent/tep_strerror.c
tools/lib/traceevent/Build +1 -0
@@ -4,6 +4,7 @@ libtraceevent-y += trace-seq.o libtraceevent-y += parse-filter.o libtraceevent-y += parse-utils.o libtraceevent-y += kbuffer-parse.o +libtraceevent-y += tep_strerror.o plugin_jbd2-y += plugin_jbd2.o plugin_hrtimer-y += plugin_hrtimer.o
tools/lib/traceevent/event-parse.c +0 -30
@@ -18,7 +18,6 @@#include <errno.h> #include <stdint.h> #include <limits.h> -#include <linux/string.h> #include <linux/time64.h> #include <netinet/in.h>
@@ -6201,35 +6200,6 @@ enum tep_errno tep_parse_event(struct tep_handle *pevent, const char *buf,return __parse_event (pevent, &event, buf, size, sys); } -#undef _PE -#define _PE (code, str) str -static const char *const tep_error_str[] = { -TEP_ERRORS -}; -#undef _PE - -int tep_strerror (struct tep_handle *pevent__maybe_unused , -enum tep_errno errnum,char *buf,size_t buflen) -{ -int idx; -const char *msg; - -if (errnum >=0 ) { -str_error_r (errnum, buf, buflen); -return 0 ; - } - -if (errnum <= __TEP_ERRNO__START || - errnum >= __TEP_ERRNO__END) -return -1 ; - - idx = errnum - __TEP_ERRNO__START -1 ; - msg = tep_error_str[idx]; -snprintf (buf, buflen,"%s" , msg); - -return 0 ; -} -int get_field_val (struct trace_seq *s,struct tep_format_field *field,const char *name,struct tep_record *record,unsigned long long *val,int err)
tools/lib/traceevent/tep_strerror.c new file +53 -0
53 lines not on this page · raw message
Signature · 1 line
2.13.6
Arnaldo Carvalho de Melo
AppliedEm Fri, Oct 05, 2018 at 12:18:16PM -0400, Steven Rostedt escreveu:
Quoted 15 lines
From: "Steven Rostedt (VMware)" <[email protected]>
While working on having PowerTop use libtracevent as a shared object library, Tzvetomir hit "
str_error_rnot defined". This was added by commitc3cec9e68f12d("tools lib traceevent: Usestr_error_r()") becausestrerror_r()has two definitions, where one is GNU specific, and the other is XSI complient. Thestrerror_r()is in a wrapperstr_error_r()to keep the code from having to worry about which compiler is being used.The problem is that
str_error_r()is external to libtraceevent, and not part of the library. If it is used as a shared object then the tools using it will need to define that function. I do not want that function defined in libtraceevent itself, as it is out of scope for that library.
Quoted 6 lines
As there's only a single instance of this call, and its in the traceevent library's own
tep_strerror()function, we can copy what was done in perf, and create yet another external file that undefs_GNU_SOURCEto use the more portable version of the function. We don't need to worry about the errors thatstrerror_r()returns. If the buffer isn't big enough, we simply truncate it.
Thanks, applied, replacing the previous version since this is still not in tip.
- Arnaldo
tip-bot for Steven Rostedt (VMware)
merge bot[tip:perf/core] tools lib traceevent: Separate out tep_strerror() for strerror_r() issues
In reply to Steven Rostedttools lib traceevent: Separate out tep_strerror() for strerror_r() issues
Commit-ID: bbbab191c2c474d183e93799d008b412e97f5936 Gitweb: https://git.kernel.org/tip/bbbab191c2c474d183e93799d008b412e97f5936 Author: Steven Rostedt (VMware) <[email protected]> AuthorDate: Fri, 5 Oct 2018 12:18:16 -0400 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Mon, 8 Oct 2018 14:30:45 -0300
tools lib traceevent: Separate out tep_strerror() for strerror_r() issues
While working on having PowerTop use libtracevent as a shared object library, Tzvetomir hit "str_error_r not defined". This was added by commit c3cec9e68f12d ("tools lib traceevent: Use str_error_r()") because strerror_r() has two definitions, where one is GNU specific, and the other is XSI complient. The strerror_r() is in a wrapper str_error_r() to keep the code from having to worry about which compiler is being used.
The problem is that str_error_r() is external to libtraceevent, and not part of the library. If it is used as a shared object then the tools using it will need to define that function. I do not want that function defined in libtraceevent itself, as it is out of scope for that library.
As there's only a single instance of this call, and its in the traceevent library's own tep_strerror() function, we can copy what was done in perf, and create yet another external file that undefs _GNU_SOURCE to use the more portable version of the function. We don't need to worry about the errors that strerror_r() returns. If the buffer isn't big enough, we simply truncate it.
---
tools/lib/traceevent/Build | 1 +
tools/lib/traceevent/event-parse.c | 30 ----------------
.../{str_error_r.c => traceevent/tep_strerror.c} | 40 ++++++++++++++++++----
3 files changed, 34 insertions(+), 37 deletions(-)tools/lib/traceevent/Build +1 -0
@@ -4,6 +4,7 @@ libtraceevent-y += trace-seq.o libtraceevent-y += parse-filter.o libtraceevent-y += parse-utils.o libtraceevent-y += kbuffer-parse.o +libtraceevent-y += tep_strerror.o plugin_jbd2-y += plugin_jbd2.o plugin_hrtimer-y += plugin_hrtimer.o
tools/lib/traceevent/event-parse.c +0 -30
@@ -18,7 +18,6 @@#include <errno.h> #include <stdint.h> #include <limits.h> -#include <linux/string.h> #include <linux/time64.h> #include <netinet/in.h>
@@ -6201,35 +6200,6 @@ enum tep_errno tep_parse_event(struct tep_handle *pevent, const char *buf,return __parse_event (pevent, &event, buf, size, sys); } -#undef _PE -#define _PE (code, str) str -static const char *const tep_error_str[] = { -TEP_ERRORS -}; -#undef _PE - -int tep_strerror (struct tep_handle *pevent__maybe_unused , -enum tep_errno errnum,char *buf,size_t buflen) -{ -int idx; -const char *msg; - -if (errnum >=0 ) { -str_error_r (errnum, buf, buflen); -return 0 ; - } - -if (errnum <= __TEP_ERRNO__START || - errnum >= __TEP_ERRNO__END) -return -1 ; - - idx = errnum - __TEP_ERRNO__START -1 ; - msg = tep_error_str[idx]; -snprintf (buf, buflen,"%s" , msg); - -return 0 ; -} -int get_field_val (struct trace_seq *s,struct tep_format_field *field,const char *name,struct tep_record *record,unsigned long long *val,int err)
tools/lib/traceevent/tep_strerror.c renamed from tools/lib/str_error_r.c +33 -7
@@ -1,8 +1,16 @@ -// SPDX-License-Identifier: GPL-2.0 +// SPDX-License-Identifier: LGPL-2.1 #undef _GNU_SOURCE#include <string.h> #include <stdio.h> -#include <linux/string.h> + +#include "event-parse.h" + +#undef _PE +#define _PE (code, str) str +static const char *const tep_error_str[] = { +TEP_ERRORS +}; +#undef _PE/* * The tools so far have been using the strerror_r() GNU variant, that returns
@@ -18,10 +26,28 @@* interface, but uses the portable XSI variant of strerror_r(), so that users * rest asured that the provided buffer is used and it is what is returned. */ -char *str_error_r (int errnum,char *buf,size_t buflen) +int tep_strerror (struct tep_handle *tep__maybe_unused , +enum tep_errno errnum,char *buf,size_t buflen) { -int err =strerror_r (errnum, buf, buflen); -if (err) -snprintf (buf, buflen,"INTERNAL ERROR: strerror_r(%d, [buf], %zd)=%d" , errnum, buflen, err); -return buf; +const char *msg; +int idx; + +if (!buflen) +return 0 ; + +if (errnum >=0 ) { +int err =strerror_r (errnum, buf, buflen); + buf[buflen -1 ] =0 ; +return err; + } + +if (errnum <= __TEP_ERRNO__START || + errnum >= __TEP_ERRNO__END) +return -1 ; + + idx = errnum - __TEP_ERRNO__START -1 ; + msg = tep_error_str[idx]; +snprintf (buf, buflen,"%s" , msg); + +return 0 ; }