Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove limit maximum number of files #11

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ publish = false
libc = "0.2.153"
borsh = { version = "1.3.1", features = ["derive"] }
walkdir = "2.5.0"
parking_lot = "0.12.3"

[profile.dev]
panic = "abort"
Expand Down
123 changes: 100 additions & 23 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ use std::fs::File;
use std::io::{Error, ErrorKind, Read, Result, Write};
use std::net::{SocketAddr, TcpStream};
use std::os::fd::AsRawFd;
use std::path::Path;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::{mpsc, Arc, Mutex};
use std::time::Instant;
use walkdir::WalkDir;
Expand Down Expand Up @@ -56,7 +55,7 @@ Receiver options:
to 32 is probably overkill.
";

const WIRE_PROTO_VERSION: u16 = 1;
const WIRE_PROTO_VERSION: u16 = 2;
const MAX_CHUNK_LEN: u64 = 4096 * 64;

/// Metadata about all the files we want to transfer.
Expand Down Expand Up @@ -104,7 +103,7 @@ impl TransferPlan {
fn assert_paths_relative(&self) {
for file in &self.files {
assert!(
!file.name.starts_with("/"),
!file.name.starts_with('/'),
"Transferring files with an absolute path name is not allowed.",
);
}
Expand All @@ -113,11 +112,11 @@ impl TransferPlan {

/// The index of a file in the transfer plan.
#[derive(BorshDeserialize, BorshSerialize, Copy, Clone, Debug, Eq, Hash, PartialEq)]
struct FileId(u16);
struct FileId(u32);

impl FileId {
fn from_usize(i: usize) -> FileId {
assert!(i < u16::MAX as usize, "Can transfer at most 2^16 files.");
assert!(i < u32::MAX as usize, "Can transfer at most 2^32 files.");
FileId(i as _)
}
}
Expand Down Expand Up @@ -190,21 +189,27 @@ fn print_progress(offset: u64, len: u64, start_time: Instant) {
);
}

enum SendStateInner {
Pending { fname: PathBuf },
InProgress { file: File, offset: u64 },
Done,
}

struct SendState {
id: FileId,
len: u64,
offset: AtomicU64,
in_file: File,
state: parking_lot::Mutex<SendStateInner>,
}

enum SendResult {
Done,
FileVanished,
Progress { bytes_sent: u64 },
}

/// Metadata about a chunk of data that follows.
///
/// The Borsh-generated representation of this is zero-overhead (14 bytes).
/// The Borsh-generated representation of this is zero-overhead (16 bytes).
#[derive(BorshDeserialize, BorshSerialize, Debug)]
struct ChunkHeader {
/// Which file is the chunk from?
Expand All @@ -218,8 +223,8 @@ struct ChunkHeader {
}

impl ChunkHeader {
fn to_bytes(&self) -> [u8; 14] {
let mut buffer = [0_u8; 14];
fn to_bytes(&self) -> [u8; 16] {
let mut buffer = [0_u8; 16];
let mut cursor = std::io::Cursor::new(&mut buffer[..]);
self.serialize(&mut cursor)
.expect("Writing to memory never fails.");
Expand All @@ -229,10 +234,44 @@ impl ChunkHeader {

impl SendState {
pub fn send_one(&self, start_time: Instant, out: &mut TcpStream) -> Result<SendResult> {
let offset = self.offset.fetch_add(MAX_CHUNK_LEN, Ordering::SeqCst);
// By deferring the opening of the file descriptor to this point,
// we effectively limit the amount of open files to the amount of send threads.
// However, this now introduces the possibility of files getting deleted between
// getting listed and their turn for transfer.
// A vanishing file is expected, it is not a transfer-terminating event.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does mess up the progress measurement, but I suppose we could treat a vanished file as instantly completing all of its size bytes. (Which would mess up transfer rate estimates, but I think that’s okay. Ah oh actually we could decrement the total we expect if we see a vanishing file.)

let mut state = self.state.lock();
let (offset, in_fd) = match *state {
SendStateInner::Pending { ref fname } => {
let res = std::fs::File::open(fname);
if let Err(ref e) = res {
if e.kind() == std::io::ErrorKind::NotFound {
return Ok(SendResult::FileVanished);
}
}
let res = res?;
DavidVentura marked this conversation as resolved.
Show resolved Hide resolved
let fd = res.as_raw_fd();
*state = SendStateInner::InProgress {
file: res,
offset: 0,
};
(0, fd)
}
SendStateInner::Done => {
return Ok(SendResult::Done);
}
SendStateInner::InProgress {
ref file,
mut offset,
} => {
offset += MAX_CHUNK_LEN;
(offset, file.as_raw_fd())
}
};

let end = self.len.min(offset + MAX_CHUNK_LEN);

if offset >= self.len || offset >= end {
*state = SendStateInner::Done;
return Ok(SendResult::Done);
}
DavidVentura marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -252,9 +291,8 @@ impl SendState {

let end = end as i64;
let mut off = offset as i64;
let out_fd = out.as_raw_fd();
let in_fd = self.in_file.as_raw_fd();
let mut total_written: u64 = 0;
let out_fd = out.as_raw_fd();
while off < end {
let count = (end - off) as usize;
// Note, sendfile advances the offset by the number of bytes written
Expand Down Expand Up @@ -308,17 +346,17 @@ fn main_send(
let mut send_states = Vec::new();

for (i, fname) in all_filenames_from_path_names(fnames)?.iter().enumerate() {
let file = std::fs::File::open(&fname)?;
let metadata = file.metadata()?;
let metadata = std::fs::metadata(fname)?;
let file_plan = FilePlan {
name: fname.clone(),
len: metadata.len(),
};
let state = SendState {
id: FileId::from_usize(i),
len: metadata.len(),
offset: AtomicU64::new(0),
in_file: file,
state: parking_lot::Mutex::new(SendStateInner::Pending {
fname: fname.into(),
}),
};
plan.files.push(file_plan);
send_states.push(state);
Expand Down Expand Up @@ -363,7 +401,7 @@ fn main_send(
// Stop the listener, don't send anything over our new connection.
let is_done = state_arc
.iter()
.all(|f| f.offset.load(Ordering::SeqCst) >= f.len);
.all(|f| matches!(*f.state.lock(), SendStateInner::Done));
if is_done {
break;
}
Expand All @@ -389,6 +427,9 @@ fn main_send(
std::thread::sleep(to_wait.unwrap());
}
match file.send_one(start_time, &mut stream) {
Ok(SendResult::FileVanished) => {
println!("File {:?} vanished", file.id);
}
Ok(SendResult::Progress {
bytes_sent: bytes_written,
}) => {
Expand Down Expand Up @@ -427,8 +468,6 @@ struct Chunk {
struct FileReceiver {
fname: String,

/// The file we’re writing to, if we have started writing.
///
/// We don’t open the file immediately so we don’t create a zero-sized file
/// when a transfer fails. We only open the file after we have at least some
/// data for it.
Expand Down Expand Up @@ -488,7 +527,6 @@ impl FileReceiver {
self.offset += chunk.data.len() as u64;
}

self.out_file = Some(out_file);
DavidVentura marked this conversation as resolved.
Show resolved Hide resolved
Ok(())
}
}
Expand Down Expand Up @@ -571,7 +609,7 @@ fn main_recv(
// Read a chunk header. If we hit EOF, that is not an error, it
// means that the sender has nothing more to send so we can just
// exit here.
let mut buf = [0u8; 14];
let mut buf = [0u8; 16];
match stream.read_exact(&mut buf) {
Ok(..) => {}
Err(err) if err.kind() == ErrorKind::UnexpectedEof => break,
Expand Down Expand Up @@ -637,10 +675,12 @@ fn main_recv(
#[cfg(test)]
mod tests {
use super::*;
use std::env;
use std::{
net::{IpAddr, Ipv4Addr},
thread,
};
use tempfile::TempDir;

#[test]
fn test_accepts_valid_protocol() {
Expand Down Expand Up @@ -717,4 +757,41 @@ mod tests {
["0", "a/1", "a/b/2"].map(|f| base_path.join(f).to_str().unwrap().to_owned())
);
}

#[test]
fn test_sends_20_thousand_files() {
let (events_tx, events_rx) = std::sync::mpsc::channel::<SenderEvent>();
env::set_current_dir("/tmp/").unwrap();
let cwd = env::current_dir().unwrap();
thread::spawn(|| {
let td = TempDir::new_in(".").unwrap();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably better to run this on a ramdisk, I didn’t do the math to check if my worry is justified, but I am worried about burning through my SSD if I run this on my laptop.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's now done in this weird fashion because we don't allow sending absolute paths

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, right, yes. But we could chdir into a directory in /tmp and run from there? (Or does that break the Rust test runner which by default runs tests in parallel?) (Sorry for being so paranoid, but I seem to be very good at corrupting btrfs file systems even when I’m not actively trying, and my root is on btrfs, I’m not very eager to tempt fate like this 🙊)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, it is now like that (chdir to /tmp) which is what I meant by "a weird fashion"

let tmp_path = td.path().strip_prefix(cwd).unwrap();
let mut fnames = Vec::new();
for i in 0..20_000 {
let path = tmp_path.join(i.to_string());
fnames.push(path.clone().into_os_string().into_string().unwrap());
let mut f = std::fs::File::create(path).unwrap();
f.write(&[1, 2, 3]).unwrap();
}
main_send(
SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 0),
&fnames,
1,
events_tx,
None,
)
.unwrap();
});
match events_rx.recv().unwrap() {
SenderEvent::Listening(port) => {
main_recv(
SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), port),
"1",
WriteMode::Force,
1,
)
.unwrap();
}
}
}
}