CSY/reowolf Changeset - c04f7fea1a62 · Centrum Wiskunde & Informatica (CWI)

Changeset - c04f7fea1a62

Parent rev.

Child rev.

[Not reviewed]

0 7 0

mh - 3 years ago 2022-01-16 13:40:10
contact@maxhenger.nl

WIP: Fixing compile errors

7 files changed with 54 insertions and 52 deletions:

src/runtime2/communication.rs

src/runtime2/component/component_pdl.rs

src/runtime2/component/consensus.rs

src/runtime2/component/control_layer.rs

src/runtime2/scheduler.rs

src/runtime2/store/component.rs

src/runtime2/store/unfair_se_lock.rs

0 comments (0 inline, 0 general)

src/runtime2/communication.rs

➞

Show inline comments

 use crate::protocol::eval::*;
 use super::runtime::*;
 use super::component::*;
 #[derive(Copy, Clone)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub struct PortId(pub u32);
 impl PortId {
     /// This value is not significant, it is chosen to make debugging easier: a
     /// very large port number is more likely to shine a light on bugs.
     pub fn new_invalid() -> Self {
         return Self(u32::MAX);
+    }
+}
 pub struct Peer {
     pub id: CompId,
     pub num_associated_ports: u32,
     pub(crate) handle: CompHandle,
+}
 #[derive(Debug, PartialEq, Eq)]
 pub enum PortKind {
     Putter,
     Getter,
+}
 #[derive(Debug, PartialEq, Eq)]
 pub enum PortState {
     Open,
     Blocked,
     Closed,
+}
 pub struct Port {
     pub self_id: PortId,
     pub peer_id: PortId,
     pub kind: PortKind,
     pub state: PortState,
     pub peer_comp_id: CompId,
+}
 pub struct Channel {
     pub putter_id: PortId,
     pub getter_id: PortId,
+}
 pub struct DataMessage {
     pub data_header: MessageDataHeader,
     pub sync_header: MessageSyncHeader,
     pub content: ValueGroup,
+}
 pub struct MessageSyncHeader {
     pub sync_round: u32,
+}
 pub struct MessageDataHeader {
     pub expected_mapping: Vec<(PortId, u32)>,
     pub new_mapping: u32,
     pub source_port: PortId,
     pub target_port: PortId,
+}
 pub struct ControlMessage {
     pub id: ControlId,
+    pub(crate) id: ControlId,
     pub sender_comp_id: CompId,
     pub target_port_id: Option<PortId>,
     pub content: ControlMessageContent,
+}
 #[derive(Copy, Clone)]
 pub enum ControlMessageContent {
     Ack,
     BlockPort(PortId),
     UnblockPort(PortId),
     ClosePort(PortId),
     PortPeerChangedBlock(PortId),
     PortPeerChangedUnblock(PortId, CompId),
+}
 pub enum Message {
     Data(DataMessage),
     Control(ControlMessage),
+}
 impl Message {
     pub(crate) fn target_port(&self) -> Option<PortId> {
         match self {
             Message::Data(v) =>
                 return Some(v.data_header.target_port),
             Message::Control(v) =>
                 return v.target_port_id,
+        }
+    }
+}

src/runtime2/component/component_pdl.rs

➞

Show inline comments

 use crate::protocol::*;
 use crate::protocol::eval::{
     PortId as EvalPortId, Prompt,
     ValueGroup, Value,
     EvalContinuation, EvalResult, EvalError
 };
 use crate::runtime2::store::QueueDynMpsc;
 use crate::runtime2::runtime::*;
 use crate::runtime2::scheduler::SchedulerCtx;
 use crate::runtime2::communication::*;
 use super::*;
 use super::control_layer::*;
 use super::consensus::Consensus;
 pub enum CompScheduling {
     Immediate,
     Requeue,
     Sleep,
     Exit,
+}
 pub struct CompCtx {
     pub id: CompId,
     pub ports: Vec<Port>,
     pub peers: Vec<Peer>,
     pub messages: Vec<ValueGroup>, // same size as "ports"
     pub port_id_counter: u32,
+}
 impl Default for CompCtx {
     fn default() -> Self {
         return Self{
             id: CompId(0),
             ports: Vec::new(),
             peers: Vec::new(),
             messages: Vec::new(),
             port_id_counter: 0,
+        }
+    }
+}
 impl CompCtx {
     fn take_message(&mut self, port_id: PortId) -> Option<ValueGroup> {
         let port_index = self.get_port_index(port_id).unwrap();
         let old_value = &mut self.messages[port_index];
         if old_value.values.is_empty() {
             return None;
+        }
         // Replace value in array with an empty one
         let mut message = ValueGroup::new_stack(Vec::new());
         std::mem::swap(old_value, &mut message);
         return Some(message);
+    }
     fn create_channel(&mut self) -> Channel {
         let putter_id = PortId(self.take_port_id());
         let getter_id = PortId(self.take_port_id());
         self.ports.push(Port{
             self_id: putter_id,
             peer_id: getter_id,
             kind: PortKind::Putter,
             state: PortState::Open,
             peer_comp_id: self.id,
         });
         self.ports.push(Port{
             self_id: getter_id,
             peer_id: putter_id,
             kind: PortKind::Getter,
             state: PortState::Closed,
             peer_comp_id: self.id,
         });
         return Channel{ putter_id, getter_id };
+    }
     fn get_port(&self, port_id: PortId) -> &Port {
         let index = self.get_port_index(port_id).unwrap();
         return &self.ports[index];
+    }
     pub(crate) fn get_port_mut(&mut self, port_id: PortId) -> &mut Port {
         let index = self.get_port_index(port_id).unwrap();
         return &mut self.ports[index];
+    }
     pub(crate) fn get_port_index(&self, port_id: PortId) -> Option<usize> {
         for (index, port) in self.ports.iter().enumerate() {
             if port.self_id == port_id {
                 return Some(index);
+            }
+        }
         return None;
+    }
     pub(crate) fn get_peer(&self, peer_id: CompId) -> &Peer {
         let index = self.get_peer_index(peer_id).unwrap();
         return &self.peers[index];
+    }
     fn get_peer_mut(&mut self, peer_id: CompId) -> &mut Peer {
         let index = self.get_peer_index(peer_id).unwrap();
         return &mut self.peers[index];
+    }
     pub(crate) fn get_peer_index(&self, peer_id: CompId) -> Option<usize> {
         for (index, peer) in self.peers.iter().enumerate() {
             if peer.id == peer_id {
                 return Some(index);
+            }
+        }
         return None;
+    }
     fn take_port_id(&mut self) -> u32 {
         let port_id = self.port_id_counter;
         self.port_id_counter = self.port_id_counter.wrapping_add(1);
         return port_id;
+    }
+}
 pub enum ExecStmt {
     CreatedChannel((Value, Value)),
     PerformedPut,
     PerformedGet(ValueGroup),
     None,
+}
 impl ExecStmt {
     fn take(&mut self) -> ExecStmt {
         let mut value = ExecStmt::None;
         std::mem::swap(self, &mut value);
         return value;
+    }
     fn is_none(&self) -> bool {
         match self {
             ExecStmt::None => return true,
             _ => return false,
+        }
+    }
+}
 pub struct ExecCtx {
     stmt: ExecStmt,
+}
 impl RunContext for ExecCtx {
     fn performed_put(&mut self, _port: EvalPortId) -> bool {
         match self.stmt.take() {
             ExecStmt::None => return false,
             ExecStmt::PerformedPut => return true,
             _ => unreachable!(),
+        }
+    }
     fn performed_get(&mut self, _port: EvalPortId) -> Option<ValueGroup> {
         match self.stmt.take() {
             ExecStmt::None => return None,
             ExecStmt::PerformedGet(value) => return Some(value),
             _ => unreachable!(),
+        }
+    }
     fn fires(&mut self, _port: EvalPortId) -> Option<Value> {
         todo!("remove fires")
+    }
     fn performed_fork(&mut self) -> Option<bool> {
         todo!("remove fork")
+    }
     fn created_channel(&mut self) -> Option<(Value, Value)> {
         match self.stmt.take() {
             ExecStmt::None => return None,
             ExecStmt::CreatedChannel(ports) => return Some(ports),
             _ => unreachable!(),
+        }
+    }
+}
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub(crate) enum Mode {
     NonSync,
     Sync,
     BlockedGet,
     BlockedPut,
+}
 pub(crate) struct CompPDL {
     pub mode: Mode,
     pub mode_port: PortId, // when blocked on a port
     pub mode_value: ValueGroup, // when blocked on a put
     pub prompt: Prompt,
     pub control: ControlLayer,
     pub consensus: Consensus,
     pub sync_counter: u32,
     pub exec_ctx: ExecCtx,
     // TODO: Temporary field, simulates future plans of having one storage place
     //  reserved per port.
     // Should be same length as the number of ports. Corresponding indices imply
     // message is intended for that port.
     pub inbox_main: Vec<Option<DataMessage>>,
     pub inbox_backup: Vec<DataMessage>,
+}
 impl CompPDL {
     pub(crate) fn new(initial_state: Prompt) -> Self {
     pub(crate) fn new(initial_state: Prompt, num_ports: usize) -> Self {
         let mut inbox_main = Vec::new();
         inbox_main.reserve(num_ports);
         for _ in 0..num_ports {
             inbox_main.push(None);
+        }
         return Self{
             mode: Mode::NonSync,
             mode_port: PortId::new_invalid(),
             mode_value: ValueGroup::default(),
             prompt: initial_state,
             control: ControlLayer::default(),
             consensus: Consensus::new(),
             sync_counter: 0,
             exec_ctx: ExecCtx{
                 stmt: ExecStmt::None,
             },
-            inbox_main: Vec::new(),
             inbox_main,
             inbox_backup: Vec::new(),
+        }
+    }
     pub(crate) fn handle_setup(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx) {
         self.inbox.resize(comp_ctx.ports.len(), None);
+    }
     pub(crate) fn handle_message(&mut self, sched_ctx: &mut SchedulerCtx, comp_ctx: &mut CompCtx, message: Message) {
         if let Some(new_target) = self.control.should_reroute(&message) {
             let target = sched_ctx.runtime.get_component_public(new_target);
             target.inbox.push(message);
             return;
+        }
         match message {
             Message::Data(message) => {
                 self.handle_incoming_data_message(sched_ctx, comp_ctx, message);
             },
             Message::Control(message) => {
-                self.handle_incoming_control_message(sched_ctx, comp_Ctx, message);
+                self.handle_incoming_control_message(sched_ctx, comp_ctx, message);
             },
+        }
+    }
     pub(crate) fn run(&mut self, sched_ctx: &mut SchedulerCtx, comp_ctx: &mut CompCtx) -> Result<CompScheduling, EvalError> {
         use EvalContinuation as EC;
         let run_result = self.execute_prompt(&sched_ctx)?;
         match run_result {
             EC::Stepping => unreachable!(), // execute_prompt runs until this is no longer returned
             EC::BranchInconsistent | EC::NewFork | EC::BlockFires(_) => todo!("remove these"),
             // Results that can be returned in sync mode
             EC::SyncBlockEnd => {
                 debug_assert_eq!(self.mode, Mode::Sync);
                 self.handle_sync_end(sched_ctx, comp_ctx);
                 return Ok(CompScheduling::Immediate);
             },
             EC::BlockGet(port_id) => {
                 debug_assert_eq!(self.mode, Mode::Sync);
-                let port_id = transform_port_id(port_id);
+                let port_id = port_id_from_eval(port_id);
                 if let Some(message) = comp_ctx.take_message(port_id) {
                     // We can immediately receive and continue
                     debug_assert!(self.exec_ctx.stmt.is_none());
                     self.exec_ctx.stmt = ExecStmt::PerformedGet(message);
                     return Ok(CompScheduling::Immediate);
                 } else {
                     // We need to wait
                     self.mode = Mode::BlockedGet;
                     self.mode_port = port_id;
                     return Ok(CompScheduling::Sleep);
+                }
             },
             EC::Put(port_id, value) => {
                 debug_assert_eq!(self.mode, Mode::Sync);
                 let port_id = port_id_from_eval(port_id);
                 let port_info = comp_ctx.get_port(port_id);
                 if port_info.state == PortState::Blocked {
                 } else {
+                }
                 self.send_message_and_wake_up(sched_ctx, comp_ctx, port_id, value);
                 return Ok(CompScheduling::Immediate);
             },
             // Results that can be returned outside of sync mode
             EC::ComponentTerminated => {
                 debug_assert_eq!(self.mode, Mode::NonSync);
                 return Ok(CompScheduling::Exit);
             },
             EC::SyncBlockStart => {
                 debug_assert_eq!(self.mode, Mode::NonSync);
                 self.handle_sync_start(sched_ctx, comp_ctx);
                 return Ok(CompScheduling::Immediate);
             },
             EC::NewComponent(definition_id, monomorph_idx, arguments) => {
                 debug_assert_eq!(self.mode, Mode::NonSync);
                 let mut ports = Vec::new(); // TODO: Optimize
                 let protocol = &sched_ctx.runtime.protocol;
                 find_ports_in_value_group(&arguments, &mut ports);
                 let prompt = Prompt::new(
                     &protocol.types, &protocol.heap,
                     definition_id, monomorph_idx, arguments
                 );
-                self.create_component_and_transfer_ports(sched_ctx, comp_ctx, prompt, &workspace_ports);
+                self.create_component_and_transfer_ports(sched_ctx, comp_ctx, prompt, &ports);
                 return Ok(CompScheduling::Requeue);
             },
             EC::NewChannel => {
                 debug_assert_eq!(self.mode, Mode::NonSync);
                 debug_assert!(self.exec_ctx.stmt.is_none());
                 let channel = comp_ctx.create_channel();
                 self.exec_ctx.stmt = ExecStmt::CreatedChannel((
                     Value::Output(port_id_to_eval(channel.putter_id)),
                     Value::Input(port_id_to_eval(channel.getter_id))
                 ));
                 return Ok(CompScheduling::Immediate);
+            }
+        }
+    }
     fn execute_prompt(&mut self, sched_ctx: &SchedulerCtx) -> EvalResult {
         let mut step_result = EvalContinuation::Stepping;
         while let EvalContinuation::Stepping = step_result {
             step_result = self.prompt.step(
                 &sched_ctx.runtime.protocol.types, &sched_ctx.runtime.protocol.heap,
                 &sched_ctx.runtime.protocol.modules, &mut self.exec_ctx,
             )?;
+        }
         return Ok(step_result)
+    }
     fn handle_sync_start(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx) {
         self.consensus.notify_sync_start(comp_ctx);
         debug_assert_eq!(self.mode, Mode::NonSync);
         self.mode = Mode::Sync;
+    }
     fn handle_sync_end(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx) {
         self.consensus.notify_sync_end();
         debug_assert_eq!(self.mode, Mode::Sync);
         self.mode = Mode::NonSync;
+    }
     fn send_message_and_wake_up(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &CompCtx, source_port_id: PortId, value: ValueGroup) {
         use std::sync::atomic::Ordering;
         let port_info = comp_ctx.get_port(source_port_id);
         let peer_info = comp_ctx.get_peer(port_info.peer_comp_id);
         let annotated_message = self.consensus.annotate_message_data(port_info, value);
         peer_info.handle.inbox.push(Message::Data(annotated_message));
         let should_wake_up = peer_info.handle.sleeping.compare_exchange(
             true, false, Ordering::AcqRel, Ordering::Relaxed
         ).is_ok();
         if should_wake_up {
             let comp_key = unsafe{ peer_info.id.upgrade() };
             sched_ctx.runtime.enqueue_work(comp_key);
+        }
+    }
     fn handle_incoming_data_message(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx, message: DataMessage) {
         // Check if we can insert it directly into the storage associated with
         // the port
         let target_port_id = message.data_header.target_port;
         let port_index = comp_ctx.get_port_index(target_port_id).unwrap();
         if self.inbox_main[port_index].is_none() {
             self.inbox_main[port_index] = Some(message);
             // After direct insertion, check if this component's execution is
             // blocked on receiving a message on that port
             debug_assert_ne!(comp_ctx.ports[port_index].state, PortState::Blocked); // because we could insert directly
-            if self.mode == Mode::BlockedGet && self.mode_port == message.data_header.target_port {
+            if self.mode == Mode::BlockedGet && self.mode_port == target_port_id {
                 // We were indeed blocked
                 self.mode = Mode::Sync;
                 self.mode_port = PortId::new_invalid();
+            }
             return;
+        }
         // The direct inbox is full, so the port will become (or was already) blocked
         let port_info = &mut comp_ctx.ports[port_index];
         debug_assert!(port_info.state == PortState::Open || port_info.state == PortState::Blocked);
         let _peer_comp_id = port_info.peer_comp_id;
         if port_info.state == PortState::Open {
             let (target_comp_id, block_message) =
                 self.control.mark_port_blocked(target_port_id, comp_ctx);
-            debug_assert_eq!(port_info.peer_comp_id, target_comp_id);
+            debug_assert_eq!(_peer_comp_id, target_comp_id);
             let peer = comp_ctx.get_peer(target_comp_id);
             peer.handle.inbox.push(Message::Control(block_message));
             wake_up_if_sleeping(sched_ctx, target_comp_id, &peer.handle);
+        }
         // But we still need to remember the message, so:
         self.inbox_backup.push(message);
+    }
     fn handle_incoming_control_message(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx, message: ControlMessage) {
         match message.content {
             ControlMessageContent::Ack => {
                 let mut to_ack = message.id;
                 loop {
                     let action = self.control.handle_ack(to_ack, sched_ctx, comp_ctx);
                     match action {
                         AckAction::SendMessageAndAck(target_comp, message, new_to_ack) => {
                             // FIX @NoDirectHandle
                             let handle = sched_ctx.runtime.get_component_public(target_comp);
                             handle.inbox.push(Message::Control(message));
                             wake_up_if_sleeping(sched_ctx, target_comp, &handle);
                             to_ack = new_to_ack;
                         },
                         AckAction::ScheduleComponent(to_schedule) => {
                             // FIX @NoDirectHandle
                             let handle = sched_ctx.runtime.get_component_public(to_schedule);
                             wake_up_if_sleeping(sched_ctx, to_schedule, &handle);
                             break;
                         },
                         AckAction::None => {
                             break;
+                        }
+                    }
+                }
             },
             ControlMessageContent::BlockPort(port_id) => {
                 // On of our messages was accepted, but the port should be
                 // blocked.
                 let port_info = comp_ctx.get_port_mut(port_id);
                 debug_assert_eq!(port_info.kind, PortKind::Putter);
                 if port_info.state != PortState::Closed {
                     debug_assert_ne!(port_info.state, PortState::Blocked); // implies unnecessary messages
                     port_info.state = PortState::Blocked;
+                }
             },
             ControlMessageContent::ClosePort(port_id) => {
                 // Request to close the port. We immediately comply and remove
                 // the component handle as well
                 let port_index = comp_ctx.get_port_index(port_id).unwrap();
                 let port_info = &mut comp_ctx.ports[port_index];
                 let peer_comp_id = port_info.peer_comp_id;
                 port_info.state = PortState::Closed;
-                let peer_index = comp_ctx.get_peer_index(port_info.peer_comp_id).unwrap();
                 let peer_index = comp_ctx.get_peer_index(peer_comp_id).unwrap();
                 let peer_info = &mut comp_ctx.peers[peer_index];
                 peer_info.num_associated_ports -= 1;
                 if peer_info.num_associated_ports == 0 {
                     // TODO: @Refactor clean up all these uses of "num_associated_ports"
                     let should_remove = peer_info.handle.decrement_users();
                     if should_remove {
                         let comp_key = unsafe{ peer_info.id.upgrade() };
                         sched_ctx.runtime.destroy_component(comp_key);
+                    }
                     comp_ctx.peers.remove(peer_index);
+                }
+            }
             ControlMessageContent::UnblockPort(port_id) => {
                 // We were previously blocked (or already closed)
                 let port_info = comp_ctx.get_port(port_id);
                 debug_assert_eq!(port_info.kind, PortKind::Putter);
                 debug_assert!(port_info.state == PortState::Blocked || port_info.state == PortState::Closed);
                 if port_info.state == PortState::Blocked {
                     self.unblock_port(sched_ctx, comp_ctx, port_id);
+                }
             },
             ControlMessageContent::PortPeerChangedBlock(port_id) => {
                 // The peer of our port has just changed. So we are asked to
                 // temporarily block the port (while our original recipient is
                 // potentially rerouting some of the in-flight messages) and
                 // Ack. Then we wait for the `unblock` call.
                 debug_assert_eq!(message.target_port_id, port_id);
+                debug_assert_eq!(message.target_port_id, Some(port_id));
                 let port_info = comp_ctx.get_port_mut(port_id);
                 debug_assert!(port_info.state == PortState::Open || port_info.state == PortState::Blocked);
                 if port_info.state == PortState::Open {
                     port_info.state = PortState::Blocked;
+                }
             },
             ControlMessageContent::PortPeerChangedUnblock(port_id, new_comp_id) => {
                 debug_assert_eq!(message.target_port_id, port_id);
+                debug_assert_eq!(message.target_port_id, Some(port_id));
                 let port_info = comp_ctx.get_port_mut(port_id);
                 debug_assert!(port_info.state == PortState::Blocked);
                 port_info.peer_comp_id = new_comp_id;
                 self.unblock_port(sched_ctx, comp_ctx, port_id);
+            }
+        }
+    }
     fn unblock_port(&mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx, port_id: PortId) {
         let port_info = comp_ctx.get_port_mut(port_id);
         debug_assert_eq!(port_info.state, PortState::Blocked);
         port_info.state = PortState::Open;
         if self.mode == Mode::BlockedPut && port_id == self.mode_port {
             // We were blocked on the port that just became unblocked, so
             // send the message.
             let mut replacement = ValueGroup::default();
             std::mem::swap(&mut replacement, &mut self.mode_value);
             self.send_message_and_wake_up(sched_ctx, comp_ctx, port_id, replacement);
             self.mode = Mode::Sync;
             self.mode_port = PortId::new_invalid();
+        }
+    }
     fn create_component_and_transfer_ports(&mut self, sched_ctx: &SchedulerCtx, creator_ctx: &mut CompCtx, prompt: Prompt, ports: &[PortId]) {
         let component = CompPDL::new(prompt);
+        let component = CompPDL::new(prompt, ports.len());
         let (comp_key, component) = sched_ctx.runtime.create_pdl_component(component, true);
         let created_ctx = &mut component.ctx;
         let mut has_reroute_entry = false;
         let schedule_entry_id = self.control.add_schedule_entry(created_ctx.id);
         for port_id in ports.iter().copied() {
             // Create temporary reroute entry if the peer is another component
             let port_info = creator_ctx.get_port(port_id);
             debug_assert_ne!(port_info.state, PortState::Blocked);
             if port_info.peer_comp_id == creator_ctx.id {
                 // We own the peer port. So retrieve it and modify the peer directly
                 let port_info = creator_ctx.get_port_mut(port_info.peer_id);
                 let peer_port_id = port_info.peer_id;
                 let port_info = creator_ctx.get_port_mut(peer_port_id);
                 port_info.peer_comp_id = created_ctx.id;
             } else {
                 // We don't own the port, so send the appropriate messages and
                 // notify the control layer
                 has_reroute_entry = true;
                 let message = self.control.add_reroute_entry(
                     creator_ctx.id, port_info.peer_id, port_info.peer_comp_id,
                     port_info.self_id, created_ctx.id, schedule_entry_id
                 );
                 let peer_info = creator_ctx.get_peer(port_info.peer_comp_id);
                 peer_info.handle.inbox.push(message);
+            }
             // Transfer port and create temporary reroute entry
-            let (mut port_info, peer_info) = Self::remove_port_from_component(creator_ctx, port_id);
             let (port_info, peer_info) = Self::remove_port_from_component(creator_ctx, port_id);
             if port_info.state == PortState::Blocked {
                 todo!("Think about this when you're not tired!");
+            }
             Self::add_port_to_component(sched_ctx, created_ctx, port_info);
             // Maybe remove peer from the creator
             if let Some(mut peer_info) = peer_info {
                 let remove_from_runtime = peer_info.handle.decrement_users();
                 if remove_from_runtime {
                     let removed_comp_key = unsafe{ peer_info.id.upgrade() };
                     sched_ctx.runtime.destroy_component(removed_comp_key);
+                }
+            }
+        }
         if !has_reroute_entry {
             // We can schedule the component immediately
             self.control.remove_schedule_entry(schedule_entry_id);
             sched_ctx.runtime.enqueue_work(comp_key);
         } // else: wait for the `Ack`s, they will trigger the scheduling of the component
+    }
     /// Removes a port from a component. Also decrements the port counter in
     /// the peer component's entry. If that hits 0 then it will be removed and
     /// returned. If returned then the caller is responsible for decrementing
     /// the atomic counters of the peer component's handle.
     fn remove_port_from_component(comp_ctx: &mut CompCtx, port_id: PortId) -> (Port, Option<Peer>) {
         use std::sync::atomic::Ordering;
         let port_index = comp_ctx.get_port_index(port_id).unwrap();
         let port_info = comp_ctx.ports.remove(port_index);
         // If the component owns the peer, then we don't have to decrement the
         // number of peers (because we don't have an entry for ourselves)
         if port_info.peer_comp_id == comp_ctx.id {
             return (port_info, None);
+        }
         let peer_index = comp_ctx.get_peer_index(port_info.peer_comp_id).unwrap();
         let peer_info = &mut comp_ctx.peers[peer_index];
         peer_info.num_associated_ports -= 1;
         // Check if we still have other ports referencing this peer
         if peer_info.num_associated_ports != 0 {
             return (port_info, None);
+        }
         let peer_info = comp_ctx.peers.remove(peer_index);
         return (port_info, Some(peer_info));
+    }
     fn add_port_to_component(sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx, port_info: Port) {
         // Add the port info
         let peer_comp_id = port_info.peer_comp_id;
         debug_assert!(!comp_ctx.ports.iter().any(|v| v.self_id == port_info.self_id));
         comp_ctx.ports.push(port_info);
         // Increment counters on peer, or create entry for peer if it doesn't
         // exist yet.
         match comp_ctx.peers.iter().position(|v| v.id == peer_comp_id) {
             Some(peer_index) => {
                 let peer_info = &mut comp_ctx.peers[peer_index];
                 peer_info.num_associated_ports += 1;
             },
             None => {
                 let handle = sched_ctx.runtime.get_component_public(peer_comp_id);
                 comp_ctx.peers.push(Peer{
                     id: peer_comp_id,
                     num_associated_ports: 1,
                     handle,
                 });
+            }
+        }
+    }
     fn change_port_peer_component(
         &mut self, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx,
         port_id: PortId, new_peer_comp_id: CompId
     ) {
         let port_info = comp_ctx.get_port_mut(port_id);
         let cur_peer_comp_id = port_info.peer_comp_id;
         let cur_peer_info = comp_ctx.get_peer_mut(cur_peer_comp_id);
         cur_peer_info.num_associated_ports -= 1;
         if cur_peer_info.num_associated_ports == 0 {
             let should_remove = cur_peer_info.handle.decrement_users();
             if should_remove {
                 let cur_peer_comp_key = unsafe{ cur_peer_comp_id.upgrade() };
                 sched_ctx.runtime.destroy_component(cur_peer_comp_key);
+            }
+        }
+    }
+}
 #[inline]
 fn port_id_from_eval(port_id: EvalPortId) -> PortId {
     return PortId(port_id.id);
+}
 #[inline]
 fn port_id_to_eval(port_id: PortId) -> EvalPortId {
     return EvalPortId{ id: port_id.0 };
+}
 /// Recursively goes through the value group, attempting to find ports.
 /// Duplicates will only be added once.
 pub(crate) fn find_ports_in_value_group(value_group: &ValueGroup, ports: &mut Vec<PortId>) {
     // Helper to check a value for a port and recurse if needed.
     use crate::protocol::eval::Value;
     fn find_port_in_value(group: &ValueGroup, value: &Value, ports: &mut Vec<PortId>) {
         match value {
             Value::Input(port_id) | Value::Output(port_id) => {
                 // This is an actual port
                 let cur_port = PortId(port_id.id);
                 for prev_port in ports.iter() {
                     if *prev_port == cur_port {
                         // Already added
                         return;
+                    }
+                }
                 ports.push(cur_port);
             },
             Value::Array(heap_pos) |
             Value::Message(heap_pos) |
             Value::String(heap_pos) |
             Value::Struct(heap_pos) |
             Value::Union(_, heap_pos) => {
                 // Reference to some dynamic thing which might contain ports,
                 // so recurse
                 let heap_region = &group.regions[*heap_pos as usize];
                 for embedded_value in heap_region {
                     find_port_in_value(group, embedded_value, ports);
+                }
             },
             _ => {}, // values we don't care about
+        }
+    }
     // Clear the ports, then scan all the available values
     ports.clear();
     for value in &value_group.values {
         find_port_in_value(value_group, value, ports);
+    }
+}
@@ \ No newline at end of file @@

src/runtime2/component/consensus.rs

➞

Show inline comments

-use crate::protocol::eval::*;
+use crate::protocol::eval::ValueGroup;
 use crate::runtime2::communication::*;
 use super::component_pdl::*;
 pub struct PortAnnotation {
     id: PortId,
     mapping: Option<u32>,
+}
 impl PortAnnotation {
     fn new(id: PortId) -> Self {
         return Self{ id, mapping: None }
+    }
+}
 /// Tracking consensus state
 pub struct Consensus {
     round: u32,
     mapping_counter: u32,
     ports: Vec<PortAnnotation>,
+}
 impl Consensus {
     pub(crate) fn new() -> Self {
         return Self{
             round: 0,
             mapping_counter: 0,
             ports: Vec::new(),
+        }
+    }
     pub(crate) fn notify_sync_start(&mut self, comp_ctx: &CompCtx) {
         // Make sure we locally still have all of the same ports
         self.transfer_ports(comp_ctx);
         self.mapping_counter = 0;
+    }
     pub(crate) fn annotate_message_data(&mut self, port_info: &Port, content: ValueGroup) -> DataMessage {
         debug_assert!(self.ports.iter().any(|v| v.id == port_info.self_id));
         let data_header = self.create_data_header(port_info);
         let sync_header = self.create_sync_header();
         return DataMessage{ data_header, sync_header, content };
+    }
     pub(crate) fn notify_sync_end(&mut self) {
         self.round = self.round.wrapping_add(1);
         todo!("implement sync end")
+    }
     pub(crate) fn transfer_ports(&mut self, comp_ctx: &CompCtx) {
         let mut needs_setting_ports = false;
         if comp_ctx.ports.len() != self.ports.len() {
-            ports_same = true;
+            needs_setting_ports = true;
         } else {
             for idx in 0..comp_ctx.ports.len() {
                 let comp_port_id = comp_ctx.ports[idx].self_id;
                 let cons_port_id = self.ports[idx].id;
                 if comp_port_id != cons_port_id {
                     needs_setting_ports = true;
                     break;
+                }
+            }
+        }
         if needs_setting_ports {
             self.ports.clear();
             self.ports.reserve(comp_ctx.ports.len());
             for port in &comp_ctx.ports {
                 self.ports.push(PortAnnotation::new(port.self_id))
+            }
+        }
+    }
     fn create_data_header(&mut self, port_info: &Port) -> MessageDataHeader {
         let mut expected_mapping = Vec::with_capacity(self.ports.len());
         for port in &self.ports {
             if let Some(mapping) = port.mapping {
                 expected_mapping.push((port.id, mapping));
+            }
+        }
         debug_assert_eq!(port_info.kind, PortKind::Putter);
         return MessageDataHeader{
             expected_mapping,
             new_mapping: self.take_mapping(),
             source_port: port_info.self_id,
             target_port: port_info.peer_id,
         };
+    }
     fn create_sync_header(&self) -> MessageSyncHeader {
         return MessageSyncHeader{
             sync_round: self.round,
         };
+    }
     fn take_mapping(&mut self) -> u32 {
         let mapping = self.mapping_counter;
         self.mapping_counter += 1;
         return mapping;
+    }
+}
@@ \ No newline at end of file @@

src/runtime2/component/control_layer.rs

➞

Show inline comments

 use crate::runtime2::runtime::*;
 use crate::runtime2::communication::*;
 use crate::runtime2::component::*;
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
 pub(crate) struct ControlId(u32);
 impl ControlId {
     /// Like other invalid IDs, this one doesn't care any significance, but is
     /// just set at u32::MAX to hopefully bring out bugs sooner.
     fn new_invalid() -> Self {
         return ControlId(u32::MAX);
+    }
+}
 struct ControlEntry {
     id: ControlId,
     ack_countdown: u32,
     content: ControlContent,
+}
 enum ControlContent {
     PeerChange(ContentPeerChange),
     ScheduleComponent(CompId),
     BlockedPort(PortId),
     ClosedPort(PortId),
+}
 struct ContentPeerChange {
     source_port: PortId,
     source_comp: CompId,
     target_port: PortId,
     new_target_comp: CompId,
     schedule_entry_id: ControlId,
+}
 pub(crate) enum AckAction {
     None,
     SendMessageAndAck(CompId, ControlMessage, ControlId),
     ScheduleComponent(CompId),
+}
 /// Handling/sending control messages.
 pub(crate) struct ControlLayer {
     id_counter: ControlId,
     entries: Vec<ControlEntry>,
+}
 impl ControlLayer {
     pub(crate) fn should_reroute(&self, message: &Message) -> Option<CompId> {
         // Safety note: rerouting should occur during the time when we're
         // notifying a peer of a new component. During this period that
         // component hasn't been executed yet, so cannot have died yet.
         // FIX @NoDirectHandle
         let target_port = message.target_port();
         if target_port.is_none() {
             return None;
+        }
         let target_port = target_port.unwrap();
         for entry in &self.entries {
             if let ControlContent::PeerChange(entry) = &entry.content {
                 if entry.target_port == target_port {
                     return Some(entry.new_target_comp);
+                }
+            }
+        }
         return None;
+    }
     pub(crate) fn handle_ack(&mut self, entry_id: ControlId, sched_ctx: &SchedulerCtx, comp_ctx: &mut CompCtx) -> AckAction {
         let entry_index = self.get_entry_index(entry_id).unwrap();
         let entry = &mut self.entries[entry_index];
         debug_assert!(entry.ack_countdown > 0);
         entry.ack_countdown -= 1;
         if entry.ack_countdown != 0 {
             return AckAction::None;
+        }
         // All `Ack`s received, take action based on the kind of entry
         match &entry.content {
             ControlContent::PeerChange(content) => {
                 // If change of peer is ack'd. Then we are certain we have
                 // rerouted all of the messages, and the sender's port can now
                 // be unblocked again.
                 let target_comp_id = content.source_comp;
                 let message_to_send = ControlMessage{
                     id: ControlId::new_invalid(),
                     sender_comp_id: comp_ctx.id,
                     target_port_id: Some(content.source_port),
                     content: ControlMessageContent::PortPeerChangedUnblock(
                         content.source_port,
                         content.new_target_comp
+                    )
                 };
                 let to_ack = content.schedule_entry_id;
                 self.entries.remove(entry_index);
                 self.handle_ack(to_ack, sched_ctx, comp_ctx);
                 return AckAction::SendMessageAndAck(target_comp_id, message_to_send, to_ack);
             },
-            ControlContent::ScheduleComponent(content) => {
+            ControlContent::ScheduleComponent(to_schedule) => {
                 // If all change-of-peers are `Ack`d, then we're ready to
                 // schedule the component!
-                return AckAction::ScheduleComponent(content.to_schedule);
+                return AckAction::ScheduleComponent(*to_schedule);
             },
             ControlContent::BlockedPort(_) => unreachable!(),
             ControlContent::ClosedPort(port_id) => {
                 // If a closed port is Ack'd, then we remove the reference to
                 // that component.
                 let port_index = comp_ctx.get_port_index(*port_id).unwrap();
                 debug_assert_eq!(comp_ctx.ports[port_index].state, PortState::Blocked);
                 let peer_id = comp_ctx.ports[port_index].peer_comp_id;
                 let peer_index = comp_ctx.get_peer_index(peer_id).unwrap();
                 let peer_info = &mut comp_ctx.peers[peer_index];
                 peer_info.num_associated_ports -= 1;
                 if peer_info.num_associated_ports == 0 {
                     let should_remove = peer_info.handle.decrement_users();
                     if should_remove {
                         let comp_key = unsafe{ peer_info.id.upgrade() };
                         sched_ctx.runtime.destroy_component(comp_key);
+                    }
                     comp_ctx.peers.remove(peer_index);
+                }
                 return AckAction::None;
+            }
+        }
+    }
     // -------------------------------------------------------------------------
     // Port transfer (due to component creation)
     // -------------------------------------------------------------------------
     /// Adds an entry that, when completely ack'd, will schedule a component.
     pub(crate) fn add_schedule_entry(&mut self, to_schedule_id: CompId) -> ControlId {
         let entry_id = self.take_id();
         self.entries.push(ControlEntry{
             id: entry_id,
             ack_countdown: 0, // incremented by calls to `add_reroute_entry`
             content: ControlContent::ScheduleComponent(ContentScheduleComponent{
                 to_schedule: to_schedule_id
             }),
             content: ControlContent::ScheduleComponent(to_schedule_id),
         });
         return entry_id;
+    }
     /// Removes a schedule entry. Only used if the caller preemptively called
     /// `add_schedule_entry`, but ended up not calling `add_reroute_entry`,
     /// hence the `ack_countdown` in the scheduling entry is at 0.
     pub(crate) fn remove_schedule_entry(&mut self, schedule_entry_id: ControlId) {
         let index = self.get_entry_index(schedule_entry_id).unwrap();
         debug_assert_eq!(self.entries[index].ack_countdown, 0);
         self.entries.remove(index);
+    }
     pub(crate) fn add_reroute_entry(
         &mut self, creator_comp_id: CompId,
         source_port_id: PortId, source_comp_id: CompId,
         target_port_id: PortId, new_comp_id: CompId,
         schedule_entry_id: ControlId,
     ) -> Message {
         let entry_id = self.take_id();
         self.entries.push(ControlEntry{
             id: entry_id,
             ack_countdown: 1,
             content: ControlContent::PeerChange(ContentPeerChange{
                 source_port: source_port_id,
                 source_comp: source_comp_id,
                 target_port: target_port_id,
                 new_target_comp: new_comp_id,
                 schedule_entry_id,
             }),
         });
         // increment counter on schedule entry
         for entry in &mut self.entries {
             if entry.id == schedule_entry_id {
                 entry.ack_countdown += 1;
                 break;
+            }
+        }
         return Message::Control(ControlMessage{
             id: entry_id,
             sender_comp_id: creator_comp_id,
             target_port_id: Some(source_port_id),
             content: ControlMessageContent::PortPeerChangedBlock(source_port_id)
         })
+    }
     // -------------------------------------------------------------------------
     // Blocking, unblocking, and closing ports
     // -------------------------------------------------------------------------
     pub(crate) fn mark_port_closed<'a>(&mut self, port_id: PortId, comp_ctx: &mut CompCtx) -> Option<(CompId, ControlMessage)> {
         let port = comp_ctx.get_port_mut(port_id);
         let peer_port_id = port.peer_id;
         let peer_comp_id = port.peer_comp_id;
         debug_assert!(port.state == PortState::Open || port.state == PortState::Blocked);
         port.state = PortState::Closed;
-        if port.peer_comp_id == comp_ctx.id {
         if peer_comp_id == comp_ctx.id {
             // We own the other end of the channel as well
             return None;
+        }
         let entry_id = self.take_id();
         self.entries.push(ControlEntry{
             id: entry_id,
             ack_countdown: 1,
             content: ControlContent::ClosedPort(port_id),
         });
         return Some((
-            port.peer_comp_id,
             peer_comp_id,
             ControlMessage{
                 id: entry_id,
                 sender_comp_id: comp_ctx.id,
                 target_port_id: Some(port.peer_id),
                 content: ControlMessageContent::ClosePort(port.peer_id),
                 target_port_id: Some(peer_port_id),
                 content: ControlMessageContent::ClosePort(peer_port_id),
+            }
         ));
+    }
     pub(crate) fn mark_port_blocked(&mut self, port_id: PortId, comp_ctx: &mut CompCtx) -> (CompId, ControlMessage) {
         // TODO: Feels like this shouldn't be an entry. Hence this class should
         //  be renamed. Lets see where the code ends up being
         let entry_id = self.take_id();
         let port_info = comp_ctx.get_port_mut(port_id);
         let peer_port_id = port_info.peer_id;
         let peer_comp_id = port_info.peer_comp_id;
         debug_assert_eq!(port_info.state, PortState::Open); // prevent unforeseen issues
         port_info.state = PortState::Blocked;
         self.entries.push(ControlEntry{
             id: entry_id,
             ack_countdown: 0,
             content: ControlContent::BlockedPort(ContentBlockedPort{
                 blocked_port: port_id,
             }),
             content: ControlContent::BlockedPort(port_id),
         });
         return (
-            port_info.peer_comp_id,
             peer_comp_id,
             ControlMessage{
                 id: entry_id,
                 sender_comp_id: comp_ctx.id,
                 target_port_id: Some(port_info.peer_id),
                 content: ControlMessageContent::BlockPort(port_info.peer_id),
                 target_port_id: Some(peer_port_id),
                 content: ControlMessageContent::BlockPort(peer_port_id),
+            }
         );
+    }
     pub(crate) fn mark_port_unblocked(&mut self, port_id: PortId, comp_ctx: &mut CompCtx) -> (CompId, ControlMessage) {
         // Find the entry that contains the blocking entry for the port
         let mut entry_index = usize::MAX;
-        let mut entry_id = ControlId::MAX;
+        let mut entry_id = ControlId::new_invalid();
         for (index, entry) in self.entries.iter().enumerate() {
             if let ControlContent::BlockedPort(block_entry) = &entry.content {
                 if block_entry.blocked_port == port_id {
             if let ControlContent::BlockedPort(blocked_port) = &entry.content {
                 if *blocked_port == port_id {
                     entry_index = index;
                     entry_id = entry.id;
                     break;
+                }
+            }
+        }
         let port_info = comp_ctx.get_port_mut(port_id);
         let peer_port_id = port_info.peer_id;
         let peer_comp_id = port_info.peer_comp_id;
         debug_assert_eq!(port_info.state, PortState::Blocked);
         port_info.state = PortState::Open;
         return (
-            port_info.peer_comp_id,
             peer_comp_id,
             ControlMessage{
                 id: entry_id,
                 sender_comp_id: comp_ctx.id,
                 target_port_id: Some(port_info.peer_id),
                 content: ControlMessageContent::UnblockPort(port_info.peer_id),
                 target_port_id: Some(peer_port_id),
                 content: ControlMessageContent::UnblockPort(peer_port_id),
+            }
+        )
+    }
     // -------------------------------------------------------------------------
     // Internal utilities
     // -------------------------------------------------------------------------
     fn take_id(&mut self) -> ControlId {
         let id = self.id_counter;
         self.id_counter.0 = self.id_counter.0.wrapping_add(1);
         return id;
+    }
     fn get_entry_index(&self, entry_id: ControlId) -> Option<usize> {
         for (index, entry) in self.entries.iter().enumerate() {
             if entry.id == entry_id {
                 return Some(index);
+            }
+        }
         return None;
+    }
+}
 impl Default for ControlLayer {
     fn default() -> Self {
         return ControlLayer{
             id_counter: ControlId(0),
             entries: Vec::new(),
+        }
+    }
+}
@@ \ No newline at end of file @@

src/runtime2/scheduler.rs

➞

Show inline comments

 use std::sync::atomic::Ordering;
 use super::component::*;
 use super::runtime::*;
 use super::communication::*;
 /// Data associated with a scheduler thread
 pub(crate) struct Scheduler {
     runtime: RuntimeHandle,
     scheduler_id: u32,
+}
 pub(crate) struct SchedulerCtx<'a> {
     pub runtime: &'a Runtime,
+}
 impl<'a> SchedulerCtx<'a> {
     pub fn new(runtime: &'a Runtime) -> Self {
         return Self {
             runtime,
+        }
+    }
+}
 impl Scheduler {
     // public interface to thread
     pub fn new(runtime: RuntimeHandle, scheduler_id: u32) -> Self {
         return Scheduler{ runtime, scheduler_id }
+    }
     pub fn run(&mut self) {
         let mut scheduler_ctx = SchedulerCtx::new(&*self.runtime);
         'run_loop: loop {
             // Wait until we have something to do (or need to quit)
             let comp_key = self.runtime.take_work();
             if comp_key.is_none() {
                 break 'run_loop;
+            }
             let comp_key = comp_key.unwrap();
             let component = self.runtime.get_component(comp_key);
             // Run the component until it no longer indicates that it needs to
             // be re-executed immediately.
             let mut new_scheduling = CompScheduling::Immediate;
             while let CompScheduling::Immediate = new_scheduling {
-                new_scheduling = component.code.run(&mut scheduler_ctx, &mut component.private.ctx).expect("TODO: Handle error");
                 new_scheduling = component.code.run(&mut scheduler_ctx, &mut component.ctx).expect("TODO: Handle error");
+            }
             // Handle the new scheduling
             match new_scheduling {
                 CompScheduling::Immediate => unreachable!(),
                 CompScheduling::Requeue => { self.runtime.enqueue_work(comp_key); },
                 CompScheduling::Sleep => { self.mark_component_as_sleeping(comp_key, component); },
                 CompScheduling::Exit => { self.mark_component_as_exiting(&scheduler_ctx, component); }
+            }
+        }
+    }
     // local utilities
     fn mark_component_as_sleeping(&self, key: CompKey, component: &mut RuntimeComp) {
-        debug_assert_eq!(key.downgrade(), component.private.ctx.id); // make sure component matches key
         debug_assert_eq!(key.downgrade(), component.ctx.id); // make sure component matches key
         debug_assert_eq!(component.public.sleeping.load(Ordering::Acquire), false); // we're executing it, so it cannot be sleeping
         component.public.sleeping.store(true, Ordering::Release);
         if component.inbox.can_pop() {
             let should_reschedule = component.public.sleeping
                 .compare_exchange(true, false, Ordering::AcqRel, Ordering::Relaxed)
                 .is_ok();
             if should_reschedule {
                 self.runtime.enqueue_work(key);
+            }
+        }
+    }
     fn mark_component_as_exiting(&self, sched_ctx: &SchedulerCtx, component: &mut RuntimeComp) {
         for port_index in 0..component.ctx.ports.len() {
             let port_info = &component.ctx.ports[port_index];
-            if let Some((peer_id, message)) = component.code.control.mark_port_closed(port_info.id, comp_ctx) {
+            if let Some((peer_id, message)) = component.code.control.mark_port_closed(port_info.self_id, &mut component.ctx) {
                 let peer_info = component.ctx.get_peer(peer_id);
                 peer_info.handle.inbox.push(Message::Control(message));
                 wake_up_if_sleeping(sched_ctx, peer_id, &peer_info.handle);
+            }
+        }
         let old_count = component.public.num_handles.fetch_sub(1, Ordering::AcqRel);
         let new_count = old_count - 1;
         if new_count == 0 {
             let comp_key = unsafe{ component.ctx.id.upgrade() };
             sched_ctx.runtime.destroy_component(comp_key);
+        }
+    }
+}
@@ \ No newline at end of file @@

src/runtime2/store/component.rs

➞

Show inline comments

 /*
  * Component Store
+ *
  * Concurrent datastructure for creating/destroying/retrieving components using
  * their ID. It is essentially a variation on a concurrent freelist. We store an
  * array of (potentially null) pointers to data. Indices into this array that
  * are unused (but may be left allocated) are in a freelist. So creating a new
  * bit of data involves taking an index from this freelist. Destruction involves
  * putting the index back.
+ *
  * This datastructure takes care of the threadsafe implementation of the
  * freelist and calling the data's destructor when needed. Note that it is not
  * completely safe (in Rust's sense of the word) because it is possible to
  * get more than one mutable reference to a piece of data. Likewise it is
  * possible to put back bogus indices into the freelist, which will destroy the
  * integrity of the datastructure.
+ *
  * Some underlying assumptions that led to this design (note that I haven't
  * actually checked these conditions or performed any real profiling, yet):
  *  - Resizing the freelist should be very rare. The datastructure should grow
  *    to some kind of maximum size and stay at that size.
  *  - Creation should (preferably) be faster than deletion of data. Reason being
  *    that creation implies we're creating a component that has code to be
  *    executed. Better to quickly be able to execute code than being able to
  *    quickly tear down finished components.
  *  - Retrieval is much more likely than creation/destruction.
+ *
  * Some obvious flaws with this implementation:
  *  - Because of the freelist implementation we will generally allocate all of
  *    the data pointers that are available (i.e. if we have a buffer of size
  *    64, but we generally use 33 elements, than we'll have 64 elements
  *    allocated), which might be wasteful at larger array sizes (which are
  *    always powers of two).
  *  - A lot of concurrent operations are not necessary: we may move some of the
  *    access to the global concurrent datastructure by an initial access to some
  *    kind of thread-local datastructure.
  */
 use std::mem::transmute;
-use std::alloc::{alloc, dealloc, Layout};
 use std::alloc::{dealloc, Layout};
 use std::ptr;
 use std::sync::atomic::{AtomicUsize, Ordering};
 use super::unfair_se_lock::{UnfairSeLock, UnfairSeLockSharedGuard};
 pub struct ComponentStore<T: Sized> {
     inner: UnfairSeLock<Inner<T>>,
     read_head: AtomicUsize,
     write_head: AtomicUsize,
     limit_head: AtomicUsize,
+}
 unsafe impl<T: Sized> Send for ComponentStore<T>{}
 unsafe impl<T: Sized> Sync for ComponentStore<T>{}
 struct Inner<T: Sized> {
     freelist: Vec<u32>,
     data: Vec<*mut T>,
     size: usize,
     compare_mask: usize,
     index_mask: usize,
+}
 type InnerShared<'a, T> = UnfairSeLockSharedGuard<'a, Inner<T>>;
 impl<T: Sized> ComponentStore<T> {
     pub fn new(initial_size: usize) -> Self {
         Self::assert_valid_size(initial_size);
         // Fill initial freelist and preallocate data array
         let mut initial_freelist = Vec::with_capacity(initial_size);
         for idx in 0..initial_size {
             initial_freelist.push(idx as u32)
+        }
         let mut initial_data = Vec::new();
         initial_data.resize(initial_size, ptr::null_mut());
         // Return initial store
         return Self{
             inner: UnfairSeLock::new(Inner{
                 freelist: initial_freelist,
                 data: initial_data,
                 size: initial_size,
                 compare_mask: 2*initial_size - 1,
                 index_mask: initial_size - 1,
             }),
             read_head: AtomicUsize::new(0),
             write_head: AtomicUsize::new(initial_size),
             limit_head: AtomicUsize::new(initial_size),
         };
+    }
     /// Creates a new element initialized to the provided `value`. This returns
     /// the index at which the element can be retrieved.
     pub fn create(&self, value: T) -> u32 {
         let lock = self.inner.lock_shared();
         let (lock, index) = self.pop_freelist_index(lock);
         self.initialize_at_index(lock, index, value);
         return index;
+    }
     /// Destroys an element at the provided `index`. The caller must make sure
     /// that it does not use any previously received references to the data at
     /// this index, and that no more calls to `get` are performed using this
     /// index. This is allowed again if the index has been reacquired using
     /// `create`.
     pub fn destroy(&self, index: u32) {
         let lock = self.inner.lock_shared();
         self.destruct_at_index(&lock, index);
         self.push_freelist_index(&lock, index);
+    }
     /// Retrieves an element by reference
     pub fn get(&self, index: u32) -> &T {
         let lock = self.inner.lock_shared();
         let value = lock.data[index as usize];
         unsafe {
             debug_assert!(!value.is_null());
             return &*value;
+        }
+    }
     /// Retrieves an element by mutable reference. The caller should ensure that
     /// use of that mutability is thread-safe
     pub fn get_mut(&self, index: u32) -> &mut T {
         let lock = self.inner.lock_shared();
         let value = lock.data[index as usize];
         unsafe {
             debug_assert!(!value.is_null());
             return &mut *value;
+        }
+    }
     #[inline]
     fn pop_freelist_index<'a>(&'a self, mut shared_lock: InnerShared<'a, T>) -> (InnerShared<'a, T>, u32) {
         'attempt_read: loop {
             // Load indices and check for reallocation condition
             let current_size = shared_lock.size;
             let mut read_index = self.read_head.load(Ordering::Relaxed);
             let limit_index = self.limit_head.load(Ordering::Acquire);
             if read_index == limit_index {
                 shared_lock = self.reallocate(current_size, shared_lock);
                 continue 'attempt_read;
+            }
             loop {
                 let preemptive_read = shared_lock.freelist[read_index & shared_lock.index_mask];
                 if let Err(actual_read_index) = self.read_head.compare_exchange(
                     read_index, (read_index + 1) & shared_lock.compare_mask,
                     Ordering::AcqRel, Ordering::Acquire
                 ) {
                     // We need to try again
                     read_index = actual_read_index;
                     continue 'attempt_read;
+                }
                 // If here then we performed the read
                 return (shared_lock, preemptive_read);
+            }
+        }
+    }
     #[inline]
     fn initialize_at_index(&self, read_lock: InnerShared<T>, index: u32, value: T) {
         let mut target_ptr = read_lock.data[index as usize];
         unsafe {
             if target_ptr.is_null() {
                 let layout = Layout::for_value(&value);
                 target_ptr = std::alloc::alloc(layout).cast();
                 let rewrite: *mut *mut T = transmute(read_lock.data.as_ptr());
                 *rewrite.add(index as usize) = target_ptr;
+            }
             std::ptr::write(target_ptr, value);
+        }
+    }
     #[inline]
     fn push_freelist_index(&self, read_lock: &InnerShared<T>, index_to_put_back: u32) {
         // Acquire an index in the freelist to which we can write
         let mut cur_write_index = self.write_head.load(Ordering::Relaxed);
         let mut new_write_index = (cur_write_index + 1) & read_lock.compare_mask;
         while let Err(actual_write_index) = self.write_head.compare_exchange(
             cur_write_index, new_write_index,
             Ordering::AcqRel, Ordering::Acquire
         ) {
             cur_write_index = actual_write_index;
             new_write_index = (cur_write_index + 1) & read_lock.compare_mask;
+        }
         // We own the data at the index, write to it and notify reader through
         // limit_head that it can be read from. Note that we cheat around the
         // rust mutability system here :)
         unsafe {
             let target: *mut u32 = transmute(read_lock.freelist.as_ptr());
             *(target.add(cur_write_index & read_lock.index_mask)) = index_to_put_back;
+        }
         // Essentially spinlocking, relaxed failure ordering because the logic
         // is that a write first moves the `write_head`, then the `limit_head`.
         while let Err(_) = self.limit_head.compare_exchange(
             cur_write_index, new_write_index,
             Ordering::AcqRel, Ordering::Relaxed
         ) {};
+    }
     #[inline]
     fn destruct_at_index(&self, read_lock: &InnerShared<T>, index: u32) {
         let target_ptr = read_lock.data[index as usize];
         unsafe{ ptr::drop_in_place(target_ptr); }
+    }
     // NOTE: Bit of a mess, and could have a cleanup with better logic for the
     // resizing. Maybe even a different indexing scheme...
     fn reallocate(&self, old_size: usize, inner: InnerShared<T>) -> InnerShared<T> {
         drop(inner);
+        {
             // After dropping read lock, acquire write lock
             let mut lock = self.inner.lock_exclusive();
             if old_size == lock.size {
                 // We are the thread that is supposed to reallocate
                 let new_size = old_size * 2;
                 Self::assert_valid_size(new_size);
                 // Note that the atomic indices are in the range [0, new_size)
                 // already, so we need to be careful
                 let new_index_mask = new_size - 1;
                 let new_compare_mask = (2 * new_size) - 1;

src/runtime2/store/unfair_se_lock.rs

➞

Show inline comments

 use std::cell::UnsafeCell;
 use std::sync::atomic::{AtomicU32, Ordering};
 /// An unfair shared/exclusive lock. One may quickly describe this to be an
 /// unfair RwLock where a thread that wishes to write will get to write as fast
 /// as possible (i.e. waiting for readers to finish), but others writers in line
 /// may have to wait for another round of readers acquiring the lock.
 ///
 /// However, this is NOT a read/write lock. It is a shared/exclusive lock. It is
 /// used in concurrent datastructures (implemented with atomics), so particular
 /// kinds of writing may still occur by the threads holding a shared lock. In
 /// that case the programmer must make sure that these writes are coordinated
 /// in a thread-safe manner.
 ///
 /// It was designed with resizable (ring)buffers in mind: most often you have
 /// the standard atomic pointers/indices moving around in the ringbuffer. But
 /// when the buffer needs to be resized you need to be sure that no-one is
 /// reading/writing the wrong/old/deallocated buffer pointer. Hence the
 /// shared/exclusive terminology.
 ///
 /// For this reason the `UnfairSeLock` was written assuming that exclusive locks
 /// are only held sometime: shared locks are obtained most of the time.
 // Note: preliminary benchmark batches shows this is ~2x faster than a RwLock
 // when under some contention.
 pub struct UnfairSeLock<T> {
     // Uses 31 bits to track number of shared locks, and the high bit is set if
     // an exclusive lock is supposed to be held. 31 bits is more than sufficient
     // because in this project shared locks will be held by individual threads.
     shared: AtomicU32,
     cell: UnsafeCell<T>,
+}
 // Exclusive bit is set in the atomic value when a thread wishes to hold an
 // exclusive lock.
 const EXCLUSIVE_BIT: u32 = 1 << 31;
 impl<T> UnfairSeLock<T> {
     pub fn new(value: T) -> Self {
         return Self{
             shared: AtomicU32::new(0),
             cell: UnsafeCell::new(value),
+        }
+    }
     /// Get shared access to the underlying data.
     #[must_use]
     pub fn lock_shared(&self) -> UnfairSeLockSharedGuard<T> {
         let mut shared = self.shared.load(Ordering::Relaxed);
         loop {
             if shared & EXCLUSIVE_BIT != 0 {
                 shared = self.wait_until_not_exclusive(shared);
+            }
             // Spinlock until we've incremented. If we fail we need to check the
             // exclusive bit again.
             let new_shared = shared + 1;
             match self.shared.compare_exchange(shared, new_shared, Ordering::AcqRel, Ordering::Acquire) {
                 Ok(_) => return UnfairSeLockSharedGuard::new(self, new_shared),
                 Err(actual_value) => { shared = actual_value; },
+            }
+        }
+    }
     /// Get exclusive access to the underlying data.
     #[must_use]
     pub fn lock_exclusive(&self) -> UnfairSeLockExclusiveGuard<T> {
         let mut shared = self.shared.load(Ordering::Relaxed);
         loop {
             if shared & EXCLUSIVE_BIT != 0 {
                 shared = self.wait_until_not_exclusive(shared);
+            }
             // We want to set the write bit
             let new_shared = shared | EXCLUSIVE_BIT;
             match self.shared.compare_exchange(shared, new_shared, Ordering::AcqRel, Ordering::Acquire) {
                 Ok(_) => {
                     // We've acquired the write lock, but we still might have
                     // to wait until the reader count is at 0.
                     shared = new_shared;
                     if shared != EXCLUSIVE_BIT {
-                        shared = self.wait_until_not_shared(shared);
                         self.wait_until_not_shared(shared);
+                    }
                     return UnfairSeLockExclusiveGuard::new(self);
                 },
                 Err(actual_value) => { shared = actual_value; }
+            }
+        }
+    }
     fn wait_until_not_exclusive(&self, mut shared: u32) -> u32 {
         // Assume this is only called when the EXCLUSIVE_BIT is set
         debug_assert_eq!(shared & EXCLUSIVE_BIT, EXCLUSIVE_BIT);
         loop {
             // So spin until no longer held
             shared = self.shared.load(Ordering::Acquire);
             if shared & EXCLUSIVE_BIT == 0 {
                 return shared;
+            }
+        }
+    }
     #[inline]
     fn wait_until_not_shared(&self, mut shared: u32) -> u32 {
         // This is only called when someone has signaled the exclusive bit, but
         // there are still threads holding the shared lock.
         loop {
             debug_assert_eq!(shared & EXCLUSIVE_BIT, EXCLUSIVE_BIT);
             if shared == EXCLUSIVE_BIT {
                 // shared count is 0
                 return shared;
+            }
             shared = self.shared.load(Ordering::Acquire);
+        }
+    }
+}
 /// A guard signifying that the owner has shared access to the underlying
 /// `UnfairSeLock`.
 pub struct UnfairSeLockSharedGuard<'a, T> {
     lock: &'a UnfairSeLock<T>,
     initial_value: u32,
+}
 impl<'a, T> UnfairSeLockSharedGuard<'a, T> {
     fn new(lock: &'a UnfairSeLock<T>, initial_value: u32) -> Self {
         return Self{ lock, initial_value };
+    }
     /// Force retrieval of the underlying type `T` in the mutable sense. Note
     /// that the caller is now responsible for ensuring that concurrent mutable
     /// access takes place in a correct fashion.
     #[inline]
     pub unsafe fn get_mut(&self) -> &mut T {
         return unsafe{ &mut *self.lock.cell.get() };
+    }
+}
 impl<'a, T> Drop for UnfairSeLockSharedGuard<'a, T> {
     fn drop(&mut self) {
         // Spinlock until we've decremented the number of shared locks.
         let mut value = self.initial_value;
         while let Err(actual_value) = self.lock.shared.compare_exchange_weak(
             value, value - 1, Ordering::AcqRel, Ordering::Acquire
         ) {
             value = actual_value;
+        }
+    }
+}
 impl<'a, T> std::ops::Deref for UnfairSeLockSharedGuard<'a, T> {
     type Target = T;
     fn deref(&self) -> &Self::Target {
         return unsafe{ &*self.lock.cell.get() };
+    }
+}
 /// A guard signifying that the owner has exclusive access to the underlying
 /// `UnfairSeLock`.
 pub struct UnfairSeLockExclusiveGuard<'a, T> {
     lock: &'a UnfairSeLock<T>,
+}
 impl<'a, T> UnfairSeLockExclusiveGuard<'a, T> {
     fn new(lock: &'a UnfairSeLock<T>) -> Self {
         return Self{ lock };
+    }
+}
 impl<'a, T> Drop for UnfairSeLockExclusiveGuard<'a, T> {
     fn drop(&mut self) {
         // We have the exclusive bit set, and this type was constructed when
         // the number of shared locks was at 0, we can safely store a `0` into
         // the atomic
         debug_assert_eq!(self.lock.shared.load(Ordering::Relaxed), EXCLUSIVE_BIT); // relaxed because we acquired it before
         self.lock.shared.store(0, Ordering::Release);
+    }
+}
 impl<'a, T> std::ops::Deref for UnfairSeLockExclusiveGuard<'a, T> {
     type Target = T;
     fn deref(&self) -> &Self::Target {
         return unsafe{ &*self.lock.cell.get() };
+    }
+}
 impl<'a, T> std::ops::DerefMut for UnfairSeLockExclusiveGuard<'a, T> {
     fn deref_mut(&mut self) -> &mut Self::Target {
         return unsafe{ &mut *self.lock.cell.get() };
+    }
+}
@@ \ No newline at end of file @@

0 comments (0 inline, 0 general)