2012-07-31 18:56:07 +00:00
|
|
|
/*
|
2015-06-10 07:50:00 +00:00
|
|
|
* vz_utils.h: core driver functions for managing
|
2012-07-31 18:56:07 +00:00
|
|
|
* Parallels Cloud Server hosts
|
|
|
|
*
|
|
|
|
* Copyright (C) 2012 Parallels, Inc.
|
|
|
|
*
|
|
|
|
* 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 PARALLELS_UTILS_H
|
|
|
|
# define PARALLELS_UTILS_H
|
|
|
|
|
2014-09-11 16:24:03 +00:00
|
|
|
# include <Parallels.h>
|
|
|
|
|
2012-08-01 03:46:22 +00:00
|
|
|
# include "driver.h"
|
|
|
|
# include "conf/domain_conf.h"
|
2016-05-02 09:33:07 +00:00
|
|
|
# include "conf/snapshot_conf.h"
|
2015-07-17 09:11:23 +00:00
|
|
|
# include "conf/virdomainobjlist.h"
|
2012-08-01 03:46:22 +00:00
|
|
|
# include "conf/domain_event.h"
|
2012-12-13 15:49:48 +00:00
|
|
|
# include "virthread.h"
|
2016-02-17 12:15:03 +00:00
|
|
|
# include "datatypes.h"
|
2012-08-01 03:46:22 +00:00
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
# define vzParseError() \
|
2012-12-11 10:59:44 +00:00
|
|
|
virReportErrorHelper(VIR_FROM_TEST, VIR_ERR_OPERATION_FAILED, __FILE__, \
|
2015-06-25 07:56:56 +00:00
|
|
|
__FUNCTION__, __LINE__, _("Can't parse prlctl output"))
|
2012-12-11 10:59:44 +00:00
|
|
|
|
2015-04-22 19:49:00 +00:00
|
|
|
# define IS_CT(def) (def->os.type == VIR_DOMAIN_OSTYPE_EXE)
|
2014-12-01 15:38:47 +00:00
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
# define vzDomNotFoundError(domain) \
|
2014-12-01 15:38:49 +00:00
|
|
|
do { \
|
|
|
|
char uuidstr[VIR_UUID_STRING_BUFLEN]; \
|
|
|
|
virUUIDFormat(domain->uuid, uuidstr); \
|
|
|
|
virReportError(VIR_ERR_NO_DOMAIN, \
|
|
|
|
_("no domain with matching uuid '%s'"), uuidstr); \
|
|
|
|
} while (0)
|
|
|
|
|
2016-09-05 16:39:32 +00:00
|
|
|
# define PARALLELS_DOMAIN_ROUTED_NETWORK_NAME "host-routed"
|
2016-03-15 07:47:47 +00:00
|
|
|
# define VIRTUOZZO_VER_7 ((unsigned long) 7000000)
|
|
|
|
|
|
|
|
struct _vzCapabilities {
|
|
|
|
virStorageFileFormat vmDiskFormat;
|
|
|
|
virStorageFileFormat ctDiskFormat;
|
|
|
|
virDomainDiskBus *diskBuses;
|
2016-03-15 07:47:50 +00:00
|
|
|
virDomainControllerType *controllerTypes;
|
|
|
|
virDomainControllerModelSCSI scsiControllerModel;
|
2016-03-15 07:47:47 +00:00
|
|
|
};
|
|
|
|
typedef struct _vzCapabilities vzCapabilities;
|
|
|
|
typedef struct _vzCapabilities *vzCapabilitiesPtr;
|
2015-03-18 08:33:51 +00:00
|
|
|
|
2016-05-18 08:11:08 +00:00
|
|
|
/* +2 to keep enclosing { and } */
|
|
|
|
# define VIR_UUID_STRING_BRACED_BUFLEN (VIR_UUID_STRING_BUFLEN + 2)
|
|
|
|
|
2016-03-28 19:11:30 +00:00
|
|
|
struct _vzDriver {
|
|
|
|
virObjectLockable parent;
|
2015-04-22 16:07:06 +00:00
|
|
|
|
|
|
|
/* Immutable pointer, self-locking APIs */
|
2013-01-11 16:04:47 +00:00
|
|
|
virDomainObjListPtr domains;
|
2016-05-18 08:11:04 +00:00
|
|
|
unsigned char session_uuid[VIR_UUID_BUFLEN];
|
2014-09-11 16:24:03 +00:00
|
|
|
PRL_HANDLE server;
|
2012-08-01 03:46:22 +00:00
|
|
|
virCapsPtr caps;
|
2013-03-31 18:03:42 +00:00
|
|
|
virDomainXMLOptionPtr xmlopt;
|
2013-11-21 10:43:10 +00:00
|
|
|
virObjectEventStatePtr domainEventState;
|
2016-04-07 18:52:43 +00:00
|
|
|
virSysinfoDefPtr hostsysinfo;
|
2016-03-15 07:47:46 +00:00
|
|
|
unsigned long vzVersion;
|
2016-03-15 07:47:47 +00:00
|
|
|
vzCapabilities vzCaps;
|
2012-08-01 03:46:22 +00:00
|
|
|
};
|
|
|
|
|
2016-03-28 19:11:30 +00:00
|
|
|
typedef struct _vzDriver vzDriver;
|
|
|
|
typedef struct _vzDriver *vzDriverPtr;
|
|
|
|
|
|
|
|
struct _vzConn {
|
|
|
|
struct _vzConn* next;
|
|
|
|
|
|
|
|
vzDriverPtr driver;
|
|
|
|
/* Immutable pointer, self-locking APIs */
|
|
|
|
virConnectCloseCallbackDataPtr closeCallback;
|
|
|
|
};
|
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
typedef struct _vzConn vzConn;
|
|
|
|
typedef struct _vzConn *vzConnPtr;
|
2012-08-01 03:46:22 +00:00
|
|
|
|
2016-06-20 10:08:14 +00:00
|
|
|
struct _vzDomainJobObj {
|
|
|
|
virCond cond;
|
|
|
|
bool active;
|
|
|
|
/* when the job started, zeroed on time discontinuities */
|
|
|
|
unsigned long long started;
|
|
|
|
unsigned long long elapsed;
|
|
|
|
bool hasProgress;
|
|
|
|
int progress; /* percents */
|
2017-01-31 07:44:12 +00:00
|
|
|
PRL_HANDLE sdkJob;
|
|
|
|
bool cancelled;
|
2016-06-20 10:08:14 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct _vzDomainJobObj vzDomainJobObj;
|
|
|
|
typedef struct _vzDomainJobObj *vzDomainJobObjPtr;
|
2016-03-28 19:11:30 +00:00
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
struct vzDomObj {
|
2012-08-01 03:46:22 +00:00
|
|
|
int id;
|
2014-12-01 15:38:48 +00:00
|
|
|
PRL_HANDLE sdkdom;
|
2016-06-03 07:11:44 +00:00
|
|
|
PRL_HANDLE stats;
|
2016-06-20 10:08:14 +00:00
|
|
|
vzDomainJobObj job;
|
2012-08-01 03:46:22 +00:00
|
|
|
};
|
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
typedef struct vzDomObj *vzDomObjPtr;
|
2012-08-01 03:46:22 +00:00
|
|
|
|
2016-06-14 08:45:56 +00:00
|
|
|
void* vzDomObjAlloc(void);
|
|
|
|
void vzDomObjFree(void *p);
|
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
virDomainObjPtr vzDomObjFromDomain(virDomainPtr domain);
|
|
|
|
virDomainObjPtr vzDomObjFromDomainRef(virDomainPtr domain);
|
2015-04-22 16:10:50 +00:00
|
|
|
|
2015-06-10 07:50:00 +00:00
|
|
|
char * vzGetOutput(const char *binary, ...)
|
2012-07-31 18:56:07 +00:00
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_SENTINEL;
|
2016-03-28 19:11:30 +00:00
|
|
|
|
|
|
|
vzDriverPtr
|
|
|
|
vzGetDriverConnection(void);
|
|
|
|
|
|
|
|
void
|
|
|
|
vzDestroyDriverConnection(void);
|
|
|
|
|
2016-03-15 07:47:46 +00:00
|
|
|
int
|
2016-03-28 19:11:30 +00:00
|
|
|
vzInitVersion(vzDriverPtr driver);
|
2016-03-15 07:47:48 +00:00
|
|
|
int
|
2016-04-20 14:05:32 +00:00
|
|
|
vzCheckUnsupportedDisk(const virDomainDef *def,
|
|
|
|
virDomainDiskDefPtr disk,
|
|
|
|
vzCapabilitiesPtr vzCaps);
|
2016-03-15 07:47:50 +00:00
|
|
|
int
|
2016-08-18 11:43:09 +00:00
|
|
|
vzCheckUnsupportedControllers(const virDomainDef *def,
|
2016-03-15 07:47:50 +00:00
|
|
|
vzCapabilitiesPtr vzCaps);
|
2016-03-15 07:47:51 +00:00
|
|
|
int
|
2016-03-28 19:11:30 +00:00
|
|
|
vzGetDefaultSCSIModel(vzDriverPtr driver,
|
2016-03-15 07:47:51 +00:00
|
|
|
PRL_CLUSTERED_DEVICE_SUBTYPE *scsiModel);
|
2012-07-31 18:56:07 +00:00
|
|
|
|
2016-04-20 14:05:42 +00:00
|
|
|
int vzCheckUnsupportedGraphics(virDomainGraphicsDefPtr gr);
|
|
|
|
|
2015-06-25 07:56:56 +00:00
|
|
|
# define PARALLELS_BLOCK_STATS_FOREACH(OP) \
|
|
|
|
OP(rd_req, VIR_DOMAIN_BLOCK_STATS_READ_REQ, "read_requests") \
|
|
|
|
OP(rd_bytes, VIR_DOMAIN_BLOCK_STATS_READ_BYTES, "read_total") \
|
|
|
|
OP(wr_req, VIR_DOMAIN_BLOCK_STATS_WRITE_REQ, "write_requests") \
|
|
|
|
OP(wr_bytes, VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES, "write_total")
|
2015-06-09 07:35:53 +00:00
|
|
|
|
2012-07-31 18:56:07 +00:00
|
|
|
#endif
|
vz: make vz driver more responsive
Current vz driver implementation is not usable when it comes to
long runnig operations. Migration or saving a domain blocks all
other operations even query ones which are expecteted to be available.
This patch addresses this problem.
All vz driver API calls fall into next 3 groups:
1. only query domain cache (virDomainObj, vz cache statistic)
examples are vzDomainGetState, vzDomainGetXMLDesc etc.
2. use thread shared sdkdom object
examples are vzDomainSetMemoryFlags, vzDomainAttachDevice etc.
3. use no thread shared sdkdom object nor domain cache
examples are vzDomainSnapshotListNames, vzDomainSnapshotGetXMLDesc etc
API calls from group 1 don't need to be changed as they hold domain lock only
for short period of time. These calls [1] are easily distinguished. They query
domain object thru libvirt common code or query vz sdk statistics handle thru
vz sdk sync operations.
vzDomainInterfaceStats is the only exception. It uses sdkdom object to
convert interface name to its vz sdk stack index which could not be saved in
domain cache. Interface statistics is available thru this stack index as a key
rather than name. As a result we can have accidental 'not known interface'
errors on quering intrerface stats. The reason is that in the process of
updating domain configuration we drop all devices and then recreate them again
in sdkdom object and domain lock can be dropped meanwhile (to remove networks
for existing bridged interfaces and(or) (re)create new ones). We can fix this
by changing the way we support bridged interfaces or by reordering operations
and changing bridged networks beforehand. Anyway this is better than moving
this API call into 2 group and making it an exclusive job.
As to API calls from group 2, first thread shared sdkdom object needs to be
explained. vz sdk has only one handle for a given domain, thus threads need
exclusive access to operate on it. These calls are fixed to drop and reacquire
domain lock on any lengthy operations - namely waiting the result of async vz
sdk operation. As lock is dropped we need to take extra reference to domain
object if it is not taken already as domain object can be deleted from list
while lock is dropped. As this operations use thread shared sdkdom object, the
simplest way to make calls from group 2 be consistent to each other is to make
them mutually exclusive. This is done by taking/releasing job condition thru
calling correspondent job routine. This approach makes group 1 and group
2 calls consistent to each other too. Not all calls of group 2 change the
domain cache but those that do update it thru prlsdkUpdateDomain which holds
the lock thoughout the update.
API calls from group [2] are easily distinguished too. They use
beginEdit/commit to change domain configuration (vzDomainSetMemoryFlags) or/and
update domain cache from sdkdom at the end of operation (vzDomainSuspend).
There is a known issue however. Frankly speaking it was introduced by ealier
patch '[PATCH 6/9] vz: cleanup loading domain code' from a different series.
The patch significantly reduced amount of time when the driver lock is held when
creating domain from API call or as a result of domain added event from vz sdk.
The problem is these two paths race on using thread shared sdkdom as we don't
have libvirt domain object and can not lock on it. However this don't
invalidates the patch as we can't use the former approach of preadding domain
into the list as we need name at least and name is not given by event. Anyway
i'm against adding half baked object into the list. Eventually this race can be
fixed by extra measures. As to current situation races with different
configurations are unlikely and race when adding domain thru vz driver and
simultaneous event from vz sdk is not dangerous as configuration is the same.
The last group [3] is API calls that need only sdkdom object to make vz sdk
call and don't change thread shared sdkdom object or domain cache in any way.
For now these are mostly domain snapshot API calls. The changes are similar to
those of group 2 - they add extra reference and drop/reacquire the lock on waiting
vz async call result. One can simply take the immutable sdkdom object from the
cache and drop the lock for the rest of operations but the chosen approach
makes implementation of these API calls somewhat similar to those of from group
2 and thus a bit futureproof. As calls of group 3 don't need vz driver
domain/vz sdk cache in any way, they are consistent with respect to API calls from
groups 1 and 3.
There is another exception. Calls to make-snapshot/revert-to-snapshot/migrate
are moved to group 2. That is they are made mutually exclusive. The reason
is that libvirt API supports control/query only for one job per domain and
these are jobs that are likely to be queried/aborted.
Appendix.
[1] API calls that only query domain cache.
(marked [*] are included for a different reason)
.domainLookupByID = vzDomainLookupByID, /* 0.10.0 */
.domainLookupByUUID = vzDomainLookupByUUID, /* 0.10.0 */
.domainLookupByName = vzDomainLookupByName, /* 0.10.0 */
.domainGetOSType = vzDomainGetOSType, /* 0.10.0 */
.domainGetInfo = vzDomainGetInfo, /* 0.10.0 */
.domainGetState = vzDomainGetState, /* 0.10.0 */
.domainGetXMLDesc = vzDomainGetXMLDesc, /* 0.10.0 */
.domainIsPersistent = vzDomainIsPersistent, /* 0.10.0 */
.domainGetAutostart = vzDomainGetAutostart, /* 0.10.0 */
.domainGetVcpus = vzDomainGetVcpus, /* 1.2.6 */
.domainIsActive = vzDomainIsActive, /* 1.2.10 */
.domainIsUpdated = vzDomainIsUpdated, /* 1.2.21 */
.domainGetVcpusFlags = vzDomainGetVcpusFlags, /* 1.2.21 */
.domainGetMaxVcpus = vzDomainGetMaxVcpus, /* 1.2.21 */
.domainHasManagedSaveImage = vzDomainHasManagedSaveImage, /* 1.2.13 */
.domainGetMaxMemory = vzDomainGetMaxMemory, /* 1.2.15 */
.domainBlockStats = vzDomainBlockStats, /* 1.2.17 */
.domainBlockStatsFlags = vzDomainBlockStatsFlags, /* 1.2.17 */
.domainInterfaceStats = vzDomainInterfaceStats, /* 1.2.17 */ [*]
.domainMemoryStats = vzDomainMemoryStats, /* 1.2.17 */
.domainMigrateBegin3Params = vzDomainMigrateBegin3Params, /* 1.3.5 */
.domainMigrateConfirm3Params = vzDomainMigrateConfirm3Params, /* 1.3.5 */
[2] API calls that use thread shared sdkdom object
(marked [*] are included for a different reason)
.domainSuspend = vzDomainSuspend, /* 0.10.0 */
.domainResume = vzDomainResume, /* 0.10.0 */
.domainDestroy = vzDomainDestroy, /* 0.10.0 */
.domainShutdown = vzDomainShutdown, /* 0.10.0 */
.domainCreate = vzDomainCreate, /* 0.10.0 */
.domainCreateWithFlags = vzDomainCreateWithFlags, /* 1.2.10 */
.domainReboot = vzDomainReboot, /* 1.3.0 */
.domainDefineXML = vzDomainDefineXML, /* 0.10.0 */
.domainDefineXMLFlags = vzDomainDefineXMLFlags, /* 1.2.12 */ (update part)
.domainUndefine = vzDomainUndefine, /* 1.2.10 */
.domainAttachDevice = vzDomainAttachDevice, /* 1.2.15 */
.domainAttachDeviceFlags = vzDomainAttachDeviceFlags, /* 1.2.15 */
.domainDetachDevice = vzDomainDetachDevice, /* 1.2.15 */
.domainDetachDeviceFlags = vzDomainDetachDeviceFlags, /* 1.2.15 */
.domainSetUserPassword = vzDomainSetUserPassword, /* 1.3.6 */
.domainManagedSave = vzDomainManagedSave, /* 1.2.14 */
.domainSetMemoryFlags = vzDomainSetMemoryFlags, /* 1.3.4 */
.domainSetMemory = vzDomainSetMemory, /* 1.3.4 */
.domainRevertToSnapshot = vzDomainRevertToSnapshot, /* 1.3.5 */ [*]
.domainSnapshotCreateXML = vzDomainSnapshotCreateXML, /* 1.3.5 */ [*]
.domainMigratePerform3Params = vzDomainMigratePerform3Params, /* 1.3.5 */ [*]
.domainUpdateDeviceFlags = vzDomainUpdateDeviceFlags, /* 2.0.0 */
prlsdkHandleVmConfigEvent
[3] API calls that do not use thread shared sdkdom object
.domainManagedSaveRemove = vzDomainManagedSaveRemove, /* 1.2.14 */
.domainSnapshotNum = vzDomainSnapshotNum, /* 1.3.5 */
.domainSnapshotListNames = vzDomainSnapshotListNames, /* 1.3.5 */
.domainListAllSnapshots = vzDomainListAllSnapshots, /* 1.3.5 */
.domainSnapshotGetXMLDesc = vzDomainSnapshotGetXMLDesc, /* 1.3.5 */
.domainSnapshotNumChildren = vzDomainSnapshotNumChildren, /* 1.3.5 */
.domainSnapshotListChildrenNames = vzDomainSnapshotListChildrenNames, /* 1.3.5 */
.domainSnapshotListAllChildren = vzDomainSnapshotListAllChildren, /* 1.3.5 */
.domainSnapshotLookupByName = vzDomainSnapshotLookupByName, /* 1.3.5 */
.domainHasCurrentSnapshot = vzDomainHasCurrentSnapshot, /* 1.3.5 */
.domainSnapshotGetParent = vzDomainSnapshotGetParent, /* 1.3.5 */
.domainSnapshotCurrent = vzDomainSnapshotCurrent, /* 1.3.5 */
.domainSnapshotIsCurrent = vzDomainSnapshotIsCurrent, /* 1.3.5 */
.domainSnapshotHasMetadata = vzDomainSnapshotHasMetadata, /* 1.3.5 */
.domainSnapshotDelete = vzDomainSnapshotDelete, /* 1.3.5 */
[4] Known issues.
1. accidental errors on getting network statistics
2. race with simultaneous use of thread shared domain object on paths
of adding domain thru API and adding domain on vz sdk domain added event.
2016-07-20 15:00:33 +00:00
|
|
|
|
|
|
|
int
|
|
|
|
vzDomainObjBeginJob(virDomainObjPtr dom);
|
|
|
|
void
|
|
|
|
vzDomainObjEndJob(virDomainObjPtr dom);
|
2016-06-20 10:08:14 +00:00
|
|
|
int
|
|
|
|
vzDomainJobUpdateTime(vzDomainJobObjPtr job);
|