Skip to content

Commit

Permalink
Merge #2547
Browse files Browse the repository at this point in the history
2547: fix(engine-dylib): do not keep temp file and delete it automatically r=syrusakbary a=bnjjj

close #2501

# Description
This PR plan to fix the issue #2501 
I know the implementation using Drop trait is not the best way to implement it. Maybe I need more knowledge about engine lifecycle or adding a trait method to clean any artifacts we create when using an engine. Feel free to give me more details about how I could implement this in a better way.


Co-authored-by: Benjamin Coenen <[email protected]>
  • Loading branch information
bors[bot] and bnjjj authored Sep 1, 2021
2 parents 35be1e2 + 8d8ee21 commit d18d2c7
Showing 1 changed file with 25 additions and 5 deletions.
30 changes: 25 additions & 5 deletions lib/engine-dylib/src/artifact.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ use std::path::{Path, PathBuf};
use std::process::Command;
use std::sync::{Arc, Mutex};
use tempfile::NamedTempFile;
use tracing::log::error;
#[cfg(feature = "compiler")]
use tracing::trace;
use wasmer_compiler::{
Expand Down Expand Up @@ -48,6 +49,7 @@ use wasmer_vm::{
#[derive(MemoryUsage)]
pub struct DylibArtifact {
dylib_path: PathBuf,
is_temporary: bool,
metadata: ModuleMetadata,
finished_functions: BoxedSlice<LocalFunctionIndex, FunctionBodyPtr>,
#[loupe(skip)]
Expand All @@ -58,6 +60,16 @@ pub struct DylibArtifact {
frame_info_registration: Mutex<Option<GlobalFrameInfoRegistration>>,
}

impl Drop for DylibArtifact {
fn drop(&mut self) {
if self.is_temporary {
if let Err(err) = std::fs::remove_file(&self.dylib_path) {
error!("cannot delete the temporary dylib artifact: {}", err);
}
}
}
}

fn to_compile_error(err: impl Error) -> CompileError {
CompileError::Codegen(err.to_string())
}
Expand Down Expand Up @@ -231,7 +243,7 @@ impl DylibArtifact {

// Re-open it.
let (mut file, filepath) = file.keep().map_err(to_compile_error)?;
file.write(&obj_bytes).map_err(to_compile_error)?;
file.write_all(&obj_bytes).map_err(to_compile_error)?;
filepath
}
None => {
Expand Down Expand Up @@ -261,7 +273,7 @@ impl DylibArtifact {
let (mut file, filepath) = file.keep().map_err(to_compile_error)?;
let obj_bytes = obj.write().map_err(to_compile_error)?;

file.write(&obj_bytes).map_err(to_compile_error)?;
file.write_all(&obj_bytes).map_err(to_compile_error)?;
filepath
}
};
Expand Down Expand Up @@ -368,12 +380,15 @@ impl DylibArtifact {

trace!("gcc command result {:?}", output);

if is_cross_compiling {
let mut artifact = if is_cross_compiling {
Self::from_parts_crosscompiled(metadata, output_filepath)
} else {
let lib = unsafe { Library::new(&output_filepath).map_err(to_compile_error)? };
Self::from_parts(&mut engine_inner, metadata, output_filepath, lib)
}
}?;
artifact.is_temporary = true;

Ok(artifact)
}

/// Get the default extension when serializing this artifact
Expand All @@ -400,6 +415,7 @@ impl DylibArtifact {
let signatures: PrimaryMap<SignatureIndex, VMSharedSignatureIndex> = PrimaryMap::new();
Ok(Self {
dylib_path,
is_temporary: false,
metadata,
finished_functions: finished_functions.into_boxed_slice(),
finished_function_call_trampolines: finished_function_call_trampolines
Expand Down Expand Up @@ -505,6 +521,7 @@ impl DylibArtifact {

Ok(Self {
dylib_path,
is_temporary: false,
metadata,
finished_functions: finished_functions.into_boxed_slice(),
finished_function_call_trampolines: finished_function_call_trampolines
Expand Down Expand Up @@ -546,7 +563,10 @@ impl DylibArtifact {
file.write_all(&bytes)?;
// We already checked for the header, so we don't need
// to check again.
Self::deserialize_from_file_unchecked(&engine, &path)
let mut artifact = Self::deserialize_from_file_unchecked(&engine, &path)?;
artifact.is_temporary = true;

Ok(artifact)
}

/// Deserialize a `DylibArtifact` from a file path.
Expand Down

0 comments on commit d18d2c7

Please sign in to comment.