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 #include <systemd/sd-id128.h>
  27
  28 #include "sparse-endian.h"
  29 #include "journal-def.h"
  30 #include "util.h"
  31
  32 typedef struct Window {
  33         void *ptr;
  34         uint64_t offset;
  35         uint64_t size;
  36 } Window;
  37
  38 enum {
  39         WINDOW_UNKNOWN = OBJECT_UNUSED,
  40         WINDOW_DATA = OBJECT_DATA,
  41         WINDOW_ENTRY = OBJECT_ENTRY,
  42         WINDOW_DATA_HASH_TABLE = OBJECT_DATA_HASH_TABLE,
  43         WINDOW_FIELD_HASH_TABLE = OBJECT_FIELD_HASH_TABLE,
  44         WINDOW_ENTRY_ARRAY = OBJECT_ENTRY_ARRAY,
  45         WINDOW_SIGNATURE = OBJECT_SIGNATURE,
  46         WINDOW_HEADER,
  47         _WINDOW_MAX
  48 };
  49
  50 typedef struct JournalMetrics {
  51         uint64_t max_use;
  52         uint64_t max_size;
  53         uint64_t min_size;
  54         uint64_t keep_free;
  55 } JournalMetrics;
  56
  57 typedef struct JournalFile {
  58         int fd;
  59         char *path;
  60         struct stat last_stat;
  61         mode_t mode;
  62         int flags;
  63         int prot;
  64         bool writable;
  65         bool tail_entry_monotonic_valid;
  66
  67         Header *header;
  68         HashItem *data_hash_table;
  69         HashItem *field_hash_table;
  70
  71         Window windows[_WINDOW_MAX];
  72
  73         uint64_t current_offset;
  74
  75         JournalMetrics metrics;
  76
  77         bool compress;
  78
  79 #ifdef HAVE_XZ
  80         void *compress_buffer;
  81         uint64_t compress_buffer_size;
  82 #endif
  83 } JournalFile;
  84
  85 typedef enum direction {
  86         DIRECTION_UP,
  87         DIRECTION_DOWN
  88 } direction_t;
  89
  90 int journal_file_open(
  91                 const char *fname,
  92                 int flags,
  93                 mode_t mode,
  94                 JournalMetrics *metrics,
  95                 JournalFile *template,
  96                 JournalFile **ret);
  97
  98 void journal_file_close(JournalFile *j);
  99
 100 int journal_file_open_reliably(
 101                 const char *fname,
 102                 int flags,
 103                 mode_t mode,
 104                 JournalMetrics *metrics,
 105                 JournalFile *template,
 106                 JournalFile **ret);
 107
 108 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
 109
 110 uint64_t journal_file_entry_n_items(Object *o);
 111
 112 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);
 113
 114 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
 115 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 116
 117 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
 118 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
 119
 120 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);
 121
 122 int journal_file_move_to_entry_by_offset(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 123 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 124 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
 125 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);
 126
 127 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);
 128 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);
 129 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);
 130 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);
 131
 132 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 133
 134 void journal_file_dump(JournalFile *f);
 135 void journal_file_print_header(JournalFile *f);
 136
 137 int journal_file_rotate(JournalFile **f);
 138
 139 int journal_directory_vacuum(const char *directory, uint64_t max_use, uint64_t min_free);
 140
 141 void journal_file_post_change(JournalFile *f);
 142
 143 void journal_default_metrics(JournalMetrics *m, int fd);
 144
 145 int journal_file_get_cutoff_realtime_usec(JournalFile *f, usec_t *from, usec_t *to);
 146 int journal_file_get_cutoff_monotonic_usec(JournalFile *f, sd_id128_t boot, usec_t *from, usec_t *to);
 147
 148 bool journal_file_rotate_suggested(JournalFile *f);