2 * Background jobs (long-running operations)
4 * Copyright (c) 2011 IBM Corp.
5 * Copyright (c) 2012, 2018 Red Hat, Inc.
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "qapi/error.h"
31 #include "qemu/main-loop.h"
32 #include "trace-root.h"
34 static QLIST_HEAD(, Job
) jobs
= QLIST_HEAD_INITIALIZER(jobs
);
36 /* Job State Transition Table */
37 bool JobSTT
[JOB_STATUS__MAX
][JOB_STATUS__MAX
] = {
38 /* U, C, R, P, Y, S, W, D, X, E, N */
39 /* U: */ [JOB_STATUS_UNDEFINED
] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0},
40 /* C: */ [JOB_STATUS_CREATED
] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1},
41 /* R: */ [JOB_STATUS_RUNNING
] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0},
42 /* P: */ [JOB_STATUS_PAUSED
] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0},
43 /* Y: */ [JOB_STATUS_READY
] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0},
44 /* S: */ [JOB_STATUS_STANDBY
] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0},
45 /* W: */ [JOB_STATUS_WAITING
] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0},
46 /* D: */ [JOB_STATUS_PENDING
] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0},
47 /* X: */ [JOB_STATUS_ABORTING
] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0},
48 /* E: */ [JOB_STATUS_CONCLUDED
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1},
49 /* N: */ [JOB_STATUS_NULL
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
52 bool JobVerbTable
[JOB_VERB__MAX
][JOB_STATUS__MAX
] = {
53 /* U, C, R, P, Y, S, W, D, X, E, N */
54 [JOB_VERB_CANCEL
] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0},
55 [JOB_VERB_PAUSE
] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
56 [JOB_VERB_RESUME
] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
57 [JOB_VERB_SET_SPEED
] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
58 [JOB_VERB_COMPLETE
] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0},
59 [JOB_VERB_FINALIZE
] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0},
60 [JOB_VERB_DISMISS
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0},
63 /* TODO Make static once the whole state machine is in job.c */
64 void job_state_transition(Job
*job
, JobStatus s1
)
66 JobStatus s0
= job
->status
;
67 assert(s1
>= 0 && s1
<= JOB_STATUS__MAX
);
68 trace_job_state_transition(job
, /* TODO re-enable: job->ret */ 0,
69 JobSTT
[s0
][s1
] ? "allowed" : "disallowed",
70 JobStatus_str(s0
), JobStatus_str(s1
));
71 assert(JobSTT
[s0
][s1
]);
75 int job_apply_verb(Job
*job
, JobVerb verb
, Error
**errp
)
77 JobStatus s0
= job
->status
;
78 assert(verb
>= 0 && verb
<= JOB_VERB__MAX
);
79 trace_job_apply_verb(job
, JobStatus_str(s0
), JobVerb_str(verb
),
80 JobVerbTable
[verb
][s0
] ? "allowed" : "prohibited");
81 if (JobVerbTable
[verb
][s0
]) {
84 error_setg(errp
, "Job '%s' in state '%s' cannot accept command verb '%s'",
85 job
->id
, JobStatus_str(s0
), JobVerb_str(verb
));
89 JobType
job_type(const Job
*job
)
91 return job
->driver
->job_type
;
94 const char *job_type_str(const Job
*job
)
96 return JobType_str(job_type(job
));
99 bool job_is_cancelled(Job
*job
)
101 return job
->cancelled
;
104 Job
*job_next(Job
*job
)
107 return QLIST_FIRST(&jobs
);
109 return QLIST_NEXT(job
, job_list
);
112 Job
*job_get(const char *id
)
116 QLIST_FOREACH(job
, &jobs
, job_list
) {
117 if (job
->id
&& !strcmp(id
, job
->id
)) {
125 void *job_create(const char *job_id
, const JobDriver
*driver
, AioContext
*ctx
,
131 if (!id_wellformed(job_id
)) {
132 error_setg(errp
, "Invalid job ID '%s'", job_id
);
135 if (job_get(job_id
)) {
136 error_setg(errp
, "Job ID '%s' already in use", job_id
);
141 job
= g_malloc0(driver
->instance_size
);
142 job
->driver
= driver
;
143 job
->id
= g_strdup(job_id
);
145 job
->aio_context
= ctx
;
147 job_state_transition(job
, JOB_STATUS_CREATED
);
149 QLIST_INSERT_HEAD(&jobs
, job
, job_list
);
154 void job_ref(Job
*job
)
159 void job_unref(Job
*job
)
161 if (--job
->refcnt
== 0) {
162 assert(job
->status
== JOB_STATUS_NULL
);
164 if (job
->driver
->free
) {
165 job
->driver
->free(job
);
168 QLIST_REMOVE(job
, job_list
);
177 JobDeferToMainLoopFn
*fn
;
179 } JobDeferToMainLoopData
;
181 static void job_defer_to_main_loop_bh(void *opaque
)
183 JobDeferToMainLoopData
*data
= opaque
;
184 Job
*job
= data
->job
;
185 AioContext
*aio_context
= job
->aio_context
;
187 aio_context_acquire(aio_context
);
188 data
->fn(data
->job
, data
->opaque
);
189 aio_context_release(aio_context
);
194 void job_defer_to_main_loop(Job
*job
, JobDeferToMainLoopFn
*fn
, void *opaque
)
196 JobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
199 data
->opaque
= opaque
;
200 job
->deferred_to_main_loop
= true;
202 aio_bh_schedule_oneshot(qemu_get_aio_context(),
203 job_defer_to_main_loop_bh
, data
);