qcow2: Rewrite qcow2_alloc_bytes()
PATCH v2 1/1 qcow2: Rewrite qcow2_alloc_bytes()
qcow2_alloc_bytes() is a function with insufficient error handling and an unnecessary goto. This patch rewrites it.
---
v2:
- s/free_cluster_index/free_byte_index/ [Eric]
- added an assertion at the start of the function that s->free_byte_offset is either 0 or points to the tail of a cluster (but never to the start)
- use ROUND_UP() instead of start_of_cluster() + cluster_size [Eric]
- added an assertion that s->free_byte_offset is set before using it [Eric]
--- block/qcow2-refcount.c | 77 +++++++++++++++++++++++++++++--------------------- 1 file changed, 45 insertions(+), 32 deletions(-)
block/qcow2-refcount.c +45 -32
@@ -759,46 +759,51 @@ int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset,int64_t qcow2_alloc_bytes (BlockDriverState *bs,int size) {BDRVQcowState *s = bs->opaque; -int64_t offset, cluster_offset; -int free_in_cluster; +int64_t offset, new_cluster =0 , cluster_end; +size_t free_in_cluster;BLKDBG_EVENT (bs->file,BLKDBG_CLUSTER_ALLOC_BYTES );assert (size >0 && size <= s->cluster_size); -if (s->free_byte_offset ==0 ) { - offset =qcow2_alloc_clusters (bs, s->cluster_size); -if (offset <0 ) { -return offset; +assert (!s->free_byte_offset ||offset_into_cluster (s, s->free_byte_offset)); + +if (s->free_byte_offset) { +int refcount =qcow2_get_refcount (bs, + s->free_byte_offset >> s->cluster_bits); +if (refcount <0 ) { +return refcount; + } + +if (refcount ==0xffff ) { + s->free_byte_offset =0 ; } - s->free_byte_offset = offset; } - redo: + free_in_cluster = s->cluster_size -offset_into_cluster (s, s->free_byte_offset); -if (size <= free_in_cluster) { -/* enough space in current cluster */ - offset = s->free_byte_offset; - s->free_byte_offset += size; - free_in_cluster -= size; -if (free_in_cluster ==0 ) - s->free_byte_offset =0 ; -if (offset_into_cluster (s, offset) !=0 ) -qcow2_update_cluster_refcount (bs, offset >> s->cluster_bits,1 , -QCOW2_DISCARD_NEVER ); - }else { - offset =qcow2_alloc_clusters (bs, s->cluster_size); -if (offset <0 ) { -return offset; + +if (!s->free_byte_offset || free_in_cluster < size) { + new_cluster =qcow2_alloc_clusters (bs, s->cluster_size); +if (new_cluster <0 ) { +return new_cluster; + } + + cluster_end =ROUND_UP (s->free_byte_offset, s->cluster_size); +if (!s->free_byte_offset || cluster_end != new_cluster) { + s->free_byte_offset = new_cluster; } - cluster_offset =start_of_cluster (s, s->free_byte_offset); -if ((cluster_offset + s->cluster_size) == offset) { -/* we are lucky: contiguous data */ - offset = s->free_byte_offset; -qcow2_update_cluster_refcount (bs, offset >> s->cluster_bits,1 , -QCOW2_DISCARD_NEVER ); - s->free_byte_offset += size; - }else { - s->free_byte_offset = offset; - goto redo; + } + +assert (s->free_byte_offset); +if (offset_into_cluster (s, s->free_byte_offset)) { +int ret =qcow2_update_cluster_refcount (bs, + s->free_byte_offset >> s->cluster_bits,1 , +QCOW2_DISCARD_NEVER ); +if (ret <0 ) { +if (new_cluster >0 ) { +qcow2_free_clusters (bs, new_cluster, s->cluster_size, +QCOW2_DISCARD_OTHER ); + } +return ret; } }
@@ -807,6 +812,14 @@ int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size)* be flushed before the caller's L2 table updates. */ qcow2_cache_set_dependency (bs, s->l2_table_cache, s->refcount_block_cache); + + offset = s->free_byte_offset; + + s->free_byte_offset += size; +if (!offset_into_cluster (s, s->free_byte_offset)) { + s->free_byte_offset =0 ; + } +return offset; }
Signature · 1 line
2.1.0
Quoted 4 lines · Max Reitz
qcow2_alloc_bytes()is a function with insufficient error handling and an unnecessary goto. This patch rewrites it.Signed-off-by Max Reitz <[email protected]>
Quoted 9 lines
---
v2:
- s/free_cluster_index/free_byte_index/ [Eric]
- added an assertion at the start of the function thats->free_byte_offsetis either 0 or points to the tail of a cluster (but never to the start)
- useROUND_UP()instead ofstart_of_cluster()+cluster_size[Eric]
- added an assertion thats->free_byte_offsetis set before using it [Eric]
Looks nicer.
block/qcow2-refcount.c int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, · line 791
Quoted 2 lines
block/qcow2-refcount.c +2
-0+ cluster_end =ROUND_UP (s->free_byte_offset, s->cluster_size); +if (!s->free_byte_offset || cluster_end != new_cluster) {
Here, I can prove that the left side of the || makes no difference to the outcome (using just the right half is sufficient, since !s->free_byte_offset implies cluster_end == 0, but new_cluster will be non-zero because we never allocate the header cluster). I'd be fine if you wanted to respin that and add the comment for the micro-optimized shorter code; but for maintenance purposes, it's easier to rely on the explicit condition (even if redundant) than to think about whether a proof listed in a comment is correct, so I'm also fine leaving things as is.
Quoted 1 line
+
s->free_byte_offset=new_cluster;
At this point, s->free_byte_offset violates the precondition if we just allocated a cluster, so we have to make sure that we restore the precondition before exiting...
block/qcow2-refcount.c int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, · line 806
Quoted 10 lines
block/qcow2-refcount.c +10
-0+if (offset_into_cluster (s, s->free_byte_offset)) { +int ret =qcow2_update_cluster_refcount (bs, + s->free_byte_offset >> s->cluster_bits,1 , +QCOW2_DISCARD_NEVER ); +if (ret <0 ) { +if (new_cluster >0 ) { +qcow2_free_clusters (bs, new_cluster, s->cluster_size, +QCOW2_DISCARD_OTHER ); + } +return ret;
...this early exit only happens if s->free_byte_offset was pointing to a tail, and there are no other early exits, with the final exit properly restoring the precondition.
Signature · 2 lines
Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
Am 05.02.2015 um 16:58 hat Max Reitz geschrieben:
Quoted 61 lines
qcow2_alloc_bytes()is a function with insufficient error handling and an unnecessary goto. This patch rewrites it.Signed-off-by Max Reitz <[email protected]>---
v2:
- s/free_cluster_index/free_byte_index/ [Eric]
- added an assertion at the start of the function thats->free_byte_offsetis either 0 or points to the tail of a cluster (but never to the start)
- useROUND_UP()instead ofstart_of_cluster()+cluster_size[Eric]
- added an assertion thats->free_byte_offsetis set before using it [Eric]--- block/qcow2-refcount.c | 77 +++++++++++++++++++++++++++++--------------------- 1 file changed, 45 insertions(+), 32 deletions(-)block/qcow2-refcount.c +14
-15@@ -759,46 +759,51 @@ int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset,int64_t qcow2_alloc_bytes (BlockDriverState *bs,int size) {BDRVQcowState *s = bs->opaque; -int64_t offset, cluster_offset; -int free_in_cluster; +int64_t offset, new_cluster =0 , cluster_end; +size_t free_in_cluster;BLKDBG_EVENT (bs->file,BLKDBG_CLUSTER_ALLOC_BYTES );assert (size >0 && size <= s->cluster_size); -if (s->free_byte_offset ==0 ) { - offset =qcow2_alloc_clusters (bs, s->cluster_size); -if (offset <0 ) { -return offset; +assert (!s->free_byte_offset ||offset_into_cluster (s, s->free_byte_offset)); + +if (s->free_byte_offset) { +int refcount =qcow2_get_refcount (bs, + s->free_byte_offset >> s->cluster_bits); +if (refcount <0 ) { +return refcount; + } + +if (refcount ==0xffff ) { + s->free_byte_offset =0 ; } - s->free_byte_offset = offset; } - redo: + free_in_cluster = s->cluster_size -offset_into_cluster (s, s->free_byte_offset); -if (size <= free_in_cluster) { -/* enough space in current cluster */ - offset = s->free_byte_offset; - s->free_byte_offset += size; - free_in_cluster -= size; -if (free_in_cluster ==0 ) - s->free_byte_offset =0 ;
block/qcow2-refcount.c int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, · line 785
Quoted 10 lines
block/qcow2-refcount.c +3
-7-if (offset_into_cluster (s, offset) !=0 ) -qcow2_update_cluster_refcount (bs, offset >> s->cluster_bits,1 , -QCOW2_DISCARD_NEVER ); - }else { - offset =qcow2_alloc_clusters (bs, s->cluster_size); -if (offset <0 ) { -return offset; + +if (!s->free_byte_offset || free_in_cluster < size) { + new_cluster =qcow2_alloc_clusters (bs, s->cluster_size);
The code could perhaps become a bit nicer if you used alloc_clusters_noref() here...
Quoted 12 lines
block/qcow2-refcount.c +7
-4+if (new_cluster <0 ) { +return new_cluster; + } + + cluster_end =ROUND_UP (s->free_byte_offset, s->cluster_size); +if (!s->free_byte_offset || cluster_end != new_cluster) { + s->free_byte_offset = new_cluster; } - cluster_offset =start_of_cluster (s, s->free_byte_offset); -if ((cluster_offset + s->cluster_size) == offset) { -/* we are lucky: contiguous data */ - offset = s->free_byte_offset;
block/qcow2-refcount.c int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, · line 797
Quoted 10 lines
block/qcow2-refcount.c +4
-6-qcow2_update_cluster_refcount (bs, offset >> s->cluster_bits,1 , -QCOW2_DISCARD_NEVER ); - s->free_byte_offset += size; - }else { - s->free_byte_offset = offset; - goto redo; + } + +assert (s->free_byte_offset); +if (offset_into_cluster (s, s->free_byte_offset)) {
...because this block could become unconditional then, ...
block/qcow2-refcount.c int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, · line 800
Quoted 3 lines
block/qcow2-refcount.c +3
-0+int ret =qcow2_update_cluster_refcount (bs, + s->free_byte_offset >> s->cluster_bits,1 , +QCOW2_DISCARD_NEVER );
...here you could use update_refcount() with the actual byte count (which also avoids two unnecessary shifts)...
block/qcow2-refcount.c int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, · line 805
Quoted 5 lines
block/qcow2-refcount.c +5
-0+if (ret <0 ) { +if (new_cluster >0 ) { +qcow2_free_clusters (bs, new_cluster, s->cluster_size, +QCOW2_DISCARD_OTHER ); + }
...and this part wouldn't be needed because update_refcount() already tries to fail atomically.
block/qcow2-refcount.c int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size) · line 813
Quoted 7 lines
block/qcow2-refcount.c +1
-0+return ret; } }@@ -807,6 +812,14 @@ int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size)* be flushed before the caller's L2 table updates. */
It would also simplify the two lines of this comment that aren't in the patch context any more. ;-)
block/qcow2-refcount.c int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size) · line 824
Quoted 11 lines
block/qcow2-refcount.c +8
-0qcow2_cache_set_dependency (bs, s->l2_table_cache, s->refcount_block_cache); + + offset = s->free_byte_offset; + + s->free_byte_offset += size; +if (!offset_into_cluster (s, s->free_byte_offset)) { + s->free_byte_offset =0 ; + } +return offset; }
The patch looks correct to me. Let me know if you'd like to address the point I made above, or if I should apply it as it is.
Kevin
Quoted 18 lines · Kevin Wolf
Am 05.02.2015 um 16:58 hat Max Reitz geschrieben:
Quoted 17 lines
qcow2_alloc_bytes()is a function with insufficient error handling and an unnecessary goto. This patch rewrites it.Signed-off-by Max Reitz <[email protected]>---
v2:
- s/free_cluster_index/free_byte_index/ [Eric]
- added an assertion at the start of the function thats->free_byte_offsetis either 0 or points to the tail of a cluster (but never to the start)
- useROUND_UP()instead ofstart_of_cluster()+cluster_size[Eric]
- added an assertion thats->free_byte_offsetis set before using it [Eric]--- block/qcow2-refcount.c | 77 +++++++++++++++++++++++++++++--------------------- 1 file changed, 45 insertions(+), 32 deletions(-)
[snip]
Quoted 2 lines
The patch looks correct to me. Let me know if you'd like to address the point I made above, or if I should apply it as it is.
Good question. On one hand, I like your suggestion because it would indeed make the code shorter. On the other hand, I somehow feel better using functions that are prefixed qcow2_* because I feel like it might make the code harder to read if sometimes we use qcow2_alloc_clusters() and alloc_clusters_noref() at other times; and sometimes we use qcow2_update_cluster_refcount() and update_refcount() at other times.
But then again, it might make sense to have this function mirror qcow2_alloc_clusters(), which does use alloc_clusters_noref() and update_refcount() (of course).
So I think I'll go with your suggestion, thanks!
Max