From 0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 19 Apr 2024 03:47:29 +0200 Subject: Adding upstream version 115.8.0esr. Signed-off-by: Daniel Baumann --- gfx/wr/webrender_api/src/channel.rs | 180 ++++++++++++++++++++++++++++++++++++ 1 file changed, 180 insertions(+) create mode 100644 gfx/wr/webrender_api/src/channel.rs (limited to 'gfx/wr/webrender_api/src/channel.rs') diff --git a/gfx/wr/webrender_api/src/channel.rs b/gfx/wr/webrender_api/src/channel.rs new file mode 100644 index 0000000000..7d21c6e433 --- /dev/null +++ b/gfx/wr/webrender_api/src/channel.rs @@ -0,0 +1,180 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +use crate::{Epoch, PipelineId}; +use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt}; +use serde::{Deserialize, Deserializer, Serialize, Serializer}; +use std::io::{self, Cursor, Error, ErrorKind, Read}; +use std::mem; + +pub use crossbeam_channel as crossbeam; + +#[cfg(not(target_os = "windows"))] +pub use crossbeam_channel::{Sender, Receiver}; + +#[cfg(target_os = "windows")] +pub use std::sync::mpsc::{Sender, Receiver}; + +#[derive(Clone)] +pub struct Payload { + /// An epoch used to get the proper payload for a pipeline id frame request. + /// + /// TODO(emilio): Is this still relevant? We send the messages for the same + /// pipeline in order, so we shouldn't need it. Seems like this was only + /// wallpapering (in most cases) the underlying problem in #991. + pub epoch: Epoch, + /// A pipeline id to key the payload with, along with the epoch. + pub pipeline_id: PipelineId, + pub display_list_data: Vec, +} + +impl Payload { + /// Convert the payload to a raw byte vector, in order for it to be + /// efficiently shared via shmem, for example. + /// This is a helper static method working on a slice. + pub fn construct_data(epoch: Epoch, pipeline_id: PipelineId, dl_data: &[u8]) -> Vec { + let mut data = Vec::with_capacity( + mem::size_of::() + 2 * mem::size_of::() + mem::size_of::() + dl_data.len(), + ); + data.write_u32::(epoch.0).unwrap(); + data.write_u32::(pipeline_id.0).unwrap(); + data.write_u32::(pipeline_id.1).unwrap(); + data.write_u64::(dl_data.len() as u64) + .unwrap(); + data.extend_from_slice(dl_data); + data + } + /// Convert the payload to a raw byte vector, in order for it to be + /// efficiently shared via shmem, for example. + pub fn to_data(&self) -> Vec { + Self::construct_data(self.epoch, self.pipeline_id, &self.display_list_data) + } + + /// Deserializes the given payload from a raw byte vector. + pub fn from_data(data: &[u8]) -> Payload { + let mut payload_reader = Cursor::new(data); + let epoch = Epoch(payload_reader.read_u32::().unwrap()); + let pipeline_id = PipelineId( + payload_reader.read_u32::().unwrap(), + payload_reader.read_u32::().unwrap(), + ); + + let dl_size = payload_reader.read_u64::().unwrap() as usize; + let mut built_display_list_data = vec![0; dl_size]; + payload_reader + .read_exact(&mut built_display_list_data[..]) + .unwrap(); + + assert_eq!(payload_reader.position(), data.len() as u64); + + Payload { + epoch, + pipeline_id, + display_list_data: built_display_list_data, + } + } +} + +pub type PayloadSender = MsgSender; + +pub type PayloadReceiver = MsgReceiver; + +pub struct MsgReceiver { + rx: Receiver, +} + +impl MsgReceiver { + pub fn recv(&self) -> Result { + self.rx.recv().map_err(|e| io::Error::new(ErrorKind::Other, e.to_string())) + } + + pub fn to_crossbeam_receiver(self) -> Receiver { + self.rx + } +} + +#[derive(Clone)] +pub struct MsgSender { + tx: Sender, +} + +impl MsgSender { + pub fn send(&self, data: T) -> Result<(), Error> { + self.tx.send(data).map_err(|_| Error::new(ErrorKind::Other, "cannot send on closed channel")) + } +} + +pub fn payload_channel() -> Result<(PayloadSender, PayloadReceiver), Error> { + let (tx, rx) = unbounded_channel(); + Ok((PayloadSender { tx }, PayloadReceiver { rx })) +} + +pub fn msg_channel() -> Result<(MsgSender, MsgReceiver), Error> { + let (tx, rx) = unbounded_channel(); + Ok((MsgSender { tx }, MsgReceiver { rx })) +} + +/// +/// These serialize methods are needed to satisfy the compiler +/// which uses these implementations for the recording tool. +/// The recording tool only outputs messages that don't contain +/// Senders or Receivers, so in theory these should never be +/// called in the in-process config. If they are called, +/// there may be a bug in the messages that the replay tool is writing. +/// + +impl Serialize for MsgSender { + fn serialize(&self, _: S) -> Result { + unreachable!(); + } +} + +impl<'de, T> Deserialize<'de> for MsgSender { + fn deserialize(_: D) -> Result, D::Error> + where D: Deserializer<'de> { + unreachable!(); + } +} + +/// A create a channel intended for one-shot uses, for example the channels +/// created to block on a synchronous query and then discarded, +#[cfg(not(target_os = "windows"))] +pub fn single_msg_channel() -> (Sender, Receiver) { + crossbeam_channel::bounded(1) +} + +/// A fast MPMC message channel that can hold a fixed number of messages. +/// +/// If the channel is full, the sender will block upon sending extra messages +/// until the receiver has consumed some messages. +/// The capacity parameter should be chosen either: +/// - high enough to avoid blocking on the common cases, +/// - or, on the contrary, using the blocking behavior as a means to prevent +/// fast producers from building up work faster than it is consumed. +#[cfg(not(target_os = "windows"))] +pub fn fast_channel(capacity: usize) -> (Sender, Receiver) { + crossbeam_channel::bounded(capacity) +} + +/// Creates an MPMC channel that is a bit slower than the fast_channel but doesn't +/// have a limit on the number of messages held at a given time and therefore +/// doesn't block when sending. +#[cfg(not(target_os = "windows"))] +pub use crossbeam_channel::unbounded as unbounded_channel; + + +#[cfg(target_os = "windows")] +pub fn fast_channel(_cap: usize) -> (Sender, Receiver) { + std::sync::mpsc::channel() +} + +#[cfg(target_os = "windows")] +pub fn unbounded_channel() -> (Sender, Receiver) { + std::sync::mpsc::channel() +} + +#[cfg(target_os = "windows")] +pub fn single_msg_channel() -> (Sender, Receiver) { + std::sync::mpsc::channel() +} -- cgit v1.2.3