src/journal/journal-file.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foojournalfilehfoo
   4 #define foojournalfilehfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2011 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <inttypes.h>
  26
  27 #include <systemd/sd-id128.h>
  28
  29 #include "sparse-endian.h"
  30 #include "journal-def.h"
  31 #include "util.h"
  32
  33 typedef struct Window {
  34         void *ptr;
  35         uint64_t offset;
  36         uint64_t size;
  37 } Window;
  38
  39 enum {
  40         WINDOW_UNKNOWN = OBJECT_UNUSED,
  41         WINDOW_DATA = OBJECT_DATA,
  42         WINDOW_ENTRY = OBJECT_ENTRY,
  43         WINDOW_DATA_HASH_TABLE = OBJECT_DATA_HASH_TABLE,
  44         WINDOW_FIELD_HASH_TABLE = OBJECT_FIELD_HASH_TABLE,
  45         WINDOW_ENTRY_ARRAY = OBJECT_ENTRY_ARRAY,
  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(const char *fname, int flags, mode_t mode, JournalFile *template, JournalFile **ret);
  91 void journal_file_close(JournalFile *j);
  92
  93 int journal_file_open_reliably(const char *fname, int flags, mode_t mode, JournalFile *template, JournalFile **ret);
  94
  95 int journal_file_move_to_object(JournalFile *f, int type, uint64_t offset, Object **ret);
  96
  97 uint64_t journal_file_entry_n_items(Object *o);
  98
  99 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);
 100
 101 int journal_file_find_data_object(JournalFile *f, const void *data, uint64_t size, Object **ret, uint64_t *offset);
 102 int journal_file_find_data_object_with_hash(JournalFile *f, const void *data, uint64_t size, uint64_t hash, Object **ret, uint64_t *offset);
 103
 104 int journal_file_next_entry(JournalFile *f, Object *o, uint64_t p, direction_t direction, Object **ret, uint64_t *offset);
 105 int journal_file_skip_entry(JournalFile *f, Object *o, uint64_t p, int64_t skip, Object **ret, uint64_t *offset);
 106
 107 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);
 108
 109 int journal_file_move_to_entry_by_seqnum(JournalFile *f, uint64_t seqnum, direction_t direction, Object **ret, uint64_t *offset);
 110 int journal_file_move_to_entry_by_realtime(JournalFile *f, uint64_t realtime, direction_t direction, Object **ret, uint64_t *offset);
 111 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);
 112
 113 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);
 114 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);
 115
 116 int journal_file_copy_entry(JournalFile *from, JournalFile *to, Object *o, uint64_t p, uint64_t *seqnum, Object **ret, uint64_t *offset);
 117
 118 void journal_file_dump(JournalFile *f);
 119
 120 int journal_file_rotate(JournalFile **f);
 121
 122 int journal_directory_vacuum(const char *directory, uint64_t max_use, uint64_t min_free);
 123
 124 void journal_file_post_change(JournalFile *f);
 125
 126 void journal_default_metrics(JournalMetrics *m, int fd);
 127
 128 #endif