| 1 |
/* SPDX-License-Identifier: LGPL-2.1-or-later */ |
| 2 |
|
| 3 |
#include "bus-polkit.h" |
| 4 |
#include "varlink-io.systemd.MachineImage.h" |
| 5 |
|
| 6 |
static SD_VARLINK_DEFINE_ENUM_TYPE( |
| 7 |
AcquireMetadata, |
| 8 |
SD_VARLINK_FIELD_COMMENT("Do not include metadata in the output"), |
| 9 |
SD_VARLINK_DEFINE_ENUM_VALUE(no), |
| 10 |
SD_VARLINK_FIELD_COMMENT("Include metadata in the output"), |
| 11 |
SD_VARLINK_DEFINE_ENUM_VALUE(yes), |
| 12 |
SD_VARLINK_FIELD_COMMENT("Include metadata in the output, but gracefully eat up errors"), |
| 13 |
SD_VARLINK_DEFINE_ENUM_VALUE(graceful)); |
| 14 |
|
| 15 |
static SD_VARLINK_DEFINE_METHOD_FULL( |
| 16 |
List, |
| 17 |
SD_VARLINK_SUPPORTS_MORE, |
| 18 |
SD_VARLINK_FIELD_COMMENT("If non-null the name of a image to report details on."), |
| 19 |
SD_VARLINK_DEFINE_INPUT(name, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 20 |
SD_VARLINK_FIELD_COMMENT("If true the output will include image metadata fields such as 'machineInfo' and 'OSRelease'."), |
| 21 |
SD_VARLINK_DEFINE_INPUT_BY_TYPE(acquireMetadata, AcquireMetadata, SD_VARLINK_NULLABLE), |
| 22 |
VARLINK_DEFINE_POLKIT_INPUT, |
| 23 |
SD_VARLINK_FIELD_COMMENT("Name of the image"), |
| 24 |
SD_VARLINK_DEFINE_OUTPUT(name, SD_VARLINK_STRING, 0), |
| 25 |
SD_VARLINK_FIELD_COMMENT("The file system path where image is stored"), |
| 26 |
SD_VARLINK_DEFINE_OUTPUT(path, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 27 |
SD_VARLINK_FIELD_COMMENT("The type of this image"), |
| 28 |
SD_VARLINK_DEFINE_OUTPUT(type, SD_VARLINK_STRING, 0), |
| 29 |
SD_VARLINK_FIELD_COMMENT("The class of this image"), |
| 30 |
SD_VARLINK_DEFINE_OUTPUT(class, SD_VARLINK_STRING, 0), |
| 31 |
SD_VARLINK_FIELD_COMMENT("Whether the image is read-only"), |
| 32 |
SD_VARLINK_DEFINE_OUTPUT(readOnly, SD_VARLINK_BOOL, 0), |
| 33 |
SD_VARLINK_FIELD_COMMENT("The image creation timestamp"), |
| 34 |
SD_VARLINK_DEFINE_OUTPUT(creationTimestamp, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 35 |
SD_VARLINK_FIELD_COMMENT("The image creation timestamp"), |
| 36 |
SD_VARLINK_DEFINE_OUTPUT(modificationTimestamp, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 37 |
SD_VARLINK_FIELD_COMMENT("The image creation timestamp"), |
| 38 |
SD_VARLINK_DEFINE_OUTPUT(usage, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 39 |
SD_VARLINK_FIELD_COMMENT("The image disk usage (exclusive)"), |
| 40 |
SD_VARLINK_DEFINE_OUTPUT(usageExclusive, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 41 |
SD_VARLINK_FIELD_COMMENT("The image disk usage (exclusive)"), |
| 42 |
SD_VARLINK_DEFINE_OUTPUT(limit, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 43 |
SD_VARLINK_FIELD_COMMENT("The image disk usage limit (exclusive)"), |
| 44 |
SD_VARLINK_DEFINE_OUTPUT(limitExclusive, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 45 |
SD_VARLINK_FIELD_COMMENT("The hostname of the image"), |
| 46 |
SD_VARLINK_DEFINE_OUTPUT(hostname, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 47 |
SD_VARLINK_FIELD_COMMENT("The machine ID of the image"), |
| 48 |
SD_VARLINK_DEFINE_OUTPUT(machineId, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 49 |
SD_VARLINK_FIELD_COMMENT("Machine info information of an image. It contains an array of key value pairs read from the machine-info(5) file in the image."), |
| 50 |
SD_VARLINK_DEFINE_OUTPUT(machineInfo, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY), |
| 51 |
SD_VARLINK_FIELD_COMMENT("OS release information of an image. It contains an array of key value pairs read from the os-release(5) file in the image."), |
| 52 |
SD_VARLINK_DEFINE_OUTPUT(OSRelease, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY)); |
| 53 |
|
| 54 |
#define VARLINK_DEFINE_IMAGE_LOOKUP_AND_POLKIT_FIELDS \ |
| 55 |
SD_VARLINK_FIELD_COMMENT("The name of an image"), \ |
| 56 |
SD_VARLINK_DEFINE_INPUT(name, SD_VARLINK_STRING, 0), \ |
| 57 |
VARLINK_DEFINE_POLKIT_INPUT |
| 58 |
|
| 59 |
static SD_VARLINK_DEFINE_METHOD( |
| 60 |
Update, |
| 61 |
VARLINK_DEFINE_IMAGE_LOOKUP_AND_POLKIT_FIELDS, |
| 62 |
SD_VARLINK_FIELD_COMMENT("If non-null the new name of the image"), |
| 63 |
SD_VARLINK_DEFINE_INPUT(newName, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 64 |
SD_VARLINK_FIELD_COMMENT("If non-null value of the read-only flag of the image"), |
| 65 |
SD_VARLINK_DEFINE_INPUT(readOnly, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE), |
| 66 |
SD_VARLINK_FIELD_COMMENT("If non-null value of image quota limit"), |
| 67 |
SD_VARLINK_DEFINE_INPUT(limit, SD_VARLINK_INT, SD_VARLINK_NULLABLE)); |
| 68 |
|
| 69 |
static SD_VARLINK_DEFINE_METHOD( |
| 70 |
Clone, |
| 71 |
VARLINK_DEFINE_IMAGE_LOOKUP_AND_POLKIT_FIELDS, |
| 72 |
SD_VARLINK_FIELD_COMMENT("The new name of the image"), |
| 73 |
SD_VARLINK_DEFINE_INPUT(newName, SD_VARLINK_STRING, 0), |
| 74 |
SD_VARLINK_FIELD_COMMENT("If non-null value of the read-only flag of the image"), |
| 75 |
SD_VARLINK_DEFINE_INPUT(readOnly, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE)); |
| 76 |
|
| 77 |
static SD_VARLINK_DEFINE_METHOD( |
| 78 |
Remove, |
| 79 |
VARLINK_DEFINE_IMAGE_LOOKUP_AND_POLKIT_FIELDS); |
| 80 |
|
| 81 |
static SD_VARLINK_DEFINE_METHOD( |
| 82 |
SetPoolLimit, |
| 83 |
VARLINK_DEFINE_POLKIT_INPUT, |
| 84 |
SD_VARLINK_FIELD_COMMENT("New image quota limit"), |
| 85 |
SD_VARLINK_DEFINE_INPUT(limit, SD_VARLINK_INT, 0)); |
| 86 |
|
| 87 |
static SD_VARLINK_DEFINE_ENUM_TYPE( |
| 88 |
CleanPoolMode, |
| 89 |
SD_VARLINK_FIELD_COMMENT("Remove all unused images"), |
| 90 |
SD_VARLINK_DEFINE_ENUM_VALUE(all), |
| 91 |
SD_VARLINK_FIELD_COMMENT("Remove only hidden images"), |
| 92 |
SD_VARLINK_DEFINE_ENUM_VALUE(hidden)); |
| 93 |
|
| 94 |
static SD_VARLINK_DEFINE_METHOD_FULL( |
| 95 |
CleanPool, |
| 96 |
SD_VARLINK_REQUIRES_MORE, |
| 97 |
VARLINK_DEFINE_POLKIT_INPUT, |
| 98 |
SD_VARLINK_FIELD_COMMENT("Allows removing all or only hidden images"), |
| 99 |
SD_VARLINK_DEFINE_INPUT_BY_TYPE(mode, CleanPoolMode, 0), |
| 100 |
SD_VARLINK_FIELD_COMMENT("Image name"), |
| 101 |
SD_VARLINK_DEFINE_OUTPUT(name, SD_VARLINK_STRING, 0), |
| 102 |
SD_VARLINK_FIELD_COMMENT("The image disk usage (exclusive)"), |
| 103 |
SD_VARLINK_DEFINE_OUTPUT(usageExclusive, SD_VARLINK_INT, SD_VARLINK_NULLABLE)); |
| 104 |
|
| 105 |
static SD_VARLINK_DEFINE_ERROR(NoSuchImage); |
| 106 |
static SD_VARLINK_DEFINE_ERROR(TooManyOperations); |
| 107 |
static SD_VARLINK_DEFINE_ERROR(NotSupported); |
| 108 |
|
| 109 |
SD_VARLINK_DEFINE_INTERFACE( |
| 110 |
io_systemd_MachineImage, |
| 111 |
"io.systemd.MachineImage", |
| 112 |
SD_VARLINK_SYMBOL_COMMENT("A enum field allowing to gracefully get metadata"), |
| 113 |
&vl_type_AcquireMetadata, |
| 114 |
SD_VARLINK_SYMBOL_COMMENT("List images"), |
| 115 |
&vl_method_List, |
| 116 |
SD_VARLINK_SYMBOL_COMMENT("Update image allowing to rename, toggle read-only flag, or set a limit"), |
| 117 |
&vl_method_Update, |
| 118 |
SD_VARLINK_SYMBOL_COMMENT("Clone image"), |
| 119 |
&vl_method_Clone, |
| 120 |
SD_VARLINK_SYMBOL_COMMENT("Remove image"), |
| 121 |
&vl_method_Remove, |
| 122 |
SD_VARLINK_SYMBOL_COMMENT("Sets an overall quota limit on the pool of images"), |
| 123 |
&vl_method_SetPoolLimit, |
| 124 |
SD_VARLINK_SYMBOL_COMMENT("A enum field allowing to control what type of images are cleaned up"), |
| 125 |
&vl_type_CleanPoolMode, |
| 126 |
SD_VARLINK_SYMBOL_COMMENT("Clean unused images depending on the specified mode. Note that it does not process vendon and host images."), |
| 127 |
&vl_method_CleanPool, |
| 128 |
SD_VARLINK_SYMBOL_COMMENT("No matching image exists"), |
| 129 |
&vl_error_NoSuchImage, |
| 130 |
SD_VARLINK_SYMBOL_COMMENT("Too many ongoing background operations"), |
| 131 |
&vl_error_TooManyOperations, |
| 132 |
SD_VARLINK_SYMBOL_COMMENT("Requested operation is not supported"), |
| 133 |
&vl_error_NotSupported); |