Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(plugins): reload plugin at runtime #2372

Merged
merged 17 commits into from
Apr 19, 2023
Merged

feat(plugins): reload plugin at runtime #2372

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
5d04d43
fix(plugins): proper error when wasm file does not exist
imsnif Apr 6, 2023
aca4b22
reload working
imsnif Apr 11, 2023
0c9e6a1
race condition handling
imsnif Apr 12, 2023
f012b80
refactor(plugins): start plugin
imsnif Apr 14, 2023
bf264fe
refactor(plugins): plugin-loader
imsnif Apr 17, 2023
4b9a304
refactor(plugins): load/reload plugin
imsnif Apr 17, 2023
0b4325d
refactor(plugins): apply cached events
imsnif Apr 17, 2023
8fc5079
fix(plugins): gittery loading
imsnif Apr 18, 2023
f591775
chore(plugins): rename reload-plugin to start-or-reload-plugin
imsnif Apr 18, 2023
4980d7c
chore(styling): small cleanups
imsnif Apr 18, 2023
d6429e9
style(fmt): rustfmt
imsnif Apr 18, 2023
fa4c37f
style(fmt): cleanups
imsnif Apr 18, 2023
1446616
Merge branch 'main' into plugin-reload
imsnif Apr 18, 2023
b6aefe0
style(fmt): cleanups
imsnif Apr 18, 2023
5d7d6d4
test(e2e): update snapshots
imsnif Apr 18, 2023
ee7a722
test(e2e): update snapshots
imsnif Apr 18, 2023
05f2938
chore(repo): comment plugin optimization because it doubles the CI time
imsnif Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
style(fmt): rustfmt
  • Loading branch information
@imsnif
imsnif committed Apr 18, 2023
commit d6429e9aa78b4c97d9f2944341c3e2bebde96cf1
61 changes: 35 additions & 26 deletions zellij-server/src/plugins/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ pub enum PluginInstruction {
ClientId,
Size,
),
Resize(u32, usize, usize), // plugin_id, columns, rows
Resize(u32, usize, usize), // plugin_id, columns, rows
AddClient(ClientId),
RemoveClient(ClientId),
NewTab(
Expand Down Expand Up @@ -111,32 +111,41 @@ pub(crate) fn plugin_thread_main(
PluginInstruction::Unload(pid) => {
wasm_bridge.unload_plugin(pid)?;
},
PluginInstruction::Reload(should_float, pane_title, run, tab_index, client_id, size) => {
match wasm_bridge.reload_plugin(&run) {
Ok(_) => { let _ = bus.senders.send_to_server(ServerInstruction::UnblockInputThread); },
Err(err) => match err.downcast_ref::<ZellijError>() {
Some(ZellijError::PluginDoesNotExist) => {
log::warn!("Plugin {} not found, starting it instead", run.location);
match wasm_bridge.load_plugin(&run, tab_index, size, client_id) {
Ok(plugin_id) => {
drop(bus.senders.send_to_screen(ScreenInstruction::AddPlugin(
should_float,
run,
pane_title,
tab_index,
plugin_id,
)));
},
Err(e) => {
log::error!("Failed to load plugin: {e}");
},
};
},
_ => {
return Err(err);
}
PluginInstruction::Reload(
should_float,
pane_title,
run,
tab_index,
client_id,
size,
) => match wasm_bridge.reload_plugin(&run) {
Ok(_) => {
let _ = bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread);
},
Err(err) => match err.downcast_ref::<ZellijError>() {
Some(ZellijError::PluginDoesNotExist) => {
log::warn!("Plugin {} not found, starting it instead", run.location);
match wasm_bridge.load_plugin(&run, tab_index, size, client_id) {
Ok(plugin_id) => {
drop(bus.senders.send_to_screen(ScreenInstruction::AddPlugin(
should_float,
run,
pane_title,
tab_index,
plugin_id,
)));
},
Err(e) => {
log::error!("Failed to load plugin: {e}");
},
};
},
}
_ => {
return Err(err);
},
},
},
PluginInstruction::Resize(pid, new_columns, new_rows) => {
wasm_bridge.resize_plugin(pid, new_columns, new_rows)?;
Expand Down
174 changes: 139 additions & 35 deletions zellij-server/src/plugins/plugin_loader.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::plugins::{wasm_bridge::{wasi_read_string, zellij_exports, PluginEnv, PluginMap}};
use crate::plugins::wasm_bridge::{wasi_read_string, zellij_exports, PluginEnv, PluginMap};
use highway::{HighwayHash, PortableHash};
use log::info;
use semver::Version;
Expand Down Expand Up @@ -27,10 +27,12 @@ use zellij_utils::{
macro_rules! display_loading_stage {
($loading_stage:ident, $loading_indication:expr, $senders:expr, $plugin_id:expr) => {{
$loading_indication.$loading_stage();
drop($senders.send_to_screen(ScreenInstruction::UpdatePluginLoadingStage(
$plugin_id,
$loading_indication.clone(),
)));
drop(
$senders.send_to_screen(ScreenInstruction::UpdatePluginLoadingStage(
$plugin_id,
$loading_indication.clone(),
)),
);
}};
}

Expand Down Expand Up @@ -156,7 +158,7 @@ fn load_plugin_instance(instance: &mut Instance) -> Result<()> {
Ok(())
}

pub struct PluginLoader <'a>{
pub struct PluginLoader<'a> {
plugin_cache: Arc<Mutex<HashMap<PathBuf, Module>>>,
plugin_map: Arc<Mutex<PluginMap>>,
plugin_path: PathBuf,
Expand All @@ -173,7 +175,7 @@ pub struct PluginLoader <'a>{
wasm_blob_on_hd: Option<(Vec<u8>, PathBuf)>,
}

impl <'a> PluginLoader <'a>{
impl<'a> PluginLoader<'a> {
pub fn reload_plugin_from_memory(
plugin_id: u32,
plugin_dir: PathBuf,
Expand Down Expand Up @@ -202,18 +204,22 @@ impl <'a> PluginLoader <'a>{
&store,
&plugin_dir,
)?;
plugin_loader.load_module_from_memory()
plugin_loader
.load_module_from_memory()
.and_then(|module| plugin_loader.create_plugin_instance_and_environment(module))
.and_then(|(instance, plugin_env)| {
plugin_loader.load_plugin_instance(&instance, &plugin_env)?;
plugin_loader.clone_instance_for_other_clients(&instance, &plugin_env, &connected_clients)
plugin_loader.clone_instance_for_other_clients(
&instance,
&plugin_env,
&connected_clients,
)
})
.with_context(err_context)?;
display_loading_stage!(end, loading_indication, senders, plugin_id);
Ok(())
}


pub fn start_plugin(
plugin_id: u32,
client_id: ClientId,
Expand Down Expand Up @@ -242,13 +248,18 @@ impl <'a> PluginLoader <'a>{
tab_index,
size,
)?;
plugin_loader.load_module_from_memory()
plugin_loader
.load_module_from_memory()
.or_else(|_e| plugin_loader.load_module_from_hd_cache())
.or_else(|_e| plugin_loader.compile_module())
.and_then(|module| plugin_loader.create_plugin_instance_and_environment(module))
.and_then(|(instance, plugin_env)| {
plugin_loader.load_plugin_instance(&instance, &plugin_env)?;
plugin_loader.clone_instance_for_other_clients(&instance, &plugin_env, &connected_clients.lock().unwrap())
plugin_loader.clone_instance_for_other_clients(
&instance,
&plugin_env,
&connected_clients.lock().unwrap(),
)
})
.with_context(err_context)?;
display_loading_stage!(end, loading_indication, senders, plugin_id);
Expand Down Expand Up @@ -284,11 +295,16 @@ impl <'a> PluginLoader <'a>{
&store,
&plugin_dir,
)?;
plugin_loader.compile_module()
plugin_loader
.compile_module()
.and_then(|module| plugin_loader.create_plugin_instance_and_environment(module))
.and_then(|(instance, plugin_env)| {
plugin_loader.load_plugin_instance(&instance, &plugin_env)?;
plugin_loader.clone_instance_for_other_clients(&instance, &plugin_env, &connected_clients)
plugin_loader.clone_instance_for_other_clients(
&instance,
&plugin_env,
&connected_clients,
)
})
.with_context(err_context)?;
display_loading_stage!(end, loading_indication, senders, plugin_id);
Expand Down Expand Up @@ -340,7 +356,9 @@ impl <'a> PluginLoader <'a>{
let err_context = || "Failed to find existing plugin";
let (_old_instance, old_user_env, (rows, cols)) = {
let mut plugin_map = plugin_map.lock().unwrap();
plugin_map.remove(&(plugin_id, client_id)).with_context(err_context)?
plugin_map
.remove(&(plugin_id, client_id))
.with_context(err_context)?
};
let tab_index = old_user_env.tab_index;
let size = Size { rows, cols };
Expand All @@ -361,14 +379,39 @@ impl <'a> PluginLoader <'a>{
)
}
pub fn load_module_from_memory(&mut self) -> Result<Module> {
display_loading_stage!(indicate_loading_plugin_from_memory, self.loading_indication, self.senders, self.plugin_id);
let module = self.plugin_cache.lock().unwrap().remove(&self.plugin_path).ok_or(anyhow!("Plugin is not stored in memory"))?;
display_loading_stage!(indicate_loading_plugin_from_memory_success, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_loading_plugin_from_memory,
self.loading_indication,
self.senders,
self.plugin_id
);
let module = self
.plugin_cache
.lock()
.unwrap()
.remove(&self.plugin_path)
.ok_or(anyhow!("Plugin is not stored in memory"))?;
display_loading_stage!(
indicate_loading_plugin_from_memory_success,
self.loading_indication,
self.senders,
self.plugin_id
);
Ok(module)
}
pub fn load_module_from_hd_cache(&mut self) -> Result<Module> {
display_loading_stage!(indicate_loading_plugin_from_memory_notfound, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(indicate_loading_plugin_from_hd_cache, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_loading_plugin_from_memory_notfound,
self.loading_indication,
self.senders,
self.plugin_id
);
display_loading_stage!(
indicate_loading_plugin_from_hd_cache,
self.loading_indication,
self.senders,
self.plugin_id
);
let (_wasm_bytes, cached_path) = self.plugin_bytes_and_cache_path()?;
let timer = std::time::Instant::now();
let module = unsafe { Module::deserialize_from_file(&self.store, &cached_path)? };
Expand All @@ -378,12 +421,27 @@ impl <'a> PluginLoader <'a>{
ZELLIJ_CACHE_DIR.display(),
timer.elapsed(),
);
display_loading_stage!(indicate_loading_plugin_from_hd_cache_success, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_loading_plugin_from_hd_cache_success,
self.loading_indication,
self.senders,
self.plugin_id
);
Ok(module)
}
pub fn compile_module(&mut self) -> Result<Module> {
display_loading_stage!(indicate_loading_plugin_from_hd_cache_notfound, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(indicate_compiling_plugin, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_loading_plugin_from_hd_cache_notfound,
self.loading_indication,
self.senders,
self.plugin_id
);
display_loading_stage!(
indicate_compiling_plugin,
self.loading_indication,
self.senders,
self.plugin_id
);
let (wasm_bytes, cached_path) = self.plugin_bytes_and_cache_path()?;
let timer = std::time::Instant::now();
let err_context = || "failed to recover cache dir";
Expand All @@ -406,8 +464,16 @@ impl <'a> PluginLoader <'a>{
.with_context(err_context)?;
Ok(module)
}
pub fn create_plugin_instance_and_environment(&mut self, module: Module) -> Result<(Instance, PluginEnv)> {
let err_context = || format!("Failed to create instance and plugin env for plugin {}", self.plugin_id);
pub fn create_plugin_instance_and_environment(
&mut self,
module: Module,
) -> Result<(Instance, PluginEnv)> {
let err_context = || {
format!(
"Failed to create instance and plugin env for plugin {}",
self.plugin_id
)
};
let mut wasi_env = WasiState::new("Zellij")
.env("CLICOLOR_FORCE", "1")
.map_dir("/host", ".")
Expand Down Expand Up @@ -439,11 +505,15 @@ impl <'a> PluginLoader <'a>{
};

let zellij = zellij_exports(&self.store, &plugin_env);
let instance = Instance::new(&module, &zellij.chain_back(wasi)).with_context(err_context)?;
let instance =
Instance::new(&module, &zellij.chain_back(wasi)).with_context(err_context)?;
assert_plugin_version(&instance, &plugin_env).with_context(err_context)?;
// Only do an insert when everything went well!
let cloned_plugin = self.plugin.clone();
self.plugin_cache.lock().unwrap().insert(cloned_plugin.path, module);
self.plugin_cache
.lock()
.unwrap()
.insert(cloned_plugin.path, module);
Ok((instance, plugin_env))
}
pub fn load_plugin_instance(
Expand All @@ -454,21 +524,45 @@ impl <'a> PluginLoader <'a>{
let err_context = || format!("failed to load plugin from instance {instance:#?}");
let main_user_instance = instance.clone();
let main_user_env = plugin_env.clone();
display_loading_stage!(indicate_starting_plugin, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_starting_plugin,
self.loading_indication,
self.senders,
self.plugin_id
);
let load_function = instance
.exports
.get_function("_start")
.with_context(err_context)?;
// This eventually calls the `.load()` method
load_function.call(&[]).with_context(err_context)?;
display_loading_stage!(indicate_starting_plugin_success, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(indicate_writing_plugin_to_cache, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_starting_plugin_success,
self.loading_indication,
self.senders,
self.plugin_id
);
display_loading_stage!(
indicate_writing_plugin_to_cache,
self.loading_indication,
self.senders,
self.plugin_id
);
let mut plugin_map = self.plugin_map.lock().unwrap();
plugin_map.insert(
(self.plugin_id, self.client_id),
(main_user_instance, main_user_env, (self.size.rows, self.size.cols)),
(
main_user_instance,
main_user_env,
(self.size.rows, self.size.cols),
),
);
display_loading_stage!(
indicate_writing_plugin_to_cache_success,
self.loading_indication,
self.senders,
self.plugin_id
);
display_loading_stage!(indicate_writing_plugin_to_cache_success, self.loading_indication, self.senders, self.plugin_id);
Ok(())
}
pub fn clone_instance_for_other_clients(
Expand All @@ -478,7 +572,12 @@ impl <'a> PluginLoader <'a>{
connected_clients: &[ClientId],
) -> Result<()> {
if !connected_clients.is_empty() {
display_loading_stage!(indicate_cloning_plugin_for_other_clients, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_cloning_plugin_for_other_clients,
self.loading_indication,
self.senders,
self.plugin_id
);
let mut plugin_map = self.plugin_map.lock().unwrap();
for client_id in connected_clients {
let (instance, new_plugin_env) =
Expand All @@ -488,7 +587,12 @@ impl <'a> PluginLoader <'a>{
(instance, new_plugin_env, (self.size.rows, self.size.cols)),
);
}
display_loading_stage!(indicate_cloning_plugin_for_other_clients_success, self.loading_indication, self.senders, self.plugin_id);
display_loading_stage!(
indicate_cloning_plugin_for_other_clients_success,
self.loading_indication,
self.senders,
self.plugin_id
);
}
Ok(())
}
Expand All @@ -512,7 +616,7 @@ impl <'a> PluginLoader <'a>{
let cached_path = ZELLIJ_CACHE_DIR.join(&hash);
self.wasm_blob_on_hd = Some((wasm_bytes.clone(), cached_path.clone()));
Ok((wasm_bytes, cached_path))
}
},
}
}
}
Expand Down
Loading