Skip to content

Commit

Permalink
Rollup merge of rust-lang#128507 - Oneirical:testart-from-scratch, r=…
Browse files Browse the repository at this point in the history
…jieyouxu

Migrate `libtest-thread-limit` `run-make` test to rmake

Part of rust-lang#121876 and the associated [Google Summer of Code project](https://blog.rust-lang.org/2024/05/01/gsoc-2024-selected-projects.html).

Please try, but **only if normal CI is green**:

try-job: aarch64-apple
try-job: aarch64-gnu
  • Loading branch information
tgross35 authored Aug 23, 2024
2 parents 4a4d517 + 18b7735 commit 465118f
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 9 deletions.
1 change: 1 addition & 0 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3129,6 +3129,7 @@ dependencies = [
"bstr",
"build_helper",
"gimli 0.31.0",
"libc",
"object 0.36.3",
"regex",
"serde_json",
Expand Down
1 change: 1 addition & 0 deletions src/tools/run-make-support/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ regex = "1.8" # 1.8 to avoid memchr 2.6.0, as 2.5.0 is pinned in the workspace
gimli = "0.31.0"
build_helper = { path = "../build_helper" }
serde_json = "1.0"
libc = "0.2"
1 change: 1 addition & 0 deletions src/tools/run-make-support/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ pub mod rfs {
// Re-exports of third-party library crates.
pub use bstr;
pub use gimli;
pub use libc;
pub use object;
pub use regex;
pub use serde_json;
Expand Down
1 change: 0 additions & 1 deletion src/tools/tidy/src/allowed_run_make_makefiles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ run-make/incr-add-rust-src-component/Makefile
run-make/issue-84395-lto-embed-bitcode/Makefile
run-make/jobserver-error/Makefile
run-make/libs-through-symlinks/Makefile
run-make/libtest-thread-limit/Makefile
run-make/macos-deployment-target/Makefile
run-make/split-debuginfo/Makefile
run-make/symbol-mangling-hashed/Makefile
Expand Down
7 changes: 0 additions & 7 deletions tests/run-make/libtest-thread-limit/Makefile

This file was deleted.

62 changes: 62 additions & 0 deletions tests/run-make/libtest-thread-limit/rmake.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
// libtest used to panic if it hit the thread limit. This often resulted in spurious test failures
// (thread 'main' panicked at 'called Result::unwrap() on an Err value: Os
// { code: 11, kind: WouldBlock, message: "Resource temporarily unavailable" }' ...
// error: test failed, to rerun pass '--lib').
// Since the fix in #81546, the test should continue to run synchronously
// if it runs out of threads. Therefore, this test's final execution step
// should succeed without an error.
// See https://github.com/rust-lang/rust/pull/81546

//@ only-linux
// Reason: thread limit modification

use std::ffi::{self, CStr, CString};
use std::path::PathBuf;

use run_make_support::{libc, run, rustc};

fn main() {
rustc().input("test.rs").arg("--test").run();

// We need to emulate an environment for libtest where threads are exhausted and spawning
// new threads are guaranteed to fail. This was previously achieved by ulimit shell builtin
// that called out to prlimit64 underneath to set resource limits (specifically thread
// number limits). Now that we don't have a shell, we need to implement that ourselves.
// See https://linux.die.net/man/2/setrlimit

// The fork + exec is required because we cannot first try to limit the number of
// processes/threads to 1 and then try to spawn a new process to run the test. We need to
// setrlimit and run the libtest test program in the same process.
let pid = unsafe { libc::fork() };
assert!(pid >= 0);

// If the process ID is 0, this is the child process responsible for running the test
// program.
if pid == 0 {
let test = CString::new("test").unwrap();
// The argv array should be terminated with a NULL pointer.
let argv = [test.as_ptr(), std::ptr::null()];
// rlim_cur is soft limit, rlim_max is hard limit.
// By setting the limit very low (max 1), we ensure that libtest is unable to create new
// threads.
let rlimit = libc::rlimit { rlim_cur: 1, rlim_max: 1 };
// RLIMIT_NPROC: The maximum number of processes (or, more precisely on Linux,
// threads) that can be created for the real user ID of the calling process. Upon
// encountering this limit, fork(2) fails with the error EAGAIN.
// Therefore, set the resource limit to RLIMIT_NPROC.
let ret = unsafe { libc::setrlimit(libc::RLIMIT_NPROC, &rlimit as *const libc::rlimit) };
assert!(ret == 0);

// Finally, execute the 2 tests in test.rs.
let ret = unsafe { libc::execv(test.as_ptr(), argv.as_ptr()) };
assert!(ret == 0);
} else {
// Otherwise, other process IDs indicate that this is the parent process.

let mut status: libc::c_int = 0;
let ret = unsafe { libc::waitpid(pid, &mut status as *mut libc::c_int, 0) };
assert!(ret == pid);
assert!(libc::WIFEXITED(status));
assert!(libc::WEXITSTATUS(status) == 0);
}
}
7 changes: 6 additions & 1 deletion tests/run-make/libtest-thread-limit/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ fn spawn_thread_would_block() {
THREAD_ID.set(thread::current().id()).unwrap();
}

// Tests are run in alphabetical order, and the second test is dependent on the
// first to set THREAD_ID. Do not rename the tests in such a way that `test_run_in_same_thread`
// would run before `spawn_thread_would_block`.
// See https://doc.rust-lang.org/rustc/tests/index.html#--shuffle

#[test]
fn run_in_same_thread() {
fn test_run_in_same_thread() {
assert_eq!(*THREAD_ID.get().unwrap(), thread::current().id());
}

0 comments on commit 465118f

Please sign in to comment.