Refactor redirect_stderr_to_file to solana-logger

Cargo.toml

@@ -161,6 +161,7 @@ indicatif = "0.17.9"
 itertools = "0.12.1"
 js-sys = "0.3.77"
 lazy_static = "1.5.0"
+libc = "0.2.170"
 libsecp256k1 = { version = "0.6.0", default-features = false, features = [
     "std",
     "static-context",
@@ -192,6 +193,7 @@ serde_with = { version = "3.12.0", default-features = false }
 serial_test = "2.0.0"
 sha2 = "0.10.8"
 sha3 = "0.10.8"
+signal-hook = "0.3.17"
 siphasher = "0.3.11"
 solana-account = { path = "account", version = "2.2.1" }
 solana-account-info = { path = "account-info", version = "2.2.1" }

logger/Cargo.toml

@@ -2,7 +2,7 @@
 name = "solana-logger"
 description = "Solana Logger"
 documentation = "https://docs.rs/solana-logger"
-version = "2.2.1"
+version = "2.2.2"
 authors = { workspace = true }
 repository = { workspace = true }
 homepage = { workspace = true }
@@ -14,6 +14,10 @@ env_logger = { workspace = true }
 lazy_static = { workspace = true }
 log = { workspace = true }
 
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+libc = { workspace = true }
+signal-hook = { workspace = true }
+
 [lib]
 name = "solana_logger"
 

logger/src/lib.rs

@@ -2,7 +2,11 @@
 
 use {
     lazy_static::lazy_static,
-    std::sync::{Arc, RwLock},
+    std::{
+        env,
+        sync::{Arc, RwLock},
+        thread::JoinHandle,
+    },
 };
 
 lazy_static! {
@@ -75,3 +79,68 @@ pub fn setup_file_with_default(logfile: &str, filter: &str) {
         .build();
     replace_logger(logger);
 }
+
+#[cfg(unix)]
+#[cfg(not(target_arch = "wasm32"))]
+fn redirect_stderr(filename: &str) {
+    use std::{fs::OpenOptions, os::unix::io::AsRawFd};
+    match OpenOptions::new().create(true).append(true).open(filename) {
+        Ok(file) => unsafe {
+            libc::dup2(file.as_raw_fd(), libc::STDERR_FILENO);
+        },
+        Err(err) => eprintln!("Unable to open {filename}: {err}"),
+    }
+}
+
+// Redirect stderr to a file with support for logrotate by sending a SIGUSR1 to the process.
+//
+// Upon success, future `log` macros and `eprintln!()` can be found in the specified log file.
+#[cfg(not(target_arch = "wasm32"))]
+pub fn redirect_stderr_to_file(logfile: Option<String>) -> Option<JoinHandle<()>> {
+    // Default to RUST_BACKTRACE=1 for more informative validator logs
+    if env::var_os("RUST_BACKTRACE").is_none() {
+        env::set_var("RUST_BACKTRACE", "1")
+    }
+
+    match logfile {
+        None => {
+            setup_with_default_filter();
+            None
+        }
+        Some(logfile) => {
+            #[cfg(unix)]
+            {
+                use log::info;
+                let mut signals =
+                    signal_hook::iterator::Signals::new([signal_hook::consts::SIGUSR1])
+                        .unwrap_or_else(|err| {
+                            eprintln!("Unable to register SIGUSR1 handler: {err:?}");
+                            std::process::exit(1);
+                        });
+
+                setup_with_default_filter();
+                redirect_stderr(&logfile);
+                Some(
+                    std::thread::Builder::new()
+                        .name("solSigUsr1".into())
+                        .spawn(move || {
+                            for signal in signals.forever() {
+                                info!(
+                                    "received SIGUSR1 ({}), reopening log file: {:?}",
+                                    signal, logfile
+                                );
+                                redirect_stderr(&logfile);
+                            }
+                        })
+                        .unwrap(),
+                )
+            }
+            #[cfg(not(unix))]
+            {
+                println!("logrotate is not supported on this platform");
+                setup_file_with_default(&logfile, solana_logger::DEFAULT_FILTER);
+                None
+            }
+        }
+    }
+}

scripts/check-nits.sh

@@ -17,6 +17,7 @@ declare prints=(
 # Parts of the tree that are expected to be print free
 declare print_free_tree=(
   ':**.rs'
+  ':^logger/src/lib.rs'
   ':^msg/src/lib.rs'
   ':^program-option/src/lib.rs'
   ':^pubkey/src/lib.rs'