[mirror_qemu.git] / migration / migration-stats.h

/*
 * Migration stats
 *
 * Copyright (c) 2012-2023 Red Hat Inc
 *
 * Authors:
 *  Juan Quintela <quintela@redhat.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 */

#ifndef QEMU_MIGRATION_STATS_H
#define QEMU_MIGRATION_STATS_H

#include "qemu/stats64.h"

/*
 * Amount of time to allocate to each "chunk" of bandwidth-throttled
 * data.
 */
#define BUFFER_DELAY     100

/*
 * If rate_limit_max is 0, there is special code to remove the rate
 * limit.
 */
#define RATE_LIMIT_DISABLED 0

/*
 * These are the ram migration statistic counters.  It is loosely
 * based on MigrationStats.  We change to Stat64 any counter that
 * needs to be updated using atomic ops (can be accessed by more than
 * one thread).
 */
typedef struct {
    /*
     * Number of bytes that were dirty last time that we synced with
     * the guest memory.  We use that to calculate the downtime.  As
     * the remaining dirty amounts to what we know that is still dirty
     * since last iteration, not counting what the guest has dirtied
     * since we synchronized bitmaps.
     */
    Stat64 dirty_bytes_last_sync;
    /*
     * Number of pages dirtied per second.
     */
    Stat64 dirty_pages_rate;
    /*
     * Number of times we have synchronized guest bitmaps.
     */
    Stat64 dirty_sync_count;
    /*
     * Number of times zero copy failed to send any page using zero
     * copy.
     */
    Stat64 dirty_sync_missed_zero_copy;
    /*
     * Number of bytes sent at migration completion stage while the
     * guest is stopped.
     */
    Stat64 downtime_bytes;
    /*
     * Number of bytes sent through multifd channels.
     */
    Stat64 multifd_bytes;
    /*
     * Number of pages transferred that were not full of zeros.
     */
    Stat64 normal_pages;
    /*
     * Number of bytes sent during postcopy.
     */
    Stat64 postcopy_bytes;
    /*
     * Number of postcopy page faults that we have handled during
     * postcopy stage.
     */
    Stat64 postcopy_requests;
    /*
     * Number of bytes sent during precopy stage.
     */
    Stat64 precopy_bytes;
    /*
     * Number of bytes transferred with QEMUFile.
     */
    Stat64 qemu_file_transferred;
    /*
     * Amount of transferred data at the start of current cycle.
     */
    Stat64 rate_limit_start;
    /*
     * Maximum amount of data we can send in a cycle.
     */
    Stat64 rate_limit_max;
    /*
     * Number of bytes sent through RDMA.
     */
    Stat64 rdma_bytes;
    /*
     * Number of pages transferred that were full of zeros.
     */
    Stat64 zero_pages;
} MigrationAtomicStats;

extern MigrationAtomicStats mig_stats;

/**
 * migration_rate_get: Get the maximum amount that can be transferred.
 *
 * Returns the maximum number of bytes that can be transferred in a cycle.
 */
uint64_t migration_rate_get(void);

/**
 * migration_rate_reset: Reset the rate limit counter.
 *
 * This is called when we know we start a new transfer cycle.
 */
void migration_rate_reset(void);

/**
 * migration_rate_set: Set the maximum amount that can be transferred.
 *
 * Sets the maximum amount of bytes that can be transferred in one cycle.
 *
 * @new_rate: new maximum amount
 */
void migration_rate_set(uint64_t new_rate);

/**
 * migration_transferred_bytes: Return number of bytes transferred
 *
 * Returns how many bytes have we transferred since the beginning of
 * the migration.  It accounts for bytes sent through any migration
 * channel, multifd, qemu_file, rdma, ....
 */
uint64_t migration_transferred_bytes(void);
#endif
Commit	Line	Data
947701cc JQ	1	/*
	2	* Migration stats
	3	*
	4	* Copyright (c) 2012-2023 Red Hat Inc
	5	*
	6	* Authors:
	7	* Juan Quintela <quintela@redhat.com>
	8	*
	9	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	10	* See the COPYING file in the top-level directory.
	11	*/
	12
	13	#ifndef QEMU_MIGRATION_STATS_H
	14	#define QEMU_MIGRATION_STATS_H
	15
	16	#include "qemu/stats64.h"
	17
e1fde0e0 JQ	18	/*
	19	* Amount of time to allocate to each "chunk" of bandwidth-throttled
	20	* data.
	21	*/
	22	#define BUFFER_DELAY 100
	23
8e4b2a70 JQ	24	/*
	25	* If rate_limit_max is 0, there is special code to remove the rate
	26	* limit.
	27	*/
	28	#define RATE_LIMIT_DISABLED 0
	29
947701cc JQ	30	/*
	31	* These are the ram migration statistic counters. It is loosely
	32	* based on MigrationStats. We change to Stat64 any counter that
	33	* needs to be updated using atomic ops (can be accessed by more than
	34	* one thread).
	35	*/
	36	typedef struct {
e2ee2005 JQ	37	/*
	38	* Number of bytes that were dirty last time that we synced with
	39	* the guest memory. We use that to calculate the downtime. As
	40	* the remaining dirty amounts to what we know that is still dirty
	41	* since last iteration, not counting what the guest has dirtied
	42	* since we synchronized bitmaps.
	43	*/
947701cc	44	Stat64 dirty_bytes_last_sync;
e2ee2005 JQ	45	/*
	46	* Number of pages dirtied per second.
	47	*/
947701cc	48	Stat64 dirty_pages_rate;
e2ee2005 JQ	49	/*
	50	* Number of times we have synchronized guest bitmaps.
	51	*/
947701cc	52	Stat64 dirty_sync_count;
e2ee2005 JQ	53	/*
	54	* Number of times zero copy failed to send any page using zero
	55	* copy.
	56	*/
947701cc	57	Stat64 dirty_sync_missed_zero_copy;
e2ee2005 JQ	58	/*
	59	* Number of bytes sent at migration completion stage while the
	60	* guest is stopped.
	61	*/
947701cc	62	Stat64 downtime_bytes;
e2ee2005 JQ	63	/*
	64	* Number of bytes sent through multifd channels.
	65	*/
947701cc	66	Stat64 multifd_bytes;
e2ee2005 JQ	67	/*
	68	* Number of pages transferred that were not full of zeros.
	69	*/
947701cc	70	Stat64 normal_pages;
e2ee2005 JQ	71	/*
	72	* Number of bytes sent during postcopy.
	73	*/
947701cc	74	Stat64 postcopy_bytes;
e2ee2005 JQ	75	/*
	76	* Number of postcopy page faults that we have handled during
	77	* postcopy stage.
	78	*/
947701cc	79	Stat64 postcopy_requests;
e2ee2005 JQ	80	/*
	81	* Number of bytes sent during precopy stage.
	82	*/
947701cc	83	Stat64 precopy_bytes;
2d897237 JQ	84	/*
	85	* Number of bytes transferred with QEMUFile.
	86	*/
	87	Stat64 qemu_file_transferred;
813cd616 JQ	88	/*
	89	* Amount of transferred data at the start of current cycle.
	90	*/
	91	Stat64 rate_limit_start;
e1fde0e0 JQ	92	/*
	93	* Maximum amount of data we can send in a cycle.
	94	*/
	95	Stat64 rate_limit_max;
67c31c9c JQ	96	/*
	97	* Number of bytes sent through RDMA.
	98	*/
	99	Stat64 rdma_bytes;
40f240a7 JQ	100	/*
	101	* Number of pages transferred that were full of zeros.
	102	*/
	103	Stat64 zero_pages;
96820df2	104	} MigrationAtomicStats;
947701cc	105
96820df2	106	extern MigrationAtomicStats mig_stats;
947701cc	107
e1fde0e0 JQ	108	/**
	109	* migration_rate_get: Get the maximum amount that can be transferred.
	110	*
	111	* Returns the maximum number of bytes that can be transferred in a cycle.
	112	*/
	113	uint64_t migration_rate_get(void);
	114
	115	/**
	116	* migration_rate_reset: Reset the rate limit counter.
	117	*
	118	* This is called when we know we start a new transfer cycle.
	119	*/
0743f41f	120	void migration_rate_reset(void);
e1fde0e0 JQ	121
	122	/**
	123	* migration_rate_set: Set the maximum amount that can be transferred.
	124	*
	125	* Sets the maximum amount of bytes that can be transferred in one cycle.
	126	*
	127	* @new_rate: new maximum amount
	128	*/
	129	void migration_rate_set(uint64_t new_rate);
99319e2d JQ	130
	131	/**
	132	* migration_transferred_bytes: Return number of bytes transferred
	133	*
99319e2d JQ	134	* Returns how many bytes have we transferred since the beginning of
	135	* the migration. It accounts for bytes sent through any migration
	136	* channel, multifd, qemu_file, rdma, ....
	137	*/
f57e5a6c	138	uint64_t migration_transferred_bytes(void);
947701cc	139	#endif