[mirror_qemu.git] / migration / multifd.h

/*
 * Multifd common functions
 *
 * Copyright (c) 2019-2020 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_MULTIFD_H
#define QEMU_MIGRATION_MULTIFD_H

int multifd_save_setup(Error **errp);
void multifd_save_cleanup(void);
int multifd_load_setup(Error **errp);
int multifd_load_cleanup(Error **errp);
bool multifd_recv_all_channels_created(void);
bool multifd_recv_new_channel(QIOChannel *ioc, Error **errp);
void multifd_recv_sync_main(void);
void multifd_send_sync_main(QEMUFile *f);
int multifd_queue_page(QEMUFile *f, RAMBlock *block, ram_addr_t offset);

/* Multifd Compression flags */
#define MULTIFD_FLAG_SYNC (1 << 0)

/* We reserve 3 bits for compression methods */
#define MULTIFD_FLAG_COMPRESSION_MASK (7 << 1)
/* we need to be compatible. Before compression value was 0 */
#define MULTIFD_FLAG_NOCOMP (0 << 1)
#define MULTIFD_FLAG_ZLIB (1 << 1)
#define MULTIFD_FLAG_ZSTD (2 << 1)

/* This value needs to be a multiple of qemu_target_page_size() */
#define MULTIFD_PACKET_SIZE (512 * 1024)

typedef struct {
    uint32_t magic;
    uint32_t version;
    uint32_t flags;
    /* maximum number of allocated pages */
    uint32_t pages_alloc;
    uint32_t pages_used;
    /* size of the next packet that contains pages */
    uint32_t next_packet_size;
    uint64_t packet_num;
    uint64_t unused[4];    /* Reserved for future use */
    char ramblock[256];
    uint64_t offset[];
} __attribute__((packed)) MultiFDPacket_t;

typedef struct {
    /* number of used pages */
    uint32_t used;
    /* number of allocated pages */
    uint32_t allocated;
    /* global number of generated multifd packets */
    uint64_t packet_num;
    /* offset of each page */
    ram_addr_t *offset;
    /* pointer to each page */
    struct iovec *iov;
    RAMBlock *block;
} MultiFDPages_t;

typedef struct {
    /* this fields are not changed once the thread is created */
    /* channel number */
    uint8_t id;
    /* channel thread name */
    char *name;
    /* channel thread id */
    QemuThread thread;
    /* communication channel */
    QIOChannel *c;
    /* sem where to wait for more work */
    QemuSemaphore sem;
    /* this mutex protects the following parameters */
    QemuMutex mutex;
    /* is this channel thread running */
    bool running;
    /* should this thread finish */
    bool quit;
    /* thread has work to do */
    int pending_job;
    /* array of pages to sent */
    MultiFDPages_t *pages;
    /* packet allocated len */
    uint32_t packet_len;
    /* pointer to the packet */
    MultiFDPacket_t *packet;
    /* multifd flags for each packet */
    uint32_t flags;
    /* size of the next packet that contains pages */
    uint32_t next_packet_size;
    /* global number of generated multifd packets */
    uint64_t packet_num;
    /* thread local variables */
    /* packets sent through this channel */
    uint64_t num_packets;
    /* pages sent through this channel */
    uint64_t num_pages;
    /* syncs main thread and channels */
    QemuSemaphore sem_sync;
    /* used for compression methods */
    void *data;
}  MultiFDSendParams;

typedef struct {
    /* this fields are not changed once the thread is created */
    /* channel number */
    uint8_t id;
    /* channel thread name */
    char *name;
    /* channel thread id */
    QemuThread thread;
    /* communication channel */
    QIOChannel *c;
    /* this mutex protects the following parameters */
    QemuMutex mutex;
    /* is this channel thread running */
    bool running;
    /* should this thread finish */
    bool quit;
    /* array of pages to receive */
    MultiFDPages_t *pages;
    /* packet allocated len */
    uint32_t packet_len;
    /* pointer to the packet */
    MultiFDPacket_t *packet;
    /* multifd flags for each packet */
    uint32_t flags;
    /* global number of generated multifd packets */
    uint64_t packet_num;
    /* thread local variables */
    /* size of the next packet that contains pages */
    uint32_t next_packet_size;
    /* packets sent through this channel */
    uint64_t num_packets;
    /* pages sent through this channel */
    uint64_t num_pages;
    /* syncs main thread and channels */
    QemuSemaphore sem_sync;
    /* used for de-compression methods */
    void *data;
} MultiFDRecvParams;

typedef struct {
    /* Setup for sending side */
    int (*send_setup)(MultiFDSendParams *p, Error **errp);
    /* Cleanup for sending side */
    void (*send_cleanup)(MultiFDSendParams *p, Error **errp);
    /* Prepare the send packet */
    int (*send_prepare)(MultiFDSendParams *p, uint32_t used, Error **errp);
    /* Write the send packet */
    int (*send_write)(MultiFDSendParams *p, uint32_t used, Error **errp);
    /* Setup for receiving side */
    int (*recv_setup)(MultiFDRecvParams *p, Error **errp);
    /* Cleanup for receiving side */
    void (*recv_cleanup)(MultiFDRecvParams *p);
    /* Read all pages */
    int (*recv_pages)(MultiFDRecvParams *p, uint32_t used, Error **errp);
} MultiFDMethods;

void multifd_register_ops(int method, MultiFDMethods *ops);

#endif
Commit	Line	Data
d32ca5ad JQ	1	/*
	2	* Multifd common functions
	3	*
	4	* Copyright (c) 2019-2020 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_MULTIFD_H
	14	#define QEMU_MIGRATION_MULTIFD_H
	15
	16	int multifd_save_setup(Error **errp);
	17	void multifd_save_cleanup(void);
	18	int multifd_load_setup(Error **errp);
	19	int multifd_load_cleanup(Error **errp);
	20	bool multifd_recv_all_channels_created(void);
	21	bool multifd_recv_new_channel(QIOChannel ioc, Error *errp);
	22	void multifd_recv_sync_main(void);
	23	void multifd_send_sync_main(QEMUFile *f);
	24	int multifd_queue_page(QEMUFile f, RAMBlock block, ram_addr_t offset);
	25
7ec2c2b3	26	/* Multifd Compression flags */
d32ca5ad JQ	27	#define MULTIFD_FLAG_SYNC (1 << 0)
d32ca5ad JQ	28
ab7cbb0b JQ	29	/* We reserve 3 bits for compression methods */
	30	#define MULTIFD_FLAG_COMPRESSION_MASK (7 << 1)
	31	/* we need to be compatible. Before compression value was 0 */
	32	#define MULTIFD_FLAG_NOCOMP (0 << 1)
7ec2c2b3	33	#define MULTIFD_FLAG_ZLIB (1 << 1)
87dc6f5f	34	#define MULTIFD_FLAG_ZSTD (2 << 1)
ab7cbb0b	35
d32ca5ad JQ	36	/* This value needs to be a multiple of qemu_target_page_size() */
	37	#define MULTIFD_PACKET_SIZE (512 * 1024)
	38
	39	typedef struct {
	40	uint32_t magic;
	41	uint32_t version;
	42	uint32_t flags;
	43	/* maximum number of allocated pages */
	44	uint32_t pages_alloc;
	45	uint32_t pages_used;
	46	/* size of the next packet that contains pages */
	47	uint32_t next_packet_size;
	48	uint64_t packet_num;
	49	uint64_t unused[4]; /* Reserved for future use */
	50	char ramblock[256];
	51	uint64_t offset[];
	52	} __attribute__((packed)) MultiFDPacket_t;
	53
	54	typedef struct {
	55	/* number of used pages */
	56	uint32_t used;
	57	/* number of allocated pages */
	58	uint32_t allocated;
	59	/* global number of generated multifd packets */
	60	uint64_t packet_num;
	61	/* offset of each page */
	62	ram_addr_t *offset;
	63	/* pointer to each page */
	64	struct iovec *iov;
	65	RAMBlock *block;
	66	} MultiFDPages_t;
	67
	68	typedef struct {
	69	/* this fields are not changed once the thread is created */
	70	/* channel number */
	71	uint8_t id;
	72	/* channel thread name */
	73	char *name;
	74	/* channel thread id */
	75	QemuThread thread;
	76	/* communication channel */
	77	QIOChannel *c;
	78	/* sem where to wait for more work */
	79	QemuSemaphore sem;
	80	/* this mutex protects the following parameters */
	81	QemuMutex mutex;
	82	/* is this channel thread running */
	83	bool running;
	84	/* should this thread finish */
	85	bool quit;
	86	/* thread has work to do */
	87	int pending_job;
	88	/* array of pages to sent */
	89	MultiFDPages_t *pages;
	90	/* packet allocated len */
	91	uint32_t packet_len;
	92	/* pointer to the packet */
	93	MultiFDPacket_t *packet;
	94	/* multifd flags for each packet */
	95	uint32_t flags;
	96	/* size of the next packet that contains pages */
	97	uint32_t next_packet_size;
	98	/* global number of generated multifd packets */
	99	uint64_t packet_num;
100	/* thread local variables */
101	/* packets sent through this channel */
102	uint64_t num_packets;
103	/* pages sent through this channel */
104	uint64_t num_pages;
105	/* syncs main thread and channels */
106	QemuSemaphore sem_sync;
ab7cbb0b JQ	107	/* used for compression methods */
ab7cbb0b JQ	108	void *data;
d32ca5ad JQ	109	} MultiFDSendParams;
	110
	111	typedef struct {
	112	/* this fields are not changed once the thread is created */
	113	/* channel number */
	114	uint8_t id;
	115	/* channel thread name */
	116	char *name;
	117	/* channel thread id */
	118	QemuThread thread;
	119	/* communication channel */
	120	QIOChannel *c;
	121	/* this mutex protects the following parameters */
	122	QemuMutex mutex;
	123	/* is this channel thread running */
	124	bool running;
	125	/* should this thread finish */
	126	bool quit;
	127	/* array of pages to receive */
	128	MultiFDPages_t *pages;
	129	/* packet allocated len */
	130	uint32_t packet_len;
	131	/* pointer to the packet */
	132	MultiFDPacket_t *packet;
	133	/* multifd flags for each packet */
	134	uint32_t flags;
	135	/* global number of generated multifd packets */
	136	uint64_t packet_num;
	137	/* thread local variables */
	138	/* size of the next packet that contains pages */
	139	uint32_t next_packet_size;
	140	/* packets sent through this channel */
	141	uint64_t num_packets;
	142	/* pages sent through this channel */
	143	uint64_t num_pages;
	144	/* syncs main thread and channels */
	145	QemuSemaphore sem_sync;
ab7cbb0b JQ	146	/* used for de-compression methods */
ab7cbb0b JQ	147	void *data;
d32ca5ad JQ	148	} MultiFDRecvParams;
d32ca5ad JQ	149
ab7cbb0b JQ	150	typedef struct {
	151	/* Setup for sending side */
	152	int (send_setup)(MultiFDSendParams p, Error **errp);
	153	/* Cleanup for sending side */
	154	void (send_cleanup)(MultiFDSendParams p, Error **errp);
	155	/* Prepare the send packet */
	156	int (send_prepare)(MultiFDSendParams p, uint32_t used, Error **errp);
	157	/* Write the send packet */
	158	int (send_write)(MultiFDSendParams p, uint32_t used, Error **errp);
	159	/* Setup for receiving side */
	160	int (recv_setup)(MultiFDRecvParams p, Error **errp);
	161	/* Cleanup for receiving side */
	162	void (recv_cleanup)(MultiFDRecvParams p);
	163	/* Read all pages */
	164	int (recv_pages)(MultiFDRecvParams p, uint32_t used, Error **errp);
	165	} MultiFDMethods;
	166
7ec2c2b3 JQ	167	void multifd_register_ops(int method, MultiFDMethods *ops);
7ec2c2b3 JQ	168
d32ca5ad JQ	169	#endif
d32ca5ad JQ	170