job-qmp.c

   1 /*
   2  * QMP interface for background jobs
   3  *
   4  * Copyright (c) 2011 IBM Corp.
   5  * Copyright (c) 2012, 2018 Red Hat, Inc.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25
  26 #include "qemu/osdep.h"
  27 #include "qemu/job.h"
  28 #include "qapi/qapi-commands-job.h"
  29 #include "qapi/error.h"
  30 #include "trace/trace-root.h"
  31
  32 /*
  33  * Get a job using its ID and acquire its AioContext.
  34  * Called with job_mutex held.
  35  */
  36 static Job *find_job_locked(const char *id,
  37                             AioContext **aio_context,
  38                             Error **errp)
  39 {
  40     Job *job;
  41
  42     *aio_context = NULL;
  43
  44     job = job_get_locked(id);
  45     if (!job) {
  46         error_setg(errp, "Job not found");
  47         return NULL;
  48     }
  49
  50     *aio_context = job->aio_context;
  51     aio_context_acquire(*aio_context);
  52
  53     return job;
  54 }
  55
  56 void qmp_job_cancel(const char *id, Error **errp)
  57 {
  58     AioContext *aio_context;
  59     Job *job;
  60
  61     JOB_LOCK_GUARD();
  62     job = find_job_locked(id, &aio_context, errp);
  63
  64     if (!job) {
  65         return;
  66     }
  67
  68     trace_qmp_job_cancel(job);
  69     job_user_cancel_locked(job, true, errp);
  70     aio_context_release(aio_context);
  71 }
  72
  73 void qmp_job_pause(const char *id, Error **errp)
  74 {
  75     AioContext *aio_context;
  76     Job *job;
  77
  78     JOB_LOCK_GUARD();
  79     job = find_job_locked(id, &aio_context, errp);
  80
  81     if (!job) {
  82         return;
  83     }
  84
  85     trace_qmp_job_pause(job);
  86     job_user_pause_locked(job, errp);
  87     aio_context_release(aio_context);
  88 }
  89
  90 void qmp_job_resume(const char *id, Error **errp)
  91 {
  92     AioContext *aio_context;
  93     Job *job;
  94
  95     JOB_LOCK_GUARD();
  96     job = find_job_locked(id, &aio_context, errp);
  97
  98     if (!job) {
  99         return;
 100     }
 101
 102     trace_qmp_job_resume(job);
 103     job_user_resume_locked(job, errp);
 104     aio_context_release(aio_context);
 105 }
 106
 107 void qmp_job_complete(const char *id, Error **errp)
 108 {
 109     AioContext *aio_context;
 110     Job *job;
 111
 112     JOB_LOCK_GUARD();
 113     job = find_job_locked(id, &aio_context, errp);
 114
 115     if (!job) {
 116         return;
 117     }
 118
 119     trace_qmp_job_complete(job);
 120     job_complete_locked(job, errp);
 121     aio_context_release(aio_context);
 122 }
 123
 124 void qmp_job_finalize(const char *id, Error **errp)
 125 {
 126     AioContext *aio_context;
 127     Job *job;
 128
 129     JOB_LOCK_GUARD();
 130     job = find_job_locked(id, &aio_context, errp);
 131
 132     if (!job) {
 133         return;
 134     }
 135
 136     trace_qmp_job_finalize(job);
 137     job_ref_locked(job);
 138     job_finalize_locked(job, errp);
 139
 140     /*
 141      * Job's context might have changed via job_finalize (and job_txn_apply
 142      * automatically acquires the new one), so make sure we release the correct
 143      * one.
 144      */
 145     aio_context = job->aio_context;
 146     job_unref_locked(job);
 147     aio_context_release(aio_context);
 148 }
 149
 150 void qmp_job_dismiss(const char *id, Error **errp)
 151 {
 152     AioContext *aio_context;
 153     Job *job;
 154
 155     JOB_LOCK_GUARD();
 156     job = find_job_locked(id, &aio_context, errp);
 157
 158     if (!job) {
 159         return;
 160     }
 161
 162     trace_qmp_job_dismiss(job);
 163     job_dismiss_locked(&job, errp);
 164     aio_context_release(aio_context);
 165 }
 166
 167 static JobInfo *job_query_single(Job *job, Error **errp)
 168 {
 169     JobInfo *info;
 170     uint64_t progress_current;
 171     uint64_t progress_total;
 172
 173     assert(!job_is_internal(job));
 174     progress_get_snapshot(&job->progress, &progress_current,
 175                           &progress_total);
 176
 177     info = g_new(JobInfo, 1);
 178     *info = (JobInfo) {
 179         .id                 = g_strdup(job->id),
 180         .type               = job_type(job),
 181         .status             = job->status,
 182         .current_progress   = progress_current,
 183         .total_progress     = progress_total,
 184         .has_error          = !!job->err,
 185         .error              = job->err ? \
 186                               g_strdup(error_get_pretty(job->err)) : NULL,
 187     };
 188
 189     return info;
 190 }
 191
 192 JobInfoList *qmp_query_jobs(Error **errp)
 193 {
 194     JobInfoList *head = NULL, **tail = &head;
 195     Job *job;
 196
 197     for (job = job_next(NULL); job; job = job_next(job)) {
 198         JobInfo *value;
 199         AioContext *aio_context;
 200
 201         if (job_is_internal(job)) {
 202             continue;
 203         }
 204         aio_context = job->aio_context;
 205         aio_context_acquire(aio_context);
 206         value = job_query_single(job, errp);
 207         aio_context_release(aio_context);
 208         if (!value) {
 209             qapi_free_JobInfoList(head);
 210             return NULL;
 211         }
 212         QAPI_LIST_APPEND(tail, value);
 213     }
 214
 215     return head;
 216 }