1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
3 #ifndef foojournalfilehfoo
4 #define foojournalfilehfoo
7 This file is part of systemd.
9 Copyright 2011 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 #include <systemd/sd-id128.h>
29 #include "sparse-endian.h"
30 #include "journal-def.h"
33 typedef struct Window {
40 WINDOW_UNKNOWN = OBJECT_UNUSED,
41 WINDOW_DATA = OBJECT_DATA,
42 WINDOW_ENTRY = OBJECT_ENTRY,
43 WINDOW_DATA_HASH_TABLE = OBJECT_DATA_HASH_TABLE,
44 WINDOW_FIELD_HASH_TABLE = OBJECT_FIELD_HASH_TABLE,
45 WINDOW_ENTRY_ARRAY = OBJECT_ENTRY_ARRAY,
46 WINDOW_SIGNATURE = OBJECT_SIGNATURE,
51 typedef struct JournalMetrics {
58 typedef struct JournalFile {
61 struct stat last_stat;
66 bool tail_entry_monotonic_valid;
69 HashItem *data_hash_table;
70 HashItem *field_hash_table;
72 Window windows[_WINDOW_MAX];
74 uint64_t current_offset;
76 JournalMetrics metrics;
81 void *compress_buffer;
82 uint64_t compress_buffer_size;
86 typedef enum direction {
91 int journal_file_open(
95 JournalMetrics *metrics,
96 JournalFile *template,
99 void journal_file_close(JournalFile *j);
101 int journal_file_open_reliably(
105 JournalMetrics *metrics,
106 JournalFile *template,
109 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
111 uint64_t journal_file_entry_n_items(Object *o);
113 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);
115 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
116 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
118 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
119 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
121 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);
123 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
124 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
125 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
126 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);
128 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);
129 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);
130 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);
131 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);
133 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
135 void journal_file_dump(JournalFile *f);
136 void journal_file_print_header(JournalFile *f);
138 int journal_file_rotate(JournalFile **f);
140 int journal_directory_vacuum(const char *directory, uint64_t max_use, uint64_t min_free);
142 void journal_file_post_change(JournalFile *f);
144 void journal_default_metrics(JournalMetrics *m, int fd);
146 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
147 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
149 bool journal_file_rotate_suggested(JournalFile *f);