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 {
46 typedef enum direction {
51 typedef struct JournalFile {
62 bool tail_entry_monotonic_valid:1;
64 direction_t last_direction;
67 struct stat last_stat;
70 HashItem *data_hash_table;
71 HashItem *field_hash_table;
73 uint64_t current_offset;
75 JournalMetrics metrics;
81 void *compress_buffer;
82 uint64_t compress_buffer_size;
92 uint64_t fss_start_usec;
93 uint64_t fss_interval_usec;
96 size_t fsprg_state_size;
99 size_t fsprg_seed_size;
103 int journal_file_open(
109 JournalMetrics *metrics,
110 MMapCache *mmap_cache,
111 JournalFile *template,
114 int journal_file_set_offline(JournalFile *f);
115 void journal_file_close(JournalFile *j);
117 int journal_file_open_reliably(
123 JournalMetrics *metrics,
124 MMapCache *mmap_cache,
125 JournalFile *template,
128 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
129 #define VALID64(x) (((x) & 7ULL) == 0ULL)
131 /* Use six characters to cover the offsets common in smallish journal
132 * files without adding too many zeros. */
133 #define OFSfmt "%06"PRIx64
135 static inline bool VALID_REALTIME(uint64_t u) {
136 /* This considers timestamps until the year 3112 valid. That should be plenty room... */
137 return u > 0 && u < (1ULL << 55);
140 static inline bool VALID_MONOTONIC(uint64_t u) {
141 /* This considers timestamps until 1142 years of runtime valid. */
142 return u < (1ULL << 55);
145 static inline bool VALID_EPOCH(uint64_t u) {
146 /* This allows changing the key for 1142 years, every usec. */
147 return u < (1ULL << 55);
150 #define JOURNAL_HEADER_CONTAINS(h, field) \
151 (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
153 #define JOURNAL_HEADER_SEALED(h) \
154 (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
156 #define JOURNAL_HEADER_COMPRESSED(h) \
157 (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED))
159 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
161 uint64_t journal_file_entry_n_items(Object *o) _pure_;
162 uint64_t journal_file_entry_array_n_items(Object *o) _pure_;
163 uint64_t journal_file_hash_table_n_items(Object *o) _pure_;
165 int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset);
166 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);
168 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
169 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
171 int journal_file_find_field_object(JournalFile *f, const void *field, uint64_t size, Object **ret, uint64_t *offset);
172 int journal_file_find_field_object_with_hash(JournalFile *f, const void *field, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
174 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
175 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
177 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);
179 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
180 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
181 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
182 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);
184 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);
185 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);
186 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);
187 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);
189 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
191 void journal_file_dump(JournalFile *f);
192 void journal_file_print_header(JournalFile *f);
194 int journal_file_rotate(JournalFile **f, bool compress, bool seal);
196 void journal_file_post_change(JournalFile *f);
198 void journal_default_metrics(JournalMetrics *m, int fd);
200 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
201 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
203 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec);
206 static unsigned type_to_context(int type) {
207 /* One context for each type, plus one catch-all for the rest */
208 return type > 0 && type < _OBJECT_TYPE_MAX ? type : 0;
211 static inline int journal_file_object_keep(JournalFile *f, Object *o, uint64_t offset) {
212 unsigned context = type_to_context(o->object.type);
214 return mmap_cache_get(f->mmap, f->fd, f->prot, context, true,
215 offset, o->object.size, &f->last_stat, NULL);
218 static inline int journal_file_object_release(JournalFile *f, Object *o, uint64_t offset) {
219 unsigned context = type_to_context(o->object.type);
221 return mmap_cache_release(f->mmap, f->fd, f->prot, context,
222 offset, o->object.size);