journal.h revision 7d32c065c7bb56f281651ae3dd2888f32ce4f1d9
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User * Copyright (C) 1999, 2000 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Permission to use, copy, modify, and distribute this software for any
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater * purpose with or without fee is hereby granted, provided that the above
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson * copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User ***** Module Info
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Database journalling.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * A dns_difftuple_t represents a single RR being added or deleted.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * The RR type and class are in the 'rdata' member; the class is always
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the real one, not a DynDNS meta-class, so that the rdatas can be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * compared using dns_rdata_compare(). The TTL is significant
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * even for deletions, because a deletion/addition pair cannot
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * be canceled out if the TTL differs (it might be an explicit
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews * TTL update).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Tuples are also used to represent complete RRs with owner
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * names for a couple of other purposes, such as the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * individual RRs of a "RRset exists (value dependent)"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * prerequisite set. In this case, op==DNS_DIFFOP_EXISTS,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * and the TTL is ignored.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox Usertypedef enum {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User#define DNS_DIFFTUPLE_MAGIC 0x44494654U /* DIFT. */
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews unsigned int magic;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /* Variable-size name data and rdata follows. */
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * A dns_diff_t represents a set of changes being applied to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * a zone. Diffs are also used to represent "RRset exists
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * (value dependent)" prerequisites.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User unsigned int magic;
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User/* Type of comparision function for sorting diffs. */
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox Usertypedef int dns_diff_compare_func(const void *, const void *);
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * A dns_journal_t represents an open journal file. This is an opaque type.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * A particular dns_journal_t object may be opened for writing, in which case
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * it can be used for writing transactions to a journal file, or it can be
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * opened for reading, in which case it can be used for reading transactions
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * from (iterating over) a journal file. A single dns_journal_t object may
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * not be used for both purposes.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *** Functions
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User/**************************************************************************/
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Maniuplation of diffs and tuples.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User dns_diffop_t op, dns_name_t *name, dns_ttl_t ttl,
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * Create a tuple. Deep copies are made of the name and rdata, so
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * they need not remain valid after the call.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * *tp != NULL && *tp == NULL.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * ISC_R_SUCCESS
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * ISC_R_NOMEMORY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Free a tuple.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * **tp is a valid tuple.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * *tp == NULL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * All memory used by the tuple is freed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeindns_difftuple_copy(dns_difftuple_t *orig, dns_difftuple_t **copyp);
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews * Copy a tuple.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'orig' points to a valid tuple
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater * copyp != NULL && *copyp == NULL
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updatervoid dns_diff_init(isc_mem_t *mctx, dns_diff_t *diff);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Initialize a diff.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'diff' points to an uninitialized dns_diff_t
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * allocated by the caller.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * '*diff' is a valid, empty diff.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * Clear a diff, destroying all its tuples.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'diff' points to a valid dns_diff_t.
f6da30bb5447c23d880b09f601441e70c5313557Mark Andrews * Any tuples in the diff are destroyed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The diff now empty, but it is still valid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * and may be reused without calling dns_diff_init
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * again. The only memory used is that of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * dns_diff_t structure itself.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Managing the memory of the dns_diff_t structure itself
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * is the caller's responsibility.
8c9957e63274e6ea44d182703116307b1a65dabbMark Andrewsdns_diff_append(dns_diff_t *diff, dns_difftuple_t **tuple);
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User * Append a single tuple to a diff.
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User * 'diff' is a valid diff.
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User * '*tuple' is a valid tuple.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * *tuple is NULL.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The tuple has been freed, or will be freed when the diff is cleared.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox Userdns_diff_appendminimal(dns_diff_t *diff, dns_difftuple_t **tuple);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Append 'tuple' to 'diff', removing any duplicate
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * or conflicting updates as needed to create a minimal diff.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'diff' is a minimal diff.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'diff' is still a minimal diff.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * *tuple is NULL.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * The tuple has been freed, or will be freed when the diff is cleared.
7329012471d165cd3dc4180ad2a0a43de91e7f01Mark Andrewsdns_diff_sort(dns_diff_t *diff, dns_diff_compare_func *compare);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Sort 'diff' in-place according to the comparison function 'compare'.
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrewsdns_diff_apply(dns_diff_t *diff, dns_db_t *db, dns_dbversion_t *ver);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Apply 'diff' to the database 'db'.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * For efficiency, the diff should be sorted by owner name.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * If it is not sorted, operation will still be correct,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * but less efficient.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * *diff is a valid diff (possibly empty), containing
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * tuples of type DNS_DIFFOP_ADD and/or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * For DNS_DIFFOP_DEL tuples, the TTL is ignored.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeindns_diff_load(dns_diff_t *diff, dns_addrdatasetfunc_t addfunc,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Like dns_diff_apply, but for use when loading a new database
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * instead of modifying an existing one. This bypasses the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * database transaction mechanisms.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'addfunc' is a valid dns_addradatasetfunc_t obtained from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * dns_db_beginload()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * 'add_private' points to a corresponding dns_dbload_t *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * (XXX why is it a void pointer, then?)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Print the differences to 'file' or if 'file' is NULL via the
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * logging system.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'diff' to be valid.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'file' to refer to a open file or NULL.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_SUCCESS
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_NOMEMORY
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_UNEXPECTED
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * any error from dns_rdataset_totext()
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater/**************************************************************************/
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater * Misc. utilities
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater * XXX these belong in a general-purpose DNS library
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updaterisc_uint32_t dns_soa_getserial(dns_rdata_t *rdata);
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater * Extract the serial number from the rdata of a SOA record.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * rdata refers to the rdata of a well-formed SOA record.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Uservoid dns_soa_setserial(isc_uint32_t val, dns_rdata_t *rdata);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Change the serial number of a SOA record by modifying the
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * rdata in-place.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * rdata refers to the rdata of a well-formed SOA record.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userdns_db_getsoaserial(dns_db_t *db, dns_dbversion_t *ver, isc_uint32_t *serialp);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Get the current SOA serial number from a zone database.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'db' is a valid database with zone semantics.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'ver' is a valid version.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userdns_db_createsoatuple(dns_db_t *db, dns_dbversion_t *ver, isc_mem_t *mctx,
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Create a diff tuple for the current database SOA.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#define DNS_SERIAL_GT(a, b) ((int)(((a) - (b)) & 0xFFFFFFFF) > 0)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#define DNS_SERIAL_GE(a, b) ((int)(((a) - (b)) & 0xFFFFFFFF) >= 0)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Compare SOA serial numbers. DNS_SERIAL_GT(a, b) returns true iff
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * a is "greater than" b where "greater than" is as defined in RFC1982.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_SERIAL_GE(a, b) returns true iff a is "greater than or equal to" b.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User/**************************************************************************/
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Journal object creation and destruction.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userdns_journal_open(isc_mem_t *mctx, const char *filename, isc_boolean_t write,
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Open the journal file 'filename' and create a dns_journal_t object for it.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * If 'write' is ISC_TRUE, the journal is open for writing. If it does
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * not exist, it is created.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * If 'write' is ISC_FALSE, the journal is open for reading. If it does
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * not exist, ISC_R_NOTFOUND is returned.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userdns_journal_destroy(dns_journal_t **journalp);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Destroy a dns_journal_t, closing any open files and freeing its memory.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User/**************************************************************************/
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Writing transactions to journals.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox Userdns_journal_begin_transaction(dns_journal_t *j);
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User * Prepare to write a new transaction to the open journal file 'j'.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'j' is open for writing.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userdns_journal_writediff(dns_journal_t *j, dns_diff_t *diff);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Write 'diff' to the current transaction of journal file 'j'.
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User * 'j' is open for writing and dns_journal_begin_transaction()
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User * has been called.
a24330c4805a224191ab687d0291963062fe3355Tinderbox User * 'diff' is a full or partial, correctly ordered IXFR
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User * difference sequence.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Commit the current transaction of journal file 'j'.
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User * 'j' is open for writing and dns_journal_begin_transaction()
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User * has been called.
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User * dns_journal_writediff() has been called one or more times
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User * to form a complete, correctly ordered IXFR difference
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox Userdns_journal_write_transaction(dns_journal_t *j, dns_diff_t *diff);
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User * Write a complete transaction at once to a journal file,
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * sorting it if necessary, and commit it. Equivalent to calling
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * dns_diff_sort(), dns_journal_begin_transaction(),
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * dns_journal_writediff(), and dns_journal_commit().
b90c4f0646e61b6cc82bde5a93e400e1015974b8Tinderbox User * 'j' is open for writing.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'diff' contains exactly one SOA deletion, one SOA addition
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * with a greater serial number, and possibly other changes,
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * in arbitrary order.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User/**************************************************************************/
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Reading transactions from journals.
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox Userisc_uint32_t dns_journal_first_serial(dns_journal_t *j);
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox Userisc_uint32_t dns_journal_last_serial(dns_journal_t *j);
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox User * Get the first and last addressable serial number in the journal.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User isc_uint32_t begin_serial, isc_uint32_t end_serial);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Prepare to iterate over the transactions that will bring the database
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * from SOA serial number 'begin_serial' to 'end_serial'.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_SUCCESS
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_NOTFOUND begin_serial is within the range of adressable
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * serial numbers covered by the journal, but
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * this particular serial number does not exist.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_RANGE begin_serial is outside the addressable range.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userisc_result_t dns_journal_first_rr(dns_journal_t *j);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userisc_result_t dns_journal_next_rr(dns_journal_t *j);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Position the iterator at the first/next RR in a journal
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * transaction sequence established using dns_journal_iter_init().
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * dns_journal_iter_init() has been called.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Uservoid dns_journal_current_rr(dns_journal_t *j, dns_name_t **name,
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Get the name, ttl, and rdata of the current journal RR.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * The last call to dns_journal_first_rr() or dns_journal_next_rr()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * returned DNS_R_SUCCESS.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User/**************************************************************************/
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Database roll-forward.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userdns_journal_rollforward(isc_mem_t *mctx, dns_db_t *db, const char *filename);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Roll forward (play back) the journal file "filename" into the
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * database "db". This should be called when the server starts
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * after a shutdown or crash.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'mctx' is a valid memory context.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'db' is a valid database which does not have a version
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * open for writing.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * 'filename' is the name of the journal file belonging to 'db'.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_NOJOURNAL when journal does not exist.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_NOTFOUND when current serial in not in journal.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * DNS_R_SUCCESS journal has been applied successfully to database.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox Userisc_result_t dns_journal_print(isc_mem_t *mctx, const char *filename, FILE *file);
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User/* For debugging not general use */
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * Compare the databases 'dba' and 'dbb' and generate a journal
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User * entry containing the changes to make 'dba' from 'dbb' (note
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the order). This journal entry will consist of a single,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * possibly very large transaction. Append the journal
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * entry to the journal file specified by 'journal_filename'.
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater#endif /* DNS_JOURNAL_H */