src/journal/journald-server.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5 #include <sys/types.h>
   6
   7 #include "sd-event.h"
   8
   9 typedef struct Server Server;
  10
  11 #include "conf-parser.h"
  12 #include "hashmap.h"
  13 #include "journal-file.h"
  14 #include "journald-context.h"
  15 #include "journald-rate-limit.h"
  16 #include "journald-stream.h"
  17 #include "list.h"
  18 #include "prioq.h"
  19
  20 typedef enum Storage {
  21         STORAGE_AUTO,
  22         STORAGE_VOLATILE,
  23         STORAGE_PERSISTENT,
  24         STORAGE_NONE,
  25         _STORAGE_MAX,
  26         _STORAGE_INVALID = -1
  27 } Storage;
  28
  29 typedef enum SplitMode {
  30         SPLIT_UID,
  31         SPLIT_LOGIN, /* deprecated */
  32         SPLIT_NONE,
  33         _SPLIT_MAX,
  34         _SPLIT_INVALID = -1
  35 } SplitMode;
  36
  37 typedef struct JournalCompressOptions {
  38         bool enabled;
  39         uint64_t threshold_bytes;
  40 } JournalCompressOptions;
  41
  42 typedef struct JournalStorageSpace {
  43         usec_t   timestamp;
  44
  45         uint64_t available;
  46         uint64_t limit;
  47
  48         uint64_t vfs_used; /* space used by journal files */
  49         uint64_t vfs_available;
  50 } JournalStorageSpace;
  51
  52 typedef struct JournalStorage {
  53         const char *name;
  54         char *path;
  55
  56         JournalMetrics metrics;
  57         JournalStorageSpace space;
  58 } JournalStorage;
  59
  60 struct Server {
  61         int syslog_fd;
  62         int native_fd;
  63         int stdout_fd;
  64         int dev_kmsg_fd;
  65         int audit_fd;
  66         int hostname_fd;
  67         int notify_fd;
  68
  69         sd_event *event;
  70
  71         sd_event_source *syslog_event_source;
  72         sd_event_source *native_event_source;
  73         sd_event_source *stdout_event_source;
  74         sd_event_source *dev_kmsg_event_source;
  75         sd_event_source *audit_event_source;
  76         sd_event_source *sync_event_source;
  77         sd_event_source *sigusr1_event_source;
  78         sd_event_source *sigusr2_event_source;
  79         sd_event_source *sigterm_event_source;
  80         sd_event_source *sigint_event_source;
  81         sd_event_source *sigrtmin1_event_source;
  82         sd_event_source *hostname_event_source;
  83         sd_event_source *notify_event_source;
  84         sd_event_source *watchdog_event_source;
  85
  86         JournalFile *runtime_journal;
  87         JournalFile *system_journal;
  88         OrderedHashmap *user_journals;
  89
  90         uint64_t seqnum;
  91
  92         char *buffer;
  93         size_t buffer_size;
  94
  95         JournalRateLimit *rate_limit;
  96         usec_t sync_interval_usec;
  97         usec_t rate_limit_interval;
  98         unsigned rate_limit_burst;
  99
 100         JournalStorage runtime_storage;
 101         JournalStorage system_storage;
 102
 103         JournalCompressOptions compress;
 104         bool seal;
 105         bool read_kmsg;
 106
 107         bool forward_to_kmsg;
 108         bool forward_to_syslog;
 109         bool forward_to_console;
 110         bool forward_to_wall;
 111
 112         unsigned n_forward_syslog_missed;
 113         usec_t last_warn_forward_syslog_missed;
 114
 115         uint64_t var_available_timestamp;
 116
 117         usec_t max_retention_usec;
 118         usec_t max_file_usec;
 119         usec_t oldest_file_usec;
 120
 121         LIST_HEAD(StdoutStream, stdout_streams);
 122         LIST_HEAD(StdoutStream, stdout_streams_notify_queue);
 123         unsigned n_stdout_streams;
 124
 125         char *tty_path;
 126
 127         int max_level_store;
 128         int max_level_syslog;
 129         int max_level_kmsg;
 130         int max_level_console;
 131         int max_level_wall;
 132
 133         Storage storage;
 134         SplitMode split_mode;
 135
 136         MMapCache *mmap;
 137
 138         Set *deferred_closes;
 139
 140         uint64_t *kernel_seqnum;
 141         bool dev_kmsg_readable:1;
 142
 143         bool send_watchdog:1;
 144         bool sent_notify_ready:1;
 145         bool sync_scheduled:1;
 146
 147         char machine_id_field[sizeof("_MACHINE_ID=") + 32];
 148         char boot_id_field[sizeof("_BOOT_ID=") + 32];
 149         char *hostname_field;
 150
 151         /* Cached cgroup root, so that we don't have to query that all the time */
 152         char *cgroup_root;
 153
 154         usec_t watchdog_usec;
 155
 156         usec_t last_realtime_clock;
 157
 158         size_t line_max;
 159
 160         /* Caching of client metadata */
 161         Hashmap *client_contexts;
 162         Prioq *client_contexts_lru;
 163
 164         usec_t last_cache_pid_flush;
 165
 166         ClientContext *my_context; /* the context of journald itself */
 167         ClientContext *pid1_context; /* the context of PID 1 */
 168 };
 169
 170 #define SERVER_MACHINE_ID(s) ((s)->machine_id_field + STRLEN("_MACHINE_ID="))
 171
 172 /* Extra fields for any log messages */
 173 #define N_IOVEC_META_FIELDS 22
 174
 175 /* Extra fields for log messages that contain OBJECT_PID= (i.e. log about another process) */
 176 #define N_IOVEC_OBJECT_FIELDS 18
 177
 178 /* Maximum number of fields we'll add in for driver (i.e. internal) messages */
 179 #define N_IOVEC_PAYLOAD_FIELDS 16
 180
 181 /* kmsg: Maximum number of extra fields we'll import from the kernel's /dev/kmsg */
 182 #define N_IOVEC_KERNEL_FIELDS 64
 183
 184 /* kmsg: Maximum number of extra fields we'll import from udev's devices */
 185 #define N_IOVEC_UDEV_FIELDS 32
 186
 187 void server_dispatch_message(Server *s, struct iovec *iovec, size_t n, size_t m, ClientContext *c, const struct timeval *tv, int priority, pid_t object_pid);
 188 void server_driver_message(Server *s, pid_t object_pid, const char *message_id, const char *format, ...) _sentinel_ _printf_(4,0);
 189
 190 /* gperf lookup function */
 191 const struct ConfigPerfItem* journald_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 192
 193 CONFIG_PARSER_PROTOTYPE(config_parse_storage);
 194 CONFIG_PARSER_PROTOTYPE(config_parse_line_max);
 195 CONFIG_PARSER_PROTOTYPE(config_parse_compress);
 196
 197 const char *storage_to_string(Storage s) _const_;
 198 Storage storage_from_string(const char *s) _pure_;
 199
 200 CONFIG_PARSER_PROTOTYPE(config_parse_split_mode);
 201
 202 const char *split_mode_to_string(SplitMode s) _const_;
 203 SplitMode split_mode_from_string(const char *s) _pure_;
 204
 205 int server_init(Server *s);
 206 void server_done(Server *s);
 207 void server_sync(Server *s);
 208 int server_vacuum(Server *s, bool verbose);
 209 void server_rotate(Server *s);
 210 int server_schedule_sync(Server *s, int priority);
 211 int server_flush_to_var(Server *s, bool require_flag_file);
 212 void server_maybe_append_tags(Server *s);
 213 int server_process_datagram(sd_event_source *es, int fd, uint32_t revents, void *userdata);
 214 void server_space_usage_message(Server *s, JournalStorage *storage);