idevice/ffi/src/os_trace_relay.rs

use std::os::raw::c_char;
use std::{ffi::CString, ptr::null_mut};

use idevice::{
    IdeviceError, IdeviceService, os_trace_relay::OsTraceRelayClient, provider::IdeviceProvider,
};

use crate::{IdeviceFfiError, RUNTIME, ffi_err, provider::IdeviceProviderHandle};

pub struct OsTraceRelayClientHandle(pub OsTraceRelayClient);
pub struct OsTraceRelayReceiverHandle(pub idevice::os_trace_relay::OsTraceRelayReceiver);

#[repr(C)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OsTraceLog {
    pub pid: u32,
    pub timestamp: i64,
    pub level: u8,
    pub image_name: *const c_char,
    pub filename: *const c_char,
    pub message: *const c_char,
    pub label: *const SyslogLabel,
}

#[repr(C)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SyslogLabel {
    pub subsystem: *const c_char,
    pub category: *const c_char,
}

/// Connects to the relay with the given provider
///
/// # Arguments
/// * [`provider`] - A provider created by this library
/// * [`client`] - A pointer where the handle will be allocated
///
/// # Returns
/// 0 for success, an *mut IdeviceFfiError otherwise
///
/// # Safety
/// None of the arguments can be null. Provider must be allocated by this library.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_connect(
    provider: *mut IdeviceProviderHandle,
    client: *mut *mut OsTraceRelayClientHandle,
) -> *mut IdeviceFfiError {
    if provider.is_null() {
        log::error!("Null pointer provided");
        return ffi_err!(IdeviceError::FfiInvalidArg);
    }

    let res: Result<OsTraceRelayClient, IdeviceError> = RUNTIME.block_on(async move {
        let provider_ref: &dyn IdeviceProvider = unsafe { &*(*provider).0 };
        OsTraceRelayClient::connect(provider_ref).await
    });

    match res {
        Ok(c) => {
            let boxed = Box::new(OsTraceRelayClientHandle(c));
            unsafe { *client = Box::into_raw(boxed) };
            null_mut()
        }
        Err(e) => {
            let _ = unsafe { Box::from_raw(provider) };
            ffi_err!(e)
        }
    }
}

/// Frees the relay client
///
/// # Arguments
/// * [`handle`] - The relay client handle
///
/// # Safety
/// The handle must be allocated by this library
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_free(handle: *mut OsTraceRelayClientHandle) {
    if !handle.is_null() {
        log::debug!("Freeing os trace relay client");
        let _ = unsafe { Box::from_raw(handle) };
    }
}

/// Creates a handle and starts receiving logs
///
/// # Arguments
/// * [`client`] - The relay client handle
/// * [`receiver`] - A pointer to allocate the new handle to
/// * [`pid`] - An optional pointer to a PID to get logs for. May be null.
///
/// # Returns
/// 0 for success, an *mut IdeviceFfiError otherwise
///
/// # Safety
/// The handle must be allocated by this library. It is consumed, and must never be used again.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_start_trace(
    client: *mut OsTraceRelayClientHandle,
    receiver: *mut *mut OsTraceRelayReceiverHandle,
    pid: *const u32,
) -> *mut IdeviceFfiError {
    if receiver.is_null() || client.is_null() {
        log::error!("Null pointer provided");
        return ffi_err!(IdeviceError::FfiInvalidArg);
    }

    let pid_option = if pid.is_null() {
        None
    } else {
        Some(unsafe { *pid })
    };

    let client_owned = unsafe { Box::from_raw(client) };

    let res = RUNTIME.block_on(async { client_owned.0.start_trace(pid_option).await });

    match res {
        Ok(relay) => {
            let boxed = Box::new(OsTraceRelayReceiverHandle(relay));
            unsafe { *receiver = Box::into_raw(boxed) };

            null_mut()
        }
        Err(e) => ffi_err!(e),
    }
}

/// Frees the receiver handle
///
/// # Arguments
/// * [`handle`] - The relay receiver client handle
///
/// # Safety
/// The handle must be allocated by this library. It is consumed, and must never be used again.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_receiver_free(handle: *mut OsTraceRelayReceiverHandle) {
    if !handle.is_null() {
        log::debug!("Freeing syslog relay client");
        let _ = unsafe { Box::from_raw(handle) };
    }
}

/// Gets the PID list from the device
///
/// # Arguments
/// * [`client`] - The relay receiver client handle
/// * [`list`] - A pointer to allocate a list of PIDs to
///
/// # Returns
/// 0 for success, an *mut IdeviceFfiError otherwise
///
/// # Safety
/// The handle must be allocated by this library.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_get_pid_list(
    client: *mut OsTraceRelayClientHandle,
    list: *mut *mut Vec<u64>,
) -> *mut IdeviceFfiError {
    let res = RUNTIME.block_on(async { unsafe { &mut *client }.0.get_pid_list().await });

    match res {
        Ok(r) => {
            unsafe { *list = Box::into_raw(Box::new(r)) };
            null_mut()
        }
        Err(e) => ffi_err!(e),
    }
}

/// Gets the next log from the relay
///
/// # Arguments
/// * [`client`] - The relay receiver client handle
/// * [`log`] - A pointer to allocate the new log
///
/// # Returns
/// 0 for success, an *mut IdeviceFfiError otherwise
///
/// # Safety
/// The handle must be allocated by this library.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_next(
    client: *mut OsTraceRelayReceiverHandle,
    log: *mut *mut OsTraceLog,
) -> *mut IdeviceFfiError {
    if client.is_null() {
        log::error!("Null pointer provided");
        return ffi_err!(IdeviceError::FfiInvalidArg);
    }

    let res = RUNTIME.block_on(async { unsafe { &mut *client }.0.next().await });

    match res {
        Ok(r) => {
            let log_entry = Box::new(OsTraceLog {
                pid: r.pid,
                timestamp: r.timestamp.and_utc().timestamp(),
                level: r.level as u8,
                image_name: CString::new(r.image_name).unwrap().into_raw(),
                filename: CString::new(r.filename).unwrap().into_raw(),
                message: CString::new(r.message).unwrap().into_raw(),
                label: if let Some(label) = r.label {
                    Box::into_raw(Box::new(SyslogLabel {
                        subsystem: CString::new(label.subsystem).unwrap().into_raw(),
                        category: CString::new(label.category).unwrap().into_raw(),
                    }))
                } else {
                    std::ptr::null()
                },
            });

            unsafe { *log = Box::into_raw(log_entry) };
            null_mut()
        }
        Err(e) => ffi_err!(e),
    }
}

/// Frees a log received from the relay
///
/// # Arguments
/// * [`log`] - The log to free
///
/// # Returns
/// 0 for success, an *mut IdeviceFfiError otherwise
///
/// # Safety
/// The log must be allocated by this library. It is consumed and must not be used again.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn os_trace_relay_free_log(log: *mut OsTraceLog) {
    if !log.is_null() {
        unsafe {
            if !(*log).image_name.is_null() {
                let _ = CString::from_raw((*log).image_name as *mut c_char);
            }
            if !(*log).filename.is_null() {
                let _ = CString::from_raw((*log).filename as *mut c_char);
            }
            if !(*log).message.is_null() {
                let _ = CString::from_raw((*log).message as *mut c_char);
            }
            if !(*log).label.is_null() {
                let label = &*(*log).label;

                if !label.subsystem.is_null() {
                    let _ = CString::from_raw(label.subsystem as *mut c_char);
                }

                if !label.category.is_null() {
                    let _ = CString::from_raw(label.category as *mut c_char);
                }

                let _ = Box::from_raw((*log).label as *mut SyslogLabel);
            }

            let _ = Box::from_raw(log);
        }
    }
}