Move check_and_update_readiness to epoll.rs and make EpollEventInterest field private

Author: tiif

src/shims/unix/fd.rs

@@ -10,7 +10,7 @@ use std::rc::Weak;
 
 use rustc_target::abi::Size;
 
-use crate::shims::unix::linux::epoll::{EpollEventInstance, EpollReadyEvents};
+use crate::shims::unix::linux::epoll::EpollReadyEvents;
 use crate::shims::unix::*;
 use crate::*;
 
@@ -263,6 +263,7 @@ impl FileDescriptionRef {
         &self,
         ecx: &mut InterpCx<'tcx, MiriMachine<'tcx>>,
     ) -> InterpResult<'tcx, ()> {
+        use crate::shims::unix::linux::epoll::EvalContextExt;
         ecx.check_and_update_readiness(self.get_id(), || self.borrow_mut().get_epoll_ready_events())
     }
 }
@@ -384,41 +385,6 @@ impl FdTable {
 
 impl<'tcx> EvalContextExt<'tcx> for crate::MiriInterpCx<'tcx> {}
 pub trait EvalContextExt<'tcx>: crate::MiriInterpCxExt<'tcx> {
-    /// For a specific unique file descriptor id, get its ready events and update
-    /// the corresponding ready list.
-    fn check_and_update_readiness(
-        &self,
-        id: FdId,
-        get_ready_events: impl FnOnce() -> InterpResult<'tcx, EpollReadyEvents>,
-    ) -> InterpResult<'tcx, ()> {
-        let this = self.eval_context_ref();
-        // Get a list of EpollEventInterest that is associated to a specific file description.
-        if let Some(epoll_interests) = this.machine.epoll_interests.get_epoll_interest(id) {
-            let epoll_ready_events = get_ready_events()?;
-            // Get the bitmask of ready events.
-            let ready_events = epoll_ready_events.get_event_bitmask(this);
-
-            for weak_epoll_interest in epoll_interests {
-                if let Some(epoll_interest) = weak_epoll_interest.upgrade() {
-                    // This checks if any of the events specified in epoll_event_interest.events
-                    // match those in ready_events.
-                    let epoll_event_interest = epoll_interest.borrow();
-                    let flags = epoll_event_interest.events & ready_events;
-                    // If there is any event that we are interested in being specified as ready,
-                    // insert an epoll_return to the ready list.
-                    if flags != 0 {
-                        let epoll_key = (id, epoll_event_interest.file_descriptor);
-                        let ready_list = &mut epoll_event_interest.ready_list.borrow_mut();
-                        let event_instance =
-                            EpollEventInstance::new(flags, epoll_event_interest.data);
-                        ready_list.insert(epoll_key, event_instance);
-                    }
-                }
-            }
-        }
-        Ok(())
-    }
-
     fn dup(&mut self, old_fd: i32) -> InterpResult<'tcx, Scalar> {
         let this = self.eval_context_mut();
 

src/shims/unix/linux/epoll.rs

@@ -50,16 +50,16 @@ impl EpollEventInstance {
 #[derive(Clone, Debug)]
 pub struct EpollEventInterest {
     /// The file descriptor value of the file description registered.
-    pub file_descriptor: i32,
+    file_descriptor: i32,
     /// The events bitmask retrieved from `epoll_event`.
-    pub events: u32,
+    events: u32,
     /// The data retrieved from `epoll_event`.
     /// libc's data field in epoll_event can store integer or pointer,
     /// but only u64 is supported for now.
     /// <https://man7.org/linux/man-pages/man3/epoll_event.3type.html>
-    pub data: u64,
+    data: u64,
     /// Ready list of the epoll instance under which this EpollEventInterest is registered.
-    pub ready_list: Rc<RefCell<BTreeMap<(FdId, i32), EpollEventInstance>>>,
+    ready_list: Rc<RefCell<BTreeMap<(FdId, i32), EpollEventInstance>>>,
 }
 
 /// EpollReadyEvents reflects the readiness of a file description.
@@ -437,4 +437,39 @@ pub trait EvalContextExt<'tcx>: crate::MiriInterpCxExt<'tcx> {
         }
         Ok(Scalar::from_i32(num_of_events))
     }
+
+    /// For a specific unique file descriptor id, get its ready events and update
+    /// the corresponding ready list.
+    fn check_and_update_readiness(
+        &self,
+        id: FdId,
+        get_ready_events: impl FnOnce() -> InterpResult<'tcx, EpollReadyEvents>,
+    ) -> InterpResult<'tcx, ()> {
+        let this = self.eval_context_ref();
+        // Get a list of EpollEventInterest that is associated to a specific file description.
+        if let Some(epoll_interests) = this.machine.epoll_interests.get_epoll_interest(id) {
+            let epoll_ready_events = get_ready_events()?;
+            // Get the bitmask of ready events.
+            let ready_events = epoll_ready_events.get_event_bitmask(this);
+
+            for weak_epoll_interest in epoll_interests {
+                if let Some(epoll_interest) = weak_epoll_interest.upgrade() {
+                    // This checks if any of the events specified in epoll_event_interest.events
+                    // match those in ready_events.
+                    let epoll_event_interest = epoll_interest.borrow();
+                    let flags = epoll_event_interest.events & ready_events;
+                    // If there is any event that we are interested in being specified as ready,
+                    // insert an epoll_return to the ready list.
+                    if flags != 0 {
+                        let epoll_key = (id, epoll_event_interest.file_descriptor);
+                        let ready_list = &mut epoll_event_interest.ready_list.borrow_mut();
+                        let event_instance =
+                            EpollEventInstance::new(flags, epoll_event_interest.data);
+                        ready_list.insert(epoll_key, event_instance);
+                    }
+                }
+            }
+        }
+        Ok(())
+    }
 }

src/shims/unix/linux/eventfd.rs

@@ -91,6 +91,7 @@ impl FileDescription for Event {
             self.counter = 0;
             // When any of the event happened, we check and update the status of all supported event
             // types for current file description.
+            use crate::shims::unix::linux::epoll::EvalContextExt;
             ecx.check_and_update_readiness(self.id, || self.get_epoll_ready_events())?;
             return Ok(Ok(U64_ARRAY_SIZE));
         }
@@ -148,6 +149,7 @@ impl FileDescription for Event {
         };
         // When any of the event happened, we check and update the status of all supported event
         // types for current file description.
+        use crate::shims::unix::linux::epoll::EvalContextExt;
         ecx.check_and_update_readiness(self.id, || self.get_epoll_ready_events())?;
         Ok(Ok(U64_ARRAY_SIZE))
     }