Merge remote-tracking branch 'remotes/kevin/tags/for-upstream' into staging
[qemu/ar7.git] / qemu-img.texi
blob8a26400adbb2aa6cea97e5bae77c500beb3b7452
1 @example
2 @c man begin SYNOPSIS
3 @command{qemu-img} [@var{standard} @var{options}] @var{command} [@var{command} @var{options}]
4 @c man end
5 @end example
7 @c man begin DESCRIPTION
8 qemu-img allows you to create, convert and modify images offline. It can handle
9 all image formats supported by QEMU.
11 @b{Warning:} Never use qemu-img to modify images in use by a running virtual
12 machine or any other process; this may destroy the image. Also, be aware that
13 querying an image that is being modified by another process may encounter
14 inconsistent state.
15 @c man end
17 @c man begin OPTIONS
19 Standard options:
20 @table @option
21 @item -h, --help
22 Display this help and exit
23 @item -V, --version
24 Display version information and exit
25 @item -T, --trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
26 @findex --trace
27 @include qemu-option-trace.texi
28 @end table
30 The following commands are supported:
32 @include qemu-img-cmds.texi
34 Command parameters:
35 @table @var
37 @item filename
38 is a disk image filename
40 @item fmt
41 is the disk image format. It is guessed automatically in most cases. See below
42 for a description of the supported disk formats.
44 @item size
45 is the disk image size in bytes. Optional suffixes @code{k} or @code{K}
46 (kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M)
47 and T (terabyte, 1024G) are supported.  @code{b} is ignored.
49 @item output_filename
50 is the destination disk image filename
52 @item output_fmt
53 is the destination format
55 @item options
56 is a comma separated list of format specific options in a
57 name=value format. Use @code{-o ?} for an overview of the options supported
58 by the used format or see the format descriptions below for details.
60 @item snapshot_param
61 is param used for internal snapshot, format is
62 'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
64 @item snapshot_id_or_name
65 is deprecated, use snapshot_param instead
67 @end table
69 @table @option
71 @item --object @var{objectdef}
72 is a QEMU user creatable object definition. See the @code{qemu(1)} manual
73 page for a description of the object properties. The most common object
74 type is a @code{secret}, which is used to supply passwords and/or encryption
75 keys.
77 @item --image-opts
78 Indicates that the source @var{filename} parameter is to be interpreted as a
79 full option string, not a plain filename. This parameter is mutually
80 exclusive with the @var{-f} parameter.
82 @item --target-image-opts
83 Indicates that the @var{output_filename} parameter(s) are to be interpreted as
84 a full option string, not a plain filename. This parameter is mutually
85 exclusive with the @var{-O} parameters. It is currently required to also use
86 the @var{-n} parameter to skip image creation. This restriction may be relaxed
87 in a future release.
89 @item --force-share (-U)
90 If specified, @code{qemu-img} will open the image in shared mode, allowing
91 other QEMU processes to open it in write mode. For example, this can be used to
92 get the image information (with 'info' subcommand) when the image is used by a
93 running guest.  Note that this could produce inconsistent results because of
94 concurrent metadata changes, etc. This option is only allowed when opening
95 images in read-only mode.
97 @item --backing-chain
98 will enumerate information about backing files in a disk image chain. Refer
99 below for further description.
101 @item -c
102 indicates that target image must be compressed (qcow format only)
104 @item -h
105 with or without a command shows help and lists the supported formats
107 @item -p
108 display progress bar (compare, convert and rebase commands only).
109 If the @var{-p} option is not used for a command that supports it, the
110 progress is reported when the process receives a @code{SIGUSR1} or
111 @code{SIGINFO} signal.
113 @item -q
114 Quiet mode - do not print any output (except errors). There's no progress bar
115 in case both @var{-q} and @var{-p} options are used.
117 @item -S @var{size}
118 indicates the consecutive number of bytes that must contain only zeros
119 for qemu-img to create a sparse image during conversion. This value is rounded
120 down to the nearest 512 bytes. You may use the common size suffixes like
121 @code{k} for kilobytes.
123 @item -t @var{cache}
124 specifies the cache mode that should be used with the (destination) file. See
125 the documentation of the emulator's @code{-drive cache=...} option for allowed
126 values.
128 @item -T @var{src_cache}
129 specifies the cache mode that should be used with the source file(s). See
130 the documentation of the emulator's @code{-drive cache=...} option for allowed
131 values.
133 @end table
135 Parameters to snapshot subcommand:
137 @table @option
139 @item snapshot
140 is the name of the snapshot to create, apply or delete
141 @item -a
142 applies a snapshot (revert disk to saved state)
143 @item -c
144 creates a snapshot
145 @item -d
146 deletes a snapshot
147 @item -l
148 lists all snapshots in the given image
149 @end table
151 Parameters to compare subcommand:
153 @table @option
155 @item -f
156 First image format
157 @item -F
158 Second image format
159 @item -s
160 Strict mode - fail on different image size or sector allocation
161 @end table
163 Parameters to convert subcommand:
165 @table @option
167 @item -n
168 Skip the creation of the target volume
169 @item -m
170 Number of parallel coroutines for the convert process
171 @item -W
172 Allow out-of-order writes to the destination. This option improves performance,
173 but is only recommended for preallocated devices like host devices or other
174 raw block devices.
175 @end table
177 Parameters to dd subcommand:
179 @table @option
181 @item bs=@var{block_size}
182 defines the block size
183 @item count=@var{blocks}
184 sets the number of input blocks to copy
185 @item if=@var{input}
186 sets the input file
187 @item of=@var{output}
188 sets the output file
189 @item skip=@var{blocks}
190 sets the number of input blocks to skip
191 @end table
193 Command description:
195 @table @option
196 @item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] [--flush-interval=@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}] [--pattern=@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t @var{cache}] [-w] @var{filename}
198 Run a simple sequential I/O benchmark on the specified image. If @code{-w} is
199 specified, a write test is performed, otherwise a read test is performed.
201 A total number of @var{count} I/O requests is performed, each @var{buffer_size}
202 bytes in size, and with @var{depth} requests in parallel. The first request
203 starts at the position given by @var{offset}, each following request increases
204 the current position by @var{step_size}. If @var{step_size} is not given,
205 @var{buffer_size} is used for its value.
207 If @var{flush_interval} is specified for a write test, the request queue is
208 drained and a flush is issued before new writes are made whenever the number of
209 remaining requests is a multiple of @var{flush_interval}. If additionally
210 @code{--no-drain} is specified, a flush is issued without draining the request
211 queue first.
213 If @code{-n} is specified, the native AIO backend is used if possible. On
214 Linux, this option only works if @code{-t none} or @code{-t directsync} is
215 specified as well.
217 For write tests, by default a buffer filled with zeros is written. This can be
218 overridden with a pattern byte specified by @var{pattern}.
220 @item check [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
222 Perform a consistency check on the disk image @var{filename}. The command can
223 output in the format @var{ofmt} which is either @code{human} or @code{json}.
225 If @code{-r} is specified, qemu-img tries to repair any inconsistencies found
226 during the check. @code{-r leaks} repairs only cluster leaks, whereas
227 @code{-r all} fixes all kinds of errors, with a higher risk of choosing the
228 wrong fix or hiding corruption that has already occurred.
230 Only the formats @code{qcow2}, @code{qed} and @code{vdi} support
231 consistency checks.
233 In case the image does not have any inconsistencies, check exits with @code{0}.
234 Other exit codes indicate the kind of inconsistency found or if another error
235 occurred. The following table summarizes all exit codes of the check subcommand:
237 @table @option
239 @item 0
240 Check completed, the image is (now) consistent
241 @item 1
242 Check not completed because of internal errors
243 @item 2
244 Check completed, image is corrupted
245 @item 3
246 Check completed, image has leaked clusters, but is not corrupted
247 @item 63
248 Checks are not supported by the image format
250 @end table
252 If @code{-r} is specified, exit codes representing the image state refer to the
253 state after (the attempt at) repairing it. That is, a successful @code{-r all}
254 will yield the exit code 0, independently of the image state before.
256 @item create [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} [@var{size}]
258 Create the new disk image @var{filename} of size @var{size} and format
259 @var{fmt}. Depending on the file format, you can add one or more @var{options}
260 that enable additional features of this format.
262 If the option @var{backing_file} is specified, then the image will record
263 only the differences from @var{backing_file}. No size needs to be specified in
264 this case. @var{backing_file} will never be modified unless you use the
265 @code{commit} monitor command (or qemu-img commit).
267 If a relative path name is given, the backing file is looked up relative to
268 the directory containing @var{filename}.
270 Note that a given backing file will be opened to check that it is valid. Use
271 the @code{-u} option to enable unsafe backing file mode, which means that the
272 image will be created even if the associated backing file cannot be opened. A
273 matching backing file must be created or additional options be used to make the
274 backing file specification valid when you want to use an image created this
275 way.
277 The size can also be specified using the @var{size} option with @code{-o},
278 it doesn't need to be specified separately in this case.
280 @item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
282 Commit the changes recorded in @var{filename} in its base image or backing file.
283 If the backing file is smaller than the snapshot, then the backing file will be
284 resized to be the same size as the snapshot.  If the snapshot is smaller than
285 the backing file, the backing file will not be truncated.  If you want the
286 backing file to match the size of the smaller snapshot, you can safely truncate
287 it yourself once the commit operation successfully completes.
289 The image @var{filename} is emptied after the operation has succeeded. If you do
290 not need @var{filename} afterwards and intend to drop it, you may skip emptying
291 @var{filename} by specifying the @code{-d} flag.
293 If the backing chain of the given image file @var{filename} has more than one
294 layer, the backing file into which the changes will be committed may be
295 specified as @var{base} (which has to be part of @var{filename}'s backing
296 chain). If @var{base} is not specified, the immediate backing file of the top
297 image (which is @var{filename}) will be used. Note that after a commit operation
298 all images between @var{base} and the top image will be invalid and may return
299 garbage data when read. For this reason, @code{-b} implies @code{-d} (so that
300 the top image stays valid).
302 @item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-s] [-q] @var{filename1} @var{filename2}
304 Check if two images have the same content. You can compare images with
305 different format or settings.
307 The format is probed unless you specify it by @var{-f} (used for
308 @var{filename1}) and/or @var{-F} (used for @var{filename2}) option.
310 By default, images with different size are considered identical if the larger
311 image contains only unallocated and/or zeroed sectors in the area after the end
312 of the other image. In addition, if any sector is not allocated in one image
313 and contains only zero bytes in the second one, it is evaluated as equal. You
314 can use Strict mode by specifying the @var{-s} option. When compare runs in
315 Strict mode, it fails in case image size differs or a sector is allocated in
316 one image and is not allocated in the second one.
318 By default, compare prints out a result message. This message displays
319 information that both images are same or the position of the first different
320 byte. In addition, result message can report different image size in case
321 Strict mode is used.
323 Compare exits with @code{0} in case the images are equal and with @code{1}
324 in case the images differ. Other exit codes mean an error occurred during
325 execution and standard error output should contain an error message.
326 The following table sumarizes all exit codes of the compare subcommand:
328 @table @option
330 @item 0
331 Images are identical
332 @item 1
333 Images differ
334 @item 2
335 Error on opening an image
336 @item 3
337 Error on checking a sector allocation
338 @item 4
339 Error on reading data
341 @end table
343 @item convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
345 Convert the disk image @var{filename} or a snapshot @var{snapshot_param}(@var{snapshot_id_or_name} is deprecated)
346 to disk image @var{output_filename} using format @var{output_fmt}. It can be optionally compressed (@code{-c}
347 option) or use any format specific options like encryption (@code{-o} option).
349 Only the formats @code{qcow} and @code{qcow2} support compression. The
350 compression is read-only. It means that if a compressed sector is
351 rewritten, then it is rewritten as uncompressed data.
353 Image conversion is also useful to get smaller image when using a
354 growable format such as @code{qcow}: the empty sectors are detected and
355 suppressed from the destination image.
357 @var{sparse_size} indicates the consecutive number of bytes (defaults to 4k)
358 that must contain only zeros for qemu-img to create a sparse image during
359 conversion. If @var{sparse_size} is 0, the source will not be scanned for
360 unallocated or zero sectors, and the destination image will always be
361 fully allocated.
363 You can use the @var{backing_file} option to force the output image to be
364 created as a copy on write image of the specified base image; the
365 @var{backing_file} should have the same content as the input's base image,
366 however the path, image format, etc may differ.
368 If a relative path name is given, the backing file is looked up relative to
369 the directory containing @var{output_filename}.
371 If the @code{-n} option is specified, the target volume creation will be
372 skipped. This is useful for formats such as @code{rbd} if the target
373 volume has already been created with site specific options that cannot
374 be supplied through qemu-img.
376 Out of order writes can be enabled with @code{-W} to improve performance.
377 This is only recommended for preallocated devices like host devices or other
378 raw block devices. Out of order write does not work in combination with
379 creating compressed images.
381 @var{num_coroutines} specifies how many coroutines work in parallel during
382 the convert process (defaults to 8).
384 @item dd [-f @var{fmt}] [-O @var{output_fmt}] [bs=@var{block_size}] [count=@var{blocks}] [skip=@var{blocks}] if=@var{input} of=@var{output}
386 Dd copies from @var{input} file to @var{output} file converting it from
387 @var{fmt} format to @var{output_fmt} format.
389 The data is by default read and written using blocks of 512 bytes but can be
390 modified by specifying @var{block_size}. If count=@var{blocks} is specified
391 dd will stop reading input after reading @var{blocks} input blocks.
393 The size syntax is similar to dd(1)'s size syntax.
395 @item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
397 Give information about the disk image @var{filename}. Use it in
398 particular to know the size reserved on disk which can be different
399 from the displayed size. If VM snapshots are stored in the disk image,
400 they are displayed too. The command can output in the format @var{ofmt}
401 which is either @code{human} or @code{json}.
403 If a disk image has a backing file chain, information about each disk image in
404 the chain can be recursively enumerated by using the option @code{--backing-chain}.
406 For instance, if you have an image chain like:
408 @example
409 base.qcow2 <- snap1.qcow2 <- snap2.qcow2
410 @end example
412 To enumerate information about each disk image in the above chain, starting from top to base, do:
414 @example
415 qemu-img info --backing-chain snap2.qcow2
416 @end example
418 @item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
420 Dump the metadata of image @var{filename} and its backing file chain.
421 In particular, this commands dumps the allocation state of every sector
422 of @var{filename}, together with the topmost file that allocates it in
423 the backing file chain.
425 Two option formats are possible.  The default format (@code{human})
426 only dumps known-nonzero areas of the file.  Known-zero parts of the
427 file are omitted altogether, and likewise for parts that are not allocated
428 throughout the chain.  @command{qemu-img} output will identify a file
429 from where the data can be read, and the offset in the file.  Each line
430 will include four fields, the first three of which are hexadecimal
431 numbers.  For example the first line of:
432 @example
433 Offset          Length          Mapped to       File
434 0               0x20000         0x50000         /tmp/overlay.qcow2
435 0x100000        0x10000         0x95380000      /tmp/backing.qcow2
436 @end example
437 @noindent
438 means that 0x20000 (131072) bytes starting at offset 0 in the image are
439 available in /tmp/overlay.qcow2 (opened in @code{raw} format) starting
440 at offset 0x50000 (327680).  Data that is compressed, encrypted, or
441 otherwise not available in raw format will cause an error if @code{human}
442 format is in use.  Note that file names can include newlines, thus it is
443 not safe to parse this output format in scripts.
445 The alternative format @code{json} will return an array of dictionaries
446 in JSON format.  It will include similar information in
447 the @code{start}, @code{length}, @code{offset} fields;
448 it will also include other more specific information:
449 @itemize @minus
450 @item
451 whether the sectors contain actual data or not (boolean field @code{data};
452 if false, the sectors are either unallocated or stored as optimized
453 all-zero clusters);
455 @item
456 whether the data is known to read as zero (boolean field @code{zero});
458 @item
459 in order to make the output shorter, the target file is expressed as
460 a @code{depth}; for example, a depth of 2 refers to the backing file
461 of the backing file of @var{filename}.
462 @end itemize
464 In JSON format, the @code{offset} field is optional; it is absent in
465 cases where @code{human} format would omit the entry or exit with an error.
466 If @code{data} is false and the @code{offset} field is present, the
467 corresponding sectors in the file are not yet in use, but they are
468 preallocated.
470 For more information, consult @file{include/block/block.h} in QEMU's
471 source code.
473 @item measure [--output=@var{ofmt}] [-O @var{output_fmt}] [-o @var{options}] [--size @var{N} | [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-l @var{snapshot_param}] @var{filename}]
475 Calculate the file size required for a new image.  This information can be used
476 to size logical volumes or SAN LUNs appropriately for the image that will be
477 placed in them.  The values reported are guaranteed to be large enough to fit
478 the image.  The command can output in the format @var{ofmt} which is either
479 @code{human} or @code{json}.
481 If the size @var{N} is given then act as if creating a new empty image file
482 using @command{qemu-img create}.  If @var{filename} is given then act as if
483 converting an existing image file using @command{qemu-img convert}.  The format
484 of the new file is given by @var{output_fmt} while the format of an existing
485 file is given by @var{fmt}.
487 A snapshot in an existing image can be specified using @var{snapshot_param}.
489 The following fields are reported:
490 @example
491 required size: 524288
492 fully allocated size: 1074069504
493 @end example
495 The @code{required size} is the file size of the new image.  It may be smaller
496 than the virtual disk size if the image format supports compact representation.
498 The @code{fully allocated size} is the file size of the new image once data has
499 been written to all sectors.  This is the maximum size that the image file can
500 occupy with the exception of internal snapshots, dirty bitmaps, vmstate data,
501 and other advanced image format features.
503 @item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot} ] @var{filename}
505 List, apply, create or delete snapshots in image @var{filename}.
507 @item rebase [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
509 Changes the backing file of an image. Only the formats @code{qcow2} and
510 @code{qed} support changing the backing file.
512 The backing file is changed to @var{backing_file} and (if the image format of
513 @var{filename} supports this) the backing file format is changed to
514 @var{backing_fmt}. If @var{backing_file} is specified as ``'' (the empty
515 string), then the image is rebased onto no backing file (i.e. it will exist
516 independently of any backing file).
518 If a relative path name is given, the backing file is looked up relative to
519 the directory containing @var{filename}.
521 @var{cache} specifies the cache mode to be used for @var{filename}, whereas
522 @var{src_cache} specifies the cache mode for reading backing files.
524 There are two different modes in which @code{rebase} can operate:
525 @table @option
526 @item Safe mode
527 This is the default mode and performs a real rebase operation. The new backing
528 file may differ from the old one and qemu-img rebase will take care of keeping
529 the guest-visible content of @var{filename} unchanged.
531 In order to achieve this, any clusters that differ between @var{backing_file}
532 and the old backing file of @var{filename} are merged into @var{filename}
533 before actually changing the backing file.
535 Note that the safe mode is an expensive operation, comparable to converting
536 an image. It only works if the old backing file still exists.
538 @item Unsafe mode
539 qemu-img uses the unsafe mode if @code{-u} is specified. In this mode, only the
540 backing file name and format of @var{filename} is changed without any checks
541 on the file contents. The user must take care of specifying the correct new
542 backing file, or the guest-visible content of the image will be corrupted.
544 This mode is useful for renaming or moving the backing file to somewhere else.
545 It can be used without an accessible old backing file, i.e. you can use it to
546 fix an image whose backing file has already been moved/renamed.
547 @end table
549 You can use @code{rebase} to perform a ``diff'' operation on two
550 disk images.  This can be useful when you have copied or cloned
551 a guest, and you want to get back to a thin image on top of a
552 template or base image.
554 Say that @code{base.img} has been cloned as @code{modified.img} by
555 copying it, and that the @code{modified.img} guest has run so there
556 are now some changes compared to @code{base.img}.  To construct a thin
557 image called @code{diff.qcow2} that contains just the differences, do:
559 @example
560 qemu-img create -f qcow2 -b modified.img diff.qcow2
561 qemu-img rebase -b base.img diff.qcow2
562 @end example
564 At this point, @code{modified.img} can be discarded, since
565 @code{base.img + diff.qcow2} contains the same information.
567 @item resize [--shrink] [--preallocation=@var{prealloc}] @var{filename} [+ | -]@var{size}
569 Change the disk image as if it had been created with @var{size}.
571 Before using this command to shrink a disk image, you MUST use file system and
572 partitioning tools inside the VM to reduce allocated file systems and partition
573 sizes accordingly.  Failure to do so will result in data loss!
575 When shrinking images, the @code{--shrink} option must be given. This informs
576 qemu-img that the user acknowledges all loss of data beyond the truncated
577 image's end.
579 After using this command to grow a disk image, you must use file system and
580 partitioning tools inside the VM to actually begin using the new space on the
581 device.
583 When growing an image, the @code{--preallocation} option may be used to specify
584 how the additional image area should be allocated on the host.  See the format
585 description in the @code{NOTES} section which values are allowed.  Using this
586 option may result in slightly more data being allocated than necessary.
588 @item amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
590 Amends the image format specific @var{options} for the image file
591 @var{filename}. Not all file formats support this operation.
592 @end table
593 @c man end
595 @ignore
596 @c man begin NOTES
597 Supported image file formats:
599 @table @option
600 @item raw
602 Raw disk image format (default). This format has the advantage of
603 being simple and easily exportable to all other emulators. If your
604 file system supports @emph{holes} (for example in ext2 or ext3 on
605 Linux or NTFS on Windows), then only the written sectors will reserve
606 space. Use @code{qemu-img info} to know the real size used by the
607 image or @code{ls -ls} on Unix/Linux.
609 Supported options:
610 @table @code
611 @item preallocation
612 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
613 @code{falloc} mode preallocates space for image by calling posix_fallocate().
614 @code{full} mode preallocates space for image by writing zeros to underlying
615 storage.
616 @end table
618 @item qcow2
619 QEMU image format, the most versatile format. Use it to have smaller
620 images (useful if your filesystem does not supports holes, for example
621 on Windows), optional AES encryption, zlib based compression and
622 support of multiple VM snapshots.
624 Supported options:
625 @table @code
626 @item compat
627 Determines the qcow2 version to use. @code{compat=0.10} uses the
628 traditional image format that can be read by any QEMU since 0.10.
629 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
630 newer understand (this is the default). Amongst others, this includes zero
631 clusters, which allow efficient copy-on-read for sparse images.
633 @item backing_file
634 File name of a base image (see @option{create} subcommand)
635 @item backing_fmt
636 Image format of the base image
637 @item encryption
638 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
640 The use of encryption in qcow and qcow2 images is considered to be flawed by
641 modern cryptography standards, suffering from a number of design problems:
643 @itemize @minus
644 @item
645 The AES-CBC cipher is used with predictable initialization vectors based
646 on the sector number. This makes it vulnerable to chosen plaintext attacks
647 which can reveal the existence of encrypted data.
648 @item
649 The user passphrase is directly used as the encryption key. A poorly
650 chosen or short passphrase will compromise the security of the encryption.
651 @item
652 In the event of the passphrase being compromised there is no way to
653 change the passphrase to protect data in any qcow images. The files must
654 be cloned, using a different encryption passphrase in the new file. The
655 original file must then be securely erased using a program like shred,
656 though even this is ineffective with many modern storage technologies.
657 @item
658 Initialization vectors used to encrypt sectors are based on the
659 guest virtual sector number, instead of the host physical sector. When
660 a disk image has multiple internal snapshots this means that data in
661 multiple physical sectors is encrypted with the same initialization
662 vector. With the CBC mode, this opens the possibility of watermarking
663 attacks if the attack can collect multiple sectors encrypted with the
664 same IV and some predictable data. Having multiple qcow2 images with
665 the same passphrase also exposes this weakness since the passphrase
666 is directly used as the key.
667 @end itemize
669 Use of qcow / qcow2 encryption is thus strongly discouraged. Users are
670 recommended to use an alternative encryption technology such as the
671 Linux dm-crypt / LUKS system.
673 @item cluster_size
674 Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
675 sizes can improve the image file size whereas larger cluster sizes generally
676 provide better performance.
678 @item preallocation
679 Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
680 @code{full}). An image with preallocated metadata is initially larger but can
681 improve performance when the image needs to grow. @code{falloc} and @code{full}
682 preallocations are like the same options of @code{raw} format, but sets up
683 metadata also.
685 @item lazy_refcounts
686 If this option is set to @code{on}, reference count updates are postponed with
687 the goal of avoiding metadata I/O and improving performance. This is
688 particularly interesting with @option{cache=writethrough} which doesn't batch
689 metadata updates. The tradeoff is that after a host crash, the reference count
690 tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
691 check -r all} is required, which may take some time.
693 This option can only be enabled if @code{compat=1.1} is specified.
695 @item nocow
696 If this option is set to @code{on}, it will turn off COW of the file. It's only
697 valid on btrfs, no effect on other file systems.
699 Btrfs has low performance when hosting a VM image file, even more when the guest
700 on the VM also using btrfs as file system. Turning off COW is a way to mitigate
701 this bad performance. Generally there are two ways to turn off COW on btrfs:
702 a) Disable it by mounting with nodatacow, then all newly created files will be
703 NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
704 does.
706 Note: this option is only valid to new or empty files. If there is an existing
707 file which is COW and has data blocks already, it couldn't be changed to NOCOW
708 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
709 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
711 @end table
713 @item Other
714 QEMU also supports various other image file formats for compatibility with
715 older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
716 qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
717 For a more detailed description of these formats, see the QEMU Emulation User
718 Documentation.
720 The main purpose of the block drivers for these formats is image conversion.
721 For running VMs, it is recommended to convert the disk images to either raw or
722 qcow2 in order to achieve good performance.
723 @end table
726 @c man end
728 @setfilename qemu-img
729 @settitle QEMU disk image utility
731 @c man begin SEEALSO
732 The HTML documentation of QEMU for more precise information and Linux
733 user mode emulator invocation.
734 @c man end
736 @c man begin AUTHOR
737 Fabrice Bellard
738 @c man end
740 @end ignore