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 "journal-def.h"
  28 #include "util.h"
  29 #include "sd-id128.h"
  30
  31 #define DEFAULT_MAX_SIZE (1024ULL*128ULL)
  32 #define DEFAULT_MIN_SIZE (256ULL*1024ULL)
  33 #define DEFAULT_KEEP_FREE (1ULL*1024ULL*1024ULL)
  34 #define DEFAULT_MAX_USE (16ULL*1024ULL*1024ULL*16ULL)
  35
  36 typedef struct Window {
  37         void *ptr;
  38         uint64_t offset;
  39         uint64_t size;
  40 } Window;
  41
  42 enum {
  43         WINDOW_UNKNOWN = OBJECT_UNUSED,
  44         WINDOW_DATA = OBJECT_DATA,
  45         WINDOW_ENTRY = OBJECT_ENTRY,
  46         WINDOW_DATA_HASH_TABLE = OBJECT_DATA_HASH_TABLE,
  47         WINDOW_FIELD_HASH_TABLE = OBJECT_FIELD_HASH_TABLE,
  48         WINDOW_ENTRY_ARRAY = OBJECT_ENTRY_ARRAY,
  49         WINDOW_HEADER,
  50         _WINDOW_MAX
  51 };
  52
  53 typedef struct JournalMetrics {
  54         uint64_t max_size;
  55         uint64_t min_size;
  56         uint64_t keep_free;
  57 } JournalMetrics;
  58
  59 typedef struct JournalFile {
  60         int fd;
  61         char *path;
  62         struct stat last_stat;
  63         mode_t mode;
  64         int flags;
  65         int prot;
  66         bool writable;
  67         bool tail_entry_monotonic_valid;
  68
  69         Header *header;
  70         HashItem *data_hash_table;
  71         HashItem *field_hash_table;
  72
  73         Window windows[_WINDOW_MAX];
  74
  75         uint64_t current_offset;
  76
  77         JournalMetrics metrics;
  78
  79         bool compress;
  80
  81 #ifdef HAVE_XZ
  82         void *compress_buffer;
  83         size_t compress_buffer_size;
  84 #endif
  85 } JournalFile;
  86
  87 typedef enum direction {
  88         DIRECTION_UP,
  89         DIRECTION_DOWN
  90 } direction_t;
  91
  92 int journal_file_open(const char *fname, int flags, mode_t mode, JournalFile *template, JournalFile **ret);
  93 void journal_file_close(JournalFile *j);
  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 #endif