Debian Codegraph @

src/shared/varlink-io.systemd.Job.c

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include "varlink-io.systemd.Job.h"
4
5 /* Keep in sync with job_type_table[] in src/core/job.c */
6 SD_VARLINK_DEFINE_ENUM_TYPE(
7 JobType,
8 SD_VARLINK_DEFINE_ENUM_VALUE(start),
9 SD_VARLINK_DEFINE_ENUM_VALUE(verify_active),
10 SD_VARLINK_DEFINE_ENUM_VALUE(stop),
11 SD_VARLINK_DEFINE_ENUM_VALUE(reload),
12 SD_VARLINK_DEFINE_ENUM_VALUE(reload_or_start),
13 SD_VARLINK_DEFINE_ENUM_VALUE(restart),
14 SD_VARLINK_DEFINE_ENUM_VALUE(try_restart),
15 SD_VARLINK_DEFINE_ENUM_VALUE(try_reload),
16 SD_VARLINK_DEFINE_ENUM_VALUE(nop));
17
18 /* Keep in sync with job_state_table[] in src/core/job.c */
19 SD_VARLINK_DEFINE_ENUM_TYPE(
20 JobState,
21 SD_VARLINK_DEFINE_ENUM_VALUE(waiting),
22 SD_VARLINK_DEFINE_ENUM_VALUE(running),
23 SD_VARLINK_DEFINE_ENUM_VALUE(finished));
24
25 /* Keep in sync with job_result_table[] in src/core/job.c */
26 SD_VARLINK_DEFINE_ENUM_TYPE(
27 JobResult,
28 SD_VARLINK_DEFINE_ENUM_VALUE(done),
29 SD_VARLINK_DEFINE_ENUM_VALUE(canceled),
30 SD_VARLINK_DEFINE_ENUM_VALUE(timeout),
31 SD_VARLINK_DEFINE_ENUM_VALUE(failed),
32 SD_VARLINK_DEFINE_ENUM_VALUE(dependency),
33 SD_VARLINK_DEFINE_ENUM_VALUE(skipped),
34 SD_VARLINK_DEFINE_ENUM_VALUE(invalid),
35 SD_VARLINK_DEFINE_ENUM_VALUE(assert),
36 SD_VARLINK_DEFINE_ENUM_VALUE(unsupported),
37 SD_VARLINK_DEFINE_ENUM_VALUE(collected),
38 SD_VARLINK_DEFINE_ENUM_VALUE(once),
39 SD_VARLINK_DEFINE_ENUM_VALUE(frozen),
40 SD_VARLINK_DEFINE_ENUM_VALUE(concurrency));
41
42 /* Field names match the D-Bus Job properties (Id, Unit, JobType, State) */
43 #define VARLINK_DEFINE_JOB_FIELDS(direction) \
44 SD_VARLINK_FIELD_COMMENT("The numeric job ID"), \
45 SD_VARLINK_DEFINE_##direction(Id, SD_VARLINK_INT, 0), \
46 SD_VARLINK_FIELD_COMMENT("The unit name this job operates on"), \
47 SD_VARLINK_DEFINE_##direction(Unit, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), \
48 SD_VARLINK_FIELD_COMMENT("The job type"), \
49 SD_VARLINK_DEFINE_##direction##_BY_TYPE(JobType, JobType, 0), \
50 SD_VARLINK_FIELD_COMMENT("Current job state. 'finished' indicates the job has completed; in that case Result is also set."), \
51 SD_VARLINK_DEFINE_##direction##_BY_TYPE(State, JobState, SD_VARLINK_NULLABLE), \
52 SD_VARLINK_FIELD_COMMENT("Job result. Only set once the job has reached the 'finished' state."), \
53 SD_VARLINK_DEFINE_##direction##_BY_TYPE(Result, JobResult, SD_VARLINK_NULLABLE), \
54 SD_VARLINK_FIELD_COMMENT("Activation details describing what triggered this job, as key-value pairs"), \
55 SD_VARLINK_DEFINE_##direction(ActivationDetails, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_MAP)
56
57 SD_VARLINK_DEFINE_STRUCT_TYPE(
58 Job,
59 VARLINK_DEFINE_JOB_FIELDS(FIELD));
60
61 static SD_VARLINK_DEFINE_ERROR(
62 NoSuchJob,
63 SD_VARLINK_DEFINE_FIELD(parameter, SD_VARLINK_STRING, SD_VARLINK_NULLABLE));
64
65 static SD_VARLINK_DEFINE_METHOD_FULL(
66 List,
67 SD_VARLINK_SUPPORTS_MORE,
68 SD_VARLINK_FIELD_COMMENT("If non-null, filter by job ID"),
69 SD_VARLINK_DEFINE_INPUT(id, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
70 SD_VARLINK_FIELD_COMMENT("If non-null, filter by unit name"),
71 SD_VARLINK_DEFINE_INPUT(unit, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
72 VARLINK_DEFINE_JOB_FIELDS(OUTPUT));
73
74 static SD_VARLINK_DEFINE_METHOD(
75 Cancel,
76 SD_VARLINK_FIELD_COMMENT("The job ID to cancel"),
77 SD_VARLINK_DEFINE_INPUT(id, SD_VARLINK_INT, 0));
78
79 static SD_VARLINK_DEFINE_METHOD(
80 ClearAll);
81
82 SD_VARLINK_DEFINE_INTERFACE(
83 io_systemd_Job,
84 "io.systemd.Job",
85 SD_VARLINK_INTERFACE_COMMENT("Job management interface for the systemd service manager."),
86 SD_VARLINK_SYMBOL_COMMENT("List queued jobs"),
87 &vl_method_List,
88 SD_VARLINK_SYMBOL_COMMENT("Cancel a specific job"),
89 &vl_method_Cancel,
90 SD_VARLINK_SYMBOL_COMMENT("Cancel all pending jobs"),
91 &vl_method_ClearAll,
92 SD_VARLINK_SYMBOL_COMMENT("Job type"),
93 &vl_type_JobType,
94 SD_VARLINK_SYMBOL_COMMENT("Job state"),
95 &vl_type_JobState,
96 SD_VARLINK_SYMBOL_COMMENT("Job result"),
97 &vl_type_JobResult,
98 SD_VARLINK_SYMBOL_COMMENT("A job object"),
99 &vl_type_Job,
100 SD_VARLINK_SYMBOL_COMMENT("The specified job does not exist"),
101 &vl_error_NoSuchJob);