src/journal/journal-file.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2011 Lennart Poettering
   9
  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.
  14
  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.
  19
  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/>.
  22 ***/
  23
  24 #include <inttypes.h>
  25
  26 #ifdef HAVE_GCRYPT
  27 #include <gcrypt.h>
  28 #endif
  29
  30 #include <systemd/sd-id128.h>
  31
  32 #include "sparse-endian.h"
  33 #include "journal-def.h"
  34 #include "util.h"
  35
  36 typedef struct Window {
  37         void *ptr;
  38         uint64_t offset;
  39         uint64_t size;
  40 } Window;
  41
  42 enum {
  43         WINDOW_UNKNOWN = OBJECT_UNUSED,
  44         WINDOW_DATA = OBJECT_DATA,
  45         WINDOW_ENTRY = OBJECT_ENTRY,
  46         WINDOW_DATA_HASH_TABLE = OBJECT_DATA_HASH_TABLE,
  47         WINDOW_FIELD_HASH_TABLE = OBJECT_FIELD_HASH_TABLE,
  48         WINDOW_ENTRY_ARRAY = OBJECT_ENTRY_ARRAY,
  49         WINDOW_TAG = OBJECT_TAG,
  50         WINDOW_HEADER,
  51         _WINDOW_MAX
  52 };
  53
  54 typedef struct JournalMetrics {
  55         uint64_t max_use;
  56         uint64_t max_size;
  57         uint64_t min_size;
  58         uint64_t keep_free;
  59 } JournalMetrics;
  60
  61 typedef struct JournalFile {
  62         int fd;
  63         char *path;
  64         struct stat last_stat;
  65         mode_t mode;
  66
  67         int flags;
  68         int prot;
  69         bool writable;
  70         bool compress;
  71         bool authenticate;
  72
  73         bool tail_entry_monotonic_valid;
  74
  75         Header *header;
  76         HashItem *data_hash_table;
  77         HashItem *field_hash_table;
  78
  79         Window windows[_WINDOW_MAX];
  80
  81         uint64_t current_offset;
  82
  83         JournalMetrics metrics;
  84
  85 #ifdef HAVE_XZ
  86         void *compress_buffer;
  87         uint64_t compress_buffer_size;
  88 #endif
  89
  90 #ifdef HAVE_GCRYPT
  91         gcry_md_hd_t hmac;
  92         bool hmac_running;
  93
  94         FSPRGHeader *fsprg_header;
  95         size_t fsprg_size;
  96 #endif
  97 } JournalFile;
  98
  99 typedef enum direction {
 100         DIRECTION_UP,
 101         DIRECTION_DOWN
 102 } direction_t;
 103
 104 int journal_file_open(
 105                 const char *fname,
 106                 int flags,
 107                 mode_t mode,
 108                 bool compress,
 109                 bool authenticate,
 110                 JournalMetrics *metrics,
 111                 JournalFile *template,
 112                 JournalFile **ret);
 113
 114 void journal_file_close(JournalFile *j);
 115
 116 int journal_file_open_reliably(
 117                 const char *fname,
 118                 int flags,
 119                 mode_t mode,
 120                 bool compress,
 121                 bool authenticate,
 122                 JournalMetrics *metrics,
 123                 JournalFile *template,
 124                 JournalFile **ret);
 125
 126 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
 127
 128 uint64_t journal_file_entry_n_items(Object *o);
 129
 130 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);
 131
 132 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
 133 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 134
 135 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
 136 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
 137
 138 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);
 139
 140 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 141 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 142 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
 143 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);
 144
 145 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);
 146 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);
 147 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);
 148 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);
 149
 150 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 151
 152 void journal_file_dump(JournalFile *f);
 153 void journal_file_print_header(JournalFile *f);
 154
 155 int journal_file_rotate(JournalFile **f, bool compress, bool authenticate);
 156
 157 int journal_directory_vacuum(const char *directory, uint64_t max_use, uint64_t min_free);
 158
 159 void journal_file_post_change(JournalFile *f);
 160
 161 void journal_default_metrics(JournalMetrics *m, int fd);
 162
 163 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
 164 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
 165
 166 bool journal_file_rotate_suggested(JournalFile *f);
 167
 168 int journal_file_append_tag(JournalFile *f);