1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2011 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
30 #include <systemd/sd-id128.h>
32 #include "sparse-endian.h"
33 #include "journal-def.h"
35 #include "mmap-cache.h"
37 typedef struct JournalMetrics {
44 typedef struct JournalFile {
47 struct stat last_stat;
56 bool tail_entry_monotonic_valid;
59 HashItem *data_hash_table;
60 HashItem *field_hash_table;
62 uint64_t current_offset;
64 JournalMetrics metrics;
68 void *compress_buffer;
69 uint64_t compress_buffer_size;
79 uint64_t fss_start_usec;
80 uint64_t fss_interval_usec;
83 size_t fsprg_state_size;
86 size_t fsprg_seed_size;
90 typedef enum direction {
95 int journal_file_open(
101 JournalMetrics *metrics,
102 MMapCache *mmap_cache,
103 JournalFile *template,
106 void journal_file_close(JournalFile *j);
108 int journal_file_open_reliably(
114 JournalMetrics *metrics,
115 MMapCache *mmap_cache,
116 JournalFile *template,
119 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
120 #define VALID64(x) (((x) & 7ULL) == 0ULL)
122 static inline bool VALID_REALTIME(uint64_t u) {
123 /* This considers timestamps until the year 3112 valid. That should be plenty room... */
124 return u > 0 && u < (1ULL << 55);
127 static inline bool VALID_MONOTONIC(uint64_t u) {
128 /* This considers timestamps until 1142 years of runtime valid. */
129 return u < (1ULL << 55);
132 static inline bool VALID_EPOCH(uint64_t u) {
133 /* This allows changing the key for 1142 years, every usec. */
134 return u < (1ULL << 55);
137 #define JOURNAL_HEADER_CONTAINS(h, field) \
138 (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
140 #define JOURNAL_HEADER_SEALED(h) \
141 (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
143 #define JOURNAL_HEADER_COMPRESSED(h) \
144 (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED))
146 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
148 uint64_t journal_file_entry_n_items(Object *o);
149 uint64_t journal_file_entry_array_n_items(Object *o);
150 uint64_t journal_file_hash_table_n_items(Object *o);
152 int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset);
153 int journal_file_append_entry(JournalFile *f, const dual_timestamp *ts, const struct iovec iovec[], unsigned n_iovec, uint64_t *seqno, Object **ret, uint64_t *offset);
155 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
156 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
158 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
159 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
161 int journal_file_next_entry_for_data(JournalFile *f, Object *o, uint64_t p, uint64_t data_offset, direction_t direction, Object **ret, uint64_t *offset);
163 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
164 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
165 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
166 int journal_file_move_to_entry_by_monotonic(JournalFile *f, sd_id128_t boot_id, uint64_t monotonic, direction_t direction, Object **ret, uint64_t *offset);
168 int journal_file_move_to_entry_by_offset_for_data(JournalFile *f, uint64_t data_offset, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
169 int journal_file_move_to_entry_by_seqnum_for_data(JournalFile *f, uint64_t data_offset, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
170 int journal_file_move_to_entry_by_realtime_for_data(JournalFile *f, uint64_t data_offset, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
171 int journal_file_move_to_entry_by_monotonic_for_data(JournalFile *f, uint64_t data_offset, sd_id128_t boot_id, uint64_t monotonic, direction_t direction, Object **ret, uint64_t *offset);
173 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
175 void journal_file_dump(JournalFile *f);
176 void journal_file_print_header(JournalFile *f);
178 int journal_file_rotate(JournalFile **f, bool compress, bool seal);
180 void journal_file_post_change(JournalFile *f);
182 void journal_default_metrics(JournalMetrics *m, int fd);
184 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
185 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
187 bool journal_file_rotate_suggested(JournalFile *f);