mirror of
https://github.com/matrix-construct/construct
synced 2024-11-18 16:00:57 +01:00
ircd:Ⓜ️:dbs: Unsplit appendix.h and write_opts.h for better interface in dbs.h
This commit is contained in:
Jason Volk
parent
838ad51b05
commit
dc1b5f6881
3 changed files with 186 additions and 215 deletions
|
|
@ -1,127 +0,0 @@
|
||||||
// Matrix Construct
|
|
||||||
//
|
|
||||||
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
|
||||||
// Copyright (C) 2016-2019 Jason Volk <jason@zemos.net>
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
// purpose with or without fee is hereby granted, provided that the above
|
|
||||||
// copyright notice and this permission notice is present in all copies. The
|
|
||||||
// full license for this software is available in the LICENSE file.
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
#define HAVE_IRCD_M_DBS_APPENDIX_H
|
|
||||||
|
|
||||||
/// This namespace contains the details and implementation for constructing
|
|
||||||
/// database transactions through dbs::write().
|
|
||||||
namespace ircd::m::dbs::appendix
|
|
||||||
{
|
|
||||||
enum index :uint8_t;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Values which represent some element(s) included in a transaction or
|
|
||||||
/// codepaths taken to construct a transaction. This enum is generally used
|
|
||||||
/// in a bitset in dbs::write_opts to control the behavior of dbs::write().
|
|
||||||
///
|
|
||||||
enum ircd::m::dbs::appendix::index
|
|
||||||
:std::underlying_type<ircd::m::dbs::appendix::index>::type
|
|
||||||
{
|
|
||||||
/// This bit offers coarse control over all the EVENT_ appendices.
|
|
||||||
EVENT,
|
|
||||||
|
|
||||||
/// Involves the event_idx column; translates an event_id to our internal
|
|
||||||
/// index number. This bit can be dark during re-indexing operations.
|
|
||||||
EVENT_ID,
|
|
||||||
|
|
||||||
/// Involves the event_json column; writes a full JSON serialization
|
|
||||||
/// of the event. See the `json_source` write_opts option. This bit can be
|
|
||||||
/// dark during re-indexing operations to avoid rewriting the same data.
|
|
||||||
EVENT_JSON,
|
|
||||||
|
|
||||||
/// Involves any direct event columns; such columns are forward-indexed
|
|
||||||
/// values from the original event data but split into columns for each
|
|
||||||
/// property. Can be dark during re-indexing similar to EVENT_JSON.
|
|
||||||
EVENT_COLS,
|
|
||||||
|
|
||||||
/// Take branch to handle event reference graphing. A separate bitset is
|
|
||||||
/// offered in write_opts for fine-grained control over which reference
|
|
||||||
/// types are involved.
|
|
||||||
EVENT_REFS,
|
|
||||||
|
|
||||||
/// Involves the event_horizon column which saves the event_id of any
|
|
||||||
/// unresolved event_refs at the time of the transaction. This is important
|
|
||||||
/// for out-of-order writes to the database. When the unresolved prev_event
|
|
||||||
/// is encountered later and finds its event_id in event_horizon it can
|
|
||||||
/// properly complete the event_refs graph to all the referencing events.
|
|
||||||
EVENT_HORIZON,
|
|
||||||
|
|
||||||
/// Resolves unresolved references for this event left in event_horizon.
|
|
||||||
EVENT_HORIZON_RESOLVE,
|
|
||||||
|
|
||||||
/// Involves the event_sender column (reverse index on the event sender).
|
|
||||||
EVENT_SENDER,
|
|
||||||
|
|
||||||
/// Involves the event_type column (reverse index on the event type).
|
|
||||||
EVENT_TYPE,
|
|
||||||
|
|
||||||
/// Take branch to handle events with a room_id
|
|
||||||
ROOM,
|
|
||||||
|
|
||||||
/// Take branch to handle room state events.
|
|
||||||
STATE,
|
|
||||||
|
|
||||||
/// Perform state btree manip for room history.
|
|
||||||
HISTORY,
|
|
||||||
|
|
||||||
/// Take branch to handle room redaction events.
|
|
||||||
REDACT,
|
|
||||||
|
|
||||||
/// Take branch to handle other types of events.
|
|
||||||
OTHER,
|
|
||||||
|
|
||||||
/// Whether the event should be added to the room_head, indicating that
|
|
||||||
/// it has not yet been referenced at the time of this write. Defaults
|
|
||||||
/// to true, but if this is an older event this opt should be rethought.
|
|
||||||
ROOM_HEAD,
|
|
||||||
|
|
||||||
/// Whether the event removes the prev_events it references from the
|
|
||||||
/// room_head. This defaults to true and should almost always be true.
|
|
||||||
ROOM_HEAD_REFS,
|
|
||||||
|
|
||||||
/// Involves room_events table.
|
|
||||||
ROOM_EVENTS,
|
|
||||||
|
|
||||||
/// Involves room_joined table.
|
|
||||||
ROOM_JOINED,
|
|
||||||
|
|
||||||
/// Involves room_state (present state) table.
|
|
||||||
ROOM_STATE,
|
|
||||||
};
|
|
||||||
|
|
||||||
// Internal interface; not for public. (TODO: renamespace)
|
|
||||||
namespace ircd::m::dbs
|
|
||||||
{
|
|
||||||
void _index__room_state(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index__room_events(db::txn &, const event &, const write_opts &, const string_view &);
|
|
||||||
void _index__room_joined(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index__room_head_refs(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index__room_head(db::txn &, const event &, const write_opts &);
|
|
||||||
string_view _index_state(db::txn &, const event &, const write_opts &);
|
|
||||||
string_view _index_redact(db::txn &, const event &, const write_opts &);
|
|
||||||
string_view _index_other(db::txn &, const event &, const write_opts &);
|
|
||||||
string_view _index_room(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_type(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_sender(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_horizon_resolve(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_horizon(db::txn &, const event &, const write_opts &, const id::event &);
|
|
||||||
void _index_event_refs_m_room_redaction(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_refs_m_receipt_m_read(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_refs_m_relates_m_reply(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_refs_state(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_refs_auth(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_refs_prev(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_refs(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_json(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_cols(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event_id(db::txn &, const event &, const write_opts &);
|
|
||||||
void _index_event(db::txn &, const event &, const write_opts &);
|
|
||||||
}
|
|
||||||
|
|
@ -12,7 +12,6 @@
|
||||||
#define HAVE_IRCD_M_DBS_DBS_H
|
#define HAVE_IRCD_M_DBS_DBS_H
|
||||||
|
|
||||||
/// Database Schema
|
/// Database Schema
|
||||||
///
|
|
||||||
namespace ircd::m::dbs
|
namespace ircd::m::dbs
|
||||||
{
|
{
|
||||||
struct init;
|
struct init;
|
||||||
|
|
@ -33,14 +32,17 @@ namespace ircd::m::dbs
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Database description
|
/// Database description
|
||||||
///
|
|
||||||
namespace ircd::m::dbs::desc
|
namespace ircd::m::dbs::desc
|
||||||
{
|
{
|
||||||
extern const db::description events;
|
extern const db::description events;
|
||||||
}
|
}
|
||||||
|
|
||||||
#include "appendix.h"
|
/// Transaction appendage builder namespace.
|
||||||
#include "write_opts.h"
|
namespace ircd::m::dbs::appendix
|
||||||
|
{
|
||||||
|
enum index :uint8_t;
|
||||||
|
}
|
||||||
|
|
||||||
#include "event_column.h"
|
#include "event_column.h"
|
||||||
#include "event_idx.h"
|
#include "event_idx.h"
|
||||||
#include "event_json.h"
|
#include "event_json.h"
|
||||||
|
|
@ -54,8 +56,188 @@ namespace ircd::m::dbs::desc
|
||||||
#include "room_state.h"
|
#include "room_state.h"
|
||||||
#include "state_node.h"
|
#include "state_node.h"
|
||||||
|
|
||||||
|
/// Options that affect the dbs::write() of an event to the transaction.
|
||||||
|
struct ircd::m::dbs::write_opts
|
||||||
|
{
|
||||||
|
static const std::bitset<256> event_refs_all;
|
||||||
|
static const std::bitset<64> appendix_all;
|
||||||
|
|
||||||
|
/// Operation code; usually SET or DELETE. Note that we interpret the
|
||||||
|
/// code internally and may set different codes for appendages of the
|
||||||
|
/// actual transaction.
|
||||||
|
db::op op {db::op::SET};
|
||||||
|
|
||||||
|
/// Principal's index number. Most codepaths do not permit zero. This may
|
||||||
|
/// be zero for blacklisting, but the blacklist option must be set.
|
||||||
|
uint64_t event_idx {0};
|
||||||
|
|
||||||
|
/// The state btree root to perform the update on.
|
||||||
|
string_view root_in;
|
||||||
|
|
||||||
|
/// After the update is performed, the new state btree root is returned
|
||||||
|
/// into this buffer.
|
||||||
|
mutable_buffer root_out;
|
||||||
|
|
||||||
|
/// Fuse panel to toggle transaction elements.
|
||||||
|
std::bitset<64> appendix {appendix_all};
|
||||||
|
|
||||||
|
/// Selection of what reference types to manipulate in event_refs. Refs
|
||||||
|
/// will not be made if it is not appropriate for the event anyway, so
|
||||||
|
/// this defaults to all bits. User can disable one or more ref types
|
||||||
|
/// by clearing a bit.
|
||||||
|
std::bitset<256> event_refs {event_refs_all};
|
||||||
|
|
||||||
|
/// Selection of what reference types to resolve and delete from the
|
||||||
|
/// event_horizon for this event.
|
||||||
|
std::bitset<256> horizon_resolve {event_refs_all};
|
||||||
|
|
||||||
|
/// Whether the present state table `room_state` should be updated by
|
||||||
|
/// this operation if appropriate.
|
||||||
|
bool present {true};
|
||||||
|
|
||||||
|
/// Whether the history state btree `state_node` + `room_events` value
|
||||||
|
/// should be updated by this operation if appropriate.
|
||||||
|
bool history {false};
|
||||||
|
|
||||||
|
/// Whether the event.source can be used directly for event_json. Defaults
|
||||||
|
/// to false unless the caller wants to avoid a redundant re-stringify.
|
||||||
|
bool json_source {false};
|
||||||
|
|
||||||
|
/// Data in this db::txn is used as a primary source in some cases where
|
||||||
|
/// indexers make a database query. This is useful when the sought data
|
||||||
|
/// has not even been written to the database, and this may even point to
|
||||||
|
/// the same db::txn as the result being composed in the first place. By
|
||||||
|
/// default a database query is made as a fallback after using this.
|
||||||
|
const db::txn *interpose {nullptr};
|
||||||
|
|
||||||
|
/// Whether indexers are allowed to make database queries when composing
|
||||||
|
/// the transaction. note: database queries may yield the ircd::ctx and
|
||||||
|
/// made indepdently; this is slow and requires external synchronization
|
||||||
|
/// to not introduce inconsistent data into the txn.
|
||||||
|
bool allow_queries {true};
|
||||||
|
|
||||||
|
/// Setting to true allows the event_idx to be 0 which allows the insertion
|
||||||
|
/// of the event_id into a "blacklist" to mark it as unprocessable; this
|
||||||
|
/// prevents the server from repeatedly trying to process an event.
|
||||||
|
///
|
||||||
|
/// Note for now this just creates an entry in _event_idx of 0 for the
|
||||||
|
/// event_id which also means "not found" for most codepaths, a reasonable
|
||||||
|
/// default. But for codepaths that must distinguish between "not found"
|
||||||
|
/// and "blacklist" they must know that `event_id => 0` was *found* to be
|
||||||
|
/// zero.
|
||||||
|
bool blacklist {false};
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Values which represent some element(s) included in a transaction or
|
||||||
|
/// codepaths taken to construct a transaction. This enum is generally used
|
||||||
|
/// in a bitset in dbs::write_opts to control the behavior of dbs::write().
|
||||||
|
///
|
||||||
|
enum ircd::m::dbs::appendix::index
|
||||||
|
:std::underlying_type<ircd::m::dbs::appendix::index>::type
|
||||||
|
{
|
||||||
|
/// This bit offers coarse control over all the EVENT_ appendices.
|
||||||
|
EVENT,
|
||||||
|
|
||||||
|
/// Involves the event_idx column; translates an event_id to our internal
|
||||||
|
/// index number. This bit can be dark during re-indexing operations.
|
||||||
|
EVENT_ID,
|
||||||
|
|
||||||
|
/// Involves the event_json column; writes a full JSON serialization
|
||||||
|
/// of the event. See the `json_source` write_opts option. This bit can be
|
||||||
|
/// dark during re-indexing operations to avoid rewriting the same data.
|
||||||
|
EVENT_JSON,
|
||||||
|
|
||||||
|
/// Involves any direct event columns; such columns are forward-indexed
|
||||||
|
/// values from the original event data but split into columns for each
|
||||||
|
/// property. Can be dark during re-indexing similar to EVENT_JSON.
|
||||||
|
EVENT_COLS,
|
||||||
|
|
||||||
|
/// Take branch to handle event reference graphing. A separate bitset is
|
||||||
|
/// offered in write_opts for fine-grained control over which reference
|
||||||
|
/// types are involved.
|
||||||
|
EVENT_REFS,
|
||||||
|
|
||||||
|
/// Involves the event_horizon column which saves the event_id of any
|
||||||
|
/// unresolved event_refs at the time of the transaction. This is important
|
||||||
|
/// for out-of-order writes to the database. When the unresolved prev_event
|
||||||
|
/// is encountered later and finds its event_id in event_horizon it can
|
||||||
|
/// properly complete the event_refs graph to all the referencing events.
|
||||||
|
EVENT_HORIZON,
|
||||||
|
|
||||||
|
/// Resolves unresolved references for this event left in event_horizon.
|
||||||
|
EVENT_HORIZON_RESOLVE,
|
||||||
|
|
||||||
|
/// Involves the event_sender column (reverse index on the event sender).
|
||||||
|
EVENT_SENDER,
|
||||||
|
|
||||||
|
/// Involves the event_type column (reverse index on the event type).
|
||||||
|
EVENT_TYPE,
|
||||||
|
|
||||||
|
/// Take branch to handle events with a room_id
|
||||||
|
ROOM,
|
||||||
|
|
||||||
|
/// Take branch to handle room state events.
|
||||||
|
STATE,
|
||||||
|
|
||||||
|
/// Perform state btree manip for room history.
|
||||||
|
HISTORY,
|
||||||
|
|
||||||
|
/// Take branch to handle room redaction events.
|
||||||
|
REDACT,
|
||||||
|
|
||||||
|
/// Take branch to handle other types of events.
|
||||||
|
OTHER,
|
||||||
|
|
||||||
|
/// Whether the event should be added to the room_head, indicating that
|
||||||
|
/// it has not yet been referenced at the time of this write. Defaults
|
||||||
|
/// to true, but if this is an older event this opt should be rethought.
|
||||||
|
ROOM_HEAD,
|
||||||
|
|
||||||
|
/// Whether the event removes the prev_events it references from the
|
||||||
|
/// room_head. This defaults to true and should almost always be true.
|
||||||
|
ROOM_HEAD_REFS,
|
||||||
|
|
||||||
|
/// Involves room_events table.
|
||||||
|
ROOM_EVENTS,
|
||||||
|
|
||||||
|
/// Involves room_joined table.
|
||||||
|
ROOM_JOINED,
|
||||||
|
|
||||||
|
/// Involves room_state (present state) table.
|
||||||
|
ROOM_STATE,
|
||||||
|
};
|
||||||
|
|
||||||
struct ircd::m::dbs::init
|
struct ircd::m::dbs::init
|
||||||
{
|
{
|
||||||
init(std::string dbopts = {});
|
init(std::string dbopts = {});
|
||||||
~init() noexcept;
|
~init() noexcept;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Internal interface; not for public. (TODO: renamespace)
|
||||||
|
namespace ircd::m::dbs
|
||||||
|
{
|
||||||
|
void _index__room_state(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index__room_events(db::txn &, const event &, const write_opts &, const string_view &);
|
||||||
|
void _index__room_joined(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index__room_head_refs(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index__room_head(db::txn &, const event &, const write_opts &);
|
||||||
|
string_view _index_state(db::txn &, const event &, const write_opts &);
|
||||||
|
string_view _index_redact(db::txn &, const event &, const write_opts &);
|
||||||
|
string_view _index_other(db::txn &, const event &, const write_opts &);
|
||||||
|
string_view _index_room(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_type(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_sender(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_horizon_resolve(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_horizon(db::txn &, const event &, const write_opts &, const id::event &);
|
||||||
|
void _index_event_refs_m_room_redaction(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_refs_m_receipt_m_read(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_refs_m_relates_m_reply(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_refs_state(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_refs_auth(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_refs_prev(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_refs(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_json(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_cols(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event_id(db::txn &, const event &, const write_opts &);
|
||||||
|
void _index_event(db::txn &, const event &, const write_opts &);
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,84 +0,0 @@
|
||||||
// Matrix Construct
|
|
||||||
//
|
|
||||||
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
|
||||||
// Copyright (C) 2016-2019 Jason Volk <jason@zemos.net>
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
// purpose with or without fee is hereby granted, provided that the above
|
|
||||||
// copyright notice and this permission notice is present in all copies. The
|
|
||||||
// full license for this software is available in the LICENSE file.
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
#define HAVE_IRCD_M_DBS_WRITE_OPTS_H
|
|
||||||
|
|
||||||
/// Options that affect the dbs::write() of an event to the transaction.
|
|
||||||
struct ircd::m::dbs::write_opts
|
|
||||||
{
|
|
||||||
static const std::bitset<256> event_refs_all;
|
|
||||||
static const std::bitset<64> appendix_all;
|
|
||||||
|
|
||||||
/// Operation code; usually SET or DELETE. Note that we interpret the
|
|
||||||
/// code internally and may set different codes for appendages of the
|
|
||||||
/// actual transaction.
|
|
||||||
db::op op {db::op::SET};
|
|
||||||
|
|
||||||
/// Principal's index number. Most codepaths do not permit zero. This may
|
|
||||||
/// be zero for blacklisting, but the blacklist option must be set.
|
|
||||||
uint64_t event_idx {0};
|
|
||||||
|
|
||||||
/// The state btree root to perform the update on.
|
|
||||||
string_view root_in;
|
|
||||||
|
|
||||||
/// After the update is performed, the new state btree root is returned
|
|
||||||
/// into this buffer.
|
|
||||||
mutable_buffer root_out;
|
|
||||||
|
|
||||||
/// Fuse panel to toggle transaction elements.
|
|
||||||
std::bitset<64> appendix {appendix_all};
|
|
||||||
|
|
||||||
/// Selection of what reference types to manipulate in event_refs. Refs
|
|
||||||
/// will not be made if it is not appropriate for the event anyway, so
|
|
||||||
/// this defaults to all bits. User can disable one or more ref types
|
|
||||||
/// by clearing a bit.
|
|
||||||
std::bitset<256> event_refs {event_refs_all};
|
|
||||||
|
|
||||||
/// Selection of what reference types to resolve and delete from the
|
|
||||||
/// event_horizon for this event.
|
|
||||||
std::bitset<256> horizon_resolve {event_refs_all};
|
|
||||||
|
|
||||||
/// Whether the present state table `room_state` should be updated by
|
|
||||||
/// this operation if appropriate.
|
|
||||||
bool present {true};
|
|
||||||
|
|
||||||
/// Whether the history state btree `state_node` + `room_events` value
|
|
||||||
/// should be updated by this operation if appropriate.
|
|
||||||
bool history {false};
|
|
||||||
|
|
||||||
/// Whether the event.source can be used directly for event_json. Defaults
|
|
||||||
/// to false unless the caller wants to avoid a redundant re-stringify.
|
|
||||||
bool json_source {false};
|
|
||||||
|
|
||||||
/// Data in this db::txn is used as a primary source in some cases where
|
|
||||||
/// indexers make a database query. This is useful when the sought data
|
|
||||||
/// has not even been written to the database, and this may even point to
|
|
||||||
/// the same db::txn as the result being composed in the first place. By
|
|
||||||
/// default a database query is made as a fallback after using this.
|
|
||||||
const db::txn *interpose {nullptr};
|
|
||||||
|
|
||||||
/// Whether indexers are allowed to make database queries when composing
|
|
||||||
/// the transaction. note: database queries may yield the ircd::ctx and
|
|
||||||
/// made indepdently; this is slow and requires external synchronization
|
|
||||||
/// to not introduce inconsistent data into the txn.
|
|
||||||
bool allow_queries {true};
|
|
||||||
|
|
||||||
/// Setting to true allows the event_idx to be 0 which allows the insertion
|
|
||||||
/// of the event_id into a "blacklist" to mark it as unprocessable; this
|
|
||||||
/// prevents the server from repeatedly trying to process an event.
|
|
||||||
///
|
|
||||||
/// Note for now this just creates an entry in _event_idx of 0 for the
|
|
||||||
/// event_id which also means "not found" for most codepaths, a reasonable
|
|
||||||
/// default. But for codepaths that must distinguish between "not found"
|
|
||||||
/// and "blacklist" they must know that `event_id => 0` was *found* to be
|
|
||||||
/// zero.
|
|
||||||
bool blacklist {false};
|
|
||||||
};
|
|
||||||
Loading…
Reference in a new issue