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
use std::{
os::unix::io::{AsRawFd, BorrowedFd, OwnedFd},
sync::{Arc, Mutex},
};
use super::{
handle::State, ClientId, Data, GlobalHandler, GlobalId, Handle, InnerClientId, InnerGlobalId,
InnerHandle, InnerObjectId, ObjectId,
};
use crate::{
core_interfaces::{WL_DISPLAY_INTERFACE, WL_REGISTRY_INTERFACE},
protocol::{same_interface, Argument, Message},
rs::map::Object,
types::server::InitError,
};
#[cfg(any(target_os = "linux", target_os = "android"))]
use rustix::event::epoll;
#[cfg(any(
target_os = "dragonfly",
target_os = "freebsd",
target_os = "netbsd",
target_os = "openbsd",
target_os = "macos"
))]
use rustix::event::kqueue::*;
use smallvec::SmallVec;
#[derive(Debug)]
pub struct InnerBackend<D: 'static> {
state: Arc<Mutex<State<D>>>,
}
impl<D> InnerBackend<D> {
pub fn new() -> Result<Self, InitError> {
#[cfg(any(target_os = "linux", target_os = "android"))]
let poll_fd = epoll::create(epoll::CreateFlags::CLOEXEC)
.map_err(Into::into)
.map_err(InitError::Io)?;
#[cfg(any(
target_os = "dragonfly",
target_os = "freebsd",
target_os = "netbsd",
target_os = "openbsd",
target_os = "macos"
))]
let poll_fd = kqueue().map_err(Into::into).map_err(InitError::Io)?;
Ok(Self { state: Arc::new(Mutex::new(State::new(poll_fd))) })
}
pub fn flush(&self, client: Option<ClientId>) -> std::io::Result<()> {
self.state.lock().unwrap().flush(client)
}
pub fn handle(&self) -> Handle {
Handle { handle: InnerHandle { state: self.state.clone() as Arc<_> } }
}
pub fn poll_fd(&self) -> BorrowedFd {
let raw_fd = self.state.lock().unwrap().poll_fd.as_raw_fd();
// This allows the lifetime of the BorrowedFd to be tied to &self rather than the lock guard,
// which is the real safety concern
unsafe { BorrowedFd::borrow_raw(raw_fd) }
}
pub fn dispatch_client(
&self,
data: &mut D,
client_id: InnerClientId,
) -> std::io::Result<usize> {
let ret = self.dispatch_events_for(data, client_id);
let cleanup = self.state.lock().unwrap().cleanup();
cleanup(&self.handle(), data);
ret
}
#[cfg(any(target_os = "linux", target_os = "android"))]
pub fn dispatch_all_clients(&self, data: &mut D) -> std::io::Result<usize> {
use std::os::unix::io::AsFd;
let poll_fd = self.poll_fd();
let mut dispatched = 0;
loop {
let mut events = epoll::EventVec::with_capacity(32);
epoll::wait(poll_fd.as_fd(), &mut events, 0)?;
if events.is_empty() {
break;
}
for event in events.iter() {
let id = InnerClientId::from_u64(event.data.u64());
// remove the cb while we call it, to gracefully handle reentrancy
if let Ok(count) = self.dispatch_events_for(data, id) {
dispatched += count;
}
}
let cleanup = self.state.lock().unwrap().cleanup();
cleanup(&self.handle(), data);
}
Ok(dispatched)
}
#[cfg(any(
target_os = "dragonfly",
target_os = "freebsd",
target_os = "netbsd",
target_os = "openbsd",
target_os = "macos"
))]
pub fn dispatch_all_clients(&self, data: &mut D) -> std::io::Result<usize> {
use std::time::Duration;
let poll_fd = self.poll_fd();
let mut dispatched = 0;
loop {
let mut events = Vec::with_capacity(32);
let nevents = unsafe { kevent(&poll_fd, &[], &mut events, Some(Duration::ZERO))? };
if nevents == 0 {
break;
}
for event in events.iter().take(nevents) {
let id = InnerClientId::from_u64(event.udata() as u64);
// remove the cb while we call it, to gracefully handle reentrancy
if let Ok(count) = self.dispatch_events_for(data, id) {
dispatched += count;
}
}
let cleanup = self.state.lock().unwrap().cleanup();
cleanup(&self.handle(), data);
}
Ok(dispatched)
}
pub(crate) fn dispatch_events_for(
&self,
data: &mut D,
client_id: InnerClientId,
) -> std::io::Result<usize> {
let mut dispatched = 0;
let handle = self.handle();
let mut state = self.state.lock().unwrap();
loop {
let action = {
let state = &mut *state;
if let Ok(client) = state.clients.get_client_mut(client_id.clone()) {
let (message, object) = match client.next_request() {
Ok(v) => v,
Err(e) if e.kind() == std::io::ErrorKind::WouldBlock => {
if dispatched > 0 {
break;
} else {
return Err(e);
}
}
Err(e) => {
#[cfg(any(target_os = "linux", target_os = "android"))]
{
epoll::delete(&state.poll_fd, client)?;
}
#[cfg(any(
target_os = "dragonfly",
target_os = "freebsd",
target_os = "netbsd",
target_os = "openbsd",
target_os = "macos"
))]
{
use rustix::event::kqueue::*;
use std::os::unix::io::{AsFd, AsRawFd};
let evt = Event::new(
EventFilter::Read(client.as_fd().as_raw_fd()),
EventFlags::DELETE,
client_id.as_u64() as isize,
);
let mut events = Vec::new();
unsafe {
kevent(&state.poll_fd, &[evt], &mut events, None)
.map(|_| ())?;
}
}
return Err(e);
}
};
dispatched += 1;
if same_interface(object.interface, &WL_DISPLAY_INTERFACE) {
client.handle_display_request(message, &mut state.registry);
continue;
} else if same_interface(object.interface, &WL_REGISTRY_INTERFACE) {
if let Some((client, global, object, handler)) =
client.handle_registry_request(message, &mut state.registry)
{
DispatchAction::Bind { client, global, object, handler }
} else {
continue;
}
} else {
let object_id = InnerObjectId {
id: message.sender_id,
serial: object.data.serial,
interface: object.interface,
client_id: client.id.clone(),
};
let opcode = message.opcode;
let (arguments, is_destructor, created_id) =
match client.process_request(&object, message) {
Some(args) => args,
None => continue,
};
// Return the whole set to invoke the callback while handle is not borrower via client
DispatchAction::Request {
object,
object_id,
opcode,
arguments,
is_destructor,
created_id,
}
}
} else {
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidInput,
"Invalid client ID",
));
}
};
match action {
DispatchAction::Request {
object,
object_id,
opcode,
arguments,
is_destructor,
created_id,
} => {
// temporarily unlock the state Mutex while this request is dispatched
std::mem::drop(state);
let ret = object.data.user_data.clone().request(
&handle.clone(),
data,
ClientId { id: client_id.clone() },
Message {
sender_id: ObjectId { id: object_id.clone() },
opcode,
args: arguments,
},
);
if is_destructor {
object.data.user_data.clone().destroyed(
&handle.clone(),
data,
ClientId { id: client_id.clone() },
ObjectId { id: object_id.clone() },
);
}
// acquire the lock again and continue
state = self.state.lock().unwrap();
if is_destructor {
if let Ok(client) = state.clients.get_client_mut(client_id.clone()) {
client.send_delete_id(object_id);
}
}
match (created_id, ret) {
(Some(child_id), Some(child_data)) => {
if let Ok(client) = state.clients.get_client_mut(client_id.clone()) {
client
.map
.with(child_id.id, |obj| obj.data.user_data = child_data)
.unwrap();
}
}
(None, None) => {}
(Some(child_id), None) => {
// Allow the callback to not return any data if the client is already dead (typically
// if the callback provoked a protocol error)
if let Ok(client) = state.clients.get_client(client_id.clone()) {
if !client.killed {
panic!(
"Callback creating object {} did not provide any object data.",
child_id
);
}
}
}
(None, Some(_)) => {
panic!("An object data was returned from a callback not creating any object");
}
}
// dropping the object calls destructors from which users could call into wayland-backend again.
// so lets release and relock the state again, to avoid a deadlock
std::mem::drop(state);
std::mem::drop(object);
state = self.state.lock().unwrap();
}
DispatchAction::Bind { object, client, global, handler } => {
// temporarily unlock the state Mutex while this request is dispatched
std::mem::drop(state);
let child_data = handler.bind(
&handle.clone(),
data,
ClientId { id: client.clone() },
GlobalId { id: global },
ObjectId { id: object.clone() },
);
// acquire the lock again and continue
state = self.state.lock().unwrap();
if let Ok(client) = state.clients.get_client_mut(client.clone()) {
client.map.with(object.id, |obj| obj.data.user_data = child_data).unwrap();
}
}
}
}
Ok(dispatched)
}
}
enum DispatchAction<D: 'static> {
Request {
object: Object<Data<D>>,
object_id: InnerObjectId,
opcode: u16,
arguments: SmallVec<[Argument<ObjectId, OwnedFd>; 4]>,
is_destructor: bool,
created_id: Option<InnerObjectId>,
},
Bind {
object: InnerObjectId,
client: InnerClientId,
global: InnerGlobalId,
handler: Arc<dyn GlobalHandler<D>>,
},
}