test-virt-resize: Skip this test on 32 bit hosts.
[libguestfs.git] / tools / virt-resize
1 #!/usr/bin/perl -w
2 # virt-resize
3 # Copyright (C) 2010 Red Hat Inc.
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19 use warnings;
20 use strict;
21
22 use Sys::Guestfs;
23 use Sys::Guestfs::Lib qw(feature_available);
24 use Fcntl qw(S_ISREG SEEK_SET);
25 use POSIX qw(floor);
26 use Pod::Usage;
27 use Getopt::Long;
28 use Data::Dumper;
29 use Locale::TextDomain 'libguestfs';
30
31 $Data::Dumper::Sortkeys = 1;
32
33 die __"virt-resize: sorry this program does not work on a 32 bit host\n"
34     if ~1 == 4294967294;
35
36 $| = 1;
37
38 =encoding utf8
39
40 =head1 NAME
41
42 virt-resize - Resize a virtual machine disk
43
44 =head1 SYNOPSIS
45
46  virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]
47    [--expand /dev/sdaN] [--shrink /dev/sdaN]
48    [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk
49
50 =head1 DESCRIPTION
51
52 Virt-resize is a tool which can resize a virtual machine disk, making
53 it larger or smaller overall, and resizing or deleting any partitions
54 contained within.
55
56 Virt-resize B<cannot> resize disk images in-place.  Virt-resize
57 B<should not> be used on live virtual machines - for consistent
58 results, shut the virtual machine down before resizing it.
59
60 If you are not familiar with the associated tools:
61 L<virt-list-partitions(1)>,
62 L<virt-list-filesystems(1)> and
63 L<virt-df(1)>,
64 we recommend you go and read those manual pages first.
65
66 =head1 EXAMPLES
67
68 Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions
69 to fill the extra 5GB of space.
70
71  truncate -r olddisk newdisk; truncate -s +5G newdisk
72  virt-list-partitions -lht olddisk
73  # Note "/dev/sda2" is a partition inside the "olddisk" file.
74  virt-resize --expand /dev/sda2 olddisk newdisk
75
76 As above, but make the /boot partition 200MB bigger, while giving the
77 remaining space to /dev/sda2:
78
79  virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk
80
81 =head1 DETAILED USAGE
82
83 =head2 EXPANDING A VIRTUAL MACHINE DISK
84
85 =over 4
86
87 =item 1. Shut down the virtual machine
88
89 =item 2. Locate input disk image
90
91 Locate the input disk image (ie. the file or device on the host
92 containing the guest's disk).  If the guest is managed by libvirt, you
93 can use C<virsh dumpxml> like this to find the disk image name:
94
95  # virsh dumpxml guestname | xpath /domain/devices/disk/source
96  Found 1 nodes:
97  -- NODE --
98  <source dev="/dev/vg/lv_guest" />
99
100 =item 3. Look at current sizing
101
102 Use L<virt-list-partitions(1)> to display the current partitions and
103 sizes:
104
105  # virt-list-partitions -lht /dev/vg/lv_guest
106  /dev/sda1 ext3 101.9M
107  /dev/sda2 pv 7.9G
108  /dev/sda device 8.0G
109
110 (This example is a virtual machine with an 8 GB disk which we would
111 like to expand up to 10 GB).
112
113 =item 4. Create output disk
114
115 Virt-resize cannot do in-place disk modifications.  You have to have
116 space to store the resized output disk.
117
118 To store the resized disk image in a file, create a file of a suitable
119 size:
120
121  # rm -f outdisk
122  # truncate -s 10G outdisk
123
124 Or use L<lvcreate(1)> to create a logical volume:
125
126  # lvcreate -L 10G -n lv_name vg_name
127
128 Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:
129
130  # virsh pool-list
131  # virsh vol-create-as poolname newvol 10G
132
133 =item 5. Resize
134
135 virt-resize takes two mandatory parameters, the input disk (eg. device
136 or file) and the output disk.  The output disk is the one created in
137 the previous step.
138
139  # virt-resize indisk outdisk
140
141 This command just copies disk image C<indisk> to disk image C<outdisk>
142 I<without> resizing or changing any existing partitions.  If
143 C<outdisk> is larger, then an extra, empty partition is created at the
144 end of the disk covering the extra space.  If C<outdisk> is smaller,
145 then it will give an error.
146
147 More realistically you'd want to expand existing partitions in the
148 disk image by passing extra options (for the full list see the
149 L</OPTIONS> section below).
150
151 L</--expand> is the most useful option.  It expands the named
152 partition within the disk to fill any extra space:
153
154  # virt-resize --expand /dev/sda2 indisk outdisk
155
156 (In this case, an extra partition is I<not> created at the end of the
157 disk, because there will be no unused space).
158
159 L</--resize> is the other commonly used option.  The following would
160 increase the size of /dev/sda1 by 200M, and expand /dev/sda2
161 to fill the rest of the available space:
162
163  # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \
164      indisk outdisk
165
166 If the expanded partition in the image contains a filesystem or LVM
167 PV, then if virt-resize knows how, it will resize the contents, the
168 equivalent of calling a command such as L<pvresize(8)>,
169 L<resize2fs(8)> or L<ntfsresize(8)>.  However virt-resize does not
170 know how to resize some filesystems, so you would have to online
171 resize them after booting the guest.  And virt-resize also does not
172 resize anything inside an LVM PV, it just resizes the PV itself and
173 leaves the user to resize any LVs inside that PV as desired.
174
175 Other options are covered below.
176
177 =item 6. Test
178
179 Thoroughly test the new disk image I<before> discarding the old one.
180
181 If you are using libvirt, edit the XML to point at the new disk:
182
183  # virsh edit guestname
184
185 Change E<lt>source ...E<gt>, see
186 L<http://libvirt.org/formatdomain.html#elementsDisks>
187
188 Then start up the domain with the new, resized disk:
189
190  # virsh start guestname
191
192 and check that it still works.  See also the L</NOTES> section below
193 for additional information.
194
195 =item 7. Resize LVs etc inside the guest
196
197 (This can also be done offline using L<guestfish(1)>)
198
199 Once the guest has booted you should see the new space available, at
200 least for filesystems that virt-resize knows how to resize, and for
201 PVs.  The user may need to resize LVs inside PVs, and also resize
202 filesystem types that virt-resize does not know how to expand.
203
204 =back
205
206 =head2 SHRINKING A VIRTUAL MACHINE DISK
207
208 Shrinking is somewhat more complex than expanding, and only an
209 overview is given here.
210
211 Firstly virt-resize will not attempt to shrink any partition content
212 (PVs, filesystems).  The user has to shrink content before passing the
213 disk image to virt-resize, and virt-resize will check that the content
214 has been shrunk properly.
215
216 (Shrinking can also be done offline using L<guestfish(1)>)
217
218 After shrinking PVs and filesystems, shut down the guest, and proceed
219 with steps 3 and 4 above to allocate a new disk image.
220
221 Then run virt-resize with any of the C<--shrink> and/or C<--resize>
222 options.
223
224 =head2 IGNORING OR DELETING PARTITIONS
225
226 virt-resize also gives a convenient way to ignore or delete partitions
227 when copying from the input disk to the output disk.  Ignoring a
228 partition speeds up the copy where you don't care about the existing
229 contents of a partition.  Deleting a partition removes it completely,
230 but note that it also renumbers any partitions after the one which is
231 deleted, which can leave some guests unbootable.
232
233 =head1 OPTIONS
234
235 =over 4
236
237 =cut
238
239 my $help;
240
241 =item B<--help>
242
243 Display help.
244
245 =cut
246
247 my $version;
248
249 =item B<--version>
250
251 Display version number and exit.
252
253 =cut
254
255 my @resize;
256
257 =item B<--resize part=size>
258
259 Resize the named partition (expanding or shrinking it) so that it has
260 the given size.
261
262 C<size> can be expressed as an absolute number followed by
263 b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes,
264 Terabytes, Petabytes or Exabytes; or as a percentage of the current
265 size; or as a relative number or percentage.  For example:
266
267  --resize /dev/sda2=10G
268
269  --resize /dev/sda4=90%
270
271  --resize /dev/sda2=+1G
272
273  --resize /dev/sda2=-200M
274
275  --resize /dev/sda1=+128K
276
277  --resize /dev/sda1=+10%
278
279  --resize /dev/sda1=-10%
280
281 You can increase the size of any partition.  Virt-resize will expand
282 the direct content of the partition if it knows how (see C<--expand>
283 below).
284
285 You can only I<decrease> the size of partitions that contain
286 filesystems or PVs which have already been shrunk.  Virt-resize will
287 check this has been done before proceeding, or else will print an
288 error (see also C<--resize-force>).
289
290 You can give this option multiple times.
291
292 =cut
293
294 my @resize_force;
295
296 =item B<--resize-force part=size>
297
298 This is the same as C<--resize> except that it will let you decrease
299 the size of any partition.  Generally this means you will lose any
300 data which was at the end of the partition you shrink, but you may not
301 care about that (eg. if shrinking an unused partition, or if you can
302 easily recreate it such as a swap partition).
303
304 See also the C<--ignore> option.
305
306 =cut
307
308 my $expand;
309
310 =item B<--expand part>
311
312 Expand the named partition so it uses up all extra space (space left
313 over after any other resize changes that you request have been done).
314
315 If virt-resize knows how, it will expand the direct content of the
316 partition.  For example, if the partition is an LVM PV, it will expand
317 the PV to fit (like calling L<pvresize(8)>).  Virt-resize leaves any
318 other content it doesn't know about alone.
319
320 Currently virt-resize can resize:
321
322 =over 4
323
324 =item *
325
326 ext2, ext3 and ext4 filesystems when they are contained
327 directly inside a partition.
328
329 =item *
330
331 NTFS filesystems contained directly in a partition, if libguestfs was
332 compiled with support for NTFS.
333
334 The filesystem must have been shut down consistently last time it was
335 used.  Additionally, L<ntfsresize(8)> marks the resized filesystem as
336 requiring a consistency check, so at the first boot after resizing
337 Windows will check the disk.
338
339 =item *
340
341 LVM PVs (physical volumes).  However virt-resize does I<not>
342 resize anything inside the PV.  The user will have to resize
343 LVs as desired.
344
345 =back
346
347 Note that you cannot use C<--expand> and C<--shrink> together.
348
349 =cut
350
351 my $shrink;
352
353 =item B<--shrink part>
354
355 Shrink the named partition until the overall disk image fits in the
356 destination.  The named partition B<must> contain a filesystem or PV
357 which has already been shrunk using another tool (eg. L<guestfish(1)>
358 or other online tools).  Virt-resize will check this and give an error
359 if it has not been done.
360
361 The amount by which the overall disk must be shrunk (after carrying
362 out all other operations requested by the user) is called the
363 "deficit".  For example, a straight copy (assume no other operations)
364 from a 5GB disk image to a 4GB disk image results in a 1GB deficit.
365 In this case, virt-resize would give an error unless the user
366 specified a partition to shrink and that partition had more than a
367 gigabyte of free space.
368
369 Note that you cannot use C<--expand> and C<--shrink> together.
370
371 =cut
372
373 my @ignore;
374
375 =item B<--ignore part>
376
377 Ignore the named partition.  Effectively this means the partition is
378 allocated on the destination disk, but the content is not copied
379 across from the source disk.  The content of the partition will be
380 blank (all zero bytes).
381
382 You can give this option multiple times.
383
384 =cut
385
386 my @delete;
387
388 =item B<--delete part>
389
390 Delete the named partition.  It would be more accurate to describe
391 this as "don't copy it over", since virt-resize doesn't do in-place
392 changes and the original disk image is left intact.
393
394 Note that when you delete a partition, then anything contained in the
395 partition is also deleted.  Furthermore, this causes any partitions
396 that come after to be I<renumbered>, which can easily make your guest
397 unbootable.
398
399 You can give this option multiple times.
400
401 =cut
402
403 my @lv_expand;
404
405 =item B<--LV-expand logvol>
406
407 This takes the logical volume and, as a final step, expands it to fill
408 all the space available in its volume group.  A typical usage,
409 assuming a Linux guest with a single PV C</dev/sda2> and a root device
410 called C</dev/vg_guest/lv_root> would be:
411
412  virt-resize indisk outdisk \
413    --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root
414
415 This would first expand the partition (and PV), and then expand the
416 root device to fill the extra space in the PV.
417
418 The contents of the LV are also resized if virt-resize knows how to do
419 that.  You can stop virt-resize from trying to expand the content by
420 using the option C<--no-expand-content>.
421
422 Use L<virt-list-filesystems(1)> to list the filesystems in
423 the guest.
424
425 You can give this option multiple times, I<but> it doesn't
426 make sense to do this unless the logical volumes you specify
427 are all in different volume groups.
428
429 =cut
430
431 my $copy_boot_loader = 1;
432
433 =item B<--no-copy-boot-loader>
434
435 By default, virt-resize copies over some sectors at the start of the
436 disk (up to the beginning of the first partition).  Commonly these
437 sectors contain the Master Boot Record (MBR) and the boot loader, and
438 are required in order for the guest to boot correctly.
439
440 If you specify this flag, then this initial copy is not done.  You may
441 need to reinstall the boot loader in this case.
442
443 =cut
444
445 my $extra_partition = 1;
446 my $min_extra_partition = 10 * 1024 * 1024; # see below
447
448 =item B<--no-extra-partition>
449
450 By default, virt-resize creates an extra partition if there is any
451 extra, unused space after all resizing has happened.  Use this option
452 to prevent the extra partition from being created.  If you do this
453 then the extra space will be inaccessible until you run fdisk, parted,
454 or some other partitioning tool in the guest.
455
456 Note that if the surplus space is smaller than 10 MB, no extra
457 partition will be created.
458
459 =cut
460
461 my $expand_content = 1;
462
463 =item B<--no-expand-content>
464
465 By default, virt-resize will try to expand the direct contents
466 of partitions, if it knows how (see C<--expand> option above).
467
468 If you give the C<--no-expand-content> option then virt-resize
469 will not attempt this.
470
471 =cut
472
473 my $debug;
474
475 =item B<-d> | B<--debug>
476
477 Enable debugging messages.
478
479 =cut
480
481 my $dryrun;
482
483 =item B<-n> | B<--dryrun>
484
485 Print a summary of what would be done, but don't do anything.
486
487 =cut
488
489 my $quiet;
490
491 =item B<-q> | B<--quiet>
492
493 Don't print the summary.
494
495 =back
496
497 =cut
498
499 GetOptions ("help|?" => \$help,
500             "version" => \$version,
501             "resize=s" => \@resize,
502             "resize-force=s" => \@resize_force,
503             "expand=s" => \$expand,
504             "shrink=s" => \$shrink,
505             "ignore=s" => \@ignore,
506             "delete=s" => \@delete,
507             "lv-expand=s" => \@lv_expand,
508             "copy-boot-loader!" => \$copy_boot_loader,
509             "extra-partition!" => \$extra_partition,
510             "expand-content!" => \$expand_content,
511             "d|debug" => \$debug,
512             "n|dryrun|dry-run" => \$dryrun,
513             "q|quiet" => \$quiet,
514     ) or pod2usage (2);
515 pod2usage (1) if $help;
516 if ($version) {
517     my $g = Sys::Guestfs->new ();
518     my %h = $g->version ();
519     print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
520     exit
521 }
522
523 die "virt-resize [--options] indisk outdisk\n" unless @ARGV == 2;
524
525 # Check in and out images exist.
526 my $infile = $ARGV[0];
527 my $outfile = $ARGV[1];
528 die __x("virt-resize: {file}: does not exist or is not readable\n", file => $infile)
529     unless -r $infile;
530 die __x("virt-resize: {file}: does not exist or is not writable\nYou have to create the destination disk before running this program.\nPlease read the virt-resize(1) manpage for more information.\n", file => $outfile)
531     unless -w $outfile;
532
533 # Add them to the handle and launch the appliance.
534 my $g;
535 launch_guestfs ();
536
537 sub launch_guestfs
538 {
539     $g = Sys::Guestfs->new ();
540     $g->set_trace (1) if $debug;
541     $g->add_drive_ro ($infile);
542     $g->add_drive ($outfile);
543     $g->set_progress_callback (\&progress_callback) unless $quiet;
544     $g->launch ();
545 }
546
547 my $sectsize = $g->blockdev_getss ("/dev/sdb");
548
549 # Get the size in bytes of each disk.
550 #
551 # Originally we computed this by looking at the same of the host file,
552 # but of course this failed for qcow2 images (RHBZ#633096).  The right
553 # way to do it is with $g->blockdev_getsize64.
554 my $insize = $g->blockdev_getsize64 ("/dev/sda");
555 my $outsize = $g->blockdev_getsize64 ("/dev/sdb");
556
557 if ($debug) {
558     print "$infile size $insize bytes\n";
559     print "$outfile size $outsize bytes\n";
560 }
561
562 # Create a partition table.
563 #
564 # We *must* do this before copying the bootloader across, and copying
565 # the bootloader must be careful not to disturb this partition table
566 # (RHBZ#633766).  There are two reasons for this:
567 #
568 # (1) The 'parted' library is stupid and broken.  In many ways.  In
569 # this particular instance the stupid and broken bit is that it
570 # overwrites the whole boot sector when initializating a partition
571 # table.  (Upstream don't consider this obvious problem to be a bug).
572 #
573 # (2) GPT has a backup partition table located at the end of the disk.
574 # It's non-movable, because the primary GPT contains fixed references
575 # to both the size of the disk and the backup partition table at the
576 # end.  This would be a problem for any resize that didn't either
577 # carefully move the backup GPT (and rewrite those references) or
578 # recreate the whole partition table from scratch.
579
580 my $parttype;
581 create_partition_table ();
582
583 sub create_partition_table
584 {
585     local $_;
586
587     $parttype = $g->part_get_parttype ("/dev/sda");
588     print "partition table type: $parttype\n" if $debug;
589
590     $g->part_init ("/dev/sdb", $parttype);
591 }
592
593 # In reality the number of sectors containing boot loader data will be
594 # less than this (although Windows 7 defaults to putting the first
595 # partition on sector 2048, and has quite a large boot loader).
596 #
597 # However make this large enough to be sure that we have copied over
598 # the boot loader.  We could also do this by looking for the sector
599 # offset of the first partition.
600 #
601 # It doesn't matter if we copy too much.
602 my $max_bootloader = 4096 * 512;
603
604 die __x("virt-resize: {file}: file is too small to be a disk image ({sz} bytes)\n",
605         file => $infile, sz => $insize)
606     if $insize < $max_bootloader;
607 die __x("virt-resize: {file}: file is too small to be a disk image ({sz} bytes)\n",
608         file => $outfile, sz => $outsize)
609     if $outsize < $max_bootloader;
610
611 # Copy the boot loader across.
612 do_copy_boot_loader () if $copy_boot_loader;
613
614 sub do_copy_boot_loader
615 {
616     print "copying boot loader ...\n" if $debug;
617
618     # Don't disturb the partition table that we just wrote.
619     # https://secure.wikimedia.org/wikipedia/en/wiki/Master_Boot_Record
620     # https://secure.wikimedia.org/wikipedia/en/wiki/GUID_Partition_Table
621
622     my $bootsect = $g->pread_device ("/dev/sda", 446, 0);
623     die __"virt-resize: short read" if length ($bootsect) < 446;
624
625     $g->pwrite_device ("/dev/sdb", $bootsect, 0);
626
627     my $start = 512;
628     if ($parttype eq "gpt") {
629         # XXX With 4K sectors does GPT just fit more entries in a
630         # sector, or does it always use 34 sectors?
631         $start = 17408;
632     }
633
634     my $loader = $g->pread_device ("/dev/sda", $max_bootloader, $start);
635     die __"virt-resize: short read" if length ($loader) < $max_bootloader;
636
637     $g->pwrite_device ("/dev/sdb", $loader, $start);
638 }
639
640 my $to_be_expanded = 0;
641
642 # Get the partitions on the source disk.
643 my @partitions;
644 my %partitions;
645 check_source_disk ();
646
647 sub check_source_disk
648 {
649     local $_;
650
651     # Partitions and PVs.
652     my @p = $g->part_list ("/dev/sda");
653     foreach (@p) {
654         my $name = "/dev/sda" . $_->{part_num};
655         push @partitions, $name;
656
657         my %h = %$_;
658         $h{name} = $name;
659         $h{bootable} = $g->part_get_bootable ("/dev/sda", $h{part_num});
660         eval { $h{mbr_id} = $g->part_get_mbr_id ("/dev/sda", $h{part_num}); };
661         $partitions{$name} = \%h;
662     }
663 }
664
665 # Examine each partition.
666 my @pvs_full = $g->pvs_full ();
667 examine_partition ($_) foreach @partitions;
668
669 sub examine_partition
670 {
671     local $_;
672     my $part = shift;
673
674     # What is it?
675     my $type = "unknown";
676     eval {
677         $type = $g->vfs_type ($part);
678     };
679     $partitions{$part}->{type} = $type;
680
681     # Can we get the actual size of this object (ie. to find out if it
682     # is smaller than the container for shrinking)?
683     my $fssize;
684     if ($type eq "LVM2_member") { # LVM PV
685         foreach (@pvs_full) {
686             $fssize = $_->{pv_size}
687               if canonicalize ($_->{pv_name}) eq $part;
688         }
689     } else {                    # Something mountable?
690         eval {
691             $g->mount_ro ($part, "/");
692
693             my %stat = $g->statvfs ("/");
694             $fssize = $stat{bsize} * $stat{blocks};
695         };
696
697         eval {
698             $g->umount_all ();
699         };
700     }
701
702     # This might be undef if we didn't successfully find the size.  In
703     # that case user won't be allowed to shrink this partition except
704     # by forcing it.
705     $partitions{$part}->{fssize} = $fssize;
706
707     # Is it partition content that we know how to expand?
708     $partitions{$part}->{can_expand_content} = 0;
709     if ($expand_content) {
710         if ($type eq "LVM2_member") {
711             $partitions{$part}->{can_expand_content} = 1;
712             $partitions{$part}->{expand_content_method} = "pvresize";
713         } elsif ($type =~ /^ext[234]$/) {
714             $partitions{$part}->{can_expand_content} = 1;
715             $partitions{$part}->{expand_content_method} = "resize2fs";
716         } elsif ($type eq "ntfs" && feature_available ($g, "ntfsprogs")) {
717             $partitions{$part}->{can_expand_content} = 1;
718             $partitions{$part}->{expand_content_method} = "ntfsresize";
719         }
720     }
721 }
722
723 if ($debug) {
724     print "partitions found: ", join (", ", @partitions), "\n";
725     foreach my $part (@partitions) {
726         print "$part:\n";
727         foreach (sort keys %{$partitions{$part}}) {
728             print("\t", $_, " = ",
729                   defined ($partitions{$part}->{$_})
730                   ? $partitions{$part}->{$_} : "undef",
731                   "\n");
732         }
733     }
734 }
735
736 # Examine the LVs (for --lv-expand option).
737 my @lvs = $g->lvs ();
738 my %lvs;
739 examine_lv ($_) foreach @lvs;
740 mark_lvs_to_expand ();
741
742 sub examine_lv
743 {
744     local $_ = shift;
745
746     $lvs{$_}->{name} = $_;
747
748     my $type = "unknown";
749     eval {
750         $type = $g->vfs_type ($_);
751     };
752     $lvs{$_}->{type} = $type;
753
754     if ($expand_content) {
755         if ($type =~ /^ext[234]$/) {
756             $lvs{$_}->{can_expand_content} = 1;
757             $lvs{$_}->{expand_content_method} = "resize2fs";
758         } elsif ($type eq "ntfs" && feature_available ($g, "ntfsprogs")) {
759             $lvs{$_}->{can_expand_content} = 1;
760             $lvs{$_}->{expand_content_method} = "ntfsresize";
761         }
762     }
763 }
764
765 sub mark_lvs_to_expand {
766     local $_;
767
768     foreach (@lv_expand) {
769         die __x("virt-resize: no logical volume called {n}\n",
770                 n => $_)
771             unless exists $lvs{$_};
772
773         if ($lvs{$_}->{can_expand_content}) {
774             $lvs{$_}->{will_expand_content} = 1;
775             $to_be_expanded++;
776         }
777     }
778 }
779
780 sub find_partition
781 {
782     local $_ = shift;
783     my $option = shift;
784
785     $_ = "/dev/$_" unless $_ =~ m{^/dev};
786     $_ = canonicalize ($_);
787
788     unless (exists $partitions{$_}) {
789         die __x("{p}: partition not found in the source disk image, when using the '{opt}' command line option\n",
790                 p => $_,
791                 opt => $option)
792     }
793
794     if ($partitions{$_}->{ignore}) {
795         die __x("{p}: partition ignored, you cannot use it in another command line argument\n",
796                 p => $_)
797     }
798     if ($partitions{$_}->{delete}) {
799         die __x("{p}: partition deleted, you cannot use it in another command line argument\n",
800                 p => $_)
801     }
802
803     return $_;
804 }
805
806 # Handle --ignore.
807 do_ignore ($_) foreach @ignore;
808
809 sub do_ignore
810 {
811     local $_ = shift;
812     $_ = find_partition ($_, "--ignore");
813     $partitions{$_}->{ignore} = 1;
814 }
815
816 # Handle --delete.
817 do_delete ($_) foreach @delete;
818
819 sub do_delete
820 {
821     local $_ = shift;
822     $_ = find_partition ($_, "--delete");
823     $partitions{$_}->{delete} = 1;
824 }
825
826 # Handle --resize and --resize-force.
827 do_resize ($_, 0, "--resize") foreach @resize;
828 do_resize ($_, 1, "--resize-force") foreach @resize_force;
829
830 sub do_resize
831 {
832     local $_ = shift;
833     my $force = shift;
834     my $option = shift;
835
836     # Argument is "part=size" ...
837     my ($part, $sizefield) = split /=/, $_, 2;
838     $part = find_partition ($part, $option);
839
840     if (exists $partitions{$part}->{newsize}) {
841         die __x("{p}: this partition has already been marked for resizing\n",
842                 p => $part);
843     }
844
845     # Parse the size field.
846     my $oldsize = $partitions{$part}->{part_size};
847     my $newsize;
848     if (!defined ($sizefield) || $sizefield eq "") {
849         die __x("{p}: missing size field in {o} option\n",
850                 p => $part, o => $option);
851     } elsif ($sizefield =~ /^([.\d]+)([bKMGTPE])$/) {
852         $newsize = sizebytes ($1, $2);
853     } elsif ($sizefield =~ /^\+([.\d]+)([bKMGTPE])$/) {
854         my $incr = sizebytes ($1, $2);
855         $newsize = $oldsize + $incr;
856     } elsif ($sizefield =~ /^-([.\d]+)([bKMGTPE])$/) {
857         my $decr = sizebytes ($1, $2);
858         $newsize = $oldsize - $decr;
859     } elsif ($sizefield =~ /^([.\d]+)%$/) {
860         $newsize = $oldsize * $1 / 100;
861     } elsif ($sizefield =~ /^\+([.\d]+)%$/) {
862         $newsize = $oldsize + $oldsize * $1 / 100;
863     } elsif ($sizefield =~ /^-([.\d]+)%$/) {
864         $newsize = $oldsize - $oldsize * $1 / 100;
865     } else {
866         die __x("{p}: {f}: cannot parse size field\n",
867                 p => $part, f => $sizefield)
868     }
869
870     $newsize > 0 or
871         die __x("{p}: new size is zero or negative\n", p => $part);
872
873     mark_partition_for_resize ($part, $oldsize, $newsize, $force, $option);
874 }
875
876 sub mark_partition_for_resize
877 {
878     local $_;
879     my $part = shift;
880     my $oldsize = shift;
881     my $newsize = shift;
882     my $force = shift;
883     my $option = shift;
884
885     # Do nothing if the size is the same.
886     return if $oldsize == $newsize;
887
888     my $bigger = $newsize > $oldsize;
889
890     # Check there is space to shrink this.
891     unless ($bigger || $force) {
892         if (! $partitions{$part}->{fssize} ||
893             $partitions{$part}->{fssize} > $newsize) {
894             die __x("{p}: cannot make this partition smaller because it contains a\nfilesystem, physical volume or other content that is larger than the new size.\nYou have to resize the content first, see virt-resize(1).\n",
895                     p => $part);
896         }
897     }
898
899     $partitions{$part}->{newsize} = $newsize;
900
901     if ($partitions{$part}->{can_expand_content} && $bigger) {
902         $partitions{$part}->{will_expand_content} = 1;
903         $to_be_expanded++;
904     }
905 }
906
907 # Handle --expand and --shrink.
908 my $surplus;
909 if (defined $expand && defined $shrink) {
910     die __"virt-resize: you cannot use options --expand and --shrink together\n"
911 }
912 if (defined $expand || defined $shrink) {
913     calculate_surplus ();
914
915     if ($debug) {
916         print "surplus before --expand or --shrink: $surplus (",
917           human_size ($surplus), ")\n";
918     }
919
920     do_expand () if $expand;
921     do_shrink () if $shrink;
922 }
923
924 # (Re-)calculate surplus after doing expand or shrink.
925 calculate_surplus ();
926
927 # Add up the total space required on the target so far, compared
928 # to the size of the target.  We end up with a surplus or deficit.
929 sub calculate_surplus
930 {
931     local $_;
932
933     # We need some overhead for partitioning.  Worst case would be for
934     # EFI partitioning + massive per-partition alignment.
935     my $overhead = $sectsize * (
936         2 * 64 +                   # GPT start and end
937         (64 * (@partitions + 1))   # Maximum alignment
938         ) +
939         ($max_bootloader - 64 * 512); # boot loader
940
941     my $required = 0;
942     foreach (@partitions) {
943         if ($partitions{$_}->{newsize}) {
944             $required += $partitions{$_}->{newsize}
945         } else {
946             $required += $partitions{$_}->{part_size}
947         }
948     }
949
950     # Compare that to the actual target disk.
951     $surplus = $outsize - ($required + $overhead);
952 }
953
954 sub do_expand
955 {
956     local $_;
957
958     unless ($surplus > 0) {
959         die __x("virt-resize: error: cannot use --expand when there is no surplus space to\nexpand into.  You need to make the target disk larger by at least {h}.\n",
960                 h => human_size (-$surplus));
961     }
962
963     my $part = find_partition ($expand, "--expand");
964     my $oldsize = $partitions{$part}->{part_size};
965     mark_partition_for_resize ($part, $oldsize, $oldsize + $surplus,
966                                0, "--expand");
967 }
968
969 sub do_shrink
970 {
971     local $_;
972
973     unless ($surplus < 0) {
974         die __"virt-resize: error: cannot use --shrink because there is no deficit\n(see 'deficit' in the virt-resize(1) man page)\n"
975     }
976
977     my $part = find_partition ($shrink, "--shrink");
978     my $oldsize = $partitions{$part}->{part_size};
979     mark_partition_for_resize ($part, $oldsize, $oldsize + $surplus,
980                                0, "--shrink");
981 }
982
983 # Print summary.
984 print_summary () unless $quiet;
985
986 sub print_summary
987 {
988     local $_;
989     print __"Summary of changes:\n";
990
991     foreach my $part (@partitions) {
992         if ($partitions{$part}->{ignore}) {
993             print __x("{p}: partition will be ignored\n", p => $part);
994         } elsif ($partitions{$part}->{delete}) {
995             print __x("{p}: partition will be deleted\n", p => $part);
996         } elsif ($partitions{$part}->{newsize}) {
997             print __x("{p}: partition will be resized from {oldsize} to {newsize}\n",
998                       p => $part,
999                       oldsize => human_size ($partitions{$part}->{part_size}),
1000                       newsize => human_size ($partitions{$part}->{newsize}));
1001             if ($partitions{$part}->{will_expand_content}) {
1002                 print __x("{p}: content will be expanded using the '{meth}' method\n",
1003                           p => $part,
1004                           meth => $partitions{$part}->{expand_content_method});
1005             }
1006         } else {
1007             print __x("{p}: partition will be left alone\n", p => $part);
1008         }
1009     }
1010
1011     foreach my $lv (@lv_expand) {
1012         print __x("{n}: LV will be expanded to maximum size\n",
1013                   n => $lv);
1014     }
1015
1016     foreach my $lv (@lvs) {
1017         if ($lvs{$lv}->{will_expand_content}) {
1018             print __x("{n}: content will be expanded using the '{meth}' method\n",
1019                       n => $lv,
1020                       meth => $lvs{$lv}->{expand_content_method});
1021         }
1022     }
1023
1024     if ($surplus > 0) {
1025         print __x("There is a surplus of {spl} bytes ({h}).\n",
1026                   spl => $surplus,
1027                   h => human_size ($surplus));
1028         if ($extra_partition) {
1029             if ($surplus >= $min_extra_partition) {
1030                 print __"An extra partition will be created for the surplus.\n";
1031             } else {
1032                 print __"The surplus space is not large enough for an extra partition to be created\nand so it will just be ignored.\n";
1033             }
1034         } else {
1035             print __"The surplus space will be ignored.  Run a partitioning program in the guest\nto partition this extra space if you want.\n";
1036         }
1037     } elsif ($surplus < 0) {
1038         die __x("virt-resize: error: there is a deficit of {def} bytes ({h}).\nYou need to make the target disk larger by at least this amount,\nor adjust your resizing requests.\n",
1039                 def => -$surplus,
1040                 h => human_size (-$surplus));
1041     }
1042 }
1043
1044 exit 0 if $dryrun;
1045
1046 # Repartition the target disk.
1047 my $nextpart = 1;
1048 repartition ();
1049
1050 sub repartition
1051 {
1052     local $_;
1053
1054     # Work out where to start the first partition.
1055     die __"virt-resize: source disk does not have a first partition\n"
1056         unless exists ($partitions{"/dev/sda1"});
1057     my $start = $partitions{"/dev/sda1"}->{part_start} / $sectsize;
1058
1059     # Align to 64.
1060     $start = ($start + 63) & ~63;
1061
1062     print "starting to partition from $start\n" if $debug;
1063
1064     # Create the new partitions.
1065     foreach my $part (@partitions) {
1066         unless ($partitions{$part}->{delete}) {
1067             # Size in sectors.
1068             my $size;
1069             if ($partitions{$part}->{newsize}) {
1070                 $size = ($partitions{$part}->{newsize} + $sectsize - 1)
1071                     / $sectsize;
1072             } else {
1073                 $size = ($partitions{$part}->{part_size} + $sectsize - 1)
1074                     / $sectsize;
1075             }
1076
1077             # Create it.
1078             my ($target, $end, $part_num) = add_partition ($start, $size);
1079             $partitions{$part}->{target} = $target;
1080
1081             if ($partitions{$part}->{bootable}) {
1082                 $g->part_set_bootable ("/dev/sdb", $part_num, 1);
1083             }
1084
1085             if ($partitions{$part}->{mbr_id}) {
1086                 $g->part_set_mbr_id ("/dev/sdb", $part_num,
1087                                      $partitions{$part}->{mbr_id});
1088             }
1089
1090             # Start of next partition + alignment.
1091             $start = $end + 1;
1092             $start = ($start + 63) & ~63;
1093         }
1094     }
1095
1096     # Create surplus partition.
1097     if ($extra_partition && $surplus >= $min_extra_partition) {
1098         add_partition ($start, $outsize / $sectsize - 64 - $start);
1099     }
1100 }
1101
1102 # Add a partition.
1103 sub add_partition
1104 {
1105     local $_;
1106     my $start = shift;
1107     my $size = shift;
1108
1109     my ($target, $end, $part_num);
1110
1111     if ($nextpart <= 3 || $parttype ne "msdos") {
1112         $target = "/dev/sdb$nextpart";
1113         $end = $start + $size - 1;
1114         $g->part_add ("/dev/sdb", "primary", $start, $end);
1115         $part_num = $nextpart++;
1116     } else {
1117         if ($nextpart == 4) {
1118             $g->part_add ("/dev/sdb", "extended", $start, -1);
1119             $part_num = $nextpart++;
1120             $start += 64;
1121         }
1122         $target = "/dev/sdb$nextpart";
1123         $end = $start + $size - 1;
1124         $g->part_add ("/dev/sdb", "logical", $start, $end);
1125         $part_num = $nextpart++;
1126     }
1127
1128     return ($target, $end, $part_num);
1129 }
1130
1131 # Copy over the data.
1132 copy_data ();
1133
1134 sub copy_data
1135 {
1136     foreach my $part (@partitions)
1137     {
1138         unless ($partitions{$part}->{ignore}) {
1139             my $target = $partitions{$part}->{target};
1140             if ($target) {
1141                 my $oldsize = $partitions{$part}->{part_size};
1142                 my $newsize;
1143                 if ($partitions{$part}->{newsize}) {
1144                     $newsize = $partitions{$part}->{newsize};
1145                 } else {
1146                     $newsize = $partitions{$part}->{part_size};
1147                 }
1148
1149                 if (!$quiet && !$debug) {
1150                     print __x("Copying {p} ...\n", p => $part);
1151                 }
1152
1153                 $g->copy_size ($part, $target,
1154                                $newsize < $oldsize ? $newsize : $oldsize);
1155             }
1156         }
1157     }
1158 }
1159
1160 # After copying the data over we must shut down and restart the
1161 # appliance in order to expand the content.  The reason for this may
1162 # not be obvious, but it's because otherwise we'll have duplicate VGs
1163 # (the old VG(s) and the new VG(s)) which breaks LVM.
1164 #
1165 # The restart is only required if we're going to expand something.
1166
1167 if ($to_be_expanded > 0) {
1168     restart_appliance ();
1169     expand_partitions ();
1170     expand_lvs ();
1171     expand_lvs_content ();
1172 }
1173
1174 sub restart_appliance
1175 {
1176     # Sync disk and exit.
1177     $g->umount_all ();
1178     $g->sync ();
1179     undef $g;
1180
1181     $g = Sys::Guestfs->new ();
1182     $g->set_trace (1) if $debug;
1183     $g->add_drive ($outfile);
1184     $g->launch ();
1185
1186     # Target partitions have changed from /dev/sdb to /dev/sda,
1187     # so change them.
1188     foreach my $part (@partitions)
1189     {
1190         my $target = $partitions{$part}->{target};
1191         if ($target) {
1192             if ($target =~ m{/dev/(.)db(.*)}) {
1193                 $partitions{$part}->{target} = "/dev/$1da$2";
1194             } else {
1195                 die "internal error: unexpected partition target: $target";
1196             }
1197         }
1198     }
1199 }
1200
1201 sub expand_partitions
1202 {
1203     foreach my $part (@partitions)
1204     {
1205         unless ($partitions{$part}->{ignore}) {
1206             my $target = $partitions{$part}->{target};
1207             if ($target) {
1208                 # Expand if requested.
1209                 if ($partitions{$part}->{will_expand_content}) {
1210                     if (!$quiet && !$debug) {
1211                         print __x("Expanding {p} using the '{meth}' method\n",
1212                                   p => $part,
1213                                   meth => $partitions{$part}->{expand_content_method});
1214                     }
1215                     expand_target_partition ($part)
1216                 }
1217             }
1218         }
1219     }
1220 }
1221
1222 sub expand_target_partition
1223 {
1224     local $_;
1225     my $part = shift;
1226
1227     # Assertions.
1228     die unless $part;
1229     die unless $partitions{$part}->{can_expand_content};
1230     die unless $partitions{$part}->{will_expand_content};
1231     die unless $partitions{$part}->{expand_content_method};
1232     die unless $partitions{$part}->{target};
1233     die unless $expand_content;
1234
1235     my $target = $partitions{$part}->{target};
1236     my $method = $partitions{$part}->{expand_content_method};
1237     if ($method eq "pvresize") {
1238         $g->pvresize ($target);
1239     }
1240     elsif ($method eq "resize2fs") {
1241         $g->e2fsck_f ($target);
1242         $g->resize2fs ($target);
1243     }
1244     elsif ($method eq "ntfsresize") {
1245         $g->ntfsresize ($target);
1246     }
1247     else {
1248         die "internal error: unknown method: $method";
1249     }
1250 }
1251
1252 sub expand_lvs
1253 {
1254     local $_;
1255
1256     foreach (@lv_expand) {
1257         $g->lvresize_free ($_, 100);
1258     }
1259 }
1260
1261 sub expand_lvs_content
1262 {
1263     local $_;
1264
1265     foreach (@lvs) {
1266         if ($lvs{$_}->{will_expand_content}) {
1267             my $method = $lvs{$_}->{expand_content_method};
1268             if (!$quiet && !$debug) {
1269                 print __x("Expanding {p} using the '{meth}' method\n",
1270                           p => $_, meth => $method);
1271                     }
1272             if ($method eq "resize2fs") {
1273                 $g->e2fsck_f ($_);
1274                 $g->resize2fs ($_);
1275             } elsif ($method eq "ntfsresize") {
1276                 $g->ntfsresize ($_);
1277             } else {
1278                 die "internal error: unknown method: $method";
1279             }
1280         }
1281     }
1282 }
1283
1284 # Sync disk and exit.
1285 $g->umount_all ();
1286 $g->sync ();
1287 undef $g;
1288
1289 exit 0;
1290
1291 sub sizebytes
1292 {
1293     local $_ = shift;
1294     my $unit = shift;
1295
1296     $_ *= 1024 if $unit =~ /[KMGTPE]/;
1297     $_ *= 1024 if $unit =~ /[MGTPE]/;
1298     $_ *= 1024 if $unit =~ /[GTPE]/;
1299     $_ *= 1024 if $unit =~ /[TPE]/;
1300     $_ *= 1024 if $unit =~ /[PE]/;
1301     $_ *= 1024 if $unit =~ /[E]/;
1302
1303     return floor($_);
1304 }
1305
1306 # Convert a number of bytes to a human-readable number.
1307 sub human_size
1308 {
1309     local $_ = shift;
1310
1311     my $sgn = "";
1312     if ($_ < 0) {
1313         $sgn = "-";
1314         $_ = -$_;
1315     }
1316
1317     $_ /= 1024;
1318
1319     if ($_ < 1024) {
1320         sprintf "%s%dK", $sgn, $_;
1321     } elsif ($_ < 1024 * 1024) {
1322         sprintf "%s%.1fM", $sgn, ($_ / 1024);
1323     } else {
1324         sprintf "%s%.1fG", $sgn, ($_ / 1024 / 1024);
1325     }
1326 }
1327
1328 # The reverse of device name translation, see
1329 # BLOCK DEVICE NAMING in guestfs(3).
1330 sub canonicalize
1331 {
1332     local $_ = shift;
1333
1334     if (m{^/dev/[hv]d([a-z]\d)$}) {
1335         return "/dev/sd$1";
1336     }
1337     $_;
1338 }
1339
1340 # Not as sophisticated as the guestfish progress bar, because
1341 # I intend to use an external library for this at some point (XXX).
1342 sub progress_callback
1343 {
1344     my $proc_nr = shift;
1345     my $serial = shift;
1346     my $position = shift;
1347     my $total = shift;
1348
1349     my $ratio = $position / $total;
1350     if ($ratio < 0) { $ratio = 0 }
1351     elsif ($ratio > 1) { $ratio = 1 }
1352
1353     my $dots = int ($ratio * 76);
1354
1355     print "[", "#"x$dots, "-"x(76-$dots), "]\r";
1356     print "\n" if $ratio == 1;
1357 }
1358
1359 =head1 NOTES
1360
1361 =head2 "Partition 1 does not end on cylinder boundary."
1362
1363 Virt-resize aligns partitions to multiples of 64 sectors.  Usually
1364 this means the partitions will not be aligned to the ancient CHS
1365 geometry.  However CHS geometry is meaningless for disks manufactured
1366 since the early 1990s, and doubly so for virtual hard drives.
1367 Alignment of partitions to cylinders is not required by any modern
1368 operating system.
1369
1370 =head2 RESIZING WINDOWS VIRTUAL MACHINES
1371
1372 In Windows Vista and later versions, Microsoft switched to using a
1373 separate boot partition.  In these VMs, typically C</dev/sda1> is the
1374 boot partition and C</dev/sda2> is the main (C:) drive.  We have not
1375 had any luck resizing the boot partition.  Doing so seems to break the
1376 guest completely.  However expanding the second partition (ie. C:
1377 drive) should work.
1378
1379 Windows may initiate a lengthy "chkdsk" on first boot after a resize,
1380 if NTFS partitions have been expanded.  This is just a safety check
1381 and (unless it find errors) is nothing to worry about.
1382
1383 =head1 ALTERNATIVE TOOLS
1384
1385 There are several proprietary tools for resizing partitions.  We
1386 won't mention any here.
1387
1388 L<parted(8)> and its graphical shell gparted can do some types of
1389 resizing operations on disk images.  They can resize and move
1390 partitions, but I don't think they can do anything with the contents,
1391 and they certainly don't understand LVM.
1392
1393 L<guestfish(1)> can do everything that virt-resize can do and a lot
1394 more, but at a much lower level.  You will probably end up
1395 hand-calculating sector offsets, which is something that virt-resize
1396 was designed to avoid.  If you want to see the guestfish-equivalent
1397 commands that virt-resize runs, use the C<--debug> flag.
1398
1399 =head1 SEE ALSO
1400
1401 L<virt-list-partitions(1)>,
1402 L<virt-list-filesystems(1)>,
1403 L<virt-df(1)>,
1404 L<guestfs(3)>,
1405 L<guestfish(1)>,
1406 L<lvm(8)>,
1407 L<pvresize(8)>,
1408 L<lvresize(8)>,
1409 L<resize2fs(8)>,
1410 L<ntfsresize(8)>,
1411 L<virsh(1)>,
1412 L<parted(8)>,
1413 L<Sys::Guestfs(3)>,
1414 L<http://libguestfs.org/>.
1415
1416 =head1 AUTHOR
1417
1418 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
1419
1420 =head1 COPYRIGHT
1421
1422 Copyright (C) 2010 Red Hat Inc.
1423
1424 This program is free software; you can redistribute it and/or modify
1425 it under the terms of the GNU General Public License as published by
1426 the Free Software Foundation; either version 2 of the License, or
1427 (at your option) any later version.
1428
1429 This program is distributed in the hope that it will be useful,
1430 but WITHOUT ANY WARRANTY; without even the implied warranty of
1431 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1432 GNU General Public License for more details.
1433
1434 You should have received a copy of the GNU General Public License
1435 along with this program; if not, write to the Free Software
1436 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.