sim_lib_server/
lib.rs

1//! SIM's server library: a loadable lib that serves eval and agents over a
2//! transport. It exposes sites (local, coroutine, pipeline, loop, fabric),
3//! frame routing, REPL drivers, connections, and transports so callers can
4//! request evaluation, stream replies, and run agent loops across the runtime.
5//!
6//! Transports are in-process by default: the default feature set enables no
7//! network surface. The network/HTTP transport is the non-default
8//! `server-net-http` feature and must be opted into explicitly; the various
9//! `trigger-*` features add their respective inbound triggers the same way.
10#![forbid(unsafe_code)]
11#![deny(missing_docs)]
12#![allow(deprecated)]
13
14mod address;
15mod citizen;
16mod cli;
17mod codecio;
18mod connection;
19mod cookbook_web;
20mod cookbook_web_json;
21mod coroutine;
22mod cron;
23mod dispatch;
24mod frame;
25mod helpers;
26#[cfg(feature = "server-net-http")]
27mod http;
28#[cfg(feature = "server-net-http")]
29mod http_client;
30mod isolation;
31mod ops;
32mod ops_lifecycle;
33mod ops_shell;
34mod pool;
35mod realize;
36mod registries;
37mod repl;
38mod router;
39mod runtime;
40mod server;
41mod site;
42mod stream_support;
43mod transport;
44mod trigger;
45mod wasm;
46
47pub use address::ServerAddress;
48pub use citizen::{
49    ServerAddressDescriptor, ServerFrameDescriptor, server_address_class_symbol,
50    server_frame_class_symbol,
51};
52pub use codecio::{decode_frame_payload, encode_frame_payload};
53pub use connection::{Connection, Session};
54pub use cookbook_web::{CookbookWebResponse, CookbookWebState};
55pub use coroutine::{Coroutine, CoroutineStatus};
56pub use frame::{
57    FrameEnvelope, FrameKind, LifecycleCommand, ServerFrame, eval_reply_from_frame,
58    eval_request_from_frame, server_frame_from_reply, server_frame_from_request,
59};
60pub use helpers::parse_duration;
61#[cfg(feature = "server-net-http")]
62pub use http_client::{HttpGetResponse, http_get};
63pub use isolation::{IsolationPolicy, ShareMode};
64pub use realize::{realize as realize_site_fragment, realize_stream_events};
65pub use registries::{
66    AddressResolver, LineDriverFactory, ResolvedAddress, register_address_resolver,
67    register_line_driver,
68};
69pub(crate) use registries::{address_resolvers, line_driver_factories};
70pub use repl::{DriverSpec as ReplDriverSpec, LineDriver, ReplOptions, ReplOutput, run_repl};
71pub use router::FrameRouter;
72pub use runtime::ServerRuntime;
73pub use server::{Server, ServerStatus, ThreadMode};
74pub use sim_cookbook::EmbeddedDir;
75pub use sim_lib_cookbook::CookbookCapabilityProfile;
76pub use site::{
77    CoroutineEvalSite, EvalSite, FabricEvalSite, LocalEvalSite, LoopEvalSite, PipelineEvalSite,
78    Site, SiteKind, StreamSink,
79};
80pub use stream_support::{
81    BufferedStreamSink, StreamHandle, stream_chunk_frame_from_expr, stream_end_frame,
82    stream_frame_from_expr, stream_frame_to_expr, stream_frame_to_value,
83};
84pub use transport::{
85    ConnectionTransport, LocalTransport, LoopbackTransportEndpoint, ServerTransport,
86    TcpServerTransport, connect_transport_site, connect_transport_site_with_loopback,
87    decode_transport_frame, encode_transport_frame, register_loopback_transport_endpoint,
88};
89pub use trigger::TriggerHandle;
90pub use wasm::register_wasm_region;
91
92use crate::isolation::IsolatedEvalSite;
93use cli::{register_server_cli, server_cli_exports};
94use dispatch::{register_server_functions, server_exports};
95use helpers::{
96    connection_arg, coroutine_target_from_value, ensure_installed_codec, keyword, server_arg,
97    server_from_value,
98};
99use ops::{
100    server_cancel_coroutine, server_connect, server_coroutine_status, server_lisp, server_loop,
101    server_notify, server_pipeline, server_realize, server_receive, server_request,
102    server_resume_exprs, server_send, server_start_loop, server_stream, server_stream_next,
103    server_yield,
104};
105use ops_lifecycle::server_start;
106use ops_shell::{server_repl, server_trigger, server_trigger_poll, server_wasm_region};
107use sim_kernel::{
108    AbiVersion, Cx, Lib, LibManifest, LibTarget, Linker, Result, Symbol, Value, Version,
109};
110use stream_support::stream_handle_arg;
111use transport::shutdown_server_transport;
112
113/// The server [`Lib`] implementation, registering the server functions and CLI
114/// surface when loaded into a runtime.
115pub struct ServerLib;
116
117impl Lib for ServerLib {
118    fn manifest(&self) -> LibManifest {
119        LibManifest {
120            id: Symbol::new("server"),
121            version: Version(env!("CARGO_PKG_VERSION").to_owned()),
122            abi: AbiVersion { major: 0, minor: 1 },
123            target: LibTarget::HostRegistered,
124            requires: Vec::new(),
125            capabilities: Vec::new(),
126            exports: {
127                let mut exports = server_exports();
128                exports.extend(server_cli_exports());
129                exports
130            },
131        }
132    }
133
134    fn load(&self, cx: &mut sim_kernel::LoadCx, linker: &mut Linker<'_>) -> Result<()> {
135        register_server_functions(cx, linker)?;
136        register_server_cli(cx, linker)?;
137        Ok(())
138    }
139}
140
141/// Installs the server lib into `cx` exactly once, registering its functions
142/// and CLI exports.
143pub fn install_server_lib(cx: &mut Cx) -> Result<()> {
144    sim_lib_core::install_once(cx, &ServerLib).map(|_| ())
145}
146
147pub(crate) fn symbol_list_value(cx: &mut Cx, symbols: &[Symbol]) -> Result<Value> {
148    cx.factory().list(
149        symbols
150            .iter()
151            .cloned()
152            .map(|symbol| cx.factory().symbol(symbol))
153            .collect::<Result<Vec<_>>>()?,
154    )
155}
156
157/// Cookbook recipes for this lib, embedded at build time.
158pub static RECIPES: sim_cookbook::EmbeddedDir =
159    include!(concat!(env!("OUT_DIR"), "/cookbook_recipes.rs"));
160
161#[cfg(test)]
162mod tests;
sim_lib_server/lib.rs

sim_lib_server/
lib.rs
