src/journal/journal-internal.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 <sys/types.h>
  25 #include <inttypes.h>
  26 #include <stdbool.h>
  27
  28 #include <systemd/sd-id128.h>
  29
  30 #include "journal-def.h"
  31 #include "list.h"
  32 #include "hashmap.h"
  33 #include "set.h"
  34 #include "journal-file.h"
  35
  36 typedef struct Match Match;
  37 typedef struct Location Location;
  38 typedef struct Directory Directory;
  39
  40 typedef enum MatchType {
  41         MATCH_DISCRETE,
  42         MATCH_OR_TERM,
  43         MATCH_AND_TERM
  44 } MatchType;
  45
  46 struct Match {
  47         MatchType type;
  48         Match *parent;
  49         LIST_FIELDS(Match, matches);
  50
  51         /* For concrete matches */
  52         char *data;
  53         size_t size;
  54         le64_t le_hash;
  55
  56         /* For terms */
  57         LIST_HEAD(Match, matches);
  58 };
  59
  60 typedef enum LocationType {
  61         /* The first and last entries, resp. */
  62         LOCATION_HEAD,
  63         LOCATION_TAIL,
  64
  65         /* We already read the entry we currently point to, and the
  66          * next one to read should probably not be this one again. */
  67         LOCATION_DISCRETE,
  68
  69         /* We should seek to the precise location specified, and
  70          * return it, as we haven't read it yet. */
  71         LOCATION_SEEK
  72 } LocationType;
  73
  74 struct Location {
  75         LocationType type;
  76
  77         bool seqnum_set;
  78         bool realtime_set;
  79         bool monotonic_set;
  80         bool xor_hash_set;
  81
  82         uint64_t seqnum;
  83         sd_id128_t seqnum_id;
  84
  85         uint64_t realtime;
  86
  87         uint64_t monotonic;
  88         sd_id128_t boot_id;
  89
  90         uint64_t xor_hash;
  91 };
  92
  93 struct Directory {
  94         char *path;
  95         int wd;
  96         bool is_root;
  97 };
  98
  99 struct sd_journal {
 100         char *path;
 101
 102         Hashmap *files;
 103         MMapCache *mmap;
 104
 105         Location current_location;
 106
 107         JournalFile *current_file;
 108         uint64_t current_field;
 109
 110         Match *level0, *level1, *level2;
 111
 112         pid_t original_pid;
 113
 114         int inotify_fd;
 115         unsigned current_invalidate_counter, last_invalidate_counter;
 116         usec_t last_process_usec;
 117
 118         char *unique_field;
 119         JournalFile *unique_file;
 120         uint64_t unique_offset;
 121
 122         int flags;
 123
 124         bool on_network;
 125         bool no_new_files;
 126
 127         size_t data_threshold;
 128
 129         Hashmap *directories_by_path;
 130         Hashmap *directories_by_wd;
 131
 132         Set *errors;
 133 };
 134
 135 char *journal_make_match_string(sd_journal *j);
 136 void journal_print_header(sd_journal *j);
 137
 138 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_journal*, sd_journal_close);
 139 #define _cleanup_journal_close_ _cleanup_(sd_journal_closep)
 140
 141 #define JOURNAL_FOREACH_DATA_RETVAL(j, data, l, retval)                     \
 142         for (sd_journal_restart_data(j); ((retval) = sd_journal_enumerate_data((j), &(data), &(l))) > 0; )