Skip to content

Don't execute a build when not enough memory is available #1279

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 16, 2021
Merged

Don't execute a build when not enough memory is available #1279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ pub struct Config {
pub(crate) toolchain: String,
pub(crate) build_cpu_limit: Option<u32>,
pub(crate) include_default_targets: bool,
pub(crate) disable_memory_limit: bool,
}

impl Config {
Expand Down Expand Up @@ -101,6 +102,7 @@ impl Config {
toolchain: env("CRATESFYI_TOOLCHAIN", "nightly".to_string())?,
build_cpu_limit: maybe_env("DOCS_RS_BUILD_CPU_LIMIT")?,
include_default_targets: env("DOCSRS_INCLUDE_DEFAULT_TARGETS", true)?,
disable_memory_limit: env("DOCSRS_DISABLE_MEMORY_LIMIT", false)?,
})
}
}
Expand Down
19 changes: 19 additions & 0 deletions src/docbuilder/rustwide_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use crate::utils::{copy_doc_dir, parse_rustc_version, CargoMetadata, GithubUpdat
use crate::{db::blacklist::is_blacklisted, utils::MetadataPackage};
use crate::{Config, Context, Index, Metrics, Storage};
use docsrs_metadata::{Metadata, DEFAULT_TARGETS, HOST_TARGET};
use failure::bail;
use failure::ResultExt;
use log::{debug, info, warn, LevelFilter};
use postgres::Client;
Expand Down Expand Up @@ -309,6 +310,24 @@ impl RustwideBuilder {
}

let limits = Limits::for_crate(&mut conn, name)?;
#[cfg(target_os = "linux")]
if !self.config.disable_memory_limit {
let mem_info = procfs::Meminfo::new().context("failed to read /proc/meminfo")?;
let available = mem_info
.mem_available
.expect("kernel version too old for determining memory limit");
if limits.memory() as u64 > available {
bail!("not enough memory to build {} {}: needed {} MiB, have {} MiB\nhelp: set DOCSRS_DISABLE_MEMORY_LIMIT=true to force a build",
name, version, limits.memory() / 1024 / 1024, available / 1024 / 1024
);
} else {
debug!(
"had enough memory: {} MiB > {} MiB",
limits.memory() / 1024 / 1024,
available / 1024 / 1024
);
}
}

let mut build_dir = self.workspace.build_dir(&format!("{}-{}", name, version));
build_dir.purge()?;
Expand Down