xref: /base/msdp/device_status/rust/plugin_manager/src/lib.rs

/*
 * Copyright (C) 2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//! Plugin manager, On-demand load and unload dynamic library.
//! Plugin module supply one group of interfaces, bussiness implement these interfaces
//! as a plugin, this plugin can manage by plugin manager.
//! Currently there are two plugins, one is mouse and key coordination, another is drag
//! interacton. They develop base on plugin manager.

#![allow(unused_variables)]
#![allow(dead_code)]

use std::collections::HashMap;
use std::path::Path;
use std::ffi::{ c_char, CString };

use hilog_rust::{ debug, info, error, hilog, HiLogLabel, LogType };

use fusion_data_rust::{ Intention, IPlugin };
use fusion_utils_rust::call_debug_enter;
use fusion_basic_server_rust::FusionBasicServer;

const LOG_LABEL: HiLogLabel = HiLogLabel {
    log_type: LogType::LogCore,
    domain: 0xD002220,
    tag: "FusionPluginManager"
};

/// Helper to define intefaces of library that will be used by [`PluginManager`]
/// to interact with it.
#[macro_export]
macro_rules! export_plugin {
    ($plugin_type:ty) => {
        /// Create a new instance of [`IPlugin`] through which functionalities
        /// of this module can be accessed.
        /// # Safety
        #[no_mangle]
        pub unsafe extern "C" fn _create_plugin() -> *mut dyn IPlugin {
            let boxed = Box::new(<$plugin_type>::default());
            Box::into_raw(boxed)
        }
    };
}

/// Loading、unloading and bookkeeping of modules.
#[derive(Default)]
pub struct PluginManager {
    loaders: HashMap<Intention, libloading::Library>
}

impl PluginManager {
    fn instantiate_loader(&mut self, intention: &Intention) {
        call_debug_enter!("PluginManager::instantiate_loader");
        let file_path = match intention {
            Intention::Drag => {
                Path::new("/system/lib/libfusion_drag_server_ffi.z.so")
            }
            Intention::Coordination => {
                Path::new("/system/lib/libfusion_coordination_server_ffi.z.so")
            }
            _ => {
                return;
            }
        };

        let lib_result = unsafe {
            libloading::Library::new(file_path.as_os_str())
        };
        match lib_result {
            Ok(lib) => {
                info!(LOG_LABEL, "New Library instance created");
                self.loaders.insert(intention.clone(), lib);
            }
            Err(_) => {
                info!(LOG_LABEL, "Failed to create Library instance");
            }
        }
    }

    fn do_load_plugin(&mut self, intention: Intention) -> Option<Box<dyn IPlugin>> {
        call_debug_enter!("PluginManager::do_load_plugin");
        if !self.loaders.contains_key(&intention) {
            self.instantiate_loader(&intention);
        }
        match self.loaders.get(&intention) {
            Some(loader) => {
                if let Ok(creator) = unsafe {
                    loader.get::<libloading::Symbol<unsafe extern "C" fn() -> *mut dyn IPlugin>>(b"_create_plugin")
                } {
                    info!(LOG_LABEL, "Create plugin instance");
                    let plugin_ptr = unsafe {
                        creator()
                    };
                    if plugin_ptr.is_null() {
                        error!(LOG_LABEL, "Failed to create plugin instance");
                        None
                    } else {
                        Some(unsafe {
                            info!(LOG_LABEL, "Plugin is loaded");
                            Box::from_raw(plugin_ptr)
                        })
                    }
                } else {
                    error!(LOG_LABEL, "Symbol is not found");
                    None
                }
            }
            None => {
                error!(LOG_LABEL, "Can not instantiate loader");
                None
            }
        }
    }

    /// Load module identified by [`intention`].
    pub fn load_plugin(&mut self, intention: Intention) -> Option<Box<dyn IPlugin>>
    {
        call_debug_enter!("PluginManager::load_plugin");
        match intention {
            Intention::Basic => {
                Some(Box::<FusionBasicServer>::default())
            }
            _ => {
                self.do_load_plugin(intention)
            }
        }
    }

    /// Unload module identified by [`intention`].
    pub fn unload_plugin(&mut self, intention: Intention) {
        call_debug_enter!("PluginManager::unload_plugin");
        if let Some(loader) = self.loaders.remove(&intention) {
            info!(LOG_LABEL, "Library({}) is unloaded", @public(intention as u32));
        } else {
            debug!(LOG_LABEL, "Library({}) has not been loaded", @public(intention as u32));
        }
    }
}