// Matrix Construct // // Copyright (C) Matrix Construct Developers, Authors & Contributors // Copyright (C) 2016-2018 Jason Volk // // 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_H /// Database Schema /// namespace ircd::m::dbs { struct init; struct write_opts; // General confs extern conf::item events_cache_enable; extern conf::item events_cache_comp_enable; extern conf::item events_mem_write_buffer_size; extern conf::item events_sst_write_buffer_size; // Database instance extern std::shared_ptr events; // Event property columns constexpr const auto event_columns{event::size()}; extern std::array event_column; // Event metadata columns extern db::column event_idx; // event_id => event_idx extern db::column event_json; // event_idx => full json extern db::index event_refs; // event_idx | event_idx extern db::index event_auth; // event_idx | event_idx extern db::index room_head; // room_id | event_id => event_idx extern db::index room_events; // room_id | depth, event_idx => node_id extern db::index room_joined; // room_id | origin, member => event_idx extern db::index room_state; // room_id | type, state_key => event_idx extern db::column state_node; // node_id => state::node // Lowlevel util constexpr size_t EVENT_REFS_KEY_MAX_SIZE {sizeof(event::idx) + sizeof(event::idx)}; string_view event_refs_key(const mutable_buffer &out, const event::idx &tgt, const event::idx &referer); std::tuple event_refs_key(const string_view &amalgam); constexpr size_t EVENT_AUTH_KEY_MAX_SIZE {sizeof(event::idx) + sizeof(event::idx)}; string_view event_auth_key(const mutable_buffer &out, const event::idx &tgt, const event::idx &referer); std::tuple event_auth_key(const string_view &amalgam); constexpr size_t ROOM_HEAD_KEY_MAX_SIZE {id::MAX_SIZE + 1 + id::MAX_SIZE}; string_view room_head_key(const mutable_buffer &out, const id::room &, const id::event &); string_view room_head_key(const string_view &amalgam); constexpr size_t ROOM_STATE_KEY_MAX_SIZE {id::MAX_SIZE + 256 + 256}; string_view room_state_key(const mutable_buffer &out, const id::room &, const string_view &type, const string_view &state_key); string_view room_state_key(const mutable_buffer &out, const id::room &, const string_view &type); std::pair room_state_key(const string_view &amalgam); constexpr size_t ROOM_JOINED_KEY_MAX_SIZE {id::MAX_SIZE + 256 + id::MAX_SIZE}; string_view room_joined_key(const mutable_buffer &out, const id::room &, const string_view &origin, const id::user &member); string_view room_joined_key(const mutable_buffer &out, const id::room &, const string_view &origin); std::pair room_joined_key(const string_view &amalgam); constexpr size_t ROOM_EVENTS_KEY_MAX_SIZE {id::MAX_SIZE + 1 + 8 + 8}; string_view room_events_key(const mutable_buffer &out, const id::room &, const uint64_t &depth, const event::idx &); string_view room_events_key(const mutable_buffer &out, const id::room &, const uint64_t &depth); std::pair room_events_key(const string_view &amalgam); // [GET] the state root for an event (with as much information as you have) string_view state_root(const mutable_buffer &out, const id::room &, const event::idx &, const uint64_t &depth); string_view state_root(const mutable_buffer &out, const id::room &, const event::id &, const uint64_t &depth); string_view state_root(const mutable_buffer &out, const id::room &, const event::idx &); string_view state_root(const mutable_buffer &out, const id::room &, const event::id &); string_view state_root(const mutable_buffer &out, const event::idx &); string_view state_root(const mutable_buffer &out, const event::id &); string_view state_root(const mutable_buffer &out, const event &); // [SET (txn)] Basic write suite string_view write(db::txn &, const event &, const write_opts &); void blacklist(db::txn &, const event::id &, const write_opts &); } struct ircd::m::dbs::write_opts { uint64_t event_idx {0}; string_view root_in; mutable_buffer root_out; db::op op {db::op::SET}; bool present {true}; bool history {true}; bool room_head {true}; bool room_refs {true}; bool event_id {true}; bool event_refs {true}; bool event_auth {true}; bool json_source {false}; }; /// Database Schema Descriptors /// namespace ircd::m::dbs::desc { // Full description extern const db::description events; // // Direct columns // extern conf::item events___event__bloom__bits; extern conf::item events__content__block__size; extern conf::item events__content__meta_block__size; extern conf::item events__content__cache__size; extern conf::item events__content__cache_comp__size; extern const db::descriptor events_content; extern conf::item events__depth__block__size; extern conf::item events__depth__meta_block__size; extern conf::item events__depth__cache__size; extern conf::item events__depth__cache_comp__size; extern const db::descriptor events_depth; extern conf::item events__event_id__block__size; extern conf::item events__event_id__meta_block__size; extern conf::item events__event_id__cache__size; extern conf::item events__event_id__cache_comp__size; extern const db::descriptor events_event_id; extern conf::item events__origin_server_ts__block__size; extern conf::item events__origin_server_ts__meta_block__size; extern conf::item events__origin_server_ts__cache__size; extern conf::item events__origin_server_ts__cache_comp__size; extern const db::descriptor events_origin_server_ts; extern conf::item events__prev_events__block__size; extern conf::item events__prev_events__meta_block__size; extern conf::item events__prev_events__cache__size; extern conf::item events__prev_events__cache_comp__size; extern const db::descriptor events_prev_events; extern conf::item events__room_id__block__size; extern conf::item events__room_id__meta_block__size; extern conf::item events__room_id__cache__size; extern conf::item events__room_id__cache_comp__size; extern const db::descriptor events_room_id; extern conf::item events__sender__block__size; extern conf::item events__sender__meta_block__size; extern conf::item events__sender__cache__size; extern conf::item events__sender__cache_comp__size; extern const db::descriptor events_sender; extern conf::item events__state_key__block__size; extern conf::item events__state_key__meta_block__size; extern conf::item events__state_key__cache__size; extern conf::item events__state_key__cache_comp__size; extern const db::descriptor events_state_key; extern conf::item events__type__block__size; extern conf::item events__type__meta_block__size; extern conf::item events__type__cache__size; extern conf::item events__type__cache_comp__size; extern const db::descriptor events_type; // // Metadata columns // // events index extern conf::item events__event_idx__block__size; extern conf::item events__event_idx__meta_block__size; extern conf::item events__event_idx__cache__size; extern conf::item events__event_idx__cache_comp__size; extern conf::item events__event_idx__bloom__bits; extern const db::descriptor events__event_idx; // events cache extern conf::item events__event_json__block__size; extern conf::item events__event_json__meta_block__size; extern conf::item events__event_json__cache__size; extern conf::item events__event_json__cache_comp__size; extern conf::item events__event_json__bloom__bits; extern const db::descriptor events__event_json; // events graph extern conf::item events__event_refs__block__size; extern conf::item events__event_refs__meta_block__size; extern conf::item events__event_refs__cache__size; extern conf::item events__event_refs__cache_comp__size; extern conf::item events__event_refs__bloom__bits; extern const db::prefix_transform events__event_refs__pfx; extern const db::comparator events__event_refs__cmp; extern const db::descriptor events__event_refs; // events auth extern conf::item events__event_auth__block__size; extern conf::item events__event_auth__meta_block__size; extern conf::item events__event_auth__cache__size; extern conf::item events__event_auth__cache_comp__size; extern conf::item events__event_auth__bloom__bits; extern const db::prefix_transform events__event_auth__pfx; extern const db::comparator events__event_auth__cmp; extern const db::descriptor events__event_auth; // room head mapping sequence extern conf::item events__room_head__block__size; extern conf::item events__room_head__meta_block__size; extern conf::item events__room_head__cache__size; extern const db::prefix_transform events__room_head__pfx; extern const db::descriptor events__room_head; // room events sequence extern conf::item events__room_events__block__size; extern conf::item events__room_events__meta_block__size; extern conf::item events__room_events__cache__size; extern conf::item events__room_events__cache_comp__size; extern const db::prefix_transform events__room_events__pfx; extern const db::comparator events__room_events__cmp; extern const db::descriptor events__room_events; // room present joined members sequence extern conf::item events__room_joined__block__size; extern conf::item events__room_joined__meta_block__size; extern conf::item events__room_joined__cache__size; extern conf::item events__room_joined__cache_comp__size; extern conf::item events__room_joined__bloom__bits; extern const db::prefix_transform events__room_joined__pfx; extern const db::descriptor events__room_joined; // room present state mapping sequence extern conf::item events__room_state__block__size; extern conf::item events__room_state__meta_block__size; extern conf::item events__room_state__cache__size; extern conf::item events__room_state__cache_comp__size; extern conf::item events__room_state__bloom__bits; extern const db::prefix_transform events__room_state__pfx; extern const db::descriptor events__room_state; // state btree node key-value store extern conf::item events__state_node__block__size; extern conf::item events__state_node__meta_block__size; extern conf::item events__state_node__cache__size; extern conf::item events__state_node__cache_comp__size; extern conf::item events__state_node__bloom__bits; extern const db::descriptor events__state_node; } // Internal interface; not for public. 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(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_refs(db::txn &, const event &, const write_opts &); void _index_event_auth(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 &); void _append_json(db::txn &, const event &, const write_opts &); void _append_cols(db::txn &, const event &, const write_opts &); } struct ircd::m::dbs::init { init(std::string dbopts = {}); ~init() noexcept; };