]>
Commit | Line | Data |
---|---|---|
c2f1db8f | 1 | #pragma once |
83096483 LP |
2 | |
3 | /*** | |
4 | This file is part of systemd. | |
5 | ||
6 | Copyright 2011 Lennart Poettering | |
7 | ||
8 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
9 | under the terms of the GNU Lesser General Public License as published by |
10 | the Free Software Foundation; either version 2.1 of the License, or | |
83096483 LP |
11 | (at your option) any later version. |
12 | ||
13 | systemd is distributed in the hope that it will be useful, but | |
14 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 16 | Lesser General Public License for more details. |
83096483 | 17 | |
5430f7f2 | 18 | You should have received a copy of the GNU Lesser General Public License |
83096483 LP |
19 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
20 | ***/ | |
21 | ||
cab6235f LP |
22 | typedef enum UnitFileScope UnitFileScope; |
23 | typedef enum UnitFileState UnitFileState; | |
24 | typedef enum UnitFilePresetMode UnitFilePresetMode; | |
25 | typedef enum UnitFileChangeType UnitFileChangeType; | |
0ec0deaa | 26 | typedef enum UnitFileType UnitFileType; |
cab6235f LP |
27 | typedef struct UnitFileChange UnitFileChange; |
28 | typedef struct UnitFileList UnitFileList; | |
29 | typedef struct UnitFileInstallInfo UnitFileInstallInfo; | |
30 | ||
a8fbdf54 TA |
31 | #include <stdbool.h> |
32 | ||
83096483 | 33 | #include "hashmap.h" |
a8fbdf54 | 34 | #include "macro.h" |
a8ffe6fb | 35 | #include "path-lookup.h" |
0ec0deaa LP |
36 | #include "strv.h" |
37 | #include "unit-name.h" | |
83096483 | 38 | |
cab6235f | 39 | enum UnitFileScope { |
83096483 LP |
40 | UNIT_FILE_SYSTEM, |
41 | UNIT_FILE_GLOBAL, | |
42 | UNIT_FILE_USER, | |
43 | _UNIT_FILE_SCOPE_MAX, | |
44 | _UNIT_FILE_SCOPE_INVALID = -1 | |
cab6235f | 45 | }; |
83096483 | 46 | |
cab6235f | 47 | enum UnitFileState { |
83096483 LP |
48 | UNIT_FILE_ENABLED, |
49 | UNIT_FILE_ENABLED_RUNTIME, | |
50 | UNIT_FILE_LINKED, | |
51 | UNIT_FILE_LINKED_RUNTIME, | |
52 | UNIT_FILE_MASKED, | |
53 | UNIT_FILE_MASKED_RUNTIME, | |
54 | UNIT_FILE_STATIC, | |
55 | UNIT_FILE_DISABLED, | |
aedd4012 | 56 | UNIT_FILE_INDIRECT, |
f4139308 | 57 | UNIT_FILE_GENERATED, |
e4fca67f | 58 | UNIT_FILE_TRANSIENT, |
0ec0deaa | 59 | UNIT_FILE_BAD, |
83096483 LP |
60 | _UNIT_FILE_STATE_MAX, |
61 | _UNIT_FILE_STATE_INVALID = -1 | |
cab6235f | 62 | }; |
83096483 | 63 | |
cab6235f | 64 | enum UnitFilePresetMode { |
d309c1c3 LP |
65 | UNIT_FILE_PRESET_FULL, |
66 | UNIT_FILE_PRESET_ENABLE_ONLY, | |
67 | UNIT_FILE_PRESET_DISABLE_ONLY, | |
86bbe5bf | 68 | _UNIT_FILE_PRESET_MAX, |
d309c1c3 | 69 | _UNIT_FILE_PRESET_INVALID = -1 |
cab6235f | 70 | }; |
d309c1c3 | 71 | |
cab6235f | 72 | enum UnitFileChangeType { |
83096483 LP |
73 | UNIT_FILE_SYMLINK, |
74 | UNIT_FILE_UNLINK, | |
9a0a413a | 75 | UNIT_FILE_IS_MASKED, |
83096483 | 76 | _UNIT_FILE_CHANGE_TYPE_MAX, |
1fa03360 | 77 | _UNIT_FILE_CHANGE_INVALID = INT_MIN |
cab6235f | 78 | }; |
83096483 | 79 | |
af3d8113 ZJS |
80 | /* type can either one of the UnitFileChangeTypes listed above, or a negative error. |
81 | * If source is specified, it should be the contents of the path symlink. | |
82 | * In case of an error, source should be the existing symlink contents or NULL | |
83 | */ | |
cab6235f | 84 | struct UnitFileChange { |
af3d8113 | 85 | int type; /* UnitFileChangeType or bust */ |
83096483 LP |
86 | char *path; |
87 | char *source; | |
cab6235f | 88 | }; |
83096483 | 89 | |
795ff6d5 ZJS |
90 | static inline bool unit_file_changes_have_modification(const UnitFileChange* changes, unsigned n_changes) { |
91 | unsigned i; | |
92 | for (i = 0; i < n_changes; i++) | |
93 | if (IN_SET(changes[i].type, UNIT_FILE_SYMLINK, UNIT_FILE_UNLINK)) | |
94 | return true; | |
95 | return false; | |
96 | } | |
97 | ||
cab6235f | 98 | struct UnitFileList { |
83096483 LP |
99 | char *path; |
100 | UnitFileState state; | |
cab6235f | 101 | }; |
83096483 | 102 | |
0ec0deaa LP |
103 | enum UnitFileType { |
104 | UNIT_FILE_TYPE_REGULAR, | |
105 | UNIT_FILE_TYPE_SYMLINK, | |
106 | UNIT_FILE_TYPE_MASKED, | |
107 | _UNIT_FILE_TYPE_MAX, | |
108 | _UNIT_FILE_TYPE_INVALID = -1, | |
109 | }; | |
110 | ||
cab6235f | 111 | struct UnitFileInstallInfo { |
7584d236 ZJS |
112 | char *name; |
113 | char *path; | |
114 | ||
115 | char **aliases; | |
116 | char **wanted_by; | |
117 | char **required_by; | |
aedd4012 | 118 | char **also; |
d54c4993 LP |
119 | |
120 | char *default_instance; | |
0ec0deaa LP |
121 | |
122 | UnitFileType type; | |
123 | ||
124 | char *symlink_target; | |
cab6235f | 125 | }; |
7584d236 | 126 | |
0ec0deaa LP |
127 | static inline bool UNIT_FILE_INSTALL_INFO_HAS_RULES(UnitFileInstallInfo *i) { |
128 | assert(i); | |
129 | ||
130 | return !strv_isempty(i->aliases) || | |
131 | !strv_isempty(i->wanted_by) || | |
132 | !strv_isempty(i->required_by); | |
133 | } | |
134 | ||
135 | static inline bool UNIT_FILE_INSTALL_INFO_HAS_ALSO(UnitFileInstallInfo *i) { | |
136 | assert(i); | |
137 | ||
138 | return !strv_isempty(i->also); | |
139 | } | |
140 | ||
8a993b61 ZJS |
141 | bool unit_type_may_alias(UnitType type) _const_; |
142 | ||
596fc263 ZJS |
143 | int unit_file_enable( |
144 | UnitFileScope scope, | |
145 | bool runtime, | |
146 | const char *root_dir, | |
147 | char **files, | |
148 | bool force, | |
149 | UnitFileChange **changes, | |
150 | unsigned *n_changes); | |
151 | int unit_file_disable( | |
152 | UnitFileScope scope, | |
153 | bool runtime, | |
154 | const char *root_dir, | |
155 | char **files, | |
156 | UnitFileChange **changes, | |
157 | unsigned *n_changes); | |
158 | int unit_file_reenable( | |
159 | UnitFileScope scope, | |
160 | bool runtime, | |
161 | const char *root_dir, | |
162 | char **files, | |
163 | bool force, | |
164 | UnitFileChange **changes, | |
165 | unsigned *n_changes); | |
166 | int unit_file_preset( | |
167 | UnitFileScope scope, | |
168 | bool runtime, | |
169 | const char *root_dir, | |
170 | char **files, | |
171 | UnitFilePresetMode mode, | |
172 | bool force, | |
173 | UnitFileChange **changes, | |
174 | unsigned *n_changes); | |
175 | int unit_file_preset_all( | |
176 | UnitFileScope scope, | |
177 | bool runtime, | |
178 | const char *root_dir, | |
179 | UnitFilePresetMode mode, | |
180 | bool force, | |
181 | UnitFileChange **changes, | |
182 | unsigned *n_changes); | |
183 | int unit_file_mask( | |
184 | UnitFileScope scope, | |
185 | bool runtime, | |
186 | const char *root_dir, | |
187 | char **files, | |
188 | bool force, | |
189 | UnitFileChange **changes, | |
190 | unsigned *n_changes); | |
191 | int unit_file_unmask( | |
192 | UnitFileScope scope, | |
193 | bool runtime, | |
194 | const char *root_dir, | |
195 | char **files, | |
196 | UnitFileChange **changes, | |
197 | unsigned *n_changes); | |
198 | int unit_file_link( | |
199 | UnitFileScope scope, | |
200 | bool runtime, | |
201 | const char *root_dir, | |
202 | char **files, | |
203 | bool force, | |
204 | UnitFileChange **changes, | |
205 | unsigned *n_changes); | |
206 | int unit_file_revert( | |
207 | UnitFileScope scope, | |
208 | const char *root_dir, | |
209 | char **files, | |
210 | UnitFileChange **changes, | |
211 | unsigned *n_changes); | |
212 | int unit_file_set_default( | |
213 | UnitFileScope scope, | |
214 | const char *root_dir, | |
215 | const char *file, | |
216 | bool force, | |
217 | UnitFileChange **changes, | |
218 | unsigned *n_changes); | |
219 | int unit_file_get_default( | |
220 | UnitFileScope scope, | |
221 | const char *root_dir, | |
222 | char **name); | |
223 | int unit_file_add_dependency( | |
224 | UnitFileScope scope, | |
225 | bool runtime, | |
226 | const char *root_dir, | |
227 | char **files, | |
228 | const char *target, | |
229 | UnitDependency dep, | |
230 | bool force, | |
231 | UnitFileChange **changes, | |
232 | unsigned *n_changes); | |
83096483 | 233 | |
0ec0deaa | 234 | int unit_file_get_state(UnitFileScope scope, const char *root_dir, const char *filename, UnitFileState *ret); |
e735decc | 235 | int unit_file_exists(UnitFileScope scope, const LookupPaths *paths, const char *name); |
83096483 | 236 | |
313fe66f | 237 | int unit_file_get_list(UnitFileScope scope, const char *root_dir, Hashmap *h, char **states, char **patterns); |
0ec0deaa | 238 | Hashmap* unit_file_list_free(Hashmap *h); |
83096483 | 239 | |
57ab2eab | 240 | int unit_file_changes_add(UnitFileChange **changes, unsigned *n_changes, UnitFileChangeType type, const char *path, const char *source); |
83096483 | 241 | void unit_file_changes_free(UnitFileChange *changes, unsigned n_changes); |
af3d8113 | 242 | void unit_file_dump_changes(int r, const char *verb, const UnitFileChange *changes, unsigned n_changes, bool quiet); |
83096483 | 243 | |
c2a8d7b0 | 244 | int unit_file_query_preset(UnitFileScope scope, const char *root_dir, const char *name); |
83096483 | 245 | |
44a6b1b6 ZJS |
246 | const char *unit_file_state_to_string(UnitFileState s) _const_; |
247 | UnitFileState unit_file_state_from_string(const char *s) _pure_; | |
1fa03360 | 248 | /* from_string conversion is unreliable because of the overlap between -EPERM and -1 for error. */ |
83096483 | 249 | |
44a6b1b6 ZJS |
250 | const char *unit_file_change_type_to_string(UnitFileChangeType s) _const_; |
251 | UnitFileChangeType unit_file_change_type_from_string(const char *s) _pure_; | |
d309c1c3 LP |
252 | |
253 | const char *unit_file_preset_mode_to_string(UnitFilePresetMode m) _const_; | |
254 | UnitFilePresetMode unit_file_preset_mode_from_string(const char *s) _pure_; |