src/journal/journal-file.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2011 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <inttypes.h>
  24
  25 #if HAVE_GCRYPT
  26 #include <gcrypt.h>
  27 #endif
  28
  29 #include "sd-id128.h"
  30
  31 #include "hashmap.h"
  32 #include "journal-def.h"
  33 #include "macro.h"
  34 #include "mmap-cache.h"
  35 #include "sd-event.h"
  36 #include "sparse-endian.h"
  37
  38 typedef struct JournalMetrics {
  39         /* For all these: -1 means "pick automatically", and 0 means "no limit enforced" */
  40         uint64_t max_size;     /* how large journal files grow at max */
  41         uint64_t min_size;     /* how large journal files grow at least */
  42         uint64_t max_use;      /* how much disk space to use in total at max, keep_free permitting */
  43         uint64_t min_use;      /* how much disk space to use in total at least, even if keep_free says not to */
  44         uint64_t keep_free;    /* how much to keep free on disk */
  45         uint64_t n_max_files;  /* how many files to keep around at max */
  46 } JournalMetrics;
  47
  48 typedef enum direction {
  49         DIRECTION_UP,
  50         DIRECTION_DOWN
  51 } direction_t;
  52
  53 typedef enum LocationType {
  54         /* The first and last entries, resp. */
  55         LOCATION_HEAD,
  56         LOCATION_TAIL,
  57
  58         /* We already read the entry we currently point to, and the
  59          * next one to read should probably not be this one again. */
  60         LOCATION_DISCRETE,
  61
  62         /* We should seek to the precise location specified, and
  63          * return it, as we haven't read it yet. */
  64         LOCATION_SEEK
  65 } LocationType;
  66
  67 typedef enum OfflineState {
  68         OFFLINE_JOINED,
  69         OFFLINE_SYNCING,
  70         OFFLINE_OFFLINING,
  71         OFFLINE_CANCEL,
  72         OFFLINE_AGAIN_FROM_SYNCING,
  73         OFFLINE_AGAIN_FROM_OFFLINING,
  74         OFFLINE_DONE
  75 } OfflineState;
  76
  77 typedef struct JournalFile {
  78         int fd;
  79         MMapFileDescriptor *cache_fd;
  80
  81         mode_t mode;
  82
  83         int flags;
  84         int prot;
  85         bool writable:1;
  86         bool compress_xz:1;
  87         bool compress_lz4:1;
  88         bool seal:1;
  89         bool defrag_on_close:1;
  90         bool close_fd:1;
  91         bool archive:1;
  92
  93         direction_t last_direction;
  94         LocationType location_type;
  95         uint64_t last_n_entries;
  96
  97         char *path;
  98         struct stat last_stat;
  99         usec_t last_stat_usec;
 100
 101         Header *header;
 102         HashItem *data_hash_table;
 103         HashItem *field_hash_table;
 104
 105         uint64_t current_offset;
 106         uint64_t current_seqnum;
 107         uint64_t current_realtime;
 108         uint64_t current_monotonic;
 109         sd_id128_t current_boot_id;
 110         uint64_t current_xor_hash;
 111
 112         JournalMetrics metrics;
 113         MMapCache *mmap;
 114
 115         sd_event_source *post_change_timer;
 116         usec_t post_change_timer_period;
 117
 118         OrderedHashmap *chain_cache;
 119
 120         pthread_t offline_thread;
 121         volatile OfflineState offline_state;
 122
 123         unsigned last_seen_generation;
 124
 125         uint64_t compress_threshold_bytes;
 126 #if HAVE_XZ || HAVE_LZ4
 127         void *compress_buffer;
 128         size_t compress_buffer_size;
 129 #endif
 130
 131 #if HAVE_GCRYPT
 132         gcry_md_hd_t hmac;
 133         bool hmac_running;
 134
 135         FSSHeader *fss_file;
 136         size_t fss_file_size;
 137
 138         uint64_t fss_start_usec;
 139         uint64_t fss_interval_usec;
 140
 141         void *fsprg_state;
 142         size_t fsprg_state_size;
 143
 144         void *fsprg_seed;
 145         size_t fsprg_seed_size;
 146 #endif
 147 } JournalFile;
 148
 149 int journal_file_open(
 150                 int fd,
 151                 const char *fname,
 152                 int flags,
 153                 mode_t mode,
 154                 bool compress,
 155                 uint64_t compress_threshold_bytes,
 156                 bool seal,
 157                 JournalMetrics *metrics,
 158                 MMapCache *mmap_cache,
 159                 Set *deferred_closes,
 160                 JournalFile *template,
 161                 JournalFile **ret);
 162
 163 int journal_file_set_offline(JournalFile *f, bool wait);
 164 bool journal_file_is_offlining(JournalFile *f);
 165 JournalFile* journal_file_close(JournalFile *j);
 166
 167 int journal_file_open_reliably(
 168                 const char *fname,
 169                 int flags,
 170                 mode_t mode,
 171                 bool compress,
 172                 uint64_t compress_threshold_bytes,
 173                 bool seal,
 174                 JournalMetrics *metrics,
 175                 MMapCache *mmap_cache,
 176                 Set *deferred_closes,
 177                 JournalFile *template,
 178                 JournalFile **ret);
 179
 180 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
 181 #define VALID64(x) (((x) & 7ULL) == 0ULL)
 182
 183 /* Use six characters to cover the offsets common in smallish journal
 184  * files without adding too many zeros. */
 185 #define OFSfmt "%06"PRIx64
 186
 187 static inline bool VALID_REALTIME(uint64_t u) {
 188         /* This considers timestamps until the year 3112 valid. That should be plenty room... */
 189         return u > 0 && u < (1ULL << 55);
 190 }
 191
 192 static inline bool VALID_MONOTONIC(uint64_t u) {
 193         /* This considers timestamps until 1142 years of runtime valid. */
 194         return u < (1ULL << 55);
 195 }
 196
 197 static inline bool VALID_EPOCH(uint64_t u) {
 198         /* This allows changing the key for 1142 years, every usec. */
 199         return u < (1ULL << 55);
 200 }
 201
 202 #define JOURNAL_HEADER_CONTAINS(h, field) \
 203         (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
 204
 205 #define JOURNAL_HEADER_SEALED(h) \
 206         (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
 207
 208 #define JOURNAL_HEADER_COMPRESSED_XZ(h) \
 209         (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED_XZ))
 210
 211 #define JOURNAL_HEADER_COMPRESSED_LZ4(h) \
 212         (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED_LZ4))
 213
 214 int journal_file_move_to_object(JournalFile *f, ObjectType type, uint64_t offset, Object **ret);
 215
 216 uint64_t journal_file_entry_n_items(Object *o) _pure_;
 217 uint64_t journal_file_entry_array_n_items(Object *o) _pure_;
 218 uint64_t journal_file_hash_table_n_items(Object *o) _pure_;
 219
 220 int journal_file_append_object(JournalFile *f, ObjectType type, uint64_t size, Object **ret, uint64_t *offset);
 221 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);
 222
 223 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
 224 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 225
 226 int journal_file_find_field_object(JournalFile *f, const void *field, uint64_t size, Object **ret, uint64_t *offset);
 227 int journal_file_find_field_object_with_hash(JournalFile *f, const void *field, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 228
 229 void journal_file_reset_location(JournalFile *f);
 230 void journal_file_save_location(JournalFile *f, Object *o, uint64_t offset);
 231 int journal_file_compare_locations(JournalFile *af, JournalFile *bf);
 232 int journal_file_next_entry(JournalFile *f, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
 233
 234 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);
 235
 236 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 237 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
 238 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);
 239
 240 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);
 241 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);
 242 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);
 243 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);
 244
 245 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 246
 247 void journal_file_dump(JournalFile *f);
 248 void journal_file_print_header(JournalFile *f);
 249
 250 int journal_file_rotate(JournalFile **f, bool compress, uint64_t compress_threshold_bytes, bool seal, Set *deferred_closes);
 251
 252 void journal_file_post_change(JournalFile *f);
 253 int journal_file_enable_post_change_timer(JournalFile *f, sd_event *e, usec_t t);
 254
 255 void journal_reset_metrics(JournalMetrics *m);
 256 void journal_default_metrics(JournalMetrics *m, int fd);
 257
 258 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
 259 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
 260
 261 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec);
 262
 263 int journal_file_map_data_hash_table(JournalFile *f);
 264 int journal_file_map_field_hash_table(JournalFile *f);
 265
 266 static inline bool JOURNAL_FILE_COMPRESS(JournalFile *f) {
 267         assert(f);
 268         return f->compress_xz || f->compress_lz4;
 269 }