1 From b9c06929cb9e9583b002fa6de76ad3c318c89f35 Mon Sep 17 00:00:00 2001
2 From: Dietmar Maurer <dietmar@proxmox.com>
3 Date: Tue, 13 Nov 2012 11:27:56 +0100
4 Subject: [PATCH v3 3/6] add backup related monitor commands
6 We use a generic BackupDriver struct to encapsulate all archive format
9 Another option would be to simply dump <devid,cluster_num,cluster_data> to
10 the output fh (pipe), and an external binary saves the data. That way we
11 could move the whole archive format related code out of qemu.
13 Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
16 blockdev.c | 412 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
17 hmp-commands.hx | 31 ++++
21 qapi-schema.json | 91 ++++++++++++
22 qmp-commands.hx | 27 ++++
23 8 files changed, 646 insertions(+), 0 deletions(-)
25 diff --git a/backup.h b/backup.h
26 index a5f85e6..c9c20c9 100644
29 @@ -29,4 +29,16 @@ int backup_job_create(BlockDriverState *bs, BackupDumpFunc *backup_dump_cb,
30 BlockDriverCompletionFunc *backup_complete_cb,
31 void *opaque, int64_t speed);
33 +typedef struct BackupDriver {
35 + void *(*open_cb)(const char *filename, uuid_t uuid, Error **errp);
36 + int (*close_cb)(void *opaque, Error **errp);
37 + int (*register_config_cb)(void *opaque, const char *name, gpointer data,
39 + int (*register_stream_cb)(void *opaque, const char *devname, size_t size);
40 + int (*dump_cb)(void *opaque, uint8_t dev_id, int64_t cluster_num,
41 + unsigned char *buf, size_t *zero_bytes);
42 + int (*complete_cb)(void *opaque, uint8_t dev_id, int ret);
45 #endif /* QEMU_BACKUP_H */
46 diff --git a/blockdev.c b/blockdev.c
47 index e73fd6e..bd2198e 100644
51 #include "qmp-commands.h"
53 #include "arch_init.h"
56 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
58 @@ -1321,6 +1322,417 @@ void qmp_drive_mirror(const char *device, const char *target,
59 drive_get_ref(drive_get_by_blockdev(bs));
62 +/* Backup related function */
64 +static void backup_run_next_job(void);
66 +static struct GenericBackupState {
74 + const BackupDriver *driver;
82 +typedef struct BackupCB {
83 + BlockDriverState *bs;
92 +static int backup_dump_cb(void *opaque, BlockDriverState *bs,
93 + int64_t cluster_num, unsigned char *buf)
95 + BackupCB *bcb = opaque;
97 + assert(backup_state.driver);
98 + assert(backup_state.writer);
99 + assert(backup_state.driver->dump_cb);
101 + size_t zero_bytes = 0;
102 + int bytes = backup_state.driver->dump_cb(backup_state.writer,
103 + bcb->dev_id, cluster_num,
107 + bcb->transferred += bytes;
108 + backup_state.transferred += bytes;
110 + bcb->zero_bytes += bytes;
111 + backup_state.zero_bytes += zero_bytes;
118 +static void backup_cleanup(void)
120 + if (backup_state.writer && backup_state.driver) {
121 + backup_state.end_time = time(NULL);
122 + Error *local_err = NULL;
123 + backup_state.driver->close_cb(backup_state.writer, &local_err);
124 + error_propagate(&backup_state.error, local_err);
125 + backup_state.writer = NULL;
128 + if (backup_state.bcb_list) {
129 + GList *l = backup_state.bcb_list;
131 + BackupCB *bcb = l->data;
132 + l = g_list_next(l);
133 + drive_put_ref_bh_schedule(drive_get_by_blockdev(bcb->bs));
136 + g_list_free(backup_state.bcb_list);
137 + backup_state.bcb_list = NULL;
141 +static void backup_complete_cb(void *opaque, int ret)
143 + BackupCB *bcb = opaque;
145 + assert(backup_state.driver);
146 + assert(backup_state.writer);
147 + assert(backup_state.driver->complete_cb);
148 + assert(backup_state.driver->close_cb);
150 + bcb->completed = true;
152 + backup_state.driver->complete_cb(backup_state.writer, bcb->dev_id, ret);
154 + backup_run_next_job();
157 +static void backup_cancel(void)
159 + if (!backup_state.error) {
160 + error_setg(&backup_state.error, "backup cancelled");
163 + /* we only need to cancel the running job - backup_run_next_job() cancels
164 + * the other jobs */
166 + GList *l = backup_state.bcb_list;
168 + BackupCB *bcb = l->data;
169 + l = g_list_next(l);
170 + BlockJob *job = bcb->bs->job;
171 + if (!bcb->completed && job) {
172 + block_job_cancel(job);
173 + /* make sure we call the complete callback */
175 + block_job_completed(job, -1);
181 + if (!l) { /* all jobs completed */
186 +void qmp_backup_cancel(Error **errp)
191 +static void backup_run_next_job(void)
193 + GList *l = backup_state.bcb_list;
195 + BackupCB *bcb = l->data;
196 + l = g_list_next(l);
198 + if (bcb->bs && bcb->bs->job && !bcb->completed) {
199 + if (!bcb->started) {
200 + bcb->started = true;
201 + if (!backup_state.error) {
202 + backup_job_start(bcb->bs);
204 + block_job_completed(bcb->bs->job, -1);
214 +static void backup_start_jobs(void)
216 + /* create all jobs (one for each device), start first one */
217 + GList *l = backup_state.bcb_list;
219 + BackupCB *bcb = l->data;
220 + l = g_list_next(l);
222 + if (backup_job_create(bcb->bs, backup_dump_cb, backup_complete_cb,
223 + bcb, backup_state.speed) != 0) {
224 + error_setg(&backup_state.error, "backup_job_create failed");
230 + backup_run_next_job();
233 +char *qmp_backup(const char *backupfile, bool has_format, BackupFormat format,
234 + bool has_config_filename, const char *config_filename,
235 + bool has_devlist, const char *devlist,
236 + bool has_speed, int64_t speed, Error **errp)
238 + BlockDriverState *bs;
239 + Error *local_err = NULL;
241 + void *writer = NULL;
242 + gchar **devs = NULL;
243 + GList *bcblist = NULL;
245 + /* Todo: try to auto-detect format based on file name */
246 + format = has_format ? format : BACKUP_FORMAT_VMA;
248 + /* fixme: find driver for specifued format */
249 + const BackupDriver *driver = NULL;
252 + error_set(errp, ERROR_CLASS_GENERIC_ERROR, "unknown backup format");
257 + devs = g_strsplit_set(devlist, ",;:", -1);
261 + bs = bdrv_find(*d);
263 + if (bdrv_is_read_only(bs)) {
264 + error_set(errp, QERR_DEVICE_IS_READ_ONLY, *d);
267 + if (!bdrv_is_inserted(bs)) {
268 + error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, *d);
271 + BackupCB *bcb = g_new0(BackupCB, 1);
273 + bcblist = g_list_append(bcblist, bcb);
275 + error_set(errp, QERR_DEVICE_NOT_FOUND, *d);
284 + while ((bs = bdrv_next(bs))) {
286 + if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
290 + BackupCB *bcb = g_new0(BackupCB, 1);
292 + bcblist = g_list_append(bcblist, bcb);
297 + error_set(errp, ERROR_CLASS_GENERIC_ERROR, "empty device list");
301 + GList *l = bcblist;
303 + BackupCB *bcb = l->data;
304 + l = g_list_next(l);
305 + if (bcb->bs->job) {
306 + error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bcb->bs));
311 + uuid_generate(uuid);
313 + writer = driver->open_cb(backupfile, uuid, &local_err);
315 + if (error_is_set(&local_err)) {
316 + error_propagate(errp, local_err);
323 + /* register all devices for vma writer */
326 + BackupCB *bcb = l->data;
327 + l = g_list_next(l);
329 + int64_t size = bdrv_getlength(bcb->bs);
330 + const char *devname = bdrv_get_device_name(bcb->bs);
331 + bcb->dev_id = driver->register_stream_cb(writer, devname, size);
332 + if (bcb->dev_id <= 0) {
333 + error_set(errp, ERROR_CLASS_GENERIC_ERROR,
334 + "register_stream failed");
341 + /* add configuration file to archive */
342 + if (has_config_filename) {
343 + char *cdata = NULL;
345 + GError *err = NULL;
346 + if (!g_file_get_contents(config_filename, &cdata, &clen, &err)) {
347 + error_setg(errp, "unable to read file '%s'", config_filename);
351 + const char *basename = g_path_get_basename(config_filename);
352 + if (driver->register_config_cb(writer, basename, cdata, clen) < 0) {
353 + error_setg(errp, "register_config failed");
360 + /* initialize global backup_state now */
362 + if (backup_state.error) {
363 + error_free(backup_state.error);
364 + backup_state.error = NULL;
367 + backup_state.driver = driver;
369 + backup_state.speed = (has_speed && speed > 0) ? speed : 0;
371 + backup_state.start_time = time(NULL);
372 + backup_state.end_time = 0;
374 + if (backup_state.backupfile) {
375 + g_free(backup_state.backupfile);
377 + backup_state.backupfile = g_strdup(backupfile);
379 + backup_state.writer = writer;
381 + uuid_copy(backup_state.uuid, uuid);
382 + uuid_unparse_lower(uuid, backup_state.uuid_str);
384 + backup_state.bcb_list = bcblist;
386 + backup_state.total = total;
387 + backup_state.transferred = 0;
388 + backup_state.zero_bytes = 0;
390 + /* Grab a reference so hotplug does not delete the
391 + * BlockDriverState from underneath us.
395 + BackupCB *bcb = l->data;
396 + l = g_list_next(l);
397 + drive_get_ref(drive_get_by_blockdev(bcb->bs));
400 + backup_start_jobs();
402 + return g_strdup(backup_state.uuid_str);
409 + l = g_list_next(l);
411 + g_list_free(bcblist);
418 + unlink(backupfile);
421 + driver->close_cb(writer, &err);
428 +BackupStatus *qmp_query_backup(Error **errp)
430 + BackupStatus *info = g_malloc0(sizeof(*info));
432 + if (!backup_state.start_time) {
433 + /* not started, return {} */
437 + info->has_status = true;
438 + info->has_start_time = true;
439 + info->start_time = backup_state.start_time;
441 + if (backup_state.backupfile) {
442 + info->has_backupfile = true;
443 + info->backupfile = g_strdup(backup_state.backupfile);
446 + info->has_uuid = true;
447 + info->uuid = g_strdup(backup_state.uuid_str);
449 + if (backup_state.end_time) {
450 + if (backup_state.error) {
451 + info->status = g_strdup("error");
452 + info->has_errmsg = true;
453 + info->errmsg = g_strdup(error_get_pretty(backup_state.error));
455 + info->status = g_strdup("done");
457 + info->has_end_time = true;
458 + info->end_time = backup_state.end_time;
460 + info->status = g_strdup("active");
463 + info->has_total = true;
464 + info->total = backup_state.total;
465 + info->has_zero_bytes = true;
466 + info->zero_bytes = backup_state.zero_bytes;
467 + info->has_transferred = true;
468 + info->transferred = backup_state.transferred;
473 static BlockJob *find_block_job(const char *device)
475 BlockDriverState *bs;
476 diff --git a/hmp-commands.hx b/hmp-commands.hx
477 index 010b8c9..57be357 100644
478 --- a/hmp-commands.hx
479 +++ b/hmp-commands.hx
480 @@ -83,6 +83,35 @@ STEXI
481 Copy data from a backing file into a block device.
486 + .args_type = "backupfile:s,speed:o?,devlist:s?",
487 + .params = "backupfile [speed [devlist]]",
488 + .help = "create a VM Backup.",
489 + .mhandler.cmd = hmp_backup,
499 + .name = "backup_cancel",
502 + .help = "cancel the current VM backup",
503 + .mhandler.cmd = hmp_backup_cancel,
508 +@findex backup_cancel
509 +Cancel the current VM backup.
514 .name = "block_job_set_speed",
515 .args_type = "device:B,speed:o",
516 @@ -1558,6 +1587,8 @@ show CPU statistics
517 show user network stack connection states
519 show migration status
522 @item info migrate_capabilities
523 show current migration capabilities
524 @item info migrate_cache_size
525 diff --git a/hmp.c b/hmp.c
526 index 180ba2b..27fd421 100644
529 @@ -130,6 +130,38 @@ void hmp_info_mice(Monitor *mon)
530 qapi_free_MouseInfoList(mice_list);
533 +void hmp_info_backup(Monitor *mon)
535 + BackupStatus *info;
537 + info = qmp_query_backup(NULL);
538 + if (info->has_status) {
539 + if (info->has_errmsg) {
540 + monitor_printf(mon, "Backup status: %s - %s\n",
541 + info->status, info->errmsg);
543 + monitor_printf(mon, "Backup status: %s\n", info->status);
546 + if (info->has_backupfile) {
547 + int per = (info->has_total && info->total &&
548 + info->has_transferred && info->transferred) ?
549 + (info->transferred * 100)/info->total : 0;
550 + int zero_per = (info->has_total && info->total &&
551 + info->has_zero_bytes && info->zero_bytes) ?
552 + (info->zero_bytes * 100)/info->total : 0;
553 + monitor_printf(mon, "Backup file: %s\n", info->backupfile);
554 + monitor_printf(mon, "Backup uuid: %s\n", info->uuid);
555 + monitor_printf(mon, "Total size: %zd\n", info->total);
556 + monitor_printf(mon, "Transferred bytes: %zd (%d%%)\n",
557 + info->transferred, per);
558 + monitor_printf(mon, "Zero bytes: %zd (%d%%)\n",
559 + info->zero_bytes, zero_per);
562 + qapi_free_BackupStatus(info);
565 void hmp_info_migrate(Monitor *mon)
568 @@ -977,6 +1009,37 @@ void hmp_block_stream(Monitor *mon, const QDict *qdict)
569 hmp_handle_error(mon, &error);
572 +void hmp_backup_cancel(Monitor *mon, const QDict *qdict)
574 + Error *errp = NULL;
576 + qmp_backup_cancel(&errp);
578 + if (error_is_set(&errp)) {
579 + monitor_printf(mon, "%s\n", error_get_pretty(errp));
585 +void hmp_backup(Monitor *mon, const QDict *qdict)
587 + const char *backupfile = qdict_get_str(qdict, "backupfile");
588 + const char *devlist = qdict_get_try_str(qdict, "devlist");
589 + int64_t speed = qdict_get_try_int(qdict, "speed", 0);
591 + Error *errp = NULL;
593 + qmp_backup(backupfile, true, BACKUP_FORMAT_VMA, false, NULL, !!devlist,
594 + devlist, qdict_haskey(qdict, "speed"), speed, &errp);
596 + if (error_is_set(&errp)) {
597 + monitor_printf(mon, "%s\n", error_get_pretty(errp));
603 void hmp_block_job_set_speed(Monitor *mon, const QDict *qdict)
606 diff --git a/hmp.h b/hmp.h
607 index 0ab03be..20c9a62 100644
610 @@ -28,6 +28,7 @@ void hmp_info_mice(Monitor *mon);
611 void hmp_info_migrate(Monitor *mon);
612 void hmp_info_migrate_capabilities(Monitor *mon);
613 void hmp_info_migrate_cache_size(Monitor *mon);
614 +void hmp_info_backup(Monitor *mon);
615 void hmp_info_cpus(Monitor *mon);
616 void hmp_info_block(Monitor *mon);
617 void hmp_info_blockstats(Monitor *mon);
618 @@ -63,6 +64,8 @@ void hmp_eject(Monitor *mon, const QDict *qdict);
619 void hmp_change(Monitor *mon, const QDict *qdict);
620 void hmp_block_set_io_throttle(Monitor *mon, const QDict *qdict);
621 void hmp_block_stream(Monitor *mon, const QDict *qdict);
622 +void hmp_backup(Monitor *mon, const QDict *qdict);
623 +void hmp_backup_cancel(Monitor *mon, const QDict *qdict);
624 void hmp_block_job_set_speed(Monitor *mon, const QDict *qdict);
625 void hmp_block_job_cancel(Monitor *mon, const QDict *qdict);
626 void hmp_block_job_pause(Monitor *mon, const QDict *qdict);
627 diff --git a/monitor.c b/monitor.c
628 index c0e32d6..85cf47e 100644
631 @@ -2680,6 +2680,13 @@ static mon_cmd_t info_cmds[] = {
638 + .help = "show backup status",
639 + .mhandler.info = hmp_info_backup,
645 diff --git a/qapi-schema.json b/qapi-schema.json
646 index 5dfa052..2d3699b 100644
647 --- a/qapi-schema.json
648 +++ b/qapi-schema.json
650 { 'type': 'EventInfo', 'data': {'name': 'str'} }
655 +# Detailed backup status.
657 +# @status: #optional string describing the current backup status.
658 +# This can be 'active', 'done', 'error'. If this field is not
659 +# returned, no backup process has been initiated
661 +# @errmsg: #optional error message (only returned if status is 'error')
663 +# @total: #optional total amount of bytes involved in the backup process
665 +# @transferred: #optional amount of bytes already backed up.
667 +# @zero-bytes: #optional amount of 'zero' bytes detected.
669 +# @start-time: #optional time (epoch) when backup job started.
671 +# @end-time: #optional time (epoch) when backup job finished.
673 +# @backupfile: #optional backup file name
675 +# @uuid: #optional uuid for this backup job
679 +{ 'type': 'BackupStatus',
680 + 'data': {'*status': 'str', '*errmsg': 'str', '*total': 'int',
681 + '*transferred': 'int', '*zero-bytes': 'int',
682 + '*start-time': 'int', '*end-time': 'int',
683 + '*backupfile': 'str', '*uuid': 'str' } }
688 # Return a list of supported QMP events by this server
689 @@ -1764,6 +1797,64 @@
690 'data': { 'path': 'str' },
691 'returns': [ 'ObjectPropertyInfo' ] }
697 +# An enumeration of supported backup formats.
699 +# @vma: Proxmox vma backup format
701 +{ 'enum': 'BackupFormat',
702 + 'data': [ 'vma' ] }
707 +# Starts a VM backup.
709 +# @backupfile: the backup file name
711 +# @format: format of the backup file
713 +# @config-filename: #optional name of a configuration file to include into
714 +# the backup archive.
716 +# @speed: #optional the maximum speed, in bytes per second
718 +# Returns: the uuid of the backup job
722 +{ 'command': 'backup', 'data': { 'backupfile': 'str', '*format': 'BackupFormat',
723 + '*config-filename': 'str',
724 + '*devlist': 'str', '*speed': 'int' },
730 +# Returns information about current/last backup task.
732 +# Returns: @BackupStatus
736 +{ 'command': 'query-backup', 'returns': 'BackupStatus' }
741 +# Cancel the current executing backup process.
743 +# Returns: nothing on success
745 +# Notes: This command succeeds even if there is no backup process running.
749 +{ 'command': 'backup-cancel' }
754 diff --git a/qmp-commands.hx b/qmp-commands.hx
755 index 5c692d0..c46fdc4 100644
756 --- a/qmp-commands.hx
757 +++ b/qmp-commands.hx
758 @@ -822,6 +822,18 @@ EQMP
763 + .args_type = "backupfile:s,format:s?,config-filename:F?,speed:o?,devlist:s?",
764 + .mhandler.cmd_new = qmp_marshal_input_backup,
768 + .name = "backup_cancel",
770 + .mhandler.cmd_new = qmp_marshal_input_backup_cancel,
774 .name = "block-job-set-speed",
775 .args_type = "device:B,speed:o",
776 .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
777 @@ -2491,6 +2503,21 @@ EQMP
790 + .name = "query-backup",
792 + .mhandler.cmd_new = qmp_marshal_input_query_backup,
796 migrate-set-capabilities