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 use;
  41         uint64_t max_size;
  42         uint64_t min_size;
  43         uint64_t keep_free;
  44 } JournalMetrics;
  45
  46 typedef enum direction {
  47         DIRECTION_UP,
  48         DIRECTION_DOWN
  49 } direction_t;
  50
  51 typedef enum LocationType {
  52         /* The first and last entries, resp. */
  53         LOCATION_HEAD,
  54         LOCATION_TAIL,
  55
  56         /* We already read the entry we currently point to, and the
  57          * next one to read should probably not be this one again. */
  58         LOCATION_DISCRETE,
  59
  60         /* We should seek to the precise location specified, and
  61          * return it, as we haven't read it yet. */
  62         LOCATION_SEEK
  63 } LocationType;
  64
  65 typedef struct JournalFile {
  66         int fd;
  67
  68         mode_t mode;
  69
  70         int flags;
  71         int prot;
  72         bool writable:1;
  73         bool compress_xz:1;
  74         bool compress_lz4:1;
  75         bool seal:1;
  76
  77         bool tail_entry_monotonic_valid:1;
  78
  79         direction_t last_direction;
  80
  81         char *path;
  82         struct stat last_stat;
  83
  84         Header *header;
  85         HashItem *data_hash_table;
  86         HashItem *field_hash_table;
  87
  88         uint64_t current_offset;
  89
  90         JournalMetrics metrics;
  91         MMapCache *mmap;
  92
  93         OrderedHashmap *chain_cache;
  94
  95 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
  96         void *compress_buffer;
  97         size_t compress_buffer_size;
  98 #endif
  99
 100 #ifdef HAVE_GCRYPT
 101         gcry_md_hd_t hmac;
 102         bool hmac_running;
 103
 104         FSSHeader *fss_file;
 105         size_t fss_file_size;
 106
 107         uint64_t fss_start_usec;
 108         uint64_t fss_interval_usec;
 109
 110         void *fsprg_state;
 111         size_t fsprg_state_size;
 112
 113         void *fsprg_seed;
 114         size_t fsprg_seed_size;
 115 #endif
 116 } JournalFile;
 117
 118 int journal_file_open(
 119                 const char *fname,
 120                 int flags,
 121                 mode_t mode,
 122                 bool compress,
 123                 bool seal,
 124                 JournalMetrics *metrics,
 125                 MMapCache *mmap_cache,
 126                 JournalFile *template,
 127                 JournalFile **ret);
 128
 129 int journal_file_set_offline(JournalFile *f);
 130 void journal_file_close(JournalFile *j);
 131
 132 int journal_file_open_reliably(
 133                 const char *fname,
 134                 int flags,
 135                 mode_t mode,
 136                 bool compress,
 137                 bool seal,
 138                 JournalMetrics *metrics,
 139                 MMapCache *mmap_cache,
 140                 JournalFile *template,
 141                 JournalFile **ret);
 142
 143 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
 144 #define VALID64(x) (((x) & 7ULL) == 0ULL)
 145
 146 /* Use six characters to cover the offsets common in smallish journal
 147  * files without adding too many zeros. */
 148 #define OFSfmt "%06"PRIx64
 149
 150 static inline bool VALID_REALTIME(uint64_t u) {
 151         /* This considers timestamps until the year 3112 valid. That should be plenty room... */
 152         return u > 0 && u < (1ULL << 55);
 153 }
 154
 155 static inline bool VALID_MONOTONIC(uint64_t u) {
 156         /* This considers timestamps until 1142 years of runtime valid. */
 157         return u < (1ULL << 55);
 158 }
 159
 160 static inline bool VALID_EPOCH(uint64_t u) {
 161         /* This allows changing the key for 1142 years, every usec. */
 162         return u < (1ULL << 55);
 163 }
 164
 165 #define JOURNAL_HEADER_CONTAINS(h, field) \
 166         (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
 167
 168 #define JOURNAL_HEADER_SEALED(h) \
 169         (!!(le32toh((h)->compatible_flags) & HEADER_COMPATIBLE_SEALED))
 170
 171 #define JOURNAL_HEADER_COMPRESSED_XZ(h) \
 172         (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED_XZ))
 173
 174 #define JOURNAL_HEADER_COMPRESSED_LZ4(h) \
 175         (!!(le32toh((h)->incompatible_flags) & HEADER_INCOMPATIBLE_COMPRESSED_LZ4))
 176
 177 int journal_file_move_to_object(JournalFile *f, ObjectType type, uint64_t offset, Object **ret);
 178
 179 uint64_t journal_file_entry_n_items(Object *o) _pure_;
 180 uint64_t journal_file_entry_array_n_items(Object *o) _pure_;
 181 uint64_t journal_file_hash_table_n_items(Object *o) _pure_;
 182
 183 int journal_file_append_object(JournalFile *f, ObjectType type, uint64_t size, Object **ret, uint64_t *offset);
 184 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);
 185
 186 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
 187 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 188
 189 int journal_file_find_field_object(JournalFile *f, const void *field, uint64_t size, Object **ret, uint64_t *offset);
 190 int journal_file_find_field_object_with_hash(JournalFile *f, const void *field, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 191
 192 void journal_file_reset_location(JournalFile *f);
 193 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
 194
 195 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);
 196
 197 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 198 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
 199 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);
 200
 201 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);
 202 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);
 203 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);
 204 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);
 205
 206 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 207
 208 void journal_file_dump(JournalFile *f);
 209 void journal_file_print_header(JournalFile *f);
 210
 211 int journal_file_rotate(JournalFile **f, bool compress, bool seal);
 212
 213 void journal_file_post_change(JournalFile *f);
 214
 215 void journal_default_metrics(JournalMetrics *m, int fd);
 216
 217 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
 218 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
 219
 220 bool journal_file_rotate_suggested(JournalFile *f, usec_t max_file_usec);