chiark / gitweb /
Merge branch 'master' into journal
[elogind.git] / src / journal / journal-file.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #ifndef foojournalfilehfoo
4 #define foojournalfilehfoo
5
6 /***
7   This file is part of systemd.
8
9   Copyright 2011 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU General Public License as published by
13   the Free Software Foundation; either version 2 of the License, or
14   (at your option) any later version.
15
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   General Public License for more details.
20
21   You should have received a copy of the GNU General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 ***/
24
25 #include <inttypes.h>
26
27 #include "journal-def.h"
28 #include "util.h"
29 #include "sd-id128.h"
30
31 typedef struct Window {
32         void *ptr;
33         uint64_t offset;
34         uint64_t size;
35 } Window;
36
37 enum {
38         WINDOW_UNKNOWN = OBJECT_UNUSED,
39         WINDOW_DATA = OBJECT_DATA,
40         WINDOW_ENTRY = OBJECT_ENTRY,
41         WINDOW_DATA_HASH_TABLE = OBJECT_DATA_HASH_TABLE,
42         WINDOW_FIELD_HASH_TABLE = OBJECT_FIELD_HASH_TABLE,
43         WINDOW_ENTRY_ARRAY = OBJECT_ENTRY_ARRAY,
44         WINDOW_HEADER,
45         _WINDOW_MAX
46 };
47
48 typedef struct JournalFile {
49         int fd;
50         char *path;
51         struct stat last_stat;
52         mode_t mode;
53         int flags;
54         int prot;
55         bool writable;
56         bool tail_entry_monotonic_valid;
57
58         Header *header;
59         HashItem *data_hash_table;
60         HashItem *field_hash_table;
61
62         Window windows[_WINDOW_MAX];
63
64         uint64_t current_offset;
65 } JournalFile;
66
67 typedef enum direction {
68         DIRECTION_UP,
69         DIRECTION_DOWN
70 } direction_t;
71
72 int journal_file_open(const char *fname, int flags, mode_t mode, JournalFile *template, JournalFile **ret);
73 void journal_file_close(JournalFile *j);
74
75 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
76
77 uint64_t journal_file_entry_n_items(Object *o);
78
79 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);
80
81 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
82 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
83
84 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
85 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
86
87 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);
88
89 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
90 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
91 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);
92
93 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);
94 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);
95
96 void journal_file_dump(JournalFile *f);
97
98 int journal_file_rotate(JournalFile **f);
99
100 int journal_directory_vacuum(const char *directory, uint64_t max_use, uint64_t min_free);
101
102 #endif