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>
31 #include <attr/xattr.h>
34 #include "journal-def.h"
35 #include "journal-file.h"
36 #include "journal-authenticate.h"
41 #define DEFAULT_DATA_HASH_TABLE_SIZE (2047ULL*sizeof(HashItem))
42 #define DEFAULT_FIELD_HASH_TABLE_SIZE (333ULL*sizeof(HashItem))
44 #define COMPRESSION_SIZE_THRESHOLD (512ULL)
46 /* This is the minimum journal file size */
47 #define JOURNAL_FILE_SIZE_MIN (64ULL*1024ULL) /* 64 KiB */
49 /* These are the lower and upper bounds if we deduce the max_use value
50 * from the file system size */
51 #define DEFAULT_MAX_USE_LOWER (1ULL*1024ULL*1024ULL) /* 1 MiB */
52 #define DEFAULT_MAX_USE_UPPER (4ULL*1024ULL*1024ULL*1024ULL) /* 4 GiB */
54 /* This is the upper bound if we deduce max_size from max_use */
55 #define DEFAULT_MAX_SIZE_UPPER (128ULL*1024ULL*1024ULL) /* 128 MiB */
57 /* This is the upper bound if we deduce the keep_free value from the
59 #define DEFAULT_KEEP_FREE_UPPER (4ULL*1024ULL*1024ULL*1024ULL) /* 4 GiB */
61 /* This is the keep_free value when we can't determine the system
63 #define DEFAULT_KEEP_FREE (1024ULL*1024ULL) /* 1 MB */
65 /* n_data was the first entry we added after the initial file format design */
66 #define HEADER_SIZE_MIN ALIGN64(offsetof(Header, n_data))
68 /* How many entries to keep in the entry array chain cache at max */
69 #define CHAIN_CACHE_MAX 20
71 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)));
134 close_nointr_nofail(f->fd);
139 mmap_cache_unref(f->mmap);
141 hashmap_free_free(f->chain_cache);
144 free(f->compress_buffer);
149 munmap(f->fss_file, PAGE_ALIGN(f->fss_file_size));
150 else if (f->fsprg_state)
151 free(f->fsprg_state);
156 gcry_md_close(f->hmac);
162 static int journal_file_init_header(JournalFile *f, JournalFile *template) {
170 memcpy(h.signature, HEADER_SIGNATURE, 8);
171 h.header_size = htole64(ALIGN64(sizeof(h)));
173 h.incompatible_flags =
174 htole32(f->compress ? HEADER_INCOMPATIBLE_COMPRESSED : 0);
177 htole32(f->seal ? HEADER_COMPATIBLE_SEALED : 0);
179 r = sd_id128_randomize(&h.file_id);
184 h.seqnum_id = template->header->seqnum_id;
185 h.tail_entry_seqnum = template->header->tail_entry_seqnum;
187 h.seqnum_id = h.file_id;
189 k = pwrite(f->fd, &h, sizeof(h), 0);
199 static int journal_file_refresh_header(JournalFile *f) {
205 r = sd_id128_get_machine(&f->header->machine_id);
209 r = sd_id128_get_boot(&boot_id);
213 if (sd_id128_equal(boot_id, f->header->boot_id))
214 f->tail_entry_monotonic_valid = true;
216 f->header->boot_id = boot_id;
218 journal_file_set_online(f);
220 /* Sync the online state to disk */
221 msync(f->header, PAGE_ALIGN(sizeof(Header)), MS_SYNC);
227 static int journal_file_verify_header(JournalFile *f) {
230 if (memcmp(f->header->signature, HEADER_SIGNATURE, 8))
233 /* In both read and write mode we refuse to open files with
234 * incompatible flags we don't know */
236 if ((le32toh(f->header->incompatible_flags) & ~HEADER_INCOMPATIBLE_COMPRESSED) != 0)
237 return -EPROTONOSUPPORT;
239 if (f->header->incompatible_flags != 0)
240 return -EPROTONOSUPPORT;
243 /* When open for writing we refuse to open files with
244 * compatible flags, too */
247 if ((le32toh(f->header->compatible_flags) & ~HEADER_COMPATIBLE_SEALED) != 0)
248 return -EPROTONOSUPPORT;
250 if (f->header->compatible_flags != 0)
251 return -EPROTONOSUPPORT;
255 if (f->header->state >= _STATE_MAX)
258 /* The first addition was n_data, so check that we are at least this large */
259 if (le64toh(f->header->header_size) < HEADER_SIZE_MIN)
262 if (JOURNAL_HEADER_SEALED(f->header) && !JOURNAL_HEADER_CONTAINS(f->header, n_entry_arrays))
265 if ((le64toh(f->header->header_size) + le64toh(f->header->arena_size)) > (uint64_t) f->last_stat.st_size)
268 if (le64toh(f->header->tail_object_offset) > (le64toh(f->header->header_size) + le64toh(f->header->arena_size)))
271 if (!VALID64(le64toh(f->header->data_hash_table_offset)) ||
272 !VALID64(le64toh(f->header->field_hash_table_offset)) ||
273 !VALID64(le64toh(f->header->tail_object_offset)) ||
274 !VALID64(le64toh(f->header->entry_array_offset)))
277 if (le64toh(f->header->data_hash_table_offset) < le64toh(f->header->header_size) ||
278 le64toh(f->header->field_hash_table_offset) < le64toh(f->header->header_size) ||
279 le64toh(f->header->tail_object_offset) < le64toh(f->header->header_size) ||
280 le64toh(f->header->entry_array_offset) < le64toh(f->header->header_size))
285 sd_id128_t machine_id;
288 r = sd_id128_get_machine(&machine_id);
292 if (!sd_id128_equal(machine_id, f->header->machine_id))
295 state = f->header->state;
297 if (state == STATE_ONLINE) {
298 log_debug("Journal file %s is already online. Assuming unclean closing.", f->path);
300 } else if (state == STATE_ARCHIVED)
302 else if (state != STATE_OFFLINE) {
303 log_debug("Journal file %s has unknown state %u.", f->path, state);
308 f->compress = JOURNAL_HEADER_COMPRESSED(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 &&
337 new_size > f->metrics.max_size)
340 if (new_size > f->metrics.min_size &&
341 f->metrics.keep_free > 0) {
344 if (fstatvfs(f->fd, &svfs) >= 0) {
347 available = svfs.f_bfree * svfs.f_bsize;
349 if (available >= f->metrics.keep_free)
350 available -= f->metrics.keep_free;
354 if (new_size - old_size > available)
359 /* Note that the glibc fallocate() fallback is very
360 inefficient, hence we try to minimize the allocation area
362 r = posix_fallocate(f->fd, old_size, new_size - old_size);
366 if (fstat(f->fd, &f->last_stat) < 0)
369 f->header->arena_size = htole64(new_size - le64toh(f->header->header_size));
374 static int journal_file_move_to(JournalFile *f, int context, bool keep_always, uint64_t offset, uint64_t size, void **ret) {
381 /* Avoid SIGBUS on invalid accesses */
382 if (offset + size > (uint64_t) f->last_stat.st_size) {
383 /* Hmm, out of range? Let's refresh the fstat() data
384 * first, before we trust that check. */
386 if (fstat(f->fd, &f->last_stat) < 0 ||
387 offset + size > (uint64_t) f->last_stat.st_size)
388 return -EADDRNOTAVAIL;
391 return mmap_cache_get(f->mmap, f->fd, f->prot, context, keep_always, offset, size, &f->last_stat, ret);
394 static uint64_t minimum_header_size(Object *o) {
396 static uint64_t table[] = {
397 [OBJECT_DATA] = sizeof(DataObject),
398 [OBJECT_FIELD] = sizeof(FieldObject),
399 [OBJECT_ENTRY] = sizeof(EntryObject),
400 [OBJECT_DATA_HASH_TABLE] = sizeof(HashTableObject),
401 [OBJECT_FIELD_HASH_TABLE] = sizeof(HashTableObject),
402 [OBJECT_ENTRY_ARRAY] = sizeof(EntryArrayObject),
403 [OBJECT_TAG] = sizeof(TagObject),
406 if (o->object.type >= ELEMENTSOF(table) || table[o->object.type] <= 0)
407 return sizeof(ObjectHeader);
409 return table[o->object.type];
412 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret) {
422 /* Objects may only be located at multiple of 64 bit */
423 if (!VALID64(offset))
426 /* One context for each type, plus one catch-all for the rest */
427 context = type > 0 && type < _OBJECT_TYPE_MAX ? type : 0;
429 r = journal_file_move_to(f, context, false, offset, sizeof(ObjectHeader), &t);
434 s = le64toh(o->object.size);
436 if (s < sizeof(ObjectHeader))
439 if (o->object.type <= OBJECT_UNUSED)
442 if (s < minimum_header_size(o))
445 if (type > 0 && o->object.type != type)
448 if (s > sizeof(ObjectHeader)) {
449 r = journal_file_move_to(f, o->object.type, false, offset, s, &t);
460 static uint64_t journal_file_entry_seqnum(JournalFile *f, uint64_t *seqnum) {
465 r = le64toh(f->header->tail_entry_seqnum) + 1;
468 /* If an external seqnum counter was passed, we update
469 * both the local and the external one, and set it to
470 * the maximum of both */
478 f->header->tail_entry_seqnum = htole64(r);
480 if (f->header->head_entry_seqnum == 0)
481 f->header->head_entry_seqnum = htole64(r);
486 int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset) {
493 assert(type > 0 && type < _OBJECT_TYPE_MAX);
494 assert(size >= sizeof(ObjectHeader));
498 r = journal_file_set_online(f);
502 p = le64toh(f->header->tail_object_offset);
504 p = le64toh(f->header->header_size);
506 r = journal_file_move_to_object(f, -1, p, &tail);
510 p += ALIGN64(le64toh(tail->object.size));
513 r = journal_file_allocate(f, p, size);
517 r = journal_file_move_to(f, type, false, p, size, &t);
524 o->object.type = type;
525 o->object.size = htole64(size);
527 f->header->tail_object_offset = htole64(p);
528 f->header->n_objects = htole64(le64toh(f->header->n_objects) + 1);
536 static int journal_file_setup_data_hash_table(JournalFile *f) {
543 /* We estimate that we need 1 hash table entry per 768 of
544 journal file and we want to make sure we never get beyond
545 75% fill level. Calculate the hash table size for the
546 maximum file size based on these metrics. */
548 s = (f->metrics.max_size * 4 / 768 / 3) * sizeof(HashItem);
549 if (s < DEFAULT_DATA_HASH_TABLE_SIZE)
550 s = DEFAULT_DATA_HASH_TABLE_SIZE;
552 log_debug("Reserving %llu entries in hash table.", (unsigned long long) (s / sizeof(HashItem)));
554 r = journal_file_append_object(f,
555 OBJECT_DATA_HASH_TABLE,
556 offsetof(Object, hash_table.items) + s,
561 memset(o->hash_table.items, 0, s);
563 f->header->data_hash_table_offset = htole64(p + offsetof(Object, hash_table.items));
564 f->header->data_hash_table_size = htole64(s);
569 static int journal_file_setup_field_hash_table(JournalFile *f) {
576 /* We use a fixed size hash table for the fields as this
577 * number should grow very slowly only */
579 s = DEFAULT_FIELD_HASH_TABLE_SIZE;
580 r = journal_file_append_object(f,
581 OBJECT_FIELD_HASH_TABLE,
582 offsetof(Object, hash_table.items) + s,
587 memset(o->hash_table.items, 0, s);
589 f->header->field_hash_table_offset = htole64(p + offsetof(Object, hash_table.items));
590 f->header->field_hash_table_size = htole64(s);
595 static int journal_file_map_data_hash_table(JournalFile *f) {
602 p = le64toh(f->header->data_hash_table_offset);
603 s = le64toh(f->header->data_hash_table_size);
605 r = journal_file_move_to(f,
606 OBJECT_DATA_HASH_TABLE,
613 f->data_hash_table = t;
617 static int journal_file_map_field_hash_table(JournalFile *f) {
624 p = le64toh(f->header->field_hash_table_offset);
625 s = le64toh(f->header->field_hash_table_size);
627 r = journal_file_move_to(f,
628 OBJECT_FIELD_HASH_TABLE,
635 f->field_hash_table = t;
639 static int journal_file_link_field(
652 if (o->object.type != OBJECT_FIELD)
655 /* This might alter the window we are looking at */
657 o->field.next_hash_offset = o->field.head_data_offset = 0;
659 h = hash % (le64toh(f->header->field_hash_table_size) / sizeof(HashItem));
660 p = le64toh(f->field_hash_table[h].tail_hash_offset);
662 f->field_hash_table[h].head_hash_offset = htole64(offset);
664 r = journal_file_move_to_object(f, OBJECT_FIELD, p, &o);
668 o->field.next_hash_offset = htole64(offset);
671 f->field_hash_table[h].tail_hash_offset = htole64(offset);
673 if (JOURNAL_HEADER_CONTAINS(f->header, n_fields))
674 f->header->n_fields = htole64(le64toh(f->header->n_fields) + 1);
679 static int journal_file_link_data(
692 if (o->object.type != OBJECT_DATA)
695 /* This might alter the window we are looking at */
697 o->data.next_hash_offset = o->data.next_field_offset = 0;
698 o->data.entry_offset = o->data.entry_array_offset = 0;
699 o->data.n_entries = 0;
701 h = hash % (le64toh(f->header->data_hash_table_size) / sizeof(HashItem));
702 p = le64toh(f->data_hash_table[h].tail_hash_offset);
704 /* Only entry in the hash table is easy */
705 f->data_hash_table[h].head_hash_offset = htole64(offset);
707 /* Move back to the previous data object, to patch in
710 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
714 o->data.next_hash_offset = htole64(offset);
717 f->data_hash_table[h].tail_hash_offset = htole64(offset);
719 if (JOURNAL_HEADER_CONTAINS(f->header, n_data))
720 f->header->n_data = htole64(le64toh(f->header->n_data) + 1);
725 int journal_file_find_field_object_with_hash(
727 const void *field, uint64_t size, uint64_t hash,
728 Object **ret, uint64_t *offset) {
730 uint64_t p, osize, h;
734 assert(field && size > 0);
736 osize = offsetof(Object, field.payload) + size;
738 if (f->header->field_hash_table_size == 0)
741 h = hash % (le64toh(f->header->field_hash_table_size) / sizeof(HashItem));
742 p = le64toh(f->field_hash_table[h].head_hash_offset);
747 r = journal_file_move_to_object(f, OBJECT_FIELD, p, &o);
751 if (le64toh(o->field.hash) == hash &&
752 le64toh(o->object.size) == osize &&
753 memcmp(o->field.payload, field, size) == 0) {
763 p = le64toh(o->field.next_hash_offset);
769 int journal_file_find_field_object(
771 const void *field, uint64_t size,
772 Object **ret, uint64_t *offset) {
777 assert(field && size > 0);
779 hash = hash64(field, size);
781 return journal_file_find_field_object_with_hash(f,
786 int journal_file_find_data_object_with_hash(
788 const void *data, uint64_t size, uint64_t hash,
789 Object **ret, uint64_t *offset) {
791 uint64_t p, osize, h;
795 assert(data || size == 0);
797 osize = offsetof(Object, data.payload) + size;
799 if (f->header->data_hash_table_size == 0)
802 h = hash % (le64toh(f->header->data_hash_table_size) / sizeof(HashItem));
803 p = le64toh(f->data_hash_table[h].head_hash_offset);
808 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
812 if (le64toh(o->data.hash) != hash)
815 if (o->object.flags & OBJECT_COMPRESSED) {
819 l = le64toh(o->object.size);
820 if (l <= offsetof(Object, data.payload))
823 l -= offsetof(Object, data.payload);
825 if (!uncompress_blob(o->data.payload, l, &f->compress_buffer, &f->compress_buffer_size, &rsize, 0))
829 memcmp(f->compress_buffer, data, size) == 0) {
840 return -EPROTONOSUPPORT;
843 } else if (le64toh(o->object.size) == osize &&
844 memcmp(o->data.payload, data, size) == 0) {
856 p = le64toh(o->data.next_hash_offset);
862 int journal_file_find_data_object(
864 const void *data, uint64_t size,
865 Object **ret, uint64_t *offset) {
870 assert(data || size == 0);
872 hash = hash64(data, size);
874 return journal_file_find_data_object_with_hash(f,
879 static int journal_file_append_field(
881 const void *field, uint64_t size,
882 Object **ret, uint64_t *offset) {
890 assert(field && size > 0);
892 hash = hash64(field, size);
894 r = journal_file_find_field_object_with_hash(f, field, size, hash, &o, &p);
908 osize = offsetof(Object, field.payload) + size;
909 r = journal_file_append_object(f, OBJECT_FIELD, osize, &o, &p);
911 o->field.hash = htole64(hash);
912 memcpy(o->field.payload, field, size);
914 r = journal_file_link_field(f, o, p, hash);
918 /* The linking might have altered the window, so let's
919 * refresh our pointer */
920 r = journal_file_move_to_object(f, OBJECT_FIELD, p, &o);
925 r = journal_file_hmac_put_object(f, OBJECT_FIELD, o, p);
939 static int journal_file_append_data(
941 const void *data, uint64_t size,
942 Object **ret, uint64_t *offset) {
948 bool compressed = false;
952 assert(data || size == 0);
954 hash = hash64(data, size);
956 r = journal_file_find_data_object_with_hash(f, data, size, hash, &o, &p);
970 osize = offsetof(Object, data.payload) + size;
971 r = journal_file_append_object(f, OBJECT_DATA, osize, &o, &p);
975 o->data.hash = htole64(hash);
979 size >= COMPRESSION_SIZE_THRESHOLD) {
982 compressed = compress_blob(data, size, o->data.payload, &rsize);
985 o->object.size = htole64(offsetof(Object, data.payload) + rsize);
986 o->object.flags |= OBJECT_COMPRESSED;
988 log_debug("Compressed data object %lu -> %lu", (unsigned long) size, (unsigned long) rsize);
993 if (!compressed && size > 0)
994 memcpy(o->data.payload, data, size);
996 r = journal_file_link_data(f, o, p, hash);
1000 /* The linking might have altered the window, so let's
1001 * refresh our pointer */
1002 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
1006 eq = memchr(data, '=', size);
1007 if (eq && eq > data) {
1011 /* Create field object ... */
1012 r = journal_file_append_field(f, data, (uint8_t*) eq - (uint8_t*) data, &fo, &fp);
1016 /* ... and link it in. */
1017 o->data.next_field_offset = fo->field.head_data_offset;
1018 fo->field.head_data_offset = le64toh(p);
1022 r = journal_file_hmac_put_object(f, OBJECT_DATA, o, p);
1036 uint64_t journal_file_entry_n_items(Object *o) {
1039 if (o->object.type != OBJECT_ENTRY)
1042 return (le64toh(o->object.size) - offsetof(Object, entry.items)) / sizeof(EntryItem);
1045 uint64_t journal_file_entry_array_n_items(Object *o) {
1048 if (o->object.type != OBJECT_ENTRY_ARRAY)
1051 return (le64toh(o->object.size) - offsetof(Object, entry_array.items)) / sizeof(uint64_t);
1054 uint64_t journal_file_hash_table_n_items(Object *o) {
1057 if (o->object.type != OBJECT_DATA_HASH_TABLE &&
1058 o->object.type != OBJECT_FIELD_HASH_TABLE)
1061 return (le64toh(o->object.size) - offsetof(Object, hash_table.items)) / sizeof(HashItem);
1064 static int link_entry_into_array(JournalFile *f,
1069 uint64_t n = 0, ap = 0, q, i, a, hidx;
1077 a = le64toh(*first);
1078 i = hidx = le64toh(*idx);
1081 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &o);
1085 n = journal_file_entry_array_n_items(o);
1087 o->entry_array.items[i] = htole64(p);
1088 *idx = htole64(hidx + 1);
1094 a = le64toh(o->entry_array.next_entry_array_offset);
1105 r = journal_file_append_object(f, OBJECT_ENTRY_ARRAY,
1106 offsetof(Object, entry_array.items) + n * sizeof(uint64_t),
1112 r = journal_file_hmac_put_object(f, OBJECT_ENTRY_ARRAY, o, q);
1117 o->entry_array.items[i] = htole64(p);
1120 *first = htole64(q);
1122 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, ap, &o);
1126 o->entry_array.next_entry_array_offset = htole64(q);
1129 if (JOURNAL_HEADER_CONTAINS(f->header, n_entry_arrays))
1130 f->header->n_entry_arrays = htole64(le64toh(f->header->n_entry_arrays) + 1);
1132 *idx = htole64(hidx + 1);
1137 static int link_entry_into_array_plus_one(JournalFile *f,
1152 *extra = htole64(p);
1156 i = htole64(le64toh(*idx) - 1);
1157 r = link_entry_into_array(f, first, &i, p);
1162 *idx = htole64(le64toh(*idx) + 1);
1166 static int journal_file_link_entry_item(JournalFile *f, Object *o, uint64_t offset, uint64_t i) {
1173 p = le64toh(o->entry.items[i].object_offset);
1177 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
1181 return link_entry_into_array_plus_one(f,
1182 &o->data.entry_offset,
1183 &o->data.entry_array_offset,
1188 static int journal_file_link_entry(JournalFile *f, Object *o, uint64_t offset) {
1196 if (o->object.type != OBJECT_ENTRY)
1199 __sync_synchronize();
1201 /* Link up the entry itself */
1202 r = link_entry_into_array(f,
1203 &f->header->entry_array_offset,
1204 &f->header->n_entries,
1209 /* log_debug("=> %s seqnr=%lu n_entries=%lu", f->path, (unsigned long) o->entry.seqnum, (unsigned long) f->header->n_entries); */
1211 if (f->header->head_entry_realtime == 0)
1212 f->header->head_entry_realtime = o->entry.realtime;
1214 f->header->tail_entry_realtime = o->entry.realtime;
1215 f->header->tail_entry_monotonic = o->entry.monotonic;
1217 f->tail_entry_monotonic_valid = true;
1219 /* Link up the items */
1220 n = journal_file_entry_n_items(o);
1221 for (i = 0; i < n; i++) {
1222 r = journal_file_link_entry_item(f, o, offset, i);
1230 static int journal_file_append_entry_internal(
1232 const dual_timestamp *ts,
1234 const EntryItem items[], unsigned n_items,
1236 Object **ret, uint64_t *offset) {
1243 assert(items || n_items == 0);
1246 osize = offsetof(Object, entry.items) + (n_items * sizeof(EntryItem));
1248 r = journal_file_append_object(f, OBJECT_ENTRY, osize, &o, &np);
1252 o->entry.seqnum = htole64(journal_file_entry_seqnum(f, seqnum));
1253 memcpy(o->entry.items, items, n_items * sizeof(EntryItem));
1254 o->entry.realtime = htole64(ts->realtime);
1255 o->entry.monotonic = htole64(ts->monotonic);
1256 o->entry.xor_hash = htole64(xor_hash);
1257 o->entry.boot_id = f->header->boot_id;
1260 r = journal_file_hmac_put_object(f, OBJECT_ENTRY, o, np);
1265 r = journal_file_link_entry(f, o, np);
1278 void journal_file_post_change(JournalFile *f) {
1281 /* inotify() does not receive IN_MODIFY events from file
1282 * accesses done via mmap(). After each access we hence
1283 * trigger IN_MODIFY by truncating the journal file to its
1284 * current size which triggers IN_MODIFY. */
1286 __sync_synchronize();
1288 if (ftruncate(f->fd, f->last_stat.st_size) < 0)
1289 log_error("Failed to truncate file to its own size: %m");
1292 static int entry_item_cmp(const void *_a, const void *_b) {
1293 const EntryItem *a = _a, *b = _b;
1295 if (le64toh(a->object_offset) < le64toh(b->object_offset))
1297 if (le64toh(a->object_offset) > le64toh(b->object_offset))
1302 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) {
1306 uint64_t xor_hash = 0;
1307 struct dual_timestamp _ts;
1310 assert(iovec || n_iovec == 0);
1313 dual_timestamp_get(&_ts);
1317 if (f->tail_entry_monotonic_valid &&
1318 ts->monotonic < le64toh(f->header->tail_entry_monotonic))
1322 r = journal_file_maybe_append_tag(f, ts->realtime);
1327 /* alloca() can't take 0, hence let's allocate at least one */
1328 items = alloca(sizeof(EntryItem) * MAX(1, n_iovec));
1330 for (i = 0; i < n_iovec; i++) {
1334 r = journal_file_append_data(f, iovec[i].iov_base, iovec[i].iov_len, &o, &p);
1338 xor_hash ^= le64toh(o->data.hash);
1339 items[i].object_offset = htole64(p);
1340 items[i].hash = o->data.hash;
1343 /* Order by the position on disk, in order to improve seek
1344 * times for rotating media. */
1345 qsort(items, n_iovec, sizeof(EntryItem), entry_item_cmp);
1347 r = journal_file_append_entry_internal(f, ts, xor_hash, items, n_iovec, seqnum, ret, offset);
1349 journal_file_post_change(f);
1354 typedef struct ChainCacheItem {
1355 uint64_t first; /* the array at the begin of the chain */
1356 uint64_t array; /* the cached array */
1357 uint64_t begin; /* the first item in the cached array */
1358 uint64_t total; /* the total number of items in all arrays before this one in the chain */
1361 static void chain_cache_put(
1370 /* If the chain item to cache for this chain is the
1371 * first one it's not worth caching anything */
1375 if (hashmap_size(h) >= CHAIN_CACHE_MAX)
1376 ci = hashmap_steal_first(h);
1378 ci = new(ChainCacheItem, 1);
1385 if (hashmap_put(h, &ci->first, ci) < 0) {
1390 assert(ci->first == first);
1397 static int generic_array_get(JournalFile *f,
1400 Object **ret, uint64_t *offset) {
1403 uint64_t p = 0, a, t = 0;
1411 /* Try the chain cache first */
1412 ci = hashmap_get(f->chain_cache, &first);
1413 if (ci && i > ci->total) {
1422 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &o);
1426 k = journal_file_entry_array_n_items(o);
1428 p = le64toh(o->entry_array.items[i]);
1434 a = le64toh(o->entry_array.next_entry_array_offset);
1440 /* Let's cache this item for the next invocation */
1441 chain_cache_put(f->chain_cache, ci, first, a, o->entry_array.items[0], t);
1443 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1456 static int generic_array_get_plus_one(JournalFile *f,
1460 Object **ret, uint64_t *offset) {
1469 r = journal_file_move_to_object(f, OBJECT_ENTRY, extra, &o);
1482 return generic_array_get(f, first, i-1, ret, offset);
1491 static int generic_array_bisect(JournalFile *f,
1495 int (*test_object)(JournalFile *f, uint64_t p, uint64_t needle),
1496 direction_t direction,
1501 uint64_t a, p, t = 0, i = 0, last_p = 0;
1502 bool subtract_one = false;
1503 Object *o, *array = NULL;
1508 assert(test_object);
1510 /* Start with the first array in the chain */
1513 ci = hashmap_get(f->chain_cache, &first);
1514 if (ci && n > ci->total) {
1515 /* Ah, we have iterated this bisection array chain
1516 * previously! Let's see if we can skip ahead in the
1517 * chain, as far as the last time. But we can't jump
1518 * backwards in the chain, so let's check that
1521 r = test_object(f, ci->begin, needle);
1525 if (r == TEST_LEFT) {
1526 /* OK, what we are looking for is right of th
1527 * begin of this EntryArray, so let's jump
1528 * straight to previously cached array in the
1538 uint64_t left, right, k, lp;
1540 r = journal_file_move_to_object(f, OBJECT_ENTRY_ARRAY, a, &array);
1544 k = journal_file_entry_array_n_items(array);
1550 lp = p = le64toh(array->entry_array.items[i]);
1554 r = test_object(f, p, needle);
1558 if (r == TEST_FOUND)
1559 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1561 if (r == TEST_RIGHT) {
1565 if (left == right) {
1566 if (direction == DIRECTION_UP)
1567 subtract_one = true;
1573 assert(left < right);
1575 i = (left + right) / 2;
1576 p = le64toh(array->entry_array.items[i]);
1580 r = test_object(f, p, needle);
1584 if (r == TEST_FOUND)
1585 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1587 if (r == TEST_RIGHT)
1595 if (direction == DIRECTION_UP) {
1597 subtract_one = true;
1608 a = le64toh(array->entry_array.next_entry_array_offset);
1614 if (subtract_one && t == 0 && i == 0)
1617 /* Let's cache this item for the next invocation */
1618 chain_cache_put(f->chain_cache, ci, first, a, array->entry_array.items[0], t);
1620 if (subtract_one && i == 0)
1622 else if (subtract_one)
1623 p = le64toh(array->entry_array.items[i-1]);
1625 p = le64toh(array->entry_array.items[i]);
1627 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1638 *idx = t + i + (subtract_one ? -1 : 0);
1643 static int generic_array_bisect_plus_one(JournalFile *f,
1648 int (*test_object)(JournalFile *f, uint64_t p, uint64_t needle),
1649 direction_t direction,
1655 bool step_back = false;
1659 assert(test_object);
1664 /* This bisects the array in object 'first', but first checks
1666 r = test_object(f, extra, needle);
1670 if (r == TEST_FOUND)
1671 r = direction == DIRECTION_DOWN ? TEST_RIGHT : TEST_LEFT;
1673 /* if we are looking with DIRECTION_UP then we need to first
1674 see if in the actual array there is a matching entry, and
1675 return the last one of that. But if there isn't any we need
1676 to return this one. Hence remember this, and return it
1679 step_back = direction == DIRECTION_UP;
1681 if (r == TEST_RIGHT) {
1682 if (direction == DIRECTION_DOWN)
1688 r = generic_array_bisect(f, first, n-1, needle, test_object, direction, ret, offset, idx);
1690 if (r == 0 && step_back)
1699 r = journal_file_move_to_object(f, OBJECT_ENTRY, extra, &o);
1715 static int test_object_offset(JournalFile *f, uint64_t p, uint64_t needle) {
1721 else if (p < needle)
1727 int journal_file_move_to_entry_by_offset(
1730 direction_t direction,
1734 return generic_array_bisect(f,
1735 le64toh(f->header->entry_array_offset),
1736 le64toh(f->header->n_entries),
1744 static int test_object_seqnum(JournalFile *f, uint64_t p, uint64_t needle) {
1751 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1755 if (le64toh(o->entry.seqnum) == needle)
1757 else if (le64toh(o->entry.seqnum) < needle)
1763 int journal_file_move_to_entry_by_seqnum(
1766 direction_t direction,
1770 return generic_array_bisect(f,
1771 le64toh(f->header->entry_array_offset),
1772 le64toh(f->header->n_entries),
1779 static int test_object_realtime(JournalFile *f, uint64_t p, uint64_t needle) {
1786 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1790 if (le64toh(o->entry.realtime) == needle)
1792 else if (le64toh(o->entry.realtime) < needle)
1798 int journal_file_move_to_entry_by_realtime(
1801 direction_t direction,
1805 return generic_array_bisect(f,
1806 le64toh(f->header->entry_array_offset),
1807 le64toh(f->header->n_entries),
1809 test_object_realtime,
1814 static int test_object_monotonic(JournalFile *f, uint64_t p, uint64_t needle) {
1821 r = journal_file_move_to_object(f, OBJECT_ENTRY, p, &o);
1825 if (le64toh(o->entry.monotonic) == needle)
1827 else if (le64toh(o->entry.monotonic) < needle)
1833 int journal_file_move_to_entry_by_monotonic(
1837 direction_t direction,
1841 char t[9+32+1] = "_BOOT_ID=";
1847 sd_id128_to_string(boot_id, t + 9);
1848 r = journal_file_find_data_object(f, t, strlen(t), &o, NULL);
1854 return generic_array_bisect_plus_one(f,
1855 le64toh(o->data.entry_offset),
1856 le64toh(o->data.entry_array_offset),
1857 le64toh(o->data.n_entries),
1859 test_object_monotonic,
1864 int journal_file_next_entry(
1866 Object *o, uint64_t p,
1867 direction_t direction,
1868 Object **ret, uint64_t *offset) {
1874 assert(p > 0 || !o);
1876 n = le64toh(f->header->n_entries);
1881 i = direction == DIRECTION_DOWN ? 0 : n - 1;
1883 if (o->object.type != OBJECT_ENTRY)
1886 r = generic_array_bisect(f,
1887 le64toh(f->header->entry_array_offset),
1888 le64toh(f->header->n_entries),
1897 if (direction == DIRECTION_DOWN) {
1910 /* And jump to it */
1911 return generic_array_get(f,
1912 le64toh(f->header->entry_array_offset),
1917 int journal_file_skip_entry(
1919 Object *o, uint64_t p,
1921 Object **ret, uint64_t *offset) {
1930 if (o->object.type != OBJECT_ENTRY)
1933 r = generic_array_bisect(f,
1934 le64toh(f->header->entry_array_offset),
1935 le64toh(f->header->n_entries),
1944 /* Calculate new index */
1946 if ((uint64_t) -skip >= i)
1949 i = i - (uint64_t) -skip;
1951 i += (uint64_t) skip;
1953 n = le64toh(f->header->n_entries);
1960 return generic_array_get(f,
1961 le64toh(f->header->entry_array_offset),
1966 int journal_file_next_entry_for_data(
1968 Object *o, uint64_t p,
1969 uint64_t data_offset,
1970 direction_t direction,
1971 Object **ret, uint64_t *offset) {
1978 assert(p > 0 || !o);
1980 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
1984 n = le64toh(d->data.n_entries);
1989 i = direction == DIRECTION_DOWN ? 0 : n - 1;
1991 if (o->object.type != OBJECT_ENTRY)
1994 r = generic_array_bisect_plus_one(f,
1995 le64toh(d->data.entry_offset),
1996 le64toh(d->data.entry_array_offset),
1997 le64toh(d->data.n_entries),
2007 if (direction == DIRECTION_DOWN) {
2021 return generic_array_get_plus_one(f,
2022 le64toh(d->data.entry_offset),
2023 le64toh(d->data.entry_array_offset),
2028 int journal_file_move_to_entry_by_offset_for_data(
2030 uint64_t data_offset,
2032 direction_t direction,
2033 Object **ret, uint64_t *offset) {
2040 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2044 return generic_array_bisect_plus_one(f,
2045 le64toh(d->data.entry_offset),
2046 le64toh(d->data.entry_array_offset),
2047 le64toh(d->data.n_entries),
2054 int journal_file_move_to_entry_by_monotonic_for_data(
2056 uint64_t data_offset,
2059 direction_t direction,
2060 Object **ret, uint64_t *offset) {
2062 char t[9+32+1] = "_BOOT_ID=";
2069 /* First, seek by time */
2070 sd_id128_to_string(boot_id, t + 9);
2071 r = journal_file_find_data_object(f, t, strlen(t), &o, &b);
2077 r = generic_array_bisect_plus_one(f,
2078 le64toh(o->data.entry_offset),
2079 le64toh(o->data.entry_array_offset),
2080 le64toh(o->data.n_entries),
2082 test_object_monotonic,
2088 /* And now, continue seeking until we find an entry that
2089 * exists in both bisection arrays */
2095 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2099 r = generic_array_bisect_plus_one(f,
2100 le64toh(d->data.entry_offset),
2101 le64toh(d->data.entry_array_offset),
2102 le64toh(d->data.n_entries),
2110 r = journal_file_move_to_object(f, OBJECT_DATA, b, &o);
2114 r = generic_array_bisect_plus_one(f,
2115 le64toh(o->data.entry_offset),
2116 le64toh(o->data.entry_array_offset),
2117 le64toh(o->data.n_entries),
2141 int journal_file_move_to_entry_by_seqnum_for_data(
2143 uint64_t data_offset,
2145 direction_t direction,
2146 Object **ret, uint64_t *offset) {
2153 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2157 return generic_array_bisect_plus_one(f,
2158 le64toh(d->data.entry_offset),
2159 le64toh(d->data.entry_array_offset),
2160 le64toh(d->data.n_entries),
2167 int journal_file_move_to_entry_by_realtime_for_data(
2169 uint64_t data_offset,
2171 direction_t direction,
2172 Object **ret, uint64_t *offset) {
2179 r = journal_file_move_to_object(f, OBJECT_DATA, data_offset, &d);
2183 return generic_array_bisect_plus_one(f,
2184 le64toh(d->data.entry_offset),
2185 le64toh(d->data.entry_array_offset),
2186 le64toh(d->data.n_entries),
2188 test_object_realtime,
2193 void journal_file_dump(JournalFile *f) {
2200 journal_file_print_header(f);
2202 p = le64toh(f->header->header_size);
2204 r = journal_file_move_to_object(f, -1, p, &o);
2208 switch (o->object.type) {
2211 printf("Type: OBJECT_UNUSED\n");
2215 printf("Type: OBJECT_DATA\n");
2219 printf("Type: OBJECT_FIELD\n");
2223 printf("Type: OBJECT_ENTRY seqnum=%llu monotonic=%llu realtime=%llu\n",
2224 (unsigned long long) le64toh(o->entry.seqnum),
2225 (unsigned long long) le64toh(o->entry.monotonic),
2226 (unsigned long long) le64toh(o->entry.realtime));
2229 case OBJECT_FIELD_HASH_TABLE:
2230 printf("Type: OBJECT_FIELD_HASH_TABLE\n");
2233 case OBJECT_DATA_HASH_TABLE:
2234 printf("Type: OBJECT_DATA_HASH_TABLE\n");
2237 case OBJECT_ENTRY_ARRAY:
2238 printf("Type: OBJECT_ENTRY_ARRAY\n");
2242 printf("Type: OBJECT_TAG seqnum=%llu epoch=%llu\n",
2243 (unsigned long long) le64toh(o->tag.seqnum),
2244 (unsigned long long) le64toh(o->tag.epoch));
2248 printf("Type: unknown (%u)\n", o->object.type);
2252 if (o->object.flags & OBJECT_COMPRESSED)
2253 printf("Flags: COMPRESSED\n");
2255 if (p == le64toh(f->header->tail_object_offset))
2258 p = p + ALIGN64(le64toh(o->object.size));
2263 log_error("File corrupt");
2266 void journal_file_print_header(JournalFile *f) {
2267 char a[33], b[33], c[33];
2268 char x[FORMAT_TIMESTAMP_MAX], y[FORMAT_TIMESTAMP_MAX];
2270 char bytes[FORMAT_BYTES_MAX];
2274 printf("File Path: %s\n"
2278 "Sequential Number ID: %s\n"
2280 "Compatible Flags:%s%s\n"
2281 "Incompatible Flags:%s%s\n"
2282 "Header size: %llu\n"
2283 "Arena size: %llu\n"
2284 "Data Hash Table Size: %llu\n"
2285 "Field Hash Table Size: %llu\n"
2286 "Rotate Suggested: %s\n"
2287 "Head Sequential Number: %llu\n"
2288 "Tail Sequential Number: %llu\n"
2289 "Head Realtime Timestamp: %s\n"
2290 "Tail Realtime Timestamp: %s\n"
2292 "Entry Objects: %llu\n",
2294 sd_id128_to_string(f->header->file_id, a),
2295 sd_id128_to_string(f->header->machine_id, b),
2296 sd_id128_to_string(f->header->boot_id, c),
2297 sd_id128_to_string(f->header->seqnum_id, c),
2298 f->header->state == STATE_OFFLINE ? "OFFLINE" :
2299 f->header->state == STATE_ONLINE ? "ONLINE" :
2300 f->header->state == STATE_ARCHIVED ? "ARCHIVED" : "UNKNOWN",
2301 JOURNAL_HEADER_SEALED(f->header) ? " SEALED" : "",
2302 (le32toh(f->header->compatible_flags) & ~HEADER_COMPATIBLE_SEALED) ? " ???" : "",
2303 JOURNAL_HEADER_COMPRESSED(f->header) ? " COMPRESSED" : "",
2304 (le32toh(f->header->incompatible_flags) & ~HEADER_INCOMPATIBLE_COMPRESSED) ? " ???" : "",
2305 (unsigned long long) le64toh(f->header->header_size),
2306 (unsigned long long) le64toh(f->header->arena_size),
2307 (unsigned long long) le64toh(f->header->data_hash_table_size) / sizeof(HashItem),
2308 (unsigned long long) le64toh(f->header->field_hash_table_size) / sizeof(HashItem),
2309 yes_no(journal_file_rotate_suggested(f, 0)),
2310 (unsigned long long) le64toh(f->header->head_entry_seqnum),
2311 (unsigned long long) le64toh(f->header->tail_entry_seqnum),
2312 format_timestamp(x, sizeof(x), le64toh(f->header->head_entry_realtime)),
2313 format_timestamp(y, sizeof(y), le64toh(f->header->tail_entry_realtime)),
2314 (unsigned long long) le64toh(f->header->n_objects),
2315 (unsigned long long) le64toh(f->header->n_entries));
2317 if (JOURNAL_HEADER_CONTAINS(f->header, n_data))
2318 printf("Data Objects: %llu\n"
2319 "Data Hash Table Fill: %.1f%%\n",
2320 (unsigned long long) le64toh(f->header->n_data),
2321 100.0 * (double) le64toh(f->header->n_data) / ((double) (le64toh(f->header->data_hash_table_size) / sizeof(HashItem))));
2323 if (JOURNAL_HEADER_CONTAINS(f->header, n_fields))
2324 printf("Field Objects: %llu\n"
2325 "Field Hash Table Fill: %.1f%%\n",
2326 (unsigned long long) le64toh(f->header->n_fields),
2327 100.0 * (double) le64toh(f->header->n_fields) / ((double) (le64toh(f->header->field_hash_table_size) / sizeof(HashItem))));
2329 if (JOURNAL_HEADER_CONTAINS(f->header, n_tags))
2330 printf("Tag Objects: %llu\n",
2331 (unsigned long long) le64toh(f->header->n_tags));
2332 if (JOURNAL_HEADER_CONTAINS(f->header, n_entry_arrays))
2333 printf("Entry Array Objects: %llu\n",
2334 (unsigned long long) le64toh(f->header->n_entry_arrays));
2336 if (fstat(f->fd, &st) >= 0)
2337 printf("Disk usage: %s\n", format_bytes(bytes, sizeof(bytes), (off_t) st.st_blocks * 512ULL));
2340 int journal_file_open(
2346 JournalMetrics *metrics,
2347 MMapCache *mmap_cache,
2348 JournalFile *template,
2349 JournalFile **ret) {
2353 bool newly_created = false;
2358 if ((flags & O_ACCMODE) != O_RDONLY &&
2359 (flags & O_ACCMODE) != O_RDWR)
2362 if (!endswith(fname, ".journal") &&
2363 !endswith(fname, ".journal~"))
2366 f = new0(JournalFile, 1);
2374 f->prot = prot_from_flags(flags);
2375 f->writable = (flags & O_ACCMODE) != O_RDONLY;
2377 f->compress = compress;
2384 f->mmap = mmap_cache_ref(mmap_cache);
2386 f->mmap = mmap_cache_new();
2393 f->path = strdup(fname);
2399 f->chain_cache = hashmap_new(uint64_hash_func, uint64_compare_func);
2400 if (!f->chain_cache) {
2405 f->fd = open(f->path, f->flags|O_CLOEXEC, f->mode);
2411 if (fstat(f->fd, &f->last_stat) < 0) {
2416 if (f->last_stat.st_size == 0 && f->writable) {
2420 /* Let's attach the creation time to the journal file,
2421 * so that the vacuuming code knows the age of this
2422 * file even if the file might end up corrupted one
2423 * day... Ideally we'd just use the creation time many
2424 * file systems maintain for each file, but there is
2425 * currently no usable API to query this, hence let's
2426 * emulate this via extended attributes. If extended
2427 * attributes are not supported we'll just skip this,
2428 * and rely solely on mtime/atime/ctime of the file.*/
2430 crtime = htole64((uint64_t) now(CLOCK_REALTIME));
2431 fsetxattr(f->fd, "user.crtime_usec", &crtime, sizeof(crtime), XATTR_CREATE);
2435 /* Try to load the FSPRG state, and if we can't, then
2436 * just don't do sealing */
2438 r = journal_file_fss_load(f);
2444 r = journal_file_init_header(f, template);
2448 if (fstat(f->fd, &f->last_stat) < 0) {
2453 newly_created = true;
2456 if (f->last_stat.st_size < (off_t) HEADER_SIZE_MIN) {
2461 f->header = mmap(NULL, PAGE_ALIGN(sizeof(Header)), prot_from_flags(flags), MAP_SHARED, f->fd, 0);
2462 if (f->header == MAP_FAILED) {
2468 if (!newly_created) {
2469 r = journal_file_verify_header(f);
2475 if (!newly_created && f->writable) {
2476 r = journal_file_fss_load(f);
2484 journal_default_metrics(metrics, f->fd);
2485 f->metrics = *metrics;
2486 } else if (template)
2487 f->metrics = template->metrics;
2489 r = journal_file_refresh_header(f);
2495 r = journal_file_hmac_setup(f);
2500 if (newly_created) {
2501 r = journal_file_setup_field_hash_table(f);
2505 r = journal_file_setup_data_hash_table(f);
2510 r = journal_file_append_first_tag(f);
2516 r = journal_file_map_field_hash_table(f);
2520 r = journal_file_map_data_hash_table(f);
2528 journal_file_close(f);
2533 int journal_file_rotate(JournalFile **f, bool compress, bool seal) {
2536 JournalFile *old_file, *new_file = NULL;
2544 if (!old_file->writable)
2547 if (!endswith(old_file->path, ".journal"))
2550 l = strlen(old_file->path);
2552 p = new(char, l + 1 + 32 + 1 + 16 + 1 + 16 + 1);
2556 memcpy(p, old_file->path, l - 8);
2558 sd_id128_to_string(old_file->header->seqnum_id, p + l - 8 + 1);
2559 snprintf(p + l - 8 + 1 + 32, 1 + 16 + 1 + 16 + 8 + 1,
2560 "-%016llx-%016llx.journal",
2561 (unsigned long long) le64toh((*f)->header->head_entry_seqnum),
2562 (unsigned long long) le64toh((*f)->header->head_entry_realtime));
2564 r = rename(old_file->path, p);
2570 old_file->header->state = STATE_ARCHIVED;
2572 r = journal_file_open(old_file->path, old_file->flags, old_file->mode, compress, seal, NULL, old_file->mmap, old_file, &new_file);
2573 journal_file_close(old_file);
2579 int journal_file_open_reliably(
2585 JournalMetrics *metrics,
2586 MMapCache *mmap_cache,
2587 JournalFile *template,
2588 JournalFile **ret) {
2594 r = journal_file_open(fname, flags, mode, compress, seal,
2595 metrics, mmap_cache, template, ret);
2596 if (r != -EBADMSG && /* corrupted */
2597 r != -ENODATA && /* truncated */
2598 r != -EHOSTDOWN && /* other machine */
2599 r != -EPROTONOSUPPORT && /* incompatible feature */
2600 r != -EBUSY && /* unclean shutdown */
2601 r != -ESHUTDOWN /* already archived */)
2604 if ((flags & O_ACCMODE) == O_RDONLY)
2607 if (!(flags & O_CREAT))
2610 if (!endswith(fname, ".journal"))
2613 /* The file is corrupted. Rotate it away and try it again (but only once) */
2616 if (asprintf(&p, "%.*s@%016llx-%016llx.journal~",
2618 (unsigned long long) now(CLOCK_REALTIME),
2622 r = rename(fname, p);
2627 log_warning("File %s corrupted or uncleanly shut down, renaming and replacing.", fname);
2629 return journal_file_open(fname, flags, mode, compress, seal,
2630 metrics, mmap_cache, template, ret);
2633 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset) {
2635 uint64_t q, xor_hash = 0;
2648 ts.monotonic = le64toh(o->entry.monotonic);
2649 ts.realtime = le64toh(o->entry.realtime);
2651 if (to->tail_entry_monotonic_valid &&
2652 ts.monotonic < le64toh(to->header->tail_entry_monotonic))
2655 n = journal_file_entry_n_items(o);
2656 items = alloca(sizeof(EntryItem) * n);
2658 for (i = 0; i < n; i++) {
2665 q = le64toh(o->entry.items[i].object_offset);
2666 le_hash = o->entry.items[i].hash;
2668 r = journal_file_move_to_object(from, OBJECT_DATA, q, &o);
2672 if (le_hash != o->data.hash)
2675 l = le64toh(o->object.size) - offsetof(Object, data.payload);
2678 /* We hit the limit on 32bit machines */
2679 if ((uint64_t) t != l)
2682 if (o->object.flags & OBJECT_COMPRESSED) {
2686 if (!uncompress_blob(o->data.payload, l, &from->compress_buffer, &from->compress_buffer_size, &rsize, 0))
2689 data = from->compress_buffer;
2692 return -EPROTONOSUPPORT;
2695 data = o->data.payload;
2697 r = journal_file_append_data(to, data, l, &u, &h);
2701 xor_hash ^= le64toh(u->data.hash);
2702 items[i].object_offset = htole64(h);
2703 items[i].hash = u->data.hash;
2705 r = journal_file_move_to_object(from, OBJECT_ENTRY, p, &o);
2710 return journal_file_append_entry_internal(to, &ts, xor_hash, items, n, seqnum, ret, offset);
2713 void journal_default_metrics(JournalMetrics *m, int fd) {
2714 uint64_t fs_size = 0;
2716 char a[FORMAT_BYTES_MAX], b[FORMAT_BYTES_MAX], c[FORMAT_BYTES_MAX], d[FORMAT_BYTES_MAX];
2721 if (fstatvfs(fd, &ss) >= 0)
2722 fs_size = ss.f_frsize * ss.f_blocks;
2724 if (m->max_use == (uint64_t) -1) {
2727 m->max_use = PAGE_ALIGN(fs_size / 10); /* 10% of file system size */
2729 if (m->max_use > DEFAULT_MAX_USE_UPPER)
2730 m->max_use = DEFAULT_MAX_USE_UPPER;
2732 if (m->max_use < DEFAULT_MAX_USE_LOWER)
2733 m->max_use = DEFAULT_MAX_USE_LOWER;
2735 m->max_use = DEFAULT_MAX_USE_LOWER;
2737 m->max_use = PAGE_ALIGN(m->max_use);
2739 if (m->max_use < JOURNAL_FILE_SIZE_MIN*2)
2740 m->max_use = JOURNAL_FILE_SIZE_MIN*2;
2743 if (m->max_size == (uint64_t) -1) {
2744 m->max_size = PAGE_ALIGN(m->max_use / 8); /* 8 chunks */
2746 if (m->max_size > DEFAULT_MAX_SIZE_UPPER)
2747 m->max_size = DEFAULT_MAX_SIZE_UPPER;
2749 m->max_size = PAGE_ALIGN(m->max_size);
2751 if (m->max_size < JOURNAL_FILE_SIZE_MIN)
2752 m->max_size = JOURNAL_FILE_SIZE_MIN;
2754 if (m->max_size*2 > m->max_use)
2755 m->max_use = m->max_size*2;
2757 if (m->min_size == (uint64_t) -1)
2758 m->min_size = JOURNAL_FILE_SIZE_MIN;
2760 m->min_size = PAGE_ALIGN(m->min_size);
2762 if (m->min_size < JOURNAL_FILE_SIZE_MIN)
2763 m->min_size = JOURNAL_FILE_SIZE_MIN;
2765 if (m->min_size > m->max_size)
2766 m->max_size = m->min_size;
2769 if (m->keep_free == (uint64_t) -1) {
2772 m->keep_free = PAGE_ALIGN(fs_size / 20); /* 5% of file system size */
2774 if (m->keep_free > DEFAULT_KEEP_FREE_UPPER)
2775 m->keep_free = DEFAULT_KEEP_FREE_UPPER;
2778 m->keep_free = DEFAULT_KEEP_FREE;
2781 log_debug("Fixed max_use=%s max_size=%s min_size=%s keep_free=%s",
2782 format_bytes(a, sizeof(a), m->max_use),
2783 format_bytes(b, sizeof(b), m->max_size),
2784 format_bytes(c, sizeof(c), m->min_size),
2785 format_bytes(d, sizeof(d), m->keep_free));
2788 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to) {
2793 if (f->header->head_entry_realtime == 0)
2796 *from = le64toh(f->header->head_entry_realtime);
2800 if (f->header->tail_entry_realtime == 0)
2803 *to = le64toh(f->header->tail_entry_realtime);
2809 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot_id, usec_t *from, usec_t *to) {
2810 char t[9+32+1] = "_BOOT_ID=";
2818 sd_id128_to_string(boot_id, t + 9);
2820 r = journal_file_find_data_object(f, t, strlen(t), &o, &p);
2824 if (le64toh(o->data.n_entries) <= 0)
2828 r = journal_file_move_to_object(f, OBJECT_ENTRY, le64toh(o->data.entry_offset), &o);
2832 *from = le64toh(o->entry.monotonic);
2836 r = journal_file_move_to_object(f, OBJECT_DATA, p, &o);
2840 r = generic_array_get_plus_one(f,
2841 le64toh(o->data.entry_offset),
2842 le64toh(o->data.entry_array_offset),
2843 le64toh(o->data.n_entries)-1,
2848 *to = le64toh(o->entry.monotonic);
2854 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec) {
2857 /* If we gained new header fields we gained new features,
2858 * hence suggest a rotation */
2859 if (le64toh(f->header->header_size) < sizeof(Header)) {
2860 log_debug("%s uses an outdated header, suggesting rotation.", f->path);
2864 /* Let's check if the hash tables grew over a certain fill
2865 * level (75%, borrowing this value from Java's hash table
2866 * implementation), and if so suggest a rotation. To calculate
2867 * the fill level we need the n_data field, which only exists
2868 * in newer versions. */
2870 if (JOURNAL_HEADER_CONTAINS(f->header, n_data))
2871 if (le64toh(f->header->n_data) * 4ULL > (le64toh(f->header->data_hash_table_size) / sizeof(HashItem)) * 3ULL) {
2872 log_debug("Data hash table of %s has a fill level at %.1f (%llu of %llu items, %llu file size, %llu bytes per hash table item), suggesting rotation.",
2874 100.0 * (double) le64toh(f->header->n_data) / ((double) (le64toh(f->header->data_hash_table_size) / sizeof(HashItem))),
2875 (unsigned long long) le64toh(f->header->n_data),
2876 (unsigned long long) (le64toh(f->header->data_hash_table_size) / sizeof(HashItem)),
2877 (unsigned long long) (f->last_stat.st_size),
2878 (unsigned long long) (f->last_stat.st_size / le64toh(f->header->n_data)));
2882 if (JOURNAL_HEADER_CONTAINS(f->header, n_fields))
2883 if (le64toh(f->header->n_fields) * 4ULL > (le64toh(f->header->field_hash_table_size) / sizeof(HashItem)) * 3ULL) {
2884 log_debug("Field hash table of %s has a fill level at %.1f (%llu of %llu items), suggesting rotation.",
2886 100.0 * (double) le64toh(f->header->n_fields) / ((double) (le64toh(f->header->field_hash_table_size) / sizeof(HashItem))),
2887 (unsigned long long) le64toh(f->header->n_fields),
2888 (unsigned long long) (le64toh(f->header->field_hash_table_size) / sizeof(HashItem)));
2892 /* Are the data objects properly indexed by field objects? */
2893 if (JOURNAL_HEADER_CONTAINS(f->header, n_data) &&
2894 JOURNAL_HEADER_CONTAINS(f->header, n_fields) &&
2895 le64toh(f->header->n_data) > 0 &&
2896 le64toh(f->header->n_fields) == 0)
2899 if (max_file_usec > 0) {
2902 h = le64toh(f->header->head_entry_realtime);
2903 t = now(CLOCK_REALTIME);
2905 if (h > 0 && t > h + max_file_usec)