1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2011 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
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
11 (at your option) any later version.
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
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 #include <sys/statvfs.h>
30 #include "journal-def.h"
31 #include "journal-file.h"
35 #define DEFAULT_DATA_HASH_TABLE_SIZE (2047ULL*16ULL)
36 #define DEFAULT_FIELD_HASH_TABLE_SIZE (2047ULL*16ULL)
38 #define DEFAULT_WINDOW_SIZE (8ULL*1024ULL*1024ULL)
40 #define COMPRESSION_SIZE_THRESHOLD (512ULL)
42 /* This is the minimum journal file size */
43 #define JOURNAL_FILE_SIZE_MIN (64ULL*1024ULL) /* 64 KiB */
45 /* These are the lower and upper bounds if we deduce the max_use value
46 * from the file system size */
47 #define DEFAULT_MAX_USE_LOWER (1ULL*1024ULL*1024ULL) /* 1 MiB */
48 #define DEFAULT_MAX_USE_UPPER (4ULL*1024ULL*1024ULL*1024ULL) /* 4 GiB */
50 /* This is the upper bound if we deduce max_size from max_use */
51 #define DEFAULT_MAX_SIZE_UPPER (128ULL*1024ULL*1024ULL) /* 128 MiB */
53 /* This is the upper bound if we deduce the keep_free value from the
55 #define DEFAULT_KEEP_FREE_UPPER (4ULL*1024ULL*1024ULL*1024ULL) /* 4 GiB */
57 /* This is the keep_free value when we can't determine the system
59 #define DEFAULT_KEEP_FREE (1024ULL*1024ULL) /* 1 MB */
61 static const char signature[] = { 'L', 'P', 'K', 'S', 'H', 'H', 'R', 'H' };
63 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
65 void journal_file_close(JournalFile *f) {
72 f->header->state = STATE_OFFLINE;
74 munmap(f->header, PAGE_ALIGN(sizeof(Header)));
77 for (t = 0; t < _WINDOW_MAX; t++)
78 if (f->windows[t].ptr)
79 munmap(f->windows[t].ptr, f->windows[t].size);
82 close_nointr_nofail(f->fd);
87 free(f->compress_buffer);
93 static int journal_file_init_header(JournalFile *f, JournalFile *template) {
101 memcpy(h.signature, signature, 8);
102 h.header_size = htole64(ALIGN64(sizeof(h)));
104 r = sd_id128_randomize(&h.file_id);
109 h.seqnum_id = template->header->seqnum_id;
110 h.seqnum = template->header->seqnum;
112 h.seqnum_id = h.file_id;
114 k = pwrite(f->fd, &h, sizeof(h), 0);
124 static int journal_file_refresh_header(JournalFile *f) {
130 r = sd_id128_get_machine(&f->header->machine_id);
134 r = sd_id128_get_boot(&boot_id);
138 if (sd_id128_equal(boot_id, f->header->boot_id))
139 f->tail_entry_monotonic_valid = true;
141 f->header->boot_id = boot_id;
143 f->header->state = STATE_ONLINE;
145 __sync_synchronize();
150 static int journal_file_verify_header(JournalFile *f) {
153 if (memcmp(f->header, signature, 8))
157 if ((le64toh(f->header->incompatible_flags) & ~HEADER_INCOMPATIBLE_COMPRESSED) != 0)
158 return -EPROTONOSUPPORT;
160 if (f->header->incompatible_flags != 0)
161 return -EPROTONOSUPPORT;
164 if (f->header->header_size != htole64(ALIGN64(sizeof(*(f->header)))))
167 if ((uint64_t) f->last_stat.st_size < (le64toh(f->header->header_size) + le64toh(f->header->arena_size)))
172 sd_id128_t machine_id;
175 r = sd_id128_get_machine(&machine_id);
179 if (!sd_id128_equal(machine_id, f->header->machine_id))
182 state = f->header->state;
184 if (state == STATE_ONLINE)
185 log_debug("Journal file %s is already online. Assuming unclean closing. Ignoring.", f->path);
186 /* FIXME: immediately rotate */
187 else if (state == STATE_ARCHIVED)
189 else if (state != STATE_OFFLINE)
190 log_debug("Journal file %s has unknown state %u. Ignoring.", f->path, state);
196 static int journal_file_allocate(JournalFile *f, uint64_t offset, uint64_t size) {
197 uint64_t old_size, new_size;
202 /* We assume that this file is not sparse, and we know that
203 * for sure, since we always call posix_fallocate()
207 le64toh(f->header->header_size) +
208 le64toh(f->header->arena_size);
210 new_size = PAGE_ALIGN(offset + size);
211 if (new_size < le64toh(f->header->header_size))
212 new_size = le64toh(f->header->header_size);
214 if (new_size <= old_size)
217 if (f->metrics.max_size > 0 &&
218 new_size > f->metrics.max_size)
221 if (new_size > f->metrics.min_size &&
222 f->metrics.keep_free > 0) {
225 if (fstatvfs(f->fd, &svfs) >= 0) {
228 available = svfs.f_bfree * svfs.f_bsize;
230 if (available >= f->metrics.keep_free)
231 available -= f->metrics.keep_free;
235 if (new_size - old_size > available)
240 /* Note that the glibc fallocate() fallback is very
241 inefficient, hence we try to minimize the allocation area
243 r = posix_fallocate(f->fd, old_size, new_size - old_size);
247 if (fstat(f->fd, &f->last_stat) < 0)
250 f->header->arena_size = htole64(new_size - le64toh(f->header->header_size));
255 static int journal_file_map(
264 uint64_t woffset, wsize;
271 woffset = offset & ~((uint64_t) page_size() - 1ULL);
272 wsize = size + (offset - woffset);
273 wsize = PAGE_ALIGN(wsize);
275 /* Avoid SIGBUS on invalid accesses */
276 if (woffset + wsize > (uint64_t) PAGE_ALIGN(f->last_stat.st_size))
277 return -EADDRNOTAVAIL;
279 window = mmap(NULL, wsize, f->prot, MAP_SHARED, f->fd, woffset);
280 if (window == MAP_FAILED)
292 *ret = (uint8_t*) window + (offset - woffset);
297 static int journal_file_move_to(JournalFile *f, int wt, uint64_t offset, uint64_t size, void **ret) {
306 assert(wt < _WINDOW_MAX);
308 if (offset + size > (uint64_t) f->last_stat.st_size) {
309 /* Hmm, out of range? Let's refresh the fstat() data
310 * first, before we trust that check. */
312 if (fstat(f->fd, &f->last_stat) < 0 ||
313 offset + size > (uint64_t) f->last_stat.st_size)
314 return -EADDRNOTAVAIL;
319 if (_likely_(w->ptr &&
320 w->offset <= offset &&
321 w->offset + w->size >= offset + size)) {
323 *ret = (uint8_t*) w->ptr + (offset - w->offset);
328 if (munmap(w->ptr, w->size) < 0)
332 w->size = w->offset = 0;
335 if (size < DEFAULT_WINDOW_SIZE) {
336 /* If the default window size is larger then what was
337 * asked for extend the mapping a bit in the hope to
338 * minimize needed remappings later on. We add half
339 * the window space before and half behind the
340 * requested mapping */
342 delta = (DEFAULT_WINDOW_SIZE - size) / 2;
348 size = DEFAULT_WINDOW_SIZE;
352 if (offset + size > (uint64_t) f->last_stat.st_size)
353 size = (uint64_t) f->last_stat.st_size - offset;
356 return -EADDRNOTAVAIL;
358 r = journal_file_map(f,
360 &w->ptr, &w->offset, &w->size,
366 *ret = (uint8_t*) p + delta;
370 static bool verify_hash(Object *o) {
375 if (o->object.type == OBJECT_DATA && !(o->object.flags & OBJECT_COMPRESSED)) {
376 h1 = le64toh(o->data.hash);
377 h2 = hash64(o->data.payload, le64toh(o->object.size) - offsetof(Object, data.payload));
378 } else if (o->object.type == OBJECT_FIELD) {
379 h1 = le64toh(o->field.hash);
380 h2 = hash64(o->field.payload, le64toh(o->object.size) - offsetof(Object, field.payload));
387 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret) {
395 assert(type < _OBJECT_TYPE_MAX);
397 r = journal_file_move_to(f, type >= 0 ? type : WINDOW_UNKNOWN, offset, sizeof(ObjectHeader), &t);
402 s = le64toh(o->object.size);
404 if (s < sizeof(ObjectHeader))
407 if (type >= 0 && o->object.type != type)
410 if (s > sizeof(ObjectHeader)) {
411 r = journal_file_move_to(f, o->object.type, offset, s, &t);
425 static uint64_t journal_file_seqnum(JournalFile *f, uint64_t *seqnum) {
430 r = le64toh(f->header->seqnum) + 1;
433 /* If an external seqnum counter was passed, we update
434 * both the local and the external one, and set it to
435 * the maximum of both */
443 f->header->seqnum = htole64(r);
445 if (f->header->first_seqnum == 0)
446 f->header->first_seqnum = htole64(r);
451 static int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset) {
458 assert(size >= sizeof(ObjectHeader));
462 p = le64toh(f->header->tail_object_offset);
464 p = le64toh(f->header->header_size);
466 r = journal_file_move_to_object(f, -1, p, &tail);
470 p += ALIGN64(le64toh(tail->object.size));
473 r = journal_file_allocate(f, p, size);
477 r = journal_file_move_to(f, type, p, size, &t);
484 o->object.type = type;
485 o->object.size = htole64(size);
487 f->header->tail_object_offset = htole64(p);
488 f->header->n_objects = htole64(le64toh(f->header->n_objects) + 1);
496 static int journal_file_setup_data_hash_table(JournalFile *f) {
503 s = DEFAULT_DATA_HASH_TABLE_SIZE;
504 r = journal_file_append_object(f,
505 OBJECT_DATA_HASH_TABLE,
506 offsetof(Object, hash_table.items) + s,
511 memset(o->hash_table.items, 0, s);
513 f->header->data_hash_table_offset = htole64(p + offsetof(Object, hash_table.items));
514 f->header->data_hash_table_size = htole64(s);
519 static int journal_file_setup_field_hash_table(JournalFile *f) {
526 s = DEFAULT_FIELD_HASH_TABLE_SIZE;
527 r = journal_file_append_object(f,
528 OBJECT_FIELD_HASH_TABLE,
529 offsetof(Object, hash_table.items) + s,
534 memset(o->hash_table.items, 0, s);
536 f->header->field_hash_table_offset = htole64(p + offsetof(Object, hash_table.items));
537 f->header->field_hash_table_size = htole64(s);
542 static int journal_file_map_data_hash_table(JournalFile *f) {
549 p = le64toh(f->header->data_hash_table_offset);
550 s = le64toh(f->header->data_hash_table_size);
552 r = journal_file_move_to(f,
553 WINDOW_DATA_HASH_TABLE,
559 f->data_hash_table = t;
563 static int journal_file_map_field_hash_table(JournalFile *f) {
570 p = le64toh(f->header->field_hash_table_offset);
571 s = le64toh(f->header->field_hash_table_size);
573 r = journal_file_move_to(f,
574 WINDOW_FIELD_HASH_TABLE,
580 f->field_hash_table = t;
584 static int journal_file_link_data(JournalFile *f, Object *o, uint64_t offset, uint64_t hash) {
591 assert(o->object.type == OBJECT_DATA);
593 /* This might alter the window we are looking at */
595 o->data.next_hash_offset = o->data.next_field_offset = 0;
596 o->data.entry_offset = o->data.entry_array_offset = 0;
597 o->data.n_entries = 0;
599 h = hash % (le64toh(f->header->data_hash_table_size) / sizeof(HashItem));
600 p = le64toh(f->data_hash_table[h].tail_hash_offset);
602 /* Only entry in the hash table is easy */
603 f->data_hash_table[h].head_hash_offset = htole64(offset);
605 /* Move back to the previous data object, to patch in
608 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
612 o->data.next_hash_offset = htole64(offset);
615 f->data_hash_table[h].tail_hash_offset = htole64(offset);
620 int journal_file_find_data_object_with_hash(
622 const void *data, uint64_t size, uint64_t hash,
623 Object **ret, uint64_t *offset) {
625 uint64_t p, osize, h;
629 assert(data || size == 0);
631 osize = offsetof(Object, data.payload) + size;
633 if (f->header->data_hash_table_size == 0)
636 h = hash % (le64toh(f->header->data_hash_table_size) / sizeof(HashItem));
637 p = le64toh(f->data_hash_table[h].head_hash_offset);
642 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
646 if (le64toh(o->data.hash) != hash)
649 if (o->object.flags & OBJECT_COMPRESSED) {
653 l = le64toh(o->object.size);
654 if (l <= offsetof(Object, data.payload))
657 l -= offsetof(Object, data.payload);
659 if (!uncompress_blob(o->data.payload, l, &f->compress_buffer, &f->compress_buffer_size, &rsize))
663 memcmp(f->compress_buffer, data, size) == 0) {
674 return -EPROTONOSUPPORT;
677 } else if (le64toh(o->object.size) == osize &&
678 memcmp(o->data.payload, data, size) == 0) {
690 p = le64toh(o->data.next_hash_offset);
696 int journal_file_find_data_object(
698 const void *data, uint64_t size,
699 Object **ret, uint64_t *offset) {
704 assert(data || size == 0);
706 hash = hash64(data, size);
708 return journal_file_find_data_object_with_hash(f,
713 static int journal_file_append_data(
715 const void *data, uint64_t size,
716 Object **ret, uint64_t *offset) {
722 bool compressed = false;
725 assert(data || size == 0);
727 hash = hash64(data, size);
729 r = journal_file_find_data_object_with_hash(f, data, size, hash, &o, &p);
743 osize = offsetof(Object, data.payload) + size;
744 r = journal_file_append_object(f, OBJECT_DATA, osize, &o, &p);
748 o->data.hash = htole64(hash);
752 size >= COMPRESSION_SIZE_THRESHOLD) {
755 compressed = compress_blob(data, size, o->data.payload, &rsize);
758 o->object.size = htole64(offsetof(Object, data.payload) + rsize);
759 o->object.flags |= OBJECT_COMPRESSED;
761 f->header->incompatible_flags = htole32(le32toh(f->header->incompatible_flags) | HEADER_INCOMPATIBLE_COMPRESSED);
763 log_debug("Compressed data object %lu -> %lu", (unsigned long) size, (unsigned long) rsize);
769 memcpy(o->data.payload, data, size);
771 r = journal_file_link_data(f, o, p, hash);
775 /* The linking might have altered the window, so let's
776 * refresh our pointer */
777 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
790 uint64_t journal_file_entry_n_items(Object *o) {
792 assert(o->object.type == OBJECT_ENTRY);
794 return (le64toh(o->object.size) - offsetof(Object, entry.items)) / sizeof(EntryItem);
797 static uint64_t journal_file_entry_array_n_items(Object *o) {
799 assert(o->object.type == OBJECT_ENTRY_ARRAY);
801 return (le64toh(o->object.size) - offsetof(Object, entry_array.items)) / sizeof(uint64_t);
804 static int link_entry_into_array(JournalFile *f,
809 uint64_t n = 0, ap = 0, q, i, a, hidx;
818 i = hidx = le64toh(*idx);
821 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &o);
825 n = journal_file_entry_array_n_items(o);
827 o->entry_array.items[i] = htole64(p);
828 *idx = htole64(hidx + 1);
834 a = le64toh(o->entry_array.next_entry_array_offset);
845 r = journal_file_append_object(f, OBJECT_ENTRY_ARRAY,
846 offsetof(Object, entry_array.items) + n * sizeof(uint64_t),
851 o->entry_array.items[i] = htole64(p);
856 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, ap, &o);
860 o->entry_array.next_entry_array_offset = htole64(q);
863 *idx = htole64(hidx + 1);
868 static int link_entry_into_array_plus_one(JournalFile *f,
887 i = htole64(le64toh(*idx) - 1);
888 r = link_entry_into_array(f, first, &i, p);
893 *idx = htole64(le64toh(*idx) + 1);
897 static int journal_file_link_entry_item(JournalFile *f, Object *o, uint64_t offset, uint64_t i) {
904 p = le64toh(o->entry.items[i].object_offset);
908 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
912 return link_entry_into_array_plus_one(f,
913 &o->data.entry_offset,
914 &o->data.entry_array_offset,
919 static int journal_file_link_entry(JournalFile *f, Object *o, uint64_t offset) {
926 assert(o->object.type == OBJECT_ENTRY);
928 __sync_synchronize();
930 /* Link up the entry itself */
931 r = link_entry_into_array(f,
932 &f->header->entry_array_offset,
933 &f->header->n_entries,
938 /* log_debug("=> %s seqnr=%lu n_entries=%lu", f->path, (unsigned long) o->entry.seqnum, (unsigned long) f->header->n_entries); */
940 if (f->header->head_entry_realtime == 0)
941 f->header->head_entry_realtime = o->entry.realtime;
943 f->header->tail_entry_realtime = o->entry.realtime;
944 f->header->tail_entry_monotonic = o->entry.monotonic;
946 f->tail_entry_monotonic_valid = true;
948 /* Link up the items */
949 n = journal_file_entry_n_items(o);
950 for (i = 0; i < n; i++) {
951 r = journal_file_link_entry_item(f, o, offset, i);
959 static int journal_file_append_entry_internal(
961 const dual_timestamp *ts,
963 const EntryItem items[], unsigned n_items,
965 Object **ret, uint64_t *offset) {
972 assert(items || n_items == 0);
975 osize = offsetof(Object, entry.items) + (n_items * sizeof(EntryItem));
977 r = journal_file_append_object(f, OBJECT_ENTRY, osize, &o, &np);
981 o->entry.seqnum = htole64(journal_file_seqnum(f, seqnum));
982 memcpy(o->entry.items, items, n_items * sizeof(EntryItem));
983 o->entry.realtime = htole64(ts->realtime);
984 o->entry.monotonic = htole64(ts->monotonic);
985 o->entry.xor_hash = htole64(xor_hash);
986 o->entry.boot_id = f->header->boot_id;
988 r = journal_file_link_entry(f, o, np);
1001 void journal_file_post_change(JournalFile *f) {
1004 /* inotify() does not receive IN_MODIFY events from file
1005 * accesses done via mmap(). After each access we hence
1006 * trigger IN_MODIFY by truncating the journal file to its
1007 * current size which triggers IN_MODIFY. */
1009 __sync_synchronize();
1011 if (ftruncate(f->fd, f->last_stat.st_size) < 0)
1012 log_error("Failed to to truncate file to its own size: %m");
1015 int journal_file_append_entry(JournalFile *f, const dual_timestamp *ts, const struct iovec iovec[], unsigned n_iovec, uint64_t *seqnum, Object **ret, uint64_t *offset) {
1019 uint64_t xor_hash = 0;
1020 struct dual_timestamp _ts;
1023 assert(iovec || n_iovec == 0);
1029 dual_timestamp_get(&_ts);
1033 if (f->tail_entry_monotonic_valid &&
1034 ts->monotonic < le64toh(f->header->tail_entry_monotonic))
1037 items = alloca(sizeof(EntryItem) * n_iovec);
1039 for (i = 0; i < n_iovec; i++) {
1043 r = journal_file_append_data(f, iovec[i].iov_base, iovec[i].iov_len, &o, &p);
1047 xor_hash ^= le64toh(o->data.hash);
1048 items[i].object_offset = htole64(p);
1049 items[i].hash = o->data.hash;
1052 r = journal_file_append_entry_internal(f, ts, xor_hash, items, n_iovec, seqnum, ret, offset);
1054 journal_file_post_change(f);
1059 static int generic_array_get(JournalFile *f,
1062 Object **ret, uint64_t *offset) {
1074 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &o);
1078 n = journal_file_entry_array_n_items(o);
1080 p = le64toh(o->entry_array.items[i]);
1085 a = le64toh(o->entry_array.next_entry_array_offset);
1088 if (a <= 0 || p <= 0)
1091 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1104 static int generic_array_get_plus_one(JournalFile *f,
1108 Object **ret, uint64_t *offset) {
1117 r = journal_file_move_to_object(f, OBJECT_ENTRY, extra, &o);
1130 return generic_array_get(f, first, i-1, ret, offset);
1139 static int generic_array_bisect(JournalFile *f,
1143 int (*test_object)(JournalFile *f, uint64_t p, uint64_t needle),
1144 direction_t direction,
1149 uint64_t a, p, t = 0, i = 0, last_p = 0;
1150 bool subtract_one = false;
1151 Object *o, *array = NULL;
1155 assert(test_object);
1159 uint64_t left, right, k, lp;
1161 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &array);
1165 k = journal_file_entry_array_n_items(array);
1171 lp = p = le64toh(array->entry_array.items[i]);
1175 r = test_object(f, p, needle);
1179 if (r == TEST_FOUND)
1180 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1182 if (r == TEST_RIGHT) {
1186 if (left == right) {
1187 if (direction == DIRECTION_UP)
1188 subtract_one = true;
1194 assert(left < right);
1196 i = (left + right) / 2;
1197 p = le64toh(array->entry_array.items[i]);
1201 r = test_object(f, p, needle);
1205 if (r == TEST_FOUND)
1206 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1208 if (r == TEST_RIGHT)
1222 a = le64toh(array->entry_array.next_entry_array_offset);
1228 if (subtract_one && t == 0 && i == 0)
1231 if (subtract_one && i == 0)
1233 else if (subtract_one)
1234 p = le64toh(array->entry_array.items[i-1]);
1236 p = le64toh(array->entry_array.items[i]);
1238 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1249 *idx = t + i - (subtract_one ? 1 : 0);
1254 static int generic_array_bisect_plus_one(JournalFile *f,
1259 int (*test_object)(JournalFile *f, uint64_t p, uint64_t needle),
1260 direction_t direction,
1268 assert(test_object);
1273 /* This bisects the array in object 'first', but first checks
1275 r = test_object(f, extra, needle);
1279 if (r == TEST_FOUND)
1280 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1282 if (r == TEST_RIGHT) {
1285 r = journal_file_move_to_object(f, OBJECT_ENTRY, extra, &o);
1301 r = generic_array_bisect(f, first, n-1, needle, test_object, direction, ret, offset, idx);
1309 static int test_object_seqnum(JournalFile *f, uint64_t p, uint64_t needle) {
1316 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1320 if (le64toh(o->entry.seqnum) == needle)
1322 else if (le64toh(o->entry.seqnum) < needle)
1328 int journal_file_move_to_entry_by_seqnum(
1331 direction_t direction,
1335 return generic_array_bisect(f,
1336 le64toh(f->header->entry_array_offset),
1337 le64toh(f->header->n_entries),
1344 static int test_object_realtime(JournalFile *f, uint64_t p, uint64_t needle) {
1351 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1355 if (le64toh(o->entry.realtime) == needle)
1357 else if (le64toh(o->entry.realtime) < needle)
1363 int journal_file_move_to_entry_by_realtime(
1366 direction_t direction,
1370 return generic_array_bisect(f,
1371 le64toh(f->header->entry_array_offset),
1372 le64toh(f->header->n_entries),
1374 test_object_realtime,
1379 static int test_object_monotonic(JournalFile *f, uint64_t p, uint64_t needle) {
1386 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1390 if (le64toh(o->entry.monotonic) == needle)
1392 else if (le64toh(o->entry.monotonic) < needle)
1398 int journal_file_move_to_entry_by_monotonic(
1402 direction_t direction,
1406 char t[9+32+1] = "_BOOT_ID=";
1410 sd_id128_to_string(boot_id, t + 9);
1412 r = journal_file_find_data_object(f, t, strlen(t), &o, NULL);
1418 return generic_array_bisect_plus_one(f,
1419 le64toh(o->data.entry_offset),
1420 le64toh(o->data.entry_array_offset),
1421 le64toh(o->data.n_entries),
1423 test_object_monotonic,
1428 static int test_object_offset(JournalFile *f, uint64_t p, uint64_t needle) {
1434 else if (p < needle)
1440 int journal_file_next_entry(
1442 Object *o, uint64_t p,
1443 direction_t direction,
1444 Object **ret, uint64_t *offset) {
1450 assert(p > 0 || !o);
1452 n = le64toh(f->header->n_entries);
1457 i = direction == DIRECTION_DOWN ? 0 : n - 1;
1459 if (o->object.type != OBJECT_ENTRY)
1462 r = generic_array_bisect(f,
1463 le64toh(f->header->entry_array_offset),
1464 le64toh(f->header->n_entries),
1473 if (direction == DIRECTION_DOWN) {
1486 /* And jump to it */
1487 return generic_array_get(f,
1488 le64toh(f->header->entry_array_offset),
1493 int journal_file_skip_entry(
1495 Object *o, uint64_t p,
1497 Object **ret, uint64_t *offset) {
1506 if (o->object.type != OBJECT_ENTRY)
1509 r = generic_array_bisect(f,
1510 le64toh(f->header->entry_array_offset),
1511 le64toh(f->header->n_entries),
1520 /* Calculate new index */
1522 if ((uint64_t) -skip >= i)
1525 i = i - (uint64_t) -skip;
1527 i += (uint64_t) skip;
1529 n = le64toh(f->header->n_entries);
1536 return generic_array_get(f,
1537 le64toh(f->header->entry_array_offset),
1542 int journal_file_next_entry_for_data(
1544 Object *o, uint64_t p,
1545 uint64_t data_offset,
1546 direction_t direction,
1547 Object **ret, uint64_t *offset) {
1554 assert(p > 0 || !o);
1556 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
1560 n = le64toh(d->data.n_entries);
1565 i = direction == DIRECTION_DOWN ? 0 : n - 1;
1567 if (o->object.type != OBJECT_ENTRY)
1570 r = generic_array_bisect_plus_one(f,
1571 le64toh(d->data.entry_offset),
1572 le64toh(d->data.entry_array_offset),
1573 le64toh(d->data.n_entries),
1583 if (direction == DIRECTION_DOWN) {
1597 return generic_array_get_plus_one(f,
1598 le64toh(d->data.entry_offset),
1599 le64toh(d->data.entry_array_offset),
1604 int journal_file_move_to_entry_by_seqnum_for_data(
1606 uint64_t data_offset,
1608 direction_t direction,
1609 Object **ret, uint64_t *offset) {
1616 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
1620 return generic_array_bisect_plus_one(f,
1621 le64toh(d->data.entry_offset),
1622 le64toh(d->data.entry_array_offset),
1623 le64toh(d->data.n_entries),
1630 int journal_file_move_to_entry_by_realtime_for_data(
1632 uint64_t data_offset,
1634 direction_t direction,
1635 Object **ret, uint64_t *offset) {
1642 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
1646 return generic_array_bisect_plus_one(f,
1647 le64toh(d->data.entry_offset),
1648 le64toh(d->data.entry_array_offset),
1649 le64toh(d->data.n_entries),
1651 test_object_realtime,
1656 void journal_file_dump(JournalFile *f) {
1657 char a[33], b[33], c[33];
1664 printf("File Path: %s\n"
1668 "Arena size: %llu\n"
1672 sd_id128_to_string(f->header->file_id, a),
1673 sd_id128_to_string(f->header->machine_id, b),
1674 sd_id128_to_string(f->header->boot_id, c),
1675 (unsigned long long) le64toh(f->header->arena_size),
1676 (unsigned long) le64toh(f->header->n_objects),
1677 (unsigned long) le64toh(f->header->n_entries));
1679 p = le64toh(f->header->header_size);
1681 r = journal_file_move_to_object(f, -1, p, &o);
1685 switch (o->object.type) {
1688 printf("Type: OBJECT_UNUSED\n");
1692 printf("Type: OBJECT_DATA\n");
1696 printf("Type: OBJECT_ENTRY %llu %llu %llu\n",
1697 (unsigned long long) le64toh(o->entry.seqnum),
1698 (unsigned long long) le64toh(o->entry.monotonic),
1699 (unsigned long long) le64toh(o->entry.realtime));
1702 case OBJECT_FIELD_HASH_TABLE:
1703 printf("Type: OBJECT_FIELD_HASH_TABLE\n");
1706 case OBJECT_DATA_HASH_TABLE:
1707 printf("Type: OBJECT_DATA_HASH_TABLE\n");
1710 case OBJECT_ENTRY_ARRAY:
1711 printf("Type: OBJECT_ENTRY_ARRAY\n");
1714 case OBJECT_SIGNATURE:
1715 printf("Type: OBJECT_SIGNATURE\n");
1719 if (o->object.flags & OBJECT_COMPRESSED)
1720 printf("Flags: COMPRESSED\n");
1722 if (p == le64toh(f->header->tail_object_offset))
1725 p = p + ALIGN64(le64toh(o->object.size));
1730 log_error("File corrupt");
1733 int journal_file_open(
1737 JournalFile *template,
1738 JournalFile **ret) {
1742 bool newly_created = false;
1746 if ((flags & O_ACCMODE) != O_RDONLY &&
1747 (flags & O_ACCMODE) != O_RDWR)
1750 if (!endswith(fname, ".journal"))
1753 f = new0(JournalFile, 1);
1760 f->writable = (flags & O_ACCMODE) != O_RDONLY;
1761 f->prot = prot_from_flags(flags);
1764 f->metrics = template->metrics;
1765 f->compress = template->compress;
1768 f->path = strdup(fname);
1774 f->fd = open(f->path, f->flags|O_CLOEXEC, f->mode);
1780 if (fstat(f->fd, &f->last_stat) < 0) {
1785 if (f->last_stat.st_size == 0 && f->writable) {
1786 newly_created = true;
1788 r = journal_file_init_header(f, template);
1792 if (fstat(f->fd, &f->last_stat) < 0) {
1798 if (f->last_stat.st_size < (off_t) sizeof(Header)) {
1803 f->header = mmap(NULL, PAGE_ALIGN(sizeof(Header)), prot_from_flags(flags), MAP_SHARED, f->fd, 0);
1804 if (f->header == MAP_FAILED) {
1810 if (!newly_created) {
1811 r = journal_file_verify_header(f);
1817 r = journal_file_refresh_header(f);
1822 if (newly_created) {
1824 r = journal_file_setup_field_hash_table(f);
1828 r = journal_file_setup_data_hash_table(f);
1833 r = journal_file_map_field_hash_table(f);
1837 r = journal_file_map_data_hash_table(f);
1847 journal_file_close(f);
1852 int journal_file_rotate(JournalFile **f) {
1855 JournalFile *old_file, *new_file = NULL;
1863 if (!old_file->writable)
1866 if (!endswith(old_file->path, ".journal"))
1869 l = strlen(old_file->path);
1871 p = new(char, l + 1 + 32 + 1 + 16 + 1 + 16 + 1);
1875 memcpy(p, old_file->path, l - 8);
1877 sd_id128_to_string(old_file->header->seqnum_id, p + l - 8 + 1);
1878 snprintf(p + l - 8 + 1 + 32, 1 + 16 + 1 + 16 + 8 + 1,
1879 "-%016llx-%016llx.journal",
1880 (unsigned long long) le64toh((*f)->header->seqnum),
1881 (unsigned long long) le64toh((*f)->header->tail_entry_realtime));
1883 r = rename(old_file->path, p);
1889 old_file->header->state = STATE_ARCHIVED;
1891 r = journal_file_open(old_file->path, old_file->flags, old_file->mode, old_file, &new_file);
1892 journal_file_close(old_file);
1898 int journal_file_open_reliably(
1902 JournalFile *template,
1903 JournalFile **ret) {
1909 r = journal_file_open(fname, flags, mode, template, ret);
1910 if (r != -EBADMSG && /* corrupted */
1911 r != -ENODATA && /* truncated */
1912 r != -EHOSTDOWN && /* other machine */
1913 r != -EPROTONOSUPPORT) /* incompatible feature */
1916 if ((flags & O_ACCMODE) == O_RDONLY)
1919 if (!(flags & O_CREAT))
1922 /* The file is corrupted. Rotate it away and try it again (but only once) */
1925 if (asprintf(&p, "%.*s@%016llx-%016llx.journal~",
1927 (unsigned long long) now(CLOCK_REALTIME),
1931 r = rename(fname, p);
1936 log_warning("File %s corrupted, renaming and replacing.", fname);
1938 return journal_file_open(fname, flags, mode, template, ret);
1941 struct vacuum_info {
1946 sd_id128_t seqnum_id;
1952 static int vacuum_compare(const void *_a, const void *_b) {
1953 const struct vacuum_info *a, *b;
1958 if (a->have_seqnum && b->have_seqnum &&
1959 sd_id128_equal(a->seqnum_id, b->seqnum_id)) {
1960 if (a->seqnum < b->seqnum)
1962 else if (a->seqnum > b->seqnum)
1968 if (a->realtime < b->realtime)
1970 else if (a->realtime > b->realtime)
1972 else if (a->have_seqnum && b->have_seqnum)
1973 return memcmp(&a->seqnum_id, &b->seqnum_id, 16);
1975 return strcmp(a->filename, b->filename);
1978 int journal_directory_vacuum(const char *directory, uint64_t max_use, uint64_t min_free) {
1981 struct vacuum_info *list = NULL;
1982 unsigned n_list = 0, n_allocated = 0, i;
1990 d = opendir(directory);
1996 struct dirent buf, *de;
2000 unsigned long long seqnum = 0, realtime;
2001 sd_id128_t seqnum_id;
2004 k = readdir_r(d, &buf, &de);
2013 if (fstatat(dirfd(d), de->d_name, &st, AT_SYMLINK_NOFOLLOW) < 0)
2016 if (!S_ISREG(st.st_mode))
2019 q = strlen(de->d_name);
2021 if (endswith(de->d_name, ".journal")) {
2023 /* Vacuum archived files */
2025 if (q < 1 + 32 + 1 + 16 + 1 + 16 + 8)
2028 if (de->d_name[q-8-16-1] != '-' ||
2029 de->d_name[q-8-16-1-16-1] != '-' ||
2030 de->d_name[q-8-16-1-16-1-32-1] != '@')
2033 p = strdup(de->d_name);
2039 de->d_name[q-8-16-1-16-1] = 0;
2040 if (sd_id128_from_string(de->d_name + q-8-16-1-16-1-32, &seqnum_id) < 0) {
2045 if (sscanf(de->d_name + q-8-16-1-16, "%16llx-%16llx.journal", &seqnum, &realtime) != 2) {
2052 } else if (endswith(de->d_name, ".journal~")) {
2053 unsigned long long tmp;
2055 /* Vacuum corrupted files */
2057 if (q < 1 + 16 + 1 + 16 + 8 + 1)
2060 if (de->d_name[q-1-8-16-1] != '-' ||
2061 de->d_name[q-1-8-16-1-16-1] != '@')
2064 p = strdup(de->d_name);
2070 if (sscanf(de->d_name + q-1-8-16-1-16, "%16llx-%16llx.journal~", &realtime, &tmp) != 2) {
2075 have_seqnum = false;
2079 if (n_list >= n_allocated) {
2080 struct vacuum_info *j;
2082 n_allocated = MAX(n_allocated * 2U, 8U);
2083 j = realloc(list, n_allocated * sizeof(struct vacuum_info));
2093 list[n_list].filename = p;
2094 list[n_list].usage = 512UL * (uint64_t) st.st_blocks;
2095 list[n_list].seqnum = seqnum;
2096 list[n_list].realtime = realtime;
2097 list[n_list].seqnum_id = seqnum_id;
2098 list[n_list].have_seqnum = have_seqnum;
2100 sum += list[n_list].usage;
2105 qsort(list, n_list, sizeof(struct vacuum_info), vacuum_compare);
2107 for(i = 0; i < n_list; i++) {
2110 if (fstatvfs(dirfd(d), &ss) < 0) {
2115 if (sum <= max_use &&
2116 (uint64_t) ss.f_bavail * (uint64_t) ss.f_bsize >= min_free)
2119 if (unlinkat(dirfd(d), list[i].filename, 0) >= 0) {
2120 log_info("Deleted archived journal %s/%s.", directory, list[i].filename);
2121 sum -= list[i].usage;
2122 } else if (errno != ENOENT)
2123 log_warning("Failed to delete %s/%s: %m", directory, list[i].filename);
2127 for (i = 0; i < n_list; i++)
2128 free(list[i].filename);
2138 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset) {
2140 uint64_t q, xor_hash = 0;
2153 ts.monotonic = le64toh(o->entry.monotonic);
2154 ts.realtime = le64toh(o->entry.realtime);
2156 if (to->tail_entry_monotonic_valid &&
2157 ts.monotonic < le64toh(to->header->tail_entry_monotonic))
2160 if (ts.realtime < le64toh(to->header->tail_entry_realtime))
2163 n = journal_file_entry_n_items(o);
2164 items = alloca(sizeof(EntryItem) * n);
2166 for (i = 0; i < n; i++) {
2173 q = le64toh(o->entry.items[i].object_offset);
2174 le_hash = o->entry.items[i].hash;
2176 r = journal_file_move_to_object(from, OBJECT_DATA, q, &o);
2180 if (le_hash != o->data.hash)
2183 l = le64toh(o->object.size) - offsetof(Object, data.payload);
2186 /* We hit the limit on 32bit machines */
2187 if ((uint64_t) t != l)
2190 if (o->object.flags & OBJECT_COMPRESSED) {
2194 if (!uncompress_blob(o->data.payload, l, &from->compress_buffer, &from->compress_buffer_size, &rsize))
2197 data = from->compress_buffer;
2200 return -EPROTONOSUPPORT;
2203 data = o->data.payload;
2205 r = journal_file_append_data(to, data, l, &u, &h);
2209 xor_hash ^= le64toh(u->data.hash);
2210 items[i].object_offset = htole64(h);
2211 items[i].hash = u->data.hash;
2213 r = journal_file_move_to_object(from, OBJECT_ENTRY, p, &o);
2218 return journal_file_append_entry_internal(to, &ts, xor_hash, items, n, seqnum, ret, offset);
2221 void journal_default_metrics(JournalMetrics *m, int fd) {
2222 uint64_t fs_size = 0;
2224 char a[FORMAT_BYTES_MAX], b[FORMAT_BYTES_MAX], c[FORMAT_BYTES_MAX], d[FORMAT_BYTES_MAX];
2229 if (fstatvfs(fd, &ss) >= 0)
2230 fs_size = ss.f_frsize * ss.f_blocks;
2232 if (m->max_use == (uint64_t) -1) {
2235 m->max_use = PAGE_ALIGN(fs_size / 10); /* 10% of file system size */
2237 if (m->max_use > DEFAULT_MAX_USE_UPPER)
2238 m->max_use = DEFAULT_MAX_USE_UPPER;
2240 if (m->max_use < DEFAULT_MAX_USE_LOWER)
2241 m->max_use = DEFAULT_MAX_USE_LOWER;
2243 m->max_use = DEFAULT_MAX_USE_LOWER;
2245 m->max_use = PAGE_ALIGN(m->max_use);
2247 if (m->max_use < JOURNAL_FILE_SIZE_MIN*2)
2248 m->max_use = JOURNAL_FILE_SIZE_MIN*2;
2251 if (m->max_size == (uint64_t) -1) {
2252 m->max_size = PAGE_ALIGN(m->max_use / 8); /* 8 chunks */
2254 if (m->max_size > DEFAULT_MAX_SIZE_UPPER)
2255 m->max_size = DEFAULT_MAX_SIZE_UPPER;
2257 m->max_size = PAGE_ALIGN(m->max_size);
2259 if (m->max_size < JOURNAL_FILE_SIZE_MIN)
2260 m->max_size = JOURNAL_FILE_SIZE_MIN;
2262 if (m->max_size*2 > m->max_use)
2263 m->max_use = m->max_size*2;
2265 if (m->min_size == (uint64_t) -1)
2266 m->min_size = JOURNAL_FILE_SIZE_MIN;
2268 m->min_size = PAGE_ALIGN(m->min_size);
2270 if (m->min_size < JOURNAL_FILE_SIZE_MIN)
2271 m->min_size = JOURNAL_FILE_SIZE_MIN;
2273 if (m->min_size > m->max_size)
2274 m->max_size = m->min_size;
2277 if (m->keep_free == (uint64_t) -1) {
2280 m->keep_free = PAGE_ALIGN(fs_size / 20); /* 5% of file system size */
2282 if (m->keep_free > DEFAULT_KEEP_FREE_UPPER)
2283 m->keep_free = DEFAULT_KEEP_FREE_UPPER;
2286 m->keep_free = DEFAULT_KEEP_FREE;
2289 log_info("Fixed max_use=%s max_size=%s min_size=%s keep_free=%s",
2290 format_bytes(a, sizeof(a), m->max_use),
2291 format_bytes(b, sizeof(b), m->max_size),
2292 format_bytes(c, sizeof(c), m->min_size),
2293 format_bytes(d, sizeof(d), m->keep_free));
2296 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to) {
2304 r = journal_file_next_entry(f, NULL, 0, DIRECTION_DOWN, &o, NULL);
2308 *from = le64toh(o->entry.realtime);
2312 r = journal_file_next_entry(f, NULL, 0, DIRECTION_UP, &o, NULL);
2316 *to = le64toh(o->entry.realtime);
2322 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot_id, usec_t *from, usec_t *to) {
2323 char t[9+32+1] = "_BOOT_ID=";
2331 sd_id128_to_string(boot_id, t + 9);
2333 r = journal_file_find_data_object(f, t, strlen(t), &o, &p);
2337 if (le64toh(o->data.n_entries) <= 0)
2341 r = journal_file_move_to_object(f, OBJECT_ENTRY, le64toh(o->data.entry_offset), &o);
2345 *from = le64toh(o->entry.monotonic);
2349 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
2353 r = generic_array_get_plus_one(f,
2354 le64toh(o->data.entry_offset),
2355 le64toh(o->data.entry_array_offset),
2356 le64toh(o->data.n_entries)-1,
2361 *to = le64toh(o->entry.monotonic);