libtraceevent: Add eof checks.
PATCH 1/2 libtraceevent: Add eof checks.
Added checking for __read_char and peek_char to make sure value is not at end of file.
This issue was found while fuzz testing. One of the test cases created an infinite loop because __read_token had reached end of file. Checking was added to all cases where this may occur.
--- src/event-parse.c | 62 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 48 insertions(+), 14 deletions(-)
src/event-parse.c +48 -14
@@ -1155,17 +1155,16 @@ static enum tep_event_type force_token(const char *str, char **tok);static enum tep_event_type __read_token (char **tok) {char buf[BUFSIZ ]; -int ch, last_ch, quote_ch, next_ch; +int ch, last_ch, quote_ch, next_ch, read_ch, peek_ch;int i =0 ;int tok_size =0 ;enum tep_event_type type; *tok =NULL ; - - ch =__read_char (); + ch =__read_char ();if (ch <0 ) -return TEP_EVENT_NONE ; + goto out_eof_error; type =get_type (ch);if (type ==TEP_EVENT_NONE )
@@ -1184,9 +1183,15 @@ static enum tep_event_type __read_token(char **tok)case TEP_EVENT_OP :switch (ch) {case '-' : - next_ch =peek_char (); + peek_ch =peek_char (); +if (peek_ch <0 ) + goto out_eof_error; + next_ch = peek_ch;if (next_ch =='>' ) { - buf[i++] =__read_char (); + read_ch =__read_char (); +if (read_ch <0 ) + goto out_eof_error; + buf[i++] = read_ch;break ; }/* fall through */
@@ -1197,9 +1202,14 @@ static enum tep_event_type __read_token(char **tok)case '<' : last_ch = ch; ch =peek_char (); +if (ch <0 ) + goto out_eof_error;if (ch != last_ch) goto test_equal; - buf[i++] =__read_char (); + read_ch =__read_char (); +if (read_ch <0 ) + goto out_eof_error; + buf[i++] = read_ch;switch (last_ch) {case '>' :case '<' :
@@ -1219,10 +1229,17 @@ static enum tep_event_type __read_token(char **tok)return type; test_equal: - ch =peek_char (); -if (ch =='=' ) - buf[i++] =__read_char (); - goto out; + peek_ch =peek_char (); +if (peek_ch <0 ) + goto out_eof_error; + ch = peek_ch; +if (ch =='=' ) { + read_ch =__read_char (); +if (read_ch <0 ) + goto out_eof_error; + buf[i++] = read_ch; + goto out; + }case TEP_EVENT_DQUOTE :case TEP_EVENT_SQUOTE :
@@ -1242,6 +1259,8 @@ static enum tep_event_type __read_token(char **tok) } last_ch = ch; ch =__read_char (); +if (ch <0 ) + goto out_eof_error; buf[i++] = ch;/* the '\' '\' will cancel itself */ if (ch =='\\' && last_ch =='\\' )
@@ -1259,6 +1278,8 @@ static enum tep_event_type __read_token(char **tok)do { ch =__read_char (); +if (ch <0 ) +return TEP_EVENT_NONE ; }while (isspace (ch));if (ch =='"' ) goto concat;
@@ -1273,7 +1294,13 @@ static enum tep_event_type __read_token(char **tok)break ; } -while (get_type (peek_char ()) == type) { +while (1 ) { + peek_ch =peek_char (); +if (peek_ch <0 ) + goto out_eof_error; +if (get_type (peek_ch) != type) +break ; +if (i == (BUFSIZ -1 )) { buf[i] =0 ; tok_size +=BUFSIZ ;
@@ -1282,8 +1309,10 @@ static enum tep_event_type __read_token(char **tok)return TEP_EVENT_NONE ; i =0 ; } - ch =__read_char (); - buf[i++] = ch; + read_ch =__read_char (); +if (read_ch <0 ) + goto out_eof_error; + buf[i++] = read_ch; } out:
@@ -1316,6 +1345,11 @@ static enum tep_event_type __read_token(char **tok) }return type; + +out_eof_error: +free (*tok); + *tok =NULL ; +return TEP_EVENT_NONE ; }static enum tep_event_type force_token (const char *str,char **tok)
Signature · 1 line
2.32.0.288.g62a8d224e6-goog
PATCH 2/2 libtraceevent: Changed angled brackets to double quotes.
Certain build systems, such as bazel, are picky about angled brackets vs double quotes.
the failure you see when building is:
In file included from src/event-parse.c:27:src/event-utils.h:13:10: error: 'event-parse.h' file not found with <angled> include; use "quotes" instead
#include <event-parse.h>
^~~~~~~~~~~~~~~
"event-parse.h"Arguably -iquote is more correct within the library build, hence bazel using it. The libtraceevent Makefile is using -I, hence this not being a problem for others.
--- src/event-utils.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
src/event-utils.h +1 -1
@@ -10,7 +10,7 @@#include <stdarg.h> #include <stdbool.h> -#include <event-parse.h> +#include "event-parse.h" void tep_warning (const char *fmt, ...);void tep_info (const char *fmt, ...);
Signature · 1 line
2.32.0.288.g62a8d224e6-goog
On Thu, 17 Jun 2021 19:43:25 +0000
Claire Jensen <[email protected]> wrote:
Hi Claire,
Thanks for sending the patches, I'll try to get some time to look at them (note, that I have a lot of other duties that I need to finish before I can get to this).
Quoted 4 lines
Added checking for
__read_charandpeek_charto make sure value is not at end of file.This issue was found while fuzz testing. One of the test cases created an infinite loop because
__read_tokenhad reached end of file. Checking was added to all cases where this may occur.
You don't need to fix this now, but for future reference, we follow the Linux guidelines on submitting patches which includes having line breaks at 74 (although I use 76) bytes, for the change log.
This makes the change logs easier to read.
Thanks!
-- Steve
Quoted 3 lines
Signed-off-by Claire Jensen <[email protected]>
Quoted 12 lines · On Thu, 17 Jun 2021 15:58:28 -0400 Steven Rostedt <[email protected]> wrote:
On Thu, 17 Jun 2021 19:43:25 +0000
Claire Jensen <[email protected]> wrote:Hi Claire,
Thanks for sending the patches, I'll try to get some time to look at them (note, that I have a lot of other duties that I need to finish before I can get to this).
Quoted 3 lines
Added checking for
__read_charandpeek_charto make sure value is not at end of file.
Quoted 8 lines
Quoted 1 line
This issue was found while fuzz testing. One of the test cases created an infinite loop because
__read_tokenhad reached end of file. Checking was added to all cases where this may occur.You don't need to fix this now, but for future reference, we follow the Linux guidelines on submitting patches which includes having line breaks at 74 (although I use 76) bytes, for the change log.
This makes the change logs easier to read.
I made the mistake of adding this patch and pushing it to a new release without running my test suite against it. It ended up breaking the parsing.
When running with --debug -N, I get:
[ftrace:branch] unexpected type 1
[sched:sched_switch] unknown op ''
[irq:irq_handler_exit] unexpected type 1
[timer:timer_start] unknown op ''
[kvm:vcpu_match_mmio] unexpected type 1
[kvm:kvm_wait_lapic_expire] unknown op ''
[kvm:kvm_vcpu_wakeup] unexpected type 1
[kvm:kvm_userspace_exit] unknown op ''
[kvm:kvm_pv_tlb_flush] unexpected type 1
[kvm:kvm_ple_window_update] unknown op ''
[kvm:kvm_pio] unknown op ''
[kvm:kvm_pic_set_irq] unknown op ''
[kvm:kvm_nested_vmrun] unexpected type 1
[kvm:kvm_nested_vmexit_inject] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_nested_vmexit] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_nested_vmenter_failed] bad op token
[kvm:kvm_msr] unexpected type 1
[kvm:kvm_msi_set_irq] unknown op ''
unknown op ''
[kvm:kvm_ioapic_set_irq] unknown op ''
Error: expected type 5 but read 0
unknown op ''
[kvm:kvm_ioapic_delayed_eoi_inj] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_exit] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_emulate_insn] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_cpuid] unexpected type 1
unknown op ''
[kvm:kvm_apic_ipi] unknown op ''
Error: expected type 5 but read 0
unknown op ''
[kvm:kvm_apic_accept_irq] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_age_page] unexpected type 1
with the patch, and no errors without it.
I have to revert this patch and push a new version out.
-- Steve
Quoted 22 lines · Steven Rostedt
Quoted 18 lines · On Thu, 17 Jun 2021 15:58:28 -0400 Steven Rostedt <[email protected]> wrote:
On Thu, 17 Jun 2021 19:43:25 +0000
Claire Jensen <[email protected]> wrote:Hi Claire,
Thanks for sending the patches, I'll try to get some time to look at them (note, that I have a lot of other duties that I need to finish before I can get to this).
Quoted 4 lines
Added checking for
__read_charandpeek_charto make sure value is not at end of file.This issue was found while fuzz testing. One of the test cases created an infinite loop because
__read_tokenhad reached end of file. Checking was added to all cases where this may occur.You don't need to fix this now, but for future reference, we follow the Linux guidelines on submitting patches which includes having line breaks at 74 (although I use 76) bytes, for the change log.
Quoted 7 lines
Quoted 2 lines
This makes the change logs easier to read.
I made the mistake of adding this patch and pushing it to a new release without running my test suite against it. It ended up breaking the parsing.
When running with --debug -N, I get:
Hi Steve,
sorry for the breakage, could you give a full reproduction command?
Thanks!
Ian
Quoted 44 lines
[ftrace:branch] unexpected type 1
[sched:sched_switch] unknown op ''
[irq:irq_handler_exit] unexpected type 1
[timer:timer_start] unknown op ''
[kvm:vcpu_match_mmio] unexpected type 1
[kvm:kvm_wait_lapic_expire] unknown op ''
[kvm:kvm_vcpu_wakeup] unexpected type 1
[kvm:kvm_userspace_exit] unknown op ''
[kvm:kvm_pv_tlb_flush] unexpected type 1
[kvm:kvm_ple_window_update] unknown op ''
[kvm:kvm_pio] unknown op ''
[kvm:kvm_pic_set_irq] unknown op ''
[kvm:kvm_nested_vmrun] unexpected type 1
[kvm:kvm_nested_vmexit_inject] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_nested_vmexit] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_nested_vmenter_failed] bad op token
[kvm:kvm_msr] unexpected type 1
[kvm:kvm_msi_set_irq] unknown op ''
unknown op ''
[kvm:kvm_ioapic_set_irq] unknown op ''
Error: expected type 5 but read 0
unknown op ''
[kvm:kvm_ioapic_delayed_eoi_inj] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_exit] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_emulate_insn] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_cpuid] unexpected type 1
unknown op ''
[kvm:kvm_apic_ipi] unknown op ''
Error: expected type 5 but read 0
unknown op ''
[kvm:kvm_apic_accept_irq] unknown op ''
Error: expected type 5 but read 0
[kvm:kvm_age_page] unexpected type 1with the patch, and no errors without it.
I have to revert this patch and push a new version out.
-- Steve
Quoted 3 lines · On Wed, 23 Jun 2021 22:50:58 -0700 Ian Rogers <[email protected]> wrote:
Hi Steve,
sorry for the breakage, could you give a full reproduction command?
You can download this: http://rostedt.org/private/trace-issue.dat
And run trace-cmd report --debug on it, and you'll see that it fails to parse with the patch, but works fine without it.
-- Steve