The Windows Guest WMI Interface
+===============================
-The Windows Guest WMI interface is intended to replace as the mechanism of choice for communicating with xenstore (and other hypervisor interfaces). It is provided by the device driver xeniface.sys, which forms part of the Windows PV Drivers. Access to this interface is available to those users which have been granted to the root\wmi namespace - which is to say the device driver namespace. By default this is administrators only.
+The Windows Guest WMI interface is intended to replace as the mechanism of
+choice for communicating with xenstore (and other hypervisor interfaces). It
+is provided by the device driver xeniface.sys, which forms part of the Windows PV
+Drivers. Access to this interface is available to those users which have been
+granted to the root\wmi namespace - which is to say the device driver namespace.
+By default this is administrators only.
-The WMI Interface provides a base singleton object (CitrixXenStoreBase) which can be used to generate individual session objects (CitrixXenStoreSession). These session objects represent individual applications (or functions of an application), and are the objects used to interact with xenstore - to read write, set and unset watches. Sessions may also take advantage of the transaction semantics to ensure atomicity of xenstore operations.
+The WMI Interface provides a base singleton object which can be used to generate
+individual session objects. These session objects represent individual applications
+(or functions of an application), and are the objects used to interact with
+xenstore - to read write, set and unset watches. Sessions may also take advantage
+of the transaction semantics to ensure atomicity of xenstore operations.
-The lifetime of watches and transactions are limited by the lifetime of the session object which creates them
+The lifetime of watches and transactions are limited by the lifetime of the session
+object which creates them.
-On driverload, one object is made available via WMI
+For branding purposes an object name PREFIX can be set at build time using the
+OBJECT_PREFIX environment variable.
-CitrixXenStoreBase
+On driverload, one object is made available via WMI:
+
+<PREFIX>XenStoreBase
A singleton object representing xenstore
Hypervisor's clock.
Methods:
AddSession(String Id) returns SessionId:
- Add a CitrixXenStoreSession object to the WMI namespace
+ Add a <PREFIX>XenStoreSession object to the WMI namespace
The returned value (session id) is a unique value whcih can be used to
identify the session which has been created (in case multiple sessions
have the same string identifier)
-CitrixXenStoreSession
+<PREFIX>XenStoreSession
Each instance represents a single session of communication with xenstore
About events:
-CitrixXenStoreWatchEvent:
+<PREFIX>XenStoreWatchEvent:
-Event emitted when a particular xenstore entry has changed. Registering your interest in receiving such an event can be done by calling CitrixXenStoreSession.SetWatch(pathname)
+Event emitted when a particular xenstore entry has changed. Registering your interest in receiving such an event can be done by calling <PREFIX>XenStoreSession.SetWatch(pathname)
string EventId : The pathname of the xen store value which has changed
-CitrixXenStoreUnsuspendedEvent:
+<PREFIX>XenStoreUnsuspendedEvent:
Event emitted whenever a vm resumes from being suspended.
Locate the base object
- $base = gwmi -n root\wmi -cl CitrixXenStoreBase
+ $base = gwmi -n root\wmi -cl <PREFIX>XenStoreBase
Create a session
$sid = $base.AddSession("MyNewSession")
- $session = gwmi -n root\wmi -q "select * from CitrixXenStoreSession where SessionId=$($sid.SessionId)"
+ $session = gwmi -n root\wmi -q "select * from <PREFIX>XenStoreSession where SessionId=$($sid.SessionId)"
Write a value
Set Watch
- $watch = Register-WMiEvent -n root\wmi -q "select * from CitrixXenStoreWatchEvent where EventId='data/TempValue'" -action {write $session.getvalue("data/TempValue") }
+ $watch = Register-WMiEvent -n root\wmi -q "select * from <PREFIX>XenStoreWatchEvent where EventId='data/TempValue'" -action {write $session.getvalue("data/TempValue") }
$session.setvalue("data/TempValue","HELLO")
$session.setvalue("data/TempValue","WORLD")
file.write('#define DAY_STR\t"' + str(now.day) + '"\n')
file.write('\n')
+ file.write('#define OBJECT_PREFIX_STR\t"' + os.environ['OBJECT_PREFIX'] + '"\n')
+ file.write('#define OBJECT_GUID(_Name)\t' + os.environ['OBJECT_PREFIX'] + ' ## _Name ## _GUID\n')
+
file.close()
src.close()
+def copy_mof(name):
+ src = open('src\\%s.mof' % name, 'r')
+ dst = open('src\\%s\\wmi.mof' % name, 'w')
+
+ for line in src:
+ line = re.sub('@OBJECT_PREFIX@', os.environ['OBJECT_PREFIX'], line)
+ dst.write(line)
+
+ dst.close()
+ src.close()
+
+
def get_expired_symbols(name, age = 30):
path = os.path.join(os.environ['SYMBOL_SERVER'], '000Admin\\history.txt')
if 'PRODUCT_NAME' not in os.environ.keys():
os.environ['PRODUCT_NAME'] = 'Xen'
+ if 'OBJECT_PREFIX' not in os.environ.keys():
+ os.environ['OBJECT_PREFIX'] = 'XenProject'
+
os.environ['MAJOR_VERSION'] = '8'
os.environ['MINOR_VERSION'] = '0'
os.environ['MICRO_VERSION'] = '0'
make_header()
+ copy_mof(driver)
+
copy_inf(driver)
symstore_del(driver, 30)
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup Label="ProjectConfigurations">
<ProjectConfiguration Include="Debug|Win32">
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<LinkIncremental>false</LinkIncremental>
</PropertyGroup>
+
+ <PropertyGroup>
+ <IncludePath>..\..\include;$(IncludePath)</IncludePath>
+ </PropertyGroup>
+
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<ClCompile>
<PrecompiledHeader>Use</PrecompiledHeader>
<Optimization>Disabled</Optimization>
<PreprocessorDefinitions>WIN32;_DEBUG;_WINDOWS;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<SDLCheck>true</SDLCheck>
- <AdditionalIncludeDirectories>$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+ <AdditionalIncludeDirectories>..\..\include;$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
</ClCompile>
<Link>
<Optimization>Disabled</Optimization>
<PreprocessorDefinitions>WIN32;_DEBUG;_WINDOWS;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<SDLCheck>true</SDLCheck>
- <AdditionalIncludeDirectories>$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+ <AdditionalIncludeDirectories>..\..\include;$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
</ClCompile>
<Link>
<IntrinsicFunctions>true</IntrinsicFunctions>
<PreprocessorDefinitions>WIN32;NDEBUG;_CRT_SECURE_NO_WARNINGS;_WINDOWS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<SDLCheck>true</SDLCheck>
- <AdditionalIncludeDirectories>$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+ <AdditionalIncludeDirectories>..\..\include;$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<BrowseInformation>true</BrowseInformation>
<PreprocessToFile>false</PreprocessToFile>
<RuntimeLibrary>MultiThreaded</RuntimeLibrary>
<IntrinsicFunctions>true</IntrinsicFunctions>
<PreprocessorDefinitions>WIN32;NDEBUG;_CRT_SECURE_NO_WARNINGS;_WINDOWS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<SDLCheck>true</SDLCheck>
- <AdditionalIncludeDirectories>$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+ <AdditionalIncludeDirectories>..\..\include;$(SolutionDir)\liteagent;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<BrowseInformation>true</BrowseInformation>
<PreprocessToFile>false</PreprocessToFile>
<RuntimeLibrary>MultiThreaded</RuntimeLibrary>
//#include "xs_private.h"
#include <wbemidl.h>
+#include <version.h>
+
+#define WIDEN2(x) L ## x
+#define WIDEN(x) WIDEN2(x)
+
+#define OBJECT_NAME_A(_Name) OBJECT_PREFIX_STR "XenStore" #_Name
+#define OBJECT_NAME_W(_Name) WIDEN(OBJECT_PREFIX_STR) L"XenStore" WIDEN(#_Name)
+
#pragma comment(lib, "wbemuuid.lib")
#pragma comment(lib, "uuid.lib")
#pragma comment(lib, "comsuppw.lib")
IWbemClassObject *getBase(WMIAccessor** wmi)
{
- IWbemClassObject* base = getObject(wmi, L"CitrixXenStoreBase");
+ IWbemClassObject* base = getObject(wmi, OBJECT_NAME_W(Base));
if (base == NULL) {
*wmi = NULL;
return NULL;
IWbemClassObject *getBaseClass(WMIAccessor** wmi)
{
- IWbemClassObject* baseclass = getClass(wmi, L"CitrixXenStoreBase");
+ IWbemClassObject* baseclass = getClass(wmi, OBJECT_NAME_W(Base));
if (baseclass == NULL) {
*wmi = NULL;
return NULL;
{
HRESULT hres;
- BSTR query = formatBstr("SELECT * FROM CitrixXenStoreSession WHERE Id=\"Citrix Xen Win32 Service : %s\"", sessionname);
+ BSTR query = formatBstr("SELECT * FROM " OBJECT_NAME_A(Session) " WHERE Id=\"" OBJECT_PREFIX_STR " Xen Win32 Service : %s\"", sessionname);
if (query == NULL)
goto formatsessionbstrfailed;
VARIANT var;
var.vt = VT_BSTR;
- var.bstrVal=formatBstr("Citrix Xen Win32 Service : %s", sessionname);
+ var.bstrVal=formatBstr(COMPANY_NAME_STR " Xen Win32 Service : %s", sessionname);
if (var.bstrVal == NULL)
goto formatnamebstrfailed;
goto outmethodgetfailed;
size_t query_len;
- query_len = strlen("SELECT * FROM CitrixXenStoreSession WHERE SessionId=")+10;
+ query_len = strlen("SELECT * FROM " OBJECT_NAME_A(Session) " WHERE SessionId=")+10;
query = SysAllocStringLen(NULL, (UINT)query_len);
if (query == NULL)
goto allocqueryfailed;
- swprintf_s(query,query_len, L"SELECT * FROM CitrixXenStoreSession WHERE SessionId=%d", var.uintVal);
+ swprintf_s(query,query_len, L"SELECT * FROM " OBJECT_NAME_W(Session) L" WHERE SessionId=%d", var.uintVal);
sessions = runXSQuery(wmi, query );
SysFreeString(query);
ASSERT(wmi != NULL);
- sessionClass = getClass(wmi, L"CitrixXenStoreSession");
+ sessionClass = getClass(wmi, OBJECT_NAME_W(Session));
if (sessionClass == NULL)
goto getclassfailed;
ASSERT((*sessionhandle) != NULL);
WatchSink * sink = new WatchSink(event, errorevent, path);
- BSTR query=formatBstr("SELECT * from CitrixXenStoreWatchEvent WHERE EventId=\"%s\"", path);
+ BSTR query=formatBstr("SELECT * from " OBJECT_NAME_A(WatchEvent) " WHERE EventId=\"%s\"", path);
if (query == NULL) {
goto formatstringfailed;
}
ASSERT(*wmi != NULL);
WatchSink * sink = new WatchSink(event, errorevent, NULL);
- BSTR query=formatBstr("SELECT * from CitrixXenStoreUnsuspendedEvent");
+ BSTR query=formatBstr("SELECT * from " OBJECT_NAME_A(UnsuspendedEvent));
if (query==NULL) {
goto formatstringfailed;
}
#ifndef _XSERVICE_H
#define _XSERVICE_H
+#include <version.h>
+
#define SVC_NAME "xensvc"
-#define SVC_DISPLAYNAME "Citrix Tools for Virtual Machines Service"
+#define SVC_DISPLAYNAME PRODUCT_NAME_STR ## "Interface Service"
#define SVC_DESC "Monitors and provides various metrics to XenStore"
void PrintError(const char *func);
#include <windows.h>
#include <ntverp.h>
+#undef VER_COMPANYNAME_STR
+#undef VER_PRODUCTNAME_STR
+#undef VER_PRODUCTVERSION
+#undef VER_PRODUCTVERSION_STR
+#include <version.h>
+
+#define VER_COMPANYNAME_STR COMPANY_NAME_STR
+#define VER_LEGALCOPYRIGHT_STR "Copyright (c) Citrix Systems Inc."
+
+#define VER_PRODUCTNAME_STR "XENIFACE"
+#define VER_PRODUCTVERSION MAJOR_VERSION,MINOR_VERSION,MICRO_VERSION,BUILD_NUMBER
+#define VER_PRODUCTVERSION_STR MAJOR_VERSION_STR "." MINOR_VERSION_STR "." MICRO_VERSION_STR "." BUILD_NUMBER_STR
#define VER_INTERNALNAME_STR "w32xagent.exe"
#define VER_FILEVERSION_STR "1.0"
-#define VER_FILEDESCRIPTION_STR "XenSource Windows guest agent"
+#define VER_FILEDESCRIPTION_STR "w32agent"
#define VER_ORIGINALFILENAME_STR "w32xagent.exe"
#define VER_FILETYPE VFT_APP
#define VER_FILESUBTYPE 0
Signature="$WINDOWS NT$"\r
Class=System\r
ClassGUID={4d36e97d-e325-11ce-bfc1-08002be10318} \r
-Provider=%Citrix%\r
-DriverVer=09/07/2011,6.0.0.0\r
+Provider=%Company%\r
+DriverVer=01/01/1900,0.0.0.0\r
CatalogFile=xeniface.cat\r
\r
[DestinationDirs]\r
DefaultDestDir = 12\r
ServiceDestDir.NT.Copy = 11\r
\r
-;*****************************************\r
-; Xeniface Device Install Section\r
-;*****************************************\r
-\r
[Manufacturer]\r
-%Citrix%=Citrix,NT$ARCH$\r
+%Company%=Inst,NT$ARCH$\r
\r
-[Citrix.NT$ARCH$]\r
+[Inst.NT$ARCH$]\r
; DisplayName Section DeviceID\r
; ----------- ------- --------\r
\r
[ServiceDestDir.NT.Copy]\r
liteagent.exe\r
\r
-;-------------- Service installation\r
-\r
[Xeniface_Device.NT$ARCH$.Services]\r
AddService = xeniface, %SPSVCINST_ASSOCSERVICE%, xeniface_Service_Inst\r
AddService = xenlite, %LITESVC_FLAGS%, xenlite_Service_Inst\r
ErrorControl = 1 ; SERVICE_ERROR_NORMAL\r
ServiceBinary = %11%\liteagent.exe\r
\r
-\r
[SourceDisksNames]\r
1 = %DiskId1%,,,""\r
\r
\r
[Strings]\r
SPSVCINST_ASSOCSERVICE= 0x00000002\r
-Citrix= "Citrix Systems, Inc." \r
-DiskId1 = "XenServer Tools for Virtual Machines"\r
-XenIfaceDevice.DeviceDesc = "XenServer Interface"\r
-xeniface.SVCDESC = "XenServer Interface Device Driver"\r
+Company= "@COMPANY_NAME@" \r
+DiskId1 = "@PRODUCT_NAME@ Interface Package"\r
+XenIfaceDevice.DeviceDesc = "@PRODUCT_NAME Interface"\r
LITESVC_FLAGS= 0x00000800\r
-xenlite.SVCDESC= "XenServer Lite Guest Agent"\r
+xenlite.SVCDESC= "@PRODUCT_NAME Interface Service"\r
\r
--- /dev/null
+[Dynamic, Provider("WMIProv"),
+ WMI,
+ Description("Xenstore Node"),
+ guid("{1D80EB99-A1D6-4492-B62F-8B4549FF0B5E}"),
+ locale("MS\\0x409")]
+class @OBJECT_PREFIX@XenStoreNodes
+{
+ [key, read]
+ string InstanceName;
+ [read] boolean Active;
+
+ [WmiDataId(1),
+ read,
+ Description("Number of child nodes")]
+ uint32 NoOfChildNodes;
+
+ [WmiDataId(2),
+ read,
+ WmiSizeIs("NoOfChildNodes"),
+ Description("Child Nodes")]
+ string ChildNodes[];
+
+};
+
+[Dynamic, Provider("WMIProv"),
+ WMI,
+ Description("Xenstore Session"),
+ guid("{12138A69-97B2-49DD-B9DE-54749AABC789}"),
+ locale("MS\\0x409")]
+
+class @OBJECT_PREFIX@XenStoreSession
+{
+ [key, read]
+ string InstanceName;
+ [read] boolean Active;
+
+ [WmiDataId(1), read]
+ uint32 SessionId;
+ [WmiDataId(2),read]
+ string Id;
+
+ [Implemented, WmiMethodId(1), Description("Get Value")]
+ void GetValue([In, IDQualifier(0)]string Pathname, [Out, IDQualifier(1)]string value);
+
+ [Implemented, WmiMethodId(2), Description("Get Children")]
+ void GetChildren([In, IDQualifier(0)]string Pathname, [Out, IDQualifier(1)]@OBJECT_PREFIX@XenStoreNodes children);
+
+ [Implemented, WmiMethodId(3), Description("Set Value")]
+ void SetValue([In, IDQualifier(0)]string Pathname, [In, IDQualifier(1)]string value);
+
+ [Implemented, WmiMethodId(4), Description("End Session")]
+ void EndSession();
+
+ [Implemented, WmiMethodId(5), Description("Set Watch")]
+ void SetWatch([In, IDQualifier(0)]string Pathname);
+
+ [Implemented, WmiMethodId(6), Description("Remove Watch")]
+ void RemoveWatch([In, IDQualifier(0)]string Pathname);
+
+ [Implemented, WmiMethodId(7), Description("Remove Value")]
+ void RemoveValue([In, IDQualifier(0)]string Pathname);
+
+ [Implemented, WmiMethodId(8), Description("Log")]
+ void Log([In, IDQualifier(0)]string Message);
+
+ [Implemented, WmiMethodId(9), Description("Start Transaction")]
+ void StartTransaction();
+
+ [Implemented, WmiMethodId(10), Description("Commit Transaction")]
+ void CommitTransaction();
+
+ [Implemented, WmiMethodId(11), Description("Abort Transaction")]
+ void AbortTransaction();
+
+ [Implemented, WmiMethodId(12), Description("Get First Child")]
+ void GetFirstChild([In, IDQualifier(0)]string InPath, [Out, IDQualifier(1)]string OutPath);
+
+ [Implemented, WmiMethodId(13), Description("Get Next Sibling")]
+ void GetNextSibling([In, IDQualifier(0)]string InPath, [Out, IDQualifier(1)]string OutPath);
+};
+[WMI, Dynamic, Provider("WMIProv"),
+ guid("{8C436757-56BA-4273-9E58-CA4E689260E5}"),
+ locale("MS\\0x409"),
+ WmiExpense(1),
+ Description("Event notifying XenStore")]
+class @OBJECT_PREFIX@XenStoreWatchEvent : WMIEvent
+{
+ [key, read]
+ string InstanceName;
+
+ [read]
+ boolean Active;
+
+ [read,
+ Description("Triggered Event Id"),
+ WmiDataId(1)] string EventId;
+};
+
+[Dynamic, Provider("WMIProv"),
+ WMI,
+ Description("Base XenStore Object"),
+ guid("{AB8136BF-8EA7-420D-ADAD-89C83E587925}"),
+ locale("MS\\0x409")]
+class @OBJECT_PREFIX@XenStoreBase {
+ [key, read]
+ string InstanceName;
+
+ [read]
+ boolean Active;
+
+
+ [read,
+ Description("Time provided by Xen hypervisor"),
+ WmiDataId(1)] uint64 XenTime;
+
+ [Implemented, WmiMethodId(1), Description("Add new session")]
+ void AddSession([In, IDQualifier(0)]string Id, [Out, IDQualifier(2)]uint32 SessionId);
+
+};
+
+[WMI, Dynamic, Provider("WMIProv"),
+ guid("{6456AAFA-4D71-497C-A34E-26AA995B14A4}"),
+ locale("MS\\0x409"),
+ WmiExpense(1),
+ Description("Event notifying the VM has unsuspended")]
+class @OBJECT_PREFIX@XenStoreUnsuspendedEvent : WMIEvent
+{
+ [key, read]
+ string InstanceName;
+
+ [read]
+ boolean Active;
+};
#include "..\..\include\suspend_interface.h"
#include "log.h"
#include "xeniface_ioctls.h"
+#include <version.h>
__drv_raisesIRQL(APC_LEVEL)
__drv_savesIRQLGlobal(OldIrql, fdoData->SessionLock)
if (fdoData->WmiReady) {
XenIfaceDebugPrint(TRACE,"Fire Suspend Event\n");
WmiFireEvent(fdoData->Dx->DeviceObject,
- (LPGUID)&CitrixXenStoreUnsuspendedEvent_GUID,
- 0,
- 0,
- NULL);
+ (LPGUID)&OBJECT_GUID(XenStoreUnsuspendedEvent),
+ 0,
+ 0,
+ NULL);
}
}
void FireWatch(XenStoreWatch* watch) {
if (eventdata !=NULL) {
XenIfaceDebugPrint(TRACE,"Fire Watch Event\n");
WmiFireEvent(watch->fdoData->Dx->DeviceObject,
- (LPGUID)&CitrixXenStoreWatchEvent_GUID,
- 0,
- RequiredSize,
- eventdata);
+ (LPGUID)&OBJECT_GUID(XenStoreWatchEvent),
+ 0,
+ RequiredSize,
+ eventdata);
}
}
OUT ULONG_PTR *byteswritten
)
{
- if (IsEqualGUID(stack->Parameters.WMI.DataPath, &CitrixXenStoreBase_GUID)) {
+ if (IsEqualGUID(stack->Parameters.WMI.DataPath,
+ &OBJECT_GUID(XenStoreBase))) {
return BaseExecuteMethod(stack->Parameters.WMI.Buffer,
stack->Parameters.WMI.BufferSize,
fdoData, byteswritten);
}
- else if (IsEqualGUID(stack->Parameters.WMI.DataPath, &CitrixXenStoreSession_GUID)) {
+ else if (IsEqualGUID(stack->Parameters.WMI.DataPath,
+ &OBJECT_GUID(XenStoreSession))) {
return SessionExecuteMethod(stack->Parameters.WMI.Buffer,
stack->Parameters.WMI.BufferSize,
fdoData, byteswritten);
{
if (IsEqualGUID(stack->Parameters.WMI.DataPath,
- &CitrixXenStoreBase_GUID)) {
+ &OBJECT_GUID(XenStoreBase))) {
return GenerateBaseBlock( fdoData,
stack->Parameters.WMI.Buffer,
stack->Parameters.WMI.BufferSize,
byteswritten);
}
else if (IsEqualGUID(stack->Parameters.WMI.DataPath,
- &CitrixXenStoreSession_GUID)) {
+ &OBJECT_GUID(XenStoreSession))) {
return GenerateSessionBlock(stack->Parameters.WMI.Buffer,
stack->Parameters.WMI.BufferSize,
fdoData,
OUT ULONG_PTR *byteswritten
)
{
- if (IsEqualGUID(stack->Parameters.WMI.DataPath, &CitrixXenStoreBase_GUID)) {
+ if (IsEqualGUID(stack->Parameters.WMI.DataPath,
+ &OBJECT_GUID(XenStoreBase))) {
return GenerateBaseInstance(fdoData,
stack->Parameters.WMI.Buffer,
stack->Parameters.WMI.BufferSize,
byteswritten);
}
- else if (IsEqualGUID(stack->Parameters.WMI.DataPath, &CitrixXenStoreSession_GUID)) {
+ else if (IsEqualGUID(stack->Parameters.WMI.DataPath,
+ &OBJECT_GUID(XenStoreSession))) {
return GenerateSessionInstance(stack->Parameters.WMI.Buffer,
stack->Parameters.WMI.BufferSize,
fdoData,
guid = ®info->WmiRegGuid[0];
guid->InstanceCount = 1;
- guid->Guid = CitrixXenStoreBase_GUID;
+ guid->Guid = OBJECT_GUID(XenStoreBase);
guid->Flags = WMIREG_FLAG_INSTANCE_PDO;
guid->Pdo = (ULONG_PTR)fdoData->PhysicalDeviceObject;
ObReferenceObject(fdoData->PhysicalDeviceObject);
guid = ®info->WmiRegGuid[1];
- guid->Guid = CitrixXenStoreSession_GUID;
+ guid->Guid = OBJECT_GUID(XenStoreSession);
guid->Flags =0;
guid = ®info->WmiRegGuid[2];
guid->InstanceCount = 1;
- guid->Guid = CitrixXenStoreWatchEvent_GUID;
+ guid->Guid = OBJECT_GUID(XenStoreWatchEvent);
guid->Flags = WMIREG_FLAG_INSTANCE_PDO |
WMIREG_FLAG_EVENT_ONLY_GUID ;
guid->Pdo = (ULONG_PTR)fdoData->PhysicalDeviceObject;
guid = ®info->WmiRegGuid[3];
guid->InstanceCount = 1;
- guid->Guid = CitrixXenStoreUnsuspendedEvent_GUID;
+ guid->Guid = OBJECT_GUID(XenStoreUnsuspendedEvent);
guid->Flags = WMIREG_FLAG_INSTANCE_PDO |
WMIREG_FLAG_EVENT_ONLY_GUID ;
guid->Pdo = (ULONG_PTR)fdoData->PhysicalDeviceObject;
+++ /dev/null
-[Dynamic, Provider("WMIProv"),
- WMI,
- Description("Xenstore Node"),
- guid("{1D80EB99-A1D6-4492-B62F-8B4549FF0B5E}"),
- locale("MS\\0x409")]
-class CitrixXenStoreNodes
-{
- [key, read]
- string InstanceName;
- [read] boolean Active;
-
- [WmiDataId(1),
- read,
- Description("Number of child nodes")]
- uint32 NoOfChildNodes;
-
- [WmiDataId(2),
- read,
- WmiSizeIs("NoOfChildNodes"),
- Description("Child Nodes")]
- string ChildNodes[];
-
-};
-
-[Dynamic, Provider("WMIProv"),
- WMI,
- Description("Xenstore Session"),
- guid("{12138A69-97B2-49DD-B9DE-54749AABC789}"),
- locale("MS\\0x409")]
-
-class CitrixXenStoreSession
-{
- [key, read]
- string InstanceName;
- [read] boolean Active;
-
- [WmiDataId(1), read]
- uint32 SessionId;
- [WmiDataId(2),read]
- string Id;
-
- [Implemented, WmiMethodId(1), Description("Get Value")]
- void GetValue([In, IDQualifier(0)]string Pathname, [Out, IDQualifier(1)]string value);
-
- [Implemented, WmiMethodId(2), Description("Get Children")]
- void GetChildren([In, IDQualifier(0)]string Pathname, [Out, IDQualifier(1)]CitrixXenStoreNodes children);
-
- [Implemented, WmiMethodId(3), Description("Set Value")]
- void SetValue([In, IDQualifier(0)]string Pathname, [In, IDQualifier(1)]string value);
-
- [Implemented, WmiMethodId(4), Description("End Session")]
- void EndSession();
-
- [Implemented, WmiMethodId(5), Description("Set Watch")]
- void SetWatch([In, IDQualifier(0)]string Pathname);
-
- [Implemented, WmiMethodId(6), Description("Remove Watch")]
- void RemoveWatch([In, IDQualifier(0)]string Pathname);
-
- [Implemented, WmiMethodId(7), Description("Remove Value")]
- void RemoveValue([In, IDQualifier(0)]string Pathname);
-
- [Implemented, WmiMethodId(8), Description("Log")]
- void Log([In, IDQualifier(0)]string Message);
-
- [Implemented, WmiMethodId(9), Description("Start Transaction")]
- void StartTransaction();
-
- [Implemented, WmiMethodId(10), Description("Commit Transaction")]
- void CommitTransaction();
-
- [Implemented, WmiMethodId(11), Description("Abort Transaction")]
- void AbortTransaction();
-
- [Implemented, WmiMethodId(12), Description("Get First Child")]
- void GetFirstChild([In, IDQualifier(0)]string InPath, [Out, IDQualifier(1)]string OutPath);
-
- [Implemented, WmiMethodId(13), Description("Get Next Sibling")]
- void GetNextSibling([In, IDQualifier(0)]string InPath, [Out, IDQualifier(1)]string OutPath);
-};
-[WMI, Dynamic, Provider("WMIProv"),
- guid("{8C436757-56BA-4273-9E58-CA4E689260E5}"),
- locale("MS\\0x409"),
- WmiExpense(1),
- Description("Event notifying XenStore")]
-class CitrixXenStoreWatchEvent : WMIEvent
-{
- [key, read]
- string InstanceName;
-
- [read]
- boolean Active;
-
- [read,
- Description("Triggered Event Id"),
- WmiDataId(1)] string EventId;
-};
-
-[Dynamic, Provider("WMIProv"),
- WMI,
- Description("Base Citrix XenStore Object"),
- guid("{AB8136BF-8EA7-420D-ADAD-89C83E587925}"),
- locale("MS\\0x409")]
-class CitrixXenStoreBase {
- [key, read]
- string InstanceName;
-
- [read]
- boolean Active;
-
-
- [read,
- Description("Time provided by Xen hypervisor"),
- WmiDataId(1)] uint64 XenTime;
-
- [Implemented, WmiMethodId(1), Description("Add new session")]
- void AddSession([In, IDQualifier(0)]string Id, [Out, IDQualifier(2)]uint32 SessionId);
-
-};
-
-[WMI, Dynamic, Provider("WMIProv"),
- guid("{6456AAFA-4D71-497C-A34E-26AA995B14A4}"),
- locale("MS\\0x409"),
- WmiExpense(1),
- Description("Event notifying the VM has unsuspended")]
-class CitrixXenStoreUnsuspendedEvent : WMIEvent
-{
- [key, read]
- string InstanceName;
-
- [read]
- boolean Active;
-};
#undef VER_PRODUCTVERSION
#undef VER_PRODUCTVERSION_STR
-#define VER_COMPANYNAME_STR "Citrix Systems Inc."
-#define VER_LEGALCOPYRIGHT_STR "Copyright " YEAR_STR VER_COMPANYNAME_STR
+#include <version.h>
-#include "..\..\include\version.h"
+#define VER_COMPANYNAME_STR COMPANY_NAME_STR
+#define VER_LEGALCOPYRIGHT_STR "Copyright (c) Citrix Systems Inc."
#define VER_PRODUCTNAME_STR "XENIFACE"
#define VER_PRODUCTVERSION MAJOR_VERSION,MINOR_VERSION,MICRO_VERSION,BUILD_NUMBER
+++ /dev/null
-rem testwmi.vbs
-
-rem Copyright (c) Citrix Systems Inc.
-rem All rights reserved.
-rem
-rem Redistribution and use in source and binary forms,
-rem with or without modification, are permitted provided
-rem that the following conditions are met:
-rem
-rem * Redistributions of source code must retain the above
-rem copyright notice, this list of conditions and the
-rem following disclaimer.
-rem * Redistributions in binary form must reproduce the above
-rem copyright notice, this list of conditions and the
-rem following disclaimer in the documentation and/or other
-rem materials provided with the distribution.
-rem
-rem THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
-rem CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
-rem INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-rem MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-rem DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
-rem CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-rem SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-rem BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-rem SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-rem INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-rem WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-rem NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-rem OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-rem SUCH DAMAGE.
-
-rem a sanity check for the xeniface wmi interface
-rem can be called using cscript.exe
-rem will set %ERRORLEVEL% to 0 on success and 1 on failure
-rem will also output the text 'SUCCESS' or an error message
-
-Set objWMIService = GetObject("winmgmts:\\.\root\wmi")
-Set base = objWmiService.InstancesOf("CitrixXenStoreBase")
-Dim answer
-Dim answer2
-Dim objItem
-
-
-rem Locate the base object
-
-if (base.Count) <> 1 then
- wscript.echo("Too many base objects found")
- wscript.quit(1)
-end if
-for each itementry in base
- rem is there a more trivial way of getting the only item from a collection in vbscript?
- set objItem = itementry
-next
-
-rem Add two sessions
-
-objitem.AddSession "VBSTestSession", answer
-objitem.AddSession "AnotherVBSTestSession", answer2
-
-rem locate the first session
-
-query = "select * from CitrixXenStoreSession where SessionId = '" & answer & "'"
-Set sessions = objWMIService.ExecQuery(query)
-if (sessions.count) <> 1 then
- wscript.echo("Too many session-1 sessions found")
- wscript.quit(1)
-end if
-for each itementry in sessions
- rem is there a more trivial way of getting the only item from a collection in vbscript?
- set session = itementry
-next
-
-rem locate te second session
-
-query = "select * from CitrixXenStoreSession where SessionId = '" & answer2 & "'"
-Set sessions2 = objWMIService.ExecQuery(query)
-if (sessions2.count) <> 1 then
- wscript.echo("Too many session-2 sessions found")
- wscript.quit(1)
-end if
-dim session2
-for each ses in sessions2
- Set session2=ses
-next
-
-rem ensure we located the expected session
-
-if session.Id <> "VBSTestSession" then
- wscript.echo("incorrect session found")
- wscript.quit(1)
-end if
-
-rem blank a set of xenstore entries
-
-session.removevalue "data/wmitestrun"
-
-rem and put a known set of values there
-
-session.SetValue "data/wmitestrun/test1", "Testing"
-session.SetValue "data/wmitestrun/test2", "123 Testing"
-session.SetValue "data/wmitestrun/test3", "456 Testing"
-session.SetValue "data/wmitestrun/test4", "789 Testing"
-
-rem read back a value from xenstore, and check that it is right
-
-session.getvalue "data/wmitestrun/test1", res
-if res <> "Testing" then
- wscript.echo("failed writing or reading to data/wmitestrun/test1")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-
-rem read back a different value from xenstore, and check that it is right
-
-session.getvalue "data/wmitestrun/test2", res
-if res <> "123 Testing" then
- wscript.echo("failed writing or reading to data/wmitestrun/test2")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-
-rem transactions
-rem test that aborted transactions don't do anything
-
-session.starttransaction()
-session.SetValue "data/wmitestrun/test1", "WEIRD"
-session.getvalue "data/wmitestrun/test1", res
-if res <> "WEIRD" then
- wscript.echo("failed writing or reading within transaction to data/wmitestrun/test1")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-session.aborttransaction()
-
-session.getvalue "data/wmitestrun/test1", res
-if res <> "Testing" then
- wscript.echo("failed reading to data/wmitestrun/test1 after aborted transaction ")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-
-
-rem test that 2 overlapping transactions honour commits and aborts, and raise errors when needed
-
-session.starttransaction()
-session2.starttransaction()
-session.SetValue "data/wmitestrun/test1", "WEIRD"
-session2.SetValue "data/wmitestrun/test1", "Fish"
-session.getvalue "data/wmitestrun/test1", res
-session2.getvalue "data/wmitestrun/test1", res2
-if res <> "WEIRD" then
- wscript.echo("failed writing or reading within transaction to data/wmitestrun/test1 session 1")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-if res2 <> "Fish" then
- wscript.echo("failed writing or reading within transaction to data/wmitestrun/test1 session 2")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-
-on error resume next
-session.committransaction()
-Err.clear()
-if Err.Number <> 0 then
- wscript.echo("Could not commit first transaction")
- wscript.quit(1)
-end if
-session2.committransaction()
-if Err.Number = 0 then
- wscript.echo("Both transactions comitted")
- wscript.quit(1)
-end if
-session2.aborttransaction()
-session2.getvalue "data/wmitestrun/test1", res2
-if res2 <> "WEIRD" then
- wscript.echo("failed commiting the correct transaction")
- wscript.echo("read = " & res)
- wscript.quit(1)
-end if
-
-rem events
-rem set up an event sink
-
-dim refsink
-set refsink = CreateObject("WBemScripting.SWbemSink")
-wscript.ConnectObject refsink, "EVENTSINK_"
-stq = "Select * from CitrixXenStoreWatchEvent"
-objwmiservice.ExecNotificationQueryAsync refsink, stq
-
-evtcount = 0
-
-rem watch a xenstore entry
-
-allevents=0
-session.setwatch "data/wmitestrun/test1"
-session.setvalue "data/wmitestrun/test1","MAGIC"
-session.removevalue "data/wmitestrun/test1"
-session.setvalue "data/wmitestrun/test1","GOLD"
-wscript.sleep(5000)
-session.removewatch "data/wmitestrun/test1"
-
-rem check we received an event. Also, since events can be coalesced, check
-rem that when we receive our final event, the value we read from test1 is the
-rem final value we set it to
-
-rem (note the actual work of counting and checking events is done in the
-rem EVENTSINK_OnObjectready sub below)
-
-if evtcount <= 4 and allevents <> 1 then
- wscript.echo("Failed to catch all the expected events")
- wscript.quit(1)
-end if
-
-session.removevalue "data/wmitestrun/test1"
-
-rem check that we can read the list of children an entry has
-
-strComputer = "."
-Set objWMIService = GetObject("winmgmts:" _
- & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2")
-
-Set colOperatingSystems = objWMIService.ExecQuery _
- ("Select * from Win32_OperatingSystem")
-
-for each os in colOperatingSystems
- rem is there a more trivial way of getting the only item from a collection in vbscript?
- set myos = os
-next
-
-wscript.echo(myos.Version)
-
-if Mid(myos.Version, 1 , 3) <> "6.0" then
-
- dim children
- session.getchildren "data/wmitestrun", children
-
- if children.noofchildnodes <> 3 then
- wscript.echo("Failed to find all the expected child nodes")
- wscript.quit(1)
- end if
-end if
-
-session.getfirstchild "data/wmitestrun", res
-session.getnextsibling res, res
-
-rem end both sessions that we created.
-
-session2.EndSession()
-session.EndSession()
-
-Wscript.echo("Success")
-
-Sub EVENTSINK_OnObjectReady(re, rc)
- evtcount = evtcount + 1
- session.getvalue "data/wmitestrun/test1", res
- if res = "GOLD" then
- allevents = 1
- else
- allevents = 0
- end if
-end sub
projects / people / pauldu / xeniface.git / commitdiff