ursula-runtime 0.4.0

Per-core actor runtime for Ursula: hot ring, cold-tier flush, and the replaceable group-engine boundary.
Documentation 
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

//! Per-core actor runtime for Ursula.
//!
//! Module map:
//!
//! - [`cold_store`]: opendal-backed cold tier handle and object path helpers.
//! - [`request`]: HTTP/gRPC request and response value types for each engine op.
//! - [`command`]: the replicated [`GroupWriteCommand`] envelope around the
//!   canonical [`ursula_stream::StreamCommand`], plus `From` conversions from
//!   request values into that command.
//! - [`error`]: runtime-level error type [`RuntimeError`].
//! - [`engine`]: the `GroupEngine` trait, factory, metrics, and the boxed-future
//!   type aliases that form the replaceable per-group engine boundary, plus the
//!   in-memory implementation under [`engine::in_memory`].
//! - [`runtime`]: `ShardRuntime`, `RuntimeConfig`, and per-core worker spawn.
//! - [`core_worker`]: single-thread actor that owns groups for one core.
//! - [`group_actor`]: per-group mailbox actor running inside a core worker.
//! - [`ops`]: declarative manifest of the uniform runtime operations; expands
//!   into the per-operation actor and client plumbing.
//! - [`metrics`]: runtime metrics shared across cores; lock-free counters.

mod admission;
pub mod cold_index;
mod cold_store;
pub mod cold_worker;
mod command;
mod core_worker;
mod engine;

mod error;
mod group_actor;
pub mod journal;
mod metrics;
mod ops;
mod request;
mod rt;
mod runtime;
mod snapshot_store;
mod trace;

pub use admission::RaftUncommittedAdmission;
pub use cold_index::ColdIndexPage;
pub use cold_index::ColdIndexPageCache;
pub use cold_index::ColdIndexPageKey;
pub use cold_index::ColdIndexPageStore;
pub use cold_index::ColdStoreColdIndexPageStore;
pub use cold_index::InMemoryColdIndexPageStore;
pub use cold_index::cold_index_prefix;
pub use cold_index::load_cold_chunks_from_pages;
pub use cold_index::replace_cold_chunk_index_pages;
pub use cold_index::replace_cold_chunk_index_pages_with_rollback;
pub use cold_index::rollback_cold_index_pages;
pub use cold_index::select_cold_chunk_compaction;
pub use cold_index::write_cold_chunk_index_pages;
pub use cold_index::write_external_segment_index_pages;
pub use cold_store::ColdReadCacheParams;
pub use cold_store::ColdStore;
pub use cold_store::ColdStoreEvent;
pub use cold_store::ColdStoreFault;
pub use cold_store::ColdStoreFaultContext;
pub use cold_store::ColdStoreFaultEffect;
pub use cold_store::ColdStoreHandle;
pub use cold_store::ColdStoreInfo;
pub use cold_store::ColdStoreOperation;
pub use cold_store::new_cold_chunk_path;
pub use cold_store::new_external_payload_path;
pub use cold_worker::spawn_cold_compaction_worker_if_configured;
pub use cold_worker::spawn_cold_flush_worker_if_configured;
pub use cold_worker::spawn_cold_gc_worker_if_configured;
pub use command::GroupSnapshot;
pub use command::GroupWriteCommand;
pub use engine::GroupAckColdGcFuture;
pub use engine::GroupAdvanceRetentionFuture;
pub use engine::GroupAppendBatchFuture;
pub use engine::GroupAppendBatchResponse;
pub use engine::GroupAppendFuture;
pub use engine::GroupBootstrapStreamFuture;
pub use engine::GroupBucketUsageFuture;
pub use engine::GroupCloseStreamFuture;
pub use engine::GroupColdHotBacklogFuture;
pub use engine::GroupCompactColdFuture;
pub use engine::GroupCreateStreamFuture;
pub use engine::GroupDeleteSnapshotFuture;
pub use engine::GroupDeleteStreamFuture;
pub use engine::GroupEngine;
pub use engine::GroupEngineCreateFuture;
pub use engine::GroupEngineError;
pub use engine::GroupEngineFactory;
pub use engine::GroupEngineMetrics;
pub use engine::GroupFlushColdFuture;
pub use engine::GroupGetStreamAttrsFuture;
pub use engine::GroupHeadStreamFuture;
pub use engine::GroupImportGroupStateFuture;
pub use engine::GroupInfraError;
pub use engine::GroupInstallSnapshotFuture;
pub use engine::GroupLeaderHint;
pub use engine::GroupPlanColdFlushFuture;
pub use engine::GroupPlanColdGcFuture;
pub use engine::GroupPlanNextColdFlushBatchFuture;
pub use engine::GroupPublishSnapshotFuture;
pub use engine::GroupPurgeBucketFuture;
pub use engine::GroupReadSnapshotFuture;
pub use engine::GroupReadStreamFuture;
pub use engine::GroupReadStreamPartsFuture;
pub use engine::GroupRequireLiveReadOwnerFuture;
pub use engine::GroupSetBucketQuotaFuture;
pub use engine::GroupShutdownFuture;
pub use engine::GroupSnapshotFuture;
pub use engine::GroupTouchStreamAccessFuture;
pub use engine::GroupUpdateStreamAttrsFuture;
pub use engine::GroupWriteBatchFuture;
pub use engine::GroupWriteFuture;
pub use engine::GroupWriteResponse;
pub use engine::in_memory::InMemoryGroupEngine;
pub use engine::in_memory::InMemoryGroupEngineFactory;
pub use error::ErrorStatus;
pub use error::RuntimeError;
pub use metrics::RuntimeMailboxSnapshot;
pub use metrics::RuntimeMetrics;
pub use metrics::RuntimeMetricsSnapshot;
pub use request::AckColdGcResponse;
pub use request::AdvanceRetentionRequest;
pub use request::AdvanceRetentionResponse;
pub use request::AppendBatchRequest;
pub use request::AppendBatchResponse;
pub use request::AppendExternalRequest;
pub use request::AppendRequest;
pub use request::AppendResponse;
pub use request::BootstrapStreamRequest;
pub use request::BootstrapStreamResponse;
pub use request::BootstrapUpdate;
pub use request::CloseStreamRequest;
pub use request::CloseStreamResponse;
pub use request::ColdHotBacklog;
pub use request::ColdWriteAdmission;
pub use request::CompactColdRequest;
pub use request::CompactColdResponse;
pub use request::CreateStreamExternalRequest;
pub use request::CreateStreamRequest;
pub use request::CreateStreamResponse;
pub use request::DeleteSnapshotRequest;
pub use request::DeleteStreamRequest;
pub use request::DeleteStreamResponse;
pub use request::FlushColdRequest;
pub use request::FlushColdResponse;
pub use request::GetStreamAttrsRequest;
pub use request::GetStreamAttrsResponse;
pub use request::GroupReadStreamBody;
pub use request::GroupReadStreamParts;
pub use request::HeadStreamRequest;
pub use request::HeadStreamResponse;
pub use request::ImportGroupStateRequest;
pub use request::ImportGroupStateResponse;
pub use request::PlanColdFlushRequest;
pub use request::PlanGroupColdFlushRequest;
pub use request::PublishSnapshotRequest;
pub use request::PublishSnapshotResponse;
pub use request::PurgeBucketResponse;
pub use request::ReadSnapshotRequest;
pub use request::ReadSnapshotResponse;
pub use request::ReadStreamRequest;
pub use request::ReadStreamResponse;
pub use request::SetBucketQuotaRequest;
pub use request::SetBucketQuotaResponse;
pub use request::StreamAppendCount;
pub use request::TouchStreamAccessResponse;
pub use request::UpdateStreamAttrsRequest;
pub use request::UpdateStreamAttrsResponse;
pub use runtime::PurgeBucketReport;
pub use runtime::RuntimeConfig;
pub use runtime::RuntimeThreading;
pub use runtime::ShardRuntime;
pub use snapshot_store::InlineSnapshotStore;
#[cfg(not(madsim))]
pub use snapshot_store::S3SnapshotStore;
pub use snapshot_store::SharedSnapshotStore;
pub use snapshot_store::SnapshotBytesIterator;
pub use snapshot_store::SnapshotCompression;
pub use snapshot_store::SnapshotKey;
pub use snapshot_store::SnapshotLocation;
pub use snapshot_store::SnapshotPointer;
pub use snapshot_store::SnapshotReferenceConfig;
pub use snapshot_store::SnapshotStore;
pub use snapshot_store::SnapshotStoreError;
pub use snapshot_store::SnapshotStoreFuture;
pub use snapshot_store::default_snapshot_store;
pub use snapshot_store::snapshot_store_from_config;
pub use ursula_config::config::ColdConfig;
pub use ursula_stream::ColdChunkRef;
pub use ursula_stream::ColdFlushCandidate;
pub use ursula_stream::ColdGcEntry;
pub use ursula_stream::ColdGcTarget;
pub use ursula_stream::ExternalPayloadRef;
pub use ursula_stream::ProducerRequest;
pub use ursula_stream::StreamAttrs;
pub use ursula_stream::StreamErrorCode;
pub use ursula_stream::StreamErrorContext;
pub use ursula_stream::StreamIntegritySnapshot;
pub use ursula_stream::StreamRecordRange;
pub use ursula_stream::StreamSnapshot;

#[cfg(test)]
mod tests;