*
* Macro represents proportional weight of the scheduler used on the
* host cpu, when using the posix scheduler, as a ullong.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_CPU_SHARES "cpu_shares"
*
* Macro represents the enforcement period for a quota, in microseconds,
* for whole domain, when using the posix scheduler, as a ullong.
+ *
+ * Since: v1.3.3
*/
# define VIR_DOMAIN_SCHEDULER_GLOBAL_PERIOD "global_period"
*
* Macro represents the maximum bandwidth to be used within a period for
* whole domain, when using the posix scheduler, as an llong.
+ *
+ * Since: v1.3.3
*/
# define VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA "global_quota"
*
* Macro represents the enforcement period for a quota, in microseconds,
* for vcpus only, when using the posix scheduler, as a ullong.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD "vcpu_period"
*
* Macro represents the maximum bandwidth to be used within a period for
* vcpus only, when using the posix scheduler, as an llong.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA "vcpu_quota"
* Macro represents the enforcement period for a quota in microseconds,
* when using the posix scheduler, for all emulator activity not tied to
* vcpus, as a ullong.
+ *
+ * Since: v0.10.0
*/
# define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD "emulator_period"
* Macro represents the maximum bandwidth to be used within a period for
* all emulator activity not tied to vcpus, when using the posix scheduler,
* as an llong.
+ *
+ * Since: v0.10.0
*/
# define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA "emulator_quota"
*
* Macro represents the enforcement period for a quota, in microseconds,
* for IOThreads only, when using the posix scheduler, as a ullong.
+ *
+ * Since: v2.2.0
*/
# define VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD "iothread_period"
*
* Macro represents the maximum bandwidth to be used within a period for
* IOThreads only, when using the posix scheduler, as an llong.
+ *
+ * Since: v2.2.0
*/
# define VIR_DOMAIN_SCHEDULER_IOTHREAD_QUOTA "iothread_quota"
*
* Macro represents the relative weight, when using the credit
* scheduler, as a uint.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_WEIGHT "weight"
*
* Macro represents the maximum scheduler cap, when using the credit
* scheduler, as a uint.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_CAP "cap"
*
* Macro represents the scheduler reservation value, when using the
* allocation scheduler, as an llong.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_RESERVATION "reservation"
*
* Macro represents the scheduler limit value, when using the
* allocation scheduler, as an llong.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_LIMIT "limit"
*
* Macro represents the scheduler shares value, when using the
* allocation scheduler, as an int.
+ *
+ * Since: v0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_SHARES "shares"
*
* Macro providing the field length of parameter names when using
* virDomainBlockStatsFlags().
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
*
* Macro represents the total number of read bytes of the
* block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_READ_BYTES "rd_bytes"
*
* Macro represents the total read requests of the
* block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_READ_REQ "rd_operations"
*
* Macro represents the total time spend on cache reads in
* nano-seconds of the block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES "rd_total_times"
*
* Macro represents the total number of write bytes of the
* block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES "wr_bytes"
*
* Macro represents the total write requests of the
* block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ "wr_operations"
*
* Macro represents the total time spend on cache writes in
* nano-seconds of the block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES "wr_total_times"
*
* Macro represents the total flush requests of the
* block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ "flush_operations"
*
* Macro represents the total time spend on cache flushing in
* nano-seconds of the block device, as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES "flush_total_times"
* VIR_DOMAIN_BLOCK_STATS_ERRS:
*
* In Xen this returns the mysterious 'oo_req', as an llong.
+ *
+ * Since: v0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_ERRS "errs"
* required to transmit migration data.
*
* This field may not be used when VIR_MIGRATE_TUNNELLED flag is set.
+ *
+ * Since: v1.1.0
*/
# define VIR_MIGRATE_PARAM_URI "migrate_uri"
* destination host as VIR_TYPED_PARAM_STRING. Omitting this parameter keeps
* the domain name the same. This field is only allowed to be used with
* hypervisors that support domain renaming during migration.
+ *
+ * Since: v1.1.0
*/
# define VIR_MIGRATE_PARAM_DEST_NAME "destination_name"
* Omitting this parameter keeps the original domain configuration. Using this
* field with hypervisors that do not support changing domain configuration
* during migration will result in a failure.
+ *
+ * Since: v1.1.0
*/
# define VIR_MIGRATE_PARAM_DEST_XML "destination_xml"
* Omitting this parameter keeps the original domain persistent configuration.
* Using this field with hypervisors that do not support changing domain
* configuration during migration will result in a failure.
+ *
+ * Since: v1.3.4
*/
# define VIR_MIGRATE_PARAM_PERSIST_XML "persistent_xml"
* be used for migration as VIR_TYPED_PARAM_ULLONG. If set to 0 or omitted,
* libvirt will choose a suitable default. Some hypervisors do not support this
* feature and will return an error if this field is used and is not 0.
+ *
+ * Since: v1.1.0
*/
# define VIR_MIGRATE_PARAM_BANDWIDTH "bandwidth"
* virDomainMigrate* params field: the maximum bandwidth (in MiB/s) that will
* be used for post-copy phase of a migration as VIR_TYPED_PARAM_ULLONG. If set
* to 0 or omitted, post-copy migration speed will not be limited.
+ *
+ * Since: v5.1.0
*/
# define VIR_MIGRATE_PARAM_BANDWIDTH_POSTCOPY "bandwidth.postcopy"
* parameters are "tlsPort" and "tlsSubject". For example,
*
* spice://target.host.com:1234/?tlsPort=4567
+ *
+ * Since: v1.1.0
*/
# define VIR_MIGRATE_PARAM_GRAPHICS_URI "graphics_uri"
* addresses are accepted as well as hostnames (the resolving is done on
* destination). Some hypervisors do not support this feature and will return
* an error if this field is used.
+ *
+ * Since: v1.1.4
*/
# define VIR_MIGRATE_PARAM_LISTEN_ADDRESS "listen_address"
* virDomainMigrate* params multiple field: The multiple values that list
* the block devices to be migrated. At the moment this is only supported
* by the QEMU driver but not for the tunnelled migration.
+ *
+ * Since: v1.2.17
*/
# define VIR_MIGRATE_PARAM_MIGRATE_DISKS "migrate_disks"
* for incoming disks migration. Type is VIR_TYPED_PARAM_INT. If set to 0 or
* omitted, libvirt will choose a suitable default. At the moment this is only
* supported by the QEMU driver.
+ *
+ * Since: v1.3.3
*/
# define VIR_MIGRATE_PARAM_DISKS_PORT "disks_port"
* currently only supported by the QEMU driver. UNIX URI is only usable if the
* management application makes sure that socket created with this name on the
* destination will be reachable from the source under the same exact path.
+ *
+ * Since: v6.8.0
*/
# define VIR_MIGRATE_PARAM_DISKS_URI "disks_uri"
* compress migration traffic. Supported compression methods: xbzrle, mt.
* The parameter may be specified multiple times if more than one method
* should be used.
+ *
+ * Since: v1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION "compression"
* virDomainMigrate* params field: the level of compression for multithread
* compression as VIR_TYPED_PARAM_INT. Accepted values are in range 0-9.
* 0 is no compression, 1 is maximum speed and 9 is maximum compression.
+ *
+ * Since: v1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL "compression.mt.level"
*
* virDomainMigrate* params field: the number of compression threads for
* multithread compression as VIR_TYPED_PARAM_INT.
+ *
+ * Since: v1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS "compression.mt.threads"
*
* virDomainMigrate* params field: the number of decompression threads for
* multithread compression as VIR_TYPED_PARAM_INT.
+ *
+ * Since: v1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS "compression.mt.dthreads"
*
* virDomainMigrate* params field: the size of page cache for xbzrle
* compression as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE "compression.xbzrle.cache"
* virDomainMigrate* params field: the initial percentage guest CPUs are
* throttled to when auto-convergence decides migration is not converging.
* As VIR_TYPED_PARAM_INT.
+ *
+ * Since: v2.0.0
*/
# define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL "auto_converge.initial"
* VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL whenever the hypervisor decides
* the current rate is not enough to ensure convergence of the migration.
* As VIR_TYPED_PARAM_INT.
+ *
+ * Since: v2.0.0
*/
# define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT "auto_converge.increment"
*
* virDomainMigrate* params field: number of connections used during parallel
* migration. As VIR_TYPED_PARAM_INT.
+ *
+ * Since: v5.2.0
*/
# define VIR_MIGRATE_PARAM_PARALLEL_CONNECTIONS "parallel.connections"
* the destination hostname and the expected certificate's hostname is known,
* this parameter can be used to pass this expected hostname when starting
* the migration.
+ *
+ * Since: v6.0.0
*/
# define VIR_MIGRATE_PARAM_TLS_DESTINATION "tls.destination"
* VIR_DOMAIN_CPU_STATS_CPUTIME:
* cpu usage (sum of both vcpu and hypervisor usage) in nanoseconds,
* as a ullong
+ *
+ * Since: v0.9.10
*/
# define VIR_DOMAIN_CPU_STATS_CPUTIME "cpu_time"
/**
* VIR_DOMAIN_CPU_STATS_USERTIME:
* cpu time charged to user instructions in nanoseconds, as a ullong
+ *
+ * Since: v0.9.11
*/
# define VIR_DOMAIN_CPU_STATS_USERTIME "user_time"
/**
* VIR_DOMAIN_CPU_STATS_SYSTEMTIME:
* cpu time charged to system instructions in nanoseconds, as a ullong
+ *
+ * Since: v0.9.11
*/
# define VIR_DOMAIN_CPU_STATS_SYSTEMTIME "system_time"
* VIR_DOMAIN_CPU_STATS_VCPUTIME:
* vcpu usage in nanoseconds (cpu_time excluding hypervisor time),
* as a ullong
+ *
+ * Since: v0.9.13
*/
# define VIR_DOMAIN_CPU_STATS_VCPUTIME "vcpu_time"
*
* Macro for the Blkio tunable weight: it represents the io weight
* the guest can use, as a uint.
+ *
+ * Since: v0.9.0
*/
# define VIR_DOMAIN_BLKIO_WEIGHT "weight"
* Macro for the blkio tunable weight_device: it represents the
* per-device weight, as a string. The string is parsed as a
* series of /path/to/device,weight elements, separated by ','.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT "device_weight"
* the number of reading the block device per second, as a string. The
* string is parsed as a series of /path/to/device, read_iops elements,
* separated by ','.
+ *
+ * Since: v1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS "device_read_iops_sec"
* the number of writing the block device per second, as a string. The
* string is parsed as a series of /path/to/device, write_iops elements,
* separated by ','.
+ *
+ * Since: v1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS "device_write_iops_sec"
* the bytes of reading the block device per second, as a string. The
* string is parsed as a series of /path/to/device, read_bps elements,
* separated by ','.
+ *
+ * Since: v1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS "device_read_bytes_sec"
* the number of reading the block device per second, as a string. The
* string is parsed as a series of /path/to/device, write_bps elements,
* separated by ','.
+ *
+ * Since: v1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS "device_write_bytes_sec"
* VIR_DOMAIN_MEMORY_PARAM_UNLIMITED:
*
* Macro providing the virMemoryParameter value that indicates "unlimited"
+ *
+ * Since: v0.8.8
*/
# define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED 9007199254740991LL /* = INT64_MAX >> 10 */
*
* Macro for the memory tunable hard_limit: it represents the maximum memory
* the guest can use, as a ullong.
+ *
+ * Since: v0.8.5
*/
# define VIR_DOMAIN_MEMORY_HARD_LIMIT "hard_limit"
*
* Macro for the memory tunable soft_limit: it represents the memory upper
* limit enforced during memory contention, as a ullong.
+ *
+ * Since: v0.8.5
*/
# define VIR_DOMAIN_MEMORY_SOFT_LIMIT "soft_limit"
*
* Macro for the memory tunable min_guarantee: it represents the minimum
* memory guaranteed to be reserved for the guest, as a ullong.
+ *
+ * Since: v0.8.5
*/
# define VIR_DOMAIN_MEMORY_MIN_GUARANTEE "min_guarantee"
* Macro for the swap tunable swap_hard_limit: it represents the maximum swap
* plus memory the guest can use, as a ullong. This limit has to be more than
* VIR_DOMAIN_MEMORY_HARD_LIMIT.
+ *
+ * Since: v0.8.5
*/
# define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT "swap_hard_limit"
*
* Macro for typed parameter name that lists the numa nodeset of a
* domain, as a string.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_NUMA_NODESET "numa_nodeset"
*
* Macro for typed parameter name that lists the numa mode of a domain,
* as an int containing a virDomainNumatuneMemMode value.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_NUMA_MODE "numa_mode"
* VIR_DOMAIN_BANDWIDTH_IN_AVERAGE:
*
* Macro represents the inbound average of NIC bandwidth, as a uint.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE "inbound.average"
* VIR_DOMAIN_BANDWIDTH_IN_PEAK:
*
* Macro represents the inbound peak of NIC bandwidth, as a uint.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_IN_PEAK "inbound.peak"
* VIR_DOMAIN_BANDWIDTH_IN_BURST:
*
* Macro represents the inbound burst of NIC bandwidth, as a uint.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_IN_BURST "inbound.burst"
* VIR_DOMAIN_BANDWIDTH_IN_FLOOR:
*
* Macro represents the inbound floor of NIC bandwidth, as a uint.
+ *
+ * Since: v1.2.19
*/
# define VIR_DOMAIN_BANDWIDTH_IN_FLOOR "inbound.floor"
* VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE:
*
* Macro represents the outbound average of NIC bandwidth, as a uint.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE "outbound.average"
* VIR_DOMAIN_BANDWIDTH_OUT_PEAK:
*
* Macro represents the outbound peak of NIC bandwidth, as a uint.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_OUT_PEAK "outbound.peak"
* VIR_DOMAIN_BANDWIDTH_OUT_BURST:
*
* Macro represents the outbound burst of NIC bandwidth, as a uint.
+ *
+ * Since: v0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_OUT_BURST "outbound.burst"
* will cause more CPU time to be allocated the guest. A value set too
* small will not provide enough cycles for the guest to process data.
* The polling interval is not available for statistical purposes.
+ *
+ * Since: v4.10.0
*/
# define VIR_DOMAIN_IOTHREAD_POLL_MAX_NS "poll_max_ns"
* use to grow its polling interval up to the poll_max_ns value. A value
* of 0 (zero) allows the hypervisor to choose its own value. The algorithm
* to use for adjustment is hypervisor specific.
+ *
+ * Since: v4.10.0
*/
# define VIR_DOMAIN_IOTHREAD_POLL_GROW "poll_grow"
* the poll_max_ns value. A value of 0 (zero) allows the hypervisor to
* choose its own value. The algorithm to use for adjustment is hypervisor
* specific.
+ *
+ * Since: v4.10.0
*/
# define VIR_DOMAIN_IOTHREAD_POLL_SHRINK "poll_shrink"
*
* This macro is to be used in conjunction with virDomainPinVcpu() API.
* It sets the bit (CPU usable) of the related cpu in cpumap.
+ *
+ * Since: v0.1.4
*/
# define VIR_USE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] |= (1 << ((cpu) % 8)))
*
* This macro is to be used in conjunction with virDomainPinVcpu() API.
* It resets the bit (CPU not usable) of the related cpu in cpumap.
+ *
+ * Since: v0.1.4
*/
# define VIR_UNUSE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] &= ~(1 << ((cpu) % 8)))
*
* This macro can be used in conjunction with virNodeGetCPUMap() API.
* It returns non-zero if the bit of the related CPU is set.
+ *
+ * Since: v1.0.0
*/
# define VIR_CPU_USED(cpumap, cpu) ((cpumap)[(cpu) / 8] & (1 << ((cpu) % 8)))
* This macro is to be used in conjunction with virDomainPinVcpu() API.
* It returns the length (in bytes) required to store the complete
* CPU map between a single virtual & all physical CPUs of a domain.
+ *
+ * Since: v0.1.4
*/
# define VIR_CPU_MAPLEN(cpu) (((cpu) + 7) / 8)
* This macro is to be used in conjunction with virDomainGetVcpus() API.
* VIR_CPU_USABLE macro returns a non-zero value (true) if the cpu
* is usable by the vcpu, and 0 otherwise.
+ *
+ * Since: v0.1.4
*/
# define VIR_CPU_USABLE(cpumaps, maplen, vcpu, cpu) \
* virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extracts the cpumap of
* the specified vcpu from cpumaps array and copies it into cpumap to be used
* later by virDomainPinVcpu() API.
+ *
+ * Since: v0.1.4
*/
# define VIR_COPY_CPUMAP(cpumaps, maplen, vcpu, cpumap) \
memcpy(cpumap, VIR_GET_CPUMAP(cpumaps, maplen, vcpu), maplen)
* This macro is to be used in conjunction with virDomainGetVcpus() and
* virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the
* cpumap of the specified vcpu from cpumaps array.
+ *
+ * Since: v0.1.4
*/
# define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (maplen)]))
* which can be used to measure the usage of cache (bytes) by
* applications running on the platform. It corresponds to the
* "perf.cmt" field in the *Stats APIs.
+ *
+ * Since: v1.3.3
*/
# define VIR_PERF_PARAM_CMT "cmt"
* which can be used to monitor total system bandwidth (bytes/s)
* from one level of cache to another. It corresponds to the
* "perf.mbmt" field in the *Stats APIs.
+ *
+ * Since: v1.3.5
*/
# define VIR_PERF_PARAM_MBMT "mbmt"
* which can be used to monitor the amount of data (bytes/s) sent
* through the memory controller on the socket. It corresponds to
* the "perf.mbml" field in the *Stats APIs.
+ *
+ * Since: v1.3.5
*/
# define VIR_PERF_PARAM_MBML "mbml"
* event which can be used to measure the count of cache misses by
* applications running on the platform. It corresponds to the
* "perf.cache_misses" field in the *Stats APIs.
+ *
+ * Since: v2.3.0
*/
# define VIR_PERF_PARAM_CACHE_MISSES "cache_misses"
* perf event which can be used to measure the count of cache hits
* by applications running on the platform. It corresponds to the
* "perf.cache_references" field in the *Stats APIs.
+ *
+ * Since: v2.3.0
*/
# define VIR_PERF_PARAM_CACHE_REFERENCES "cache_references"
* event which can be used to measure the count of instructions
* by applications running on the platform. It corresponds to the
* "perf.instructions" field in the *Stats APIs.
+ *
+ * Since: v2.3.0
*/
# define VIR_PERF_PARAM_INSTRUCTIONS "instructions"
* describing the total/elapsed cpu cycles. This can be used to measure
* how many cpu cycles one instruction needs.
* It corresponds to the "perf.cpu_cycles" field in the *Stats APIs.
+ *
+ * Since: v2.3.0
*/
# define VIR_PERF_PARAM_CPU_CYCLES "cpu_cycles"
* perf event which can be used to measure the count of branch instructions
* by applications running on the platform. It corresponds to the
* "perf.branch_instructions" field in the *Stats APIs.
+ *
+ * Since: v3.0.0
*/
# define VIR_PERF_PARAM_BRANCH_INSTRUCTIONS "branch_instructions"
* perf event which can be used to measure the count of branch misses
* by applications running on the platform. It corresponds to the
* "perf.branch_misses" field in the *Stats APIs.
+ *
+ * Since: v3.0.0
*/
# define VIR_PERF_PARAM_BRANCH_MISSES "branch_misses"
* perf event which can be used to measure the count of bus cycles
* by applications running on the platform. It corresponds to the
* "perf.bus_cycles" field in the *Stats APIs.
+ *
+ * Since: v3.0.0
*/
# define VIR_PERF_PARAM_BUS_CYCLES "bus_cycles"
* in the frontend of the instruction processor pipeline by applications
* running on the platform. It corresponds to the
* "perf.stalled_cycles_frontend" field in the *Stats APIs.
+ *
+ * Since: v3.0.0
*/
# define VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND "stalled_cycles_frontend"
* in the backend of the instruction processor pipeline by application
* running on the platform. It corresponds to the
* "perf.stalled_cycles_backend" field in the *Stats APIs.
+ *
+ * Since: v3.0.0
*/
# define VIR_PERF_PARAM_STALLED_CYCLES_BACKEND "stalled_cycles_backend"
* cycles not affected by CPU frequency scaling by applications
* running on the platform. It corresponds to the
* "perf.ref_cpu_cycles" field in the *Stats APIs.
+ *
+ * Since: v3.0.0
*/
# define VIR_PERF_PARAM_REF_CPU_CYCLES "ref_cpu_cycles"
* clock time by applications running on the platform. It
* corresponds to the "perf.cpu_clock" field in the *Stats
* APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_CPU_CLOCK "cpu_clock"
* clock time by applications running on the platform. It
* corresponds to the "perf.task_clock" field in the *Stats
* APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_TASK_CLOCK "task_clock"
* perf event which can be used to measure the count of page
* faults by applications running on the platform. It corresponds
* to the "perf.page_faults" field in the *Stats APIs.
+*
+* Since: v3.2.0
+*
*/
# define VIR_PERF_PARAM_PAGE_FAULTS "page_faults"
* perf event which can be used to measure the count of context
* switches by applications running on the platform. It corresponds
* to the "perf.context_switches" field in the *Stats APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_CONTEXT_SWITCHES "context_switches"
* perf event which can be used to measure the count of cpu
* migrations by applications running on the platform. It corresponds
* to the "perf.cpu_migrations" field in the *Stats APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_CPU_MIGRATIONS "cpu_migrations"
* perf event which can be used to measure the count of minor page
* faults by applications running on the platform. It corresponds
* to the "perf.page_faults_min" field in the *Stats APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_PAGE_FAULTS_MIN "page_faults_min"
* perf event which can be used to measure the count of major page
* faults by applications running on the platform. It corresponds
* to the "perf.page_faults_maj" field in the *Stats APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_PAGE_FAULTS_MAJ "page_faults_maj"
* perf event which can be used to measure the count of alignment
* faults by applications running on the platform. It corresponds
* to the "perf.alignment_faults" field in the *Stats APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_ALIGNMENT_FAULTS "alignment_faults"
* perf event which can be used to measure the count of emulation
* faults by applications running on the platform. It corresponds
* to the "perf.emulation_faults" field in the *Stats APIs.
+ *
+ * Since: v3.2.0
*/
# define VIR_PERF_PARAM_EMULATION_FAULTS "emulation_faults"
* allowing a subsequent change of bandwidth via
* virDomainBlockJobSetSpeed(). The actual speed can be determined
* with virDomainGetBlockJobInfo().
+ *
+ * Since: v1.2.8
*/
# define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH "bandwidth"
* restrict this to be a power of two or fall within a certain
* range. Specifying 0 is the same as omitting this parameter, to
* request the hypervisor default.
+ *
+ * Since: v1.2.8
*/
# define VIR_DOMAIN_BLOCK_COPY_GRANULARITY "granularity"
* how much data in bytes can be in flight between source and destination,
* as an unsigned long long. Specifying 0 is the same as omitting this
* parameter, to request the hypervisor default.
+ *
+ * Since: v1.2.8
*/
# define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE "buf-size"
*
* Macro for the BlockIoTune tunable weight: it represents the total
* bytes per second permitted through a block device, as a ullong.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC "total_bytes_sec"
*
* Macro for the BlockIoTune tunable weight: it represents the read
* bytes per second permitted through a block device, as a ullong.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC "read_bytes_sec"
*
* Macro for the BlockIoTune tunable weight: it represents the write
* bytes per second permitted through a block device, as a ullong.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC "write_bytes_sec"
*
* Macro for the BlockIoTune tunable weight: it represents the total
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC "total_iops_sec"
*
* Macro for the BlockIoTune tunable weight: it represents the read
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC "read_iops_sec"
* VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC:
* Macro for the BlockIoTune tunable weight: it represents the write
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC "write_iops_sec"
*
* Macro for the BlockIoTune tunable weight: it represents the maximum total
* bytes per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX "total_bytes_sec_max"
*
* Macro for the BlockIoTune tunable weight: it represents the maximum read
* bytes per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX "read_bytes_sec_max"
*
* Macro for the BlockIoTune tunable weight: it represents the maximum write
* bytes per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX "write_bytes_sec_max"
*
* Macro for the BlockIoTune tunable weight: it represents the maximum
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX "total_iops_sec_max"
*
* Macro for the BlockIoTune tunable weight: it represents the maximum read
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX "read_iops_sec_max"
* VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX:
* Macro for the BlockIoTune tunable weight: it represents the maximum write
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX "write_iops_sec_max"
*
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by total_bytes_sec_max, as a ullong.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH "total_bytes_sec_max_length"
*
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by read_bytes_sec_max, as a ullong.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH "read_bytes_sec_max_length"
*
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by write_bytes_sec_max, as a ullong.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH "write_bytes_sec_max_length"
*
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by total_iops_sec_max, as a ullong.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH "total_iops_sec_max_length"
*
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by read_iops_sec_max, as a ullong.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH "read_iops_sec_max_length"
*
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by write_iops_sec_max, as a ullong.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH "write_iops_sec_max_length"
* VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC:
* Macro for the BlockIoTune tunable weight: it represents the size
* I/O operations per second permitted through a block device, as a ullong.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC "size_iops_sec"
* VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME:
* Macro for the BlockIoTune tunable weight: it represents a group name to
* allow sharing of I/O throttling quota between multiple drives, as a string.
+ *
+ * Since: v3.0.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME "group_name"
* VIR_KEYCODE_SET_RFB:
*
* Compatibility alias for VIR_KEYCODE_SET_QNUM, which replaced it since 4.2.0.
+ *
+ * Since: v0.9.5
*/
# define VIR_KEYCODE_SET_RFB VIR_KEYCODE_SET_QNUM
* VIR_DOMAIN_SEND_KEY_MAX_KEYS:
*
* Maximum number of keycodes that can be sent in one virDomainSendKey() call.
+ *
+ * Since: v0.9.3
*/
# define VIR_DOMAIN_SEND_KEY_MAX_KEYS 16
* virDomainGetJobStats field: the operation which started the job as
* VIR_TYPED_PARAM_INT. The values correspond to the items in
* virDomainJobOperation enum.
+ *
+ * Since: v3.3.0
*/
# define VIR_DOMAIN_JOB_OPERATION "operation"
* job, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to timeElapsed field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_TIME_ELAPSED "time_elapsed"
* migration job NOT including the time required to transfer control
* flow from the source host to the destination host,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.15
*/
# define VIR_DOMAIN_JOB_TIME_ELAPSED_NET "time_elapsed_net"
* jobs, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to timeRemaining field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_TIME_REMAINING "time_remaining"
* during migration, as VIR_TYPED_PARAM_ULLONG. The real computed downtime
* between the time guest CPUs were paused and the time they were resumed
* is reported for completed migration.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DOWNTIME "downtime"
* virDomainGetJobStats field: real measured downtime (ms) NOT including
* the time required to transfer control flow from the source host to the
* destination host, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.15
*/
# define VIR_DOMAIN_JOB_DOWNTIME_NET "downtime_net"
* virDomainGetJobStats field: total time in milliseconds spent preparing
* the migration in the 'setup' phase before the iterations begin, as
* VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_JOB_SETUP_TIME "setup_time"
* VIR_DOMAIN_JOB_DATA_PROCESSED + VIR_DOMAIN_JOB_DATA_REMAINING.
*
* This field corresponds to dataTotal field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DATA_TOTAL "data_total"
* beginning of the job, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to dataProcessed field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DATA_PROCESSED "data_processed"
* transferred, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to dataRemaining field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DATA_REMAINING "data_remaining"
* tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to memTotal field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_TOTAL "memory_total"
* tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to memProcessed field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_PROCESSED "memory_processed"
* tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to memRemaining field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_REMAINING "memory_remaining"
*
* The most common example of such pages are zero pages, i.e., pages filled
* with zero bytes.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_CONSTANT "memory_constant"
* any kind of compression (i.e., pages which were not filled with a constant
* byte and which could not be compressed) transferred since the beginning
* of the migration job, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_NORMAL "memory_normal"
* as VIR_TYPED_PARAM_ULLONG.
*
* See VIR_DOMAIN_JOB_MEMORY_NORMAL for more details.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES "memory_normal_bytes"
*
* virDomainGetJobStats field: network throughput used while migrating
* memory in Bytes per second, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_JOB_MEMORY_BPS "memory_bps"
* virDomainGetJobStats field: number of memory pages dirtied by the guest
* per second, as VIR_TYPED_PARAM_ULLONG. This statistics makes sense only
* when live migration is running.
+ *
+ * Since: v1.3.1
*/
# define VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE "memory_dirty_rate"
* convert other page based statistics, such as
* VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE or VIR_DOMAIN_JOB_COMPRESSION_PAGES
* to bytes.
+ *
+ * Since: v3.9.0
*/
# define VIR_DOMAIN_JOB_MEMORY_PAGE_SIZE "memory_page_size"
* when memory starts to be transferred and the value is increased by one
* every time a new iteration is started to transfer memory pages dirtied
* since the last iteration.
+ *
+ * Since: v1.3.1
*/
# define VIR_DOMAIN_JOB_MEMORY_ITERATION "memory_iteration"
* destination host during post-copy migration, as VIR_TYPED_PARAM_ULLONG.
* This counter is incremented whenever the migrated domain tries to access
* a memory page which has not been transferred from the source host yet.
+ *
+ * Since: v5.0.0
*/
# define VIR_DOMAIN_JOB_MEMORY_POSTCOPY_REQS "memory_postcopy_requests"
* tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to fileTotal field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DISK_TOTAL "disk_total"
* tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to fileProcessed field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DISK_PROCESSED "disk_processed"
* tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG.
*
* This field corresponds to fileRemaining field in virDomainJobInfo.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_DISK_REMAINING "disk_remaining"
*
* virDomainGetJobStats field: network throughput used while migrating
* disks in Bytes per second, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_JOB_DISK_BPS "disk_bps"
* virDomainGetJobStats field: size of the cache (in bytes) used for
* compressing repeatedly transferred memory pages during live migration,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_CACHE "compression_cache"
*
* virDomainGetJobStats field: number of compressed bytes transferred
* since the beginning of migration, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_BYTES "compression_bytes"
*
* virDomainGetJobStats field: number of compressed pages transferred
* since the beginning of migration, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_PAGES "compression_pages"
* virDomainGetJobStats field: number of repeatedly changing pages that
* were not found in compression cache and thus could not be compressed,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES "compression_cache_misses"
* were found in compression cache but were sent uncompressed because
* the result of compression was larger than the original page as a whole,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW "compression_overflow"
* virDomainGetJobStats field: current percentage guest CPUs are throttled
* to when auto-convergence decided migration was not converging, as
* VIR_TYPED_PARAM_INT.
+ *
+ * Since: v2.0.0
*/
# define VIR_DOMAIN_JOB_AUTO_CONVERGE_THROTTLE "auto_converge_throttle"
*
* virDomainGetJobStats field: Present only in statistics for a completed job.
* Successful completion of the job as VIR_TYPED_PARAM_BOOLEAN.
+ *
+ * Since: v6.0.0
*/
# define VIR_DOMAIN_JOB_SUCCESS "success"
*
* virDomainGetJobStats field: Present only in statistics for a completed job.
* Optional error message for a failed job.
+ *
+ * Since: v6.3.0
*/
# define VIR_DOMAIN_JOB_ERRMSG "errmsg"
* VIR_DOMAIN_JOB_DISK_TEMP_USED:
* virDomainGetJobStats field: current usage of temporary disk space for the
* job in bytes as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v6.0.0
*/
# define VIR_DOMAIN_JOB_DISK_TEMP_USED "disk_temp_used"
* VIR_DOMAIN_JOB_DISK_TEMP_TOTAL:
* virDomainGetJobStats field: possible total temporary disk space for the
* job in bytes as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v6.0.0
*/
# define VIR_DOMAIN_JOB_DISK_TEMP_TOTAL "disk_temp_total"
* Macro represents formatted pinning for one vcpu specified by id which is
* appended to the parameter name, for example "cputune.vcpupin1",
* as VIR_TYPED_PARAM_STRING.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN "cputune.vcpupin%u"
*
* Macro represents formatted pinning for emulator process,
* as VIR_TYPED_PARAM_STRING.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN "cputune.emulatorpin"
* Macro represents formatted pinning for one IOThread specified by id which is
* appended to the parameter name, for example "cputune.iothreadpin1",
* as VIR_TYPED_PARAM_STRING.
+ *
+ * Since: v1.2.14
*/
# define VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN "cputune.iothreadpin%u"
*
* Macro represents proportional weight of the scheduler used on the
* host cpu, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES "cputune.cpu_shares"
*
* Macro represents the enforcement period for a quota, in microseconds,
* for whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.3.3
*/
# define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_PERIOD "cputune.global_period"
*
* Macro represents the maximum bandwidth to be used within a period for
* whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.
+ *
+ * Since: v1.3.3
*/
# define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA "cputune.global_quota"
*
* Macro represents the enforcement period for a quota, in microseconds,
* for vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD "cputune.vcpu_period"
*
* Macro represents the maximum bandwidth to be used within a period for
* vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA "cputune.vcpu_quota"
* Macro represents the enforcement period for a quota in microseconds,
* when using the posix scheduler, for all emulator activity not tied to
* vcpus, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD "cputune.emulator_period"
* Macro represents the maximum bandwidth to be used within a period for
* all emulator activity not tied to vcpus, when using the posix scheduler,
* as an VIR_TYPED_PARAM_LLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA "cputune.emulator_quota"
*
* Macro represents the enforcement period for a quota, in microseconds, for
* iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.2.0
*/
# define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD "cputune.iothread_period"
*
* Macro represents the maximum bandwidth to be used within a period for
* iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.
+ *
+ * Since: v2.2.0
*/
# define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_QUOTA "cputune.iothread_quota"
*
* Macro represents the name of guest disk for which the values are updated,
* as VIR_TYPED_PARAM_STRING.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_DISK "blkdeviotune.disk"
*
* Macro represents the total throughput limit in bytes per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC "blkdeviotune.total_bytes_sec"
*
* Macro represents the read throughput limit in bytes per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC "blkdeviotune.read_bytes_sec"
*
* Macro represents the write throughput limit in bytes per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC "blkdeviotune.write_bytes_sec"
*
* Macro represents the total I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC "blkdeviotune.total_iops_sec"
*
* Macro represents the read I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC "blkdeviotune.read_iops_sec"
*
* Macro represents the write I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC "blkdeviotune.write_iops_sec"
*
* Macro represents the total throughput limit during bursts in
* maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX "blkdeviotune.total_bytes_sec_max"
*
* Macro represents the read throughput limit during bursts in
* maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX "blkdeviotune.read_bytes_sec_max"
*
* Macro represents the write throughput limit during bursts in
* maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX "blkdeviotune.write_bytes_sec_max"
*
* Macro represents the total maximum I/O operations per second during bursts,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX "blkdeviotune.total_iops_sec_max"
*
* Macro represents the read maximum I/O operations per second during bursts,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX "blkdeviotune.read_iops_sec_max"
*
* Macro represents the write maximum I/O operations per second during bursts,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX "blkdeviotune.write_iops_sec_max"
*
* Macro represents the size maximum I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC "blkdeviotune.size_iops_sec"
*
* Macro represents the group name to be used,
* as VIR_TYPED_PARAM_STRING.
+ *
+ * Since: v3.0.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_GROUP_NAME "blkdeviotune.group_name"
* Macro represents the length in seconds allowed for a burst period
* for the blkdeviotune.total_bytes_sec_max,
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH "blkdeviotune.total_bytes_sec_max_length"
* Macro represents the length in seconds allowed for a burst period
* for the blkdeviotune.read_bytes_sec_max
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH "blkdeviotune.read_bytes_sec_max_length"
* Macro represents the length in seconds allowed for a burst period
* for the blkdeviotune.write_bytes_sec_max
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH "blkdeviotune.write_bytes_sec_max_length"
* Macro represents the length in seconds allowed for a burst period
* for the blkdeviotune.total_iops_sec_max
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH "blkdeviotune.total_iops_sec_max_length"
* Macro represents the length in seconds allowed for a burst period
* for the blkdeviotune.read_iops_sec_max
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH "blkdeviotune.read_iops_sec_max_length"
* Macro represents the length in seconds allowed for a burst period
* for the blkdeviotune.write_iops_sec_max
* as VIR_TYPED_PARAM_ULLONG.
+ *
+ * Since: v2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH "blkdeviotune.write_iops_sec_max_length"
*
* Used to cast the event specific callback into the generic one
* for use for virConnectDomainEventRegisterAny()
+ *
+ * Since: v0.8.0
*/
# define VIR_DOMAIN_EVENT_CALLBACK(cb) ((virConnectDomainEventGenericCallback)(cb))
*
* Macro providing the field length of virSchedParameter. Provided
* for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the
- * preferred value since 0.9.2.
+ * preferred value
+ *
+ * Since: v0.2.3
*/
# define VIR_DOMAIN_SCHED_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
+/**
+ * _virSchedParameter:
+ *
+ * Since: v0.2.3
+ */
+# define _virSchedParameter _virTypedParameter
+
/**
* virSchedParameter:
*
* a virSchedParameter is the set of scheduler parameters.
* Provided for backwards compatibility; virTypedParameter is the
- * preferred alias since 0.9.2.
+ * preferred alias.
+ *
+ * Since: v0.9.2
*/
-# define _virSchedParameter _virTypedParameter
typedef struct _virTypedParameter virSchedParameter;
/**
*
* Macro providing the field length of virBlkioParameter. Provided
* for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the
- * preferred value since 0.9.2.
+ * preferred value.
+ *
+ * Since: v0.9.0
*/
# define VIR_DOMAIN_BLKIO_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
+/**
+ * _virBlkioParameter:
+ *
+ * Since: v0.9.0
+ */
+# define _virBlkioParameter _virTypedParameter
+
/**
* virBlkioParameter:
*
* a virBlkioParameter is the set of blkio parameters.
* Provided for backwards compatibility; virTypedParameter is the
- * preferred alias since 0.9.2.
+ * preferred alias.
+ *
+ * Since: v0.9.2
*/
-# define _virBlkioParameter _virTypedParameter
typedef struct _virTypedParameter virBlkioParameter;
/**
*
* Macro providing the field length of virMemoryParameter. Provided
* for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the
- * preferred value since 0.9.2.
+ * preferred value.
+ *
+ * Since: v0.8.5
*/
# define VIR_DOMAIN_MEMORY_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
+/**
+ * _virMemoryParameter:
+ *
+ * Since: v0.8.5
+ */
+# define _virMemoryParameter _virTypedParameter
+
/**
* virMemoryParameter:
*
* a virMemoryParameter is the set of scheduler parameters.
* Provided for backwards compatibility; virTypedParameter is the
- * preferred alias since 0.9.2.
+ * preferred alias.
+ *
+ * Since: v0.9.2
*/
-# define _virMemoryParameter _virTypedParameter
typedef struct _virTypedParameter virMemoryParameter;
/**
*
* Macro represents the launch measurement of the SEV guest,
* as VIR_TYPED_PARAM_STRING.
+ *
+ * Since: v4.5.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_MEASUREMENT "sev-measurement"
*
* Macro represents the API major version of the SEV host,
* as VIR_TYPED_PARAM_UINT.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MAJOR "sev-api-major"
*
* Macro represents the API minor version of the SEV guest,
* as VIR_TYPED_PARAM_UINT.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MINOR "sev-api-minor"
*
* Macro represents the build ID of the SEV host,
* as VIR_TYPED_PARAM_UINT.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_BUILD_ID "sev-build-id"
*
* Macro represents the policy of the SEV guest,
* as VIR_TYPED_PARAM_UINT.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_POLICY "sev-policy"
* the SEV firmware to recover the plain text of the launch secret. See
* section "6.6 LAUNCH_SECRET" in the SEV API specification for a detailed
* description of the secret header.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_HEADER "sev-secret-header"
* base64-encoded VIR_TYPED_PARAM_STRING containing an encrypted launch
* secret. The secret is created by the domain owner after the SEV launch
* measurement is retrieved and verified.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET "sev-secret"
* A macro used to represent the physical address within the guest's memory
* where the secret will be set, as VIR_TYPED_PARAM_ULLONG. If not specified,
* the address will be determined by the hypervisor.
+ *
+ * Since: v8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_SET_ADDRESS "sev-secret-set-address"
projects / thirdparty / libvirt.git / commitdiff
