ombrac_client/

ffi.rs

use std::ffi::{CStr, c_char};
use std::sync::{Arc, Mutex};

use figment::Figment;
use figment::providers::{Format, Json, Serialized};
use tokio::runtime::{Builder, Runtime};

use ombrac_macros::{error, info};

use crate::config::{ConfigFile, ServiceConfig};
#[cfg(feature = "tracing")]
use crate::logging::LogCallback;
#[cfg(feature = "transport-quic")]
use crate::service::QuicServiceBuilder;
use crate::service::Service;

// A global, thread-safe handle to the running service instance.
static SERVICE_HANDLE: Mutex<Option<ServiceHandle>> = Mutex::new(None);

// Encapsulates the service instance and its associated Tokio runtime.
struct ServiceHandle {
    #[cfg(feature = "transport-quic")]
    service: Option<
        Box<Service<ombrac_transport::quic::client::Client, ombrac_transport::quic::Connection>>,
    >,
    runtime: Runtime,
}

/// A helper function to safely convert a C string pointer to a Rust string slice.
/// Returns an empty string if the pointer is null.
unsafe fn c_str_to_str<'a>(s: *const c_char) -> &'a str {
    if s.is_null() {
        return "";
    }
    unsafe { CStr::from_ptr(s).to_str().unwrap_or("") }
}

/// Initializes the logging system to use a C-style callback for log messages.
///
/// This function must be called before `ombrac_client_service_startup` if you wish to
/// receive logs in a C-compatible way. It sets up a global logger that will
/// forward all log records to the provided callback function.
///
/// # Arguments
///
/// * `callback` - A function pointer of type `LogCallback`. See the definition of
///   `LogCallback` for the expected signature and log level mappings.
///
/// # Safety
///
/// The provided `callback` function pointer must be valid and remain valid for
/// the lifetime of the program. If a null pointer is passed, logging will be
/// disabled.
#[cfg(feature = "tracing")]
#[unsafe(no_mangle)]
pub unsafe extern "C" fn ombrac_client_set_log_callback(callback: *const LogCallback) {
    let callback = if callback.is_null() {
        None
    } else {
        Some(unsafe { *callback })
    };
    crate::logging::set_log_callback(callback);
}

/// Initializes and starts the service with a given JSON configuration.
///
/// This function sets up the asynchronous runtime, parses the configuration,
/// and launches the main service. It must be called before any other service
/// operations. The service must be shut down via `ombrac_client_service_shutdown` to ensure
/// a clean exit.
///
/// # Arguments
///
/// * `config_json` - A pointer to a null-terminated UTF-8 string containing the
///   service configuration in JSON format.
///
/// # Returns
///
/// * `0` on success.
/// * `-1` on failure (e.g., invalid configuration, service already running, or
///   runtime initialization failed).
///
/// # Safety
///
/// The caller must ensure that `config_json` is a valid pointer to a
/// null-terminated C string. This function is not thread-safe and should not be
/// called concurrently with `ombrac_client_service_shutdown`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn ombrac_client_service_startup(config_json: *const c_char) -> i32 {
    let config_str = unsafe { c_str_to_str(config_json) };

    let config_file: ConfigFile = match Figment::new()
        .merge(Serialized::defaults(ConfigFile::default()))
        .merge(Json::string(config_str))
        .extract()
    {
        Ok(cfg) => cfg,
        Err(_e) => {
            error!("Failed to parse config JSON: {_e}");
            return -1;
        }
    };

    let service_config = match (config_file.secret, config_file.server) {
        (Some(secret), Some(server)) => ServiceConfig {
            secret,
            server,
            handshake_option: config_file.handshake_option,
            endpoint: config_file.endpoint,
            #[cfg(feature = "transport-quic")]
            transport: config_file.transport,
            #[cfg(feature = "tracing")]
            logging: config_file.logging,
        },
        (None, _) => {
            error!("Configuration error: missing required field `secret` in JSON config");
            return -1;
        }
        (_, None) => {
            error!("Configuration error: missing required field `server` in JSON config");
            return -1;
        }
    };

    #[cfg(feature = "tracing")]
    crate::logging::init_for_ffi(&service_config.logging);

    let runtime = match Builder::new_multi_thread().enable_all().build() {
        Ok(rt) => rt,
        Err(_e) => {
            error!("Failed to create Tokio runtime: {}", _e);
            return -1;
        }
    };

    let service = runtime.block_on(async {
        #[cfg(feature = "transport-quic")]
        Service::build::<QuicServiceBuilder>(Arc::new(service_config)).await
    });

    #[cfg(feature = "transport-quic")]
    let service = match service {
        Ok(s) => s,
        Err(e) => {
            error!("Failed to build service: {}", e);
            return -1;
        }
    };

    #[cfg(not(feature = "transport-quic"))]
    {
        error!("The application was compiled without a transport feature");
        return -1;
    }

    let mut handle_guard = SERVICE_HANDLE.lock().unwrap();
    if handle_guard.is_some() {
        error!("Service is already running. Please shut down the existing service first.");
        return -1;
    }

    *handle_guard = Some(ServiceHandle {
        #[cfg(feature = "transport-quic")]
        service: Some(Box::new(service)),
        runtime,
    });

    info!("Service started successfully");

    0
}

/// Triggers a network rebind on the underlying transport.
///
/// This is useful in scenarios where the network environment changes,
/// to ensure the client can re-establish its connection through a new socket.
///
/// # Returns
///
/// * `0` on success.
/// * `-1` if the service is not running or the rebind operation fails.
///
/// # Safety
///
/// This function is not thread-safe and should not be called concurrently with
/// other service management functions.
#[unsafe(no_mangle)]
pub extern "C" fn ombrac_client_service_rebind() -> i32 {
    let handle_guard = SERVICE_HANDLE.lock().unwrap();
    if let Some(handle) = handle_guard.as_ref() {
        #[cfg(feature = "transport-quic")]
        if let Some(service) = &handle.service {
            let result = handle.runtime.block_on(service.rebind());
            if let Err(e) = result {
                error!("Failed to rebind: {}", e);
                return -1;
            } else {
                info!("Service rebind successful");
                return 0;
            }
        }
    }
    -1
}

/// Shuts down the running service and releases all associated resources.
///
/// This function will gracefully stop the service and terminate the asynchronous
/// runtime. It is safe to call even if the service was not started or has
/// already been stopped.
///
/// # Returns
///
/// * `0` on completion.
///
/// # Safety
///
/// This function is not thread-safe and should not be called concurrently with
/// `ombrac_client_service_startup`.
#[unsafe(no_mangle)]
pub extern "C" fn ombrac_client_service_shutdown() -> i32 {
    let mut handle_guard = SERVICE_HANDLE.lock().unwrap();

    if let Some(mut handle) = handle_guard.take() {
        info!("Shutting down service");

        #[cfg(feature = "transport-quic")]
        if let Some(service) = handle.service.take() {
            handle.runtime.block_on(async {
                service.shutdown().await;
            });
        }

        handle.runtime.shutdown_background();

        info!("Service shut down complete.");
    } else {
        info!("Service was not running.");
    }

    0
}

/// Returns the version of the ombrac-client library.
///
/// The returned string is a null-terminated UTF-8 string. The memory for this
/// string is managed by the library and should not be freed by the caller.
#[unsafe(no_mangle)]
pub extern "C" fn ombrac_client_get_version() -> *const c_char {
    const VERSION_WITH_NULL: &str = concat!(env!("CARGO_PKG_VERSION"), "\0");
    VERSION_WITH_NULL.as_ptr() as *const c_char
}