xenadmin/XenModel/XenAPI-Extensions/PBD.cs

/* Copyright (c) Citrix Systems Inc. 
 * All rights reserved. 
 * 
 * Redistribution and use 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 HOLDER 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.
 */

using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;
using System.Threading;
using XenAdmin;
using XenAdmin.Core;
using XenAdmin.Network;


namespace XenAPI
{
    partial class PBD
    {
        private static bool WaitForPlug(Session session, string pbdOpaqueRef)
        {
            int timeout = 120; //Wait 2 min for PBD to plug

            while (timeout > 0)
            {
                if (PBD.get_currently_attached(session, pbdOpaqueRef))
                    return true;
                Thread.Sleep(1000);
                timeout--;
            }

            return false;
        }

        public static List<PBD> GetPBDsFor(IEnumerable<VM> vms)
        {
            List<PBD> pbds = new List<PBD>();

            // Find all the PBDs this vm relies on

            foreach (VM vm in vms)
            {
                foreach (VBD vbd in vm.Connection.ResolveAll<VBD>(vm.VBDs))
                {
                    VDI vdi = vbd.Connection.Resolve<VDI>(vbd.VDI);
                    if (vdi == null)
                        continue;

                    SR sr = vdi.Connection.Resolve<SR>(vdi.SR);
                    if (sr == null)
                        continue;

                    foreach (PBD pbd in vm.Connection.ResolveAll<PBD>(sr.PBDs))
                    {
                        if (!pbds.Contains(pbd))
                            pbds.Add(pbd);
                    }
                }
            }

            return pbds;
        }

        /// <summary>
        /// Wrapper for the plug method making a best effort at plugging the PBD
        /// i.e. if the plug throws an exception due to a failure this is masked
        /// </summary>
        /// <param name="session">session</param>
        /// <param name="selfOpaqueRef">Opaque reference to self</param>
        public static void NonchalantPlug(Session session, string selfOpaqueRef )
        {
            try
            {
                plug(session, selfOpaqueRef); 
            }
            catch //All exceptions from plug are masked here
            {
            }
        }

        private enum PlugMode
        {
            NORMAL,     //Exception raised in the plug are propagated
            NONCHALANT  //Exceptions raised in the plug are masked
        }

        public static void CheckAndPlugPBDsFor(IXenConnection connection, List<XenRef<VM>> vmRefs)
        {
            CheckAndPlugPBDsFor(connection, vmRefs, PlugMode.NORMAL);
        }

        public static void CheckAndBestEffortPlugPBDsFor(IXenConnection connection, List<XenRef<VM>> vmRefs)
        {
            CheckAndPlugPBDsFor(connection, vmRefs, PlugMode.NONCHALANT);
        }

        private static void CheckAndPlugPBDsFor(IXenConnection connection, List<XenRef<VM>> vmRefs, PlugMode plugMode)
        {
            //Program.AssertOffEventThread();

            List<VM> vms = new List<VM>();

            foreach (XenRef<VM> vmRef in vmRefs)
            {
                VM vm = null;
                while ((vm = connection.Resolve<VM>(vmRef)) == null)
                    Thread.Sleep(100);

                vms.Add(vm);
            }
            
            CheckAndPlugPBDsFor(vms, plugMode);
        }

        public static void CheckAndPlugPBDsFor(List<VM> vms)
        {
            CheckAndPlugPBDsFor( vms, PlugMode.NORMAL );
        }

        private static void CheckAndPlugPBDsFor(List<VM> vms, PlugMode plugMode)
        {
            //Program.AssertOffEventThread();

            List<PBD> pbds = PBD.GetPBDsFor(vms);

            // Now lets see if they're all plugged
            CheckAndPlugPBDs(pbds, plugMode);
        }

        public static void CheckAndPlugPBDs(IList<PBD> pbds)
        {
            CheckAndPlugPBDs(pbds, PlugMode.NORMAL);
        }

        private static void CheckAndPlugPBDs(IList<PBD> pbds, PlugMode plugMode)
        {
            foreach (PBD pbd in pbds)
            {
                Session session = pbd.Connection.DuplicateSession();

                // Wait 2 min for PBD to become plugged
                if (WaitForPlug(session, pbd.opaque_ref))
                    continue;

                // If we still havent plugged, then try and plug it - this will probably
                // fail, but at least we'll get a better error message.
                if( plugMode == PlugMode.NONCHALANT )
                    NonchalantPlug(session, pbd.opaque_ref);
                else
                    plug(session, pbd.opaque_ref);
            }
        }

        public static List<PBD> GetUnpluggedPBDsFor(IEnumerable<VM> vms)
        {
            List<PBD> unpluggedPBDs = new List<PBD>();

            foreach (PBD pbd in PBD.GetPBDsFor(vms))
            {
                if (!pbd.currently_attached)
                    unpluggedPBDs.Add(pbd);
            }

            return unpluggedPBDs;
        }

        public static IEnumerable<SR> GetSRs(IEnumerable<PBD> pbds)
        {
            List<SR> result = new List<SR>();
            foreach (PBD pbd in pbds)
            {
                SR sr = pbd.Connection.Resolve(pbd.SR);
                if (sr != null)
                    result.Add(sr);
            }
            return result;
        }

        public bool MultipathActive
        {
            get
            {
                return BoolKey(other_config, "multipathed");
            }
        }

        /// <summary>
        /// The number of iSCSI sessions in use, as advertised by the SR backend, or -1 if the value is missing.
        /// </summary>
        public int ISCSISessions
        {
            get
            {
                return IntKey(other_config, "iscsi_sessions", -1);
            }
        }

        private static readonly Regex multipathCountRegex = new Regex(@"\[(\d+)L?,\s(\d+)L?");

        public static bool ParsePathCounts(String input, out int currentPaths, out int maxPaths)
        {
            currentPaths = 0;
            maxPaths = 0;

            Match match = multipathCountRegex.Match(input);

            return match.Success && match.Groups.Count == 3 &&
                int.TryParse(match.Groups[1].Value, out currentPaths) &&
                int.TryParse(match.Groups[2].Value, out maxPaths);
        }

        /// <summary>
        /// The status of the PBD as a friendly string (unplugged, host down, connected)
        /// </summary>
        public string StatusString
        {
            get
            {
                Host h = Connection.Resolve(host);
                if ((!currently_attached) || (h == null))
                {
                    return Messages.REPAIR_SR_DIALOG_UNPLUGGED;
                }
                else if (!h.IsLive)
                    return Messages.HOST_NOT_LIVE;
                else
                    return Messages.CONNECTED;
            }
        }

        public StorageLinkCredentials GetStorageLinkCredentials()
        {
            var deviceConfig = new Dictionary<string, string>(device_config);
            
            SR sr = Connection.Resolve<SR>(SR);
            
            if (sr != null && sr.type == "cslg" && Helpers.MidnightRideOrGreater(sr.Connection))
            {
                string host, username, passwordSecret;

                deviceConfig.TryGetValue("target", out host);
                deviceConfig.TryGetValue("username", out username);
                deviceConfig.TryGetValue("password_secret", out passwordSecret);

                return new StorageLinkCredentials(Connection, host, username, null, passwordSecret);
            }
            return null;
        }
    }
}