Debian Codegraph @

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

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include "varlink-io.systemd.MachineInstance.h"
4
5 static SD_VARLINK_DEFINE_METHOD(Terminate);
6 static SD_VARLINK_DEFINE_METHOD(PowerOff);
7 static SD_VARLINK_DEFINE_METHOD(Reboot);
8 static SD_VARLINK_DEFINE_METHOD(Pause);
9 static SD_VARLINK_DEFINE_METHOD(Resume);
10
11 static SD_VARLINK_DEFINE_METHOD(
12 Describe,
13 SD_VARLINK_FIELD_COMMENT("True iff vCPUs are executing"),
14 SD_VARLINK_DEFINE_OUTPUT(running, SD_VARLINK_BOOL, 0),
15 SD_VARLINK_FIELD_COMMENT("Backend-specific state string (e.g. 'running', 'paused', 'shutdown'); 'unknown' if unavailable"),
16 SD_VARLINK_DEFINE_OUTPUT(status, SD_VARLINK_STRING, 0));
17
18 static SD_VARLINK_DEFINE_METHOD_FULL(
19 SubscribeEvents,
20 SD_VARLINK_REQUIRES_MORE,
21 SD_VARLINK_FIELD_COMMENT("If specified, only deliver events whose name matches one of these strings; null means all events"),
22 SD_VARLINK_DEFINE_INPUT(filter, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY),
23 SD_VARLINK_FIELD_COMMENT("Name of the event"),
24 SD_VARLINK_DEFINE_OUTPUT(event, SD_VARLINK_STRING, 0),
25 SD_VARLINK_FIELD_COMMENT("Event-specific payload"),
26 SD_VARLINK_DEFINE_OUTPUT(data, SD_VARLINK_OBJECT, SD_VARLINK_NULLABLE));
27
28 static SD_VARLINK_DEFINE_METHOD(
29 AddStorage,
30 SD_VARLINK_FIELD_COMMENT("Index of the attached file descriptor for the storage volume"),
31 SD_VARLINK_DEFINE_INPUT(fileDescriptorIndex, SD_VARLINK_INT, 0),
32 SD_VARLINK_FIELD_COMMENT("Caller-supplied identifier for this binding (any non-empty string; machinectl uses '<provider>:<volume>' from the StorageProvider, but the form is not required)"),
33 SD_VARLINK_DEFINE_INPUT(name, SD_VARLINK_STRING, 0),
34 SD_VARLINK_FIELD_COMMENT("Backend-specific configuration"),
35 SD_VARLINK_DEFINE_INPUT(config, SD_VARLINK_STRING, SD_VARLINK_NULLABLE));
36
37 static SD_VARLINK_DEFINE_METHOD(
38 RemoveStorage,
39 SD_VARLINK_FIELD_COMMENT("Identifier of the binding to detach (as supplied to AddStorage)"),
40 SD_VARLINK_DEFINE_INPUT(name, SD_VARLINK_STRING, 0));
41
42 static SD_VARLINK_DEFINE_METHOD(
43 ReplaceStorage,
44 SD_VARLINK_FIELD_COMMENT("Index of the attached file descriptor for the new backing storage"),
45 SD_VARLINK_DEFINE_INPUT(fileDescriptorIndex, SD_VARLINK_INT, 0),
46 SD_VARLINK_FIELD_COMMENT("Identifier of the existing binding whose backing is being replaced (as supplied to AddStorage)"),
47 SD_VARLINK_DEFINE_INPUT(name, SD_VARLINK_STRING, 0));
48
49 static SD_VARLINK_DEFINE_ERROR(NotConnected);
50 static SD_VARLINK_DEFINE_ERROR(NotSupported);
51 static SD_VARLINK_DEFINE_ERROR(NoSuchStorage);
52 static SD_VARLINK_DEFINE_ERROR(StorageExists);
53 static SD_VARLINK_DEFINE_ERROR(StorageImmutable);
54 static SD_VARLINK_DEFINE_ERROR(BadConfig);
55 static SD_VARLINK_DEFINE_ERROR(ConfigNotSupported);
56
57 SD_VARLINK_DEFINE_INTERFACE(
58 io_systemd_MachineInstance,
59 "io.systemd.MachineInstance",
60 SD_VARLINK_SYMBOL_COMMENT("Forcefully terminate the machine immediately"),
61 &vl_method_Terminate,
62 SD_VARLINK_SYMBOL_COMMENT("Request a clean shutdown of the machine"),
63 &vl_method_PowerOff,
64 SD_VARLINK_SYMBOL_COMMENT("Reboot the machine"),
65 &vl_method_Reboot,
66 SD_VARLINK_SYMBOL_COMMENT("Pause/freeze the machine"),
67 &vl_method_Pause,
68 SD_VARLINK_SYMBOL_COMMENT("Resume a paused machine"),
69 &vl_method_Resume,
70 SD_VARLINK_SYMBOL_COMMENT("Query the current status of the machine"),
71 &vl_method_Describe,
72 SD_VARLINK_SYMBOL_COMMENT("Subscribe to machine events. Returns a stream of events as they occur."),
73 &vl_method_SubscribeEvents,
74 SD_VARLINK_SYMBOL_COMMENT("Attach a storage volume (passed via file descriptor) to the running machine"),
75 &vl_method_AddStorage,
76 SD_VARLINK_SYMBOL_COMMENT("Detach a previously-attached storage volume from the running machine"),
77 &vl_method_RemoveStorage,
78 SD_VARLINK_SYMBOL_COMMENT("Replace the backing of a previously-attached storage volume in place"),
79 &vl_method_ReplaceStorage,
80 SD_VARLINK_SYMBOL_COMMENT("The connection to the machine backend is not available"),
81 &vl_error_NotConnected,
82 SD_VARLINK_SYMBOL_COMMENT("The requested operation is not supported"),
83 &vl_error_NotSupported,
84 SD_VARLINK_SYMBOL_COMMENT("The named storage binding does not exist"),
85 &vl_error_NoSuchStorage,
86 SD_VARLINK_SYMBOL_COMMENT("A storage binding with this name already exists"),
87 &vl_error_StorageExists,
88 SD_VARLINK_SYMBOL_COMMENT("The storage binding cannot be detached at runtime (e.g. attached at boot)"),
89 &vl_error_StorageImmutable,
90 SD_VARLINK_SYMBOL_COMMENT("The supplied 'config' value is not valid for this backend"),
91 &vl_error_BadConfig,
92 SD_VARLINK_SYMBOL_COMMENT("The supplied 'config' value is recognized but not supported by this backend"),
93 &vl_error_ConfigNotSupported);