Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 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" |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 27 | #include "qemu/job.h" |
| 28 | #include "qapi/qapi-commands-job.h" |
| 29 | #include "qapi/error.h" |
Paolo Bonzini | 243af02 | 2020-02-04 12:20:10 +0100 | [diff] [blame] | 30 | #include "trace/trace-root.h" |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 31 | |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 32 | /* |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 33 | * Get a job using its ID. Called with job_mutex held. |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 34 | */ |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 35 | static Job *find_job_locked(const char *id, Error **errp) |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 36 | { |
| 37 | Job *job; |
| 38 | |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 39 | job = job_get_locked(id); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 40 | if (!job) { |
| 41 | error_setg(errp, "Job not found"); |
| 42 | return NULL; |
| 43 | } |
| 44 | |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 45 | return job; |
| 46 | } |
| 47 | |
| 48 | void qmp_job_cancel(const char *id, Error **errp) |
| 49 | { |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 50 | Job *job; |
| 51 | |
| 52 | JOB_LOCK_GUARD(); |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 53 | job = find_job_locked(id, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 54 | |
| 55 | if (!job) { |
| 56 | return; |
| 57 | } |
| 58 | |
| 59 | trace_qmp_job_cancel(job); |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 60 | job_user_cancel_locked(job, true, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | void qmp_job_pause(const char *id, Error **errp) |
| 64 | { |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 65 | Job *job; |
| 66 | |
| 67 | JOB_LOCK_GUARD(); |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 68 | job = find_job_locked(id, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 69 | |
| 70 | if (!job) { |
| 71 | return; |
| 72 | } |
| 73 | |
| 74 | trace_qmp_job_pause(job); |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 75 | job_user_pause_locked(job, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 76 | } |
| 77 | |
| 78 | void qmp_job_resume(const char *id, Error **errp) |
| 79 | { |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 80 | Job *job; |
| 81 | |
| 82 | JOB_LOCK_GUARD(); |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 83 | job = find_job_locked(id, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 84 | |
| 85 | if (!job) { |
| 86 | return; |
| 87 | } |
| 88 | |
| 89 | trace_qmp_job_resume(job); |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 90 | job_user_resume_locked(job, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 91 | } |
| 92 | |
| 93 | void qmp_job_complete(const char *id, Error **errp) |
| 94 | { |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 95 | Job *job; |
| 96 | |
| 97 | JOB_LOCK_GUARD(); |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 98 | job = find_job_locked(id, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 99 | |
| 100 | if (!job) { |
| 101 | return; |
| 102 | } |
| 103 | |
| 104 | trace_qmp_job_complete(job); |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 105 | job_complete_locked(job, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 106 | } |
| 107 | |
| 108 | void qmp_job_finalize(const char *id, Error **errp) |
| 109 | { |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 110 | Job *job; |
| 111 | |
| 112 | JOB_LOCK_GUARD(); |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 113 | job = find_job_locked(id, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 114 | |
| 115 | if (!job) { |
| 116 | return; |
| 117 | } |
| 118 | |
| 119 | trace_qmp_job_finalize(job); |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 120 | job_ref_locked(job); |
| 121 | job_finalize_locked(job, errp); |
Stefan Reiter | b660a84 | 2020-04-07 13:56:49 +0200 | [diff] [blame] | 122 | |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 123 | job_unref_locked(job); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | void qmp_job_dismiss(const char *id, Error **errp) |
| 127 | { |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 128 | Job *job; |
| 129 | |
| 130 | JOB_LOCK_GUARD(); |
Emanuele Giuseppe Esposito | 6f592e5 | 2022-09-26 05:32:11 -0400 | [diff] [blame] | 131 | job = find_job_locked(id, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 132 | |
| 133 | if (!job) { |
| 134 | return; |
| 135 | } |
| 136 | |
| 137 | trace_qmp_job_dismiss(job); |
Emanuele Giuseppe Esposito | 9624112 | 2022-09-26 05:32:01 -0400 | [diff] [blame] | 138 | job_dismiss_locked(&job, errp); |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 139 | } |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 140 | |
Emanuele Giuseppe Esposito | 880eeec | 2022-09-26 05:32:04 -0400 | [diff] [blame] | 141 | /* Called with job_mutex held. */ |
| 142 | static JobInfo *job_query_single_locked(Job *job, Error **errp) |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 143 | { |
| 144 | JobInfo *info; |
Emanuele Giuseppe Esposito | a7b4f8f | 2021-06-14 10:11:29 +0200 | [diff] [blame] | 145 | uint64_t progress_current; |
| 146 | uint64_t progress_total; |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 147 | |
| 148 | assert(!job_is_internal(job)); |
Emanuele Giuseppe Esposito | a7b4f8f | 2021-06-14 10:11:29 +0200 | [diff] [blame] | 149 | progress_get_snapshot(&job->progress, &progress_current, |
| 150 | &progress_total); |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 151 | |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 152 | info = g_new(JobInfo, 1); |
| 153 | *info = (JobInfo) { |
| 154 | .id = g_strdup(job->id), |
| 155 | .type = job_type(job), |
| 156 | .status = job->status, |
Emanuele Giuseppe Esposito | a7b4f8f | 2021-06-14 10:11:29 +0200 | [diff] [blame] | 157 | .current_progress = progress_current, |
| 158 | .total_progress = progress_total, |
Markus Armbruster | 107111b | 2022-11-04 17:06:56 +0100 | [diff] [blame] | 159 | .error = job->err ? |
John Snow | 3d1f8b0 | 2018-08-29 21:57:27 -0400 | [diff] [blame] | 160 | g_strdup(error_get_pretty(job->err)) : NULL, |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 161 | }; |
| 162 | |
| 163 | return info; |
| 164 | } |
| 165 | |
| 166 | JobInfoList *qmp_query_jobs(Error **errp) |
| 167 | { |
Eric Blake | c3033fd | 2021-01-13 16:10:12 -0600 | [diff] [blame] | 168 | JobInfoList *head = NULL, **tail = &head; |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 169 | Job *job; |
| 170 | |
Emanuele Giuseppe Esposito | 880eeec | 2022-09-26 05:32:04 -0400 | [diff] [blame] | 171 | JOB_LOCK_GUARD(); |
| 172 | |
| 173 | for (job = job_next_locked(NULL); job; job = job_next_locked(job)) { |
Eric Blake | c3033fd | 2021-01-13 16:10:12 -0600 | [diff] [blame] | 174 | JobInfo *value; |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 175 | |
| 176 | if (job_is_internal(job)) { |
| 177 | continue; |
| 178 | } |
Emanuele Giuseppe Esposito | 880eeec | 2022-09-26 05:32:04 -0400 | [diff] [blame] | 179 | value = job_query_single_locked(job, errp); |
Eric Blake | c3033fd | 2021-01-13 16:10:12 -0600 | [diff] [blame] | 180 | if (!value) { |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 181 | qapi_free_JobInfoList(head); |
| 182 | return NULL; |
| 183 | } |
Eric Blake | c3033fd | 2021-01-13 16:10:12 -0600 | [diff] [blame] | 184 | QAPI_LIST_APPEND(tail, value); |
Kevin Wolf | 456273b | 2018-05-04 16:25:43 +0200 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | return head; |
| 188 | } |