app-emulation/libvirt: break apart OpenRC init script
authorDoug Goldstein <cardoe@gentoo.org>
Tue, 18 Aug 2015 21:08:56 +0000 (16:08 -0500)
committerMatthias Maier <tamiko@gentoo.org>
Thu, 20 Aug 2015 01:13:30 +0000 (20:13 -0500)
This breaks apart the startup/shutdown of libvirtd from the
startup/shutdown of the libvirt domains. Additionally this expands out
the domain support to work for all the libvirtd backends instead of just
QEMU.

Signed-off-by: Doug Goldstein <cardoe@gentoo.org>
Signed-off-by: Matthias Maier <tamiko@gentoo.org>
app-emulation/libvirt/files/libvirt-guests.confd [new file with mode: 0644]
app-emulation/libvirt/files/libvirt-guests.init [new file with mode: 0644]
app-emulation/libvirt/files/libvirtd.confd-r5 [new file with mode: 0644]
app-emulation/libvirt/files/libvirtd.init-r15 [new file with mode: 0644]

diff --git a/app-emulation/libvirt/files/libvirt-guests.confd b/app-emulation/libvirt/files/libvirt-guests.confd
new file mode 100644 (file)
index 0000000..6e98dc2
--- /dev/null
@@ -0,0 +1,49 @@
+# /etc/conf.d/libvirtd
+
+# LIBVIRT_URIS
+# space separated list of libvirt URIs to communicate with to start/stop guests
+# Valid values are anything that can be passed to 'virsh connect'
+
+#LIBVIRT_URIS="qemu:///system"
+
+
+# LIBVIRT_SHUTDOWN
+# Valid options:
+# * managedsave - Performs a state save external to the VM (for hypervisors
+#                 supporting this operation). qemu-kvm will stop the CPU
+#                 and save off all state to a separate file. When the
+#                 machine is started again, it will resume like nothing
+#                 ever happened. This is guarenteed to always successfully
+#                 stop your machine and restart it.
+#
+# * shutdown -    Sends an ACPI shutdown (think of this as a request to
+#                 your guest to shutdown). There is no way to distinguish
+#                 between guests that are ignoring the shutdown request or
+#                 are stuck or are taking a long time to shutdown. We will
+#                 wait LIBVIRT_MAXWAIT seconds before yanking the power
+#                 out.
+#
+# * destroy  -    Immediately stop all running guests. Use with caution as
+#                 this can leave the guest in a corrupted state and might
+#                 lead to data loss.
+#
+
+#LIBVIRT_SHUTDOWN="managedsave"
+
+
+# LIBVIRT_MAXWAIT
+# Timeout in seconds until stopping a guest and "pulling the plug" on the
+# guest
+# Valid values are any integer over 0
+
+#LIBVIRT_MAXWAIT="500"
+
+
+# LIBVIRT_NET_SHUTDOWN
+# If libvirtd created networks for you (e.g. NATed networks) then this init
+# script will shut them down for you if this is set to 'yes'. Otherwise,
+# the networks will be left running. For this option to be useful you must
+# have enabled the 'virt-network' USE flag and have had libvirt create a
+# NATed network for you. Valid values: 'yes' or 'no'
+
+#LIBVIRT_NET_SHUTDOWN="yes"
diff --git a/app-emulation/libvirt/files/libvirt-guests.init b/app-emulation/libvirt/files/libvirt-guests.init
new file mode 100644 (file)
index 0000000..045f04d
--- /dev/null
@@ -0,0 +1,215 @@
+#!/sbin/runscript
+
+description="Virtual Machine Management (libvirt) Guests"
+
+depend() {
+       need libvirtd
+}
+
+# set the default to QEMU
+[ -z "${LIBVIRT_URIS}" ] && LIBVIRT_URIS="qemu:///system"
+
+# default to suspending the VM via managedsave
+case "${LIBVIRT_SHUTDOWN}" in
+       managedsave|shutdown|destroy) ;;
+       *) LIBVIRT_SHUTDOWN="managedsave" ;;
+esac
+
+# default to 500 seconds
+[ -z ${LIBVIRT_MAXWAIT} ] && LIBVIRT_MAXWAIT=500
+
+gueststatefile="/var/lib/libvirt/libvirt-guests.state"
+netstatefile="/var/lib/libvirt/libvirt-net.state"
+
+do_virsh() {
+       local hvuri=$1
+       shift
+
+       # if unset, default to qemu
+       [ -z ${hvuri} ] && hvuri="qemu:///system"
+       # if only qemu was supplied then correct the value
+       [ "xqemu" = x${hvuri} ] && hvuri="qemu:///system"
+
+       # Silence errors because virsh always throws an error about
+       # not finding the hypervisor version when connecting to libvirtd
+       # lastly strip the blank line at the end
+       LC_ALL=C virsh -c ${hvuri} "$@" 2>/dev/null | head -n -1
+}
+
+libvirtd_dom_list() {
+       # Only work with domains by their UUIDs
+       do_virsh "$1" list --uuid $2
+}
+
+libvirtd_dom_count() {
+       libvirtd_dom_list "$1" $2 | wc -l
+}
+
+libvirtd_net_list() {
+       # Only work with networks by their UUIDs
+       do_virsh "$1" net-list --uuid $2
+}
+
+libvirtd_net_count() {
+       libvirtd_net_list "$1" $2 | wc -l
+}
+
+libvirtd_dom_stop() {
+       # stops all persistent or transient domains for a given URI
+       # $1 - uri
+       # $2 - persisent/transient
+
+       local uri=$1
+       local persist=$2
+       local shutdown_type=${LIBVIRT_SHUTDOWN}
+       local counter=${LIBVIRT_MAXWAIT}
+       local dom_name=
+       local dom_ids=
+       local uuid=
+       local dom_count=
+
+       [ "${persist}" = "--transient" ] && shutdown_type="shutdown"
+       [ -n "${counter}" ] || counter=500
+
+       einfo " Shutting down domain(s) ..."
+
+       # grab all persistent or transient domains running
+       dom_ids=$(libvirtd_dom_list ${uri} ${persist})
+
+       for uuid in ${dom_ids}; do
+               # Get the name
+               dom_name=$(do_virsh ${uri} domname ${uuid})
+               einfo "  ${dom_name}"
+
+               if [ "${persist}" = "--persistent" ]; then
+                       # Save our running state
+                       echo "${uri} ${uuid}" >> ${gueststatefile}
+
+               fi
+
+               # Now let's stop it
+               do_virsh "${uri}" ${shutdown_type} ${uuid} > /dev/null
+
+       done
+
+       dom_count="$(libvirtd_dom_count ${uri} ${persist})"
+       while [ ${dom_count} -gt 0 ] && [ ${counter} -gt 0 ] ; do
+               dom_count="$(libvirtd_dom_count ${uri} ${persist})"
+               sleep 1
+               if [ "${shutdown_type}" = "shutdown" ]; then
+                       counter=$((${counter} - 1))
+               fi
+               echo -n "."
+       done
+
+       if [ "${shutdown_type}" = "shutdown" ]; then
+               # grab all domains still running
+               dom_ids=$(libvirtd_dom_list ${uri} ${persist})
+               for uuid in ${dom_ids}; do
+                       dom_name=$(do_virsh ${uri} domname ${uuid})
+                       eerror "  ${dom_name} forcibly stopped"
+                       do_virsh "${uri}" destroy ${uuid} > /dev/null
+               done
+       fi
+}
+
+libvirtd_net_stop() {
+       # stops all persistent or transient domains for a given URI
+       # $1 - uri
+       # $2 - persisent/transient
+
+       local uri=$1
+       local persist=$2
+       local uuid=
+       local net_name=
+
+       if [ "${LIBVIRT_NET_SHUTDOWN}" != "no" ]; then
+
+               einfo " Shutting down network(s):"
+               for uuid in $(libvirtd_net_list ${uri} ${persist}); do
+                       net_name=$(do_virsh ${uri} net-name ${uuid})
+                       einfo "   ${net_name}"
+
+                       if [ "${persist}" = "--persistent" ]; then
+                               # Save our running state
+                               echo "${uri} ${uuid}" >> ${netstatefile}
+
+                       fi
+
+                       # Actually stop the network
+                       do_virsh qemu net-destroy ${uuid} > /dev/null
+               done
+
+       fi
+}
+
+start() {
+       local uri=
+       local uuid=
+       local name=
+
+       for uri in ${LIBVIRT_URIS}; do
+               do_virsh "${uri}" connect
+               if [ $? -ne 0 ]; then
+                       eerror "Failed to connect to '${uri}'. Domains may not start."
+               fi
+       done
+
+       [ ! -e "${netstatefile}" ] && touch "${netstatefile}"
+       [ ! -e "${gueststatefile}" ] && touch "${gueststatefile}"
+
+       # start networks
+       ebegin "Starting libvirt networks"
+       while read -r line
+       do
+               # tokenize the data
+               read -r uri uuid <<<"${line}"
+               # ignore trash
+               [ -z "${uri}" ] || [ -z "${uuid}" ] && continue
+
+               name=$(do_virsh "${uri}" net-name ${uuid})
+               einfo "  ${name}"
+               do_virsh "${uri}" net-start ${uuid} > /dev/null
+       done <"${netstatefile}"
+       eend 0
+
+       # start domains
+       ebegin "Starting libvirt domains"
+       while read -r line
+       do
+               # tokenize the data
+               read -r uri uuid <<<"${line}"
+               # ignore trash
+               [ -z "${uri}" ] || [ -z "${uuid}" ] && continue
+
+               name=$(do_virsh "${uri}" domname ${uuid})
+               einfo "  ${name}"
+               do_virsh "${uri}" start ${uuid} > /dev/null
+       done <"${gueststatefile}"
+       eend 0
+}
+
+stop() {
+       local counter=
+       local dom_name=
+       local net_name=
+       local dom_ids=
+       local uuid=
+       local dom_count=
+
+       rm -f "${gueststatefile}"
+       [ $? -ne 0 ] && eerror "Unable to save domain state"
+       rm -f "${netstatefile}"
+       [ $? -ne 0 ] && eerror "Unable to save net state"
+
+       for uri in ${LIBVIRT_URIS}; do
+               einfo "Stopping libvirt domains and networks for ${uri}"
+
+               libvirtd_dom_stop "${uri}" "--persistent"
+               libvirtd_dom_stop "${uri}" "--transient"
+               libvirtd_net_stop "${uri}" "--persistent"
+               libvirtd_net_stop "${uri}" "--transient"
+
+               einfo "Done stopping domains and networks for ${uri}"
+       done
+}
diff --git a/app-emulation/libvirt/files/libvirtd.confd-r5 b/app-emulation/libvirt/files/libvirtd.confd-r5
new file mode 100644 (file)
index 0000000..3463cb9
--- /dev/null
@@ -0,0 +1,13 @@
+# /etc/conf.d/libvirtd
+
+# Startup dependency
+# libvirtd typically requires all networks to be up and settled which
+# is what rc_need="net" provides. However if you only use specific networks
+# for libvirtd, you may override this. Or if you only use libvirtd locally.
+rc_need="net"
+
+# LIBVIRTD_OPTS
+# You may want to add '--listen' to have libvirtd listen for tcp/ip connections
+# if you want to use libvirt for remote control
+# Please consult 'libvirtd --help' for more options
+#LIBVIRTD_OPTS="--listen"
diff --git a/app-emulation/libvirt/files/libvirtd.init-r15 b/app-emulation/libvirt/files/libvirtd.init-r15
new file mode 100644 (file)
index 0000000..7b95bd8
--- /dev/null
@@ -0,0 +1,35 @@
+#!/sbin/runscript
+
+description="Virtual Machine Management daemon (libvirt)"
+
+depend() {
+       USE_FLAG_FIREWALLD
+       use USE_FLAG_AVAHI USE_FLAG_ISCSI USE_FLAG_RBD dbus virtlockd
+       after ntp-client ntpd nfs nfsmount portmap rpc.statd iptables ip6tables ebtables corosync sanlock cgconfig xenconsoled
+}
+
+start() {
+       # Test configuration directories in /etc/libvirt/ to be either not
+       # present or a directory, i.e. not a regular file, bug #532892
+       for dir in lxc nwfilter qemu storage; do
+               if [ -f /etc/libvirt/$dir ]; then
+                       eerror "/etc/libvirt/$dir was created as a regular file. It must be either"
+                       eerror "a directory or not present for libvirtd to start up successfully."
+                       return 1
+               fi
+       done
+
+       ebegin "Starting libvirtd"
+       start-stop-daemon --start \
+               --env KRB5_KTNAME=/etc/libvirt/krb5.tab \
+               --exec /usr/sbin/libvirtd --pidfile=/var/run/libvirtd.pid \
+               -- -d ${LIBVIRTD_OPTS}
+       eend $?
+}
+
+stop() {
+       ebegin "Stopping libvirtd without shutting down your VMs"
+       start-stop-daemon --stop --quiet --exec \
+               /usr/sbin/libvirtd --pidfile=/var/run/libvirtd.pid
+       eend $?
+}