0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-26 08:42:34 +01:00
construct/include/ircd/m/dbs/event_refs.h

92 lines
2.7 KiB
C++

// 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_EVENT_REFS_H
namespace ircd::m::dbs
{
constexpr size_t EVENT_REFS_KEY_MAX_SIZE
{
sizeof(event::idx) + sizeof(event::idx)
};
constexpr size_t ref_shift
{
8 * (sizeof(event::idx) - sizeof(ref))
};
constexpr event::idx ref_mask
{
0xFFUL << ref_shift
};
// event_idx | ref_type, event_idx
extern db::domain event_refs;
string_view
event_refs_key(const mutable_buffer &out,
const event::idx &tgt,
const ref &type,
const event::idx &referer);
std::tuple<ref, event::idx>
event_refs_key(const string_view &amalgam);
string_view
reflect(const ref &);
}
namespace ircd::m::dbs::desc
{
extern conf::item<size_t> events__event_refs__block__size;
extern conf::item<size_t> events__event_refs__meta_block__size;
extern conf::item<size_t> events__event_refs__cache__size;
extern conf::item<size_t> events__event_refs__cache_comp__size;
extern const db::prefix_transform events__event_refs__pfx;
extern const db::comparator events__event_refs__cmp;
extern const db::descriptor events__event_refs;
}
/// Types of references indexed by event_refs. This is a single byte integer,
/// which should be plenty of namespace. Internally event_refs_key() and
/// event_refs store this in a high order byte of an event::idx integer. This
/// is an alternative to having separate columns for each type of reference.
///
/// NOTE: These values are written to the database and cannot be changed to
/// maintain ABI stability.
///
/// NOTE: These values not bit-flags and the entire integer space is in use.
///
enum class ircd::m::dbs::ref
:uint8_t
{
/// All events which reference this event in their `prev_events`.
NEXT = 0x00,
/// All power events which reference this event in their `auth_events`.
/// Non-auth/non-power events are not involved in this graph at all.
NEXT_AUTH = 0x01,
/// The next states in the transitions for a (type,state_key) cell.
NEXT_STATE = 0x02,
/// The previous states in the transitions for a (type,state_key) cell.
PREV_STATE = 0x04,
/// All m.receipt's which target this event.
M_RECEIPT__M_READ = 0x10,
/// All m.relates_to's which target this event.
M_RELATES = 0x20,
/// All m.room.redaction's which target this event.
M_ROOM_REDACTION = 0x40,
};