Skip to contentSkip to conversation

virt: acrn: Annotate struct vm_memory_region_batch with __counted_by

PATCH Applied Kees Cook 2 participants 3 messages Sep 22, 2023 – Oct 6, 2023 Acrn hypervisor service module

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 virt: acrn: Annotate struct vm_memory_region_batch 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 vm_memory_region_batch. 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/virt/acrn/acrn_drv.h | 2 +-
 drivers/virt/acrn/mm.c       | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
drivers/virt/acrn/acrn_drv.h +1 -1
index 5663c17ad37c..fb8438094f6f 100644
@@ -60,7 +60,7 @@ struct vm_memory_region_batch {
 	u16			   reserved[3];
 	u32			   regions_num;
 	u64			   regions_gpa;
-	struct vm_memory_region_op regions_op[];
+	struct vm_memory_region_op regions_op[] __counted_by(regions_num);
 };
 
 /**
drivers/virt/acrn/mm.c +1 -1
index b4ad8d452e9a..fa5d9ca6be57 100644
@@ -250,11 +250,11 @@ int acrn_vm_ram_map(struct acrn_vm *vm, struct acrn_vm_memmap *memmap)
 		ret = -ENOMEM;
 		goto unmap_kernel_map;
 	}
+	regions_info->regions_num = nr_regions;
 
 	/* Fill each vm_memory_region_op */
 	vm_region = regions_info->regions_op;
 	regions_info->vmid = vm->vmid;
-	regions_info->regions_num = nr_regions;
 	regions_info->regions_gpa = virt_to_phys(vm_region);
 	user_vm_pa = memmap->user_vm_pa;
 	i = 0;
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Kees Cook

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).

Quoted 8 lines

As found with Coccinelle[1], add __counted_by for struct vm_memory_region_batch. 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

Thanks

Signature · 1 line
Gustavo
Quoted 35 lines
---
  drivers/virt/acrn/acrn_drv.h | 2 +-
  drivers/virt/acrn/mm.c       | 2 +-
  2 files changed, 2 insertions(+), 2 deletions(-)
drivers/virt/acrn/acrn_drv.h +1 -1
index 5663c17ad37c..fb8438094f6f 100644
@@ -60,7 +60,7 @@ struct vm_memory_region_batch {
  	u16			   reserved[3];
  	u32			   regions_num;
  	u64			   regions_gpa;
-	struct vm_memory_region_op regions_op[];
+	struct vm_memory_region_op regions_op[] __counted_by(regions_num);
  };
 
  /**
drivers/virt/acrn/mm.c +1 -1
index b4ad8d452e9a..fa5d9ca6be57 100644
@@ -250,11 +250,11 @@ int acrn_vm_ram_map(struct acrn_vm *vm, struct acrn_vm_memmap *memmap)
  		ret = -ENOMEM;
  		goto unmap_kernel_map;
  	}
+	regions_info->regions_num = nr_regions;
 
  	/* Fill each vm_memory_region_op */
  	vm_region = regions_info->regions_op;
  	regions_info->vmid = vm->vmid;
-	regions_info->regions_num = nr_regions;
  	regions_info->regions_gpa = virt_to_phys(vm_region);
  	user_vm_pa = memmap->user_vm_pa;
  	i = 0;
author Applied
#2 lore raw
In reply to Kees Cook
Quoted 11 lines · Kees Cook

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 vm_memory_region_batch. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

[...]

Applied to for-next/hardening, thanks!

[1/1] virt: acrn: Annotate struct vm_memory_region_batch with __counted_by

      https://git.kernel.org/kees/c/1a38cf8d8ae7

Take care,

Signature · 1 line
Kees Cook