cxl/acpi: Annotate struct cxl_cxims_data with __counted_by
PATCH 1/1 cxl/acpi: Annotate struct cxl_cxims_data with __counted_by
Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).
As found with Coccinelle[1], add __counted_by for struct cxl_cxims_data. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.
[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci
--- drivers/cxl/acpi.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/cxl/acpi.c +2 -2
@@ -14,7 +14,7 @@struct cxl_cxims_data {int nr_maps; -u64 xormaps[]; + u64 xormaps[] __counted_by(nr_maps); };/*
@@ -112,9 +112,9 @@ static int cxl_parse_cxims(union acpi_subtable_headers *header, void *arg, GFP_KERNEL);if (!cximsd)return -ENOMEM ; + cximsd->nr_maps = nr_maps;memcpy (cximsd->xormaps, cxims->xormap_list, nr_maps *sizeof (*cximsd->xormaps)); - cximsd->nr_maps = nr_maps; cxlrd->platform_data = cximsd;return 0 ;
Signature · 1 line
2.34.1
Quoted 12 lines · Kees Cook
Prepare for the coming implementation by GCC and Clang of the
__counted_byattribute. Flexible array members annotated with__counted_bycan have their accesses bounds-checked at run-time checking viaCONFIG_UBSAN_BOUNDS(for array indexing) andCONFIG_FORTIFY_SOURCE(for strcpy/memcpy-family functions).As found with Coccinelle[1], add
__counted_byfor structcxl_cxims_data. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci
Quoted 9 lines
Cc Davidlohr Bueso <[email protected]>Cc Jonathan Cameron <[email protected]>Cc Dave Jiang <[email protected]>Cc Alison Schofield <[email protected]>Cc Vishal Verma <[email protected]>Cc Ira Weiny <[email protected]>Cc Dan Williams <[email protected]>Signed-off-by Kees Cook <[email protected]>
Quoted 28 lines
--- drivers/cxl/acpi.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/cxl/acpi.c +2
-2@@ -14,7 +14,7 @@struct cxl_cxims_data {int nr_maps; -u64 xormaps[]; + u64 xormaps[] __counted_by(nr_maps); };/* @@ -112,9 +112,9 @@ static int cxl_parse_cxims(union acpi_subtable_headers *header, void *arg, GFP_KERNEL);if (!cximsd)return -ENOMEM ; + cximsd->nr_maps = nr_maps;memcpy (cximsd->xormaps, cxims->xormap_list, nr_maps *sizeof (*cximsd->xormaps)); - cximsd->nr_maps = nr_maps; cxlrd->platform_data = cximsd;return 0 ;
Quoted 21 lines · Kees Cook
Prepare for the coming implementation by GCC and Clang of the
__counted_byattribute. Flexible array members annotated with__counted_bycan have their accesses bounds-checked at run-time checking viaCONFIG_UBSAN_BOUNDS(for array indexing) andCONFIG_FORTIFY_SOURCE(for strcpy/memcpy-family functions).As found with Coccinelle[1], add
__counted_byfor structcxl_cxims_data. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci
Cc Davidlohr Bueso <[email protected]>Cc Jonathan Cameron <[email protected]>Cc Dave Jiang <[email protected]>Cc Alison Schofield <[email protected]>Cc Vishal Verma <[email protected]>Cc Ira Weiny <[email protected]>Cc Dan Williams <[email protected]>Signed-off-by Kees Cook <[email protected]>
Quoted 3 lines
---
drivers/cxl/acpi.c | 4 ++--1 file changed, 2 insertions(+), 2 deletions(-)
Quoted 25 lines
drivers/cxl/acpi.c +0
-0@@ -14,7 +14,7 @@
structcxl_cxims_data{
intnr_maps;
- u64 xormaps[];
+ u64 xormaps[]__counted_by(nr_maps);
};
/*drivers/cxl/acpi.c +1
-1@@ -112,9 +112,9 @@ static int cxl_parse_cxims(union acpi_subtable_headers *header, void *arg, GFP_KERNEL); if (!cximsd) return -ENOMEM; + cximsd->nr_maps = nr_maps; memcpy(cximsd->xormaps, cxims->xormap_list, nr_maps * sizeof(*cximsd->xormaps)); - cximsd->nr_maps = nr_maps; cxlrd->platform_data = cximsd;
return 0;
Quoted 12 lines · Kees Cook
Prepare for the coming implementation by GCC and Clang of the
__counted_byattribute. Flexible array members annotated with__counted_bycan have their accesses bounds-checked at run-time checking viaCONFIG_UBSAN_BOUNDS(for array indexing) andCONFIG_FORTIFY_SOURCE(for strcpy/memcpy-family functions).As found with Coccinelle[1], add
__counted_byfor structcxl_cxims_data. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci
Quoted 9 lines
Cc Davidlohr Bueso <[email protected]>Cc Jonathan Cameron <[email protected]>Cc Dave Jiang <[email protected]>Cc Alison Schofield <[email protected]>Cc Vishal Verma <[email protected]>Cc Ira Weiny <[email protected]>Cc Dan Williams <[email protected]>Signed-off-by Kees Cook <[email protected]>
Thanks
--
Gustavo
Quoted 32 lines
--- drivers/cxl/acpi.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/cxl/acpi.c +2
-2@@ -14,7 +14,7 @@struct cxl_cxims_data {int nr_maps; -u64 xormaps[]; + u64 xormaps[] __counted_by(nr_maps); };/* @@ -112,9 +112,9 @@ static int cxl_parse_cxims(union acpi_subtable_headers *header, void *arg, GFP_KERNEL);if (!cximsd)return -ENOMEM ; + cximsd->nr_maps = nr_maps;memcpy (cximsd->xormaps, cxims->xormap_list, nr_maps *sizeof (*cximsd->xormaps)); - cximsd->nr_maps = nr_maps; cxlrd->platform_data = cximsd;return 0 ;Signature · 1 line
2.34.1
Quoted 9 lines · Kees Cook
Prepare for the coming implementation by GCC and Clang of the
__counted_byattribute. Flexible array members annotated with__counted_bycan have their accesses bounds-checked at run-time checking viaCONFIG_UBSAN_BOUNDS(for array indexing) andCONFIG_FORTIFY_SOURCE(for strcpy/memcpy-family functions).As found with Coccinelle[1], add
__counted_byfor structcxl_cxims_data. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.
Nice.
Quoted 43 lines
[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci
Cc Davidlohr Bueso <[email protected]>Cc Jonathan Cameron <[email protected]>Cc Dave Jiang <[email protected]>Cc Alison Schofield <[email protected]>Cc Vishal Verma <[email protected]>Cc Ira Weiny <[email protected]>Cc Dan Williams <[email protected]>Signed-off-by Kees Cook <[email protected]>---
drivers/cxl/acpi.c| 4 ++--1 file changed, 2 insertions(+), 2 deletions(-)drivers/cxl/acpi.c +2
-3@@ -14,7 +14,7 @@struct cxl_cxims_data {int nr_maps; -u64 xormaps[]; + u64 xormaps[] __counted_by(nr_maps); };/* @@ -112,9 +112,9 @@ static int cxl_parse_cxims(union acpi_subtable_headers *header, void *arg, GFP_KERNEL);if (!cximsd)return -ENOMEM ; + cximsd->nr_maps = nr_maps;memcpy (cximsd->xormaps, cxims->xormap_list, nr_maps *sizeof (*cximsd->xormaps)); - cximsd->nr_maps = nr_maps; cxlrd->platform_data = cximsd;return 0 ; --2.34.1
Quoted 13 lines · Kees Cook
Prepare for the coming implementation by GCC and Clang of the
__counted_byattribute. Flexible array members annotated with__counted_bycan have their accesses bounds-checked at run-time checking viaCONFIG_UBSAN_BOUNDS(for array indexing) andCONFIG_FORTIFY_SOURCE(for strcpy/memcpy-family functions).As found with Coccinelle[1], add
__counted_byfor structcxl_cxims_data. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci
Quoted 9 lines
Cc Davidlohr Bueso <[email protected]>Cc Jonathan Cameron <[email protected]>Cc Dave Jiang <[email protected]>Cc Alison Schofield <[email protected]>Cc Vishal Verma <[email protected]>Cc Ira Weiny <[email protected]>Cc Dan Williams <[email protected]>Signed-off-by Kees Cook <[email protected]>
Looks good.
The reordering of the count assignment is crucial here otherwise the runtime checks will trip when cximsd->xormaps is used as memcpy destination.
Quoted 32 lines
--- drivers/cxl/acpi.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/cxl/acpi.c +2
-3@@ -14,7 +14,7 @@struct cxl_cxims_data {int nr_maps; -u64 xormaps[]; + u64 xormaps[] __counted_by(nr_maps); };/* @@ -112,9 +112,9 @@ static int cxl_parse_cxims(union acpi_subtable_headers *header, void *arg, GFP_KERNEL);if (!cximsd)return -ENOMEM ; + cximsd->nr_maps = nr_maps;memcpy (cximsd->xormaps, cxims->xormap_list, nr_maps *sizeof (*cximsd->xormaps)); - cximsd->nr_maps = nr_maps; cxlrd->platform_data = cximsd;return 0 ; --2.34.1