perf tools: Replace zero-length array with flexible-array
PATCH 1/1 perf tools: Replace zero-length array with flexible-array
The current codebase makes use of the zero-length array language extension to the C90 standard, but the preferred mechanism to declare variable-length types such as these ones is a flexible array member[1][2], introduced in C99:
struct foo {
int stuff;
struct boo array[];
};By making use of the mechanism above, we will get a compiler warning in case the flexible array does not occur last in the structure, which will help us prevent some kind of undefined behavior bugs from being inadvertently introduced[3] to the codebase from now on.
Also, notice that, dynamic memory allocations won't be affected by this change:
"Flexible array members have incomplete type, and so the sizeof operator may not be applied. As a quirk of the original implementation of zero-length arrays, sizeof evaluates to zero."[1]
sizeof(flexible-array-member) triggers a warning because flexible array members have incomplete type[1]. There are some instances of code in which the sizeof operator is being incorrectly/erroneously applied to zero-length arrays and the result is zero. Such instances may be hiding some bugs. So, this work (flexible-array member conversions) will also help to get completely rid of those sorts of issues.
This issue was found with the help of Coccinelle.
[1] https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
[2] https://github.com/KSPP/linux/issues/21
[3] commit 76497732932f ("cxgb3/l2t: Fix undefined behaviour")
--- tools/perf/bench/sched-messaging.c | 2 +- tools/perf/builtin-inject.c | 2 +- tools/perf/builtin-script.c | 2 +- tools/perf/builtin-timechart.c | 2 +- tools/perf/util/annotate.h | 4 ++-- tools/perf/util/branch.h | 2 +- tools/perf/util/cputopo.h | 2 +- tools/perf/util/dso.h | 4 ++-- tools/perf/util/event.h | 2 +- tools/perf/util/jitdump.c | 2 +- tools/perf/util/jitdump.h | 6 +++--- tools/perf/util/ordered-events.h | 2 +- tools/perf/util/pstack.c | 2 +- tools/perf/util/symbol.h | 2 +- tools/perf/util/unwind-libunwind-local.c | 2 +- 15 files changed, 19 insertions(+), 19 deletions(-)
tools/perf/bench/sched-messaging.c +1 -1
@@ -40,7 +40,7 @@ struct sender_context {unsigned int num_fds;int ready_out;int wakefd; -int out_fds[0 ]; +int out_fds[]; };struct receiver_context {
tools/perf/builtin-inject.c +1 -1
@@ -51,7 +51,7 @@ struct perf_inject {struct event_entry {struct list_head node;u32 tid; -union perf_event event[0 ]; +union perf_event event[]; };static int output_bytes (struct perf_inject *inject,void *buf,size_t sz)
tools/perf/builtin-script.c +1 -1
@@ -2619,7 +2619,7 @@ static int __cmd_script(struct perf_script *script)struct script_spec {struct list_head node;struct scripting_ops *ops; -char spec[0 ]; +char spec[]; };static LIST_HEAD (script_specs);
tools/perf/builtin-timechart.c +1 -1
@@ -128,7 +128,7 @@ struct sample_wrapper {struct sample_wrapper *next;u64 timestamp; -unsigned char data[0 ]; +unsigned char data[]; };#define TYPE_NONE 0
tools/perf/util/annotate.h +2 -2
@@ -144,7 +144,7 @@ struct annotation_line {u32 idx;int idx_asm;int data_nr; -struct annotation_data data[0 ]; +struct annotation_data data[]; };struct disasm_line {
@@ -227,7 +227,7 @@ void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);struct sym_hist {u64 nr_samples;u64 period; -struct sym_hist_entry addr[0 ]; +struct sym_hist_entry addr[]; };struct cyc_hist {
tools/perf/util/branch.h +1 -1
@@ -41,7 +41,7 @@ struct branch_entry {struct branch_stack {u64 nr;u64 hw_idx; -struct branch_entry entries[0 ]; +struct branch_entry entries[]; };/*
tools/perf/util/cputopo.h +1 -1
@@ -22,7 +22,7 @@ struct numa_topology_node {struct numa_topology {u32 nr; -struct numa_topology_node nodes[0 ]; +struct numa_topology_node nodes[]; };struct cpu_topology *cpu_topology__new (void );
tools/perf/util/dso.h +2 -2
@@ -136,7 +136,7 @@ struct dso_cache {struct rb_node rb_node;u64 offset;u64 size; -char data[0 ]; +char data[]; };struct auxtrace_cache ;
@@ -208,7 +208,7 @@ struct dso {struct nsinfo *nsinfo;struct dso_id id;refcount_t refcnt; -char name[0 ]; +char name[]; };/* dso__for_each_symbol - iterate over the symbols of given type
tools/perf/util/event.h +1 -1
@@ -79,7 +79,7 @@ struct sample_read {struct ip_callchain {u64 nr; -u64 ips[0 ]; +u64 ips[]; };struct branch_stack ;
tools/perf/util/jitdump.c +1 -1
@@ -57,7 +57,7 @@ struct debug_line_info {unsigned long vma;unsigned int lineno;/* The filename format is unspecified, absolute path, relative etc. */ -char const filename[0 ]; +char const filename[]; };struct jit_tool {
tools/perf/util/jitdump.h +3 -3
@@ -93,7 +93,7 @@ struct debug_entry {uint64_t addr;int lineno;/* source line number starting at 1 */ int discrim;/* column discriminator, 0 is default */ -const char name[0 ];/* null terminated filename, \xff\0 if same as previous entry */ +const char name[];/* null terminated filename, \xff\0 if same as previous entry */ };struct jr_code_debug_info {
@@ -101,7 +101,7 @@ struct jr_code_debug_info {uint64_t code_addr;uint64_t nr_entry; -struct debug_entry entries[0 ]; +struct debug_entry entries[]; };struct jr_code_unwinding_info {
@@ -110,7 +110,7 @@ struct jr_code_unwinding_info {uint64_t unwinding_size;uint64_t eh_frame_hdr_size;uint64_t mapped_size; -const char unwinding_data[0 ]; +const char unwinding_data[]; };union jr_entry {
tools/perf/util/ordered-events.h +1 -1
@@ -29,7 +29,7 @@ typedef int (*ordered_events__deliver_t)(struct ordered_events *oe,struct ordered_events_buffer {struct list_head list; -struct ordered_event event[0 ]; +struct ordered_event event[]; };struct ordered_events {
tools/perf/util/pstack.c +1 -1
@@ -15,7 +15,7 @@struct pstack {unsigned short top;unsigned short max_nr_entries; -void *entries[0 ]; +void *entries[]; };struct pstack *pstack__new (unsigned short max_nr_entries)
tools/perf/util/symbol.h +1 -1
@@ -55,7 +55,7 @@ struct symbol { u8 inlined:1;u8 arch_sym;bool annotate2; -char name[0 ]; +char name[]; };void symbol__delete (struct symbol *sym);
tools/perf/util/unwind-libunwind-local.c +1 -1
@@ -243,7 +243,7 @@ struct eh_frame_hdr {* encoded_t fde_addr; * } binary_search_table[fde_count]; */ -char data[0 ]; +char data[]; } __packed; static int unwind_spec_ehframe(struct dso *dso, struct machine *machine,
Signature · 1 line
2.26.2
Arnaldo Melo
AppliedQuoted 24 lines · Gustavo A. R. Silva
The current codebase makes use of the zero-length array language extension to the C90 standard, but the preferred mechanism to declare variable-length types such as these ones is a flexible array member[1][2],
introduced in C99:struct foo { int stuff; struct boo array[]; };By making use of the mechanism above, we will get a compiler warning in case the flexible array does not occur last in the structure, which will help us prevent some kind of undefined behavior bugs from being inadvertently introduced[3] to the codebase from now on.
Also, notice that, dynamic memory allocations won't be affected by this change:
"Flexible array members have incomplete type, and so the sizeof operator
may not be applied. As a quirk of the original implementation of zero-length arrays, sizeof evaluates to zero."[1]
Quoted 8 lines
sizeof(flexible-array-member) triggers a warning because flexible array members have incomplete type[1]. There are some instances of code in which the sizeof operator is being incorrectly/erroneously applied to zero-length arrays and the result is zero. Such instances may be hiding some bugs. So, this work (flexible-array member conversions) will also help to get completely rid of those sorts of issues.
This issue was found with the help of Coccinelle.
Thanks, applied
- Arnaldo
Quoted 266 lines
[1] https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
[2] https://github.com/KSPP/linux/issues/21
[3] commit76497732932f("cxgb3/l2t: Fix undefined behaviour")Signed-off-by Gustavo A. R. Silva <[email protected]>---
tools/perf/bench/sched-messaging.c | 2 +- tools/perf/builtin-inject.c | 2 +- tools/perf/builtin-script.c | 2 +- tools/perf/builtin-timechart.c | 2 +- tools/perf/util/annotate.h | 4 ++-- tools/perf/util/branch.h | 2 +- tools/perf/util/cputopo.h | 2 +- tools/perf/util/dso.h | 4 ++-- tools/perf/util/event.h | 2 +- tools/perf/util/jitdump.c | 2 +- tools/perf/util/jitdump.h | 6 +++--- tools/perf/util/ordered-events.h | 2 +- tools/perf/util/pstack.c | 2 +- tools/perf/util/symbol.h | 2 +- tools/perf/util/unwind-libunwind-local.c | 2 +- 15 files changed, 19 insertions(+), 19 deletions(-)tools/perf/bench/sched-messaging.c +1
-1@@ -40,7 +40,7 @@ struct sender_context {unsigned int num_fds;int ready_out;int wakefd; -int out_fds[0 ]; +int out_fds[]; };struct receiver_context {tools/perf/builtin-inject.c +1
-1@@ -51,7 +51,7 @@ struct perf_inject {struct event_entry {struct list_head node;u32 tid; -union perf_event event[0 ]; +union perf_event event[]; };static int
output_bytes(struct perf_inject *inject, void *buf, size_t sz)tools/perf/builtin-script.c +1
-1@@ -2619,7 +2619,7 @@ static int __cmd_script(struct perf_script *script)struct script_spec {struct list_head node;struct scripting_ops *ops; -char spec[0 ]; +char spec[]; };static
LIST_HEAD(script_specs);tools/perf/builtin-timechart.c +1
-1@@ -128,7 +128,7 @@ struct sample_wrapper {struct sample_wrapper *next;u64 timestamp; -unsigned char data[0 ]; +unsigned char data[]; };#define TYPE_NONE 0tools/perf/util/annotate.h +2
-2@@ -144,7 +144,7 @@ struct annotation_line {u32 idx;int idx_asm;int data_nr; -struct annotation_data data[0 ]; +struct annotation_data data[]; };struct disasm_line {@@ -227,7 +227,7 @@ void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);struct sym_hist {u64 nr_samples;u64 period; -struct sym_hist_entry addr[0 ]; +struct sym_hist_entry addr[]; };struct
cyc_hist{tools/perf/util/branch.h +1
-1@@ -41,7 +41,7 @@ struct branch_entry {struct branch_stack {u64 nr;u64 hw_idx; -struct branch_entry entries[0 ]; +struct branch_entry entries[]; };/* tools/perf/util/cputopo.h +1
-1@@ -22,7 +22,7 @@ struct numa_topology_node {struct numa_topology {u32 nr; -struct numa_topology_node nodes[0 ]; +struct numa_topology_node nodes[]; };struct cpu_topology *cpu_topology__new (void );tools/perf/util/dso.h +2
-2@@ -136,7 +136,7 @@ struct dso_cache {struct rb_node rb_node;u64 offset;u64 size; -char data[0 ]; +char data[]; };struct auxtrace_cache ;@@ -208,7 +208,7 @@ struct dso {struct nsinfo *nsinfo;struct dso_id id;refcount_t refcnt; -char name[0 ]; +char name[]; };/* dso__for_each_symbol - iterate over the symbols of given type tools/perf/util/event.h +1
-1@@ -79,7 +79,7 @@ struct sample_read {struct ip_callchain {u64 nr; -u64 ips[0 ]; +u64 ips[]; };struct branch_stack ;tools/perf/util/jitdump.c +1
-1@@ -57,7 +57,7 @@ struct debug_line_info {unsigned long vma;unsigned int lineno;/* The filename format is unspecified, absolute path, relative etc. */ -char const filename[0 ]; +char const filename[]; };struct jit_tool {tools/perf/util/jitdump.h +0
-1@@ -93,7 +93,7 @@ struct debug_entry {uint64_t addr;int lineno;/* source line number starting at 1 */ int discrim;/* column discriminator, 0 is default */ -const char name[0 ];/* null terminated filename, \xff\0 if same as previous entry */
tools/perf/util/jitdump.h +1
-0+const char name[];/* null terminated filename, \xff\0 if same as previous entry */
};struct
jr_code_debug_info{tools/perf/util/jitdump.h +2
-2@@ -101,7 +101,7 @@ struct jr_code_debug_info {uint64_t code_addr;uint64_t nr_entry; -struct debug_entry entries[0 ]; +struct debug_entry entries[]; };struct jr_code_unwinding_info {@@ -110,7 +110,7 @@ struct jr_code_unwinding_info {uint64_t unwinding_size;uint64_t eh_frame_hdr_size;uint64_t mapped_size; -const char unwinding_data[0 ]; +const char unwinding_data[]; };union jr_entry {tools/perf/util/ordered-events.h +1
-1@@ -29,7 +29,7 @@ typedef int (*ordered_events__deliver_t)(struct ordered_events *oe, struct ordered_events_buffer {struct list_head list; -struct ordered_event event[0 ]; +struct ordered_event event[]; };struct
ordered_events{tools/perf/util/pstack.c +1
-1@@ -15,7 +15,7 @@struct pstack {unsigned short top;unsigned short max_nr_entries; -void *entries[0 ]; +void *entries[]; };struct pstack *pstack__new (unsigned short max_nr_entries)tools/perf/util/symbol.h +1
-1@@ -55,7 +55,7 @@ struct symbol { u8 inlined:1;u8 arch_sym;bool annotate2; -char name[0 ]; +char name[]; };void symbol__delete (struct symbol *sym);tools/perf/util/unwind-libunwind-local.c +1
-1@@ -243,7 +243,7 @@ struct eh_frame_hdr {* encoded_t fde_addr; * } binary_search_table[fde_count]; */ -char data[0 ]; +char data[]; } __packed;static int unwind_spec_ehframe(struct dso *dso, struct machine *machine,
Signature · 1 line
Sent from my Android device with K-9 Mail. Please excuse my brevity.
Quoted 3 lines · Arnaldo Melo
Thanks, applied
Thanks, Arnaldo.
I wonder if could also take the other two:
https://lore.kernel.org/lkml/20200511200911.GA13149@embeddedor/
https://lore.kernel.org/lkml/20200511201227.GA14041@embeddedor/
--
Gustavo
Peter Zijlstra
maintainerQuoted 11 lines · Gustavo A. R. Silva
Quoted 3 lines · Arnaldo Melo
Thanks, applied
Thanks, Arnaldo.
I wonder if could also take the other two:
https://lore.kernel.org/lkml/20200511200911.GA13149@embeddedor/
https://lore.kernel.org/lkml/20200511201227.GA14041@embeddedor/
I think I have those, but let me make sure.
Quoted 6 lines · Peter Zijlstra
Quoted 5 lines · Gustavo A. R. Silva
Quoted 3 lines · Arnaldo Melo
Thanks, applied
Quoted 8 lines
Quoted 6 lines
Thanks, Arnaldo.
I wonder if could also take the other two:
https://lore.kernel.org/lkml/20200511200911.GA13149@embeddedor/
https://lore.kernel.org/lkml/20200511201227.GA14041@embeddedor/I think I have those, but let me make sure.
Great. :)
Thanks
--
Gustavo
Ian Rogers
reviewerQuoted 10 lines · Gustavo A. R. Silva
Quoted 8 lines · Peter Zijlstra
Quoted 7 lines · Gustavo A. R. Silva
Quoted 3 lines · Arnaldo Melo
Thanks, applied
Thanks, Arnaldo.
Quoted 8 lines
Quoted 6 lines
Quoted 4 lines
I wonder if could also take the other two:
https://lore.kernel.org/lkml/20200511200911.GA13149@embeddedor/
https://lore.kernel.org/lkml/20200511201227.GA14041@embeddedor/I think I have those, but let me make sure.
Great. :)
Thanks for the cleanup! It has yielded a clang compiler warning/error for me in kernel/git/acme/linux.git branch perf/core:
util/intel-pt.c:1802:24: error: field 'br_stack' with variable sized type 'struct branch_stack' not
at the end of a struct or class is a GNU extension [-Werror,-Wgnu-variable-sized-type-not-at-end]
struct branch_stack br_stack;
I think this can be resolved by reordering the members of the struct, and may have been a latent bug exposed by this change. It's unfortunate it has broken this build.
Thanks,
Ian
Quoted 4 lines
Thanks
--
Gustavo
Quoted 29 lines · Ian Rogers
Quoted 10 lines · Gustavo A. R. Silva
Quoted 8 lines · Peter Zijlstra
Quoted 7 lines · Gustavo A. R. Silva
Quoted 3 lines · Arnaldo Melo
Thanks, applied
Thanks, Arnaldo.
Quoted 8 lines
Quoted 6 lines
Quoted 4 lines
I wonder if could also take the other two:
https://lore.kernel.org/lkml/20200511200911.GA13149@embeddedor/
https://lore.kernel.org/lkml/20200511201227.GA14041@embeddedor/I think I have those, but let me make sure.
Great. :)
Thanks for the cleanup! It has yielded a clang compiler warning/error for me in
kernel/git/acme/linux.gitbranch perf/core:
util/intel-pt.c:1802:24: error: field 'br_stack' with variable sized type 'structbranch_stack' not
at the end of a struct or class is a GNU extension [-Werror,-Wgnu-variable-sized-type-not-at-end]
Quoted 6 lines
struct branch_stack br_stack;I think this can be resolved by reordering the members of the struct, and may have been a latent bug exposed by this change. It's unfortunate it has broken this build.
Yep. The following should resolve the issue:
tools/perf/util/intel-pt.c +1 -1
@@ -1799,8 +1799,8 @@ static int intel_pt_synth_pebs_sample(struct intel_pt_queue *ptq)if (sample_type &PERF_SAMPLE_BRANCH_STACK ) {struct { -struct branch_stack br_stack;struct branch_entry entries[LBRS_MAX ]; +struct branch_stack br_stack; } br; if (items->mask[INTEL_PT_LBR_0_POS] ||
I'll send a proper patch.
Thanks for the report!
--
Gustavo