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 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
// This module requires to be work under `cfg(madsim)` so we will allow
// dead code and unused variables.
#![allow(unused_imports)]
#![allow(unused_variables)]
#![allow(dead_code)]
use std::any::Any;
use std::cmp::min;
use std::collections::HashMap;
use std::fmt::Debug;
use std::future::Future;
use std::io::Result;
use std::io::SeekFrom;
use std::net::SocketAddr;
use std::sync::Arc;
use std::sync::Mutex;
use std::task::Context;
use std::task::Poll;
use bytes::Bytes;
#[cfg(madsim)]
use madsim::net::Endpoint;
#[cfg(madsim)]
use madsim::net::Payload;
use crate::raw::*;
use crate::*;
/// Add deterministic simulation for async operations, powered by [`madsim`](https://docs.rs/madsim/latest/madsim/).
///
/// # Note
///
/// - blocking operations are not supported, as [`madsim`](https://docs.rs/madsim/latest/madsim/) is async only.
///
///
/// # Examples
///
/// ```no_build
/// use std::time::Duration;
///
/// use madsim::net::NetSim;
/// use madsim::runtime::Handle;
/// use madsim::time::sleep;
/// use opendal::layers::MadsimLayer;
/// use opendal::layers::MadsimServer;
/// use opendal::services;
/// use opendal::Operator;
///
/// #[cfg(madsim)]
/// #[madsim::test]
/// async fn deterministic_simulation_test() {
/// let handle = Handle::current();
/// let ip1 = "10.0.0.1".parse().unwrap();
/// let ip2 = "10.0.0.2".parse().unwrap();
/// let server_addr = "10.0.0.1:2379".parse().unwrap();
/// let server = handle.create_node().name("server").ip(ip1).build();
/// let client = handle.create_node().name("client").ip(ip2).build();
///
/// server.spawn(async move {
/// SimServer::serve(server_addr).await.unwrap();
/// });
/// sleep(Duration::from_secs(1)).await;
///
/// let handle = client.spawn(async move {
/// let mut builder = services::Fs::default();
/// builder.root(".");
/// let op = Operator::new(builder)
/// .unwrap()
/// .layer(MadsimLayer::new(server_addr))
/// .finish();
///
/// let path = "hello.txt";
/// let data = "Hello, World!";
/// op.write(path, data).await.unwrap();
/// assert_eq!(data.as_bytes(), op.read(path).await.unwrap());
/// });
/// handle.await.unwrap();
/// }
/// ```
/// To enable logging output, please set `RUSTFLAGS="--cfg madsim"`:
/// ```shell
/// RUSTFLAGS="--cfg madsim" cargo test
/// ```
#[derive(Debug, Copy, Clone)]
pub struct MadsimLayer {
#[cfg(madsim)]
addr: SocketAddr,
}
impl MadsimLayer {
/// Create new madsim layer
pub fn new(endpoint: &str) -> Self {
#[cfg(madsim)]
{
Self {
addr: endpoint.parse().unwrap(),
}
}
#[cfg(not(madsim))]
{
unreachable!("madsim is not enabled")
}
}
}
impl<A: Access> Layer<A> for MadsimLayer {
type LayeredAccess = MadsimAccessor;
fn layer(&self, _: A) -> Self::LayeredAccess {
#[cfg(madsim)]
{
MadsimAccessor { addr: self.addr }
}
#[cfg(not(madsim))]
{
unreachable!("madsim is not enabled")
}
}
}
#[derive(Debug)]
pub struct MadsimAccessor {
#[cfg(madsim)]
addr: SocketAddr,
}
impl LayeredAccess for MadsimAccessor {
type Inner = ();
type Reader = MadsimReader;
type BlockingReader = ();
type Writer = MadsimWriter;
type BlockingWriter = ();
type Lister = MadsimLister;
type BlockingLister = ();
fn inner(&self) -> &Self::Inner {
&()
}
fn metadata(&self) -> AccessorInfo {
let mut info = AccessorInfo::default();
info.set_name("madsim");
info.set_native_capability(Capability {
read: true,
write: true,
..Default::default()
});
info
}
async fn read(&self, path: &str, args: OpRead) -> crate::Result<(RpRead, Self::Reader)> {
#[cfg(madsim)]
{
let req = Request::Read(path.to_string(), args);
let ep = Endpoint::connect(self.addr)
.await
.expect("fail to connect to sim server");
let (tx, mut rx) = ep
.connect1(self.addr)
.await
.expect("fail to connect1 to sim server");
tx.send(Box::new(req))
.await
.expect("fail to send request to sim server");
let resp = rx
.recv()
.await
.expect("fail to recv response from sim server");
let resp = resp
.downcast::<ReadResponse>()
.expect("fail to downcast response to ReadResponse");
let content_length = resp.data.as_ref().map(|b| b.len()).unwrap_or(0);
Ok((RpRead::new(), MadsimReader { data: resp.data }))
}
#[cfg(not(madsim))]
{
unreachable!("madsim is not enabled")
}
}
async fn write(&self, path: &str, args: OpWrite) -> crate::Result<(RpWrite, Self::Writer)> {
#[cfg(madsim)]
{
Ok((
RpWrite::default(),
MadsimWriter {
path: path.to_string(),
args,
addr: self.addr,
},
))
}
#[cfg(not(madsim))]
{
unreachable!("madsim is not enabled")
}
}
async fn list(&self, path: &str, args: OpList) -> crate::Result<(RpList, Self::Lister)> {
Err(Error::new(
ErrorKind::Unsupported,
"will be supported in the future",
))
}
fn blocking_read(
&self,
path: &str,
args: OpRead,
) -> crate::Result<(RpRead, Self::BlockingReader)> {
Err(Error::new(
ErrorKind::Unsupported,
"will not be supported in MadsimLayer",
))
}
fn blocking_write(
&self,
path: &str,
args: OpWrite,
) -> crate::Result<(RpWrite, Self::BlockingWriter)> {
Err(Error::new(
ErrorKind::Unsupported,
"will not be supported in MadsimLayer",
))
}
fn blocking_list(
&self,
path: &str,
args: OpList,
) -> crate::Result<(RpList, Self::BlockingLister)> {
Err(Error::new(
ErrorKind::Unsupported,
"will not be supported in MadsimLayer",
))
}
}
pub struct MadsimReader {
data: Option<Bytes>,
}
impl oio::Read for MadsimReader {
async fn read_at(&self, offset: u64, limit: usize) -> crate::Result<Buffer> {
if let Some(ref data) = self.data {
let size = min(limit, data.len());
Ok(data.clone().split_to(size).into())
} else {
Ok(Buffer::new())
}
}
}
pub struct MadsimWriter {
#[cfg(madsim)]
path: String,
#[cfg(madsim)]
args: OpWrite,
#[cfg(madsim)]
addr: SocketAddr,
}
impl oio::Write for MadsimWriter {
async fn write(&mut self, bs: Buffer) -> crate::Result<usize> {
#[cfg(madsim)]
{
let req = Request::Write(self.path.to_string(), bs);
let ep = Endpoint::bind(self.addr).await?;
let (tx, mut rx) = ep.connect1(self.addr).await?;
tx.send(Box::new(req)).await?;
rx.recv().await?;
Ok(())
}
#[cfg(not(madsim))]
{
unreachable!("madsim is not enabled")
}
}
async fn abort(&mut self) -> crate::Result<()> {
Err(Error::new(
ErrorKind::Unsupported,
"will be supported in the future",
))
}
async fn close(&mut self) -> crate::Result<()> {
Ok(())
}
}
pub struct MadsimLister {}
impl oio::List for MadsimLister {
async fn next(&mut self) -> crate::Result<Option<oio::Entry>> {
Err(Error::new(
ErrorKind::Unsupported,
"will be supported in the future",
))
}
}
/// A simulated server.This an experimental feature, docs are not ready yet.
#[derive(Default, Clone)]
pub struct MadsimServer;
impl MadsimServer {
/// Start serving as madsim server.
pub async fn serve(addr: SocketAddr) -> Result<()> {
#[cfg(madsim)]
{
let ep = Endpoint::bind(addr).await?;
let service = Arc::new(SimService::default());
loop {
let (tx, mut rx, _) = ep.accept1().await?;
let service = service.clone();
madsim::task::spawn(async move {
let request = *rx
.recv()
.await?
.downcast::<Request>()
.expect("invalid request");
let response = match request {
Request::Read(path, args) => {
Box::new(service.read(&path, args).await) as Payload
}
Request::Write(path, args) => {
Box::new(service.write(&path, args).await) as Payload
}
};
tx.send(response).await?;
Ok(()) as Result<()>
});
}
}
#[cfg(not(madsim))]
{
unreachable!("madsim is not enabled")
}
}
}
enum Request {
Read(String, OpRead),
Write(String, Bytes),
}
#[derive(Default)]
pub struct SimService {
inner: Mutex<HashMap<String, Bytes>>,
}
impl SimService {
async fn read(&self, path: &str, args: OpRead) -> ReadResponse {
let inner = self.inner.lock().unwrap();
let data = inner.get(path);
ReadResponse {
data: data.cloned(),
}
}
async fn write(&self, path: &str, data: Bytes) -> WriteResponse {
let mut inner = self.inner.lock().unwrap();
inner.insert(path.to_string(), data);
WriteResponse {}
}
}
struct ReadResponse {
data: Option<Bytes>,
}
struct WriteResponse {}
#[cfg(test)]
#[cfg(madsim)]
mod test {
use std::time::Duration;
use madsim::runtime::Handle;
use madsim::time::sleep;
use super::*;
use crate::services;
use crate::Operator;
#[madsim::test]
async fn test_madsim_layer() {
let handle = Handle::current();
let ip1 = "10.0.0.1".parse().unwrap();
let ip2 = "10.0.0.2".parse().unwrap();
let server_addr = "10.0.0.1:2379";
let server = handle.create_node().name("server").ip(ip1).build();
let client = handle.create_node().name("client").ip(ip2).build();
server.spawn(async move {
MadsimServer::serve(server_addr.parse().unwrap())
.await
.unwrap();
});
sleep(Duration::from_secs(1)).await;
let handle = client.spawn(async move {
let mut builder = services::Fs::default();
builder.root(".");
let op = Operator::new(builder)
.unwrap()
.layer(MadsimLayer::new(server_addr))
.finish();
let path = "hello.txt";
let data = "Hello, World!";
op.write(path, data).await.unwrap();
assert_eq!(data.as_bytes(), op.read(path).await.unwrap());
});
handle.await.unwrap();
}
}