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>
29 #include <sys/xattr.h>
31 #include "journal-def.h"
32 #include "journal-file.h"
33 #include "journal-authenticate.h"
38 #define DEFAULT_DATA_HASH_TABLE_SIZE (2047ULL*sizeof(HashItem))
39 #define DEFAULT_FIELD_HASH_TABLE_SIZE (333ULL*sizeof(HashItem))
41 #define COMPRESSION_SIZE_THRESHOLD (512ULL)
43 /* This is the minimum journal file size */
44 #define JOURNAL_FILE_SIZE_MIN (4ULL*1024ULL*1024ULL) /* 4 MiB */
46 /* These are the lower and upper bounds if we deduce the max_use value
47 * from the file system size */
48 #define DEFAULT_MAX_USE_LOWER (1ULL*1024ULL*1024ULL) /* 1 MiB */
49 #define DEFAULT_MAX_USE_UPPER (4ULL*1024ULL*1024ULL*1024ULL) /* 4 GiB */
51 /* This is the upper bound if we deduce max_size from max_use */
52 #define DEFAULT_MAX_SIZE_UPPER (128ULL*1024ULL*1024ULL) /* 128 MiB */
54 /* This is the upper bound if we deduce the keep_free value from the
56 #define DEFAULT_KEEP_FREE_UPPER (4ULL*1024ULL*1024ULL*1024ULL) /* 4 GiB */
58 /* This is the keep_free value when we can't determine the system
60 #define DEFAULT_KEEP_FREE (1024ULL*1024ULL) /* 1 MB */
62 /* n_data was the first entry we added after the initial file format design */
63 #define HEADER_SIZE_MIN ALIGN64(offsetof(Header, n_data))
65 /* How many entries to keep in the entry array chain cache at max */
66 #define CHAIN_CACHE_MAX 20
68 /* How much to increase the journal file size at once each time we allocate something new. */
69 #define FILE_SIZE_INCREASE (8ULL*1024ULL*1024ULL) /* 8MB */
71 static int journal_file_set_online(JournalFile *f) {
77 if (!(f->fd >= 0 && f->header))
80 switch(f->header->state) {
85 f->header->state = STATE_ONLINE;
94 int journal_file_set_offline(JournalFile *f) {
100 if (!(f->fd >= 0 && f->header))
103 if (f->header->state != STATE_ONLINE)
108 f->header->state = STATE_OFFLINE;
115 void journal_file_close(JournalFile *f) {
119 /* Write the final tag */
120 if (f->seal && f->writable)
121 journal_file_append_tag(f);
124 /* Sync everything to disk, before we mark the file offline */
125 if (f->mmap && f->fd >= 0)
126 mmap_cache_close_fd(f->mmap, f->fd);
128 journal_file_set_offline(f);
131 munmap(f->header, PAGE_ALIGN(sizeof(Header)));
137 mmap_cache_unref(f->mmap);
139 ordered_hashmap_free_free(f->chain_cache);
141 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
142 free(f->compress_buffer);
147 munmap(f->fss_file, PAGE_ALIGN(f->fss_file_size));
148 else if (f->fsprg_state)
149 free(f->fsprg_state);
154 gcry_md_close(f->hmac);
160 static int journal_file_init_header(JournalFile *f, JournalFile *template) {
167 memcpy(h.signature, HEADER_SIGNATURE, 8);
168 h.header_size = htole64(ALIGN64(sizeof(h)));
170 h.incompatible_flags |= htole32(
171 f->compress_xz * HEADER_INCOMPATIBLE_COMPRESSED_XZ |
172 f->compress_lz4 * HEADER_INCOMPATIBLE_COMPRESSED_LZ4);
174 h.compatible_flags = htole32(
175 f->seal * HEADER_COMPATIBLE_SEALED);
177 r = sd_id128_randomize(&h.file_id);
182 h.seqnum_id = template->header->seqnum_id;
183 h.tail_entry_seqnum = template->header->tail_entry_seqnum;
185 h.seqnum_id = h.file_id;
187 k = pwrite(f->fd, &h, sizeof(h), 0);
197 static int journal_file_refresh_header(JournalFile *f) {
203 r = sd_id128_get_machine(&f->header->machine_id);
207 r = sd_id128_get_boot(&boot_id);
211 if (sd_id128_equal(boot_id, f->header->boot_id))
212 f->tail_entry_monotonic_valid = true;
214 f->header->boot_id = boot_id;
216 journal_file_set_online(f);
218 /* Sync the online state to disk */
224 static int journal_file_verify_header(JournalFile *f) {
229 if (memcmp(f->header->signature, HEADER_SIGNATURE, 8))
232 /* In both read and write mode we refuse to open files with
233 * incompatible flags we don't know */
234 flags = le32toh(f->header->incompatible_flags);
235 if (flags & ~HEADER_INCOMPATIBLE_SUPPORTED) {
236 if (flags & ~HEADER_INCOMPATIBLE_ANY)
237 log_debug("Journal file %s has unknown incompatible flags %"PRIx32,
238 f->path, flags & ~HEADER_INCOMPATIBLE_ANY);
239 flags = (flags & HEADER_INCOMPATIBLE_ANY) & ~HEADER_INCOMPATIBLE_SUPPORTED;
241 log_debug("Journal file %s uses incompatible flags %"PRIx32
242 " disabled at compilation time.", f->path, flags);
243 return -EPROTONOSUPPORT;
246 /* When open for writing we refuse to open files with
247 * compatible flags, too */
248 flags = le32toh(f->header->compatible_flags);
249 if (f->writable && (flags & ~HEADER_COMPATIBLE_SUPPORTED)) {
250 if (flags & ~HEADER_COMPATIBLE_ANY)
251 log_debug("Journal file %s has unknown compatible flags %"PRIx32,
252 f->path, flags & ~HEADER_COMPATIBLE_ANY);
253 flags = (flags & HEADER_COMPATIBLE_ANY) & ~HEADER_COMPATIBLE_SUPPORTED;
255 log_debug("Journal file %s uses compatible flags %"PRIx32
256 " disabled at compilation time.", f->path, flags);
257 return -EPROTONOSUPPORT;
260 if (f->header->state >= _STATE_MAX)
263 /* The first addition was n_data, so check that we are at least this large */
264 if (le64toh(f->header->header_size) < HEADER_SIZE_MIN)
267 if (JOURNAL_HEADER_SEALED(f->header) && !JOURNAL_HEADER_CONTAINS(f->header, n_entry_arrays))
270 if ((le64toh(f->header->header_size) + le64toh(f->header->arena_size)) > (uint64_t) f->last_stat.st_size)
273 if (le64toh(f->header->tail_object_offset) > (le64toh(f->header->header_size) + le64toh(f->header->arena_size)))
276 if (!VALID64(le64toh(f->header->data_hash_table_offset)) ||
277 !VALID64(le64toh(f->header->field_hash_table_offset)) ||
278 !VALID64(le64toh(f->header->tail_object_offset)) ||
279 !VALID64(le64toh(f->header->entry_array_offset)))
284 sd_id128_t machine_id;
287 r = sd_id128_get_machine(&machine_id);
291 if (!sd_id128_equal(machine_id, f->header->machine_id))
294 state = f->header->state;
296 if (state == STATE_ONLINE) {
297 log_debug("Journal file %s is already online. Assuming unclean closing.", f->path);
299 } else if (state == STATE_ARCHIVED)
301 else if (state != STATE_OFFLINE) {
302 log_debug("Journal file %s has unknown state %u.", f->path, state);
307 f->compress_xz = JOURNAL_HEADER_COMPRESSED_XZ(f->header);
308 f->compress_lz4 = JOURNAL_HEADER_COMPRESSED_LZ4(f->header);
310 f->seal = JOURNAL_HEADER_SEALED(f->header);
315 static int journal_file_allocate(JournalFile *f, uint64_t offset, uint64_t size) {
316 uint64_t old_size, new_size;
321 /* We assume that this file is not sparse, and we know that
322 * for sure, since we always call posix_fallocate()
326 le64toh(f->header->header_size) +
327 le64toh(f->header->arena_size);
329 new_size = PAGE_ALIGN(offset + size);
330 if (new_size < le64toh(f->header->header_size))
331 new_size = le64toh(f->header->header_size);
333 if (new_size <= old_size)
336 if (f->metrics.max_size > 0 && new_size > f->metrics.max_size)
339 if (new_size > f->metrics.min_size && f->metrics.keep_free > 0) {
342 if (fstatvfs(f->fd, &svfs) >= 0) {
345 available = svfs.f_bfree * svfs.f_bsize;
347 if (available >= f->metrics.keep_free)
348 available -= f->metrics.keep_free;
352 if (new_size - old_size > available)
357 /* Increase by larger blocks at once */
358 new_size = ((new_size+FILE_SIZE_INCREASE-1) / FILE_SIZE_INCREASE) * FILE_SIZE_INCREASE;
359 if (f->metrics.max_size > 0 && new_size > f->metrics.max_size)
360 new_size = f->metrics.max_size;
362 /* Note that the glibc fallocate() fallback is very
363 inefficient, hence we try to minimize the allocation area
365 r = posix_fallocate(f->fd, old_size, new_size - old_size);
369 if (fstat(f->fd, &f->last_stat) < 0)
372 f->header->arena_size = htole64(new_size - le64toh(f->header->header_size));
377 static unsigned type_to_context(ObjectType type) {
378 /* One context for each type, plus one catch-all for the rest */
379 assert_cc(_OBJECT_TYPE_MAX <= MMAP_CACHE_MAX_CONTEXTS);
380 return type > OBJECT_UNUSED && type < _OBJECT_TYPE_MAX ? type : 0;
383 static int journal_file_move_to(JournalFile *f, ObjectType type, bool keep_always, uint64_t offset, uint64_t size, void **ret) {
390 /* Avoid SIGBUS on invalid accesses */
391 if (offset + size > (uint64_t) f->last_stat.st_size) {
392 /* Hmm, out of range? Let's refresh the fstat() data
393 * first, before we trust that check. */
395 if (fstat(f->fd, &f->last_stat) < 0 ||
396 offset + size > (uint64_t) f->last_stat.st_size)
397 return -EADDRNOTAVAIL;
400 return mmap_cache_get(f->mmap, f->fd, f->prot, type_to_context(type), keep_always, offset, size, &f->last_stat, ret);
403 static uint64_t minimum_header_size(Object *o) {
405 static const uint64_t table[] = {
406 [OBJECT_DATA] = sizeof(DataObject),
407 [OBJECT_FIELD] = sizeof(FieldObject),
408 [OBJECT_ENTRY] = sizeof(EntryObject),
409 [OBJECT_DATA_HASH_TABLE] = sizeof(HashTableObject),
410 [OBJECT_FIELD_HASH_TABLE] = sizeof(HashTableObject),
411 [OBJECT_ENTRY_ARRAY] = sizeof(EntryArrayObject),
412 [OBJECT_TAG] = sizeof(TagObject),
415 if (o->object.type >= ELEMENTSOF(table) || table[o->object.type] <= 0)
416 return sizeof(ObjectHeader);
418 return table[o->object.type];
421 int journal_file_move_to_object(JournalFile *f, ObjectType type, uint64_t offset, Object **ret) {
430 /* Objects may only be located at multiple of 64 bit */
431 if (!VALID64(offset))
434 r = journal_file_move_to(f, type, false, offset, sizeof(ObjectHeader), &t);
439 s = le64toh(o->object.size);
441 if (s < sizeof(ObjectHeader))
444 if (o->object.type <= OBJECT_UNUSED)
447 if (s < minimum_header_size(o))
450 if (type > OBJECT_UNUSED && o->object.type != type)
453 if (s > sizeof(ObjectHeader)) {
454 r = journal_file_move_to(f, type, false, offset, s, &t);
465 static uint64_t journal_file_entry_seqnum(JournalFile *f, uint64_t *seqnum) {
470 r = le64toh(f->header->tail_entry_seqnum) + 1;
473 /* If an external seqnum counter was passed, we update
474 * both the local and the external one, and set it to
475 * the maximum of both */
483 f->header->tail_entry_seqnum = htole64(r);
485 if (f->header->head_entry_seqnum == 0)
486 f->header->head_entry_seqnum = htole64(r);
491 int journal_file_append_object(JournalFile *f, ObjectType type, uint64_t size, Object **ret, uint64_t *offset) {
498 assert(type > OBJECT_UNUSED && type < _OBJECT_TYPE_MAX);
499 assert(size >= sizeof(ObjectHeader));
503 r = journal_file_set_online(f);
507 p = le64toh(f->header->tail_object_offset);
509 p = le64toh(f->header->header_size);
511 r = journal_file_move_to_object(f, OBJECT_UNUSED, p, &tail);
515 p += ALIGN64(le64toh(tail->object.size));
518 r = journal_file_allocate(f, p, size);
522 r = journal_file_move_to(f, type, false, p, size, &t);
529 o->object.type = type;
530 o->object.size = htole64(size);
532 f->header->tail_object_offset = htole64(p);
533 f->header->n_objects = htole64(le64toh(f->header->n_objects) + 1);
541 static int journal_file_setup_data_hash_table(JournalFile *f) {
548 /* We estimate that we need 1 hash table entry per 768 of
549 journal file and we want to make sure we never get beyond
550 75% fill level. Calculate the hash table size for the
551 maximum file size based on these metrics. */
553 s = (f->metrics.max_size * 4 / 768 / 3) * sizeof(HashItem);
554 if (s < DEFAULT_DATA_HASH_TABLE_SIZE)
555 s = DEFAULT_DATA_HASH_TABLE_SIZE;
557 log_debug("Reserving %"PRIu64" entries in hash table.", s / sizeof(HashItem));
559 r = journal_file_append_object(f,
560 OBJECT_DATA_HASH_TABLE,
561 offsetof(Object, hash_table.items) + s,
566 memzero(o->hash_table.items, s);
568 f->header->data_hash_table_offset = htole64(p + offsetof(Object, hash_table.items));
569 f->header->data_hash_table_size = htole64(s);
574 static int journal_file_setup_field_hash_table(JournalFile *f) {
581 /* We use a fixed size hash table for the fields as this
582 * number should grow very slowly only */
584 s = DEFAULT_FIELD_HASH_TABLE_SIZE;
585 r = journal_file_append_object(f,
586 OBJECT_FIELD_HASH_TABLE,
587 offsetof(Object, hash_table.items) + s,
592 memzero(o->hash_table.items, s);
594 f->header->field_hash_table_offset = htole64(p + offsetof(Object, hash_table.items));
595 f->header->field_hash_table_size = htole64(s);
600 static int journal_file_map_data_hash_table(JournalFile *f) {
607 p = le64toh(f->header->data_hash_table_offset);
608 s = le64toh(f->header->data_hash_table_size);
610 r = journal_file_move_to(f,
611 OBJECT_DATA_HASH_TABLE,
618 f->data_hash_table = t;
622 static int journal_file_map_field_hash_table(JournalFile *f) {
629 p = le64toh(f->header->field_hash_table_offset);
630 s = le64toh(f->header->field_hash_table_size);
632 r = journal_file_move_to(f,
633 OBJECT_FIELD_HASH_TABLE,
640 f->field_hash_table = t;
644 static int journal_file_link_field(
657 if (o->object.type != OBJECT_FIELD)
660 /* This might alter the window we are looking at */
662 o->field.next_hash_offset = o->field.head_data_offset = 0;
664 h = hash % (le64toh(f->header->field_hash_table_size) / sizeof(HashItem));
665 p = le64toh(f->field_hash_table[h].tail_hash_offset);
667 f->field_hash_table[h].head_hash_offset = htole64(offset);
669 r = journal_file_move_to_object(f, OBJECT_FIELD, p, &o);
673 o->field.next_hash_offset = htole64(offset);
676 f->field_hash_table[h].tail_hash_offset = htole64(offset);
678 if (JOURNAL_HEADER_CONTAINS(f->header, n_fields))
679 f->header->n_fields = htole64(le64toh(f->header->n_fields) + 1);
684 static int journal_file_link_data(
697 if (o->object.type != OBJECT_DATA)
700 /* This might alter the window we are looking at */
702 o->data.next_hash_offset = o->data.next_field_offset = 0;
703 o->data.entry_offset = o->data.entry_array_offset = 0;
704 o->data.n_entries = 0;
706 h = hash % (le64toh(f->header->data_hash_table_size) / sizeof(HashItem));
707 p = le64toh(f->data_hash_table[h].tail_hash_offset);
709 /* Only entry in the hash table is easy */
710 f->data_hash_table[h].head_hash_offset = htole64(offset);
712 /* Move back to the previous data object, to patch in
715 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
719 o->data.next_hash_offset = htole64(offset);
722 f->data_hash_table[h].tail_hash_offset = htole64(offset);
724 if (JOURNAL_HEADER_CONTAINS(f->header, n_data))
725 f->header->n_data = htole64(le64toh(f->header->n_data) + 1);
730 int journal_file_find_field_object_with_hash(
732 const void *field, uint64_t size, uint64_t hash,
733 Object **ret, uint64_t *offset) {
735 uint64_t p, osize, h;
739 assert(field && size > 0);
741 osize = offsetof(Object, field.payload) + size;
743 if (f->header->field_hash_table_size == 0)
746 h = hash % (le64toh(f->header->field_hash_table_size) / sizeof(HashItem));
747 p = le64toh(f->field_hash_table[h].head_hash_offset);
752 r = journal_file_move_to_object(f, OBJECT_FIELD, p, &o);
756 if (le64toh(o->field.hash) == hash &&
757 le64toh(o->object.size) == osize &&
758 memcmp(o->field.payload, field, size) == 0) {
768 p = le64toh(o->field.next_hash_offset);
774 int journal_file_find_field_object(
776 const void *field, uint64_t size,
777 Object **ret, uint64_t *offset) {
782 assert(field && size > 0);
784 hash = hash64(field, size);
786 return journal_file_find_field_object_with_hash(f,
791 int journal_file_find_data_object_with_hash(
793 const void *data, uint64_t size, uint64_t hash,
794 Object **ret, uint64_t *offset) {
796 uint64_t p, osize, h;
800 assert(data || size == 0);
802 osize = offsetof(Object, data.payload) + size;
804 if (f->header->data_hash_table_size == 0)
807 h = hash % (le64toh(f->header->data_hash_table_size) / sizeof(HashItem));
808 p = le64toh(f->data_hash_table[h].head_hash_offset);
813 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
817 if (le64toh(o->data.hash) != hash)
820 if (o->object.flags & OBJECT_COMPRESSION_MASK) {
821 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
825 l = le64toh(o->object.size);
826 if (l <= offsetof(Object, data.payload))
829 l -= offsetof(Object, data.payload);
831 r = decompress_blob(o->object.flags & OBJECT_COMPRESSION_MASK,
832 o->data.payload, l, &f->compress_buffer, &f->compress_buffer_size, &rsize, 0);
837 memcmp(f->compress_buffer, data, size) == 0) {
848 return -EPROTONOSUPPORT;
850 } else if (le64toh(o->object.size) == osize &&
851 memcmp(o->data.payload, data, size) == 0) {
863 p = le64toh(o->data.next_hash_offset);
869 int journal_file_find_data_object(
871 const void *data, uint64_t size,
872 Object **ret, uint64_t *offset) {
877 assert(data || size == 0);
879 hash = hash64(data, size);
881 return journal_file_find_data_object_with_hash(f,
886 static int journal_file_append_field(
888 const void *field, uint64_t size,
889 Object **ret, uint64_t *offset) {
897 assert(field && size > 0);
899 hash = hash64(field, size);
901 r = journal_file_find_field_object_with_hash(f, field, size, hash, &o, &p);
915 osize = offsetof(Object, field.payload) + size;
916 r = journal_file_append_object(f, OBJECT_FIELD, osize, &o, &p);
920 o->field.hash = htole64(hash);
921 memcpy(o->field.payload, field, size);
923 r = journal_file_link_field(f, o, p, hash);
927 /* The linking might have altered the window, so let's
928 * refresh our pointer */
929 r = journal_file_move_to_object(f, OBJECT_FIELD, p, &o);
934 r = journal_file_hmac_put_object(f, OBJECT_FIELD, o, p);
948 static int journal_file_append_data(
950 const void *data, uint64_t size,
951 Object **ret, uint64_t *offset) {
956 int r, compression = 0;
960 assert(data || size == 0);
962 hash = hash64(data, size);
964 r = journal_file_find_data_object_with_hash(f, data, size, hash, &o, &p);
978 osize = offsetof(Object, data.payload) + size;
979 r = journal_file_append_object(f, OBJECT_DATA, osize, &o, &p);
983 o->data.hash = htole64(hash);
985 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
986 if (f->compress_xz &&
987 size >= COMPRESSION_SIZE_THRESHOLD) {
990 compression = compress_blob(data, size, o->data.payload, &rsize);
993 o->object.size = htole64(offsetof(Object, data.payload) + rsize);
994 o->object.flags |= compression;
996 log_debug("Compressed data object %"PRIu64" -> %zu using %s",
997 size, rsize, object_compressed_to_string(compression));
1002 if (!compression && size > 0)
1003 memcpy(o->data.payload, data, size);
1005 r = journal_file_link_data(f, o, p, hash);
1009 /* The linking might have altered the window, so let's
1010 * refresh our pointer */
1011 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
1018 eq = memchr(data, '=', size);
1019 if (eq && eq > data) {
1023 /* Create field object ... */
1024 r = journal_file_append_field(f, data, (uint8_t*) eq - (uint8_t*) data, &fo, &fp);
1028 /* ... and link it in. */
1029 o->data.next_field_offset = fo->field.head_data_offset;
1030 fo->field.head_data_offset = le64toh(p);
1034 r = journal_file_hmac_put_object(f, OBJECT_DATA, o, p);
1048 uint64_t journal_file_entry_n_items(Object *o) {
1051 if (o->object.type != OBJECT_ENTRY)
1054 return (le64toh(o->object.size) - offsetof(Object, entry.items)) / sizeof(EntryItem);
1057 uint64_t journal_file_entry_array_n_items(Object *o) {
1060 if (o->object.type != OBJECT_ENTRY_ARRAY)
1063 return (le64toh(o->object.size) - offsetof(Object, entry_array.items)) / sizeof(uint64_t);
1066 uint64_t journal_file_hash_table_n_items(Object *o) {
1069 if (o->object.type != OBJECT_DATA_HASH_TABLE &&
1070 o->object.type != OBJECT_FIELD_HASH_TABLE)
1073 return (le64toh(o->object.size) - offsetof(Object, hash_table.items)) / sizeof(HashItem);
1076 static int link_entry_into_array(JournalFile *f,
1081 uint64_t n = 0, ap = 0, q, i, a, hidx;
1089 a = le64toh(*first);
1090 i = hidx = le64toh(*idx);
1093 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &o);
1097 n = journal_file_entry_array_n_items(o);
1099 o->entry_array.items[i] = htole64(p);
1100 *idx = htole64(hidx + 1);
1106 a = le64toh(o->entry_array.next_entry_array_offset);
1117 r = journal_file_append_object(f, OBJECT_ENTRY_ARRAY,
1118 offsetof(Object, entry_array.items) + n * sizeof(uint64_t),
1124 r = journal_file_hmac_put_object(f, OBJECT_ENTRY_ARRAY, o, q);
1129 o->entry_array.items[i] = htole64(p);
1132 *first = htole64(q);
1134 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, ap, &o);
1138 o->entry_array.next_entry_array_offset = htole64(q);
1141 if (JOURNAL_HEADER_CONTAINS(f->header, n_entry_arrays))
1142 f->header->n_entry_arrays = htole64(le64toh(f->header->n_entry_arrays) + 1);
1144 *idx = htole64(hidx + 1);
1149 static int link_entry_into_array_plus_one(JournalFile *f,
1164 *extra = htole64(p);
1168 i = htole64(le64toh(*idx) - 1);
1169 r = link_entry_into_array(f, first, &i, p);
1174 *idx = htole64(le64toh(*idx) + 1);
1178 static int journal_file_link_entry_item(JournalFile *f, Object *o, uint64_t offset, uint64_t i) {
1185 p = le64toh(o->entry.items[i].object_offset);
1189 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
1193 return link_entry_into_array_plus_one(f,
1194 &o->data.entry_offset,
1195 &o->data.entry_array_offset,
1200 static int journal_file_link_entry(JournalFile *f, Object *o, uint64_t offset) {
1208 if (o->object.type != OBJECT_ENTRY)
1211 __sync_synchronize();
1213 /* Link up the entry itself */
1214 r = link_entry_into_array(f,
1215 &f->header->entry_array_offset,
1216 &f->header->n_entries,
1221 /* log_debug("=> %s seqnr=%"PRIu64" n_entries=%"PRIu64, f->path, o->entry.seqnum, f->header->n_entries); */
1223 if (f->header->head_entry_realtime == 0)
1224 f->header->head_entry_realtime = o->entry.realtime;
1226 f->header->tail_entry_realtime = o->entry.realtime;
1227 f->header->tail_entry_monotonic = o->entry.monotonic;
1229 f->tail_entry_monotonic_valid = true;
1231 /* Link up the items */
1232 n = journal_file_entry_n_items(o);
1233 for (i = 0; i < n; i++) {
1234 r = journal_file_link_entry_item(f, o, offset, i);
1242 static int journal_file_append_entry_internal(
1244 const dual_timestamp *ts,
1246 const EntryItem items[], unsigned n_items,
1248 Object **ret, uint64_t *offset) {
1255 assert(items || n_items == 0);
1258 osize = offsetof(Object, entry.items) + (n_items * sizeof(EntryItem));
1260 r = journal_file_append_object(f, OBJECT_ENTRY, osize, &o, &np);
1264 o->entry.seqnum = htole64(journal_file_entry_seqnum(f, seqnum));
1265 memcpy(o->entry.items, items, n_items * sizeof(EntryItem));
1266 o->entry.realtime = htole64(ts->realtime);
1267 o->entry.monotonic = htole64(ts->monotonic);
1268 o->entry.xor_hash = htole64(xor_hash);
1269 o->entry.boot_id = f->header->boot_id;
1272 r = journal_file_hmac_put_object(f, OBJECT_ENTRY, o, np);
1277 r = journal_file_link_entry(f, o, np);
1290 void journal_file_post_change(JournalFile *f) {
1293 /* inotify() does not receive IN_MODIFY events from file
1294 * accesses done via mmap(). After each access we hence
1295 * trigger IN_MODIFY by truncating the journal file to its
1296 * current size which triggers IN_MODIFY. */
1298 __sync_synchronize();
1300 if (ftruncate(f->fd, f->last_stat.st_size) < 0)
1301 log_error_errno(errno, "Failed to truncate file to its own size: %m");
1304 static int entry_item_cmp(const void *_a, const void *_b) {
1305 const EntryItem *a = _a, *b = _b;
1307 if (le64toh(a->object_offset) < le64toh(b->object_offset))
1309 if (le64toh(a->object_offset) > le64toh(b->object_offset))
1314 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) {
1318 uint64_t xor_hash = 0;
1319 struct dual_timestamp _ts;
1322 assert(iovec || n_iovec == 0);
1325 dual_timestamp_get(&_ts);
1329 if (f->tail_entry_monotonic_valid &&
1330 ts->monotonic < le64toh(f->header->tail_entry_monotonic))
1334 r = journal_file_maybe_append_tag(f, ts->realtime);
1339 /* alloca() can't take 0, hence let's allocate at least one */
1340 items = alloca(sizeof(EntryItem) * MAX(1u, n_iovec));
1342 for (i = 0; i < n_iovec; i++) {
1346 r = journal_file_append_data(f, iovec[i].iov_base, iovec[i].iov_len, &o, &p);
1350 xor_hash ^= le64toh(o->data.hash);
1351 items[i].object_offset = htole64(p);
1352 items[i].hash = o->data.hash;
1355 /* Order by the position on disk, in order to improve seek
1356 * times for rotating media. */
1357 qsort_safe(items, n_iovec, sizeof(EntryItem), entry_item_cmp);
1359 r = journal_file_append_entry_internal(f, ts, xor_hash, items, n_iovec, seqnum, ret, offset);
1361 journal_file_post_change(f);
1366 typedef struct ChainCacheItem {
1367 uint64_t first; /* the array at the beginning of the chain */
1368 uint64_t array; /* the cached array */
1369 uint64_t begin; /* the first item in the cached array */
1370 uint64_t total; /* the total number of items in all arrays before this one in the chain */
1371 uint64_t last_index; /* the last index we looked at, to optimize locality when bisecting */
1374 static void chain_cache_put(
1381 uint64_t last_index) {
1384 /* If the chain item to cache for this chain is the
1385 * first one it's not worth caching anything */
1389 if (ordered_hashmap_size(h) >= CHAIN_CACHE_MAX) {
1390 ci = ordered_hashmap_steal_first(h);
1393 ci = new(ChainCacheItem, 1);
1400 if (ordered_hashmap_put(h, &ci->first, ci) < 0) {
1405 assert(ci->first == first);
1410 ci->last_index = last_index;
1413 static int generic_array_get(
1417 Object **ret, uint64_t *offset) {
1420 uint64_t p = 0, a, t = 0;
1428 /* Try the chain cache first */
1429 ci = ordered_hashmap_get(f->chain_cache, &first);
1430 if (ci && i > ci->total) {
1439 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &o);
1443 k = journal_file_entry_array_n_items(o);
1445 p = le64toh(o->entry_array.items[i]);
1451 a = le64toh(o->entry_array.next_entry_array_offset);
1457 /* Let's cache this item for the next invocation */
1458 chain_cache_put(f->chain_cache, ci, first, a, le64toh(o->entry_array.items[0]), t, i);
1460 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1473 static int generic_array_get_plus_one(
1478 Object **ret, uint64_t *offset) {
1487 r = journal_file_move_to_object(f, OBJECT_ENTRY, extra, &o);
1500 return generic_array_get(f, first, i-1, ret, offset);
1509 static int generic_array_bisect(
1514 int (*test_object)(JournalFile *f, uint64_t p, uint64_t needle),
1515 direction_t direction,
1520 uint64_t a, p, t = 0, i = 0, last_p = 0, last_index = (uint64_t) -1;
1521 bool subtract_one = false;
1522 Object *o, *array = NULL;
1527 assert(test_object);
1529 /* Start with the first array in the chain */
1532 ci = ordered_hashmap_get(f->chain_cache, &first);
1533 if (ci && n > ci->total) {
1534 /* Ah, we have iterated this bisection array chain
1535 * previously! Let's see if we can skip ahead in the
1536 * chain, as far as the last time. But we can't jump
1537 * backwards in the chain, so let's check that
1540 r = test_object(f, ci->begin, needle);
1544 if (r == TEST_LEFT) {
1545 /* OK, what we are looking for is right of the
1546 * begin of this EntryArray, so let's jump
1547 * straight to previously cached array in the
1553 last_index = ci->last_index;
1558 uint64_t left, right, k, lp;
1560 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &array);
1564 k = journal_file_entry_array_n_items(array);
1570 lp = p = le64toh(array->entry_array.items[i]);
1574 r = test_object(f, p, needle);
1578 if (r == TEST_FOUND)
1579 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1581 if (r == TEST_RIGHT) {
1585 if (last_index != (uint64_t) -1) {
1586 assert(last_index <= right);
1588 /* If we cached the last index we
1589 * looked at, let's try to not to jump
1590 * too wildly around and see if we can
1591 * limit the range to look at early to
1592 * the immediate neighbors of the last
1593 * index we looked at. */
1595 if (last_index > 0) {
1596 uint64_t x = last_index - 1;
1598 p = le64toh(array->entry_array.items[x]);
1602 r = test_object(f, p, needle);
1606 if (r == TEST_FOUND)
1607 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1609 if (r == TEST_RIGHT)
1615 if (last_index < right) {
1616 uint64_t y = last_index + 1;
1618 p = le64toh(array->entry_array.items[y]);
1622 r = test_object(f, p, needle);
1626 if (r == TEST_FOUND)
1627 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1629 if (r == TEST_RIGHT)
1637 if (left == right) {
1638 if (direction == DIRECTION_UP)
1639 subtract_one = true;
1645 assert(left < right);
1646 i = (left + right) / 2;
1648 p = le64toh(array->entry_array.items[i]);
1652 r = test_object(f, p, needle);
1656 if (r == TEST_FOUND)
1657 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1659 if (r == TEST_RIGHT)
1667 if (direction == DIRECTION_UP) {
1669 subtract_one = true;
1680 last_index = (uint64_t) -1;
1681 a = le64toh(array->entry_array.next_entry_array_offset);
1687 if (subtract_one && t == 0 && i == 0)
1690 /* Let's cache this item for the next invocation */
1691 chain_cache_put(f->chain_cache, ci, first, a, le64toh(array->entry_array.items[0]), t, subtract_one ? (i > 0 ? i-1 : (uint64_t) -1) : i);
1693 if (subtract_one && i == 0)
1695 else if (subtract_one)
1696 p = le64toh(array->entry_array.items[i-1]);
1698 p = le64toh(array->entry_array.items[i]);
1700 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1711 *idx = t + i + (subtract_one ? -1 : 0);
1717 static int generic_array_bisect_plus_one(
1723 int (*test_object)(JournalFile *f, uint64_t p, uint64_t needle),
1724 direction_t direction,
1730 bool step_back = false;
1734 assert(test_object);
1739 /* This bisects the array in object 'first', but first checks
1741 r = test_object(f, extra, needle);
1745 if (r == TEST_FOUND)
1746 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1748 /* if we are looking with DIRECTION_UP then we need to first
1749 see if in the actual array there is a matching entry, and
1750 return the last one of that. But if there isn't any we need
1751 to return this one. Hence remember this, and return it
1754 step_back = direction == DIRECTION_UP;
1756 if (r == TEST_RIGHT) {
1757 if (direction == DIRECTION_DOWN)
1763 r = generic_array_bisect(f, first, n-1, needle, test_object, direction, ret, offset, idx);
1765 if (r == 0 && step_back)
1774 r = journal_file_move_to_object(f, OBJECT_ENTRY, extra, &o);
1790 _pure_ static int test_object_offset(JournalFile *f, uint64_t p, uint64_t needle) {
1796 else if (p < needle)
1802 int journal_file_move_to_entry_by_offset(
1805 direction_t direction,
1809 return generic_array_bisect(f,
1810 le64toh(f->header->entry_array_offset),
1811 le64toh(f->header->n_entries),
1819 static int test_object_seqnum(JournalFile *f, uint64_t p, uint64_t needle) {
1826 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1830 if (le64toh(o->entry.seqnum) == needle)
1832 else if (le64toh(o->entry.seqnum) < needle)
1838 int journal_file_move_to_entry_by_seqnum(
1841 direction_t direction,
1845 return generic_array_bisect(f,
1846 le64toh(f->header->entry_array_offset),
1847 le64toh(f->header->n_entries),
1854 static int test_object_realtime(JournalFile *f, uint64_t p, uint64_t needle) {
1861 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1865 if (le64toh(o->entry.realtime) == needle)
1867 else if (le64toh(o->entry.realtime) < needle)
1873 int journal_file_move_to_entry_by_realtime(
1876 direction_t direction,
1880 return generic_array_bisect(f,
1881 le64toh(f->header->entry_array_offset),
1882 le64toh(f->header->n_entries),
1884 test_object_realtime,
1889 static int test_object_monotonic(JournalFile *f, uint64_t p, uint64_t needle) {
1896 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1900 if (le64toh(o->entry.monotonic) == needle)
1902 else if (le64toh(o->entry.monotonic) < needle)
1908 static inline int find_data_object_by_boot_id(
1913 char t[sizeof("_BOOT_ID=")-1 + 32 + 1] = "_BOOT_ID=";
1915 sd_id128_to_string(boot_id, t + 9);
1916 return journal_file_find_data_object(f, t, sizeof(t) - 1, o, b);
1919 int journal_file_move_to_entry_by_monotonic(
1923 direction_t direction,
1932 r = find_data_object_by_boot_id(f, boot_id, &o, NULL);
1938 return generic_array_bisect_plus_one(f,
1939 le64toh(o->data.entry_offset),
1940 le64toh(o->data.entry_array_offset),
1941 le64toh(o->data.n_entries),
1943 test_object_monotonic,
1948 int journal_file_next_entry(
1950 Object *o, uint64_t p,
1951 direction_t direction,
1952 Object **ret, uint64_t *offset) {
1958 assert(p > 0 || !o);
1960 n = le64toh(f->header->n_entries);
1965 i = direction == DIRECTION_DOWN ? 0 : n - 1;
1967 if (o->object.type != OBJECT_ENTRY)
1970 r = generic_array_bisect(f,
1971 le64toh(f->header->entry_array_offset),
1972 le64toh(f->header->n_entries),
1981 if (direction == DIRECTION_DOWN) {
1994 /* And jump to it */
1995 r = generic_array_get(f,
1996 le64toh(f->header->entry_array_offset),
2003 (direction == DIRECTION_DOWN ? ofs <= p : ofs >= p)) {
2004 log_debug("%s: entry array corrupted at entry %"PRIu64,
2015 int journal_file_skip_entry(
2017 Object *o, uint64_t p,
2019 Object **ret, uint64_t *offset) {
2028 if (o->object.type != OBJECT_ENTRY)
2031 r = generic_array_bisect(f,
2032 le64toh(f->header->entry_array_offset),
2033 le64toh(f->header->n_entries),
2042 /* Calculate new index */
2044 if ((uint64_t) -skip >= i)
2047 i = i - (uint64_t) -skip;
2049 i += (uint64_t) skip;
2051 n = le64toh(f->header->n_entries);
2058 return generic_array_get(f,
2059 le64toh(f->header->entry_array_offset),
2064 int journal_file_next_entry_for_data(
2066 Object *o, uint64_t p,
2067 uint64_t data_offset,
2068 direction_t direction,
2069 Object **ret, uint64_t *offset) {
2076 assert(p > 0 || !o);
2078 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2082 n = le64toh(d->data.n_entries);
2087 i = direction == DIRECTION_DOWN ? 0 : n - 1;
2089 if (o->object.type != OBJECT_ENTRY)
2092 r = generic_array_bisect_plus_one(f,
2093 le64toh(d->data.entry_offset),
2094 le64toh(d->data.entry_array_offset),
2095 le64toh(d->data.n_entries),
2105 if (direction == DIRECTION_DOWN) {
2119 return generic_array_get_plus_one(f,
2120 le64toh(d->data.entry_offset),
2121 le64toh(d->data.entry_array_offset),
2126 int journal_file_move_to_entry_by_offset_for_data(
2128 uint64_t data_offset,
2130 direction_t direction,
2131 Object **ret, uint64_t *offset) {
2138 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2142 return generic_array_bisect_plus_one(f,
2143 le64toh(d->data.entry_offset),
2144 le64toh(d->data.entry_array_offset),
2145 le64toh(d->data.n_entries),
2152 int journal_file_move_to_entry_by_monotonic_for_data(
2154 uint64_t data_offset,
2157 direction_t direction,
2158 Object **ret, uint64_t *offset) {
2166 /* First, seek by time */
2167 r = find_data_object_by_boot_id(f, boot_id, &o, &b);
2173 r = generic_array_bisect_plus_one(f,
2174 le64toh(o->data.entry_offset),
2175 le64toh(o->data.entry_array_offset),
2176 le64toh(o->data.n_entries),
2178 test_object_monotonic,
2184 /* And now, continue seeking until we find an entry that
2185 * exists in both bisection arrays */
2191 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2195 r = generic_array_bisect_plus_one(f,
2196 le64toh(d->data.entry_offset),
2197 le64toh(d->data.entry_array_offset),
2198 le64toh(d->data.n_entries),
2206 r = journal_file_move_to_object(f, OBJECT_DATA, b, &o);
2210 r = generic_array_bisect_plus_one(f,
2211 le64toh(o->data.entry_offset),
2212 le64toh(o->data.entry_array_offset),
2213 le64toh(o->data.n_entries),
2235 int journal_file_move_to_entry_by_seqnum_for_data(
2237 uint64_t data_offset,
2239 direction_t direction,
2240 Object **ret, uint64_t *offset) {
2247 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2251 return generic_array_bisect_plus_one(f,
2252 le64toh(d->data.entry_offset),
2253 le64toh(d->data.entry_array_offset),
2254 le64toh(d->data.n_entries),
2261 int journal_file_move_to_entry_by_realtime_for_data(
2263 uint64_t data_offset,
2265 direction_t direction,
2266 Object **ret, uint64_t *offset) {
2273 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2277 return generic_array_bisect_plus_one(f,
2278 le64toh(d->data.entry_offset),
2279 le64toh(d->data.entry_array_offset),
2280 le64toh(d->data.n_entries),
2282 test_object_realtime,
2287 void journal_file_dump(JournalFile *f) {
2294 journal_file_print_header(f);
2296 p = le64toh(f->header->header_size);
2298 r = journal_file_move_to_object(f, OBJECT_UNUSED, p, &o);
2302 switch (o->object.type) {
2305 printf("Type: OBJECT_UNUSED\n");
2309 printf("Type: OBJECT_DATA\n");
2313 printf("Type: OBJECT_FIELD\n");
2317 printf("Type: OBJECT_ENTRY seqnum=%"PRIu64" monotonic=%"PRIu64" realtime=%"PRIu64"\n",
2318 le64toh(o->entry.seqnum),
2319 le64toh(o->entry.monotonic),
2320 le64toh(o->entry.realtime));
2323 case OBJECT_FIELD_HASH_TABLE:
2324 printf("Type: OBJECT_FIELD_HASH_TABLE\n");
2327 case OBJECT_DATA_HASH_TABLE:
2328 printf("Type: OBJECT_DATA_HASH_TABLE\n");
2331 case OBJECT_ENTRY_ARRAY:
2332 printf("Type: OBJECT_ENTRY_ARRAY\n");
2336 printf("Type: OBJECT_TAG seqnum=%"PRIu64" epoch=%"PRIu64"\n",
2337 le64toh(o->tag.seqnum),
2338 le64toh(o->tag.epoch));
2342 printf("Type: unknown (%u)\n", o->object.type);
2346 if (o->object.flags & OBJECT_COMPRESSION_MASK)
2347 printf("Flags: %s\n",
2348 object_compressed_to_string(o->object.flags & OBJECT_COMPRESSION_MASK));
2350 if (p == le64toh(f->header->tail_object_offset))
2353 p = p + ALIGN64(le64toh(o->object.size));
2358 log_error("File corrupt");
2361 static const char* format_timestamp_safe(char *buf, size_t l, usec_t t) {
2364 x = format_timestamp(buf, l, t);
2370 void journal_file_print_header(JournalFile *f) {
2371 char a[33], b[33], c[33], d[33];
2372 char x[FORMAT_TIMESTAMP_MAX], y[FORMAT_TIMESTAMP_MAX], z[FORMAT_TIMESTAMP_MAX];
2374 char bytes[FORMAT_BYTES_MAX];
2378 printf("File Path: %s\n"
2382 "Sequential Number ID: %s\n"
2384 "Compatible Flags:%s%s\n"
2385 "Incompatible Flags:%s%s%s\n"
2386 "Header size: %"PRIu64"\n"
2387 "Arena size: %"PRIu64"\n"
2388 "Data Hash Table Size: %"PRIu64"\n"
2389 "Field Hash Table Size: %"PRIu64"\n"
2390 "Rotate Suggested: %s\n"
2391 "Head Sequential Number: %"PRIu64"\n"
2392 "Tail Sequential Number: %"PRIu64"\n"
2393 "Head Realtime Timestamp: %s\n"
2394 "Tail Realtime Timestamp: %s\n"
2395 "Tail Monotonic Timestamp: %s\n"
2396 "Objects: %"PRIu64"\n"
2397 "Entry Objects: %"PRIu64"\n",
2399 sd_id128_to_string(f->header->file_id, a),
2400 sd_id128_to_string(f->header->machine_id, b),
2401 sd_id128_to_string(f->header->boot_id, c),
2402 sd_id128_to_string(f->header->seqnum_id, d),
2403 f->header->state == STATE_OFFLINE ? "OFFLINE" :
2404 f->header->state == STATE_ONLINE ? "ONLINE" :
2405 f->header->state == STATE_ARCHIVED ? "ARCHIVED" : "UNKNOWN",
2406 JOURNAL_HEADER_SEALED(f->header) ? " SEALED" : "",
2407 (le32toh(f->header->compatible_flags) & ~HEADER_COMPATIBLE_ANY) ? " ???" : "",
2408 JOURNAL_HEADER_COMPRESSED_XZ(f->header) ? " COMPRESSED-XZ" : "",
2409 JOURNAL_HEADER_COMPRESSED_LZ4(f->header) ? " COMPRESSED-LZ4" : "",
2410 (le32toh(f->header->incompatible_flags) & ~HEADER_INCOMPATIBLE_ANY) ? " ???" : "",
2411 le64toh(f->header->header_size),
2412 le64toh(f->header->arena_size),
2413 le64toh(f->header->data_hash_table_size) / sizeof(HashItem),
2414 le64toh(f->header->field_hash_table_size) / sizeof(HashItem),
2415 yes_no(journal_file_rotate_suggested(f, 0)),
2416 le64toh(f->header->head_entry_seqnum),
2417 le64toh(f->header->tail_entry_seqnum),
2418 format_timestamp_safe(x, sizeof(x), le64toh(f->header->head_entry_realtime)),
2419 format_timestamp_safe(y, sizeof(y), le64toh(f->header->tail_entry_realtime)),
2420 format_timespan(z, sizeof(z), le64toh(f->header->tail_entry_monotonic), USEC_PER_MSEC),
2421 le64toh(f->header->n_objects),
2422 le64toh(f->header->n_entries));
2424 if (JOURNAL_HEADER_CONTAINS(f->header, n_data))
2425 printf("Data Objects: %"PRIu64"\n"
2426 "Data Hash Table Fill: %.1f%%\n",
2427 le64toh(f->header->n_data),
2428 100.0 * (double) le64toh(f->header->n_data) / ((double) (le64toh(f->header->data_hash_table_size) / sizeof(HashItem))));
2430 if (JOURNAL_HEADER_CONTAINS(f->header, n_fields))
2431 printf("Field Objects: %"PRIu64"\n"
2432 "Field Hash Table Fill: %.1f%%\n",
2433 le64toh(f->header->n_fields),
2434 100.0 * (double) le64toh(f->header->n_fields) / ((double) (le64toh(f->header->field_hash_table_size) / sizeof(HashItem))));
2436 if (JOURNAL_HEADER_CONTAINS(f->header, n_tags))
2437 printf("Tag Objects: %"PRIu64"\n",
2438 le64toh(f->header->n_tags));
2439 if (JOURNAL_HEADER_CONTAINS(f->header, n_entry_arrays))
2440 printf("Entry Array Objects: %"PRIu64"\n",
2441 le64toh(f->header->n_entry_arrays));
2443 if (fstat(f->fd, &st) >= 0)
2444 printf("Disk usage: %s\n", format_bytes(bytes, sizeof(bytes), (off_t) st.st_blocks * 512ULL));
2447 int journal_file_open(
2453 JournalMetrics *metrics,
2454 MMapCache *mmap_cache,
2455 JournalFile *template,
2456 JournalFile **ret) {
2460 bool newly_created = false;
2465 if ((flags & O_ACCMODE) != O_RDONLY &&
2466 (flags & O_ACCMODE) != O_RDWR)
2469 if (!endswith(fname, ".journal") &&
2470 !endswith(fname, ".journal~"))
2473 f = new0(JournalFile, 1);
2481 f->prot = prot_from_flags(flags);
2482 f->writable = (flags & O_ACCMODE) != O_RDONLY;
2483 #if defined(HAVE_LZ4)
2484 f->compress_lz4 = compress;
2485 #elif defined(HAVE_XZ)
2486 f->compress_xz = compress;
2493 f->mmap = mmap_cache_ref(mmap_cache);
2495 f->mmap = mmap_cache_new();
2502 f->path = strdup(fname);
2508 f->chain_cache = ordered_hashmap_new(&uint64_hash_ops);
2509 if (!f->chain_cache) {
2514 f->fd = open(f->path, f->flags|O_CLOEXEC, f->mode);
2520 if (fstat(f->fd, &f->last_stat) < 0) {
2525 if (f->last_stat.st_size == 0 && f->writable) {
2528 /* Let's attach the creation time to the journal file,
2529 * so that the vacuuming code knows the age of this
2530 * file even if the file might end up corrupted one
2531 * day... Ideally we'd just use the creation time many
2532 * file systems maintain for each file, but there is
2533 * currently no usable API to query this, hence let's
2534 * emulate this via extended attributes. If extended
2535 * attributes are not supported we'll just skip this,
2536 * and rely solely on mtime/atime/ctime of the file. */
2538 crtime = htole64((uint64_t) now(CLOCK_REALTIME));
2539 fsetxattr(f->fd, "user.crtime_usec", &crtime, sizeof(crtime), XATTR_CREATE);
2542 /* Try to load the FSPRG state, and if we can't, then
2543 * just don't do sealing */
2545 r = journal_file_fss_load(f);
2551 r = journal_file_init_header(f, template);
2555 if (fstat(f->fd, &f->last_stat) < 0) {
2560 newly_created = true;
2563 if (f->last_stat.st_size < (off_t) HEADER_SIZE_MIN) {
2568 f->header = mmap(NULL, PAGE_ALIGN(sizeof(Header)), prot_from_flags(flags), MAP_SHARED, f->fd, 0);
2569 if (f->header == MAP_FAILED) {
2575 if (!newly_created) {
2576 r = journal_file_verify_header(f);
2582 if (!newly_created && f->writable) {
2583 r = journal_file_fss_load(f);
2591 journal_default_metrics(metrics, f->fd);
2592 f->metrics = *metrics;
2593 } else if (template)
2594 f->metrics = template->metrics;
2596 r = journal_file_refresh_header(f);
2602 r = journal_file_hmac_setup(f);
2607 if (newly_created) {
2608 r = journal_file_setup_field_hash_table(f);
2612 r = journal_file_setup_data_hash_table(f);
2617 r = journal_file_append_first_tag(f);
2623 r = journal_file_map_field_hash_table(f);
2627 r = journal_file_map_data_hash_table(f);
2635 journal_file_close(f);
2640 int journal_file_rotate(JournalFile **f, bool compress, bool seal) {
2641 _cleanup_free_ char *p = NULL;
2643 JournalFile *old_file, *new_file = NULL;
2651 if (!old_file->writable)
2654 if (!endswith(old_file->path, ".journal"))
2657 l = strlen(old_file->path);
2658 r = asprintf(&p, "%.*s@" SD_ID128_FORMAT_STR "-%016"PRIx64"-%016"PRIx64".journal",
2659 (int) l - 8, old_file->path,
2660 SD_ID128_FORMAT_VAL(old_file->header->seqnum_id),
2661 le64toh((*f)->header->head_entry_seqnum),
2662 le64toh((*f)->header->head_entry_realtime));
2666 r = rename(old_file->path, p);
2670 old_file->header->state = STATE_ARCHIVED;
2672 r = journal_file_open(old_file->path, old_file->flags, old_file->mode, compress, seal, NULL, old_file->mmap, old_file, &new_file);
2673 journal_file_close(old_file);
2679 int journal_file_open_reliably(
2685 JournalMetrics *metrics,
2686 MMapCache *mmap_cache,
2687 JournalFile *template,
2688 JournalFile **ret) {
2692 _cleanup_free_ char *p = NULL;
2694 r = journal_file_open(fname, flags, mode, compress, seal,
2695 metrics, mmap_cache, template, ret);
2696 if (r != -EBADMSG && /* corrupted */
2697 r != -ENODATA && /* truncated */
2698 r != -EHOSTDOWN && /* other machine */
2699 r != -EPROTONOSUPPORT && /* incompatible feature */
2700 r != -EBUSY && /* unclean shutdown */
2701 r != -ESHUTDOWN /* already archived */)
2704 if ((flags & O_ACCMODE) == O_RDONLY)
2707 if (!(flags & O_CREAT))
2710 if (!endswith(fname, ".journal"))
2713 /* The file is corrupted. Rotate it away and try it again (but only once) */
2716 if (asprintf(&p, "%.*s@%016llx-%016" PRIx64 ".journal~",
2718 (unsigned long long) now(CLOCK_REALTIME),
2722 r = rename(fname, p);
2726 log_warning("File %s corrupted or uncleanly shut down, renaming and replacing.", fname);
2728 return journal_file_open(fname, flags, mode, compress, seal,
2729 metrics, mmap_cache, template, ret);
2732 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset) {
2734 uint64_t q, xor_hash = 0;
2747 ts.monotonic = le64toh(o->entry.monotonic);
2748 ts.realtime = le64toh(o->entry.realtime);
2750 n = journal_file_entry_n_items(o);
2751 /* alloca() can't take 0, hence let's allocate at least one */
2752 items = alloca(sizeof(EntryItem) * MAX(1u, n));
2754 for (i = 0; i < n; i++) {
2761 q = le64toh(o->entry.items[i].object_offset);
2762 le_hash = o->entry.items[i].hash;
2764 r = journal_file_move_to_object(from, OBJECT_DATA, q, &o);
2768 if (le_hash != o->data.hash)
2771 l = le64toh(o->object.size) - offsetof(Object, data.payload);
2774 /* We hit the limit on 32bit machines */
2775 if ((uint64_t) t != l)
2778 if (o->object.flags & OBJECT_COMPRESSION_MASK) {
2779 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
2782 r = decompress_blob(o->object.flags & OBJECT_COMPRESSION_MASK,
2783 o->data.payload, l, &from->compress_buffer, &from->compress_buffer_size, &rsize, 0);
2787 data = from->compress_buffer;
2790 return -EPROTONOSUPPORT;
2793 data = o->data.payload;
2795 r = journal_file_append_data(to, data, l, &u, &h);
2799 xor_hash ^= le64toh(u->data.hash);
2800 items[i].object_offset = htole64(h);
2801 items[i].hash = u->data.hash;
2803 r = journal_file_move_to_object(from, OBJECT_ENTRY, p, &o);
2808 return journal_file_append_entry_internal(to, &ts, xor_hash, items, n, seqnum, ret, offset);
2811 void journal_default_metrics(JournalMetrics *m, int fd) {
2812 uint64_t fs_size = 0;
2814 char a[FORMAT_BYTES_MAX], b[FORMAT_BYTES_MAX], c[FORMAT_BYTES_MAX], d[FORMAT_BYTES_MAX];
2819 if (fstatvfs(fd, &ss) >= 0)
2820 fs_size = ss.f_frsize * ss.f_blocks;
2822 if (m->max_use == (uint64_t) -1) {
2825 m->max_use = PAGE_ALIGN(fs_size / 10); /* 10% of file system size */
2827 if (m->max_use > DEFAULT_MAX_USE_UPPER)
2828 m->max_use = DEFAULT_MAX_USE_UPPER;
2830 if (m->max_use < DEFAULT_MAX_USE_LOWER)
2831 m->max_use = DEFAULT_MAX_USE_LOWER;
2833 m->max_use = DEFAULT_MAX_USE_LOWER;
2835 m->max_use = PAGE_ALIGN(m->max_use);
2837 if (m->max_use < JOURNAL_FILE_SIZE_MIN*2)
2838 m->max_use = JOURNAL_FILE_SIZE_MIN*2;
2841 if (m->max_size == (uint64_t) -1) {
2842 m->max_size = PAGE_ALIGN(m->max_use / 8); /* 8 chunks */
2844 if (m->max_size > DEFAULT_MAX_SIZE_UPPER)
2845 m->max_size = DEFAULT_MAX_SIZE_UPPER;
2847 m->max_size = PAGE_ALIGN(m->max_size);
2849 if (m->max_size < JOURNAL_FILE_SIZE_MIN)
2850 m->max_size = JOURNAL_FILE_SIZE_MIN;
2852 if (m->max_size*2 > m->max_use)
2853 m->max_use = m->max_size*2;
2855 if (m->min_size == (uint64_t) -1)
2856 m->min_size = JOURNAL_FILE_SIZE_MIN;
2858 m->min_size = PAGE_ALIGN(m->min_size);
2860 if (m->min_size < JOURNAL_FILE_SIZE_MIN)
2861 m->min_size = JOURNAL_FILE_SIZE_MIN;
2863 if (m->min_size > m->max_size)
2864 m->max_size = m->min_size;
2867 if (m->keep_free == (uint64_t) -1) {
2870 m->keep_free = PAGE_ALIGN(fs_size * 3 / 20); /* 15% of file system size */
2872 if (m->keep_free > DEFAULT_KEEP_FREE_UPPER)
2873 m->keep_free = DEFAULT_KEEP_FREE_UPPER;
2876 m->keep_free = DEFAULT_KEEP_FREE;
2879 log_debug("Fixed max_use=%s max_size=%s min_size=%s keep_free=%s",
2880 format_bytes(a, sizeof(a), m->max_use),
2881 format_bytes(b, sizeof(b), m->max_size),
2882 format_bytes(c, sizeof(c), m->min_size),
2883 format_bytes(d, sizeof(d), m->keep_free));
2886 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to) {
2891 if (f->header->head_entry_realtime == 0)
2894 *from = le64toh(f->header->head_entry_realtime);
2898 if (f->header->tail_entry_realtime == 0)
2901 *to = le64toh(f->header->tail_entry_realtime);
2907 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot_id, usec_t *from, usec_t *to) {
2915 r = find_data_object_by_boot_id(f, boot_id, &o, &p);
2919 if (le64toh(o->data.n_entries) <= 0)
2923 r = journal_file_move_to_object(f, OBJECT_ENTRY, le64toh(o->data.entry_offset), &o);
2927 *from = le64toh(o->entry.monotonic);
2931 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
2935 r = generic_array_get_plus_one(f,
2936 le64toh(o->data.entry_offset),
2937 le64toh(o->data.entry_array_offset),
2938 le64toh(o->data.n_entries)-1,
2943 *to = le64toh(o->entry.monotonic);
2949 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec) {
2952 /* If we gained new header fields we gained new features,
2953 * hence suggest a rotation */
2954 if (le64toh(f->header->header_size) < sizeof(Header)) {
2955 log_debug("%s uses an outdated header, suggesting rotation.", f->path);
2959 /* Let's check if the hash tables grew over a certain fill
2960 * level (75%, borrowing this value from Java's hash table
2961 * implementation), and if so suggest a rotation. To calculate
2962 * the fill level we need the n_data field, which only exists
2963 * in newer versions. */
2965 if (JOURNAL_HEADER_CONTAINS(f->header, n_data))
2966 if (le64toh(f->header->n_data) * 4ULL > (le64toh(f->header->data_hash_table_size) / sizeof(HashItem)) * 3ULL) {
2967 log_debug("Data hash table of %s has a fill level at %.1f (%"PRIu64" of %"PRIu64" items, %llu file size, %"PRIu64" bytes per hash table item), suggesting rotation.",
2969 100.0 * (double) le64toh(f->header->n_data) / ((double) (le64toh(f->header->data_hash_table_size) / sizeof(HashItem))),
2970 le64toh(f->header->n_data),
2971 le64toh(f->header->data_hash_table_size) / sizeof(HashItem),
2972 (unsigned long long) f->last_stat.st_size,
2973 f->last_stat.st_size / le64toh(f->header->n_data));
2977 if (JOURNAL_HEADER_CONTAINS(f->header, n_fields))
2978 if (le64toh(f->header->n_fields) * 4ULL > (le64toh(f->header->field_hash_table_size) / sizeof(HashItem)) * 3ULL) {
2979 log_debug("Field hash table of %s has a fill level at %.1f (%"PRIu64" of %"PRIu64" items), suggesting rotation.",
2981 100.0 * (double) le64toh(f->header->n_fields) / ((double) (le64toh(f->header->field_hash_table_size) / sizeof(HashItem))),
2982 le64toh(f->header->n_fields),
2983 le64toh(f->header->field_hash_table_size) / sizeof(HashItem));
2987 /* Are the data objects properly indexed by field objects? */
2988 if (JOURNAL_HEADER_CONTAINS(f->header, n_data) &&
2989 JOURNAL_HEADER_CONTAINS(f->header, n_fields) &&
2990 le64toh(f->header->n_data) > 0 &&
2991 le64toh(f->header->n_fields) == 0)
2994 if (max_file_usec > 0) {
2997 h = le64toh(f->header->head_entry_realtime);
2998 t = now(CLOCK_REALTIME);
3000 if (h > 0 && t > h + max_file_usec)