Merge pull request #66 from alexcrichton/rewrite-cargo-fix

Rewrite the `cargo fix` command

Author: alexcrichton

Cargo.toml

@@ -17,7 +17,6 @@ exclude = [
 ]
 
 [dependencies]
-quick-error = "1.2.1"
 serde = "1.0"
 serde_json = "1.0"
 serde_derive = "1.0"
@@ -33,6 +32,3 @@ tempdir = "0.3.5"
 members = [
     "cargo-fix",
 ]
-
-[patch.crates-io]
-rustfix = { path = "." }

cargo-fix/Cargo.toml

@@ -8,11 +8,17 @@ repository = "https://github.com/killercup/rustfix"
 documentation = "https://docs.rs/rustfix"
 readme = "README.md"
 
+[[bin]]
+name = "cargo-fix"
+test = false
+
 [dependencies]
-clap = "2.9.2"
-colored = "1.2.0"
-quick-error = "1.2.1"
-serde = "1.0"
-serde_json = "1.0"
-serde_derive = "1.0"
-rustfix = "0.2.0"
+failure = "0.1"
+rustfix = { path = "..", version = "0.2" }
+serde_json = "1"
+log = "0.4"
+env_logger = { version = "0.5", default-features = false }
+
+[dev-dependencies]
+difference = "2"
+url = "1"

cargo-fix/src/lock.rs

@@ -0,0 +1,163 @@
+//! An implementation of IPC locks, guaranteed to be released if a process dies
+//!
+//! This module implements a locking server/client where the main `cargo fix`
+//! process will start up a server and then all the client processes will
+//! connect to it. The main purpose of this file is to enusre that each crate
+//! (aka file entry point) is only fixed by one process at a time, currently
+//! concurrent fixes can't happen.
+//!
+//! The basic design here is to use a TCP server which is pretty portable across
+//! platforms. For simplicity it just uses threads as well. Clients connect to
+//! the main server, inform the server what its name is, and then wait for the
+//! server to give it the lock (aka write a byte).
+
+use std::collections::HashMap;
+use std::env;
+use std::io::{BufReader, BufRead, Read, Write};
+use std::net::{TcpStream, SocketAddr, TcpListener};
+use std::sync::{Arc, Mutex};
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::thread::{self, JoinHandle};
+
+use failure::{Error, ResultExt};
+
+pub struct Server {
+    listener: TcpListener,
+    threads: HashMap<String, ServerClient>,
+    done: Arc<AtomicBool>,
+}
+
+pub struct StartedServer {
+    done: Arc<AtomicBool>,
+    addr: SocketAddr,
+    thread: Option<JoinHandle<()>>,
+}
+
+pub struct Client {
+    _socket: TcpStream,
+}
+
+struct ServerClient {
+    thread: Option<JoinHandle<()>>,
+    lock: Arc<Mutex<(bool, Vec<TcpStream>)>>,
+}
+
+impl Server {
+    pub fn new() -> Result<Server, Error> {
+        let listener = TcpListener::bind("127.0.0.1:0")
+            .with_context(|_| "failed to bind TCP listener to manage locking")?;
+        env::set_var("__CARGO_FIX_SERVER", listener.local_addr()?.to_string());
+        Ok(Server {
+            listener,
+            threads: HashMap::new(),
+            done: Arc::new(AtomicBool::new(false)),
+        })
+    }
+
+    pub fn start(self) -> Result<StartedServer, Error> {
+        let addr = self.listener.local_addr()?;
+        let done = self.done.clone();
+        let thread = thread::spawn(|| {
+            self.run();
+        });
+        Ok(StartedServer {
+            addr,
+            thread: Some(thread),
+            done,
+        })
+    }
+
+    fn run(mut self) {
+        while let Ok((client, _)) = self.listener.accept() {
+            if self.done.load(Ordering::SeqCst) {
+                break
+            }
+
+            // Learn the name of our connected client to figure out if it needs
+            // to wait for another process to release the lock.
+            let mut client = BufReader::new(client);
+            let mut name = String::new();
+            if client.read_line(&mut name).is_err() {
+                continue
+            }
+            let client = client.into_inner();
+
+            // If this "named mutex" is already registered and the thread is
+            // still going, put it on the queue. Otherwise wait on the previous
+            // thread and we'll replace it just below.
+            if let Some(t) = self.threads.get_mut(&name) {
+                let mut state = t.lock.lock().unwrap();
+                if state.0 {
+                    state.1.push(client);
+                    continue
+                }
+                drop(t.thread.take().unwrap().join());
+            }
+
+            let lock = Arc::new(Mutex::new((true, vec![client])));
+            let lock2 = lock.clone();
+            let thread = thread::spawn(move || {
+                loop {
+                    let mut client = {
+                        let mut state = lock2.lock().unwrap();
+                        if state.1.len() == 0 {
+                            state.0 = false;
+                            break
+                        } else {
+                            state.1.remove(0)
+                        }
+                    };
+                    // Inform this client that it now has the lock and wait for
+                    // it to disconnect by waiting for EOF.
+                    if client.write_all(&[1]).is_err() {
+                        continue
+                    }
+                    let mut dst = Vec::new();
+                    drop(client.read_to_end(&mut dst));
+                }
+            });
+
+            self.threads.insert(name, ServerClient {
+                thread: Some(thread),
+                lock,
+            });
+        }
+    }
+}
+
+impl Drop for Server {
+    fn drop(&mut self) {
+        for (_, mut client) in self.threads.drain() {
+            if let Some(thread) = client.thread.take() {
+                drop(thread.join());
+            }
+        }
+    }
+}
+
+impl Drop for StartedServer {
+    fn drop(&mut self) {
+        self.done.store(true, Ordering::SeqCst);
+        // Ignore errors here as this is largely best-effort
+        if TcpStream::connect(&self.addr).is_err() {
+            return
+        }
+        drop(self.thread.take().unwrap().join());
+    }
+}
+
+impl Client {
+    pub fn lock(name: &str) -> Result<Client, Error> {
+        let addr = env::var("__CARGO_FIX_SERVER")
+            .map_err(|_| format_err!("locking strategy misconfigured"))?;
+        let mut client = TcpStream::connect(&addr)
+            .with_context(|_| "failed to connect to parent lock server")?;
+        client.write_all(name.as_bytes())
+            .and_then(|_| client.write_all(b"\n"))
+            .with_context(|_| "failed to write to lock server")?;
+        let mut buf = [0];
+        client.read_exact(&mut buf)
+            .with_context(|_| "failed to acquire lock")?;
+        Ok(Client { _socket: client })
+    }
+}