src/journal/journal-def.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foojournaldefhfoo
   4 #define foojournaldefhfoo
   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 "macro.h"
  30
  31 typedef struct Header Header;
  32 typedef struct ObjectHeader ObjectHeader;
  33 typedef union Object Object;
  34 typedef struct DataObject DataObject;
  35 typedef struct FieldObject FieldObject;
  36 typedef struct EntryObject EntryObject;
  37 typedef struct HashTableObject HashTableObject;
  38 typedef struct EntryArrayObject EntryArrayObject;
  39 typedef struct EntryItem EntryItem;
  40 typedef struct HashItem HashItem;
  41
  42 /* Object types */
  43 enum {
  44         OBJECT_UNUSED,
  45         OBJECT_DATA,
  46         OBJECT_FIELD,
  47         OBJECT_ENTRY,
  48         OBJECT_DATA_HASH_TABLE,
  49         OBJECT_FIELD_HASH_TABLE,
  50         OBJECT_ENTRY_ARRAY,
  51         _OBJECT_TYPE_MAX
  52 };
  53
  54 /* Object flags */
  55 enum {
  56         OBJECT_COMPRESSED = 1
  57 };
  58
  59 _packed_ struct ObjectHeader {
  60         uint8_t type;
  61         uint8_t flags;
  62         uint8_t reserved[6];
  63         uint64_t size;
  64         uint8_t payload[];
  65 };
  66
  67 _packed_ struct DataObject {
  68         ObjectHeader object;
  69         uint64_t hash;
  70         uint64_t next_hash_offset;
  71         uint64_t next_field_offset;
  72         uint64_t entry_offset; /* the first array entry we store inline */
  73         uint64_t entry_array_offset;
  74         uint64_t n_entries;
  75         uint8_t payload[];
  76 };
  77
  78 _packed_ struct FieldObject {
  79         ObjectHeader object;
  80         uint64_t hash;
  81         uint64_t next_hash_offset;
  82         uint64_t head_data_offset;
  83         uint64_t tail_data_offset;
  84         uint8_t payload[];
  85 };
  86
  87 _packed_ struct EntryItem {
  88         uint64_t object_offset;
  89         uint64_t hash;
  90 };
  91
  92 _packed_ struct EntryObject {
  93         ObjectHeader object;
  94         uint64_t seqnum;
  95         uint64_t realtime;
  96         uint64_t monotonic;
  97         sd_id128_t boot_id;
  98         uint64_t xor_hash;
  99         EntryItem items[];
 100 };
 101
 102 _packed_ struct HashItem {
 103         uint64_t head_hash_offset;
 104         uint64_t tail_hash_offset;
 105 };
 106
 107 _packed_ struct HashTableObject {
 108         ObjectHeader object;
 109         HashItem items[];
 110 };
 111
 112 _packed_ struct EntryArrayObject {
 113         ObjectHeader object;
 114         uint64_t next_entry_array_offset;
 115         uint64_t items[];
 116 };
 117
 118 union Object {
 119         ObjectHeader object;
 120         DataObject data;
 121         FieldObject field;
 122         EntryObject entry;
 123         HashTableObject hash_table;
 124         EntryArrayObject entry_array;
 125 };
 126
 127 enum {
 128         STATE_OFFLINE,
 129         STATE_ONLINE,
 130         STATE_ARCHIVED
 131 };
 132
 133 /* Header flags */
 134 enum {
 135         HEADER_INCOMPATIBLE_COMPRESSED = 1
 136 };
 137
 138 _packed_ struct Header {
 139         uint8_t signature[8]; /* "LPKSHHRH" */
 140         uint32_t compatible_flags;
 141         uint32_t incompatible_flags;
 142         uint8_t state;
 143         uint8_t reserved[7];
 144         sd_id128_t file_id;
 145         sd_id128_t machine_id;
 146         sd_id128_t boot_id;
 147         sd_id128_t seqnum_id;
 148         uint64_t arena_offset;
 149         uint64_t arena_size;
 150         uint64_t data_hash_table_offset;     /* for looking up data objects */
 151         uint64_t data_hash_table_size;
 152         uint64_t field_hash_table_offset;     /* for looking up field objects */
 153         uint64_t field_hash_table_size;
 154         uint64_t tail_object_offset;
 155         uint64_t n_objects;
 156         uint64_t n_entries;
 157         uint64_t seqnum;
 158         uint64_t first_seqnum;
 159         uint64_t entry_array_offset;
 160         uint64_t head_entry_realtime;
 161         uint64_t tail_entry_realtime;
 162         uint64_t tail_entry_monotonic;
 163 };
 164
 165 #endif