2 * Block driver for the QCOW version 2 format
4 * Copyright (c) 2004-2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "qemu-common.h"
25 #include "block_int.h"
31 Differences with QCOW:
33 - Support for multiple incremental snapshots.
34 - Memory management by reference counts.
35 - Clusters which have a reference count of one have the bit
36 QCOW_OFLAG_COPIED to optimize write performance.
37 - Size of compressed clusters is stored in sectors to reduce bit usage
38 in the cluster offsets.
39 - Support for storing additional data (such as the VM state) in the
41 - If a backing store is used, the cluster size is not constrained
42 (could be backported to QCOW).
43 - L2 tables have always a size of one cluster.
47 //#define DEBUG_ALLOC2
49 #define QCOW_MAGIC (('Q' << 24) | ('F' << 16) | ('I' << 8) | 0xfb)
50 #define QCOW_VERSION 2
52 #define QCOW_CRYPT_NONE 0
53 #define QCOW_CRYPT_AES 1
55 #define QCOW_MAX_CRYPT_CLUSTERS 32
57 /* indicate that the refcount of the referenced cluster is exactly one. */
58 #define QCOW_OFLAG_COPIED (1LL << 63)
59 /* indicate that the cluster is compressed (they never have the copied flag) */
60 #define QCOW_OFLAG_COMPRESSED (1LL << 62)
62 #define REFCOUNT_SHIFT 1 /* refcount size is 2 bytes */
64 typedef struct QCowHeader
{
67 uint64_t backing_file_offset
;
68 uint32_t backing_file_size
;
69 uint32_t cluster_bits
;
70 uint64_t size
; /* in bytes */
71 uint32_t crypt_method
;
72 uint32_t l1_size
; /* XXX: save number of clusters instead ? */
73 uint64_t l1_table_offset
;
74 uint64_t refcount_table_offset
;
75 uint32_t refcount_table_clusters
;
76 uint32_t nb_snapshots
;
77 uint64_t snapshots_offset
;
80 typedef struct __attribute__((packed
)) QCowSnapshotHeader
{
81 /* header is 8 byte aligned */
82 uint64_t l1_table_offset
;
91 uint64_t vm_clock_nsec
;
93 uint32_t vm_state_size
;
94 uint32_t extra_data_size
; /* for extension */
95 /* extra data follows */
100 #define L2_CACHE_SIZE 16
102 typedef struct QCowSnapshot
{
103 uint64_t l1_table_offset
;
107 uint32_t vm_state_size
;
110 uint64_t vm_clock_nsec
;
113 typedef struct BDRVQcowState
{
114 BlockDriverState
*hd
;
121 int l1_vm_state_index
;
124 uint64_t cluster_offset_mask
;
125 uint64_t l1_table_offset
;
128 uint64_t l2_cache_offsets
[L2_CACHE_SIZE
];
129 uint32_t l2_cache_counts
[L2_CACHE_SIZE
];
130 uint8_t *cluster_cache
;
131 uint8_t *cluster_data
;
132 uint64_t cluster_cache_offset
;
134 uint64_t *refcount_table
;
135 uint64_t refcount_table_offset
;
136 uint32_t refcount_table_size
;
137 uint64_t refcount_block_cache_offset
;
138 uint16_t *refcount_block_cache
;
139 int64_t free_cluster_index
;
140 int64_t free_byte_offset
;
142 uint32_t crypt_method
; /* current crypt method, 0 if no key yet */
143 uint32_t crypt_method_header
;
144 AES_KEY aes_encrypt_key
;
145 AES_KEY aes_decrypt_key
;
146 uint64_t snapshots_offset
;
149 QCowSnapshot
*snapshots
;
152 static int decompress_cluster(BDRVQcowState
*s
, uint64_t cluster_offset
);
153 static int qcow_read(BlockDriverState
*bs
, int64_t sector_num
,
154 uint8_t *buf
, int nb_sectors
);
155 static int qcow_read_snapshots(BlockDriverState
*bs
);
156 static void qcow_free_snapshots(BlockDriverState
*bs
);
157 static int refcount_init(BlockDriverState
*bs
);
158 static void refcount_close(BlockDriverState
*bs
);
159 static int get_refcount(BlockDriverState
*bs
, int64_t cluster_index
);
160 static int update_cluster_refcount(BlockDriverState
*bs
,
161 int64_t cluster_index
,
163 static void update_refcount(BlockDriverState
*bs
,
164 int64_t offset
, int64_t length
,
166 static int64_t alloc_clusters(BlockDriverState
*bs
, int64_t size
);
167 static int64_t alloc_bytes(BlockDriverState
*bs
, int size
);
168 static void free_clusters(BlockDriverState
*bs
,
169 int64_t offset
, int64_t size
);
171 static void check_refcounts(BlockDriverState
*bs
);
174 static int qcow_probe(const uint8_t *buf
, int buf_size
, const char *filename
)
176 const QCowHeader
*cow_header
= (const void *)buf
;
178 if (buf_size
>= sizeof(QCowHeader
) &&
179 be32_to_cpu(cow_header
->magic
) == QCOW_MAGIC
&&
180 be32_to_cpu(cow_header
->version
) == QCOW_VERSION
)
186 static int qcow_open(BlockDriverState
*bs
, const char *filename
, int flags
)
188 BDRVQcowState
*s
= bs
->opaque
;
189 int len
, i
, shift
, ret
;
192 /* Performance is terrible right now with cache=writethrough due mainly
193 * to reference count updates. If the user does not explicitly specify
194 * a caching type, force to writeback caching.
196 if ((flags
& BDRV_O_CACHE_DEF
)) {
197 flags
|= BDRV_O_CACHE_WB
;
198 flags
&= ~BDRV_O_CACHE_DEF
;
200 ret
= bdrv_file_open(&s
->hd
, filename
, flags
);
203 if (bdrv_pread(s
->hd
, 0, &header
, sizeof(header
)) != sizeof(header
))
205 be32_to_cpus(&header
.magic
);
206 be32_to_cpus(&header
.version
);
207 be64_to_cpus(&header
.backing_file_offset
);
208 be32_to_cpus(&header
.backing_file_size
);
209 be64_to_cpus(&header
.size
);
210 be32_to_cpus(&header
.cluster_bits
);
211 be32_to_cpus(&header
.crypt_method
);
212 be64_to_cpus(&header
.l1_table_offset
);
213 be32_to_cpus(&header
.l1_size
);
214 be64_to_cpus(&header
.refcount_table_offset
);
215 be32_to_cpus(&header
.refcount_table_clusters
);
216 be64_to_cpus(&header
.snapshots_offset
);
217 be32_to_cpus(&header
.nb_snapshots
);
219 if (header
.magic
!= QCOW_MAGIC
|| header
.version
!= QCOW_VERSION
)
221 if (header
.size
<= 1 ||
222 header
.cluster_bits
< 9 ||
223 header
.cluster_bits
> 16)
225 if (header
.crypt_method
> QCOW_CRYPT_AES
)
227 s
->crypt_method_header
= header
.crypt_method
;
228 if (s
->crypt_method_header
)
230 s
->cluster_bits
= header
.cluster_bits
;
231 s
->cluster_size
= 1 << s
->cluster_bits
;
232 s
->cluster_sectors
= 1 << (s
->cluster_bits
- 9);
233 s
->l2_bits
= s
->cluster_bits
- 3; /* L2 is always one cluster */
234 s
->l2_size
= 1 << s
->l2_bits
;
235 bs
->total_sectors
= header
.size
/ 512;
236 s
->csize_shift
= (62 - (s
->cluster_bits
- 8));
237 s
->csize_mask
= (1 << (s
->cluster_bits
- 8)) - 1;
238 s
->cluster_offset_mask
= (1LL << s
->csize_shift
) - 1;
239 s
->refcount_table_offset
= header
.refcount_table_offset
;
240 s
->refcount_table_size
=
241 header
.refcount_table_clusters
<< (s
->cluster_bits
- 3);
243 s
->snapshots_offset
= header
.snapshots_offset
;
244 s
->nb_snapshots
= header
.nb_snapshots
;
246 /* read the level 1 table */
247 s
->l1_size
= header
.l1_size
;
248 shift
= s
->cluster_bits
+ s
->l2_bits
;
249 s
->l1_vm_state_index
= (header
.size
+ (1LL << shift
) - 1) >> shift
;
250 /* the L1 table must contain at least enough entries to put
252 if (s
->l1_size
< s
->l1_vm_state_index
)
254 s
->l1_table_offset
= header
.l1_table_offset
;
255 s
->l1_table
= qemu_malloc(s
->l1_size
* sizeof(uint64_t));
256 if (bdrv_pread(s
->hd
, s
->l1_table_offset
, s
->l1_table
, s
->l1_size
* sizeof(uint64_t)) !=
257 s
->l1_size
* sizeof(uint64_t))
259 for(i
= 0;i
< s
->l1_size
; i
++) {
260 be64_to_cpus(&s
->l1_table
[i
]);
263 s
->l2_cache
= qemu_malloc(s
->l2_size
* L2_CACHE_SIZE
* sizeof(uint64_t));
264 s
->cluster_cache
= qemu_malloc(s
->cluster_size
);
265 /* one more sector for decompressed data alignment */
266 s
->cluster_data
= qemu_malloc(QCOW_MAX_CRYPT_CLUSTERS
* s
->cluster_size
268 s
->cluster_cache_offset
= -1;
270 if (refcount_init(bs
) < 0)
273 /* read the backing file name */
274 if (header
.backing_file_offset
!= 0) {
275 len
= header
.backing_file_size
;
278 if (bdrv_pread(s
->hd
, header
.backing_file_offset
, bs
->backing_file
, len
) != len
)
280 bs
->backing_file
[len
] = '\0';
282 if (qcow_read_snapshots(bs
) < 0)
291 qcow_free_snapshots(bs
);
293 qemu_free(s
->l1_table
);
294 qemu_free(s
->l2_cache
);
295 qemu_free(s
->cluster_cache
);
296 qemu_free(s
->cluster_data
);
301 static int qcow_set_key(BlockDriverState
*bs
, const char *key
)
303 BDRVQcowState
*s
= bs
->opaque
;
307 memset(keybuf
, 0, 16);
311 /* XXX: we could compress the chars to 7 bits to increase
313 for(i
= 0;i
< len
;i
++) {
316 s
->crypt_method
= s
->crypt_method_header
;
318 if (AES_set_encrypt_key(keybuf
, 128, &s
->aes_encrypt_key
) != 0)
320 if (AES_set_decrypt_key(keybuf
, 128, &s
->aes_decrypt_key
) != 0)
330 AES_encrypt(in
, tmp
, &s
->aes_encrypt_key
);
331 AES_decrypt(tmp
, out
, &s
->aes_decrypt_key
);
332 for(i
= 0; i
< 16; i
++)
333 printf(" %02x", tmp
[i
]);
335 for(i
= 0; i
< 16; i
++)
336 printf(" %02x", out
[i
]);
343 /* The crypt function is compatible with the linux cryptoloop
344 algorithm for < 4 GB images. NOTE: out_buf == in_buf is
346 static void encrypt_sectors(BDRVQcowState
*s
, int64_t sector_num
,
347 uint8_t *out_buf
, const uint8_t *in_buf
,
348 int nb_sectors
, int enc
,
357 for(i
= 0; i
< nb_sectors
; i
++) {
358 ivec
.ll
[0] = cpu_to_le64(sector_num
);
360 AES_cbc_encrypt(in_buf
, out_buf
, 512, key
,
368 static int copy_sectors(BlockDriverState
*bs
, uint64_t start_sect
,
369 uint64_t cluster_offset
, int n_start
, int n_end
)
371 BDRVQcowState
*s
= bs
->opaque
;
377 ret
= qcow_read(bs
, start_sect
+ n_start
, s
->cluster_data
, n
);
380 if (s
->crypt_method
) {
381 encrypt_sectors(s
, start_sect
+ n_start
,
383 s
->cluster_data
, n
, 1,
384 &s
->aes_encrypt_key
);
386 ret
= bdrv_write(s
->hd
, (cluster_offset
>> 9) + n_start
,
393 static void l2_cache_reset(BlockDriverState
*bs
)
395 BDRVQcowState
*s
= bs
->opaque
;
397 memset(s
->l2_cache
, 0, s
->l2_size
* L2_CACHE_SIZE
* sizeof(uint64_t));
398 memset(s
->l2_cache_offsets
, 0, L2_CACHE_SIZE
* sizeof(uint64_t));
399 memset(s
->l2_cache_counts
, 0, L2_CACHE_SIZE
* sizeof(uint32_t));
402 static inline int l2_cache_new_entry(BlockDriverState
*bs
)
404 BDRVQcowState
*s
= bs
->opaque
;
408 /* find a new entry in the least used one */
410 min_count
= 0xffffffff;
411 for(i
= 0; i
< L2_CACHE_SIZE
; i
++) {
412 if (s
->l2_cache_counts
[i
] < min_count
) {
413 min_count
= s
->l2_cache_counts
[i
];
420 static int64_t align_offset(int64_t offset
, int n
)
422 offset
= (offset
+ n
- 1) & ~(n
- 1);
426 static int grow_l1_table(BlockDriverState
*bs
, int min_size
)
428 BDRVQcowState
*s
= bs
->opaque
;
429 int new_l1_size
, new_l1_size2
, ret
, i
;
430 uint64_t *new_l1_table
;
431 uint64_t new_l1_table_offset
;
434 new_l1_size
= s
->l1_size
;
435 if (min_size
<= new_l1_size
)
437 while (min_size
> new_l1_size
) {
438 new_l1_size
= (new_l1_size
* 3 + 1) / 2;
441 printf("grow l1_table from %d to %d\n", s
->l1_size
, new_l1_size
);
444 new_l1_size2
= sizeof(uint64_t) * new_l1_size
;
445 new_l1_table
= qemu_mallocz(new_l1_size2
);
446 memcpy(new_l1_table
, s
->l1_table
, s
->l1_size
* sizeof(uint64_t));
448 /* write new table (align to cluster) */
449 new_l1_table_offset
= alloc_clusters(bs
, new_l1_size2
);
451 for(i
= 0; i
< s
->l1_size
; i
++)
452 new_l1_table
[i
] = cpu_to_be64(new_l1_table
[i
]);
453 ret
= bdrv_pwrite(s
->hd
, new_l1_table_offset
, new_l1_table
, new_l1_size2
);
454 if (ret
!= new_l1_size2
)
456 for(i
= 0; i
< s
->l1_size
; i
++)
457 new_l1_table
[i
] = be64_to_cpu(new_l1_table
[i
]);
460 cpu_to_be32w((uint32_t*)data
, new_l1_size
);
461 cpu_to_be64w((uint64_t*)(data
+ 4), new_l1_table_offset
);
462 if (bdrv_pwrite(s
->hd
, offsetof(QCowHeader
, l1_size
), data
,
463 sizeof(data
)) != sizeof(data
))
465 qemu_free(s
->l1_table
);
466 free_clusters(bs
, s
->l1_table_offset
, s
->l1_size
* sizeof(uint64_t));
467 s
->l1_table_offset
= new_l1_table_offset
;
468 s
->l1_table
= new_l1_table
;
469 s
->l1_size
= new_l1_size
;
472 qemu_free(s
->l1_table
);
479 * seek l2_offset in the l2_cache table
480 * if not found, return NULL,
482 * increments the l2 cache hit count of the entry,
483 * if counter overflow, divide by two all counters
484 * return the pointer to the l2 cache entry
488 static uint64_t *seek_l2_table(BDRVQcowState
*s
, uint64_t l2_offset
)
492 for(i
= 0; i
< L2_CACHE_SIZE
; i
++) {
493 if (l2_offset
== s
->l2_cache_offsets
[i
]) {
494 /* increment the hit count */
495 if (++s
->l2_cache_counts
[i
] == 0xffffffff) {
496 for(j
= 0; j
< L2_CACHE_SIZE
; j
++) {
497 s
->l2_cache_counts
[j
] >>= 1;
500 return s
->l2_cache
+ (i
<< s
->l2_bits
);
509 * Loads a L2 table into memory. If the table is in the cache, the cache
510 * is used; otherwise the L2 table is loaded from the image file.
512 * Returns a pointer to the L2 table on success, or NULL if the read from
513 * the image file failed.
516 static uint64_t *l2_load(BlockDriverState
*bs
, uint64_t l2_offset
)
518 BDRVQcowState
*s
= bs
->opaque
;
522 /* seek if the table for the given offset is in the cache */
524 l2_table
= seek_l2_table(s
, l2_offset
);
525 if (l2_table
!= NULL
)
528 /* not found: load a new entry in the least used one */
530 min_index
= l2_cache_new_entry(bs
);
531 l2_table
= s
->l2_cache
+ (min_index
<< s
->l2_bits
);
532 if (bdrv_pread(s
->hd
, l2_offset
, l2_table
, s
->l2_size
* sizeof(uint64_t)) !=
533 s
->l2_size
* sizeof(uint64_t))
535 s
->l2_cache_offsets
[min_index
] = l2_offset
;
536 s
->l2_cache_counts
[min_index
] = 1;
544 * Allocate a new l2 entry in the file. If l1_index points to an already
545 * used entry in the L2 table (i.e. we are doing a copy on write for the L2
546 * table) copy the contents of the old L2 table into the newly allocated one.
547 * Otherwise the new table is initialized with zeros.
551 static uint64_t *l2_allocate(BlockDriverState
*bs
, int l1_index
)
553 BDRVQcowState
*s
= bs
->opaque
;
555 uint64_t old_l2_offset
, tmp
;
556 uint64_t *l2_table
, l2_offset
;
558 old_l2_offset
= s
->l1_table
[l1_index
];
560 /* allocate a new l2 entry */
562 l2_offset
= alloc_clusters(bs
, s
->l2_size
* sizeof(uint64_t));
564 /* update the L1 entry */
566 s
->l1_table
[l1_index
] = l2_offset
| QCOW_OFLAG_COPIED
;
568 tmp
= cpu_to_be64(l2_offset
| QCOW_OFLAG_COPIED
);
569 if (bdrv_pwrite(s
->hd
, s
->l1_table_offset
+ l1_index
* sizeof(tmp
),
570 &tmp
, sizeof(tmp
)) != sizeof(tmp
))
573 /* allocate a new entry in the l2 cache */
575 min_index
= l2_cache_new_entry(bs
);
576 l2_table
= s
->l2_cache
+ (min_index
<< s
->l2_bits
);
578 if (old_l2_offset
== 0) {
579 /* if there was no old l2 table, clear the new table */
580 memset(l2_table
, 0, s
->l2_size
* sizeof(uint64_t));
582 /* if there was an old l2 table, read it from the disk */
583 if (bdrv_pread(s
->hd
, old_l2_offset
,
584 l2_table
, s
->l2_size
* sizeof(uint64_t)) !=
585 s
->l2_size
* sizeof(uint64_t))
588 /* write the l2 table to the file */
589 if (bdrv_pwrite(s
->hd
, l2_offset
,
590 l2_table
, s
->l2_size
* sizeof(uint64_t)) !=
591 s
->l2_size
* sizeof(uint64_t))
594 /* update the l2 cache entry */
596 s
->l2_cache_offsets
[min_index
] = l2_offset
;
597 s
->l2_cache_counts
[min_index
] = 1;
602 static int size_to_clusters(BDRVQcowState
*s
, int64_t size
)
604 return (size
+ (s
->cluster_size
- 1)) >> s
->cluster_bits
;
607 static int count_contiguous_clusters(uint64_t nb_clusters
, int cluster_size
,
608 uint64_t *l2_table
, uint64_t start
, uint64_t mask
)
611 uint64_t offset
= be64_to_cpu(l2_table
[0]) & ~mask
;
616 for (i
= start
; i
< start
+ nb_clusters
; i
++)
617 if (offset
+ i
* cluster_size
!= (be64_to_cpu(l2_table
[i
]) & ~mask
))
623 static int count_contiguous_free_clusters(uint64_t nb_clusters
, uint64_t *l2_table
)
627 while(nb_clusters
-- && l2_table
[i
] == 0)
636 * For a given offset of the disk image, return cluster offset in
639 * on entry, *num is the number of contiguous clusters we'd like to
640 * access following offset.
642 * on exit, *num is the number of contiguous clusters we can read.
644 * Return 1, if the offset is found
645 * Return 0, otherwise.
649 static uint64_t get_cluster_offset(BlockDriverState
*bs
,
650 uint64_t offset
, int *num
)
652 BDRVQcowState
*s
= bs
->opaque
;
653 int l1_index
, l2_index
;
654 uint64_t l2_offset
, *l2_table
, cluster_offset
;
656 int index_in_cluster
, nb_available
, nb_needed
, nb_clusters
;
658 index_in_cluster
= (offset
>> 9) & (s
->cluster_sectors
- 1);
659 nb_needed
= *num
+ index_in_cluster
;
661 l1_bits
= s
->l2_bits
+ s
->cluster_bits
;
663 /* compute how many bytes there are between the offset and
664 * the end of the l1 entry
667 nb_available
= (1 << l1_bits
) - (offset
& ((1 << l1_bits
) - 1));
669 /* compute the number of available sectors */
671 nb_available
= (nb_available
>> 9) + index_in_cluster
;
673 if (nb_needed
> nb_available
) {
674 nb_needed
= nb_available
;
679 /* seek the the l2 offset in the l1 table */
681 l1_index
= offset
>> l1_bits
;
682 if (l1_index
>= s
->l1_size
)
685 l2_offset
= s
->l1_table
[l1_index
];
687 /* seek the l2 table of the given l2 offset */
692 /* load the l2 table in memory */
694 l2_offset
&= ~QCOW_OFLAG_COPIED
;
695 l2_table
= l2_load(bs
, l2_offset
);
696 if (l2_table
== NULL
)
699 /* find the cluster offset for the given disk offset */
701 l2_index
= (offset
>> s
->cluster_bits
) & (s
->l2_size
- 1);
702 cluster_offset
= be64_to_cpu(l2_table
[l2_index
]);
703 nb_clusters
= size_to_clusters(s
, nb_needed
<< 9);
705 if (!cluster_offset
) {
706 /* how many empty clusters ? */
707 c
= count_contiguous_free_clusters(nb_clusters
, &l2_table
[l2_index
]);
709 /* how many allocated clusters ? */
710 c
= count_contiguous_clusters(nb_clusters
, s
->cluster_size
,
711 &l2_table
[l2_index
], 0, QCOW_OFLAG_COPIED
);
714 nb_available
= (c
* s
->cluster_sectors
);
716 if (nb_available
> nb_needed
)
717 nb_available
= nb_needed
;
719 *num
= nb_available
- index_in_cluster
;
721 return cluster_offset
& ~QCOW_OFLAG_COPIED
;
727 * free clusters according to its type: compressed or not
731 static void free_any_clusters(BlockDriverState
*bs
,
732 uint64_t cluster_offset
, int nb_clusters
)
734 BDRVQcowState
*s
= bs
->opaque
;
736 /* free the cluster */
738 if (cluster_offset
& QCOW_OFLAG_COMPRESSED
) {
740 nb_csectors
= ((cluster_offset
>> s
->csize_shift
) &
742 free_clusters(bs
, (cluster_offset
& s
->cluster_offset_mask
) & ~511,
747 free_clusters(bs
, cluster_offset
, nb_clusters
<< s
->cluster_bits
);
755 * for a given disk offset, load (and allocate if needed)
758 * the l2 table offset in the qcow2 file and the cluster index
759 * in the l2 table are given to the caller.
763 static int get_cluster_table(BlockDriverState
*bs
, uint64_t offset
,
764 uint64_t **new_l2_table
,
765 uint64_t *new_l2_offset
,
768 BDRVQcowState
*s
= bs
->opaque
;
769 int l1_index
, l2_index
, ret
;
770 uint64_t l2_offset
, *l2_table
;
772 /* seek the the l2 offset in the l1 table */
774 l1_index
= offset
>> (s
->l2_bits
+ s
->cluster_bits
);
775 if (l1_index
>= s
->l1_size
) {
776 ret
= grow_l1_table(bs
, l1_index
+ 1);
780 l2_offset
= s
->l1_table
[l1_index
];
782 /* seek the l2 table of the given l2 offset */
784 if (l2_offset
& QCOW_OFLAG_COPIED
) {
785 /* load the l2 table in memory */
786 l2_offset
&= ~QCOW_OFLAG_COPIED
;
787 l2_table
= l2_load(bs
, l2_offset
);
788 if (l2_table
== NULL
)
792 free_clusters(bs
, l2_offset
, s
->l2_size
* sizeof(uint64_t));
793 l2_table
= l2_allocate(bs
, l1_index
);
794 if (l2_table
== NULL
)
796 l2_offset
= s
->l1_table
[l1_index
] & ~QCOW_OFLAG_COPIED
;
799 /* find the cluster offset for the given disk offset */
801 l2_index
= (offset
>> s
->cluster_bits
) & (s
->l2_size
- 1);
803 *new_l2_table
= l2_table
;
804 *new_l2_offset
= l2_offset
;
805 *new_l2_index
= l2_index
;
811 * alloc_compressed_cluster_offset
813 * For a given offset of the disk image, return cluster offset in
816 * If the offset is not found, allocate a new compressed cluster.
818 * Return the cluster offset if successful,
819 * Return 0, otherwise.
823 static uint64_t alloc_compressed_cluster_offset(BlockDriverState
*bs
,
827 BDRVQcowState
*s
= bs
->opaque
;
829 uint64_t l2_offset
, *l2_table
, cluster_offset
;
832 ret
= get_cluster_table(bs
, offset
, &l2_table
, &l2_offset
, &l2_index
);
836 cluster_offset
= be64_to_cpu(l2_table
[l2_index
]);
837 if (cluster_offset
& QCOW_OFLAG_COPIED
)
838 return cluster_offset
& ~QCOW_OFLAG_COPIED
;
841 free_any_clusters(bs
, cluster_offset
, 1);
843 cluster_offset
= alloc_bytes(bs
, compressed_size
);
844 nb_csectors
= ((cluster_offset
+ compressed_size
- 1) >> 9) -
845 (cluster_offset
>> 9);
847 cluster_offset
|= QCOW_OFLAG_COMPRESSED
|
848 ((uint64_t)nb_csectors
<< s
->csize_shift
);
850 /* update L2 table */
852 /* compressed clusters never have the copied flag */
854 l2_table
[l2_index
] = cpu_to_be64(cluster_offset
);
855 if (bdrv_pwrite(s
->hd
,
856 l2_offset
+ l2_index
* sizeof(uint64_t),
858 sizeof(uint64_t)) != sizeof(uint64_t))
861 return cluster_offset
;
864 typedef struct QCowL2Meta
872 static int alloc_cluster_link_l2(BlockDriverState
*bs
, uint64_t cluster_offset
,
875 BDRVQcowState
*s
= bs
->opaque
;
876 int i
, j
= 0, l2_index
, ret
;
877 uint64_t *old_cluster
, start_sect
, l2_offset
, *l2_table
;
879 if (m
->nb_clusters
== 0)
882 old_cluster
= qemu_malloc(m
->nb_clusters
* sizeof(uint64_t));
884 /* copy content of unmodified sectors */
885 start_sect
= (m
->offset
& ~(s
->cluster_size
- 1)) >> 9;
887 ret
= copy_sectors(bs
, start_sect
, cluster_offset
, 0, m
->n_start
);
892 if (m
->nb_available
& (s
->cluster_sectors
- 1)) {
893 uint64_t end
= m
->nb_available
& ~(uint64_t)(s
->cluster_sectors
- 1);
894 ret
= copy_sectors(bs
, start_sect
+ end
, cluster_offset
+ (end
<< 9),
895 m
->nb_available
- end
, s
->cluster_sectors
);
901 /* update L2 table */
902 if (!get_cluster_table(bs
, m
->offset
, &l2_table
, &l2_offset
, &l2_index
))
905 for (i
= 0; i
< m
->nb_clusters
; i
++) {
906 /* if two concurrent writes happen to the same unallocated cluster
907 * each write allocates separate cluster and writes data concurrently.
908 * The first one to complete updates l2 table with pointer to its
909 * cluster the second one has to do RMW (which is done above by
910 * copy_sectors()), update l2 table with its cluster pointer and free
911 * old cluster. This is what this loop does */
912 if(l2_table
[l2_index
+ i
] != 0)
913 old_cluster
[j
++] = l2_table
[l2_index
+ i
];
915 l2_table
[l2_index
+ i
] = cpu_to_be64((cluster_offset
+
916 (i
<< s
->cluster_bits
)) | QCOW_OFLAG_COPIED
);
919 if (bdrv_pwrite(s
->hd
, l2_offset
+ l2_index
* sizeof(uint64_t),
920 l2_table
+ l2_index
, m
->nb_clusters
* sizeof(uint64_t)) !=
921 m
->nb_clusters
* sizeof(uint64_t))
924 for (i
= 0; i
< j
; i
++)
925 free_any_clusters(bs
, be64_to_cpu(old_cluster
[i
]) & ~QCOW_OFLAG_COPIED
,
930 qemu_free(old_cluster
);
935 * alloc_cluster_offset
937 * For a given offset of the disk image, return cluster offset in
940 * If the offset is not found, allocate a new cluster.
942 * Return the cluster offset if successful,
943 * Return 0, otherwise.
947 static uint64_t alloc_cluster_offset(BlockDriverState
*bs
,
949 int n_start
, int n_end
,
950 int *num
, QCowL2Meta
*m
)
952 BDRVQcowState
*s
= bs
->opaque
;
954 uint64_t l2_offset
, *l2_table
, cluster_offset
;
955 int nb_clusters
, i
= 0;
957 ret
= get_cluster_table(bs
, offset
, &l2_table
, &l2_offset
, &l2_index
);
961 nb_clusters
= size_to_clusters(s
, n_end
<< 9);
963 nb_clusters
= MIN(nb_clusters
, s
->l2_size
- l2_index
);
965 cluster_offset
= be64_to_cpu(l2_table
[l2_index
]);
967 /* We keep all QCOW_OFLAG_COPIED clusters */
969 if (cluster_offset
& QCOW_OFLAG_COPIED
) {
970 nb_clusters
= count_contiguous_clusters(nb_clusters
, s
->cluster_size
,
971 &l2_table
[l2_index
], 0, 0);
973 cluster_offset
&= ~QCOW_OFLAG_COPIED
;
979 /* for the moment, multiple compressed clusters are not managed */
981 if (cluster_offset
& QCOW_OFLAG_COMPRESSED
)
984 /* how many available clusters ? */
986 while (i
< nb_clusters
) {
987 i
+= count_contiguous_clusters(nb_clusters
- i
, s
->cluster_size
,
988 &l2_table
[l2_index
], i
, 0);
990 if(be64_to_cpu(l2_table
[l2_index
+ i
]))
993 i
+= count_contiguous_free_clusters(nb_clusters
- i
,
994 &l2_table
[l2_index
+ i
]);
996 cluster_offset
= be64_to_cpu(l2_table
[l2_index
+ i
]);
998 if ((cluster_offset
& QCOW_OFLAG_COPIED
) ||
999 (cluster_offset
& QCOW_OFLAG_COMPRESSED
))
1004 /* allocate a new cluster */
1006 cluster_offset
= alloc_clusters(bs
, nb_clusters
* s
->cluster_size
);
1008 /* save info needed for meta data update */
1010 m
->n_start
= n_start
;
1011 m
->nb_clusters
= nb_clusters
;
1014 m
->nb_available
= MIN(nb_clusters
<< (s
->cluster_bits
- 9), n_end
);
1016 *num
= m
->nb_available
- n_start
;
1018 return cluster_offset
;
1021 static int qcow_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
1022 int nb_sectors
, int *pnum
)
1024 uint64_t cluster_offset
;
1027 cluster_offset
= get_cluster_offset(bs
, sector_num
<< 9, pnum
);
1029 return (cluster_offset
!= 0);
1032 static int decompress_buffer(uint8_t *out_buf
, int out_buf_size
,
1033 const uint8_t *buf
, int buf_size
)
1035 z_stream strm1
, *strm
= &strm1
;
1038 memset(strm
, 0, sizeof(*strm
));
1040 strm
->next_in
= (uint8_t *)buf
;
1041 strm
->avail_in
= buf_size
;
1042 strm
->next_out
= out_buf
;
1043 strm
->avail_out
= out_buf_size
;
1045 ret
= inflateInit2(strm
, -12);
1048 ret
= inflate(strm
, Z_FINISH
);
1049 out_len
= strm
->next_out
- out_buf
;
1050 if ((ret
!= Z_STREAM_END
&& ret
!= Z_BUF_ERROR
) ||
1051 out_len
!= out_buf_size
) {
1059 static int decompress_cluster(BDRVQcowState
*s
, uint64_t cluster_offset
)
1061 int ret
, csize
, nb_csectors
, sector_offset
;
1064 coffset
= cluster_offset
& s
->cluster_offset_mask
;
1065 if (s
->cluster_cache_offset
!= coffset
) {
1066 nb_csectors
= ((cluster_offset
>> s
->csize_shift
) & s
->csize_mask
) + 1;
1067 sector_offset
= coffset
& 511;
1068 csize
= nb_csectors
* 512 - sector_offset
;
1069 ret
= bdrv_read(s
->hd
, coffset
>> 9, s
->cluster_data
, nb_csectors
);
1073 if (decompress_buffer(s
->cluster_cache
, s
->cluster_size
,
1074 s
->cluster_data
+ sector_offset
, csize
) < 0) {
1077 s
->cluster_cache_offset
= coffset
;
1082 /* handle reading after the end of the backing file */
1083 static int backing_read1(BlockDriverState
*bs
,
1084 int64_t sector_num
, uint8_t *buf
, int nb_sectors
)
1087 if ((sector_num
+ nb_sectors
) <= bs
->total_sectors
)
1089 if (sector_num
>= bs
->total_sectors
)
1092 n1
= bs
->total_sectors
- sector_num
;
1093 memset(buf
+ n1
* 512, 0, 512 * (nb_sectors
- n1
));
1097 static int qcow_read(BlockDriverState
*bs
, int64_t sector_num
,
1098 uint8_t *buf
, int nb_sectors
)
1100 BDRVQcowState
*s
= bs
->opaque
;
1101 int ret
, index_in_cluster
, n
, n1
;
1102 uint64_t cluster_offset
;
1104 while (nb_sectors
> 0) {
1106 cluster_offset
= get_cluster_offset(bs
, sector_num
<< 9, &n
);
1107 index_in_cluster
= sector_num
& (s
->cluster_sectors
- 1);
1108 if (!cluster_offset
) {
1109 if (bs
->backing_hd
) {
1110 /* read from the base image */
1111 n1
= backing_read1(bs
->backing_hd
, sector_num
, buf
, n
);
1113 ret
= bdrv_read(bs
->backing_hd
, sector_num
, buf
, n1
);
1118 memset(buf
, 0, 512 * n
);
1120 } else if (cluster_offset
& QCOW_OFLAG_COMPRESSED
) {
1121 if (decompress_cluster(s
, cluster_offset
) < 0)
1123 memcpy(buf
, s
->cluster_cache
+ index_in_cluster
* 512, 512 * n
);
1125 ret
= bdrv_pread(s
->hd
, cluster_offset
+ index_in_cluster
* 512, buf
, n
* 512);
1128 if (s
->crypt_method
) {
1129 encrypt_sectors(s
, sector_num
, buf
, buf
, n
, 0,
1130 &s
->aes_decrypt_key
);
1140 static int qcow_write(BlockDriverState
*bs
, int64_t sector_num
,
1141 const uint8_t *buf
, int nb_sectors
)
1143 BDRVQcowState
*s
= bs
->opaque
;
1144 int ret
, index_in_cluster
, n
;
1145 uint64_t cluster_offset
;
1149 while (nb_sectors
> 0) {
1150 index_in_cluster
= sector_num
& (s
->cluster_sectors
- 1);
1151 n_end
= index_in_cluster
+ nb_sectors
;
1152 if (s
->crypt_method
&&
1153 n_end
> QCOW_MAX_CRYPT_CLUSTERS
* s
->cluster_sectors
)
1154 n_end
= QCOW_MAX_CRYPT_CLUSTERS
* s
->cluster_sectors
;
1155 cluster_offset
= alloc_cluster_offset(bs
, sector_num
<< 9,
1157 n_end
, &n
, &l2meta
);
1158 if (!cluster_offset
)
1160 if (s
->crypt_method
) {
1161 encrypt_sectors(s
, sector_num
, s
->cluster_data
, buf
, n
, 1,
1162 &s
->aes_encrypt_key
);
1163 ret
= bdrv_pwrite(s
->hd
, cluster_offset
+ index_in_cluster
* 512,
1164 s
->cluster_data
, n
* 512);
1166 ret
= bdrv_pwrite(s
->hd
, cluster_offset
+ index_in_cluster
* 512, buf
, n
* 512);
1168 if (ret
!= n
* 512 || alloc_cluster_link_l2(bs
, cluster_offset
, &l2meta
) < 0) {
1169 free_any_clusters(bs
, cluster_offset
, l2meta
.nb_clusters
);
1176 s
->cluster_cache_offset
= -1; /* disable compressed cache */
1180 typedef struct QCowAIOCB
{
1181 BlockDriverAIOCB common
;
1186 uint64_t cluster_offset
;
1187 uint8_t *cluster_data
;
1188 BlockDriverAIOCB
*hd_aiocb
;
1193 static void qcow_aio_read_cb(void *opaque
, int ret
);
1194 static void qcow_aio_read_bh(void *opaque
)
1196 QCowAIOCB
*acb
= opaque
;
1197 qemu_bh_delete(acb
->bh
);
1199 qcow_aio_read_cb(opaque
, 0);
1202 static int qcow_schedule_bh(QEMUBHFunc
*cb
, QCowAIOCB
*acb
)
1207 acb
->bh
= qemu_bh_new(cb
, acb
);
1211 qemu_bh_schedule(acb
->bh
);
1216 static void qcow_aio_read_cb(void *opaque
, int ret
)
1218 QCowAIOCB
*acb
= opaque
;
1219 BlockDriverState
*bs
= acb
->common
.bs
;
1220 BDRVQcowState
*s
= bs
->opaque
;
1221 int index_in_cluster
, n1
;
1223 acb
->hd_aiocb
= NULL
;
1226 acb
->common
.cb(acb
->common
.opaque
, ret
);
1227 qemu_aio_release(acb
);
1231 /* post process the read buffer */
1232 if (!acb
->cluster_offset
) {
1234 } else if (acb
->cluster_offset
& QCOW_OFLAG_COMPRESSED
) {
1237 if (s
->crypt_method
) {
1238 encrypt_sectors(s
, acb
->sector_num
, acb
->buf
, acb
->buf
,
1240 &s
->aes_decrypt_key
);
1244 acb
->nb_sectors
-= acb
->n
;
1245 acb
->sector_num
+= acb
->n
;
1246 acb
->buf
+= acb
->n
* 512;
1248 if (acb
->nb_sectors
== 0) {
1249 /* request completed */
1250 acb
->common
.cb(acb
->common
.opaque
, 0);
1251 qemu_aio_release(acb
);
1255 /* prepare next AIO request */
1256 acb
->n
= acb
->nb_sectors
;
1257 acb
->cluster_offset
= get_cluster_offset(bs
, acb
->sector_num
<< 9, &acb
->n
);
1258 index_in_cluster
= acb
->sector_num
& (s
->cluster_sectors
- 1);
1260 if (!acb
->cluster_offset
) {
1261 if (bs
->backing_hd
) {
1262 /* read from the base image */
1263 n1
= backing_read1(bs
->backing_hd
, acb
->sector_num
,
1266 acb
->hd_aiocb
= bdrv_aio_read(bs
->backing_hd
, acb
->sector_num
,
1267 acb
->buf
, acb
->n
, qcow_aio_read_cb
, acb
);
1268 if (acb
->hd_aiocb
== NULL
)
1271 ret
= qcow_schedule_bh(qcow_aio_read_bh
, acb
);
1276 /* Note: in this case, no need to wait */
1277 memset(acb
->buf
, 0, 512 * acb
->n
);
1278 ret
= qcow_schedule_bh(qcow_aio_read_bh
, acb
);
1282 } else if (acb
->cluster_offset
& QCOW_OFLAG_COMPRESSED
) {
1283 /* add AIO support for compressed blocks ? */
1284 if (decompress_cluster(s
, acb
->cluster_offset
) < 0)
1287 s
->cluster_cache
+ index_in_cluster
* 512, 512 * acb
->n
);
1288 ret
= qcow_schedule_bh(qcow_aio_read_bh
, acb
);
1292 if ((acb
->cluster_offset
& 511) != 0) {
1296 acb
->hd_aiocb
= bdrv_aio_read(s
->hd
,
1297 (acb
->cluster_offset
>> 9) + index_in_cluster
,
1298 acb
->buf
, acb
->n
, qcow_aio_read_cb
, acb
);
1299 if (acb
->hd_aiocb
== NULL
)
1304 static QCowAIOCB
*qcow_aio_setup(BlockDriverState
*bs
,
1305 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1306 BlockDriverCompletionFunc
*cb
, void *opaque
)
1310 acb
= qemu_aio_get(bs
, cb
, opaque
);
1313 acb
->hd_aiocb
= NULL
;
1314 acb
->sector_num
= sector_num
;
1316 acb
->nb_sectors
= nb_sectors
;
1318 acb
->cluster_offset
= 0;
1319 acb
->l2meta
.nb_clusters
= 0;
1323 static BlockDriverAIOCB
*qcow_aio_read(BlockDriverState
*bs
,
1324 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1325 BlockDriverCompletionFunc
*cb
, void *opaque
)
1329 acb
= qcow_aio_setup(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1333 qcow_aio_read_cb(acb
, 0);
1334 return &acb
->common
;
1337 static void qcow_aio_write_cb(void *opaque
, int ret
)
1339 QCowAIOCB
*acb
= opaque
;
1340 BlockDriverState
*bs
= acb
->common
.bs
;
1341 BDRVQcowState
*s
= bs
->opaque
;
1342 int index_in_cluster
;
1343 const uint8_t *src_buf
;
1346 acb
->hd_aiocb
= NULL
;
1350 acb
->common
.cb(acb
->common
.opaque
, ret
);
1351 qemu_aio_release(acb
);
1355 if (alloc_cluster_link_l2(bs
, acb
->cluster_offset
, &acb
->l2meta
) < 0) {
1356 free_any_clusters(bs
, acb
->cluster_offset
, acb
->l2meta
.nb_clusters
);
1360 acb
->nb_sectors
-= acb
->n
;
1361 acb
->sector_num
+= acb
->n
;
1362 acb
->buf
+= acb
->n
* 512;
1364 if (acb
->nb_sectors
== 0) {
1365 /* request completed */
1366 acb
->common
.cb(acb
->common
.opaque
, 0);
1367 qemu_aio_release(acb
);
1371 index_in_cluster
= acb
->sector_num
& (s
->cluster_sectors
- 1);
1372 n_end
= index_in_cluster
+ acb
->nb_sectors
;
1373 if (s
->crypt_method
&&
1374 n_end
> QCOW_MAX_CRYPT_CLUSTERS
* s
->cluster_sectors
)
1375 n_end
= QCOW_MAX_CRYPT_CLUSTERS
* s
->cluster_sectors
;
1377 acb
->cluster_offset
= alloc_cluster_offset(bs
, acb
->sector_num
<< 9,
1379 n_end
, &acb
->n
, &acb
->l2meta
);
1380 if (!acb
->cluster_offset
|| (acb
->cluster_offset
& 511) != 0) {
1384 if (s
->crypt_method
) {
1385 if (!acb
->cluster_data
) {
1386 acb
->cluster_data
= qemu_mallocz(QCOW_MAX_CRYPT_CLUSTERS
*
1389 encrypt_sectors(s
, acb
->sector_num
, acb
->cluster_data
, acb
->buf
,
1390 acb
->n
, 1, &s
->aes_encrypt_key
);
1391 src_buf
= acb
->cluster_data
;
1395 acb
->hd_aiocb
= bdrv_aio_write(s
->hd
,
1396 (acb
->cluster_offset
>> 9) + index_in_cluster
,
1398 qcow_aio_write_cb
, acb
);
1399 if (acb
->hd_aiocb
== NULL
)
1403 static BlockDriverAIOCB
*qcow_aio_write(BlockDriverState
*bs
,
1404 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
1405 BlockDriverCompletionFunc
*cb
, void *opaque
)
1407 BDRVQcowState
*s
= bs
->opaque
;
1410 s
->cluster_cache_offset
= -1; /* disable compressed cache */
1412 acb
= qcow_aio_setup(bs
, sector_num
, (uint8_t*)buf
, nb_sectors
, cb
, opaque
);
1416 qcow_aio_write_cb(acb
, 0);
1417 return &acb
->common
;
1420 static void qcow_aio_cancel(BlockDriverAIOCB
*blockacb
)
1422 QCowAIOCB
*acb
= (QCowAIOCB
*)blockacb
;
1424 bdrv_aio_cancel(acb
->hd_aiocb
);
1425 qemu_aio_release(acb
);
1428 static void qcow_close(BlockDriverState
*bs
)
1430 BDRVQcowState
*s
= bs
->opaque
;
1431 qemu_free(s
->l1_table
);
1432 qemu_free(s
->l2_cache
);
1433 qemu_free(s
->cluster_cache
);
1434 qemu_free(s
->cluster_data
);
1439 /* XXX: use std qcow open function ? */
1440 typedef struct QCowCreateState
{
1443 uint16_t *refcount_block
;
1444 uint64_t *refcount_table
;
1445 int64_t l1_table_offset
;
1446 int64_t refcount_table_offset
;
1447 int64_t refcount_block_offset
;
1450 static void create_refcount_update(QCowCreateState
*s
,
1451 int64_t offset
, int64_t size
)
1454 int64_t start
, last
, cluster_offset
;
1457 start
= offset
& ~(s
->cluster_size
- 1);
1458 last
= (offset
+ size
- 1) & ~(s
->cluster_size
- 1);
1459 for(cluster_offset
= start
; cluster_offset
<= last
;
1460 cluster_offset
+= s
->cluster_size
) {
1461 p
= &s
->refcount_block
[cluster_offset
>> s
->cluster_bits
];
1462 refcount
= be16_to_cpu(*p
);
1464 *p
= cpu_to_be16(refcount
);
1468 static int qcow_create(const char *filename
, int64_t total_size
,
1469 const char *backing_file
, int flags
)
1471 int fd
, header_size
, backing_filename_len
, l1_size
, i
, shift
, l2_bits
;
1474 uint64_t tmp
, offset
;
1475 QCowCreateState s1
, *s
= &s1
;
1477 memset(s
, 0, sizeof(*s
));
1479 fd
= open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
, 0644);
1482 memset(&header
, 0, sizeof(header
));
1483 header
.magic
= cpu_to_be32(QCOW_MAGIC
);
1484 header
.version
= cpu_to_be32(QCOW_VERSION
);
1485 header
.size
= cpu_to_be64(total_size
* 512);
1486 header_size
= sizeof(header
);
1487 backing_filename_len
= 0;
1489 header
.backing_file_offset
= cpu_to_be64(header_size
);
1490 backing_filename_len
= strlen(backing_file
);
1491 header
.backing_file_size
= cpu_to_be32(backing_filename_len
);
1492 header_size
+= backing_filename_len
;
1494 s
->cluster_bits
= 12; /* 4 KB clusters */
1495 s
->cluster_size
= 1 << s
->cluster_bits
;
1496 header
.cluster_bits
= cpu_to_be32(s
->cluster_bits
);
1497 header_size
= (header_size
+ 7) & ~7;
1498 if (flags
& BLOCK_FLAG_ENCRYPT
) {
1499 header
.crypt_method
= cpu_to_be32(QCOW_CRYPT_AES
);
1501 header
.crypt_method
= cpu_to_be32(QCOW_CRYPT_NONE
);
1503 l2_bits
= s
->cluster_bits
- 3;
1504 shift
= s
->cluster_bits
+ l2_bits
;
1505 l1_size
= (((total_size
* 512) + (1LL << shift
) - 1) >> shift
);
1506 offset
= align_offset(header_size
, s
->cluster_size
);
1507 s
->l1_table_offset
= offset
;
1508 header
.l1_table_offset
= cpu_to_be64(s
->l1_table_offset
);
1509 header
.l1_size
= cpu_to_be32(l1_size
);
1510 offset
+= align_offset(l1_size
* sizeof(uint64_t), s
->cluster_size
);
1512 s
->refcount_table
= qemu_mallocz(s
->cluster_size
);
1514 s
->refcount_table_offset
= offset
;
1515 header
.refcount_table_offset
= cpu_to_be64(offset
);
1516 header
.refcount_table_clusters
= cpu_to_be32(1);
1517 offset
+= s
->cluster_size
;
1518 s
->refcount_block_offset
= offset
;
1520 /* count how many refcount blocks needed */
1521 tmp
= offset
>> s
->cluster_bits
;
1522 ref_clusters
= (tmp
>> (s
->cluster_bits
- REFCOUNT_SHIFT
)) + 1;
1523 for (i
=0; i
< ref_clusters
; i
++) {
1524 s
->refcount_table
[i
] = cpu_to_be64(offset
);
1525 offset
+= s
->cluster_size
;
1528 s
->refcount_block
= qemu_mallocz(ref_clusters
* s
->cluster_size
);
1530 /* update refcounts */
1531 create_refcount_update(s
, 0, header_size
);
1532 create_refcount_update(s
, s
->l1_table_offset
, l1_size
* sizeof(uint64_t));
1533 create_refcount_update(s
, s
->refcount_table_offset
, s
->cluster_size
);
1534 create_refcount_update(s
, s
->refcount_block_offset
, ref_clusters
* s
->cluster_size
);
1536 /* write all the data */
1537 write(fd
, &header
, sizeof(header
));
1539 write(fd
, backing_file
, backing_filename_len
);
1541 lseek(fd
, s
->l1_table_offset
, SEEK_SET
);
1543 for(i
= 0;i
< l1_size
; i
++) {
1544 write(fd
, &tmp
, sizeof(tmp
));
1546 lseek(fd
, s
->refcount_table_offset
, SEEK_SET
);
1547 write(fd
, s
->refcount_table
, s
->cluster_size
);
1549 lseek(fd
, s
->refcount_block_offset
, SEEK_SET
);
1550 write(fd
, s
->refcount_block
, ref_clusters
* s
->cluster_size
);
1552 qemu_free(s
->refcount_table
);
1553 qemu_free(s
->refcount_block
);
1558 static int qcow_make_empty(BlockDriverState
*bs
)
1561 /* XXX: not correct */
1562 BDRVQcowState
*s
= bs
->opaque
;
1563 uint32_t l1_length
= s
->l1_size
* sizeof(uint64_t);
1566 memset(s
->l1_table
, 0, l1_length
);
1567 if (bdrv_pwrite(s
->hd
, s
->l1_table_offset
, s
->l1_table
, l1_length
) < 0)
1569 ret
= bdrv_truncate(s
->hd
, s
->l1_table_offset
+ l1_length
);
1578 /* XXX: put compressed sectors first, then all the cluster aligned
1579 tables to avoid losing bytes in alignment */
1580 static int qcow_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1581 const uint8_t *buf
, int nb_sectors
)
1583 BDRVQcowState
*s
= bs
->opaque
;
1587 uint64_t cluster_offset
;
1589 if (nb_sectors
== 0) {
1590 /* align end of file to a sector boundary to ease reading with
1591 sector based I/Os */
1592 cluster_offset
= bdrv_getlength(s
->hd
);
1593 cluster_offset
= (cluster_offset
+ 511) & ~511;
1594 bdrv_truncate(s
->hd
, cluster_offset
);
1598 if (nb_sectors
!= s
->cluster_sectors
)
1601 out_buf
= qemu_malloc(s
->cluster_size
+ (s
->cluster_size
/ 1000) + 128);
1603 /* best compression, small window, no zlib header */
1604 memset(&strm
, 0, sizeof(strm
));
1605 ret
= deflateInit2(&strm
, Z_DEFAULT_COMPRESSION
,
1607 9, Z_DEFAULT_STRATEGY
);
1613 strm
.avail_in
= s
->cluster_size
;
1614 strm
.next_in
= (uint8_t *)buf
;
1615 strm
.avail_out
= s
->cluster_size
;
1616 strm
.next_out
= out_buf
;
1618 ret
= deflate(&strm
, Z_FINISH
);
1619 if (ret
!= Z_STREAM_END
&& ret
!= Z_OK
) {
1624 out_len
= strm
.next_out
- out_buf
;
1628 if (ret
!= Z_STREAM_END
|| out_len
>= s
->cluster_size
) {
1629 /* could not compress: write normal cluster */
1630 qcow_write(bs
, sector_num
, buf
, s
->cluster_sectors
);
1632 cluster_offset
= alloc_compressed_cluster_offset(bs
, sector_num
<< 9,
1634 if (!cluster_offset
)
1636 cluster_offset
&= s
->cluster_offset_mask
;
1637 if (bdrv_pwrite(s
->hd
, cluster_offset
, out_buf
, out_len
) != out_len
) {
1647 static void qcow_flush(BlockDriverState
*bs
)
1649 BDRVQcowState
*s
= bs
->opaque
;
1653 static int qcow_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1655 BDRVQcowState
*s
= bs
->opaque
;
1656 bdi
->cluster_size
= s
->cluster_size
;
1657 bdi
->vm_state_offset
= (int64_t)s
->l1_vm_state_index
<<
1658 (s
->cluster_bits
+ s
->l2_bits
);
1662 /*********************************************************/
1663 /* snapshot support */
1665 /* update the refcounts of snapshots and the copied flag */
1666 static int update_snapshot_refcount(BlockDriverState
*bs
,
1667 int64_t l1_table_offset
,
1671 BDRVQcowState
*s
= bs
->opaque
;
1672 uint64_t *l1_table
, *l2_table
, l2_offset
, offset
, l1_size2
, l1_allocated
;
1673 int64_t old_offset
, old_l2_offset
;
1674 int l2_size
, i
, j
, l1_modified
, l2_modified
, nb_csectors
, refcount
;
1680 l1_size2
= l1_size
* sizeof(uint64_t);
1682 if (l1_table_offset
!= s
->l1_table_offset
) {
1683 l1_table
= qemu_malloc(l1_size2
);
1685 if (bdrv_pread(s
->hd
, l1_table_offset
,
1686 l1_table
, l1_size2
) != l1_size2
)
1688 for(i
= 0;i
< l1_size
; i
++)
1689 be64_to_cpus(&l1_table
[i
]);
1691 assert(l1_size
== s
->l1_size
);
1692 l1_table
= s
->l1_table
;
1696 l2_size
= s
->l2_size
* sizeof(uint64_t);
1697 l2_table
= qemu_malloc(l2_size
);
1699 for(i
= 0; i
< l1_size
; i
++) {
1700 l2_offset
= l1_table
[i
];
1702 old_l2_offset
= l2_offset
;
1703 l2_offset
&= ~QCOW_OFLAG_COPIED
;
1705 if (bdrv_pread(s
->hd
, l2_offset
, l2_table
, l2_size
) != l2_size
)
1707 for(j
= 0; j
< s
->l2_size
; j
++) {
1708 offset
= be64_to_cpu(l2_table
[j
]);
1710 old_offset
= offset
;
1711 offset
&= ~QCOW_OFLAG_COPIED
;
1712 if (offset
& QCOW_OFLAG_COMPRESSED
) {
1713 nb_csectors
= ((offset
>> s
->csize_shift
) &
1716 update_refcount(bs
, (offset
& s
->cluster_offset_mask
) & ~511,
1717 nb_csectors
* 512, addend
);
1718 /* compressed clusters are never modified */
1722 refcount
= update_cluster_refcount(bs
, offset
>> s
->cluster_bits
, addend
);
1724 refcount
= get_refcount(bs
, offset
>> s
->cluster_bits
);
1728 if (refcount
== 1) {
1729 offset
|= QCOW_OFLAG_COPIED
;
1731 if (offset
!= old_offset
) {
1732 l2_table
[j
] = cpu_to_be64(offset
);
1738 if (bdrv_pwrite(s
->hd
,
1739 l2_offset
, l2_table
, l2_size
) != l2_size
)
1744 refcount
= update_cluster_refcount(bs
, l2_offset
>> s
->cluster_bits
, addend
);
1746 refcount
= get_refcount(bs
, l2_offset
>> s
->cluster_bits
);
1748 if (refcount
== 1) {
1749 l2_offset
|= QCOW_OFLAG_COPIED
;
1751 if (l2_offset
!= old_l2_offset
) {
1752 l1_table
[i
] = l2_offset
;
1758 for(i
= 0; i
< l1_size
; i
++)
1759 cpu_to_be64s(&l1_table
[i
]);
1760 if (bdrv_pwrite(s
->hd
, l1_table_offset
, l1_table
,
1761 l1_size2
) != l1_size2
)
1763 for(i
= 0; i
< l1_size
; i
++)
1764 be64_to_cpus(&l1_table
[i
]);
1767 qemu_free(l1_table
);
1768 qemu_free(l2_table
);
1772 qemu_free(l1_table
);
1773 qemu_free(l2_table
);
1777 static void qcow_free_snapshots(BlockDriverState
*bs
)
1779 BDRVQcowState
*s
= bs
->opaque
;
1782 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1783 qemu_free(s
->snapshots
[i
].name
);
1784 qemu_free(s
->snapshots
[i
].id_str
);
1786 qemu_free(s
->snapshots
);
1787 s
->snapshots
= NULL
;
1788 s
->nb_snapshots
= 0;
1791 static int qcow_read_snapshots(BlockDriverState
*bs
)
1793 BDRVQcowState
*s
= bs
->opaque
;
1794 QCowSnapshotHeader h
;
1796 int i
, id_str_size
, name_size
;
1798 uint32_t extra_data_size
;
1800 if (!s
->nb_snapshots
) {
1801 s
->snapshots
= NULL
;
1802 s
->snapshots_size
= 0;
1806 offset
= s
->snapshots_offset
;
1807 s
->snapshots
= qemu_mallocz(s
->nb_snapshots
* sizeof(QCowSnapshot
));
1808 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1809 offset
= align_offset(offset
, 8);
1810 if (bdrv_pread(s
->hd
, offset
, &h
, sizeof(h
)) != sizeof(h
))
1812 offset
+= sizeof(h
);
1813 sn
= s
->snapshots
+ i
;
1814 sn
->l1_table_offset
= be64_to_cpu(h
.l1_table_offset
);
1815 sn
->l1_size
= be32_to_cpu(h
.l1_size
);
1816 sn
->vm_state_size
= be32_to_cpu(h
.vm_state_size
);
1817 sn
->date_sec
= be32_to_cpu(h
.date_sec
);
1818 sn
->date_nsec
= be32_to_cpu(h
.date_nsec
);
1819 sn
->vm_clock_nsec
= be64_to_cpu(h
.vm_clock_nsec
);
1820 extra_data_size
= be32_to_cpu(h
.extra_data_size
);
1822 id_str_size
= be16_to_cpu(h
.id_str_size
);
1823 name_size
= be16_to_cpu(h
.name_size
);
1825 offset
+= extra_data_size
;
1827 sn
->id_str
= qemu_malloc(id_str_size
+ 1);
1828 if (bdrv_pread(s
->hd
, offset
, sn
->id_str
, id_str_size
) != id_str_size
)
1830 offset
+= id_str_size
;
1831 sn
->id_str
[id_str_size
] = '\0';
1833 sn
->name
= qemu_malloc(name_size
+ 1);
1834 if (bdrv_pread(s
->hd
, offset
, sn
->name
, name_size
) != name_size
)
1836 offset
+= name_size
;
1837 sn
->name
[name_size
] = '\0';
1839 s
->snapshots_size
= offset
- s
->snapshots_offset
;
1842 qcow_free_snapshots(bs
);
1846 /* add at the end of the file a new list of snapshots */
1847 static int qcow_write_snapshots(BlockDriverState
*bs
)
1849 BDRVQcowState
*s
= bs
->opaque
;
1851 QCowSnapshotHeader h
;
1852 int i
, name_size
, id_str_size
, snapshots_size
;
1855 int64_t offset
, snapshots_offset
;
1857 /* compute the size of the snapshots */
1859 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1860 sn
= s
->snapshots
+ i
;
1861 offset
= align_offset(offset
, 8);
1862 offset
+= sizeof(h
);
1863 offset
+= strlen(sn
->id_str
);
1864 offset
+= strlen(sn
->name
);
1866 snapshots_size
= offset
;
1868 snapshots_offset
= alloc_clusters(bs
, snapshots_size
);
1869 offset
= snapshots_offset
;
1871 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1872 sn
= s
->snapshots
+ i
;
1873 memset(&h
, 0, sizeof(h
));
1874 h
.l1_table_offset
= cpu_to_be64(sn
->l1_table_offset
);
1875 h
.l1_size
= cpu_to_be32(sn
->l1_size
);
1876 h
.vm_state_size
= cpu_to_be32(sn
->vm_state_size
);
1877 h
.date_sec
= cpu_to_be32(sn
->date_sec
);
1878 h
.date_nsec
= cpu_to_be32(sn
->date_nsec
);
1879 h
.vm_clock_nsec
= cpu_to_be64(sn
->vm_clock_nsec
);
1881 id_str_size
= strlen(sn
->id_str
);
1882 name_size
= strlen(sn
->name
);
1883 h
.id_str_size
= cpu_to_be16(id_str_size
);
1884 h
.name_size
= cpu_to_be16(name_size
);
1885 offset
= align_offset(offset
, 8);
1886 if (bdrv_pwrite(s
->hd
, offset
, &h
, sizeof(h
)) != sizeof(h
))
1888 offset
+= sizeof(h
);
1889 if (bdrv_pwrite(s
->hd
, offset
, sn
->id_str
, id_str_size
) != id_str_size
)
1891 offset
+= id_str_size
;
1892 if (bdrv_pwrite(s
->hd
, offset
, sn
->name
, name_size
) != name_size
)
1894 offset
+= name_size
;
1897 /* update the various header fields */
1898 data64
= cpu_to_be64(snapshots_offset
);
1899 if (bdrv_pwrite(s
->hd
, offsetof(QCowHeader
, snapshots_offset
),
1900 &data64
, sizeof(data64
)) != sizeof(data64
))
1902 data32
= cpu_to_be32(s
->nb_snapshots
);
1903 if (bdrv_pwrite(s
->hd
, offsetof(QCowHeader
, nb_snapshots
),
1904 &data32
, sizeof(data32
)) != sizeof(data32
))
1907 /* free the old snapshot table */
1908 free_clusters(bs
, s
->snapshots_offset
, s
->snapshots_size
);
1909 s
->snapshots_offset
= snapshots_offset
;
1910 s
->snapshots_size
= snapshots_size
;
1916 static void find_new_snapshot_id(BlockDriverState
*bs
,
1917 char *id_str
, int id_str_size
)
1919 BDRVQcowState
*s
= bs
->opaque
;
1921 int i
, id
, id_max
= 0;
1923 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1924 sn
= s
->snapshots
+ i
;
1925 id
= strtoul(sn
->id_str
, NULL
, 10);
1929 snprintf(id_str
, id_str_size
, "%d", id_max
+ 1);
1932 static int find_snapshot_by_id(BlockDriverState
*bs
, const char *id_str
)
1934 BDRVQcowState
*s
= bs
->opaque
;
1937 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1938 if (!strcmp(s
->snapshots
[i
].id_str
, id_str
))
1944 static int find_snapshot_by_id_or_name(BlockDriverState
*bs
, const char *name
)
1946 BDRVQcowState
*s
= bs
->opaque
;
1949 ret
= find_snapshot_by_id(bs
, name
);
1952 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
1953 if (!strcmp(s
->snapshots
[i
].name
, name
))
1959 /* if no id is provided, a new one is constructed */
1960 static int qcow_snapshot_create(BlockDriverState
*bs
,
1961 QEMUSnapshotInfo
*sn_info
)
1963 BDRVQcowState
*s
= bs
->opaque
;
1964 QCowSnapshot
*snapshots1
, sn1
, *sn
= &sn1
;
1966 uint64_t *l1_table
= NULL
;
1968 memset(sn
, 0, sizeof(*sn
));
1970 if (sn_info
->id_str
[0] == '\0') {
1971 /* compute a new id */
1972 find_new_snapshot_id(bs
, sn_info
->id_str
, sizeof(sn_info
->id_str
));
1975 /* check that the ID is unique */
1976 if (find_snapshot_by_id(bs
, sn_info
->id_str
) >= 0)
1979 sn
->id_str
= qemu_strdup(sn_info
->id_str
);
1982 sn
->name
= qemu_strdup(sn_info
->name
);
1985 sn
->vm_state_size
= sn_info
->vm_state_size
;
1986 sn
->date_sec
= sn_info
->date_sec
;
1987 sn
->date_nsec
= sn_info
->date_nsec
;
1988 sn
->vm_clock_nsec
= sn_info
->vm_clock_nsec
;
1990 ret
= update_snapshot_refcount(bs
, s
->l1_table_offset
, s
->l1_size
, 1);
1994 /* create the L1 table of the snapshot */
1995 sn
->l1_table_offset
= alloc_clusters(bs
, s
->l1_size
* sizeof(uint64_t));
1996 sn
->l1_size
= s
->l1_size
;
1998 l1_table
= qemu_malloc(s
->l1_size
* sizeof(uint64_t));
1999 for(i
= 0; i
< s
->l1_size
; i
++) {
2000 l1_table
[i
] = cpu_to_be64(s
->l1_table
[i
]);
2002 if (bdrv_pwrite(s
->hd
, sn
->l1_table_offset
,
2003 l1_table
, s
->l1_size
* sizeof(uint64_t)) !=
2004 (s
->l1_size
* sizeof(uint64_t)))
2006 qemu_free(l1_table
);
2009 snapshots1
= qemu_malloc((s
->nb_snapshots
+ 1) * sizeof(QCowSnapshot
));
2011 memcpy(snapshots1
, s
->snapshots
, s
->nb_snapshots
* sizeof(QCowSnapshot
));
2012 qemu_free(s
->snapshots
);
2014 s
->snapshots
= snapshots1
;
2015 s
->snapshots
[s
->nb_snapshots
++] = *sn
;
2017 if (qcow_write_snapshots(bs
) < 0)
2020 check_refcounts(bs
);
2024 qemu_free(sn
->name
);
2025 qemu_free(l1_table
);
2029 /* copy the snapshot 'snapshot_name' into the current disk image */
2030 static int qcow_snapshot_goto(BlockDriverState
*bs
,
2031 const char *snapshot_id
)
2033 BDRVQcowState
*s
= bs
->opaque
;
2035 int i
, snapshot_index
, l1_size2
;
2037 snapshot_index
= find_snapshot_by_id_or_name(bs
, snapshot_id
);
2038 if (snapshot_index
< 0)
2040 sn
= &s
->snapshots
[snapshot_index
];
2042 if (update_snapshot_refcount(bs
, s
->l1_table_offset
, s
->l1_size
, -1) < 0)
2045 if (grow_l1_table(bs
, sn
->l1_size
) < 0)
2048 s
->l1_size
= sn
->l1_size
;
2049 l1_size2
= s
->l1_size
* sizeof(uint64_t);
2050 /* copy the snapshot l1 table to the current l1 table */
2051 if (bdrv_pread(s
->hd
, sn
->l1_table_offset
,
2052 s
->l1_table
, l1_size2
) != l1_size2
)
2054 if (bdrv_pwrite(s
->hd
, s
->l1_table_offset
,
2055 s
->l1_table
, l1_size2
) != l1_size2
)
2057 for(i
= 0;i
< s
->l1_size
; i
++) {
2058 be64_to_cpus(&s
->l1_table
[i
]);
2061 if (update_snapshot_refcount(bs
, s
->l1_table_offset
, s
->l1_size
, 1) < 0)
2065 check_refcounts(bs
);
2072 static int qcow_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
2074 BDRVQcowState
*s
= bs
->opaque
;
2076 int snapshot_index
, ret
;
2078 snapshot_index
= find_snapshot_by_id_or_name(bs
, snapshot_id
);
2079 if (snapshot_index
< 0)
2081 sn
= &s
->snapshots
[snapshot_index
];
2083 ret
= update_snapshot_refcount(bs
, sn
->l1_table_offset
, sn
->l1_size
, -1);
2086 /* must update the copied flag on the current cluster offsets */
2087 ret
= update_snapshot_refcount(bs
, s
->l1_table_offset
, s
->l1_size
, 0);
2090 free_clusters(bs
, sn
->l1_table_offset
, sn
->l1_size
* sizeof(uint64_t));
2092 qemu_free(sn
->id_str
);
2093 qemu_free(sn
->name
);
2094 memmove(sn
, sn
+ 1, (s
->nb_snapshots
- snapshot_index
- 1) * sizeof(*sn
));
2096 ret
= qcow_write_snapshots(bs
);
2098 /* XXX: restore snapshot if error ? */
2102 check_refcounts(bs
);
2107 static int qcow_snapshot_list(BlockDriverState
*bs
,
2108 QEMUSnapshotInfo
**psn_tab
)
2110 BDRVQcowState
*s
= bs
->opaque
;
2111 QEMUSnapshotInfo
*sn_tab
, *sn_info
;
2115 sn_tab
= qemu_mallocz(s
->nb_snapshots
* sizeof(QEMUSnapshotInfo
));
2116 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
2117 sn_info
= sn_tab
+ i
;
2118 sn
= s
->snapshots
+ i
;
2119 pstrcpy(sn_info
->id_str
, sizeof(sn_info
->id_str
),
2121 pstrcpy(sn_info
->name
, sizeof(sn_info
->name
),
2123 sn_info
->vm_state_size
= sn
->vm_state_size
;
2124 sn_info
->date_sec
= sn
->date_sec
;
2125 sn_info
->date_nsec
= sn
->date_nsec
;
2126 sn_info
->vm_clock_nsec
= sn
->vm_clock_nsec
;
2129 return s
->nb_snapshots
;
2132 /*********************************************************/
2133 /* refcount handling */
2135 static int refcount_init(BlockDriverState
*bs
)
2137 BDRVQcowState
*s
= bs
->opaque
;
2138 int ret
, refcount_table_size2
, i
;
2140 s
->refcount_block_cache
= qemu_malloc(s
->cluster_size
);
2141 refcount_table_size2
= s
->refcount_table_size
* sizeof(uint64_t);
2142 s
->refcount_table
= qemu_malloc(refcount_table_size2
);
2143 if (s
->refcount_table_size
> 0) {
2144 ret
= bdrv_pread(s
->hd
, s
->refcount_table_offset
,
2145 s
->refcount_table
, refcount_table_size2
);
2146 if (ret
!= refcount_table_size2
)
2148 for(i
= 0; i
< s
->refcount_table_size
; i
++)
2149 be64_to_cpus(&s
->refcount_table
[i
]);
2156 static void refcount_close(BlockDriverState
*bs
)
2158 BDRVQcowState
*s
= bs
->opaque
;
2159 qemu_free(s
->refcount_block_cache
);
2160 qemu_free(s
->refcount_table
);
2164 static int load_refcount_block(BlockDriverState
*bs
,
2165 int64_t refcount_block_offset
)
2167 BDRVQcowState
*s
= bs
->opaque
;
2169 ret
= bdrv_pread(s
->hd
, refcount_block_offset
, s
->refcount_block_cache
,
2171 if (ret
!= s
->cluster_size
)
2173 s
->refcount_block_cache_offset
= refcount_block_offset
;
2177 static int get_refcount(BlockDriverState
*bs
, int64_t cluster_index
)
2179 BDRVQcowState
*s
= bs
->opaque
;
2180 int refcount_table_index
, block_index
;
2181 int64_t refcount_block_offset
;
2183 refcount_table_index
= cluster_index
>> (s
->cluster_bits
- REFCOUNT_SHIFT
);
2184 if (refcount_table_index
>= s
->refcount_table_size
)
2186 refcount_block_offset
= s
->refcount_table
[refcount_table_index
];
2187 if (!refcount_block_offset
)
2189 if (refcount_block_offset
!= s
->refcount_block_cache_offset
) {
2190 /* better than nothing: return allocated if read error */
2191 if (load_refcount_block(bs
, refcount_block_offset
) < 0)
2194 block_index
= cluster_index
&
2195 ((1 << (s
->cluster_bits
- REFCOUNT_SHIFT
)) - 1);
2196 return be16_to_cpu(s
->refcount_block_cache
[block_index
]);
2199 /* return < 0 if error */
2200 static int64_t alloc_clusters_noref(BlockDriverState
*bs
, int64_t size
)
2202 BDRVQcowState
*s
= bs
->opaque
;
2205 nb_clusters
= size_to_clusters(s
, size
);
2207 for(i
= 0; i
< nb_clusters
; i
++) {
2208 int64_t i
= s
->free_cluster_index
++;
2209 if (get_refcount(bs
, i
) != 0)
2213 printf("alloc_clusters: size=%lld -> %lld\n",
2215 (s
->free_cluster_index
- nb_clusters
) << s
->cluster_bits
);
2217 return (s
->free_cluster_index
- nb_clusters
) << s
->cluster_bits
;
2220 static int64_t alloc_clusters(BlockDriverState
*bs
, int64_t size
)
2224 offset
= alloc_clusters_noref(bs
, size
);
2225 update_refcount(bs
, offset
, size
, 1);
2229 /* only used to allocate compressed sectors. We try to allocate
2230 contiguous sectors. size must be <= cluster_size */
2231 static int64_t alloc_bytes(BlockDriverState
*bs
, int size
)
2233 BDRVQcowState
*s
= bs
->opaque
;
2234 int64_t offset
, cluster_offset
;
2235 int free_in_cluster
;
2237 assert(size
> 0 && size
<= s
->cluster_size
);
2238 if (s
->free_byte_offset
== 0) {
2239 s
->free_byte_offset
= alloc_clusters(bs
, s
->cluster_size
);
2242 free_in_cluster
= s
->cluster_size
-
2243 (s
->free_byte_offset
& (s
->cluster_size
- 1));
2244 if (size
<= free_in_cluster
) {
2245 /* enough space in current cluster */
2246 offset
= s
->free_byte_offset
;
2247 s
->free_byte_offset
+= size
;
2248 free_in_cluster
-= size
;
2249 if (free_in_cluster
== 0)
2250 s
->free_byte_offset
= 0;
2251 if ((offset
& (s
->cluster_size
- 1)) != 0)
2252 update_cluster_refcount(bs
, offset
>> s
->cluster_bits
, 1);
2254 offset
= alloc_clusters(bs
, s
->cluster_size
);
2255 cluster_offset
= s
->free_byte_offset
& ~(s
->cluster_size
- 1);
2256 if ((cluster_offset
+ s
->cluster_size
) == offset
) {
2257 /* we are lucky: contiguous data */
2258 offset
= s
->free_byte_offset
;
2259 update_cluster_refcount(bs
, offset
>> s
->cluster_bits
, 1);
2260 s
->free_byte_offset
+= size
;
2262 s
->free_byte_offset
= offset
;
2269 static void free_clusters(BlockDriverState
*bs
,
2270 int64_t offset
, int64_t size
)
2272 update_refcount(bs
, offset
, size
, -1);
2275 static int grow_refcount_table(BlockDriverState
*bs
, int min_size
)
2277 BDRVQcowState
*s
= bs
->opaque
;
2278 int new_table_size
, new_table_size2
, refcount_table_clusters
, i
, ret
;
2279 uint64_t *new_table
;
2280 int64_t table_offset
;
2283 int64_t old_table_offset
;
2285 if (min_size
<= s
->refcount_table_size
)
2287 /* compute new table size */
2288 refcount_table_clusters
= s
->refcount_table_size
>> (s
->cluster_bits
- 3);
2290 if (refcount_table_clusters
== 0) {
2291 refcount_table_clusters
= 1;
2293 refcount_table_clusters
= (refcount_table_clusters
* 3 + 1) / 2;
2295 new_table_size
= refcount_table_clusters
<< (s
->cluster_bits
- 3);
2296 if (min_size
<= new_table_size
)
2300 printf("grow_refcount_table from %d to %d\n",
2301 s
->refcount_table_size
,
2304 new_table_size2
= new_table_size
* sizeof(uint64_t);
2305 new_table
= qemu_mallocz(new_table_size2
);
2306 memcpy(new_table
, s
->refcount_table
,
2307 s
->refcount_table_size
* sizeof(uint64_t));
2308 for(i
= 0; i
< s
->refcount_table_size
; i
++)
2309 cpu_to_be64s(&new_table
[i
]);
2310 /* Note: we cannot update the refcount now to avoid recursion */
2311 table_offset
= alloc_clusters_noref(bs
, new_table_size2
);
2312 ret
= bdrv_pwrite(s
->hd
, table_offset
, new_table
, new_table_size2
);
2313 if (ret
!= new_table_size2
)
2315 for(i
= 0; i
< s
->refcount_table_size
; i
++)
2316 be64_to_cpus(&new_table
[i
]);
2318 cpu_to_be64w((uint64_t*)data
, table_offset
);
2319 cpu_to_be32w((uint32_t*)(data
+ 8), refcount_table_clusters
);
2320 if (bdrv_pwrite(s
->hd
, offsetof(QCowHeader
, refcount_table_offset
),
2321 data
, sizeof(data
)) != sizeof(data
))
2323 qemu_free(s
->refcount_table
);
2324 old_table_offset
= s
->refcount_table_offset
;
2325 old_table_size
= s
->refcount_table_size
;
2326 s
->refcount_table
= new_table
;
2327 s
->refcount_table_size
= new_table_size
;
2328 s
->refcount_table_offset
= table_offset
;
2330 update_refcount(bs
, table_offset
, new_table_size2
, 1);
2331 free_clusters(bs
, old_table_offset
, old_table_size
* sizeof(uint64_t));
2334 free_clusters(bs
, table_offset
, new_table_size2
);
2335 qemu_free(new_table
);
2339 /* addend must be 1 or -1 */
2340 /* XXX: cache several refcount block clusters ? */
2341 static int update_cluster_refcount(BlockDriverState
*bs
,
2342 int64_t cluster_index
,
2345 BDRVQcowState
*s
= bs
->opaque
;
2346 int64_t offset
, refcount_block_offset
;
2347 int ret
, refcount_table_index
, block_index
, refcount
;
2350 refcount_table_index
= cluster_index
>> (s
->cluster_bits
- REFCOUNT_SHIFT
);
2351 if (refcount_table_index
>= s
->refcount_table_size
) {
2354 ret
= grow_refcount_table(bs
, refcount_table_index
+ 1);
2358 refcount_block_offset
= s
->refcount_table
[refcount_table_index
];
2359 if (!refcount_block_offset
) {
2362 /* create a new refcount block */
2363 /* Note: we cannot update the refcount now to avoid recursion */
2364 offset
= alloc_clusters_noref(bs
, s
->cluster_size
);
2365 memset(s
->refcount_block_cache
, 0, s
->cluster_size
);
2366 ret
= bdrv_pwrite(s
->hd
, offset
, s
->refcount_block_cache
, s
->cluster_size
);
2367 if (ret
!= s
->cluster_size
)
2369 s
->refcount_table
[refcount_table_index
] = offset
;
2370 data64
= cpu_to_be64(offset
);
2371 ret
= bdrv_pwrite(s
->hd
, s
->refcount_table_offset
+
2372 refcount_table_index
* sizeof(uint64_t),
2373 &data64
, sizeof(data64
));
2374 if (ret
!= sizeof(data64
))
2377 refcount_block_offset
= offset
;
2378 s
->refcount_block_cache_offset
= offset
;
2379 update_refcount(bs
, offset
, s
->cluster_size
, 1);
2381 if (refcount_block_offset
!= s
->refcount_block_cache_offset
) {
2382 if (load_refcount_block(bs
, refcount_block_offset
) < 0)
2386 /* we can update the count and save it */
2387 block_index
= cluster_index
&
2388 ((1 << (s
->cluster_bits
- REFCOUNT_SHIFT
)) - 1);
2389 refcount
= be16_to_cpu(s
->refcount_block_cache
[block_index
]);
2391 if (refcount
< 0 || refcount
> 0xffff)
2393 if (refcount
== 0 && cluster_index
< s
->free_cluster_index
) {
2394 s
->free_cluster_index
= cluster_index
;
2396 s
->refcount_block_cache
[block_index
] = cpu_to_be16(refcount
);
2397 if (bdrv_pwrite(s
->hd
,
2398 refcount_block_offset
+ (block_index
<< REFCOUNT_SHIFT
),
2399 &s
->refcount_block_cache
[block_index
], 2) != 2)
2404 static void update_refcount(BlockDriverState
*bs
,
2405 int64_t offset
, int64_t length
,
2408 BDRVQcowState
*s
= bs
->opaque
;
2409 int64_t start
, last
, cluster_offset
;
2412 printf("update_refcount: offset=%lld size=%lld addend=%d\n",
2413 offset
, length
, addend
);
2417 start
= offset
& ~(s
->cluster_size
- 1);
2418 last
= (offset
+ length
- 1) & ~(s
->cluster_size
- 1);
2419 for(cluster_offset
= start
; cluster_offset
<= last
;
2420 cluster_offset
+= s
->cluster_size
) {
2421 update_cluster_refcount(bs
, cluster_offset
>> s
->cluster_bits
, addend
);
2426 static void inc_refcounts(BlockDriverState
*bs
,
2427 uint16_t *refcount_table
,
2428 int refcount_table_size
,
2429 int64_t offset
, int64_t size
)
2431 BDRVQcowState
*s
= bs
->opaque
;
2432 int64_t start
, last
, cluster_offset
;
2438 start
= offset
& ~(s
->cluster_size
- 1);
2439 last
= (offset
+ size
- 1) & ~(s
->cluster_size
- 1);
2440 for(cluster_offset
= start
; cluster_offset
<= last
;
2441 cluster_offset
+= s
->cluster_size
) {
2442 k
= cluster_offset
>> s
->cluster_bits
;
2443 if (k
< 0 || k
>= refcount_table_size
) {
2444 printf("ERROR: invalid cluster offset=0x%llx\n", cluster_offset
);
2446 if (++refcount_table
[k
] == 0) {
2447 printf("ERROR: overflow cluster offset=0x%llx\n", cluster_offset
);
2453 static int check_refcounts_l1(BlockDriverState
*bs
,
2454 uint16_t *refcount_table
,
2455 int refcount_table_size
,
2456 int64_t l1_table_offset
, int l1_size
,
2459 BDRVQcowState
*s
= bs
->opaque
;
2460 uint64_t *l1_table
, *l2_table
, l2_offset
, offset
, l1_size2
;
2461 int l2_size
, i
, j
, nb_csectors
, refcount
;
2464 l1_size2
= l1_size
* sizeof(uint64_t);
2466 inc_refcounts(bs
, refcount_table
, refcount_table_size
,
2467 l1_table_offset
, l1_size2
);
2469 l1_table
= qemu_malloc(l1_size2
);
2470 if (bdrv_pread(s
->hd
, l1_table_offset
,
2471 l1_table
, l1_size2
) != l1_size2
)
2473 for(i
= 0;i
< l1_size
; i
++)
2474 be64_to_cpus(&l1_table
[i
]);
2476 l2_size
= s
->l2_size
* sizeof(uint64_t);
2477 l2_table
= qemu_malloc(l2_size
);
2478 for(i
= 0; i
< l1_size
; i
++) {
2479 l2_offset
= l1_table
[i
];
2482 refcount
= get_refcount(bs
, (l2_offset
& ~QCOW_OFLAG_COPIED
) >> s
->cluster_bits
);
2483 if ((refcount
== 1) != ((l2_offset
& QCOW_OFLAG_COPIED
) != 0)) {
2484 printf("ERROR OFLAG_COPIED: l2_offset=%llx refcount=%d\n",
2485 l2_offset
, refcount
);
2488 l2_offset
&= ~QCOW_OFLAG_COPIED
;
2489 if (bdrv_pread(s
->hd
, l2_offset
, l2_table
, l2_size
) != l2_size
)
2491 for(j
= 0; j
< s
->l2_size
; j
++) {
2492 offset
= be64_to_cpu(l2_table
[j
]);
2494 if (offset
& QCOW_OFLAG_COMPRESSED
) {
2495 if (offset
& QCOW_OFLAG_COPIED
) {
2496 printf("ERROR: cluster %lld: copied flag must never be set for compressed clusters\n",
2497 offset
>> s
->cluster_bits
);
2498 offset
&= ~QCOW_OFLAG_COPIED
;
2500 nb_csectors
= ((offset
>> s
->csize_shift
) &
2502 offset
&= s
->cluster_offset_mask
;
2503 inc_refcounts(bs
, refcount_table
,
2504 refcount_table_size
,
2505 offset
& ~511, nb_csectors
* 512);
2508 refcount
= get_refcount(bs
, (offset
& ~QCOW_OFLAG_COPIED
) >> s
->cluster_bits
);
2509 if ((refcount
== 1) != ((offset
& QCOW_OFLAG_COPIED
) != 0)) {
2510 printf("ERROR OFLAG_COPIED: offset=%llx refcount=%d\n",
2514 offset
&= ~QCOW_OFLAG_COPIED
;
2515 inc_refcounts(bs
, refcount_table
,
2516 refcount_table_size
,
2517 offset
, s
->cluster_size
);
2521 inc_refcounts(bs
, refcount_table
,
2522 refcount_table_size
,
2527 qemu_free(l1_table
);
2528 qemu_free(l2_table
);
2531 printf("ERROR: I/O error in check_refcounts_l1\n");
2532 qemu_free(l1_table
);
2533 qemu_free(l2_table
);
2537 static void check_refcounts(BlockDriverState
*bs
)
2539 BDRVQcowState
*s
= bs
->opaque
;
2541 int nb_clusters
, refcount1
, refcount2
, i
;
2543 uint16_t *refcount_table
;
2545 size
= bdrv_getlength(s
->hd
);
2546 nb_clusters
= size_to_clusters(s
, size
);
2547 refcount_table
= qemu_mallocz(nb_clusters
* sizeof(uint16_t));
2550 inc_refcounts(bs
, refcount_table
, nb_clusters
,
2551 0, s
->cluster_size
);
2553 check_refcounts_l1(bs
, refcount_table
, nb_clusters
,
2554 s
->l1_table_offset
, s
->l1_size
, 1);
2557 for(i
= 0; i
< s
->nb_snapshots
; i
++) {
2558 sn
= s
->snapshots
+ i
;
2559 check_refcounts_l1(bs
, refcount_table
, nb_clusters
,
2560 sn
->l1_table_offset
, sn
->l1_size
, 0);
2562 inc_refcounts(bs
, refcount_table
, nb_clusters
,
2563 s
->snapshots_offset
, s
->snapshots_size
);
2566 inc_refcounts(bs
, refcount_table
, nb_clusters
,
2567 s
->refcount_table_offset
,
2568 s
->refcount_table_size
* sizeof(uint64_t));
2569 for(i
= 0; i
< s
->refcount_table_size
; i
++) {
2571 offset
= s
->refcount_table
[i
];
2573 inc_refcounts(bs
, refcount_table
, nb_clusters
,
2574 offset
, s
->cluster_size
);
2578 /* compare ref counts */
2579 for(i
= 0; i
< nb_clusters
; i
++) {
2580 refcount1
= get_refcount(bs
, i
);
2581 refcount2
= refcount_table
[i
];
2582 if (refcount1
!= refcount2
)
2583 printf("ERROR cluster %d refcount=%d reference=%d\n",
2584 i
, refcount1
, refcount2
);
2587 qemu_free(refcount_table
);
2591 static void dump_refcounts(BlockDriverState
*bs
)
2593 BDRVQcowState
*s
= bs
->opaque
;
2594 int64_t nb_clusters
, k
, k1
, size
;
2597 size
= bdrv_getlength(s
->hd
);
2598 nb_clusters
= size_to_clusters(s
, size
);
2599 for(k
= 0; k
< nb_clusters
;) {
2601 refcount
= get_refcount(bs
, k
);
2603 while (k
< nb_clusters
&& get_refcount(bs
, k
) == refcount
)
2605 printf("%lld: refcount=%d nb=%lld\n", k
, refcount
, k
- k1
);
2611 static int qcow_put_buffer(BlockDriverState
*bs
, const uint8_t *buf
,
2612 int64_t pos
, int size
)
2614 int growable
= bs
->growable
;
2617 bdrv_pwrite(bs
, pos
, buf
, size
);
2618 bs
->growable
= growable
;
2623 static int qcow_get_buffer(BlockDriverState
*bs
, uint8_t *buf
,
2624 int64_t pos
, int size
)
2626 int growable
= bs
->growable
;
2630 ret
= bdrv_pread(bs
, pos
, buf
, size
);
2631 bs
->growable
= growable
;
2636 BlockDriver bdrv_qcow2
= {
2638 sizeof(BDRVQcowState
),
2650 .bdrv_aio_read
= qcow_aio_read
,
2651 .bdrv_aio_write
= qcow_aio_write
,
2652 .bdrv_aio_cancel
= qcow_aio_cancel
,
2653 .aiocb_size
= sizeof(QCowAIOCB
),
2654 .bdrv_write_compressed
= qcow_write_compressed
,
2656 .bdrv_snapshot_create
= qcow_snapshot_create
,
2657 .bdrv_snapshot_goto
= qcow_snapshot_goto
,
2658 .bdrv_snapshot_delete
= qcow_snapshot_delete
,
2659 .bdrv_snapshot_list
= qcow_snapshot_list
,
2660 .bdrv_get_info
= qcow_get_info
,
2662 .bdrv_put_buffer
= qcow_put_buffer
,
2663 .bdrv_get_buffer
= qcow_get_buffer
,