/usr/include/dnsdb/journal.h is in libyadifa-dev 2.2.3-1+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | /*------------------------------------------------------------------------------
*
* Copyright (c) 2011-2016, EURid. All rights reserved.
* The YADIFA TM software product is provided under the BSD 3-clause license:
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of EURid nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*------------------------------------------------------------------------------
*
*/
/** @defgroup
* @ingroup dnsdb
* @brief
*
* Journal API
*
*
* @{
*/
#ifndef JOURNAL_H
#define JOURNAL_H
#if !ZDB_JOURNAL_CODE
/*
* Direct usage of journal is risky. So now all allowed code (c files only) have :
* #define ZDB_JOURNAL_CODE 1 before the includes.
*/
#error "Please do not include dnsdb/journal.h directly."
#endif
#include <dnscore/input_stream.h>
#include <dnscore/dns_resource_record.h>
#include <dnsdb/zdb_types.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* We should handle multiple formats. So the journal can improve and the older formats still be loaded
* At some point we could also register journal formats but it does not seems important for now.
*/
typedef struct journal journal;
ya_result journal_init(u32 mru_size);
void journal_finalise();
/**
*
* The default part for XFR'ing
*
* @param path
*/
void journal_set_xfr_path(const char *path);
const char* journal_get_xfr_path();
/**
* Opens (or create) the journal for the zone
*
* @param jh pointer will be set to the journal handling structure
* @param origin origin of the zone
* @param create create an empty journal if none has been found
*
* @return an error code
*/
typedef ya_result journal_open_method(journal **jh, u8* origin, bool create);
typedef const char *journal_get_format_name_method();
typedef u32 journal_get_format_version_method();
/*
* The stream is : [SOA- RR- RR- RR- SOA+ RR+ RR+ RR+]+ <EOS>
*/
typedef ya_result journal_append_ixfr_stream_method(journal *jh, input_stream *ixfr_wire_is);
/**
* rr can be NULL
*/
typedef ya_result journal_get_ixfr_stream_at_serial_method(journal *jh, u32 serial_from, input_stream *out_input_stream, dns_resource_record* rr);
typedef ya_result journal_get_first_serial_method(journal *jh, u32 *serial);
typedef ya_result journal_get_last_serial_method(journal *jh, u32 *serial);
typedef ya_result journal_get_serial_range_method(journal *jh, u32 *serial_start, u32 *serial_end);
typedef ya_result journal_truncate_to_size_method(journal *jh, u32 size_);
typedef ya_result journal_truncate_to_serial_method(journal *jh, u32 serial_);
typedef ya_result journal_close_method(journal *jh);
typedef ya_result journal_get_domain_method(journal *jh, u8 *out_domain);
typedef void journal_destroy_method(journal *jh);
typedef void journal_log_dump_method(journal *jh);
typedef void journal_link_zone_method(journal *jh, zdb_zone *zone);
struct journal_vtbl
{
journal_get_format_name_method *get_format_name; // returns a const char*
journal_get_format_version_method *get_format_version; // returns the version
journal_close_method *close; // closes the file
journal_append_ixfr_stream_method *append_ixfr_stream; // appends IXFR (without the first/last SOA) to the journal
journal_get_ixfr_stream_at_serial_method *get_ixfr_stream_at_serial;// returns a stream starting at serial SN
journal_get_first_serial_method *get_first_serial; // returns the first serial in the journal
journal_get_last_serial_method *get_last_serial; // returns the last serial in the journal
journal_get_serial_range_method *get_serial_range; // returns both the first and last serials in the journal
journal_truncate_to_size_method *truncate_to_size; // truncates the journal size (probably never used)
journal_truncate_to_serial_method *truncate_to_serial; // truncates the journal to a serial (probably never used)
journal_log_dump_method *log_dump; // dumps the status of the journal on the database logger
journal_get_domain_method *get_domain; // copies the domain to the output buffer
journal_destroy_method *destroy; // destroys the journal at the first opportunity
journal_link_zone_method *link_zone; // links the zone to the journal and do required internal updates
const char* __class__;
};
struct journal
{
volatile struct journal_vtbl *vtbl;
volatile zdb_zone *zone;
volatile struct journal *next;
volatile struct journal *prev;
volatile bool mru;
/* The journal is not like a stream, it's a full standalone entity always returned as a pointer.
* So the handler can do whatever it wants after "mru"
*/
};
#define journal_get_format_name(j_) (j_)->vtbl->get_format_name()
#define journal_get_format_version(j_) (j_)->vtbl->get_format_version()
//#define journal_close(j_) (j_)->vtbl->close(j_)
#define journal_append_ixfr_stream(j_, ixfr_wire_is_) (j_)->vtbl->append_ixfr_stream((j_), (ixfr_wire_is_))
#define journal_get_ixfr_stream_at_serial(j_, serial_form_, out_input_stream_, \
dns_rr_) (j_)->vtbl->get_ixfr_stream_at_serial((j_), (serial_form_), (out_input_stream_), (dns_rr_))
#define journal_get_first_serial(j_, serial_) (j_)->vtbl->get_first_serial((j_),(serial_))
#define journal_get_last_serial(j_, serial_) (j_)->vtbl->get_last_serial((j_),(serial_))
#define journal_get_serial_range(j_, serial_start_, serial_end_) (j_)->vtbl->get_serial_range((j_),(serial_start_),(serial_end_))
#define journal_truncate_to_size(j_, size_) (j_)->vtbl->truncate_to_size((j_), (size_))
#define journal_truncate_to_serial(j_, serial_) (j_)->vtbl->truncate_to_serial((j_), (serial_))
#define journal_link_zone(j_, zone_) (j_)->vtbl->link_zone((j_), (zone_));
/**
*
* Returns the journal for a loaded zone.
*
* DO NOT USE THE JOURNAL WITHOUT OPENING IT.
* ie: TAKING IT DIRECTLY FROM THE ZONE NODE IN THE DATABASE.
* IT ***WILL*** RACE-FAIL !!!
*
* @param jhp
* @param zone
* @param workingdir
* @param create
* @return
*/
ya_result journal_open(journal **jhp, zdb_zone *zone, bool create);
/**
*
* Closes a journal (decrement the reference count and delete if zero)
* If no reference exists, remove the journal
*
* @param jh
* @return
*/
void journal_close(journal *jh);
/**
* Returns the last available serial of a journal for a zone.
* Does this by opening the journal.
* This function should NOT be used for a loaded zone.
*/
ya_result journal_last_serial(const u8 *origin, const char *workingdir, u32 *serialp);
/*
* Empties/deletes a journal
* Does this by opening the journal and calling a truncate to size 0
* This function should NOT be used for a loaded zone.
*/
ya_result journal_truncate(const u8 *origin);
/**
* Retrieves the last SOA of the journal.
*
* @param origin the zone origin
* @param workingdir the working directory of the journal
* @param serial a pointer that will be set to the serial of the SOA, can be NULL
* @param ttl a pointer that will be set to the ttl of the SOA, can be NULL
* @param last_soa_rdata a pointer to a buffer that will get a copy of the SOA, if its size is big enough, can be NULL
* @param last_soa_rdata_size a pointer to a u16 integer that contains the size of the rdata buffer and that will be set to the real size of the SOA rdata, can be NULL
*
* @return an error code
*/
ya_result journal_last_soa(const u8 *origin, const char *workingdir, u32 *serial, u32 *ttl, u8 *last_soa_rdata, u16 *last_soa_rdata_size);
/**
* Logs the current status of the journaling system
*/
void journal_log_status();
#ifdef __cplusplus
}
#endif
#endif /* JOURNAL_H */
/* @} */
|