#!/usr/bin/perl
#
# Copyright 2009-2012 Eucalyptus Systems, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see http://www.gnu.org/licenses/.
#
# Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
# CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you need
# additional information or have any questions.
#
# This file may incorporate work covered under the following copyright
# and permission notice:
#
#   Software License Agreement (BSD License)
#
#   Copyright (c) 2008, Regents of the University of California
#   All rights reserved.
#
#   Redistribution and use of this software in source and binary forms,
#   with or without modification, are permitted provided that the
#   following conditions are met:
#
#     Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#
#     Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer
#     in the documentation and/or other materials provided with the
#     distribution.
#
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
#   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
#   COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
#   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
#   BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
#   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
#   CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
#   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
#   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
#   POSSIBILITY OF SUCH DAMAGE. USERS OF THIS SOFTWARE ACKNOWLEDGE
#   THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE LICENSED MATERIAL,
#   COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS SOFTWARE,
#   AND IF ANY SUCH MATERIAL IS DISCOVERED THE PARTY DISCOVERING
#   IT MAY INFORM DR. RICH WOLSKI AT THE UNIVERSITY OF CALIFORNIA,
#   SANTA BARBARA WHO WILL THEN ASCERTAIN THE MOST APPROPRIATE REMEDY,
#   WHICH IN THE REGENTS' DISCRETION MAY INCLUDE, WITHOUT LIMITATION,
#   REPLACEMENT OF THE CODE SO IDENTIFIED, LICENSING OF THE CODE SO
#   IDENTIFIED, OR WITHDRAWAL OF THE CODE CAPABILITY TO THE EXTENT
#   NEEDED TO COMPLY WITH ANY SUCH LICENSES OR RIGHTS.

# this generates an XML template for libvirt domain specification,
# which is tailored to an instance by the node controller

use diagnostics;
use warnings; 
use sigtrap;
use strict;
use English; # for descriptive predefined var names
use Data::Dumper; # for debugging: print Dumper($var)
use Getopt::Long;
use FindBin;
$OUTPUT_AUTOFLUSH = 1; # no output buffering

our $use_ramdisk = 0;
our $local_kvm="";
our $use_virtio_net = 0;
our $use_virtio_root = 0;
our $use_kernel = 0;
our $plaindisk = 0;
our $use_block_root = 0;

if ( -x "/usr/bin/kvm" ) {
    $local_kvm="/usr/bin/kvm";
} elsif ( -x "/usr/bin/qemu-kvm" ) {
    $local_kvm="/usr/bin/qemu-kvm";
} elsif ( -x "/usr/libexec/qemu-kvm" ) {
    $local_kvm="/usr/libexec/qemu-kvm";
} else {
    $local_kvm="kvm";
}

# deal with command-line parameters
GetOptions('ramdisk'        => sub { $use_ramdisk = 1; },
           'kernel'         => sub { $use_kernel = 1; },
           'ephemeral'      => sub { }, # option ignored 
           'blockroot'      => sub { $use_block_root = 1; },
           'virtionet'      => sub { $use_virtio_net = 1; },
           'virtioroot'      => sub { $use_virtio_root = 1; },
		   ) or exit (1);

if (!$use_ramdisk && !$use_kernel) {
    $plaindisk = 1;
}

print <<EOF;
<domain type='kvm'>
    <name>NAME</name>
    <os>
    <type>hvm</type>
EOF

if (!$plaindisk) {
    if ($use_kernel) {
        print "        <kernel>BASEPATH/kernel</kernel>\n";
    }
    if ( $use_ramdisk ) {
	print "        <initrd>BASEPATH/ramdisk</initrd>\n";
    }

    if ( $use_virtio_root ) {
	print "        <cmdline>root=/dev/vda1 console=ttyS0</cmdline>\n";
    } else {
	print "        <cmdline>root=/dev/sda1 console=ttyS0</cmdline>\n";
    }
}

print <<EOF;
    </os>
    <features>
        <acpi/>
    </features>
    <memory>MEMORY</memory>
    <vcpu>VCPUS</vcpu>
    <devices>
        <emulator>$local_kvm</emulator>
EOF
    
if ( $use_block_root ) {
    print "        <disk type='block'>\n";
  #  print "            <driver name='phy'/>";
    print "            <source dev='DEVNAME'/>\n";
} else {
    print "        <disk type='file' device='disk'>\n"; # TODO: is 'device=disk' OK without virtio?
    print "            <source file='BASEPATH/disk'/>\n";
} 

if ( $use_virtio_root ) {
    print "            <target dev='vda' bus='virtio'/>\n";
    print "        </disk>\n";
} else {
    if ($plaindisk) {
	print "            <target dev='hda'/>\n";
    } else {
	print "            <target dev='sda'/>\n";
    }
    print "        </disk>\n";
}

if ($plaindisk) {
    print "        <disk type='file' device='floppy'>\n";
    print "          <source file='BASEPATH/floppy'/>\n";
    print "          <target dev='fda'/>\n";
    print "        </disk>\n";
}

print <<EOF;
        <interface type='bridge'>
            <source bridge='BRIDGEDEV'/>
            <mac address='PRIVMACADDR'/>
EOF

if ( $use_virtio_net ) {
    print "            <model type='virtio'/>\n";
} else {
    if ($plaindisk) {
	print "            <model type='rtl8139'/>\n";
    } else {
	print "            <model type='e1000'/>\n";
    }
}

print <<EOF;
        </interface>
        <serial type="file">
            <source path='BASEPATH/console.log'/>
            <target port='1'/>
        </serial>
        <!-- <graphics type='vnc' port='-1' autoport='yes' listen='0.0.0.0'/> -->
    </devices>
</domain>
EOF
