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

Don't flush in BufWriter destructor after a panic in write #31068

Merged
merged 1 commit into from
Jan 22, 2016
Merged
Changes from all 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
43 changes: 40 additions & 3 deletions src/libstd/io/buffered.rs
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,10 @@ impl<R: Seek> Seek for BufReader<R> {
pub struct BufWriter<W: Write> {
inner: Option<W>,
buf: Vec<u8>,
// #30888: If the inner writer panics in a call to write, we don't want to
// write the buffered data a second time in BufWriter's destructor. This
// flag tells the Drop impl if it should skip the flush.
panicked: bool,
}

/// An error returned by `into_inner` which combines an error that
Expand Down Expand Up @@ -364,6 +368,7 @@ impl<W: Write> BufWriter<W> {
BufWriter {
inner: Some(inner),
buf: Vec::with_capacity(cap),
panicked: false,
}
}

Expand All @@ -372,7 +377,11 @@ impl<W: Write> BufWriter<W> {
let len = self.buf.len();
let mut ret = Ok(());
while written < len {
match self.inner.as_mut().unwrap().write(&self.buf[written..]) {
self.panicked = true;
let r = self.inner.as_mut().unwrap().write(&self.buf[written..]);
self.panicked = false;

match r {
Ok(0) => {
ret = Err(Error::new(ErrorKind::WriteZero,
"failed to write the buffered data"));
Expand Down Expand Up @@ -455,7 +464,10 @@ impl<W: Write> Write for BufWriter<W> {
try!(self.flush_buf());
}
if buf.len() >= self.buf.capacity() {
self.inner.as_mut().unwrap().write(buf)
self.panicked = true;
let r = self.inner.as_mut().unwrap().write(buf);
self.panicked = false;
r
} else {
let amt = cmp::min(buf.len(), self.buf.capacity());
Write::write(&mut self.buf, &buf[..amt])
Expand Down Expand Up @@ -489,7 +501,7 @@ impl<W: Write + Seek> Seek for BufWriter<W> {
#[stable(feature = "rust1", since = "1.0.0")]
impl<W: Write> Drop for BufWriter<W> {
fn drop(&mut self) {
if self.inner.is_some() {
if self.inner.is_some() && !self.panicked {
// dtors should not panic, so we ignore a failed flush
let _r = self.flush_buf();
}
Expand Down Expand Up @@ -777,6 +789,8 @@ mod tests {
use prelude::v1::*;
use io::prelude::*;
use io::{self, BufReader, BufWriter, LineWriter, SeekFrom};
use sync::atomic::{AtomicUsize, Ordering};
use thread;
use test;

/// A dummy reader intended at testing short-reads propagation.
Expand Down Expand Up @@ -1065,6 +1079,29 @@ mod tests {
panic!();
}

#[test]
fn panic_in_write_doesnt_flush_in_drop() {
static WRITES: AtomicUsize = AtomicUsize::new(0);

struct PanicWriter;

impl Write for PanicWriter {
fn write(&mut self, _: &[u8]) -> io::Result<usize> {
WRITES.fetch_add(1, Ordering::SeqCst);
panic!();
}
fn flush(&mut self) -> io::Result<()> { Ok(()) }
}

thread::spawn(|| {
let mut writer = BufWriter::new(PanicWriter);
writer.write(b"hello world");
writer.flush();
}).join().err().unwrap();

assert_eq!(WRITES.load(Ordering::SeqCst), 1);
}

#[bench]
fn bench_buffered_reader(b: &mut test::Bencher) {
b.iter(|| {
Expand Down