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"
38 typedef struct JournalMetrics {
45 typedef enum direction {
50 typedef struct JournalFile {
61 bool tail_entry_monotonic_valid:1;
63 direction_t last_direction;
66 struct stat last_stat;
69 HashItem *data_hash_table;
70 HashItem *field_hash_table;
72 uint64_t current_offset;
74 JournalMetrics metrics;
80 void *compress_buffer;
81 uint64_t compress_buffer_size;
91 uint64_t fss_start_usec;
92 uint64_t fss_interval_usec;
95 size_t fsprg_state_size;
98 size_t fsprg_seed_size;
102 int journal_file_open(
108 JournalMetrics *metrics,
109 MMapCache *mmap_cache,
110 JournalFile *template,
113 int journal_file_set_offline(JournalFile *f);
114 void journal_file_close(JournalFile *j);
116 int journal_file_open_reliably(
122 JournalMetrics *metrics,
123 MMapCache *mmap_cache,
124 JournalFile *template,
127 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
128 #define VALID64(x) (((x) & 7ULL) == 0ULL)
130 /* Use six characters to cover the offsets common in smallish journal
131 * files without adding too many zeros. */
132 #define OFSfmt "%06"PRIx64
134 static inline bool VALID_REALTIME(uint64_t u) {
135 /* This considers timestamps until the year 3112 valid. That should be plenty room... */
136 return u > 0 && u < (1ULL << 55);
139 static inline bool VALID_MONOTONIC(uint64_t u) {
140 /* This considers timestamps until 1142 years of runtime valid. */
141 return u < (1ULL << 55);
144 static inline bool VALID_EPOCH(uint64_t u) {
145 /* This allows changing the key for 1142 years, every usec. */
146 return u < (1ULL << 55);
149 #define JOURNAL_HEADER_CONTAINS(h, field) \
150 (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
152 #define JOURNAL_HEADER_SEALED(h) \
153 (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
155 #define JOURNAL_HEADER_COMPRESSED(h) \
156 (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED))
158 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
160 uint64_t journal_file_entry_n_items(Object *o) _pure_;
161 uint64_t journal_file_entry_array_n_items(Object *o) _pure_;
162 uint64_t journal_file_hash_table_n_items(Object *o) _pure_;
164 int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset);
165 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);
167 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
168 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
170 int journal_file_find_field_object(JournalFile *f, const void *field, uint64_t size, Object **ret, uint64_t *offset);
171 int journal_file_find_field_object_with_hash(JournalFile *f, const void *field, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
173 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
174 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
176 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);
178 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
179 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
180 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
181 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);
183 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);
184 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);
185 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);
186 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);
188 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
190 void journal_file_dump(JournalFile *f);
191 void journal_file_print_header(JournalFile *f);
193 int journal_file_rotate(JournalFile **f, bool compress, bool seal);
195 void journal_file_post_change(JournalFile *f);
197 void journal_default_metrics(JournalMetrics *m, int fd);
199 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
200 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
202 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec);
205 static unsigned type_to_context(int type) {
206 /* One context for each type, plus one catch-all for the rest */
207 return type > 0 && type < _OBJECT_TYPE_MAX ? type : 0;
210 static inline int journal_file_object_keep(JournalFile *f, Object *o, uint64_t offset) {
211 unsigned context = type_to_context(o->object.type);
213 return mmap_cache_get(f->mmap, f->fd, f->prot, context, true,
214 offset, o->object.size, &f->last_stat, NULL);
217 static inline int journal_file_object_release(JournalFile *f, Object *o, uint64_t offset) {
218 unsigned context = type_to_context(o->object.type);
220 return mmap_cache_release(f->mmap, f->fd, f->prot, context,
221 offset, o->object.size);