env.rs

use std::{
    env,
    ffi::CString,
    net::Ipv4Addr,
    os::raw::{c_char, c_void},
    pin::Pin,
    str::FromStr,
    sync::{
        atomic::{AtomicBool, Ordering::SeqCst},
        Arc,
        Mutex,
    },
    time::Duration,
};

use byte_unit::{Byte, ByteUnit};
use clap::Parser;
use events_api::event::EventAction;
use futures::{channel::oneshot, future};
use http::Uri;
use once_cell::sync::{Lazy, OnceCell};
use snafu::Snafu;
use tokio::runtime::Builder;
use version_info::{package_description, version_info_str};

use spdk_rs::{
    libspdk::{
        spdk_app_shutdown_cb,
        spdk_env_dpdk_post_init,
        spdk_env_dpdk_rte_eal_init,
        spdk_env_fini,
        spdk_log_close,
        spdk_log_level,
        spdk_log_open,
        spdk_log_set_flag,
        spdk_log_set_level,
        spdk_log_set_print_level,
        spdk_pci_addr,
        spdk_rpc_finish,
        spdk_rpc_initialize,
        spdk_rpc_set_state,
        spdk_subsystem_fini,
        spdk_subsystem_init,
        spdk_thread_lib_fini,
        spdk_thread_send_critical_msg,
        spdk_trace_cleanup,
        SPDK_LOG_DEBUG,
        SPDK_LOG_INFO,
        SPDK_RPC_RUNTIME,
    },
    spdk_rs_log,
};

use crate::{
    bdev::{bdev_io_ctx_pool_init, nexus, nvme_io_ctx_pool_init},
    constants::NVME_NQN_PREFIX,
    core::{
        nic,
        reactor::{Reactor, ReactorState, Reactors},
        Cores,
        MayastorFeatures,
        Mthread,
    },
    eventing::{
        io_engine_events::io_engine_stop_event_meta,
        Event,
        EventWithMeta,
    },
    grpc,
    grpc::MayastorGrpcServer,
    logger,
    persistent_store::PersistentStoreBuilder,
    subsys::{
        self,
        config::opts::TARGET_CRDT_LEN,
        registration::registration_grpc::ApiVersion,
        Config,
        PoolConfig,
        Registration,
    },
};

fn parse_mb(src: &str) -> Result<i32, String> {
    // For compatibility, we check to see if there are no alphabetic characters
    // passed in, if, so we interpret the value to be in MiB which is what the
    // EAL expects it to be in.

    let has_unit = src.trim_end().chars().any(|c| c.is_alphabetic());

    if let Ok(val) = Byte::from_str(src) {
        let value = if has_unit {
            val.get_adjusted_unit(ByteUnit::MiB).get_value() as i32
        } else {
            val.get_bytes() as i32
        };
        Ok(value)
    } else {
        Err(format!("Invalid argument {src}"))
    }
}

/// Parses a persistent store timeout.
fn parse_ps_timeout(src: &str) -> Result<Duration, String> {
    humantime::parse_duration(src)
        .map_err(|e| format!("Invalid argument {src}: {e}"))
        .map(|d| d.clamp(Duration::from_secs(1), Duration::from_secs(60)))
}

/// Parses Command Retry Delay(s): either a single integer or a comma-separated
/// list of three integers.
fn parse_crdt(src: &str) -> Result<[u16; TARGET_CRDT_LEN], String> {
    fn parse_val(s: &str) -> Result<u16, String> {
        let u = u16::from_str(s).map_err(|e| e.to_string())?;
        if u > 100 {
            Err("Command Retry Delay value is too big".to_string())
        } else {
            Ok(u)
        }
    }

    let items = src.split(',').collect::<Vec<&str>>();
    match items.as_slice() {
        [one] => Ok([parse_val(one)?, 0, 0]),
        [one, two, three] => {
            Ok([parse_val(one)?, parse_val(two)?, parse_val(three)?])
        }
        _ => Err("Command Retry Delay argument must be an integer or \
                  a comma-separated list of three intergers"
            .to_string()),
    }
}

#[derive(Debug, Clone, Parser)]
#[clap(
    name = package_description!(),
    about = "Containerized Attached Storage (CAS) for k8s",
    version = version_info_str!(),
)]
pub struct MayastorCliArgs {
    #[clap(short = 'g', default_value = grpc::default_endpoint_str())]
    /// IP address and port (optional) for the gRPC server to listen on.
    pub grpc_endpoint: String,
    #[clap(short = 'R')]
    /// Registration grpc endpoint
    pub registration_endpoint: Option<Uri>,
    #[clap(short = 'L')]
    /// Enable logging for sub components.
    pub log_components: Vec<String>,
    #[clap(short = 'F')]
    /// Log format.
    pub log_format: Option<logger::LogFormat>,
    #[clap(short = 'm', default_value = "0x1")]
    /// The reactor mask to be used for starting up the instance
    pub reactor_mask: String,
    #[clap(short = 'N')]
    /// Name of the node where mayastor is running (ID used by control plane)
    pub node_name: Option<String>,
    /// The maximum amount of hugepage memory we are allowed to allocate in
    /// MiB. A value of 0 means no limit.
    #[clap(short = 's', value_parser = parse_mb, default_value = "0")]
    pub mem_size: i32,
    #[clap(short = 'u')]
    /// Disable the use of PCIe devices.
    pub no_pci: bool,
    #[clap(short = 'r', default_value = "/var/tmp/mayastor.sock")]
    /// Path to create the rpc socket.
    pub rpc_address: String,
    #[clap(short = 'y')]
    /// Path to mayastor config YAML file.
    pub mayastor_config: Option<String>,
    #[clap(long)]
    /// Path to persistence through power loss nvme reservation base directory.
    pub ptpl_dir: Option<String>,
    #[clap(short = 'P')]
    /// Path to pool config file.
    pub pool_config: Option<String>,
    #[clap(long = "huge-dir")]
    /// Path to hugedir.
    pub hugedir: Option<String>,
    #[clap(long = "env-context")]
    /// Pass additional arguments to the EAL environment.
    pub env_context: Option<String>,
    #[clap(short = 'l')]
    /// List of cores to run on instead of using the core mask. When specified
    /// it supersedes the core mask (-m) argument.
    pub core_list: Option<String>,
    #[clap(short = 'p')]
    /// Endpoint of the persistent store.
    pub ps_endpoint: Option<String>,
    #[clap(
        long = "ps-timeout",
        default_value = "10s",
        value_parser = parse_ps_timeout,
    )]
    /// Persistent store timeout.
    pub ps_timeout: Duration,
    #[clap(long = "ps-retries", default_value = "30")]
    /// Persistent store operation retries.
    pub ps_retries: u8,
    #[clap(long = "bdev-pool-size", default_value = "65535")]
    /// Number of entries in memory pool for bdev I/O contexts
    pub bdev_io_ctx_pool_size: u64,
    #[clap(long = "nvme-ctl-pool-size", default_value = "65535")]
    /// Number of entries in memory pool for NVMe controller I/O contexts
    pub nvme_ctl_io_ctx_pool_size: u64,
    #[clap(short = 'T', long = "tgt-iface", env = "NVMF_TGT_IFACE")]
    /// NVMF target interface (ip, mac, name or subnet).
    pub nvmf_tgt_interface: Option<String>,
    /// NVMF target Command Retry Delay in x100 ms (single integer or three
    /// comma-separated integers). First value is used for errors on nexus
    /// target except reservation conflict and no space; second
    /// value is used for reservation conflict and no space on nexus target;
    /// third value is used for all errors on replica target.
    #[clap(
        long = "tgt-crdt",
        env = "NVMF_TGT_CRDT",
        default_value = "0",
        value_parser = parse_crdt,
    )]
    pub nvmf_tgt_crdt: [u16; TARGET_CRDT_LEN],
    /// The gRPC api version.
    #[clap(
        long,
        value_delimiter = ',',
        default_value = "V0,V1",
        env = "API_VERSIONS"
    )]
    pub api_versions: Vec<ApiVersion>,
    /// Dump stack trace for all threads inside I/O agent process with target
    /// PID.
    #[clap(short = 'd', long = "diagnose-stack", env = "DIAGNOSE_STACK")]
    pub diagnose_stack: Option<u32>,
    /// Enable reactor freeze detection.
    #[clap(long)]
    pub reactor_freeze_detection: bool,
    /// Timeout (in seconds) for reactor freeze detection.
    #[clap(long = "reactor-freeze-timeout", env = "REACTOR_FREEZE_TIMEOUT")]
    pub reactor_freeze_timeout: Option<u64>,
    /// Skip install of the signal handler which will trigger process graceful
    /// termination.
    #[clap(long, hide = true)]
    pub skip_sig_handler: bool,
    /// Whether the nexus channel should have readers/writers configured.
    /// This must be set true ONLY from tests. This option can be removed once
    /// dynamic reconfiguration of nexus channels can handle async-qpair
    /// connect. Details in NexusChannel::new
    #[clap(long = "enable-io-all-thrd-nexus-channels", hide = true)]
    pub enable_io_all_thrd_nexus_channels: bool,
    /// Events message-bus endpoint url.
    #[clap(long)]
    pub events_url: Option<url::Url>,
    /// Enables additional nexus I/O channel debugging.
    #[clap(
        long = "enable-channel-dbg",
        env = "ENABLE_NEXUS_CHANNEL_DEBUG",
        hide = true
    )]
    pub enable_nexus_channel_debug: bool,
    /// Enables experimental LVM backend support.
    /// LVM pools can then be created by specifying the LVM pool type.
    /// If LVM is enabled and LVM_SUPPRESS_FD_WARNINGS is not set then it will
    /// be set to 1.
    #[clap(long = "enable-lvm", env = "ENABLE_LVM", value_parser = delay_compat)]
    pub lvm: bool,
    /// Enables experimental Snapshot Rebuild support.
    #[clap(long = "enable-snapshot-rebuild", env = "ENABLE_SNAPSHOT_REBUILD", value_parser = delay_compat)]
    pub snap_rebuild: bool,
    /// Reactors sleep 1ms before each poll.
    /// # Warning: Don't use this in production.
    #[clap(long, env = "MAYASTOR_DELAY", hide = true, value_parser = delay_compat)]
    pub developer_delay: bool,
    /// Enables RDMA between initiator and Mayastor Nvmf target.
    #[clap(long = "enable-rdma", env = "ENABLE_RDMA", value_parser = delay_compat)]
    pub rdma: bool,
    /// Enables globally blob store cluster release on unmap.
    #[clap(long, env = "ENABLE_BS_CLUSTER_UNMAP", hide = true)]
    pub bs_cluster_unmap: bool,
}

fn delay_compat(s: &str) -> Result<bool, String> {
    match s {
        "1" | "true" => Ok(true),
        "" | "0" | "false" => Ok(false),
        _else => Err(format!("Must be one of: 1,true,0,false")),
    }
}

/// Mayastor features.
impl MayastorFeatures {
    fn init_features() -> MayastorFeatures {
        let ana = env::var("NEXUS_NVMF_ANA_ENABLE").as_deref() == Ok("1");
        let lvm = env::var("ENABLE_LVM").as_deref() == Ok("true");
        let snapshot_rebuild =
            env::var("ENABLE_SNAPSHOT_REBUILD").as_deref() == Ok("true");

        MayastorFeatures {
            asymmetric_namespace_access: ana,
            logical_volume_manager: lvm,
            snapshot_rebuild,
        }
    }
    /// Get all the supported and enabled features.
    pub fn get() -> Self {
        MAYASTOR_FEATURES.get_or_init(Self::init_features).clone()
    }
}

/// Defaults are redefined here in case of using it during tests
impl Default for MayastorCliArgs {
    fn default() -> Self {
        Self {
            grpc_endpoint: grpc::default_endpoint().to_string(),
            ps_endpoint: None,
            ps_timeout: Duration::from_secs(10),
            ps_retries: 30,
            node_name: None,
            env_context: None,
            reactor_mask: "0x1".into(),
            mem_size: 0,
            rpc_address: "/var/tmp/mayastor.sock".to_string(),
            no_pci: true,
            log_components: vec![],
            log_format: None,
            mayastor_config: None,
            ptpl_dir: None,
            pool_config: None,
            hugedir: None,
            core_list: None,
            bdev_io_ctx_pool_size: 65535,
            nvme_ctl_io_ctx_pool_size: 65535,
            registration_endpoint: None,
            nvmf_tgt_interface: None,
            nvmf_tgt_crdt: [0; TARGET_CRDT_LEN],
            api_versions: vec![ApiVersion::V0, ApiVersion::V1],
            diagnose_stack: None,
            reactor_freeze_detection: false,
            reactor_freeze_timeout: None,
            skip_sig_handler: false,
            enable_io_all_thrd_nexus_channels: false,
            events_url: None,
            enable_nexus_channel_debug: false,
            lvm: false,
            snap_rebuild: false,
            developer_delay: false,
            rdma: false,
            bs_cluster_unmap: false,
        }
    }
}

impl MayastorCliArgs {
    /// Create the hostnqn for this io-engine instance.
    pub fn make_hostnqn(&self) -> Option<String> {
        make_hostnqn(self.node_name.as_ref())
    }
}

/// Global exit code of the program, initially set to -1 to capture double
/// shutdown during test cases
pub static GLOBAL_RC: Lazy<Arc<Mutex<i32>>> =
    Lazy::new(|| Arc::new(Mutex::new(-1)));

/// keep track if we have received a signal already
pub static SIG_RECEIVED: Lazy<AtomicBool> =
    Lazy::new(|| AtomicBool::new(false));

#[derive(Debug, Snafu)]
pub enum EnvError {
    #[snafu(display("Failed to install signal handler"))]
    SetSigHdl { source: nix::Error },
    #[snafu(display("Failed to initialize logging subsystem"))]
    InitLog,
    #[snafu(display("Failed to initialize {} target", target))]
    InitTarget { target: String },
}

type Result<T, E = EnvError> = std::result::Result<T, E>;

/// Mayastor argument
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct MayastorEnvironment {
    pub node_name: String,
    pub node_nqn: Option<String>,
    pub grpc_endpoint: Option<std::net::SocketAddr>,
    pub registration_endpoint: Option<Uri>,
    ps_endpoint: Option<String>,
    ps_timeout: Duration,
    ps_retries: u8,
    mayastor_config: Option<String>,
    ptpl_dir: Option<String>,
    pool_config: Option<String>,
    delay_subsystem_init: bool,
    enable_coredump: bool,
    env_context: Option<String>,
    hugedir: Option<String>,
    hugepage_single_segments: bool,
    json_config_file: Option<String>,
    master_core: i32,
    mem_channel: i32,
    pub mem_size: i32,
    pub name: String,
    no_pci: bool,
    num_entries: u64,
    num_pci_addr: usize,
    pci_blocklist: Vec<spdk_pci_addr>,
    pci_allowlist: Vec<spdk_pci_addr>,
    print_level: spdk_log_level,
    debug_level: spdk_log_level,
    reactor_mask: String,
    pub rpc_addr: String,
    shm_id: i32,
    shutdown_cb: spdk_app_shutdown_cb,
    tpoint_group_mask: String,
    unlink_hugepage: bool,
    log_component: Vec<String>,
    core_list: Option<String>,
    bdev_io_ctx_pool_size: u64,
    nvme_ctl_io_ctx_pool_size: u64,
    nvmf_tgt_interface: Option<String>,
    /// NVMF target Command Retry Delay in x100 ms.
    pub nvmf_tgt_crdt: [u16; TARGET_CRDT_LEN],
    pub api_versions: Vec<ApiVersion>,
    skip_sig_handler: bool,
    enable_io_all_thrd_nexus_channels: bool,
    developer_delay: bool,
    rdma: bool,
    bs_cluster_unmap: bool,
}

impl Default for MayastorEnvironment {
    fn default() -> Self {
        Self {
            node_name: "mayastor-node".into(),
            node_nqn: None,
            grpc_endpoint: None,
            registration_endpoint: None,
            ps_endpoint: None,
            ps_timeout: Duration::from_secs(10),
            ps_retries: 30,
            mayastor_config: None,
            ptpl_dir: None,
            pool_config: None,
            delay_subsystem_init: false,
            enable_coredump: true,
            env_context: None,
            hugedir: None,
            hugepage_single_segments: false,
            json_config_file: None,
            master_core: -1,
            mem_channel: -1,
            mem_size: -1,
            name: "mayastor".into(),
            no_pci: false,
            num_entries: 0,
            num_pci_addr: 0,
            pci_blocklist: vec![],
            pci_allowlist: vec![],
            print_level: SPDK_LOG_INFO,
            debug_level: SPDK_LOG_INFO,
            reactor_mask: "0x1".into(),
            rpc_addr: "/var/tmp/mayastor.sock".into(),
            shm_id: -1,
            shutdown_cb: None,
            tpoint_group_mask: String::new(),
            unlink_hugepage: true,
            log_component: vec![],
            core_list: None,
            bdev_io_ctx_pool_size: 65535,
            nvme_ctl_io_ctx_pool_size: 65535,
            nvmf_tgt_interface: None,
            nvmf_tgt_crdt: [0; TARGET_CRDT_LEN],
            api_versions: vec![ApiVersion::V0, ApiVersion::V1],
            skip_sig_handler: false,
            enable_io_all_thrd_nexus_channels: false,
            developer_delay: false,
            rdma: false,
            bs_cluster_unmap: false,
        }
    }
}

/// The actual routine which does the mayastor shutdown.
/// Must be called on the same thread which did the init.
async fn do_shutdown(arg: *mut c_void) {
    Event::event(
        &MayastorEnvironment::global_or_default(),
        EventAction::Shutdown,
    )
    .generate();

    let start_time = std::time::Instant::now();

    // we must enter the init thread explicitly here as this, typically, gets
    // called by the signal handler
    // callback for when the subsystems have shutdown
    extern "C" fn reactors_stop(arg: *mut c_void) {
        Reactors::iter().for_each(|r| r.shutdown());
        *GLOBAL_RC.lock().unwrap() = arg as i32;
    }

    let rc = arg as i32;

    if rc != 0 {
        warn!("Mayastor stopped non-zero: {}", rc);
    }

    // Shutdown GRPC Server and Registration Client first, to not accept any
    // more requests once we start shutting down, otherwise the control
    // plane might schedule workloads on this instance while it's shutting
    // down.
    MayastorGrpcServer::get_or_init().fini();
    if let Some(reg) = Registration::get() {
        reg.fini();
    }
    nexus::shutdown_nexuses().await;
    crate::rebuild::shutdown_snapshot_rebuilds().await;
    crate::lvs::Lvs::export_all().await;
    if MayastorFeatures::get().lvm() {
        crate::lvm::VolumeGroup::export_all().await;
    }

    unsafe {
        spdk_rpc_finish();
        spdk_subsystem_fini(Some(reactors_stop), arg);
    }

    EventWithMeta::event(
        &MayastorEnvironment::global_or_default(),
        EventAction::Stop,
        io_engine_stop_event_meta(start_time.elapsed()),
    )
    .generate();
}

/// main shutdown routine for mayastor
pub fn mayastor_env_stop(rc: i32) {
    let r = Reactors::master();

    match r.get_state() {
        ReactorState::Running | ReactorState::Delayed | ReactorState::Init => {
            r.send_future(async move {
                do_shutdown(rc as *const i32 as *mut c_void).await;
            });
        }
        _ => {
            panic!("invalid reactor state during shutdown");
        }
    }
}

#[inline(always)]
unsafe extern "C" fn signal_trampoline(_: *mut c_void) {
    mayastor_env_stop(0);
}

/// called on SIGINT and SIGTERM
extern "C" fn mayastor_signal_handler(signo: i32) {
    if SIG_RECEIVED.load(SeqCst) {
        return;
    }

    warn!("Received SIGNO: {}", signo);
    SIG_RECEIVED.store(true, SeqCst);
    unsafe {
        if let Some(mth) = Mthread::primary_safe() {
            spdk_thread_send_critical_msg(
                mth.as_ptr(),
                Some(signal_trampoline),
            );
        }
    };
}

#[derive(Debug)]
struct SubsystemCtx {
    rpc: CString,
    sender: futures::channel::oneshot::Sender<bool>,
}

static MAYASTOR_FEATURES: OnceCell<MayastorFeatures> = OnceCell::new();

static MAYASTOR_DEFAULT_ENV: OnceCell<parking_lot::Mutex<MayastorEnvironment>> =
    OnceCell::new();

impl MayastorEnvironment {
    pub fn new(args: MayastorCliArgs) -> Self {
        Self {
            grpc_endpoint: Some(grpc::endpoint(args.grpc_endpoint)),
            registration_endpoint: args.registration_endpoint,
            ps_endpoint: args.ps_endpoint,
            ps_timeout: args.ps_timeout,
            ps_retries: args.ps_retries,
            node_name: args.node_name.clone().unwrap_or_else(|| {
                env::var("HOSTNAME").unwrap_or_else(|_| "mayastor-node".into())
            }),
            node_nqn: make_hostnqn(
                args.node_name
                    .or_else(|| env::var("HOSTNAME").ok())
                    .as_ref(),
            ),
            mayastor_config: args.mayastor_config,
            ptpl_dir: args.ptpl_dir,
            pool_config: args.pool_config,
            log_component: args.log_components,
            mem_size: args.mem_size,
            no_pci: args.no_pci,
            reactor_mask: args.reactor_mask,
            rpc_addr: args.rpc_address,
            hugedir: args.hugedir,
            env_context: args.env_context,
            core_list: args.core_list,
            bdev_io_ctx_pool_size: args.bdev_io_ctx_pool_size,
            nvme_ctl_io_ctx_pool_size: args.nvme_ctl_io_ctx_pool_size,
            nvmf_tgt_interface: args.nvmf_tgt_interface,
            nvmf_tgt_crdt: args.nvmf_tgt_crdt,
            api_versions: args.api_versions,
            skip_sig_handler: args.skip_sig_handler,
            developer_delay: args.developer_delay,
            rdma: args.rdma,
            bs_cluster_unmap: args.bs_cluster_unmap,
            enable_io_all_thrd_nexus_channels: args
                .enable_io_all_thrd_nexus_channels,
            ..Default::default()
        }
        .setup_static()
    }

    /// Get the persistence through power loss directory.
    pub fn ptpl_dir(&self) -> Option<String> {
        self.ptpl_dir.clone()
    }

    fn setup_static(self) -> Self {
        match MAYASTOR_DEFAULT_ENV.get() {
            None => {
                MAYASTOR_DEFAULT_ENV
                    .get_or_init(|| parking_lot::Mutex::new(self.clone()));
            }
            Some(some) => {
                *some.lock() = self.clone();
            }
        }
        self
    }

    /// Get the global environment (first created on new)
    /// or otherwise the default one (used by the tests)
    pub fn global_or_default() -> Self {
        match MAYASTOR_DEFAULT_ENV.get() {
            Some(env) => env.lock().clone(),
            None => MayastorEnvironment::default(),
        }
    }

    /// configure signal handling
    fn install_signal_handlers(&self) {
        unsafe {
            signal_hook::low_level::register(
                signal_hook::consts::SIGTERM,
                || mayastor_signal_handler(1),
            )
        }
        .unwrap();

        unsafe {
            signal_hook::low_level::register(
                signal_hook::consts::SIGINT,
                || mayastor_signal_handler(1),
            )
        }
        .unwrap();
    }

    /// construct an array of options to be passed to EAL and start it
    fn initialize_eal(&self) {
        let mut args = vec![CString::new(self.name.clone()).unwrap()];

        if self.mem_channel > 0 {
            args.push(
                CString::new(format!("-n {}", self.mem_channel)).unwrap(),
            );
        }

        if self.shm_id < 0 {
            args.push(CString::new("--no-shconf").unwrap());
        }

        if self.mem_size >= 0 {
            args.push(CString::new(format!("-m {}", self.mem_size)).unwrap());
        }

        if self.master_core > 0 {
            args.push(
                CString::new(format!("--master-lcore={}", self.master_core))
                    .unwrap(),
            );
        }

        if self.no_pci {
            args.push(CString::new("--no-pci").unwrap());
        }

        if self.hugepage_single_segments {
            args.push(CString::new("--single-file-segments").unwrap());
        }

        if self.hugedir.is_some() {
            args.push(
                CString::new(format!(
                    "--huge-dir={}",
                    &self.hugedir.as_ref().unwrap().clone()
                ))
                .unwrap(),
            )
        }

        if cfg!(target_os = "linux") {
            // Ref: https://github.com/google/sanitizers/wiki/AddressSanitizerAlgorithm
            args.push(CString::new("--base-virtaddr=0x200000000000").unwrap());
        }

        if self.shm_id < 0 {
            args.push(
                CString::new(format!("--file-prefix=mayastor_pid{}", unsafe {
                    libc::getpid()
                }))
                .unwrap(),
            );
        } else {
            args.push(
                CString::new(format!(
                    "--file-prefix=mayastor_pid{}",
                    self.shm_id
                ))
                .unwrap(),
            );
            args.push(CString::new("--proc-type=auto").unwrap());
        }

        if self.unlink_hugepage {
            args.push(CString::new("--huge-unlink".to_string()).unwrap());
        }

        // set the log levels of the DPDK libs, this can be overridden by
        // setting env_context
        args.push(CString::new("--log-level=lib.eal:6").unwrap());
        args.push(CString::new("--log-level=lib.cryptodev:5").unwrap());
        args.push(CString::new("--log-level=user1:6").unwrap());
        args.push(CString::new("--match-allocations").unwrap());

        // any additional parameters we want to pass down to the eal. These
        // arguments are not checked or validated.
        if self.env_context.is_some() {
            args.extend(
                self.env_context
                    .as_ref()
                    .unwrap()
                    .split_ascii_whitespace()
                    .map(|s| CString::new(s.to_string()).unwrap())
                    .collect::<Vec<_>>(),
            );
        }

        // when -l is specified it overrules the core mask. The core mask still
        // carries our default of 0x1 such that existing testing code
        // does not require any changes.
        if let Some(list) = &self.core_list {
            args.push(CString::new(format!("-l {list}")).unwrap());
        } else {
            args.push(
                CString::new(format!("-c {}", self.reactor_mask)).unwrap(),
            )
        }

        let mut cargs = args
            .iter()
            .map(|arg| arg.as_ptr())
            .collect::<Vec<*const c_char>>();

        cargs.push(std::ptr::null());
        debug!("EAL arguments {:?}", args);

        if unsafe {
            spdk_env_dpdk_rte_eal_init(
                (cargs.len() as libc::c_int) - 1,
                cargs.as_ptr() as *mut *mut c_char,
            )
        } < 0
        {
            panic!("Failed to init EAL");
        }
        if unsafe { spdk_env_dpdk_post_init(false) } != 0 {
            panic!("Failed execute post setup");
        }
    }

    /// initialize the logging subsystem
    fn init_logger(&mut self) {
        // if log flags are specified increase the loglevel and print level.
        if !self.log_component.is_empty() {
            warn!("Increasing debug and print level ...");
            self.debug_level = SPDK_LOG_DEBUG;
            self.print_level = SPDK_LOG_DEBUG;
        }

        unsafe {
            for flag in &self.log_component {
                let cflag = CString::new(flag.as_str()).unwrap();
                if spdk_log_set_flag(cflag.as_ptr()) != 0 {
                    error!("Failed to set SPDK log flag: {:?}", cflag);
                }
            }

            spdk_log_set_level(self.debug_level);
            spdk_log_set_print_level(self.print_level);
            // open our log implementation which is implemented in the wrapper
            spdk_log_open(Some(spdk_rs_log));
            // our callback called defined in rust called by our wrapper
            spdk_rs::logfn = Some(logger::log_impl);
        }
    }

    /// Returns NVMF target's IP address.
    pub(crate) fn get_nvmf_tgt_ip() -> Result<String, String> {
        static TGT_IP: OnceCell<String> = OnceCell::new();
        TGT_IP
            .get_or_try_init(|| {
                match Self::global_or_default().nvmf_tgt_interface {
                    Some(ref iface) => Self::detect_nvmf_tgt_iface_ip(iface),
                    None => Self::detect_pod_ip(),
                }
            })
            .map(|s| s.clone())
    }

    /// Detects IP address for NVMF target by the interface specified in CLI
    /// arguments.
    fn detect_nvmf_tgt_iface_ip(iface: &str) -> Result<String, String> {
        info!(
            "Detecting IP address for NVMF target network interface \
                specified as '{}' ...",
            iface
        );

        let (cls, name) = match iface.split_once(':') {
            Some(p) => p,
            None => ("name", iface),
        };

        let pred: Box<dyn Fn(&nic::Interface) -> bool> = match cls {
            "name" => Box::new(|n| n.name == name),
            "mac" => {
                let mac = Some(name.parse::<nic::MacAddr>()?);
                Box::new(move |n| n.mac == mac)
            }
            "ip" => {
                let addr = Some(nic::parse_ipv4(name)?);
                Box::new(move |n| n.inet.addr == addr)
            }
            "subnet" => {
                let (subnet, mask) = nic::parse_ipv4_subnet(name)?;
                Box::new(move |n| n.ipv4_subnet_eq(subnet, mask))
            }
            _ => {
                return Err(format!(
                    "Invalid NVMF target interface: '{iface}'",
                ));
            }
        };

        let mut nics: Vec<_> =
            nic::find_all_nics().into_iter().filter(pred).collect();

        if nics.is_empty() {
            return Err(format!(
                "Network interface matching '{iface}' not found",
            ));
        }

        if nics.len() > 1 {
            return Err(format!(
                "Multiple network interfaces that \
                match '{iface}' are found",
            ));
        }

        let res = nics.pop().unwrap();

        info!(
            "NVMF target network interface '{}' matches to {}",
            iface, res
        );

        if res.inet.addr.is_none() {
            return Err(format!(
                "Network interface '{}' has no IPv4 address configured",
                res.name
            ));
        }

        Ok(res.inet.addr.unwrap().to_string())
    }

    /// Detects pod IP address.
    fn detect_pod_ip() -> Result<String, String> {
        match env::var("MY_POD_IP") {
            Ok(val) => {
                info!(
                    "Using 'MY_POD_IP' environment variable for IP address \
                        for NVMF target network interface"
                );

                if val.parse::<Ipv4Addr>().is_ok() {
                    Ok(val)
                } else {
                    Err(format!(
                        "MY_POD_IP environment variable is set to an \
                            invalid IPv4 address: '{val}'"
                    ))
                }
            }
            Err(_) => Ok("127.0.0.1".to_owned()),
        }
    }

    /// Starts the JSON rpc server which listens only to a local path.
    extern "C" fn start_rpc(rc: i32, arg: *mut c_void) {
        let ctx = unsafe { Box::from_raw(arg as *mut SubsystemCtx) };

        if rc != 0 {
            ctx.sender.send(false).unwrap();
        } else {
            info!("RPC server listening at: {}", ctx.rpc.to_str().unwrap());
            unsafe {
                spdk_rpc_initialize(
                    ctx.rpc.as_ptr() as *mut c_char,
                    std::ptr::null_mut(),
                );
                spdk_rpc_set_state(SPDK_RPC_RUNTIME);
            };

            let success = true;

            ctx.sender.send(success).unwrap();
        }
    }

    /// Load the config and apply it before any subsystems have started.
    /// there is currently no run time check that enforces this.
    fn load_yaml_config(&mut self) {
        let cfg = if let Some(yaml) = &self.mayastor_config {
            info!("loading mayastor config YAML file {}", yaml);
            Config::get_or_init(|| {
                if let Ok(cfg) = Config::read(yaml) {
                    cfg
                } else {
                    // if the configuration is invalid exit early
                    panic!("Failed to load the mayastor configuration")
                }
            })
        } else {
            Config::get_or_init(Config::default)
        };
        cfg.apply();
        if let Some(mask) = cfg.eal_opts.reactor_mask.as_ref() {
            self.reactor_mask = mask.clone();
        }
        if cfg.eal_opts.core_list.is_some() {
            self.core_list = cfg.eal_opts.core_list.clone();
        }
        if let Some(delay) = cfg.eal_opts.developer_delay {
            self.developer_delay = delay;
        }
        if let Some(interface) = &cfg.nvmf_tgt_conf.interface {
            self.nvmf_tgt_interface = Some(interface.clone());
        }
        self.clone().setup_static();
    }

    /// load the pool config file.
    fn load_pool_config(&self) -> Option<PoolConfig> {
        if let Some(file) = &self.pool_config {
            info!("loading pool config file {}", file);
            match PoolConfig::load(file) {
                Ok(config) => {
                    return Some(config);
                }
                Err(error) => {
                    warn!("failed to load pool configuration: {}", error);
                }
            }
        }
        None
    }

    /// initialize the core, call this before all else
    pub fn init(mut self) -> Self {
        // setup the logger as soon as possible
        self.init_logger();

        if option_env!("ASAN_ENABLE").unwrap_or_default() == "1" {
            print_asan_env();
        }

        self.load_yaml_config();

        if let Some(ptpl) = &self.ptpl_dir {
            if let Err(error) = std::fs::create_dir_all(ptpl) {
                tracing::error!(%error, "Failed to create ptpl base path directories");
            }
        }

        let pool_config = self.load_pool_config();

        // bootstrap DPDK and its magic
        self.initialize_eal();

        // initialize memory pool for allocating bdev I/O contexts
        bdev_io_ctx_pool_init(self.bdev_io_ctx_pool_size);

        // initialize memory pool for allocating NVMe controller I/O contexts
        nvme_io_ctx_pool_init(self.nvme_ctl_io_ctx_pool_size);

        info!(
            "Total number of cores available: {}",
            Cores::count().into_iter().count()
        );

        // setup our signal handlers
        if !self.skip_sig_handler {
            self.install_signal_handlers();
        }

        if self.enable_io_all_thrd_nexus_channels {
            nexus::ENABLE_IO_ALL_THRD_NX_CHAN.store(true, SeqCst);
        }

        // allocate a Reactor per core
        Reactors::init(self.developer_delay);

        // launch the remote cores if any. note that during init these have to
        // be running as during setup cross call will take place.
        Cores::count()
            .into_iter()
            .for_each(|c| Reactors::launch_remote(c).unwrap());

        let rpc = CString::new(self.rpc_addr.as_str()).unwrap();

        // wait for all cores to be online, not sure if this is the right way
        // but when using more then 16 cores, I saw some "weirdness"
        // which could be related purely to logging.

        while Reactors::iter().any(|r| {
            r.get_state() == ReactorState::Init && r.core() != Cores::current()
        }) {
            std::thread::sleep(Duration::from_millis(1));
        }

        info!("All cores locked and loaded!");

        // ensure we are within the context of a spdk thread from here
        Mthread::primary().set_current();

        Reactor::block_on(async {
            let (sender, receiver) = oneshot::channel::<bool>();

            unsafe {
                spdk_subsystem_init(
                    Some(Self::start_rpc),
                    Box::into_raw(Box::new(SubsystemCtx {
                        rpc,
                        sender,
                    })) as *mut _,
                );
            }

            assert!(receiver.await.unwrap());
        });

        // load any pools that need to be created
        if let Some(config) = pool_config {
            config.import_pools();
        }

        self
    }

    // finalize our environment
    pub fn fini(&self) {
        unsafe {
            spdk_trace_cleanup();
            spdk_thread_lib_fini();
            spdk_env_fini();
            spdk_log_close();
        }
    }

    /// start mayastor and call f when all is setup.
    pub fn start<F>(self, f: F) -> Result<i32>
    where
        F: FnOnce() + 'static,
    {
        type FutureResult = Result<(), ()>;
        let node_name = self.node_name.clone();
        let node_nqn = self.node_nqn.clone();

        let ps_endpoint = self.ps_endpoint.clone();
        let ps_timeout = self.ps_timeout;
        let ps_retries = self.ps_retries;
        let grpc_endpoint = self.grpc_endpoint;
        let rpc_addr = self.rpc_addr.clone();
        let api_versions = self.api_versions.clone();
        let ms = self.init();

        let rt = Builder::new_current_thread().enable_all().build().unwrap();

        rt.block_on(async {
            // If a persistent store endpoint is given, configure and enable it.
            if let Some(ps_endpoint) = ps_endpoint {
                PersistentStoreBuilder::new()
                    .with_endpoint(&ps_endpoint)
                    .with_timeout(ps_timeout)
                    .with_retries(ps_retries)
                    .connect()
                    .await;
            }

            let master = Reactors::current();
            master.send_future(async { f() });
            let mut futures: Vec<
                Pin<Box<dyn future::Future<Output = FutureResult>>>,
            > = Vec::new();
            if let Some(grpc_endpoint) = grpc_endpoint {
                futures.push(Box::pin(grpc::MayastorGrpcServer::run(
                    &node_name,
                    &node_nqn,
                    grpc_endpoint,
                    rpc_addr,
                    api_versions,
                )));
            }
            futures.push(Box::pin(subsys::Registration::run()));
            futures.push(Box::pin(master));
            let _out = future::try_join_all(futures).await;
            info!("reactors stopped");
            ms.fini();
        });

        Ok(*GLOBAL_RC.lock().unwrap())
    }

    /// Create the hostnqn for this io-engine instance.
    pub fn make_hostnqn(&self) -> Option<String> {
        self.node_nqn.clone()
    }
}

fn make_hostnqn(node_name: Option<&String>) -> Option<String> {
    std::env::var("HOSTNQN").ok().or_else(|| {
        node_name.map(|n| format!("{NVME_NQN_PREFIX}:node-name:{n}"))
    })
}

fn print_asan_env() {
    macro_rules! print_compile_var {
        ($name:literal) => {
            let value = option_env!($name).unwrap_or_default();
            info!("    {:25} = {value}", $name);
        };
    }
    fn print_run_var(name: &str) {
        let value = std::env::var(name).unwrap_or_default();
        info!("    {name:25} = {value}");
    }

    warn!("Compiled with Address Sanitizer enabled");
    print_run_var("ASAN_OPTIONS");
    print_compile_var!("ASAN_BUILD_ENV");
    print_compile_var!("RUSTFLAGS");
    print_compile_var!("CARGO_BUILD_RUSTFLAGS");
    print_compile_var!("CARGO_BUILD_TARGET");
    print_compile_var!("CARGO_PROFILE_DEV_PANIC");
    print_run_var("RUST_BACKTRACE");
}