ceph: Annotate struct ceph_monmap with __counted_by
Subsystems (3)
PATCH 1/1 ceph: Annotate struct ceph_monmap 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 ceph_monmap. 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
--- include/linux/ceph/mon_client.h | 2 +- net/ceph/mon_client.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
include/linux/ceph/mon_client.h +1 -1
@@ -19,7 +19,7 @@ struct ceph_monmap {struct ceph_fsid fsid;u32 epoch;u32 num_mon; -struct ceph_entity_inst mon_inst[]; + struct ceph_entity_inst mon_inst[] __counted_by(num_mon); };struct ceph_mon_client ;
net/ceph/mon_client.c +1 -1
@@ -1136,6 +1136,7 @@ static int build_initial_monmap(struct ceph_mon_client *monc) GFP_KERNEL);if (!monc->monmap)return -ENOMEM ; + monc->monmap->num_mon = num_mon;for (i =0 ; i < num_mon; i++) {struct ceph_entity_inst *inst = &monc->monmap->mon_inst[i];
@@ -1147,7 +1148,6 @@ static int build_initial_monmap(struct ceph_mon_client *monc) inst->name.type =CEPH_ENTITY_TYPE_MON ; inst->name.num =cpu_to_le64 (i); } - monc->monmap->num_mon = num_mon;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 structceph_monmap. 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 10 lines
Cc Ilya Dryomov <[email protected]>Cc Xiubo Li <[email protected]>Cc Jeff Layton <[email protected]>Cc "David S. Miller" <[email protected]>Cc Eric Dumazet <[email protected]>Cc Jakub Kicinski <[email protected]>Cc Paolo Abeni <[email protected]>Signed-off-by Kees Cook <[email protected]>
Thanks
Signature · 1 line
Gustavo
Quoted 38 lines
--- include/linux/ceph/mon_client.h | 2 +- net/ceph/mon_client.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)include/linux/ceph/mon_client.h +1
-1@@ -19,7 +19,7 @@ struct ceph_monmap {struct ceph_fsid fsid;u32 epoch;u32 num_mon; -struct ceph_entity_inst mon_inst[]; + struct ceph_entity_inst mon_inst[] __counted_by(num_mon); };struct ceph_mon_client ;net/ceph/mon_client.c +1
-1@@ -1136,6 +1136,7 @@ static int build_initial_monmap(struct ceph_mon_client *monc) GFP_KERNEL);if (!monc->monmap)return -ENOMEM ; + monc->monmap->num_mon = num_mon;for (i =0 ; i < num_mon; i++) {struct ceph_entity_inst *inst = &monc->monmap->mon_inst[i];@@ -1147,7 +1148,6 @@ static int build_initial_monmap(struct ceph_mon_client *monc) inst->name.type =CEPH_ENTITY_TYPE_MON ; inst->name.num =cpu_to_le64 (i); } - monc->monmap->num_mon = num_mon;return 0 ; }
Quoted 53 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 structceph_monmap. 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 Ilya Dryomov <[email protected]>Cc Xiubo Li <[email protected]>Cc Jeff Layton <[email protected]>Cc "David S. Miller" <[email protected]>Cc Eric Dumazet <[email protected]>Cc Jakub Kicinski <[email protected]>Cc Paolo Abeni <[email protected]>Signed-off-by Kees Cook <[email protected]>--- include/linux/ceph/mon_client.h | 2 +- net/ceph/mon_client.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)include/linux/ceph/mon_client.h +1
-1@@ -19,7 +19,7 @@ struct ceph_monmap {struct ceph_fsid fsid;u32 epoch;u32 num_mon; -struct ceph_entity_inst mon_inst[]; + struct ceph_entity_inst mon_inst[] __counted_by(num_mon); };struct ceph_mon_client ;net/ceph/mon_client.c +1
-0@@ -1136,6 +1136,7 @@ static int build_initial_monmap(struct ceph_mon_client *monc) GFP_KERNEL);if (!monc->monmap)return -ENOMEM ; + monc->monmap->num_mon = num_mon;for (i =0 ; i < num_mon; i++) {struct ceph_entity_inst *inst = &monc->monmap->mon_inst[i];
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1150
Quoted 4 lines
net/ceph/mon_client.c +0
-1@@ -1147,7 +1148,6 @@ static int build_initial_monmap(struct ceph_mon_client *monc) inst->name.type =CEPH_ENTITY_TYPE_MON ; inst->name.num =cpu_to_le64 (i); } - monc->monmap->num_mon = num_mon;
BTW, is this change related ?
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1153
Quoted 3 lines
net/ceph/mon_client.c +0
-0return 0 ; }
Else LGTM.
Thanks!
- Xiubo
Quoted 17 lines · Xiubo Li
Quoted 15 lines · Kees Cook
[...]
Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.[...]
net/ceph/mon_client.c +1
-0@@ -1136,6 +1136,7 @@ static int build_initial_monmap(struct ceph_mon_client *monc) GFP_KERNEL);if (!monc->monmap)return -ENOMEM ; + monc->monmap->num_mon = num_mon;for (i =0 ; i < num_mon; i++) {
Quoted 8 lines
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1150
Quoted 6 lines
net/ceph/mon_client.c +0
-1struct ceph_entity_inst *inst = &monc->monmap->mon_inst[i];@@ -1147,7 +1148,6 @@ static int build_initial_monmap(struct ceph_mon_client *monc) inst->name.type =CEPH_ENTITY_TYPE_MON ; inst->name.num =cpu_to_le64 (i); } - monc->monmap->num_mon = num_mon;BTW, is this change related ?
Yes, this is needed so that the __counted_by size is set before accessing the flexible array.
Quoted 8 lines
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1153
Quoted 4 lines
net/ceph/mon_client.c +0
-0return 0 ; }Else LGTM.
Reviewed-by Xiubo Li <[email protected]>
Thanks!
Signature · 1 line
Kees Cook
Quoted 51 lines · Xiubo Li
Quoted 49 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 structceph_monmap. 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 Ilya Dryomov <[email protected]>Cc Xiubo Li <[email protected]>Cc Jeff Layton <[email protected]>Cc "David S. Miller" <[email protected]>Cc Eric Dumazet <[email protected]>Cc Jakub Kicinski <[email protected]>Cc Paolo Abeni <[email protected]>Signed-off-by Kees Cook <[email protected]>---
include/linux/ceph/mon_client.h| 2 +-
net/ceph/mon_client.c | 2 +-2 files changed, 2 insertions(+), 2 deletions(-)include/linux/ceph/mon_client.h +1
-1@@ -19,7 +19,7 @@ struct ceph_monmap { struct ceph_fsid fsid; u32 epoch; u32 num_mon; - struct ceph_entity_inst mon_inst[]; + struct ceph_entity_inst mon_inst[] __counted_by(num_mon); }; struct ceph_mon_client;net/ceph/mon_client.c +1
-0@@ -1136,6 +1136,7 @@ static int build_initial_monmap(struct ceph_mon_client *monc) GFP_KERNEL); if (!monc->monmap) return -ENOMEM; + monc->monmap->num_mon = num_mon; for (i = 0; i < num_mon; i++) {
Quoted 8 lines
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1150
Quoted 6 lines
net/ceph/mon_client.c +0
-1struct ceph_entity_inst *inst = &monc->monmap->mon_inst[i];@@ -1147,7 +1148,6 @@ static int build_initial_monmap(struct ceph_mon_client *monc) inst->name.type = CEPH_ENTITY_TYPE_MON; inst->name.num = cpu_to_le64(i); } - monc->monmap->num_mon = num_mon;BTW, is this change related ?
Yes, it is, and it's described in the changelog text.
num_mon must be updated before the first access to flex-array mon_inst. Otherwise the compiler cannot properly instrument the code to catch any out-of-bounds access to mon_inst.
--
Gustavo
Quoted 13 lines
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1152
Quoted 3 lines
net/ceph/mon_client.c +0
-0return 0; }Else LGTM.
Reviewed-by Xiubo Li <[email protected]>Thanks!
- Xiubo
Quoted 65 lines · Gustavo A. R. Silva
Quoted 53 lines · Xiubo Li
Quoted 51 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 structceph_monmap. 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 Ilya Dryomov <[email protected]>Cc Xiubo Li <[email protected]>Cc Jeff Layton <[email protected]>Cc "David S. Miller" <[email protected]>Cc Eric Dumazet <[email protected]>Cc Jakub Kicinski <[email protected]>Cc Paolo Abeni <[email protected]>Signed-off-by Kees Cook <[email protected]>---
include/linux/ceph/mon_client.h| 2 +-
net/ceph/mon_client.c | 2 +-2 files changed, 2 insertions(+), 2 deletions(-)include/linux/ceph/mon_client.h +1
-1@@ -19,7 +19,7 @@ struct ceph_monmap { struct ceph_fsid fsid; u32 epoch; u32 num_mon; - struct ceph_entity_inst mon_inst[]; + struct ceph_entity_inst mon_inst[] __counted_by(num_mon); }; struct ceph_mon_client;net/ceph/mon_client.c +1
-0@@ -1136,6 +1136,7 @@ static int build_initial_monmap(struct ceph_mon_client *monc) GFP_KERNEL); if (!monc->monmap) return -ENOMEM; + monc->monmap->num_mon = num_mon; for (i = 0; i < num_mon; i++) { struct ceph_entity_inst *inst = &monc->monmap->mon_inst[i];Quoted 8 lines
net/ceph/mon_client.c static int build_initial_monmap(struct · line 1151
Quoted 6 lines
net/ceph/mon_client.c +0
-1@@ -1147,7 +1148,6 @@ static int build_initial_monmap(struct ceph_mon_client *monc) inst->name.type = CEPH_ENTITY_TYPE_MON; inst->name.num = cpu_to_le64(i); } - monc->monmap->num_mon = num_mon;BTW, is this change related ?
Quoted 6 lines
Yes, it is, and it's described in the changelog text.
num_monmust be updated before the first access to flex-arraymon_inst. Otherwise the compiler cannot properly instrument the code to catch any out-of-bounds access tomon_inst.
Okay, got it.
Thanks
- Xiubo
Quoted 17 lines
Signature · 1 line
GustavoQuoted 13 lines
net/ceph/mon_client.c static int build_initial_monmap(struct ceph_mon_client *monc) · line 1152
Quoted 3 lines
net/ceph/mon_client.c +0
-0return 0; }Else LGTM.
Reviewed-by Xiubo Li <[email protected]>Thanks!
- Xiubo
This patch was applied to netdev/net-next.git (main) by David S. Miller <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (main) by David S. Miller <[email protected]>:
Quoted 11 lines · On Fri, 15 Sep 2023 13:15:10 -0700 you wrote:
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 structceph_monmap. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.[...]
Here is the summary with links:
- ceph: Annotate struct ceph_monmap with __counted_by
https://git.kernel.org/netdev/net-next/c/1cb6422ecac8
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html