/*
* 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:
*
* 1) Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2) 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;
using System.Collections.Generic;
using CookComputing.XmlRpc;
namespace XenAPI
{
///
/// A physical GPU (pGPU)
/// First published in XenServer 6.0.
///
public partial class PGPU : XenObject
{
public PGPU()
{
}
public PGPU(string uuid,
XenRef PCI,
XenRef GPU_group,
XenRef host,
Dictionary other_config,
List> supported_VGPU_types,
List> enabled_VGPU_types,
List> resident_VGPUs,
Dictionary, long> supported_VGPU_max_capacities)
{
this.uuid = uuid;
this.PCI = PCI;
this.GPU_group = GPU_group;
this.host = host;
this.other_config = other_config;
this.supported_VGPU_types = supported_VGPU_types;
this.enabled_VGPU_types = enabled_VGPU_types;
this.resident_VGPUs = resident_VGPUs;
this.supported_VGPU_max_capacities = supported_VGPU_max_capacities;
}
///
/// Creates a new PGPU from a Proxy_PGPU.
///
///
public PGPU(Proxy_PGPU proxy)
{
this.UpdateFromProxy(proxy);
}
public override void UpdateFrom(PGPU update)
{
uuid = update.uuid;
PCI = update.PCI;
GPU_group = update.GPU_group;
host = update.host;
other_config = update.other_config;
supported_VGPU_types = update.supported_VGPU_types;
enabled_VGPU_types = update.enabled_VGPU_types;
resident_VGPUs = update.resident_VGPUs;
supported_VGPU_max_capacities = update.supported_VGPU_max_capacities;
}
internal void UpdateFromProxy(Proxy_PGPU proxy)
{
uuid = proxy.uuid == null ? null : (string)proxy.uuid;
PCI = proxy.PCI == null ? null : XenRef.Create(proxy.PCI);
GPU_group = proxy.GPU_group == null ? null : XenRef.Create(proxy.GPU_group);
host = proxy.host == null ? null : XenRef.Create(proxy.host);
other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config);
supported_VGPU_types = proxy.supported_VGPU_types == null ? null : XenRef.Create(proxy.supported_VGPU_types);
enabled_VGPU_types = proxy.enabled_VGPU_types == null ? null : XenRef.Create(proxy.enabled_VGPU_types);
resident_VGPUs = proxy.resident_VGPUs == null ? null : XenRef.Create(proxy.resident_VGPUs);
supported_VGPU_max_capacities = proxy.supported_VGPU_max_capacities == null ? null : Maps.convert_from_proxy_XenRefVGPU_type_long(proxy.supported_VGPU_max_capacities);
}
public Proxy_PGPU ToProxy()
{
Proxy_PGPU result_ = new Proxy_PGPU();
result_.uuid = (uuid != null) ? uuid : "";
result_.PCI = (PCI != null) ? PCI : "";
result_.GPU_group = (GPU_group != null) ? GPU_group : "";
result_.host = (host != null) ? host : "";
result_.other_config = Maps.convert_to_proxy_string_string(other_config);
result_.supported_VGPU_types = (supported_VGPU_types != null) ? Helper.RefListToStringArray(supported_VGPU_types) : new string[] {};
result_.enabled_VGPU_types = (enabled_VGPU_types != null) ? Helper.RefListToStringArray(enabled_VGPU_types) : new string[] {};
result_.resident_VGPUs = (resident_VGPUs != null) ? Helper.RefListToStringArray(resident_VGPUs) : new string[] {};
result_.supported_VGPU_max_capacities = Maps.convert_to_proxy_XenRefVGPU_type_long(supported_VGPU_max_capacities);
return result_;
}
///
/// Creates a new PGPU from a Hashtable.
///
///
public PGPU(Hashtable table)
{
uuid = Marshalling.ParseString(table, "uuid");
PCI = Marshalling.ParseRef(table, "PCI");
GPU_group = Marshalling.ParseRef(table, "GPU_group");
host = Marshalling.ParseRef(table, "host");
other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config"));
supported_VGPU_types = Marshalling.ParseSetRef(table, "supported_VGPU_types");
enabled_VGPU_types = Marshalling.ParseSetRef(table, "enabled_VGPU_types");
resident_VGPUs = Marshalling.ParseSetRef(table, "resident_VGPUs");
supported_VGPU_max_capacities = Maps.convert_from_proxy_XenRefVGPU_type_long(Marshalling.ParseHashTable(table, "supported_VGPU_max_capacities"));
}
public bool DeepEquals(PGPU other)
{
if (ReferenceEquals(null, other))
return false;
if (ReferenceEquals(this, other))
return true;
return Helper.AreEqual2(this._uuid, other._uuid) &&
Helper.AreEqual2(this._PCI, other._PCI) &&
Helper.AreEqual2(this._GPU_group, other._GPU_group) &&
Helper.AreEqual2(this._host, other._host) &&
Helper.AreEqual2(this._other_config, other._other_config) &&
Helper.AreEqual2(this._supported_VGPU_types, other._supported_VGPU_types) &&
Helper.AreEqual2(this._enabled_VGPU_types, other._enabled_VGPU_types) &&
Helper.AreEqual2(this._resident_VGPUs, other._resident_VGPUs) &&
Helper.AreEqual2(this._supported_VGPU_max_capacities, other._supported_VGPU_max_capacities);
}
public override string SaveChanges(Session session, string opaqueRef, PGPU server)
{
if (opaqueRef == null)
{
System.Diagnostics.Debug.Assert(false, "Cannot create instances of this type on the server");
return "";
}
else
{
if (!Helper.AreEqual2(_other_config, server._other_config))
{
PGPU.set_other_config(session, opaqueRef, _other_config);
}
if (!Helper.AreEqual2(_GPU_group, server._GPU_group))
{
PGPU.set_GPU_group(session, opaqueRef, _GPU_group);
}
return null;
}
}
///
/// Get a record containing the current state of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
public static PGPU get_record(Session session, string _pgpu)
{
return new PGPU((Proxy_PGPU)session.proxy.pgpu_get_record(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get a reference to the PGPU instance with the specified UUID.
/// First published in XenServer 6.0.
///
/// The session
/// UUID of object to return
public static XenRef get_by_uuid(Session session, string _uuid)
{
return XenRef.Create(session.proxy.pgpu_get_by_uuid(session.uuid, (_uuid != null) ? _uuid : "").parse());
}
///
/// Get the uuid field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
public static string get_uuid(Session session, string _pgpu)
{
return (string)session.proxy.pgpu_get_uuid(session.uuid, (_pgpu != null) ? _pgpu : "").parse();
}
///
/// Get the PCI field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
public static XenRef get_PCI(Session session, string _pgpu)
{
return XenRef.Create(session.proxy.pgpu_get_pci(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the GPU_group field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
public static XenRef get_GPU_group(Session session, string _pgpu)
{
return XenRef.Create(session.proxy.pgpu_get_gpu_group(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the host field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
public static XenRef get_host(Session session, string _pgpu)
{
return XenRef.Create(session.proxy.pgpu_get_host(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the other_config field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
public static Dictionary get_other_config(Session session, string _pgpu)
{
return Maps.convert_from_proxy_string_string(session.proxy.pgpu_get_other_config(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the supported_VGPU_types field of the given PGPU.
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
public static List> get_supported_VGPU_types(Session session, string _pgpu)
{
return XenRef.Create(session.proxy.pgpu_get_supported_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the enabled_VGPU_types field of the given PGPU.
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
public static List> get_enabled_VGPU_types(Session session, string _pgpu)
{
return XenRef.Create(session.proxy.pgpu_get_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the resident_VGPUs field of the given PGPU.
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
public static List> get_resident_VGPUs(Session session, string _pgpu)
{
return XenRef.Create(session.proxy.pgpu_get_resident_vgpus(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Get the supported_VGPU_max_capacities field of the given PGPU.
/// First published in XenServer 6.2 SP1.
///
/// The session
/// The opaque_ref of the given pgpu
public static Dictionary, long> get_supported_VGPU_max_capacities(Session session, string _pgpu)
{
return Maps.convert_from_proxy_XenRefVGPU_type_long(session.proxy.pgpu_get_supported_vgpu_max_capacities(session.uuid, (_pgpu != null) ? _pgpu : "").parse());
}
///
/// Set the other_config field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
/// New value to set
public static void set_other_config(Session session, string _pgpu, Dictionary _other_config)
{
session.proxy.pgpu_set_other_config(session.uuid, (_pgpu != null) ? _pgpu : "", Maps.convert_to_proxy_string_string(_other_config)).parse();
}
///
/// Add the given key-value pair to the other_config field of the given PGPU.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
/// Key to add
/// Value to add
public static void add_to_other_config(Session session, string _pgpu, string _key, string _value)
{
session.proxy.pgpu_add_to_other_config(session.uuid, (_pgpu != null) ? _pgpu : "", (_key != null) ? _key : "", (_value != null) ? _value : "").parse();
}
///
/// Remove the given key and its corresponding value from the other_config field of the given PGPU. If the key is not in that Map, then do nothing.
/// First published in XenServer 6.0.
///
/// The session
/// The opaque_ref of the given pgpu
/// Key to remove
public static void remove_from_other_config(Session session, string _pgpu, string _key)
{
session.proxy.pgpu_remove_from_other_config(session.uuid, (_pgpu != null) ? _pgpu : "", (_key != null) ? _key : "").parse();
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU type to enable
public static void add_enabled_VGPU_types(Session session, string _pgpu, string _value)
{
session.proxy.pgpu_add_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? _value : "").parse();
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU type to enable
public static XenRef async_add_enabled_VGPU_types(Session session, string _pgpu, string _value)
{
return XenRef.Create(session.proxy.async_pgpu_add_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? _value : "").parse());
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU type to disable
public static void remove_enabled_VGPU_types(Session session, string _pgpu, string _value)
{
session.proxy.pgpu_remove_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? _value : "").parse();
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU type to disable
public static XenRef async_remove_enabled_VGPU_types(Session session, string _pgpu, string _value)
{
return XenRef.Create(session.proxy.async_pgpu_remove_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? _value : "").parse());
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU types to enable
public static void set_enabled_VGPU_types(Session session, string _pgpu, List> _value)
{
session.proxy.pgpu_set_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? Helper.RefListToStringArray(_value) : new string[] {}).parse();
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU types to enable
public static XenRef async_set_enabled_VGPU_types(Session session, string _pgpu, List> _value)
{
return XenRef.Create(session.proxy.async_pgpu_set_enabled_vgpu_types(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? Helper.RefListToStringArray(_value) : new string[] {}).parse());
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The group to which the PGPU will be moved
public static void set_GPU_group(Session session, string _pgpu, string _value)
{
session.proxy.pgpu_set_gpu_group(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? _value : "").parse();
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The group to which the PGPU will be moved
public static XenRef async_set_GPU_group(Session session, string _pgpu, string _value)
{
return XenRef.Create(session.proxy.async_pgpu_set_gpu_group(session.uuid, (_pgpu != null) ? _pgpu : "", (_value != null) ? _value : "").parse());
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU type for which we want to find the number of VGPUs which can still be started on this PGPU
public static long get_remaining_capacity(Session session, string _pgpu, string _vgpu_type)
{
return long.Parse((string)session.proxy.pgpu_get_remaining_capacity(session.uuid, (_pgpu != null) ? _pgpu : "", (_vgpu_type != null) ? _vgpu_type : "").parse());
}
///
///
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
/// The session
/// The opaque_ref of the given pgpu
/// The VGPU type for which we want to find the number of VGPUs which can still be started on this PGPU
public static XenRef async_get_remaining_capacity(Session session, string _pgpu, string _vgpu_type)
{
return XenRef.Create(session.proxy.async_pgpu_get_remaining_capacity(session.uuid, (_pgpu != null) ? _pgpu : "", (_vgpu_type != null) ? _vgpu_type : "").parse());
}
///
/// Return a list of all the PGPUs known to the system.
/// First published in XenServer 6.0.
///
/// The session
public static List> get_all(Session session)
{
return XenRef.Create(session.proxy.pgpu_get_all(session.uuid).parse());
}
///
/// Get all the PGPU Records at once, in a single XML RPC call
/// First published in XenServer 6.0.
///
/// The session
public static Dictionary, PGPU> get_all_records(Session session)
{
return XenRef.Create(session.proxy.pgpu_get_all_records(session.uuid).parse());
}
///
/// Unique identifier/object reference
///
public virtual string uuid
{
get { return _uuid; }
set
{
if (!Helper.AreEqual(value, _uuid))
{
_uuid = value;
Changed = true;
NotifyPropertyChanged("uuid");
}
}
}
private string _uuid;
///
/// Link to underlying PCI device
///
public virtual XenRef PCI
{
get { return _PCI; }
set
{
if (!Helper.AreEqual(value, _PCI))
{
_PCI = value;
Changed = true;
NotifyPropertyChanged("PCI");
}
}
}
private XenRef _PCI;
///
/// GPU group the pGPU is contained in
///
public virtual XenRef GPU_group
{
get { return _GPU_group; }
set
{
if (!Helper.AreEqual(value, _GPU_group))
{
_GPU_group = value;
Changed = true;
NotifyPropertyChanged("GPU_group");
}
}
}
private XenRef _GPU_group;
///
/// Host that own the GPU
///
public virtual XenRef host
{
get { return _host; }
set
{
if (!Helper.AreEqual(value, _host))
{
_host = value;
Changed = true;
NotifyPropertyChanged("host");
}
}
}
private XenRef _host;
///
/// Additional configuration
///
public virtual Dictionary other_config
{
get { return _other_config; }
set
{
if (!Helper.AreEqual(value, _other_config))
{
_other_config = value;
Changed = true;
NotifyPropertyChanged("other_config");
}
}
}
private Dictionary _other_config;
///
/// List of VGPU types supported by the underlying hardware
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
public virtual List> supported_VGPU_types
{
get { return _supported_VGPU_types; }
set
{
if (!Helper.AreEqual(value, _supported_VGPU_types))
{
_supported_VGPU_types = value;
Changed = true;
NotifyPropertyChanged("supported_VGPU_types");
}
}
}
private List> _supported_VGPU_types;
///
/// List of VGPU types which have been enabled for this PGPU
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
public virtual List> enabled_VGPU_types
{
get { return _enabled_VGPU_types; }
set
{
if (!Helper.AreEqual(value, _enabled_VGPU_types))
{
_enabled_VGPU_types = value;
Changed = true;
NotifyPropertyChanged("enabled_VGPU_types");
}
}
}
private List> _enabled_VGPU_types;
///
/// List of VGPUs running on this PGPU
/// First published in XenServer 6.2 SP1 Tech-Preview.
///
public virtual List> resident_VGPUs
{
get { return _resident_VGPUs; }
set
{
if (!Helper.AreEqual(value, _resident_VGPUs))
{
_resident_VGPUs = value;
Changed = true;
NotifyPropertyChanged("resident_VGPUs");
}
}
}
private List> _resident_VGPUs;
///
/// A map relating each VGPU type supported on this GPU to the maximum number of VGPUs of that type which can run simultaneously on this GPU
/// First published in XenServer 6.2 SP1.
///
public virtual Dictionary, long> supported_VGPU_max_capacities
{
get { return _supported_VGPU_max_capacities; }
set
{
if (!Helper.AreEqual(value, _supported_VGPU_max_capacities))
{
_supported_VGPU_max_capacities = value;
Changed = true;
NotifyPropertyChanged("supported_VGPU_max_capacities");
}
}
}
private Dictionary, long> _supported_VGPU_max_capacities;
}
}