]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
c2f1db8f | 2 | #pragma once |
87d2c1ff | 3 | |
87d2c1ff LP |
4 | #include <inttypes.h> |
5 | ||
349cc4a5 | 6 | #if HAVE_GCRYPT |
a03d4359 | 7 | # include <gcrypt.h> |
7560fffc LP |
8 | #endif |
9 | ||
a03d4359 | 10 | #include "sd-event.h" |
fa6ac760 | 11 | #include "sd-id128.h" |
81527be1 | 12 | |
71d35b6b | 13 | #include "hashmap.h" |
87d2c1ff | 14 | #include "journal-def.h" |
a2341f68 | 15 | #include "macro.h" |
16e9f408 | 16 | #include "mmap-cache.h" |
71d35b6b | 17 | #include "sparse-endian.h" |
de190aef | 18 | |
bc85bfee | 19 | typedef struct JournalMetrics { |
8580d1f7 LP |
20 | /* For all these: -1 means "pick automatically", and 0 means "no limit enforced" */ |
21 | uint64_t max_size; /* how large journal files grow at max */ | |
22 | uint64_t min_size; /* how large journal files grow at least */ | |
23 | uint64_t max_use; /* how much disk space to use in total at max, keep_free permitting */ | |
24 | uint64_t min_use; /* how much disk space to use in total at least, even if keep_free says not to */ | |
25 | uint64_t keep_free; /* how much to keep free on disk */ | |
26 | uint64_t n_max_files; /* how many files to keep around at max */ | |
bc85bfee LP |
27 | } JournalMetrics; |
28 | ||
87011c25 ZJS |
29 | typedef enum direction { |
30 | DIRECTION_UP, | |
31 | DIRECTION_DOWN | |
32 | } direction_t; | |
33 | ||
99cc7653 MS |
34 | typedef enum LocationType { |
35 | /* The first and last entries, resp. */ | |
36 | LOCATION_HEAD, | |
37 | LOCATION_TAIL, | |
38 | ||
39 | /* We already read the entry we currently point to, and the | |
40 | * next one to read should probably not be this one again. */ | |
41 | LOCATION_DISCRETE, | |
42 | ||
43 | /* We should seek to the precise location specified, and | |
44 | * return it, as we haven't read it yet. */ | |
45 | LOCATION_SEEK | |
46 | } LocationType; | |
47 | ||
ac2e41f5 VC |
48 | typedef enum OfflineState { |
49 | OFFLINE_JOINED, | |
50 | OFFLINE_SYNCING, | |
51 | OFFLINE_OFFLINING, | |
52 | OFFLINE_CANCEL, | |
53 | OFFLINE_AGAIN_FROM_SYNCING, | |
54 | OFFLINE_AGAIN_FROM_OFFLINING, | |
55 | OFFLINE_DONE | |
56 | } OfflineState; | |
57 | ||
f4b47811 LP |
58 | typedef struct JournalFile { |
59 | int fd; | |
be7cdd8e | 60 | MMapFileDescriptor *cache_fd; |
87011c25 | 61 | |
0ac38b70 | 62 | mode_t mode; |
7560fffc | 63 | |
0ac38b70 | 64 | int flags; |
f4b47811 | 65 | int prot; |
b8e891e6 | 66 | bool writable:1; |
d89c8fdf ZJS |
67 | bool compress_xz:1; |
68 | bool compress_lz4:1; | |
b8e891e6 | 69 | bool seal:1; |
f27a3864 | 70 | bool defrag_on_close:1; |
5d1ce257 | 71 | bool close_fd:1; |
8eb85171 | 72 | bool archive:1; |
7560fffc | 73 | |
87011c25 | 74 | direction_t last_direction; |
6573ef05 | 75 | LocationType location_type; |
6e693b42 | 76 | uint64_t last_n_entries; |
87011c25 ZJS |
77 | |
78 | char *path; | |
79 | struct stat last_stat; | |
2678031a | 80 | usec_t last_stat_usec; |
87011c25 | 81 | |
f4b47811 | 82 | Header *header; |
de190aef LP |
83 | HashItem *data_hash_table; |
84 | HashItem *field_hash_table; | |
f4b47811 | 85 | |
f4b47811 | 86 | uint64_t current_offset; |
6573ef05 MS |
87 | uint64_t current_seqnum; |
88 | uint64_t current_realtime; | |
89 | uint64_t current_monotonic; | |
90 | sd_id128_t current_boot_id; | |
91 | uint64_t current_xor_hash; | |
bc85bfee LP |
92 | |
93 | JournalMetrics metrics; | |
16e9f408 | 94 | MMapCache *mmap; |
807e17f0 | 95 | |
7a24f3bf VC |
96 | sd_event_source *post_change_timer; |
97 | usec_t post_change_timer_period; | |
98 | ||
4743015d | 99 | OrderedHashmap *chain_cache; |
a4bcff5b | 100 | |
ac2e41f5 VC |
101 | pthread_t offline_thread; |
102 | volatile OfflineState offline_state; | |
103 | ||
858749f7 LP |
104 | unsigned last_seen_generation; |
105 | ||
57850536 | 106 | uint64_t compress_threshold_bytes; |
349cc4a5 | 107 | #if HAVE_XZ || HAVE_LZ4 |
807e17f0 | 108 | void *compress_buffer; |
fa1c4b51 | 109 | size_t compress_buffer_size; |
807e17f0 | 110 | #endif |
7560fffc | 111 | |
349cc4a5 | 112 | #if HAVE_GCRYPT |
7560fffc LP |
113 | gcry_md_hd_t hmac; |
114 | bool hmac_running; | |
115 | ||
baed47c3 LP |
116 | FSSHeader *fss_file; |
117 | size_t fss_file_size; | |
118 | ||
119 | uint64_t fss_start_usec; | |
120 | uint64_t fss_interval_usec; | |
b7c9ae91 LP |
121 | |
122 | void *fsprg_state; | |
123 | size_t fsprg_state_size; | |
124 | ||
125 | void *fsprg_seed; | |
126 | size_t fsprg_seed_size; | |
7560fffc | 127 | #endif |
f4b47811 LP |
128 | } JournalFile; |
129 | ||
4a92baf3 | 130 | int journal_file_open( |
5d1ce257 | 131 | int fd, |
4a92baf3 LP |
132 | const char *fname, |
133 | int flags, | |
134 | mode_t mode, | |
7560fffc | 135 | bool compress, |
57850536 | 136 | uint64_t compress_threshold_bytes, |
baed47c3 | 137 | bool seal, |
4a92baf3 | 138 | JournalMetrics *metrics, |
27370278 | 139 | MMapCache *mmap_cache, |
b58c888f | 140 | Set *deferred_closes, |
4a92baf3 LP |
141 | JournalFile *template, |
142 | JournalFile **ret); | |
143 | ||
ac2e41f5 | 144 | int journal_file_set_offline(JournalFile *f, bool wait); |
b58c888f | 145 | bool journal_file_is_offlining(JournalFile *f); |
804ae586 | 146 | JournalFile* journal_file_close(JournalFile *j); |
87d2c1ff | 147 | |
4a92baf3 LP |
148 | int journal_file_open_reliably( |
149 | const char *fname, | |
150 | int flags, | |
151 | mode_t mode, | |
7560fffc | 152 | bool compress, |
57850536 | 153 | uint64_t compress_threshold_bytes, |
baed47c3 | 154 | bool seal, |
4a92baf3 | 155 | JournalMetrics *metrics, |
27370278 | 156 | MMapCache *mmap_cache, |
b58c888f | 157 | Set *deferred_closes, |
4a92baf3 LP |
158 | JournalFile *template, |
159 | JournalFile **ret); | |
9447a7f1 | 160 | |
0284adc6 | 161 | #define ALIGN64(x) (((x) + 7ULL) & ~7ULL) |
db11ac1a | 162 | #define VALID64(x) (((x) & 7ULL) == 0ULL) |
0284adc6 | 163 | |
ae97089d ZJS |
164 | /* Use six characters to cover the offsets common in smallish journal |
165 | * files without adding too many zeros. */ | |
166 | #define OFSfmt "%06"PRIx64 | |
167 | ||
fc89a139 LP |
168 | static inline bool VALID_REALTIME(uint64_t u) { |
169 | /* This considers timestamps until the year 3112 valid. That should be plenty room... */ | |
170 | return u > 0 && u < (1ULL << 55); | |
171 | } | |
172 | ||
173 | static inline bool VALID_MONOTONIC(uint64_t u) { | |
174 | /* This considers timestamps until 1142 years of runtime valid. */ | |
175 | return u < (1ULL << 55); | |
176 | } | |
177 | ||
178 | static inline bool VALID_EPOCH(uint64_t u) { | |
179 | /* This allows changing the key for 1142 years, every usec. */ | |
180 | return u < (1ULL << 55); | |
181 | } | |
182 | ||
0284adc6 LP |
183 | #define JOURNAL_HEADER_CONTAINS(h, field) \ |
184 | (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field)) | |
185 | ||
8088cbd3 LP |
186 | #define JOURNAL_HEADER_SEALED(h) \ |
187 | (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED)) | |
188 | ||
d89c8fdf ZJS |
189 | #define JOURNAL_HEADER_COMPRESSED_XZ(h) \ |
190 | (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED_XZ)) | |
191 | ||
192 | #define JOURNAL_HEADER_COMPRESSED_LZ4(h) \ | |
193 | (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED_LZ4)) | |
8088cbd3 | 194 | |
78519831 | 195 | int journal_file_move_to_object(JournalFile *f, ObjectType type, uint64_t offset, Object **ret); |
87d2c1ff | 196 | |
44a6b1b6 ZJS |
197 | uint64_t journal_file_entry_n_items(Object *o) _pure_; |
198 | uint64_t journal_file_entry_array_n_items(Object *o) _pure_; | |
199 | uint64_t journal_file_hash_table_n_items(Object *o) _pure_; | |
87d2c1ff | 200 | |
78519831 | 201 | int journal_file_append_object(JournalFile *f, ObjectType type, uint64_t size, Object **ret, uint64_t *offset); |
d180c349 ZJS |
202 | int journal_file_append_entry( |
203 | JournalFile *f, | |
204 | const dual_timestamp *ts, | |
205 | const sd_id128_t *boot_id, | |
206 | const struct iovec iovec[], unsigned n_iovec, | |
207 | uint64_t *seqno, | |
208 | Object **ret, | |
209 | uint64_t *offset); | |
87d2c1ff | 210 | |
de190aef LP |
211 | int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset); |
212 | int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset); | |
87d2c1ff | 213 | |
3c1668da LP |
214 | int journal_file_find_field_object(JournalFile *f, const void *field, uint64_t size, Object **ret, uint64_t *offset); |
215 | int journal_file_find_field_object_with_hash(JournalFile *f, const void *field, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset); | |
216 | ||
1fc605b0 | 217 | void journal_file_reset_location(JournalFile *f); |
950c07d4 | 218 | void journal_file_save_location(JournalFile *f, Object *o, uint64_t offset); |
d8ae66d7 | 219 | int journal_file_compare_locations(JournalFile *af, JournalFile *bf); |
f534928a | 220 | int journal_file_next_entry(JournalFile *f, uint64_t p, direction_t direction, Object **ret, uint64_t *offset); |
87d2c1ff | 221 | |
de190aef LP |
222 | int journal_file_next_entry_for_data(JournalFile *f, Object *o, uint64_t p, uint64_t data_offset, direction_t direction, Object **ret, uint64_t *offset); |
223 | ||
224 | int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset); | |
225 | int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset); | |
226 | int journal_file_move_to_entry_by_monotonic(JournalFile *f, sd_id128_t boot_id, uint64_t monotonic, direction_t direction, Object **ret, uint64_t *offset); | |
227 | ||
cbdca852 | 228 | int journal_file_move_to_entry_by_offset_for_data(JournalFile *f, uint64_t data_offset, uint64_t p, direction_t direction, Object **ret, uint64_t *offset); |
de190aef LP |
229 | int journal_file_move_to_entry_by_seqnum_for_data(JournalFile *f, uint64_t data_offset, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset); |
230 | int journal_file_move_to_entry_by_realtime_for_data(JournalFile *f, uint64_t data_offset, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset); | |
cbdca852 | 231 | int journal_file_move_to_entry_by_monotonic_for_data(JournalFile *f, uint64_t data_offset, sd_id128_t boot_id, uint64_t monotonic, direction_t direction, Object **ret, uint64_t *offset); |
87d2c1ff | 232 | |
5a271b08 | 233 | int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p); |
cf244689 | 234 | |
87d2c1ff | 235 | void journal_file_dump(JournalFile *f); |
dca6219e | 236 | void journal_file_print_header(JournalFile *f); |
87d2c1ff | 237 | |
7a4d21ad LP |
238 | int journal_file_archive(JournalFile *f); |
239 | JournalFile* journal_initiate_close(JournalFile *f, Set *deferred_closes); | |
57850536 | 240 | int journal_file_rotate(JournalFile **f, bool compress, uint64_t compress_threshold_bytes, bool seal, Set *deferred_closes); |
0ac38b70 | 241 | |
68127658 LP |
242 | int journal_file_dispose(int dir_fd, const char *fname); |
243 | ||
cf244689 | 244 | void journal_file_post_change(JournalFile *f); |
7a24f3bf | 245 | int journal_file_enable_post_change_timer(JournalFile *f, sd_event *e, usec_t t); |
cf244689 | 246 | |
8580d1f7 | 247 | void journal_reset_metrics(JournalMetrics *m); |
babfc091 LP |
248 | void journal_default_metrics(JournalMetrics *m, int fd); |
249 | ||
08984293 LP |
250 | int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to); |
251 | int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to); | |
252 | ||
fb0951b0 | 253 | bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec); |
dade37d4 LP |
254 | |
255 | int journal_file_map_data_hash_table(JournalFile *f); | |
256 | int journal_file_map_field_hash_table(JournalFile *f); | |
d1afbcd2 LP |
257 | |
258 | static inline bool JOURNAL_FILE_COMPRESS(JournalFile *f) { | |
259 | assert(f); | |
260 | return f->compress_xz || f->compress_lz4; | |
261 | } |