Skip to contentSkip to conversation

block: initialize auto integrity buffer opaque

PATCH In review Caleb Sander Mateos 3 participants 4 messages Jan 8 Block layer

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 block: initialize auto integrity buffer opaque

The auto-generated integrity buffer for writes needs to be fully initialized before being passed to the underlying block device, otherwise the uninitialized memory can be read back by userspace or anyone with physical access to the storage device. If protection information is generated, that portion of the integrity buffer will be initialized. The integrity buffer is also zeroed if PI generation is disabled via sysfs or the PI tuple size is 0. However, this misses the case where the PI is generated and the PI tuple size is nonzero, but the metadata size is larger than the PI tuple. In this case, the remainder ("opaque") of the metadata is left uninitialized.
Generalize the BLK_INTEGRITY_CSUM_NONE check to cover any case when the metadata is larger than just the PI tuple.
Switch the gfp_t variable to bool zero_buffer since it's only used to compute the zero_buffer argument to bio_integrity_alloc_buf().

Fixes c546d6f43833 ("block: only zero non-PI metadata tuples in bio_integrity_prep")
---
 block/bio-integrity-auto.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
block/bio-integrity-auto.c +6 -5
index 9850c338548d..605403b52c90 100644
@@ -107,11 +107,11 @@ bool __bio_integrity_endio(struct bio *bio)
 bool bio_integrity_prep(struct bio *bio)
 {
 	struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 	struct bio_integrity_data *bid;
 	bool set_flags = true;
-	gfp_t gfp = GFP_NOIO;
+	bool zero_buffer = false;
 
 	if (!bi)
 		return true;
 
 	if (!bio_sectors(bio))
@@ -137,13 +137,14 @@ bool bio_integrity_prep(struct bio *bio)
 		 */
 		if (bi->flags & BLK_INTEGRITY_NOGENERATE) {
 			if (bi_offload_capable(bi))
 				return true;
 			set_flags = false;
-			gfp |= __GFP_ZERO;
-		} else if (bi->csum_type == BLK_INTEGRITY_CSUM_NONE)
-			gfp |= __GFP_ZERO;
+			zero_buffer = true;
+		} else {
+			zero_buffer = bi->metadata_size > bi->pi_tuple_size;
+		}
 		break;
 	default:
 		return true;
 	}
 
@@ -152,11 +153,11 @@ bool bio_integrity_prep(struct bio *bio)
 
 	bid = mempool_alloc(&bid_pool, GFP_NOIO);
 	bio_integrity_init(bio, &bid->bip, &bid->bvec, 1);
 	bid->bio = bio;
 	bid->bip.bip_flags |= BIP_BLOCK_INTEGRITY;
-	bio_integrity_alloc_buf(bio, gfp & __GFP_ZERO);
+	bio_integrity_alloc_buf(bio, zero_buffer);
 
 	bip_set_seed(&bid->bip, bio->bi_iter.bi_sector);
 
 	if (set_flags) {
 		if (bi->csum_type == BLK_INTEGRITY_CSUM_IP)
Signature · 1 line
2.45.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 15 lines

The auto-generated integrity buffer for writes needs to be fully initialized before being passed to the underlying block device, otherwise the uninitialized memory can be read back by userspace or anyone with physical access to the storage device. If protection information is generated, that portion of the integrity buffer will be initialized. The integrity buffer is also zeroed if PI generation is disabled via sysfs or the PI tuple size is 0. However, this misses the case where the PI is generated and the PI tuple size is nonzero, but the metadata size is larger than the PI tuple. In this case, the remainder ("opaque") of the metadata is left uninitialized.
Generalize the BLK_INTEGRITY_CSUM_NONE check to cover any case when the metadata is larger than just the PI tuple.
Switch the gfp_t variable to bool zero_buffer since it's only used to compute the zero_buffer argument to bio_integrity_alloc_buf().

Quoted 2 lines
Fixes c546d6f43833 ("block: only zero non-PI metadata tuples in bio_integrity_prep")

Makes sense. Thanks for posting the fix.

#2 lore raw
In reply to Caleb Sander Mateos

The subject sounds a little weird. From looking at the commit message and the code change I'd expect it to be something like:

block: zero auto integrity buffer when not fully occupied by PI tuple

does that make sense?

Quoted 2 lines

Switch the gfp_t variable to bool zero_buffer since it's only used to compute the zero_buffer argument to bio_integrity_alloc_buf().

Yeah, that also makes total sense now. But maybe split it into a separate cleanup patch to not detract from the bug fix?

#3 lore raw
Quoted 7 lines · Christoph Hellwig

The subject sounds a little weird. From looking at the commit message and the code change I'd expect it to be something like:

block: zero auto integrity buffer when not fully occupied by PI tuple

does that make sense?

Yes, that sounds fine. "opaque" is how the FS_IOC_GETLBMD_CAP ioctl refers to the non-PI metadata, but I guess it's not widely used terminology?

Quoted 6 lines
Quoted 3 lines

Switch the gfp_t variable to bool zero_buffer since it's only used to compute the zero_buffer argument to bio_integrity_alloc_buf().

Yeah, that also makes total sense now. But maybe split it into a separate cleanup patch to not detract from the bug fix?

Sure.

Thanks,
Caleb