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
  37 typedef struct JournalMetrics {
  38         uint64_t max_use;
  39         uint64_t max_size;
  40         uint64_t min_size;
  41         uint64_t keep_free;
  42 } JournalMetrics;
  43
  44 typedef struct JournalFile {
  45         int fd;
  46         char *path;
  47         struct stat last_stat;
  48         mode_t mode;
  49
  50         int flags;
  51         int prot;
  52         bool writable;
  53         bool compress;
  54         bool authenticate;
  55
  56         bool tail_entry_monotonic_valid;
  57
  58         Header *header;
  59         HashItem *data_hash_table;
  60         HashItem *field_hash_table;
  61
  62         uint64_t current_offset;
  63
  64         JournalMetrics metrics;
  65         MMapCache *mmap;
  66
  67 #ifdef HAVE_XZ
  68         void *compress_buffer;
  69         uint64_t compress_buffer_size;
  70 #endif
  71
  72 #ifdef HAVE_GCRYPT
  73         gcry_md_hd_t hmac;
  74         bool hmac_running;
  75
  76         FSPRGHeader *fsprg_header;
  77         size_t fsprg_size;
  78 #endif
  79 } JournalFile;
  80
  81 typedef enum direction {
  82         DIRECTION_UP,
  83         DIRECTION_DOWN
  84 } direction_t;
  85
  86 int journal_file_open(
  87                 const char *fname,
  88                 int flags,
  89                 mode_t mode,
  90                 bool compress,
  91                 bool authenticate,
  92                 JournalMetrics *metrics,
  93                 MMapCache *mmap_cache,
  94                 JournalFile *template,
  95                 JournalFile **ret);
  96
  97 void journal_file_close(JournalFile *j);
  98
  99 int journal_file_open_reliably(
 100                 const char *fname,
 101                 int flags,
 102                 mode_t mode,
 103                 bool compress,
 104                 bool authenticate,
 105                 JournalMetrics *metrics,
 106                 MMapCache *mmap_cache,
 107                 JournalFile *template,
 108                 JournalFile **ret);
 109
 110 #define ALIGN64(x) (((x) + 7ULL) & ~7ULL)
 111
 112 #define JOURNAL_HEADER_CONTAINS(h, field) \
 113         (le64toh((h)->header_size) >= offsetof(Header, field) + sizeof((h)->field))
 114
 115 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
 116
 117 uint64_t journal_file_entry_n_items(Object *o);
 118 uint64_t journal_file_entry_array_n_items(Object *o);
 119
 120 int journal_file_append_object(JournalFile *f, int type, uint64_t size, Object **ret, uint64_t *offset);
 121 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);
 122
 123 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
 124 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 125
 126 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
 127 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
 128
 129 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);
 130
 131 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 132 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 133 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
 134 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);
 135
 136 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);
 137 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);
 138 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);
 139 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);
 140
 141 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 142
 143 void journal_file_dump(JournalFile *f);
 144 void journal_file_print_header(JournalFile *f);
 145
 146 int journal_file_rotate(JournalFile **f, bool compress, bool authenticate);
 147
 148 void journal_file_post_change(JournalFile *f);
 149
 150 void journal_default_metrics(JournalMetrics *m, int fd);
 151
 152 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
 153 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
 154
 155 bool journal_file_rotate_suggested(JournalFile *f);