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