From d960ab86c5ad6eafff3d1d550a80226209b24062 Mon Sep 17 00:00:00 2001

From: Kevin Wolf <kwolf@redhat.com>

Date: Tue, 26 Jun 2018 09:48:32 +0200

Subject: [PATCH 124/268] job: Add lifecycle QMP commands

RH-Author: Kevin Wolf <kwolf@redhat.com>

Message-id: <20180626094856.6924-50-kwolf@redhat.com>

Patchwork-id: 81129

O-Subject: [RHV-7.6 qemu-kvm-rhev PATCH v2 49/73] job: Add lifecycle QMP commands

Bugzilla: 1513543

RH-Acked-by: Jeffrey Cody <jcody@redhat.com>

RH-Acked-by: Max Reitz <mreitz@redhat.com>

RH-Acked-by: Fam Zheng <famz@redhat.com>

This adds QMP commands that control the transition between states of the

job lifecycle.

Signed-off-by: Kevin Wolf <kwolf@redhat.com>

(cherry picked from commit 1a90bc8128ee7d16ce4abb131961e37084d75b16)

Signed-off-by: Kevin Wolf <kwolf@redhat.com>

Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>

---

 MAINTAINERS   |   1 +

 Makefile.objs |   1 +

 job-qmp.c     | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

 qapi/job.json |  99 +++++++++++++++++++++++++++++++++++++++++++

 trace-events  |   9 ++++

 5 files changed, 244 insertions(+)

 create mode 100644 job-qmp.c

diff --git a/MAINTAINERS b/MAINTAINERS

index 5aaf264..a783c92 100644

--- a/MAINTAINERS

+++ b/MAINTAINERS

@@ -1372,6 +1372,7 @@ S: Supported

 F: blockjob.c

 F: include/block/blockjob.h

 F: job.c

+F: job-qmp.c

 F: include/block/job.h

 F: block/backup.c

 F: block/commit.c

diff --git a/Makefile.objs b/Makefile.objs

index 3df8d58..c6c3554 100644

--- a/Makefile.objs

+++ b/Makefile.objs

@@ -97,6 +97,7 @@ io-obj-y = io/

 ifeq ($(CONFIG_SOFTMMU),y)

 common-obj-y = blockdev.o blockdev-nbd.o block/

 common-obj-y += bootdevice.o iothread.o

+common-obj-y += job-qmp.o

 common-obj-y += net/

 common-obj-y += qdev-monitor.o device-hotplug.o

 common-obj-$(CONFIG_WIN32) += os-win32.o

diff --git a/job-qmp.c b/job-qmp.c

new file mode 100644

index 0000000..b2e18cf

--- /dev/null

+++ b/job-qmp.c

@@ -0,0 +1,134 @@

+/*

+ * QMP interface for background jobs

+ *

+ * Copyright (c) 2011 IBM Corp.

+ * Copyright (c) 2012, 2018 Red Hat, Inc.

+ *

+ * Permission is hereby granted, free of charge, to any person obtaining a copy

+ * of this software and associated documentation files (the "Software"), to deal

+ * in the Software without restriction, including without limitation the rights

+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

+ * copies of the Software, and to permit persons to whom the Software is

+ * furnished to do so, subject to the following conditions:

+ *

+ * The above copyright notice and this permission notice shall be included in

+ * all copies or substantial portions of the Software.

+ *

+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

+ * THE SOFTWARE.

+ */

+

+#include "qemu/osdep.h"

+#include "qemu-common.h"

+#include "qemu/job.h"

+#include "qapi/qapi-commands-job.h"

+#include "qapi/error.h"

+#include "trace-root.h"

+

+/* Get a job using its ID and acquire its AioContext */

+static Job *find_job(const char *id, AioContext **aio_context, Error **errp)

+{

+    Job *job;

+

+    *aio_context = NULL;

+

+    job = job_get(id);

+    if (!job) {

+        error_setg(errp, "Job not found");

+        return NULL;

+    }

+

+    *aio_context = job->aio_context;

+    aio_context_acquire(*aio_context);

+

+    return job;

+}

+

+void qmp_job_cancel(const char *id, Error **errp)

+{

+    AioContext *aio_context;

+    Job *job = find_job(id, &aio_context, errp);

+

+    if (!job) {

+        return;

+    }

+

+    trace_qmp_job_cancel(job);

+    job_user_cancel(job, true, errp);

+    aio_context_release(aio_context);

+}

+

+void qmp_job_pause(const char *id, Error **errp)

+{

+    AioContext *aio_context;

+    Job *job = find_job(id, &aio_context, errp);

+

+    if (!job) {

+        return;

+    }

+

+    trace_qmp_job_pause(job);

+    job_user_pause(job, errp);

+    aio_context_release(aio_context);

+}

+

+void qmp_job_resume(const char *id, Error **errp)

+{

+    AioContext *aio_context;

+    Job *job = find_job(id, &aio_context, errp);

+

+    if (!job) {

+        return;

+    }

+

+    trace_qmp_job_resume(job);

+    job_user_resume(job, errp);

+    aio_context_release(aio_context);

+}

+

+void qmp_job_complete(const char *id, Error **errp)

+{

+    AioContext *aio_context;

+    Job *job = find_job(id, &aio_context, errp);

+

+    if (!job) {

+        return;

+    }

+

+    trace_qmp_job_complete(job);

+    job_complete(job, errp);

+    aio_context_release(aio_context);

+}

+

+void qmp_job_finalize(const char *id, Error **errp)

+{

+    AioContext *aio_context;

+    Job *job = find_job(id, &aio_context, errp);

+

+    if (!job) {

+        return;

+    }

+

+    trace_qmp_job_finalize(job);

+    job_finalize(job, errp);

+    aio_context_release(aio_context);

+}

+

+void qmp_job_dismiss(const char *id, Error **errp)

+{

+    AioContext *aio_context;

+    Job *job = find_job(id, &aio_context, errp);

+

+    if (!job) {

+        return;

+    }

+

+    trace_qmp_job_dismiss(job);

+    job_dismiss(&job, errp);

+    aio_context_release(aio_context);

+}

diff --git a/qapi/job.json b/qapi/job.json

index 9fbdd0c..b84dc6c 100644

--- a/qapi/job.json

+++ b/qapi/job.json

@@ -106,3 +106,102 @@

 { 'event': 'JOB_STATUS_CHANGE',

   'data': { 'id': 'str',

             'status': 'JobStatus' } }

+

+##

+# @job-pause:

+#

+# Pause an active job.

+#

+# This command returns immediately after marking the active job for pausing.

+# Pausing an already paused job is an error.

+#

+# The job will pause as soon as possible, which means transitioning into the

+# PAUSED state if it was RUNNING, or into STANDBY if it was READY. The

+# corresponding JOB_STATUS_CHANGE event will be emitted.

+#

+# Cancelling a paused job automatically resumes it.

+#

+# @id: The job identifier.

+#

+# Since: 2.13

+##

+{ 'command': 'job-pause', 'data': { 'id': 'str' } }

+

+##

+# @job-resume:

+#

+# Resume a paused job.

+#

+# This command returns immediately after resuming a paused job. Resuming an

+# already running job is an error.

+#

+# @id : The job identifier.

+#

+# Since: 2.13

+##

+{ 'command': 'job-resume', 'data': { 'id': 'str' } }

+

+##

+# @job-cancel:

+#

+# Instruct an active background job to cancel at the next opportunity.

+# This command returns immediately after marking the active job for

+# cancellation.

+#

+# The job will cancel as soon as possible and then emit a JOB_STATUS_CHANGE

+# event. Usually, the status will change to ABORTING, but it is possible that

+# a job successfully completes (e.g. because it was almost done and there was

+# no opportunity to cancel earlier than completing the job) and transitions to

+# PENDING instead.

+#

+# @id: The job identifier.

+#

+# Since: 2.13

+##

+{ 'command': 'job-cancel', 'data': { 'id': 'str' } }

+

+

+##

+# @job-complete:

+#

+# Manually trigger completion of an active job in the READY state.

+#

+# @id: The job identifier.

+#

+# Since: 2.13

+##

+{ 'command': 'job-complete', 'data': { 'id': 'str' } }

+

+##

+# @job-dismiss:

+#

+# Deletes a job that is in the CONCLUDED state. This command only needs to be

+# run explicitly for jobs that don't have automatic dismiss enabled.

+#

+# This command will refuse to operate on any job that has not yet reached its

+# terminal state, JOB_STATUS_CONCLUDED. For jobs that make use of JOB_READY

+# event, job-cancel or job-complete will still need to be used as appropriate.

+#

+# @id: The job identifier.

+#

+# Since: 2.13

+##

+{ 'command': 'job-dismiss', 'data': { 'id': 'str' } }

+

+##

+# @job-finalize:

+#

+# Instructs all jobs in a transaction (or a single job if it is not part of any

+# transaction) to finalize any graph changes and do any necessary cleanup. This

+# command requires that all involved jobs are in the PENDING state.

+#

+# For jobs in a transaction, instructing one job to finalize will force

+# ALL jobs in the transaction to finalize, so it is only necessary to instruct

+# a single member job to finalize.

+#

+# @id: The identifier of any job in the transaction, or of a job that is not

+#      part of any transaction.

+#

+# Since: 2.13

+##

+{ 'command': 'job-finalize', 'data': { 'id': 'str' } }

diff --git a/trace-events b/trace-events

index ef7579a..c445f54 100644

--- a/trace-events

+++ b/trace-events

@@ -109,6 +109,15 @@ job_state_transition(void *job,  int ret, const char *legal, const char *s0, con

 job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"

 job_completed(void *job, int ret, int jret) "job %p ret %d corrected ret %d"

+# job-qmp.c

+qmp_job_cancel(void *job) "job %p"

+qmp_job_pause(void *job) "job %p"

+qmp_job_resume(void *job) "job %p"

+qmp_job_complete(void *job) "job %p"

+qmp_job_finalize(void *job) "job %p"

+qmp_job_dismiss(void *job) "job %p"

+

+

 ### Guest events, keep at bottom

-- 

1.8.3.1