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 #include "mmap-cache.h"
  36 #include "hashmap.h"
  37
  38 typedef struct JournalMetrics {
  39         uint64_t max_use;
  40         uint64_t max_size;
  41         uint64_t min_size;
  42         uint64_t keep_free;
  43 } JournalMetrics;
  44
  45 typedef struct JournalFile {
  46         int fd;
  47         char *path;
  48         struct stat last_stat;
  49         mode_t mode;
  50
  51         int flags;
  52         int prot;
  53         bool writable;
  54         bool compress;
  55         bool seal;
  56
  57         bool tail_entry_monotonic_valid;
  58
  59         Header *header;
  60         HashItem *data_hash_table;
  61         HashItem *field_hash_table;
  62
  63         uint64_t current_offset;
  64
  65         JournalMetrics metrics;
  66         MMapCache *mmap;
  67
  68         Hashmap *chain_cache;
  69
  70 #ifdef HAVE_XZ
  71         void *compress_buffer;
  72         uint64_t compress_buffer_size;
  73 #endif
  74
  75 #ifdef HAVE_GCRYPT
  76         gcry_md_hd_t hmac;
  77         bool hmac_running;
  78
  79         FSSHeader *fss_file;
  80         size_t fss_file_size;
  81
  82         uint64_t fss_start_usec;
  83         uint64_t fss_interval_usec;
  84
  85         void *fsprg_state;
  86         size_t fsprg_state_size;
  87
  88         void *fsprg_seed;
  89         size_t fsprg_seed_size;
  90 #endif
  91 } JournalFile;
  92
  93 typedef enum direction {
  94         DIRECTION_UP,
  95         DIRECTION_DOWN
  96 } direction_t;
  97
  98 int journal_file_open(
  99                 const char *fname,
 100                 int flags,
 101                 mode_t mode,
 102                 bool compress,
 103                 bool seal,
 104                 JournalMetrics *metrics,
 105                 MMapCache *mmap_cache,
 106                 JournalFile *template,
 107                 JournalFile **ret);
 108
 109 int journal_file_set_offline(JournalFile *f);
 110 int journal_file_set_online(JournalFile *f);
 111 void journal_file_close(JournalFile *j);
 112
 113 int journal_file_open_reliably(
 114                 const char *fname,
 115                 int flags,
 116                 mode_t mode,
 117                 bool compress,
 118                 bool seal,
 119                 JournalMetrics *metrics,
 120                 MMapCache *mmap_cache,
 121                 JournalFile *template,
 122                 JournalFile **ret);
 123
 124 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
 125 #define VALID64(x) (((x) & 7ULL) == 0ULL)
 126
 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);
 130 }
 131
 132 static inline bool VALID_MONOTONIC(uint64_t u) {
 133         /* This considers timestamps until 1142 years of runtime valid. */
 134         return u < (1ULL << 55);
 135 }
 136
 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);
 140 }
 141
 142 #define JOURNAL_HEADER_CONTAINS(h, field) \
 143         (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
 144
 145 #define JOURNAL_HEADER_SEALED(h) \
 146         (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
 147
 148 #define JOURNAL_HEADER_COMPRESSED(h) \
 149         (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED))
 150
 151 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
 152
 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);
 156
 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);
 159
 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);
 162
 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);
 165
 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);
 168
 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);
 170
 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);
 175
 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);
 180
 181 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 182
 183 void journal_file_dump(JournalFile *f);
 184 void journal_file_print_header(JournalFile *f);
 185
 186 int journal_file_rotate(JournalFile **f, bool compress, bool seal);
 187
 188 void journal_file_post_change(JournalFile *f);
 189
 190 void journal_default_metrics(JournalMetrics *m, int fd);
 191
 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);
 194
 195 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec);