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
#![deny(missing_docs)]
#![deny(warnings)]
#![deny(unsafe_code)]
#![doc = tx5_core::__doc_header!()]
//! # tx5
//!
//! Tx5 - The main holochain tx5 webrtc networking crate.
//!
//! # WebRTC Backend Features
//!
//! Tx5 can be backed currently by 1 of 2 backend webrtc libraries.
//!
//! - <b><i>`*`DEFAULT`*`</i></b> `backend-go-pion` - The pion webrtc library
//! writen in go (golang).
//! - [https://github.com/pion/webrtc](https://github.com/pion/webrtc)
//! - `backend-webrtc-rs` - The rust webrtc library.
//! - [https://github.com/webrtc-rs/webrtc](https://github.com/webrtc-rs/webrtc)
//!
//! The go pion library is currently the default as it is more mature
//! and well tested, but comes with some overhead of calling into a different
//! memory/runtime. When the rust library is stable enough for holochain's
//! needs, we will switch the default. To switch now, or if you want to
//! make sure the backend doesn't change out from under you, set
//! no-default-features and explicitly enable the backend of your choice.
#[cfg(any(
not(any(feature = "backend-go-pion", feature = "backend-webrtc-rs")),
all(feature = "backend-go-pion", feature = "backend-webrtc-rs"),
))]
compile_error!("Must specify exactly 1 webrtc backend");
/// Re-exported dependencies.
pub mod deps {
pub use tx5_core;
pub use tx5_core::deps::*;
pub use tx5_signal;
pub use tx5_signal::deps::*;
}
use deps::{serde, serde_json};
use tx5_core::Uniq;
pub use tx5_core::{Error, ErrorExt, Id, Result, Tx5Url};
pub mod actor;
mod back_buf;
pub use back_buf::*;
/// Helper extension trait for `Box<dyn bytes::Buf + 'static + Send>`.
pub trait BytesBufExt {
/// Convert into a `Vec<u8>`.
fn to_vec(self) -> Result<Vec<u8>>;
}
impl BytesBufExt for Box<dyn bytes::Buf + 'static + Send> {
fn to_vec(self) -> Result<Vec<u8>> {
use bytes::Buf;
use std::io::Read;
let mut out = Vec::with_capacity(self.remaining());
self.reader().read_to_end(&mut out)?;
Ok(out)
}
}
const FINISH: u64 = 1 << 63;
trait FinishExt: Sized {
fn set_finish(&self) -> Self;
fn unset_finish(&self) -> Self;
fn is_finish(&self) -> bool;
}
impl FinishExt for u64 {
fn set_finish(&self) -> Self {
*self | FINISH
}
fn unset_finish(&self) -> Self {
*self & !FINISH
}
fn is_finish(&self) -> bool {
*self & FINISH > 0
}
}
/// A set of distinct chunks of bytes that can be treated as a single unit
//#[derive(Clone, Default)]
#[derive(Default)]
struct BytesList(pub std::collections::VecDeque<bytes::Bytes>);
impl BytesList {
/// Construct a new BytesList.
pub fn new() -> Self {
Self::default()
}
/*
/// Construct a new BytesList with given capacity.
pub fn with_capacity(capacity: usize) -> Self {
Self(std::collections::VecDeque::with_capacity(capacity))
}
*/
/// Push a new bytes::Bytes into this BytesList.
pub fn push(&mut self, data: bytes::Bytes) {
if bytes::Buf::has_remaining(&data) {
self.0.push_back(data);
}
}
/// Convert into a trait object.
pub fn into_dyn(self) -> Box<dyn bytes::Buf + 'static + Send> {
Box::new(self)
}
/*
/// Copy data into a Vec<u8>. You should avoid this if possible.
pub fn to_vec(&self) -> Vec<u8> {
use std::io::Read;
let mut out = Vec::with_capacity(self.remaining());
// data is local, it can't error, safe to unwrap
self.clone().reader().read_to_end(&mut out).unwrap();
out
}
/// Extract the contents of this BytesList into a new one
pub fn extract(&mut self) -> Self {
Self(std::mem::take(&mut self.0))
}
/// Remove specified byte cnt from the front of this list as a new list.
/// Panics if self doesn't contain enough bytes.
#[allow(clippy::comparison_chain)] // clearer written explicitly
pub fn take_front(&mut self, mut cnt: usize) -> Self {
let mut out = BytesList::new();
loop {
let mut item = match self.0.pop_front() {
Some(item) => item,
None => panic!("UnexpectedEof"),
};
let rem = item.remaining();
if rem == cnt {
out.push(item);
return out;
} else if rem < cnt {
out.push(item);
cnt -= rem;
} else if rem > cnt {
out.push(item.split_to(cnt));
self.0.push_front(item);
return out;
}
}
}
*/
}
/*
impl From<std::collections::VecDeque<bytes::Bytes>> for BytesList {
#[inline(always)]
fn from(v: std::collections::VecDeque<bytes::Bytes>) -> Self {
Self(v)
}
}
impl From<bytes::Bytes> for BytesList {
#[inline(always)]
fn from(b: bytes::Bytes) -> Self {
let mut out = std::collections::VecDeque::with_capacity(8);
out.push_back(b);
out.into()
}
}
impl From<Vec<u8>> for BytesList {
#[inline(always)]
fn from(v: Vec<u8>) -> Self {
bytes::Bytes::from(v).into()
}
}
impl From<&[u8]> for BytesList {
#[inline(always)]
fn from(b: &[u8]) -> Self {
bytes::Bytes::copy_from_slice(b).into()
}
}
impl<const N: usize> From<&[u8; N]> for BytesList {
#[inline(always)]
fn from(b: &[u8; N]) -> Self {
bytes::Bytes::copy_from_slice(&b[..]).into()
}
}
*/
impl bytes::Buf for BytesList {
fn remaining(&self) -> usize {
self.0.iter().map(|b| b.remaining()).sum()
}
fn chunk(&self) -> &[u8] {
match self.0.get(0) {
Some(b) => b.chunk(),
None => &[],
}
}
#[allow(clippy::comparison_chain)] // clearer written explicitly
fn advance(&mut self, mut cnt: usize) {
loop {
let mut item = match self.0.pop_front() {
Some(item) => item,
None => return,
};
let rem = item.remaining();
if rem == cnt {
return;
} else if rem < cnt {
cnt -= rem;
} else if rem > cnt {
item.advance(cnt);
self.0.push_front(item);
return;
}
}
}
}
pub mod state;
mod config;
pub use config::*;
mod endpoint;
pub use endpoint::*;
fn divide_send<B: bytes::Buf>(
config: &dyn Config,
snd_ident: &std::sync::atomic::AtomicU64,
mut data: B,
) -> Result<Vec<BackBuf>> {
use std::io::Write;
let max_send_bytes = config.max_send_bytes();
if bytes::Buf::remaining(&data) > max_send_bytes as usize {
Err(Error::id("DataTooLarge"))
} else {
(|| {
let ident =
snd_ident.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
let mut buf_list = Vec::new();
const MAX_MSG: usize = (16 * 1024) - 8;
while data.has_remaining() {
let loc_len = std::cmp::min(data.remaining(), MAX_MSG);
let ident = if data.remaining() <= loc_len {
ident.set_finish()
} else {
ident.unset_finish()
};
tracing::trace!(ident=%ident.unset_finish(), is_finish=%ident.is_finish(), %loc_len, "prepare send");
let mut tmp =
bytes::Buf::reader(bytes::Buf::take(data, loc_len));
// TODO - reserve the bytes before writing
let mut buf = BackBuf::from_writer()?;
buf.write_all(&ident.to_le_bytes())?;
std::io::copy(&mut tmp, &mut buf)?;
buf_list.push(buf.finish());
data = tmp.into_inner().into_inner();
}
if buf_list.is_empty() {
let ident = ident.set_finish();
let mut buf = BackBuf::from_writer()?;
buf.write_all(&ident.to_le_bytes())?;
buf_list.push(buf.finish());
}
Ok(buf_list)
})()
}
}
#[cfg(test)]
mod test;