1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

// Copyright 2015-2019 Capital One Services, LLC
//
// 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.

use crate::Result;
use libloading::Library;
use libloading::Symbol;
use std::ffi::OsStr;
use wascc_codec::capabilities::CapabilityProvider;

#[derive(Debug, Clone)]
pub struct CapabilitySummary {
    pub name: String,
    pub id: String,
    pub portable: bool,
}

/// Represents a native capability provider compiled as a shared object library.
/// These plugins are OS-specific, so they will be `.so` files on Linux, `.dylib`
/// files on macOS, etc.
pub struct NativeCapability {
    pub(crate) capid: String,
    pub(crate) plugin: Box<dyn CapabilityProvider>,
    // This field is solely used to keep the FFI library instance allocated for the same
    // lifetime as the boxed plugin
    #[allow(dead_code)]
    library: Option<Library>,
}

impl NativeCapability {
    /// Reads a capability provider from a file. The capability provider must implement the
    /// correct FFI interface to support waSCC plugins
    pub fn from_file<P: AsRef<OsStr>>(filename: P) -> Result<Self> {
        type PluginCreate = unsafe fn() -> *mut dyn CapabilityProvider;

        let library = Library::new(filename.as_ref())?;

        let plugin = unsafe {
            let constructor: Symbol<PluginCreate> = library.get(b"__capability_provider_create")?;
            let boxed_raw = constructor();

            Box::from_raw(boxed_raw)
        };
        info!(
            "Loaded capability: {}, native provider: {}",
            plugin.capability_id(),
            plugin.name()
        );

        let capid = plugin.capability_id().to_string();
        Ok(NativeCapability {
            capid,
            plugin,
            library: Some(library),
        })
    }

    /// If you know ahead of time that you want a particular capability provider to be a compile-time
    /// dependency, you can create your own provider instance and pass it to this function
    pub fn from_instance(instance: impl CapabilityProvider) -> Result<Self> {
        let capid = instance.capability_id();
        Ok(NativeCapability {
            capid: capid.to_string(),
            plugin: Box::new(instance),
            library: None,
        })
    }

    pub fn id(&self) -> String {
        self.capid.clone()
    }

    pub fn name(&self) -> String {
        self.plugin.name().to_string()
    }
}