Files
@ 890f6ae420c2
Branch filter:
Location: CSY/reowolf/src/runtime/mod.rs
890f6ae420c2
20.1 KiB
application/rls-services+xml
added example cases to mirror the presentation examples 1-5
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 | /// cbindgen:ignore
mod communication;
/// cbindgen:ignore
mod endpoints;
pub mod error;
/// cbindgen:ignore
mod logging;
/// cbindgen:ignore
mod setup;
#[cfg(test)]
mod tests;
use crate::common::*;
use error::*;
use mio::net::UdpSocket;
#[derive(Debug)]
pub struct Connector {
unphased: ConnectorUnphased,
phased: ConnectorPhased,
}
pub trait Logger: Debug {
fn line_writer(&mut self) -> Option<&mut dyn std::io::Write>;
}
#[derive(Debug)]
pub struct VecLogger(ConnectorId, Vec<u8>);
#[derive(Debug)]
pub struct DummyLogger;
#[derive(Debug)]
pub struct FileLogger(ConnectorId, std::fs::File);
pub(crate) struct NonsyncProtoContext<'a> {
logger: &'a mut dyn Logger,
proto_component_id: ProtoComponentId,
port_info: &'a mut PortInfo,
id_manager: &'a mut IdManager,
proto_component_ports: &'a mut HashSet<PortId>,
unrun_components: &'a mut Vec<(ProtoComponentId, ProtoComponent)>,
}
pub(crate) struct SyncProtoContext<'a> {
logger: &'a mut dyn Logger,
untaken_choice: &'a mut Option<u16>,
predicate: &'a Predicate,
port_info: &'a PortInfo,
inbox: &'a HashMap<PortId, Payload>,
}
#[derive(
Copy, Clone, Eq, PartialEq, Ord, Hash, PartialOrd, serde::Serialize, serde::Deserialize,
)]
struct SpecVar(PortId);
#[derive(
Copy, Clone, Eq, PartialEq, Ord, Hash, PartialOrd, serde::Serialize, serde::Deserialize,
)]
struct SpecVal(u16);
#[derive(Debug)]
struct RoundOk {
batch_index: usize,
gotten: HashMap<PortId, Payload>,
}
#[derive(Default)]
struct VecSet<T: std::cmp::Ord> {
// invariant: ordered, deduplicated
vec: Vec<T>,
}
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash, serde::Serialize, serde::Deserialize)]
enum ComponentId {
Native,
Proto(ProtoComponentId),
}
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash, serde::Serialize, serde::Deserialize)]
enum Route {
LocalComponent(ComponentId),
NetEndpoint { index: usize },
UdpEndpoint { index: usize },
}
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash, serde::Serialize, serde::Deserialize)]
enum SubtreeId {
LocalComponent(ComponentId),
NetEndpoint { index: usize },
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
struct MyPortInfo {
polarity: Polarity,
port: PortId,
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
enum Decision {
Failure,
Success(Predicate),
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
enum Msg {
SetupMsg(SetupMsg),
CommMsg(CommMsg),
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
enum SetupMsg {
MyPortInfo(MyPortInfo),
LeaderWave { wave_leader: ConnectorId },
LeaderAnnounce { tree_leader: ConnectorId },
YouAreMyParent,
SessionGather { unoptimized_map: HashMap<ConnectorId, SessionInfo> },
SessionScatter { optimized_map: HashMap<ConnectorId, SessionInfo> },
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
struct SessionInfo {
serde_proto_description: SerdeProtocolDescription,
port_info: PortInfo,
endpoint_incoming_to_getter: Vec<PortId>,
proto_components: HashMap<ProtoComponentId, ProtoComponent>,
}
#[derive(Debug, Clone)]
struct SerdeProtocolDescription(Arc<ProtocolDescription>);
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
struct CommMsg {
round_index: usize,
contents: CommMsgContents,
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
enum CommMsgContents {
SendPayload(SendPayloadMsg),
CommCtrl(CommCtrlMsg),
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
enum CommCtrlMsg {
Suggest { suggestion: Decision }, // SINKWARD
Announce { decision: Decision }, // SINKAWAYS
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
struct SendPayloadMsg {
predicate: Predicate,
payload: Payload,
}
#[derive(Debug, PartialEq)]
enum AssignmentUnionResult {
FormerNotLatter,
LatterNotFormer,
Equivalent,
New(Predicate),
Nonexistant,
}
struct NetEndpoint {
inbox: Vec<u8>,
stream: TcpStream,
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct ProtoComponent {
state: ComponentState,
ports: HashSet<PortId>,
}
#[derive(Debug, Clone)]
struct NetEndpointSetup {
getter_for_incoming: PortId,
sock_addr: SocketAddr,
endpoint_polarity: EndpointPolarity,
}
#[derive(Debug, Clone)]
struct UdpEndpointSetup {
getter_for_incoming: PortId,
local_addr: SocketAddr,
peer_addr: SocketAddr,
}
#[derive(Debug)]
struct NetEndpointExt {
net_endpoint: NetEndpoint,
getter_for_incoming: PortId,
}
#[derive(Debug)]
struct Neighborhood {
parent: Option<usize>,
children: VecSet<usize>,
}
#[derive(Debug)]
struct IdManager {
connector_id: ConnectorId,
port_suffix_stream: U32Stream,
proto_component_suffix_stream: U32Stream,
}
#[derive(Debug)]
struct UdpInBuffer {
byte_vec: Vec<u8>,
}
#[derive(Debug)]
struct SpecVarStream {
connector_id: ConnectorId,
port_suffix_stream: U32Stream,
}
#[derive(Debug)]
struct EndpointManager {
// invariants:
// 1. net and udp endpoints are registered with poll. Poll token computed with TargetToken::into
// 2. Events is empty
poll: Poll,
events: Events,
delayed_messages: Vec<(usize, Msg)>,
undelayed_messages: Vec<(usize, Msg)>,
net_endpoint_store: EndpointStore<NetEndpointExt>,
udp_endpoint_store: EndpointStore<UdpEndpointExt>,
udp_in_buffer: UdpInBuffer,
}
#[derive(Debug)]
struct EndpointStore<T> {
endpoint_exts: Vec<T>,
polled_undrained: VecSet<usize>,
}
#[derive(Debug)]
struct UdpEndpointExt {
sock: UdpSocket, // already bound and connected
outgoing_payloads: HashMap<Predicate, Payload>,
incoming_round_spec_var: Option<SpecVar>,
getter_for_incoming: PortId,
incoming_payloads: Vec<Payload>,
}
#[derive(Clone, Debug, Default, serde::Serialize, serde::Deserialize)]
struct PortInfo {
polarities: HashMap<PortId, Polarity>,
peers: HashMap<PortId, PortId>,
routes: HashMap<PortId, Route>,
}
#[derive(Debug)]
struct ConnectorCommunication {
round_index: usize,
endpoint_manager: EndpointManager,
neighborhood: Neighborhood,
native_batches: Vec<NativeBatch>,
round_result: Result<Option<RoundOk>, SyncError>,
}
#[derive(Debug)]
struct ConnectorUnphased {
proto_description: Arc<ProtocolDescription>,
proto_components: HashMap<ProtoComponentId, ProtoComponent>,
logger: Box<dyn Logger>,
id_manager: IdManager,
native_ports: HashSet<PortId>,
port_info: PortInfo,
}
#[derive(Debug)]
struct ConnectorSetup {
net_endpoint_setups: Vec<NetEndpointSetup>,
udp_endpoint_setups: Vec<UdpEndpointSetup>,
surplus_sockets: u16,
}
#[derive(Debug)]
enum ConnectorPhased {
Setup(Box<ConnectorSetup>),
Communication(Box<ConnectorCommunication>),
}
#[derive(Default, Clone, Eq, PartialEq, Hash, serde::Serialize, serde::Deserialize)]
struct Predicate {
assigned: BTreeMap<SpecVar, SpecVal>,
}
#[derive(Debug, Default)]
struct NativeBatch {
// invariant: putters' and getters' polarities respected
to_put: HashMap<PortId, Payload>,
to_get: HashSet<PortId>,
}
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
enum TokenTarget {
NetEndpoint { index: usize },
UdpEndpoint { index: usize },
Waker,
}
trait RoundCtxTrait {
fn get_deadline(&self) -> &Option<Instant>;
fn getter_add(&mut self, getter: PortId, msg: SendPayloadMsg);
}
enum CommRecvOk {
TimeoutWithoutNew,
NewPayloadMsgs,
NewControlMsg { net_index: usize, msg: CommCtrlMsg },
}
////////////////
fn would_block(err: &std::io::Error) -> bool {
err.kind() == std::io::ErrorKind::WouldBlock
}
impl TokenTarget {
const HALFWAY_INDEX: usize = usize::MAX / 2;
const MAX_INDEX: usize = usize::MAX;
const WAKER_TOKEN: usize = Self::MAX_INDEX;
}
impl From<Token> for TokenTarget {
fn from(Token(index): Token) -> Self {
if index == Self::WAKER_TOKEN {
TokenTarget::Waker
} else if let Some(shifted) = index.checked_sub(Self::HALFWAY_INDEX) {
TokenTarget::UdpEndpoint { index: shifted }
} else {
TokenTarget::NetEndpoint { index }
}
}
}
impl Into<Token> for TokenTarget {
fn into(self) -> Token {
match self {
TokenTarget::Waker => Token(Self::WAKER_TOKEN),
TokenTarget::UdpEndpoint { index } => Token(index + Self::HALFWAY_INDEX),
TokenTarget::NetEndpoint { index } => Token(index),
}
}
}
impl<T: std::cmp::Ord> VecSet<T> {
fn new(mut vec: Vec<T>) -> Self {
vec.sort();
vec.dedup();
Self { vec }
}
fn contains(&self, element: &T) -> bool {
self.vec.binary_search(element).is_ok()
}
fn insert(&mut self, element: T) -> bool {
match self.vec.binary_search(&element) {
Ok(_) => false,
Err(index) => {
self.vec.insert(index, element);
true
}
}
}
fn iter(&self) -> std::slice::Iter<T> {
self.vec.iter()
}
fn pop(&mut self) -> Option<T> {
self.vec.pop()
}
}
impl PortInfo {
fn spec_var_for(&self, port: PortId) -> SpecVar {
SpecVar(match self.polarities.get(&port).unwrap() {
Getter => port,
Putter => *self.peers.get(&port).unwrap(),
})
}
}
impl SpecVarStream {
fn next(&mut self) -> SpecVar {
let phantom_port: PortId =
Id { connector_id: self.connector_id, u32_suffix: self.port_suffix_stream.next() }
.into();
SpecVar(phantom_port)
}
}
impl IdManager {
fn new(connector_id: ConnectorId) -> Self {
Self {
connector_id,
port_suffix_stream: Default::default(),
proto_component_suffix_stream: Default::default(),
}
}
fn new_spec_var_stream(&self) -> SpecVarStream {
let mut port_suffix_stream = self.port_suffix_stream.clone();
const JUMP_OVER: usize = 100; // Jumping is entirely unnecessary. It's only used to make spec vars easier to spot in logs
for _ in 0..JUMP_OVER {
port_suffix_stream.next(); // throw away an ID
}
SpecVarStream { connector_id: self.connector_id, port_suffix_stream }
}
fn new_port_id(&mut self) -> PortId {
Id { connector_id: self.connector_id, u32_suffix: self.port_suffix_stream.next() }.into()
}
fn new_proto_component_id(&mut self) -> ProtoComponentId {
Id {
connector_id: self.connector_id,
u32_suffix: self.proto_component_suffix_stream.next(),
}
.into()
}
}
impl Drop for Connector {
fn drop(&mut self) {
log!(&mut *self.unphased.logger, "Connector dropping. Goodbye!");
}
}
impl Connector {
pub(crate) fn random_id() -> ConnectorId {
type Bytes8 = [u8; std::mem::size_of::<ConnectorId>()];
unsafe {
let mut bytes = std::mem::MaybeUninit::<Bytes8>::uninit();
// getrandom is the canonical crate for a small, secure rng
getrandom::getrandom(&mut *bytes.as_mut_ptr()).unwrap();
// safe! representations of all valid Byte8 values are valid ConnectorId values
std::mem::transmute::<_, _>(bytes.assume_init())
}
}
pub fn swap_logger(&mut self, mut new_logger: Box<dyn Logger>) -> Box<dyn Logger> {
std::mem::swap(&mut self.unphased.logger, &mut new_logger);
new_logger
}
pub fn get_logger(&mut self) -> &mut dyn Logger {
&mut *self.unphased.logger
}
pub fn new_port_pair(&mut self) -> [PortId; 2] {
let cu = &mut self.unphased;
// adds two new associated ports, related to each other, and exposed to the native
let [o, i] = [cu.id_manager.new_port_id(), cu.id_manager.new_port_id()];
cu.native_ports.insert(o);
cu.native_ports.insert(i);
// {polarity, peer, route} known. {} unknown.
cu.port_info.polarities.insert(o, Putter);
cu.port_info.polarities.insert(i, Getter);
cu.port_info.peers.insert(o, i);
cu.port_info.peers.insert(i, o);
let route = Route::LocalComponent(ComponentId::Native);
cu.port_info.routes.insert(o, route);
cu.port_info.routes.insert(i, route);
log!(cu.logger, "Added port pair (out->in) {:?} -> {:?}", o, i);
[o, i]
}
pub fn add_component(
&mut self,
identifier: &[u8],
ports: &[PortId],
) -> Result<(), AddComponentError> {
// called by the USER. moves ports owned by the NATIVE
use AddComponentError as Ace;
// 1. check if this is OK
let cu = &mut self.unphased;
let polarities = cu.proto_description.component_polarities(identifier)?;
if polarities.len() != ports.len() {
return Err(Ace::WrongNumberOfParamaters { expected: polarities.len() });
}
for (&expected_polarity, port) in polarities.iter().zip(ports.iter()) {
if !cu.native_ports.contains(port) {
return Err(Ace::UnknownPort(*port));
}
if expected_polarity != *cu.port_info.polarities.get(port).unwrap() {
return Err(Ace::WrongPortPolarity { port: *port, expected_polarity });
}
}
// 3. remove ports from old component & update port->route
let new_id = cu.id_manager.new_proto_component_id();
for port in ports.iter() {
cu.port_info.routes.insert(*port, Route::LocalComponent(ComponentId::Proto(new_id)));
}
cu.native_ports.retain(|port| !ports.contains(port));
// 4. add new component
cu.proto_components.insert(
new_id,
ProtoComponent {
state: cu.proto_description.new_main_component(identifier, ports),
ports: ports.iter().copied().collect(),
},
);
Ok(())
}
}
impl Predicate {
#[inline]
pub fn inserted(mut self, k: SpecVar, v: SpecVal) -> Self {
self.assigned.insert(k, v);
self
}
pub fn assigns_subset(&self, maybe_superset: &Self) -> bool {
for (var, val) in self.assigned.iter() {
match maybe_superset.assigned.get(var) {
Some(val2) if val2 == val => {}
_ => return false, // var unmapped, or mapped differently
}
}
true
}
// returns true IFF self.unify would return Equivalent OR FormerNotLatter
// pub fn consistent_with(&self, other: &Self) -> bool {
// let [larger, smaller] =
// if self.assigned.len() > other.assigned.len() { [self, other] } else { [other, self] };
// for (var, val) in smaller.assigned.iter() {
// match larger.assigned.get(var) {
// Some(val2) if val2 != val => return false,
// _ => {}
// }
// }
// true
// }
/// Given self and other, two predicates, return the predicate whose
/// assignments are the union of those of self and other.
///
fn assignment_union(&self, other: &Self) -> AssignmentUnionResult {
use AssignmentUnionResult as Aur;
// iterators over assignments of both predicates. Rely on SORTED ordering of BTreeMap's keys.
let [mut s_it, mut o_it] = [self.assigned.iter(), other.assigned.iter()];
let [mut s, mut o] = [s_it.next(), o_it.next()];
// lists of assignments in self but not other and vice versa.
let [mut s_not_o, mut o_not_s] = [vec![], vec![]];
loop {
match [s, o] {
[None, None] => break,
[None, Some(x)] => {
o_not_s.push(x);
o_not_s.extend(o_it);
break;
}
[Some(x), None] => {
s_not_o.push(x);
s_not_o.extend(s_it);
break;
}
[Some((sid, sb)), Some((oid, ob))] => {
if sid < oid {
// o is missing this element
s_not_o.push((sid, sb));
s = s_it.next();
} else if sid > oid {
// s is missing this element
o_not_s.push((oid, ob));
o = o_it.next();
} else if sb != ob {
assert_eq!(sid, oid);
// both predicates assign the variable but differ on the value
return Aur::Nonexistant;
} else {
// both predicates assign the variable to the same value
s = s_it.next();
o = o_it.next();
}
}
}
}
// Observed zero inconsistencies. A unified predicate exists...
match [s_not_o.is_empty(), o_not_s.is_empty()] {
[true, true] => Aur::Equivalent, // ... equivalent to both.
[false, true] => Aur::FormerNotLatter, // ... equivalent to self.
[true, false] => Aur::LatterNotFormer, // ... equivalent to other.
[false, false] => {
// ... which is the union of the predicates' assignments but
// is equivalent to neither self nor other.
let mut new = self.clone();
for (&id, &b) in o_not_s {
new.assigned.insert(id, b);
}
Aur::New(new)
}
}
}
pub fn union_with(&self, other: &Self) -> Option<Self> {
let mut res = self.clone();
for (&channel_id, &assignment_1) in other.assigned.iter() {
match res.assigned.insert(channel_id, assignment_1) {
Some(assignment_2) if assignment_1 != assignment_2 => return None,
_ => {}
}
}
Some(res)
}
pub fn query(&self, var: SpecVar) -> Option<SpecVal> {
self.assigned.get(&var).copied()
}
}
impl<T: Debug + std::cmp::Ord> Debug for VecSet<T> {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
f.debug_set().entries(self.vec.iter()).finish()
}
}
impl Debug for Predicate {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
struct Assignment<'a>((&'a SpecVar, &'a SpecVal));
impl Debug for Assignment<'_> {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(f, "{:?}={:?}", (self.0).0, (self.0).1)
}
}
f.debug_set().entries(self.assigned.iter().map(Assignment)).finish()
}
}
impl serde::Serialize for SerdeProtocolDescription {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let inner: &ProtocolDescription = &self.0;
inner.serialize(serializer)
}
}
impl<'de> serde::Deserialize<'de> for SerdeProtocolDescription {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let inner: ProtocolDescription = ProtocolDescription::deserialize(deserializer)?;
Ok(Self(Arc::new(inner)))
}
}
impl IdParts for SpecVar {
fn id_parts(self) -> (ConnectorId, U32Suffix) {
self.0.id_parts()
}
}
impl Debug for SpecVar {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
let (a, b) = self.id_parts();
write!(f, "v{}_{}", a, b)
}
}
impl SpecVal {
const FIRING: Self = SpecVal(1);
const SILENT: Self = SpecVal(0);
fn is_firing(self) -> bool {
self == Self::FIRING
// all else treated as SILENT
}
fn nth_domain_element(n: usize) -> Self {
let n: u16 = n.try_into().unwrap();
SpecVal(n)
}
fn iter_domain() -> impl Iterator<Item = Self> {
(0..).map(SpecVal)
}
}
impl Debug for SpecVal {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
self.0.fmt(f)
}
}
impl Default for UdpInBuffer {
fn default() -> Self {
let mut byte_vec = Vec::with_capacity(Self::CAPACITY);
unsafe {
// safe! this vector is guaranteed to have sufficient capacity
byte_vec.set_len(Self::CAPACITY);
}
Self { byte_vec }
}
}
impl UdpInBuffer {
const CAPACITY: usize = u16::MAX as usize;
fn as_mut_slice(&mut self) -> &mut [u8] {
self.byte_vec.as_mut_slice()
}
}
|