Files
hakorune/src/runtime/plugin_loader_v2/enabled/ffi_bridge.rs
nyash-codex 6ecd8f7f52 feat(runtime): Phase 103 CoreServices Optional化 - Memory Constraints対応
- Add CoreServicesConfig struct (from_env, minimal, all_enabled)
- Implement with_core_from_registry_optional() for selective initialization
- Update CoreBoxesImpl fields to Option<Arc<dyn XyzService>>
- Maintain backward compatibility (with_core_from_registry calls all_enabled)
- Add NYASH_CORE_DISABLE_* environment variable support
- ConsoleBox remains mandatory (Graceful Degradation principle)
- Add unit tests for optional initialization
- Update console_println! macro to handle Option type
- Fix direct console.println() calls in vm.rs and selfhost.rs
- Create core_optional_design.md documentation

Note: Phase 104 will extend ConsoleService to be optional as well with
graceful fallback in console_println! macro.

Files modified:
- src/runtime/plugin_host.rs (CoreServicesConfig, with_core_from_registry_optional, tests)
- src/runtime/core_services.rs (CoreBoxesImpl fields → Option type)
- src/runtime/mod.rs (console_println! macro updated)
- src/runner/modes/vm.rs (handle Option console)
- src/runner/selfhost.rs (handle Option console)
- docs/development/current/main/core_optional_design.md (new)
- docs/development/current/main/ring0-inventory.md (Phase 103 entry)

Test results:
- Build:  Success (0 errors, 7 warnings)
- Unit tests:  3/3 passed (optional_core_tests)
- Runtime tests:  63/63 passed
- Smoke tests:  30/31 passed (1 pre-existing timeout)
2025-12-03 13:59:06 +09:00

305 lines
12 KiB
Rust

//! FFI bridge for plugin method invocation and TLV encoding/decoding
use crate::bid::{BidError, BidResult};
use crate::box_trait::NyashBox;
use crate::runtime::plugin_loader_v2::enabled::PluginLoaderV2;
use crate::runtime::get_global_ring0;
use std::env;
use std::sync::Arc;
fn dbg_on() -> bool {
std::env::var("PLUGIN_DEBUG").is_ok()
}
impl PluginLoaderV2 {
/// Invoke a method on a plugin instance with TLV encoding/decoding
pub fn invoke_instance_method(
&self,
box_type: &str,
method_name: &str,
instance_id: u32,
args: &[Box<dyn NyashBox>],
) -> BidResult<Option<Box<dyn NyashBox>>> {
// Resolve (lib_name, type_id) either from config or cached specs
let (lib_name, type_id) = resolve_type_info(self, box_type)?;
// Resolve method id via config or TypeBox resolve()
let method_id = match self.resolve_method_id(box_type, method_name) {
Ok(mid) => mid,
Err(e) => {
if dbg_on() {
get_global_ring0().log.debug(&format!(
"[PluginLoaderV2] ERR: method resolve failed for {}.{}: {:?}",
box_type, method_name, e
));
}
return Err(BidError::InvalidMethod);
}
};
// Get plugin handle
let plugins = self.plugins.read().map_err(|_| BidError::PluginError)?;
let _plugin = plugins.get(&lib_name).ok_or(BidError::PluginError)?;
// Optional C wrapper (Phase 22.2: design insertion point; default OFF)
if env::var("HAKO_PLUGIN_LOADER_C_WRAP").ok().as_deref() == Some("1") {
if should_trace_cwrap(box_type, method_name) {
get_global_ring0()
.log
.debug(&format!("[cwrap:invoke:{}.{}]", box_type, method_name));
}
// Future: route into a thin C shim here. For now, fall through to normal path.
}
// Optional C-core probe (design): emit tag and optionally call into c-core when enabled
if env::var("HAKO_C_CORE_ENABLE").ok().as_deref() == Some("1")
&& should_route_ccore(box_type, method_name)
{
get_global_ring0()
.log
.debug(&format!("[c-core:invoke:{}.{}]", box_type, method_name));
#[cfg(feature = "c-core")]
{
// MapBox.set: call C-core stub (no-op) with available info
if box_type == "MapBox" && method_name == "set" {
let key = args
.get(0)
.map(|b| b.to_string_box().value)
.unwrap_or_default();
let val = args
.get(1)
.map(|b| b.to_string_box().value)
.unwrap_or_default();
let _ = nyash_c_core::core_map_set(type_id as i32, instance_id, &key, &val);
} else if box_type == "ArrayBox" && method_name == "push" {
// For design stage, pass 0 (we don't rely on c-core result)
let _ = nyash_c_core::core_array_push(type_id as i32, instance_id, 0);
} else if box_type == "ArrayBox" && method_name == "get" {
let _ = nyash_c_core::core_array_get(type_id as i32, instance_id, 0);
} else if box_type == "ArrayBox"
&& (method_name == "size" || method_name == "len" || method_name == "length")
{
let _ = nyash_c_core::core_array_len(type_id as i32, instance_id);
} else {
// Generic probe
let _ =
nyash_c_core::core_probe_invoke(box_type, method_name, args.len() as i32);
}
}
}
// Encode TLV args via shared helper (numeric→string→toString)
let tlv = crate::runtime::plugin_ffi_common::encode_args(args);
// Unified call trace (optional): plugin calls
if env::var("HAKO_CALL_TRACE").ok().as_deref() == Some("1") {
if should_trace_call(box_type, method_name) {
get_global_ring0()
.log
.debug(&format!("[call:{}.{}]", box_type, method_name));
}
}
// Optional trace for TLV shim path (debug only; default OFF)
if env::var("HAKO_TLV_SHIM_TRACE").ok().as_deref() == Some("1")
&& env::var("HAKO_TLV_SHIM").ok().as_deref() == Some("1")
{
if should_trace_tlv_shim(box_type, method_name) {
get_global_ring0()
.log
.debug(&format!("[tlv/shim:{}.{}]", box_type, method_name));
if env::var("HAKO_TLV_SHIM_TRACE_DETAIL").ok().as_deref() == Some("1") {
get_global_ring0()
.log
.debug(&format!("[tlv/shim:detail argc={}]", args.len()));
}
}
}
if dbg_on() {
get_global_ring0().log.debug(&format!(
"[PluginLoaderV2] call {}.{}: type_id={} method_id={} instance_id={}",
box_type, method_name, type_id, method_id, instance_id
));
}
let (_code, out_len, out) = super::host_bridge::invoke_alloc(
super::super::nyash_plugin_invoke_v2_shim,
type_id,
method_id,
instance_id,
&tlv,
);
// Decode TLV (first entry) generically
decode_tlv_result(box_type, &out[..out_len])
}
}
fn should_trace_tlv_shim(box_type: &str, method: &str) -> bool {
// Filter provided → honor it
if let Ok(flt) = env::var("HAKO_TLV_SHIM_FILTER") {
let key = format!("{}.{}", box_type, method);
for pat in flt.split(',') {
let p = pat.trim();
if p.is_empty() {
continue;
}
if p == method || p == key {
return true;
}
}
return false;
}
// Default (minimal noise): only trace MapBox.set to begin with
box_type == "MapBox" && method == "set"
}
fn should_trace_cwrap(box_type: &str, method: &str) -> bool {
// Filter provided → honor it
if let Ok(flt) = env::var("HAKO_PLUGIN_LOADER_C_WRAP_FILTER") {
let key = format!("{}.{}", box_type, method);
for pat in flt.split(',') {
let p = pat.trim();
if p.is_empty() {
continue;
}
if p == method || p == key {
return true;
}
}
return false;
}
// Default (minimal noise): only trace MapBox.set to begin with
box_type == "MapBox" && method == "set"
}
fn should_trace_call(target: &str, method: &str) -> bool {
if let Ok(flt) = env::var("HAKO_CALL_TRACE_FILTER") {
let key = format!("{}.{}", target, method);
for pat in flt.split(',') {
let p = pat.trim();
if p.is_empty() {
continue;
}
if p == method || p == key {
return true;
}
}
return false;
}
true
}
fn should_route_ccore(box_type: &str, method: &str) -> bool {
if let Ok(flt) = env::var("HAKO_C_CORE_TARGETS") {
let key = format!("{}.{}", box_type, method);
for pat in flt.split(',') {
let p = pat.trim();
if p.is_empty() {
continue;
}
if p == method || p == key {
return true;
}
}
return false;
}
// Default minimal scope: MapBox.set only
box_type == "MapBox" && method == "set"
}
/// Resolve type information for a box
fn resolve_type_info(loader: &PluginLoaderV2, box_type: &str) -> BidResult<(String, u32)> {
if let Some(cfg) = loader.config.as_ref() {
let cfg_path = loader.config_path.as_deref().unwrap_or("nyash.toml");
let toml_value: toml::Value =
toml::from_str(&std::fs::read_to_string(cfg_path).map_err(|_| BidError::PluginError)?)
.map_err(|_| BidError::PluginError)?;
if let Some((lib_name, _)) = cfg.find_library_for_box(box_type) {
if let Some(bc) = cfg.get_box_config(lib_name, box_type, &toml_value) {
return Ok((lib_name.to_string(), bc.type_id));
} else {
let key = (lib_name.to_string(), box_type.to_string());
let map = loader.box_specs.read().map_err(|_| BidError::PluginError)?;
let tid = map
.get(&key)
.and_then(|s| s.type_id)
.ok_or(BidError::InvalidType)?;
return Ok((lib_name.to_string(), tid));
}
}
} else {
let map = loader.box_specs.read().map_err(|_| BidError::PluginError)?;
if let Some(((lib, _), spec)) = map.iter().find(|((_, bt), _)| bt == box_type) {
return Ok((lib.clone(), spec.type_id.ok_or(BidError::InvalidType)?));
}
}
Err(BidError::InvalidType)
}
/// Decode TLV result into a NyashBox
fn decode_tlv_result(box_type: &str, data: &[u8]) -> BidResult<Option<Box<dyn NyashBox>>> {
if let Some((tag, _sz, payload)) = crate::runtime::plugin_ffi_common::decode::tlv_first(data) {
let bx: Box<dyn NyashBox> = match tag {
1 => Box::new(crate::box_trait::BoolBox::new(
crate::runtime::plugin_ffi_common::decode::bool(payload).unwrap_or(false),
)),
2 => Box::new(crate::box_trait::IntegerBox::new(
crate::runtime::plugin_ffi_common::decode::i32(payload).unwrap_or(0) as i64,
)),
3 => {
// i64 payload
if payload.len() == 8 {
let mut b = [0u8; 8];
b.copy_from_slice(payload);
Box::new(crate::box_trait::IntegerBox::new(i64::from_le_bytes(b)))
} else {
Box::new(crate::box_trait::IntegerBox::new(0))
}
}
5 => {
let x = crate::runtime::plugin_ffi_common::decode::f64(payload).unwrap_or(0.0);
Box::new(crate::boxes::FloatBox::new(x))
}
6 | 7 => {
let s = crate::runtime::plugin_ffi_common::decode::string(payload);
Box::new(crate::box_trait::StringBox::new(s))
}
8 => {
// Plugin handle (type_id, instance_id) → wrap into PluginBoxV2
if let Some((ret_type, inst)) =
crate::runtime::plugin_ffi_common::decode::plugin_handle(payload)
{
let handle = Arc::new(super::types::PluginHandleInner {
type_id: ret_type,
invoke_fn: super::super::nyash_plugin_invoke_v2_shim,
instance_id: inst,
fini_method_id: None,
finalized: std::sync::atomic::AtomicBool::new(false),
});
Box::new(super::types::PluginBoxV2 {
box_type: box_type.to_string(),
inner: handle,
})
} else {
Box::new(crate::box_trait::VoidBox::new())
}
}
9 => {
// Host handle (u64) → try to map back to BoxRef, else void
if let Some(u) = crate::runtime::plugin_ffi_common::decode::u64(payload) {
if let Some(arc) = crate::runtime::host_handles::get(u) {
return Ok(Some(arc.share_box()));
}
}
Box::new(crate::box_trait::VoidBox::new())
}
_ => Box::new(crate::box_trait::VoidBox::new()),
};
return Ok(Some(bx));
}
Ok(Some(Box::new(crate::box_trait::VoidBox::new())))
}