src/journal/journald-server.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 #include <stdbool.h>
  26 #include <sys/epoll.h>
  27 #include <sys/types.h>
  28 #include <sys/socket.h>
  29
  30 #include "journal-file.h"
  31 #include "hashmap.h"
  32 #include "util.h"
  33 #include "audit.h"
  34 #include "journald-rate-limit.h"
  35 #include "list.h"
  36
  37 typedef enum Storage {
  38         STORAGE_AUTO,
  39         STORAGE_VOLATILE,
  40         STORAGE_PERSISTENT,
  41         STORAGE_NONE,
  42         _STORAGE_MAX,
  43         _STORAGE_INVALID = -1
  44 } Storage;
  45
  46 typedef enum SplitMode {
  47         SPLIT_LOGIN,
  48         SPLIT_UID,
  49         SPLIT_NONE,
  50         _SPLIT_MAX,
  51         _SPLIT_INVALID = -1
  52 } SplitMode;
  53
  54 typedef struct StdoutStream StdoutStream;
  55
  56 typedef struct Server {
  57         int epoll_fd;
  58         int signal_fd;
  59         int syslog_fd;
  60         int native_fd;
  61         int stdout_fd;
  62         int dev_kmsg_fd;
  63
  64         JournalFile *runtime_journal;
  65         JournalFile *system_journal;
  66         Hashmap *user_journals;
  67
  68         uint64_t seqnum;
  69
  70         char *buffer;
  71         size_t buffer_size;
  72
  73         JournalRateLimit *rate_limit;
  74         usec_t sync_interval_usec;
  75         usec_t rate_limit_interval;
  76         unsigned rate_limit_burst;
  77
  78         JournalMetrics runtime_metrics;
  79         JournalMetrics system_metrics;
  80
  81         bool compress;
  82         bool seal;
  83
  84         bool forward_to_kmsg;
  85         bool forward_to_syslog;
  86         bool forward_to_console;
  87
  88         unsigned n_forward_syslog_missed;
  89         usec_t last_warn_forward_syslog_missed;
  90
  91         uint64_t cached_available_space;
  92         usec_t cached_available_space_timestamp;
  93
  94         uint64_t var_available_timestamp;
  95
  96         usec_t max_retention_usec;
  97         usec_t max_file_usec;
  98         usec_t oldest_file_usec;
  99
 100         gid_t file_gid;
 101         bool file_gid_valid;
 102
 103         LIST_HEAD(StdoutStream, stdout_streams);
 104         unsigned n_stdout_streams;
 105
 106         char *tty_path;
 107
 108         int max_level_store;
 109         int max_level_syslog;
 110         int max_level_kmsg;
 111         int max_level_console;
 112
 113         Storage storage;
 114         SplitMode split_mode;
 115
 116         MMapCache *mmap;
 117
 118         bool dev_kmsg_readable;
 119
 120         uint64_t *kernel_seqnum;
 121
 122         struct udev *udev;
 123
 124         int sync_timer_fd;
 125         bool sync_scheduled;
 126 } Server;
 127
 128 #define N_IOVEC_META_FIELDS 17
 129 #define N_IOVEC_KERNEL_FIELDS 64
 130 #define N_IOVEC_UDEV_FIELDS 32
 131
 132 void server_dispatch_message(Server *s, struct iovec *iovec, unsigned n, unsigned m, struct ucred *ucred, struct timeval *tv, const char *label, size_t label_len, const char *unit_id, int priority);
 133 void server_driver_message(Server *s, sd_id128_t message_id, const char *format, ...);
 134
 135 /* gperf lookup function */
 136 const struct ConfigPerfItem* journald_gperf_lookup(const char *key, unsigned length);
 137
 138 int config_parse_storage(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 139
 140 const char *storage_to_string(Storage s);
 141 Storage storage_from_string(const char *s);
 142
 143 int config_parse_split_mode(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 144
 145 const char *split_mode_to_string(SplitMode s);
 146 SplitMode split_mode_from_string(const char *s);
 147
 148 void server_fix_perms(Server *s, JournalFile *f, uid_t uid);
 149 bool shall_try_append_again(JournalFile *f, int r);
 150 int server_init(Server *s);
 151 void server_done(Server *s);
 152 void server_sync(Server *s);
 153 void server_vacuum(Server *s);
 154 void server_rotate(Server *s);
 155 int server_schedule_sync(Server *s);
 156 int server_flush_to_var(Server *s);
 157 int process_event(Server *s, struct epoll_event *ev);
 158 void server_maybe_append_tags(Server *s);