mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-31 18:33:11 +00:00
87f2bd3c0c
Currently named as hypervObjecUnified to keep code
compilable/functional until all bits are in place.
This struct is a result of unserializing WMI request response.
Therefore, it needs to be able to deal with different "versions" of the
same WMI class. To accomplish this, the "data" member was turned in to
a union which:
* has a "common" member that contains only WMI class fields that are
safe to access and are present in all "versions". This is ensured by
the code generator that takes care of proper struct memory alignment
between "common", "v1", "v2" etc members. This memeber is to be used
by the driver code wherever the API implementation can be shared for
all supported hyper-v versions.
* the "v1" and "v2" member can be used by the driver code to handle
version specific cases.
Example:
Msvm_ComputerSystem *vm = NULL;
...
hypervGetVirtualMachineList(priv, wqlQuery, *vm);
...
/* safe for "v1" and "v2" */
char *vmName = vm->data.common->Name;
/* or if one really needs special handling for "v2" */
if (priv->wmiVersion == HYPERV_WMI_VERSION_V2) {
char *foo = vm->data.v2->SomeV2OnlyField;
}
In other words, driver should not concern itself with existence of "v1"
or "v2" of WMI class unless absolutely necessary.
139 lines
4.5 KiB
C
139 lines
4.5 KiB
C
/*
|
|
* hyperv_wmi.h: general WMI over WSMAN related functions and structures for
|
|
* managing Microsoft Hyper-V hosts
|
|
*
|
|
* Copyright (C) 2011 Matthias Bolte <matthias.bolte@googlemail.com>
|
|
* Copyright (C) 2009 Michael Sievers <msievers83@googlemail.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see
|
|
* <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef __HYPERV_WMI_H__
|
|
# define __HYPERV_WMI_H__
|
|
|
|
# include "virbuffer.h"
|
|
# include "hyperv_private.h"
|
|
# include "hyperv_wmi_classes.h"
|
|
# include "openwsman.h"
|
|
|
|
|
|
|
|
typedef struct _hypervObject hypervObject;
|
|
|
|
int hypervVerifyResponse(WsManClient *client, WsXmlDocH response,
|
|
const char *detail);
|
|
|
|
|
|
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Object
|
|
*/
|
|
typedef struct _hypervObjectUnified hypervObjectUnified;
|
|
struct _hypervObjectUnified {
|
|
/* Unserialized data from wsman response. The member called "common" has
|
|
* properties that are the same type and name for all "versions" of given
|
|
* WMI class. This means that calling code does not have to make any
|
|
* conditional checks based on which version was returned as long as it
|
|
* only needs to read common values. The alignment of structs is ensured
|
|
* by the generator.
|
|
*/
|
|
union {
|
|
XML_TYPE_PTR common;
|
|
XML_TYPE_PTR v1;
|
|
XML_TYPE_PTR v2;
|
|
} data;
|
|
/* The info used to make wsman request */
|
|
hypervWmiClassInfoPtr info;
|
|
hypervObjectUnified *next;
|
|
};
|
|
|
|
struct _hypervObject {
|
|
XmlSerializerInfo *serializerInfo;
|
|
XML_TYPE_PTR data;
|
|
hypervObject *next;
|
|
};
|
|
|
|
int hypervEnumAndPull(hypervPrivate *priv, virBufferPtr query,
|
|
const char *root, XmlSerializerInfo *serializerInfo,
|
|
const char *resourceUri, const char *className,
|
|
hypervObject **list);
|
|
|
|
void hypervFreeObject(hypervPrivate *priv, hypervObject *object);
|
|
|
|
|
|
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* CIM/Msvm_ReturnCode
|
|
*/
|
|
|
|
enum _CIM_ReturnCode {
|
|
CIM_RETURNCODE_COMPLETED_WITH_NO_ERROR = 0,
|
|
CIM_RETURNCODE_NOT_SUPPORTED = 1,
|
|
CIM_RETURNCODE_UNKNOWN_ERROR = 2,
|
|
CIM_RETURNCODE_CANNOT_COMPLETE_WITHIN_TIMEOUT_PERIOD = 3,
|
|
CIM_RETURNCODE_FAILED = 4,
|
|
CIM_RETURNCODE_INVALID_PARAMETER = 5,
|
|
CIM_RETURNCODE_IN_USE = 6,
|
|
CIM_RETURNCODE_TRANSITION_STARTED = 4096,
|
|
CIM_RETURNCODE_INVALID_STATE_TRANSITION = 4097,
|
|
CIM_RETURNCODE_TIMEOUT_PARAMETER_NOT_SUPPORTED = 4098,
|
|
CIM_RETURNCODE_BUSY = 4099,
|
|
};
|
|
|
|
enum _Msvm_ReturnCode {
|
|
MSVM_RETURNCODE_FAILED = 32768,
|
|
MSVM_RETURNCODE_ACCESS_DENIED = 32769,
|
|
MSVM_RETURNCODE_NOT_SUPPORTED = 32770,
|
|
MSVM_RETURNCODE_STATUS_IS_UNKNOWN = 32771,
|
|
MSVM_RETURNCODE_TIMEOUT = 32772,
|
|
MSVM_RETURNCODE_INVALID_PARAMETER = 32773,
|
|
MSVM_RETURNCODE_SYSTEM_IS_IN_USE = 32774,
|
|
MSVM_RETURNCODE_INVALID_STATE_FOR_THIS_OPERATION = 32775,
|
|
MSVM_RETURNCODE_INCORRECT_DATA_TYPE = 32776,
|
|
MSVM_RETURNCODE_SYSTEM_IS_NOT_AVAILABLE = 32777,
|
|
MSVM_RETURNCODE_OUT_OF_MEMORY = 32778,
|
|
};
|
|
|
|
const char *hypervReturnCodeToString(int returnCode);
|
|
|
|
|
|
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Msvm_ComputerSystem
|
|
*/
|
|
|
|
int hypervInvokeMsvmComputerSystemRequestStateChange(virDomainPtr domain,
|
|
int requestedState);
|
|
|
|
int hypervMsvmComputerSystemEnabledStateToDomainState
|
|
(Msvm_ComputerSystem *computerSystem);
|
|
|
|
bool hypervIsMsvmComputerSystemActive(Msvm_ComputerSystem *computerSystem,
|
|
bool *in_transition);
|
|
|
|
int hypervMsvmComputerSystemToDomain(virConnectPtr conn,
|
|
Msvm_ComputerSystem *computerSystem,
|
|
virDomainPtr *domain);
|
|
|
|
int hypervMsvmComputerSystemFromDomain(virDomainPtr domain,
|
|
Msvm_ComputerSystem **computerSystem);
|
|
|
|
|
|
|
|
# include "hyperv_wmi.generated.h"
|
|
|
|
#endif /* __HYPERV_WMI_H__ */
|