2020-06-05 20:12:02 +00:00
|
|
|
/*
|
|
|
|
* Copyright 2020 Fluence Labs Limited
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2020-10-01 09:19:38 +00:00
|
|
|
use crate::config::FaaSConfig;
|
2020-09-15 22:14:15 +00:00
|
|
|
use crate::misc::ModulesLoadStrategy;
|
2020-08-07 20:24:28 +00:00
|
|
|
use crate::faas_interface::FaaSInterface;
|
|
|
|
use crate::FaaSError;
|
2020-06-30 12:57:48 +00:00
|
|
|
use crate::Result;
|
2020-08-07 20:24:28 +00:00
|
|
|
use crate::IValue;
|
2020-06-05 20:12:02 +00:00
|
|
|
|
|
|
|
use fce::FCE;
|
2020-08-25 16:26:21 +00:00
|
|
|
use fluence_sdk_main::CallParameters;
|
2020-06-11 21:05:04 +00:00
|
|
|
|
2020-08-25 16:26:21 +00:00
|
|
|
use std::cell::RefCell;
|
2020-06-30 12:57:48 +00:00
|
|
|
use std::convert::TryInto;
|
2020-08-07 20:24:28 +00:00
|
|
|
use std::collections::HashSet;
|
2020-08-07 21:52:21 +00:00
|
|
|
use std::collections::HashMap;
|
2020-08-25 16:26:21 +00:00
|
|
|
use std::rc::Rc;
|
2020-06-05 20:12:02 +00:00
|
|
|
use std::fs;
|
2020-08-25 16:26:21 +00:00
|
|
|
use std::path::PathBuf;
|
2020-06-05 20:12:02 +00:00
|
|
|
|
2020-06-30 12:57:48 +00:00
|
|
|
// TODO: remove and use mutex instead
|
|
|
|
unsafe impl Send for FluenceFaaS {}
|
|
|
|
|
2020-06-15 14:22:18 +00:00
|
|
|
pub struct FluenceFaaS {
|
2020-08-25 16:26:21 +00:00
|
|
|
/// The Fluence Compute Engine instance.
|
2020-06-16 06:53:47 +00:00
|
|
|
fce: FCE,
|
2020-08-25 16:26:21 +00:00
|
|
|
|
|
|
|
/// Parameters of call accessible by Wasm modules.
|
|
|
|
call_parameters: Rc<RefCell<CallParameters>>,
|
2020-06-05 20:12:02 +00:00
|
|
|
}
|
|
|
|
|
2020-06-15 14:22:18 +00:00
|
|
|
impl FluenceFaaS {
|
2020-06-30 12:57:48 +00:00
|
|
|
/// Creates FaaS from config on filesystem.
|
2020-10-01 09:19:38 +00:00
|
|
|
pub fn with_config_path<P: Into<PathBuf>>(config_file_path: P) -> Result<Self> {
|
|
|
|
let config = crate::raw_toml_config::TomlFaaSConfig::load(config_file_path.into())?;
|
2020-06-30 12:57:48 +00:00
|
|
|
Self::with_raw_config(config)
|
|
|
|
}
|
2020-06-06 18:34:13 +00:00
|
|
|
|
2020-06-30 12:57:48 +00:00
|
|
|
/// Creates FaaS from config deserialized from TOML.
|
2020-08-07 08:54:37 +00:00
|
|
|
pub fn with_raw_config<C>(config: C) -> Result<Self>
|
|
|
|
where
|
2020-10-01 09:19:38 +00:00
|
|
|
C: TryInto<FaaSConfig>,
|
2020-08-07 20:24:28 +00:00
|
|
|
FaaSError: From<C::Error>,
|
2020-08-07 08:54:37 +00:00
|
|
|
{
|
|
|
|
let config = config.try_into()?;
|
2020-08-07 21:52:21 +00:00
|
|
|
let modules = config
|
|
|
|
.modules_dir
|
|
|
|
.as_ref()
|
|
|
|
.map_or(Ok(HashMap::new()), |dir| {
|
2020-08-14 10:28:15 +00:00
|
|
|
Self::load_modules(dir, ModulesLoadStrategy::WasmOnly)
|
2020-08-07 21:52:21 +00:00
|
|
|
})?;
|
|
|
|
|
2020-10-01 09:19:38 +00:00
|
|
|
Self::with_modules::<FaaSConfig>(modules, config)
|
2020-06-30 12:57:48 +00:00
|
|
|
}
|
2020-06-06 18:34:13 +00:00
|
|
|
|
2020-06-30 12:57:48 +00:00
|
|
|
/// Creates FaaS with given modules.
|
2020-08-07 21:52:21 +00:00
|
|
|
pub fn with_modules<C>(mut modules: HashMap<String, Vec<u8>>, config: C) -> Result<Self>
|
2020-06-30 12:57:48 +00:00
|
|
|
where
|
2020-10-01 09:19:38 +00:00
|
|
|
C: TryInto<FaaSConfig>,
|
2020-06-30 12:57:48 +00:00
|
|
|
FaaSError: From<C::Error>,
|
|
|
|
{
|
|
|
|
let mut fce = FCE::new();
|
2020-08-07 21:52:21 +00:00
|
|
|
let config = config.try_into()?;
|
2020-08-25 16:26:21 +00:00
|
|
|
let call_parameters = Rc::new(RefCell::new(<_>::default()));
|
2020-08-07 21:52:21 +00:00
|
|
|
|
2020-10-14 12:08:02 +00:00
|
|
|
let modules_dir = config.modules_dir;
|
2020-08-07 21:52:21 +00:00
|
|
|
for (module_name, module_config) in config.modules_config {
|
2020-10-16 12:26:09 +00:00
|
|
|
let module_bytes =
|
|
|
|
modules.remove(&module_name).ok_or_else(|| {
|
|
|
|
FaaSError::InstantiationError(format!(
|
2020-10-14 12:08:02 +00:00
|
|
|
"module with name {} is specified in config (dir: {:?}), but not found in provided modules: {:?}",
|
|
|
|
module_name, modules_dir, modules.keys().collect::<Vec<_>>()
|
2020-08-07 21:52:21 +00:00
|
|
|
))
|
2020-10-16 12:26:09 +00:00
|
|
|
})?;
|
2020-10-01 09:19:38 +00:00
|
|
|
|
2020-10-23 14:05:58 +00:00
|
|
|
let fce_module_config = crate::misc::make_fce_config(
|
|
|
|
module_name.clone(),
|
|
|
|
Some(module_config),
|
|
|
|
call_parameters.clone(),
|
|
|
|
)?;
|
2020-08-07 21:52:21 +00:00
|
|
|
fce.load_module(module_name, &module_bytes, fce_module_config)?;
|
|
|
|
}
|
2020-06-06 18:34:13 +00:00
|
|
|
|
2020-08-25 16:26:21 +00:00
|
|
|
Ok(Self {
|
|
|
|
fce,
|
|
|
|
call_parameters,
|
|
|
|
})
|
2020-06-30 12:57:48 +00:00
|
|
|
}
|
|
|
|
|
2020-08-07 08:54:37 +00:00
|
|
|
/// Searches for modules in `config.modules_dir`, loads only those in the `names` set
|
2020-07-20 14:13:11 +00:00
|
|
|
pub fn with_module_names<C>(names: &HashSet<String>, config: C) -> Result<Self>
|
|
|
|
where
|
2020-10-01 09:19:38 +00:00
|
|
|
C: TryInto<FaaSConfig>,
|
2020-07-20 14:13:11 +00:00
|
|
|
FaaSError: From<C::Error>,
|
|
|
|
{
|
|
|
|
let config = config.try_into()?;
|
2020-08-07 21:52:21 +00:00
|
|
|
let modules = config
|
|
|
|
.modules_dir
|
|
|
|
.as_ref()
|
|
|
|
.map_or(Ok(HashMap::new()), |dir| {
|
|
|
|
Self::load_modules(dir, ModulesLoadStrategy::Named(names))
|
|
|
|
})?;
|
|
|
|
|
2020-10-01 09:19:38 +00:00
|
|
|
Self::with_modules::<FaaSConfig>(modules, config)
|
2020-07-20 14:13:11 +00:00
|
|
|
}
|
|
|
|
|
2020-06-30 12:57:48 +00:00
|
|
|
/// Loads modules from a directory at a given path. Non-recursive, ignores subdirectories.
|
2020-07-20 14:13:11 +00:00
|
|
|
fn load_modules(
|
2020-10-01 09:19:38 +00:00
|
|
|
modules_dir: &PathBuf,
|
2020-08-07 08:54:37 +00:00
|
|
|
modules: ModulesLoadStrategy<'_>,
|
2020-08-07 21:52:21 +00:00
|
|
|
) -> Result<HashMap<String, Vec<u8>>> {
|
2020-06-30 12:57:48 +00:00
|
|
|
use FaaSError::IOError;
|
|
|
|
|
2020-08-07 08:54:37 +00:00
|
|
|
let mut dir_entries =
|
2020-10-01 09:19:38 +00:00
|
|
|
fs::read_dir(modules_dir).map_err(|e| IOError(format!("{:?}: {}", modules_dir, e)))?;
|
2020-06-30 12:57:48 +00:00
|
|
|
|
2020-08-07 21:52:21 +00:00
|
|
|
let loaded = dir_entries.try_fold(HashMap::new(), |mut hash_map, entry| {
|
2020-06-30 12:57:48 +00:00
|
|
|
let entry = entry?;
|
|
|
|
let path = entry.path();
|
2020-07-20 14:13:11 +00:00
|
|
|
// Skip directories
|
|
|
|
if path.is_dir() {
|
2020-08-07 21:52:21 +00:00
|
|
|
return Ok(hash_map);
|
2020-07-20 14:13:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
let module_name = path
|
|
|
|
.file_name()
|
|
|
|
.ok_or_else(|| IOError(format!("No file name in path {:?}", path)))?
|
|
|
|
.to_os_string()
|
|
|
|
.into_string()
|
|
|
|
.map_err(|name| IOError(format!("invalid file name: {:?}", name)))?;
|
|
|
|
|
2020-08-14 10:28:15 +00:00
|
|
|
if modules.should_load(&module_name.as_ref()) {
|
2020-06-30 12:57:48 +00:00
|
|
|
let module_bytes = fs::read(path)?;
|
2020-08-14 10:28:15 +00:00
|
|
|
let module_name = modules.extract_module_name(module_name);
|
2020-08-07 21:52:21 +00:00
|
|
|
if hash_map.insert(module_name, module_bytes).is_some() {
|
|
|
|
return Err(FaaSError::ConfigParseError(String::from(
|
2020-08-14 10:28:15 +00:00
|
|
|
"module {} is duplicated in config",
|
2020-08-07 21:52:21 +00:00
|
|
|
)));
|
|
|
|
}
|
2020-06-30 12:57:48 +00:00
|
|
|
}
|
|
|
|
|
2020-08-07 21:52:21 +00:00
|
|
|
Ok(hash_map)
|
2020-07-20 14:13:11 +00:00
|
|
|
})?;
|
|
|
|
|
|
|
|
if modules.required_modules_len() > loaded.len() {
|
|
|
|
let loaded = loaded.iter().map(|(n, _)| n);
|
|
|
|
let not_found = modules.missing_modules(loaded);
|
|
|
|
return Err(FaaSError::ConfigParseError(format!(
|
|
|
|
"the following modules were not found: {:?}",
|
|
|
|
not_found
|
|
|
|
)));
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(loaded)
|
2020-06-05 20:12:02 +00:00
|
|
|
}
|
|
|
|
|
2020-06-15 19:21:08 +00:00
|
|
|
/// Call a specified function of loaded on a startup module by its name.
|
2020-09-15 22:14:15 +00:00
|
|
|
pub fn call_with_ivalues<MN: AsRef<str>, FN: AsRef<str>>(
|
2020-06-11 23:04:52 +00:00
|
|
|
&mut self,
|
2020-07-17 20:07:02 +00:00
|
|
|
module_name: MN,
|
|
|
|
func_name: FN,
|
2020-06-11 23:04:52 +00:00
|
|
|
args: &[IValue],
|
2020-08-25 16:26:21 +00:00
|
|
|
call_parameters: fluence_sdk_main::CallParameters,
|
2020-06-30 12:57:48 +00:00
|
|
|
) -> Result<Vec<IValue>> {
|
2020-08-25 16:26:21 +00:00
|
|
|
self.call_parameters.replace(call_parameters);
|
|
|
|
|
2020-06-16 06:53:47 +00:00
|
|
|
self.fce
|
2020-06-11 23:04:52 +00:00
|
|
|
.call(module_name, func_name, args)
|
|
|
|
.map_err(Into::into)
|
|
|
|
}
|
|
|
|
|
2020-09-15 22:14:15 +00:00
|
|
|
/// Call a specified function of loaded on a startup module by its name.
|
|
|
|
pub fn call_with_json<MN: AsRef<str>, FN: AsRef<str>>(
|
|
|
|
&mut self,
|
|
|
|
module_name: MN,
|
|
|
|
func_name: FN,
|
|
|
|
json_args: serde_json::Value,
|
|
|
|
call_parameters: fluence_sdk_main::CallParameters,
|
|
|
|
) -> Result<Vec<IValue>> {
|
|
|
|
let module_name = module_name.as_ref();
|
|
|
|
let func_name = func_name.as_ref();
|
|
|
|
|
|
|
|
let iargs = {
|
2020-10-21 19:21:16 +00:00
|
|
|
// TODO: cache module interface
|
|
|
|
let module_interface = self
|
|
|
|
.fce
|
|
|
|
.module_interface(module_name)
|
|
|
|
.ok_or_else(|| FaaSError::NoSuchModule(module_name.to_string()))?;
|
|
|
|
|
|
|
|
let func_signature = module_interface
|
|
|
|
.function_signatures
|
|
|
|
.iter()
|
2020-09-15 22:14:15 +00:00
|
|
|
.find(|sign| sign.name == func_name)
|
|
|
|
.ok_or_else(|| FaaSError::MissingFunctionError(func_name.to_string()))?;
|
|
|
|
|
2020-10-21 19:21:16 +00:00
|
|
|
let record_types = module_interface.record_types;
|
2020-09-15 22:14:15 +00:00
|
|
|
|
2020-10-21 19:21:16 +00:00
|
|
|
crate::misc::json_to_ivalues(json_args, func_signature, &record_types)?
|
2020-09-15 22:14:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
self.call_parameters.replace(call_parameters);
|
|
|
|
self.fce
|
|
|
|
.call(module_name, func_name, &iargs)
|
|
|
|
.map_err(Into::into)
|
|
|
|
}
|
|
|
|
|
2020-08-07 08:54:37 +00:00
|
|
|
/// Return all export functions (name and signatures) of loaded modules.
|
|
|
|
pub fn get_interface(&self) -> FaaSInterface<'_> {
|
2020-10-21 19:21:16 +00:00
|
|
|
let modules = self.fce.interface().collect();
|
|
|
|
|
|
|
|
FaaSInterface { modules }
|
2020-06-05 20:12:02 +00:00
|
|
|
}
|
|
|
|
}
|
2020-08-07 20:24:28 +00:00
|
|
|
|
|
|
|
// This API is intended for testing purposes (mostly in FCE REPL)
|
|
|
|
#[cfg(feature = "raw-module-api")]
|
|
|
|
impl FluenceFaaS {
|
|
|
|
pub fn load_module<S, C>(&mut self, name: S, wasm_bytes: &[u8], config: Option<C>) -> Result<()>
|
|
|
|
where
|
|
|
|
S: Into<String>,
|
2020-10-01 09:19:38 +00:00
|
|
|
C: TryInto<crate::FaaSModuleConfig>,
|
2020-08-07 20:24:28 +00:00
|
|
|
FaaSError: From<C::Error>,
|
|
|
|
{
|
|
|
|
let config = config.map(|c| c.try_into()).transpose()?;
|
2020-10-23 14:05:58 +00:00
|
|
|
let name = name.into();
|
2020-08-07 20:24:28 +00:00
|
|
|
|
2020-10-23 14:05:58 +00:00
|
|
|
let fce_module_config =
|
|
|
|
crate::misc::make_fce_config(name.clone(), config, self.call_parameters.clone())?;
|
2020-08-07 20:24:28 +00:00
|
|
|
self.fce
|
|
|
|
.load_module(name, &wasm_bytes, fce_module_config)
|
|
|
|
.map_err(Into::into)
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn unload_module<S: AsRef<str>>(&mut self, module_name: S) -> Result<()> {
|
|
|
|
self.fce.unload_module(module_name).map_err(Into::into)
|
|
|
|
}
|
2020-08-08 20:07:21 +00:00
|
|
|
|
|
|
|
pub fn module_wasi_state<S: AsRef<str>>(
|
|
|
|
&mut self,
|
|
|
|
module_name: S,
|
|
|
|
) -> Result<&wasmer_wasi::state::WasiState> {
|
2020-10-21 19:21:16 +00:00
|
|
|
let module_name = module_name.as_ref();
|
|
|
|
|
|
|
|
self.fce
|
|
|
|
.module_wasi_state(module_name)
|
|
|
|
.ok_or_else(|| FaaSError::NoSuchModule(module_name.to_string()))
|
2020-08-08 20:07:21 +00:00
|
|
|
}
|
2020-08-07 20:24:28 +00:00
|
|
|
}
|