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 struct JournalFile {
48 struct stat last_stat;
57 bool tail_entry_monotonic_valid;
60 HashItem *data_hash_table;
61 HashItem *field_hash_table;
63 uint64_t current_offset;
65 JournalMetrics metrics;
71 void *compress_buffer;
72 uint64_t compress_buffer_size;
82 uint64_t fss_start_usec;
83 uint64_t fss_interval_usec;
86 size_t fsprg_state_size;
89 size_t fsprg_seed_size;
93 typedef enum direction {
98 int journal_file_open(
104 JournalMetrics *metrics,
105 MMapCache *mmap_cache,
106 JournalFile *template,
109 int journal_file_set_offline(JournalFile *f);
110 int journal_file_set_online(JournalFile *f);
111 void journal_file_close(JournalFile *j);
113 int journal_file_open_reliably(
119 JournalMetrics *metrics,
120 MMapCache *mmap_cache,
121 JournalFile *template,
124 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
125 #define VALID64(x) (((x) & 7ULL) == 0ULL)
127 static inline bool VALID_REALTIME(uint64_t u) {
128 /* This considers timestamps until the year 3112 valid. That should be plenty room... */
129 return u > 0 && u < (1ULL << 55);
132 static inline bool VALID_MONOTONIC(uint64_t u) {
133 /* This considers timestamps until 1142 years of runtime valid. */
134 return u < (1ULL << 55);
137 static inline bool VALID_EPOCH(uint64_t u) {
138 /* This allows changing the key for 1142 years, every usec. */
139 return u < (1ULL << 55);
142 #define JOURNAL_HEADER_CONTAINS(h, field) \
143 (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
145 #define JOURNAL_HEADER_SEALED(h) \
146 (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
148 #define JOURNAL_HEADER_COMPRESSED(h) \
149 (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED))
151 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
153 uint64_t journal_file_entry_n_items(Object *o);
154 uint64_t journal_file_entry_array_n_items(Object *o);
155 uint64_t journal_file_hash_table_n_items(Object *o);
157 int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset);
158 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);
160 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
161 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
163 int journal_file_find_field_object(JournalFile *f, const void *field, uint64_t size, Object **ret, uint64_t *offset);
164 int journal_file_find_field_object_with_hash(JournalFile *f, const void *field, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
166 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
167 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
169 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);
171 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
172 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
173 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
174 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);
176 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);
177 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);
178 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);
179 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);
181 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
183 void journal_file_dump(JournalFile *f);
184 void journal_file_print_header(JournalFile *f);
186 int journal_file_rotate(JournalFile **f, bool compress, bool seal);
188 void journal_file_post_change(JournalFile *f);
190 void journal_default_metrics(JournalMetrics *m, int fd);
192 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
193 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
195 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec);