ursula_runtime/
lib.rs

1//! Per-core actor runtime for Ursula.
2//!
3//! Module map:
4//!
5//! - [`cold_store`]: opendal-backed cold tier handle and object path helpers.
6//! - [`request`]: HTTP/gRPC request and response value types for each engine op.
7//! - [`command`]: the replicated [`GroupWriteCommand`] envelope around the
8//!   canonical [`ursula_stream::StreamCommand`], plus `From` conversions from
9//!   request values into that command.
10//! - [`error`]: runtime-level error type [`RuntimeError`].
11//! - [`engine`]: the `GroupEngine` trait, factory, metrics, and the boxed-future
12//!   type aliases that form the replaceable per-group engine boundary, plus the
13//!   in-memory implementation under [`engine::in_memory`].
14//! - [`runtime`]: `ShardRuntime`, `RuntimeConfig`, and per-core worker spawn.
15//! - [`core_worker`]: single-thread actor that owns groups for one core.
16//! - [`group_actor`]: per-group mailbox actor running inside a core worker.
17//! - [`ops`]: declarative manifest of the uniform runtime operations; expands
18//!   into the per-operation actor and client plumbing.
19//! - [`metrics`]: runtime metrics shared across cores; lock-free counters.
20
21mod admission;
22pub mod cold_index;
23mod cold_store;
24pub mod cold_worker;
25mod command;
26mod core_worker;
27mod engine;
28
29mod error;
30mod group_actor;
31pub mod journal;
32mod metrics;
33mod ops;
34mod request;
35mod rt;
36mod runtime;
37mod snapshot_store;
38mod trace;
39
40pub use admission::RaftUncommittedAdmission;
41pub use cold_index::ColdIndexPage;
42pub use cold_index::ColdIndexPageCache;
43pub use cold_index::ColdIndexPageKey;
44pub use cold_index::ColdIndexPageStore;
45pub use cold_index::ColdStoreColdIndexPageStore;
46pub use cold_index::InMemoryColdIndexPageStore;
47pub use cold_index::cold_index_prefix;
48pub use cold_index::load_cold_chunks_from_pages;
49pub use cold_index::replace_cold_chunk_index_pages;
50pub use cold_index::replace_cold_chunk_index_pages_with_rollback;
51pub use cold_index::rollback_cold_index_pages;
52pub use cold_index::select_cold_chunk_compaction;
53pub use cold_index::write_cold_chunk_index_pages;
54pub use cold_index::write_external_segment_index_pages;
55pub use cold_store::ColdReadCacheParams;
56pub use cold_store::ColdStore;
57pub use cold_store::ColdStoreEvent;
58pub use cold_store::ColdStoreFault;
59pub use cold_store::ColdStoreFaultContext;
60pub use cold_store::ColdStoreFaultEffect;
61pub use cold_store::ColdStoreHandle;
62pub use cold_store::ColdStoreInfo;
63pub use cold_store::ColdStoreOperation;
64pub use cold_store::cold_bucket_prefix;
65pub use cold_store::new_cold_chunk_path;
66pub use cold_store::new_external_payload_path;
67pub use cold_worker::spawn_cold_compaction_worker_if_configured;
68pub use cold_worker::spawn_cold_flush_worker_if_configured;
69pub use cold_worker::spawn_cold_gc_worker_if_configured;
70pub use command::GroupSnapshot;
71pub use command::GroupWriteCommand;
72pub use engine::GroupAckColdGcFuture;
73pub use engine::GroupAdvanceRetentionFuture;
74pub use engine::GroupAppendBatchFuture;
75pub use engine::GroupAppendBatchResponse;
76pub use engine::GroupAppendFuture;
77pub use engine::GroupAppendTransactionFuture;
78pub use engine::GroupBootstrapStreamFuture;
79pub use engine::GroupBucketUsageFuture;
80pub use engine::GroupCloseStreamFuture;
81pub use engine::GroupColdHotBacklogFuture;
82pub use engine::GroupCompactColdFuture;
83pub use engine::GroupCreateStreamFuture;
84pub use engine::GroupDeleteSnapshotFuture;
85pub use engine::GroupDeleteStreamFuture;
86pub use engine::GroupEngine;
87pub use engine::GroupEngineCreateFuture;
88pub use engine::GroupEngineError;
89pub use engine::GroupEngineFactory;
90pub use engine::GroupEngineMetrics;
91pub use engine::GroupFlushColdFuture;
92pub use engine::GroupGetStreamAttrsFuture;
93pub use engine::GroupHeadStreamFuture;
94pub use engine::GroupImportGroupStateFuture;
95pub use engine::GroupInfraError;
96pub use engine::GroupInstallSnapshotFuture;
97pub use engine::GroupLeaderHint;
98pub use engine::GroupPlanColdFlushFuture;
99pub use engine::GroupPlanColdGcFuture;
100pub use engine::GroupPlanNextColdFlushBatchFuture;
101pub use engine::GroupPublishSnapshotFuture;
102pub use engine::GroupPurgeBucketFuture;
103pub use engine::GroupReadSnapshotFuture;
104pub use engine::GroupReadStreamFuture;
105pub use engine::GroupReadStreamPartsFuture;
106pub use engine::GroupRequireLiveReadOwnerFuture;
107pub use engine::GroupSetBucketQuotaFuture;
108pub use engine::GroupShutdownFuture;
109pub use engine::GroupSnapshotFuture;
110pub use engine::GroupTouchStreamAccessFuture;
111pub use engine::GroupUpdateStreamAttrsFuture;
112pub use engine::GroupWriteBatchFuture;
113pub use engine::GroupWriteFuture;
114pub use engine::GroupWriteResponse;
115pub use engine::in_memory::InMemoryGroupEngine;
116pub use engine::in_memory::InMemoryGroupEngineFactory;
117pub use error::ErrorStatus;
118pub use error::RuntimeError;
119pub use metrics::RuntimeMailboxSnapshot;
120pub use metrics::RuntimeMetrics;
121pub use metrics::RuntimeMetricsSnapshot;
122pub use request::AckColdGcResponse;
123pub use request::AdvanceRetentionRequest;
124pub use request::AdvanceRetentionResponse;
125pub use request::AppendBatchRequest;
126pub use request::AppendBatchResponse;
127pub use request::AppendExternalRequest;
128pub use request::AppendRequest;
129pub use request::AppendResponse;
130pub use request::AppendTransactionRequest;
131pub use request::AppendTransactionResponse;
132pub use request::BootstrapStreamRequest;
133pub use request::BootstrapStreamResponse;
134pub use request::BootstrapUpdate;
135pub use request::CloseStreamRequest;
136pub use request::CloseStreamResponse;
137pub use request::ColdHotBacklog;
138pub use request::ColdWriteAdmission;
139pub use request::CompactColdRequest;
140pub use request::CompactColdResponse;
141pub use request::CreateStreamExternalRequest;
142pub use request::CreateStreamRequest;
143pub use request::CreateStreamResponse;
144pub use request::DeleteSnapshotRequest;
145pub use request::DeleteStreamRequest;
146pub use request::DeleteStreamResponse;
147pub use request::FlushColdRequest;
148pub use request::FlushColdResponse;
149pub use request::GetStreamAttrsRequest;
150pub use request::GetStreamAttrsResponse;
151pub use request::GroupReadStreamBody;
152pub use request::GroupReadStreamParts;
153pub use request::HeadStreamRequest;
154pub use request::HeadStreamResponse;
155pub use request::ImportGroupStateRequest;
156pub use request::ImportGroupStateResponse;
157pub use request::PlanColdFlushRequest;
158pub use request::PlanGroupColdFlushRequest;
159pub use request::PublishSnapshotRequest;
160pub use request::PublishSnapshotResponse;
161pub use request::PurgeBucketResponse;
162pub use request::ReadSnapshotRequest;
163pub use request::ReadSnapshotResponse;
164pub use request::ReadStreamRequest;
165pub use request::ReadStreamResponse;
166pub use request::SetBucketQuotaRequest;
167pub use request::SetBucketQuotaResponse;
168pub use request::StreamAppendCount;
169pub use request::TouchStreamAccessResponse;
170pub use request::UpdateStreamAttrsRequest;
171pub use request::UpdateStreamAttrsResponse;
172pub use runtime::PurgeBucketReport;
173pub use runtime::RuntimeConfig;
174pub use runtime::RuntimeThreading;
175pub use runtime::ShardRuntime;
176pub use snapshot_store::InlineSnapshotStore;
177#[cfg(not(madsim))]
178pub use snapshot_store::S3SnapshotStore;
179pub use snapshot_store::SharedSnapshotStore;
180pub use snapshot_store::SnapshotBytesIterator;
181pub use snapshot_store::SnapshotCompression;
182pub use snapshot_store::SnapshotKey;
183pub use snapshot_store::SnapshotLocation;
184pub use snapshot_store::SnapshotPointer;
185pub use snapshot_store::SnapshotReferenceConfig;
186pub use snapshot_store::SnapshotStore;
187pub use snapshot_store::SnapshotStoreError;
188pub use snapshot_store::SnapshotStoreFuture;
189pub use snapshot_store::default_snapshot_store;
190pub use snapshot_store::snapshot_store_from_config;
191pub use ursula_config::config::ColdConfig;
192pub use ursula_stream::COMMITTED_WRITE_UNIT_BYTES;
193pub use ursula_stream::ColdChunkRef;
194pub use ursula_stream::ColdFlushCandidate;
195pub use ursula_stream::ColdGcEntry;
196pub use ursula_stream::ColdGcTarget;
197pub use ursula_stream::ExternalPayloadRef;
198pub use ursula_stream::ProducerRequest;
199pub use ursula_stream::StreamAttrs;
200pub use ursula_stream::StreamErrorCode;
201pub use ursula_stream::StreamErrorContext;
202pub use ursula_stream::StreamIntegritySnapshot;
203pub use ursula_stream::StreamRecordRange;
204pub use ursula_stream::StreamSnapshot;
205
206#[cfg(test)]
207mod tests;
ursula_runtime/lib.rs

ursula_runtime/
lib.rs
