1#![deny(missing_docs)]
37#![deny(rustdoc::broken_intra_doc_links)]
38#![cfg(target_os = "linux")]
39#![cfg_attr(feature = "nightly", feature(internal_output_capture))]
40
41#[cfg(test)]
45extern crate self as reverie_ptrace;
46
47mod backend;
48#[cfg(any(test, target_arch = "aarch64"))]
49mod branch_step;
50mod capture;
51mod children;
52mod cp;
53#[allow(unused)]
54#[cfg(target_arch = "x86_64")]
55mod debug;
56#[cfg(target_arch = "x86_64")]
57pub mod decoder;
58mod descriptor_status;
59mod error;
60mod failure;
61mod gdbstub;
62mod injected_syscall;
63mod link_path;
64mod memory_map;
65#[cfg(all(test, target_arch = "x86_64"))]
66mod offset_step_interruption_tests;
67mod perf;
68mod pidfd_self;
69mod poll_on_wake;
70pub mod regs;
71mod segv_state;
72#[cfg(all(test, target_arch = "x86_64"))]
73mod signal_action_boundary_tests;
74mod signal_sets;
75mod sigtrap_state;
76mod stack;
77mod stats;
78mod task;
79pub mod testing;
80mod timer;
81mod tool_memory;
82mod tracer;
83mod validation;
84mod vdso;
85mod watch;
86
87pub use backend::PtraceBackend;
89pub use failure::BrokenSignalApproval;
90pub use failure::CapturedPrefix;
91pub use failure::LegacyCleanupDiagnostics;
92pub use failure::LegacyFailureProjection;
93pub use failure::PendingSigtrapAtStep;
94pub use failure::PtraceCallbackDecision;
95pub use failure::PtraceCallbackDiagnostic;
96pub use failure::PtraceCallbackOutcome;
97pub use failure::PtraceCallbackRefusal;
98pub use failure::PtraceCallbackStop;
99pub use failure::PtraceCleanupFailure;
100pub use failure::PtraceRunFailure;
101pub use failure::QueuedSigtrapAtStep;
102pub use failure::ToolRunCompletion;
103pub use failure::UnattributedSigtrap;
104pub use failure::UnprovenPrivateSyscallCompletion;
105pub use failure::UntracedStubSyscall;
106pub use injected_syscall::InjectedSyscallFrame;
107pub use perf::is_perf_supported;
108pub use perf::pmu_validation;
109pub use reverie::InGuestRcbCounter;
110use reverie::process::launch_window;
111pub use reverie::vdso::VdsoSyscallSite;
112#[cfg(target_arch = "x86_64")]
113pub use reverie::vdso::patch_current_vdso;
114#[cfg(target_arch = "x86_64")]
115pub use reverie::vdso::patch_current_vdso_trapping;
116#[cfg(target_arch = "x86_64")]
117pub use reverie::vdso::patch_current_vdso_trapping_owned;
118pub use stats::PtraceBackendStatsSnapshot;
119pub use stats::PtraceBackendStatsSource;
120pub use timer::PmuConfig;
121pub use timer::SKID_OVERSHOOT_MARKER;
122pub use timer::host_pmu_profile;
123pub use timer::set_pmu_config;
124pub use timer::set_skid_margin_override;
125pub use tool_memory::ToolMemory;
126pub use tracer::CleanupAdmissionRefused;
127pub use tracer::CleanupLookupError;
128pub use tracer::CleanupUnconfirmed;
129pub use tracer::GdbConnection;
130pub use tracer::InjectedCleanupUnconfirmed;
131pub use tracer::PendingPtraceCleanup;
132pub use tracer::PtraceCleanupResource;
133pub use tracer::PtraceTerminationHandle;
134pub use tracer::ToolRunOutcome;
135pub use tracer::Tracer;
136pub use tracer::TracerBuilder;
137pub use tracer::quarantine_cleanup_resource;
138pub use tracer::spawn_fn;
139pub use tracer::spawn_fn_with_config;
140pub use validation::PmuValidationError;
141
142#[cfg(test)]
147const FIXTURE_COMPILE_CPU_SECONDS: u64 = 30;
148
149#[cfg(test)]
160pub(crate) fn compile_c_fixture(
161 source: &std::path::Path,
162 output: &std::path::Path,
163) -> std::process::ExitStatus {
164 compile_c_fixture_bounded(source, output, FIXTURE_COMPILE_CPU_SECONDS)
165}
166
167#[cfg(test)]
168fn compile_c_fixture_bounded(
169 source: &std::path::Path,
170 output: &std::path::Path,
171 cpu_seconds: u64,
172) -> std::process::ExitStatus {
173 use std::os::unix::process::CommandExt;
174
175 let mut command = std::process::Command::new("cc");
176 command
177 .args(["-std=c11", "-O1"])
178 .arg(source)
179 .arg("-o")
180 .arg(output);
181 unsafe {
184 command.pre_exec(move || {
185 let limit = libc::rlimit {
186 rlim_cur: cpu_seconds,
187 rlim_max: cpu_seconds,
188 };
189 if libc::setrlimit(libc::RLIMIT_CPU, &limit) != 0 {
190 return Err(std::io::Error::last_os_error());
191 }
192 Ok(())
193 });
194 }
195 command.status().expect("run cc")
196}
197
198#[cfg(test)]
199mod compile_c_fixture_tests {
200 #[test]
201 fn fixture_compile_uses_a_cpu_bound_not_a_wall_bound() {
202 let directory =
203 std::env::temp_dir().join(format!("reverie-compile-fixture-{}", std::process::id()));
204 std::fs::create_dir_all(&directory).unwrap();
205 let source = directory.join("probe.c");
206 std::fs::write(&source, "int main(void) { return 42; }\n").unwrap();
207
208 let output = directory.join("probe");
209 let status = super::compile_c_fixture(&source, &output);
210 assert!(status.success(), "compile probe fixture: {status}");
211 let ran = std::process::Command::new(&output).status().unwrap();
212 assert_eq!(ran.code(), Some(42));
213
214 let starved = super::compile_c_fixture_bounded(&source, &directory.join("starved"), 0);
218 assert!(!starved.success(), "zero CPU budget built: {starved}");
219
220 std::fs::remove_dir_all(&directory).unwrap();
221 }
222}