8d88ffa14d
Production IHostProcessLauncher (ProcessHostLauncher.cs): Process.Start spawns OtOpcUa.Driver.FOCAS.Host.exe with OTOPCUA_FOCAS_PIPE / OTOPCUA_ALLOWED_SID / OTOPCUA_FOCAS_SECRET / OTOPCUA_FOCAS_BACKEND in the environment (supervisor-owned, never disk), polls FocasIpcClient.ConnectAsync at 250ms cadence until the pipe is up or the Host exits or the ConnectTimeout deadline passes, then wraps the connected client in an IpcFocasClient. TerminateAsync kills the entire process tree + disposes the IPC stream. ProcessHostLauncherOptions carries HostExePath + PipeName + AllowedSid plus optional SharedSecret (auto-generated from a GUID when omitted so install scripts don't have to), Arguments, Backend (fwlib32/fake/unconfigured default-unconfigured), ConnectTimeout (15s), and Series for CNC pre-flight. Post-mortem MMF (Host/Stability/PostMortemMmf.cs + Proxy/Supervisor/PostMortemReader.cs): ring-buffer of the last ~1000 IPC operations written by the Host into a memory-mapped file. On a Host crash the supervisor reads the MMF — which survives process death — to see what was in flight. File format: 16-byte header [magic 'OFPC' (0x4F465043) | version | capacity | writeIndex] + N × 256-byte entries [8-byte UTC unix ms | 8-byte opKind | 240-byte UTF-8 message + null terminator]. Magic distinguishes FOCAS MMFs from the Galaxy MMFs that ship the same format shape. Writer is single-producer (Host) with a lock_writeGate; reader is multi-consumer (Proxy + any diagnostic tool) using a separate MemoryMappedFile handle. NSSM install wrappers (scripts/install/Install-FocasHost.ps1 + Uninstall-FocasHost.ps1): idempotent service registration for OtOpcUaFocasHost. Resolves SID from the ServiceAccount, generates a fresh shared secret per install if not supplied, stages OTOPCUA_FOCAS_PIPE/SID/SECRET/BACKEND in AppEnvironmentExtra so they never hit disk, rotates 10MB stdout/stderr logs under %ProgramData%\OtOpcUa, DependOnService=OtOpcUa so startup order is deterministic. Backend selector defaults to unconfigured so a fresh install doesn't accidentally load a half-configured Fwlib32.dll on first start. Tests (7 new, 2 files): PostMortemMmfTests.cs in FOCAS.Host.Tests — round-trip write+read preserves order + content, ring-buffer wraps at capacity (writes 10 entries to a 3-slot buffer, asserts only op-7/8/9 survive in FIFO order), message truncation at the 240-byte cap is null-terminated + non-overflowing, reopening an existing file preserves entries. PostMortemReaderCompatibilityTests.cs in FOCAS.Tests — hand-writes a file in the exact host format (magic/entry layout) + asserts the Proxy reader decodes with correct ring-walk ordering when writeIndex != 0, empty-return on missing file + magic mismatch. Keeps the two codebases in format-lockstep without the net10 test project referencing the net48 Host assembly. Docs updated: docs/v2/implementation/focas-isolation-plan.md promoted from DRAFT to PRs A-E shipped status with per-PR citations + post-ship test counts (189 + 24 + 13 = 226 FOCAS-family tests green). docs/drivers/FOCAS-Test-Fixture.md §5 updated from "architecture scoped but not implemented" to listing the shipped components with the FwlibHostedBackend gap explicitly labeled as hardware-gated. Install-FocasHost.ps1 documents the OTOPCUA_FOCAS_BACKEND selector + points at docs/v2/focas-deployment.md for Fwlib32.dll licensing. What ISN'T in this PR: (1) the real FwlibHostedBackend implementing IFocasBackend with the P/Invoke — requires either a CNC on the bench or a licensed FANUC developer kit to validate, tracked under #220 as a single follow-up task; (2) Admin /hosts surface integration for FOCAS runtime status — Galaxy Tier-C already has the shape, FOCAS can slot in when someone wires ObservedCrashes/StickyAlertActive/BackoffAttempt to the FleetStatusHub; (3) a full integration test that actually spawns a real FOCAS Host process — ProcessHostLauncher is tested via its contract + the MMF is tested via round-trip, but no test spins up the real exe (the Galaxy Tier-C tests do this, but the FOCAS equivalent adds no new coverage over what's already in place). Total FOCAS-family tests green after this PR: 189 driver + 24 Shared + 13 Host = 226. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
109 lines
4.6 KiB
PowerShell
109 lines
4.6 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Registers the OtOpcUaFocasHost Windows service. Optional companion to
|
|
Install-Services.ps1 — only run this on nodes where FOCAS driver instances will run
|
|
with Tier-C process isolation enabled.
|
|
|
|
.DESCRIPTION
|
|
FOCAS PR #220 / Tier-C isolation plan. Wraps OtOpcUa.Driver.FOCAS.Host.exe (net48 x86)
|
|
as a Windows service using NSSM, running under the same service account as the main
|
|
OtOpcUa service so the named-pipe ACL works. Passes the per-process shared secret via
|
|
environment variable at service-start time so it never hits disk.
|
|
|
|
.PARAMETER InstallRoot
|
|
Where the FOCAS Host binaries live (typically
|
|
C:\Program Files\OtOpcUa\Driver.FOCAS.Host).
|
|
|
|
.PARAMETER ServiceAccount
|
|
Service account SID or DOMAIN\name. Must match the main OtOpcUa server account so the
|
|
PipeAcl match succeeds.
|
|
|
|
.PARAMETER FocasSharedSecret
|
|
Per-process secret passed via env var. Generated freshly per install if not supplied.
|
|
|
|
.PARAMETER FocasBackend
|
|
Backend selector for the Host process. One of:
|
|
fwlib32 (default — real Fanuc Fwlib32.dll integration; requires licensed DLL on PATH)
|
|
fake (in-memory; smoke-test mode)
|
|
unconfigured (safe default returning structured errors; use until hardware is wired)
|
|
|
|
.PARAMETER FocasPipeName
|
|
Pipe name the Host listens on. Default: OtOpcUaFocas.
|
|
|
|
.EXAMPLE
|
|
.\Install-FocasHost.ps1 -InstallRoot 'C:\Program Files\OtOpcUa\Driver.FOCAS.Host' `
|
|
-ServiceAccount 'OTOPCUA\svc-otopcua' -FocasBackend fwlib32
|
|
#>
|
|
[CmdletBinding()]
|
|
param(
|
|
[Parameter(Mandatory)] [string]$InstallRoot,
|
|
[Parameter(Mandatory)] [string]$ServiceAccount,
|
|
[string]$FocasSharedSecret,
|
|
[ValidateSet('fwlib32','fake','unconfigured')] [string]$FocasBackend = 'unconfigured',
|
|
[string]$FocasPipeName = 'OtOpcUaFocas',
|
|
[string]$ServiceName = 'OtOpcUaFocasHost',
|
|
[string]$NssmPath = 'C:\Program Files\nssm\nssm.exe'
|
|
)
|
|
|
|
$ErrorActionPreference = 'Stop'
|
|
|
|
function Resolve-Sid {
|
|
param([string]$Account)
|
|
if ($Account -match '^S-\d-\d+') { return $Account }
|
|
try {
|
|
$nt = New-Object System.Security.Principal.NTAccount($Account)
|
|
return $nt.Translate([System.Security.Principal.SecurityIdentifier]).Value
|
|
} catch {
|
|
throw "Could not resolve '$Account' to a SID. Pass an explicit SID or check the account name."
|
|
}
|
|
}
|
|
|
|
if (-not (Test-Path $NssmPath)) {
|
|
throw "nssm.exe not found at '$NssmPath'. Install NSSM or pass -NssmPath."
|
|
}
|
|
|
|
$hostExe = Join-Path $InstallRoot 'OtOpcUa.Driver.FOCAS.Host.exe'
|
|
if (-not (Test-Path $hostExe)) {
|
|
throw "FOCAS Host binary not found at '$hostExe'. Publish the Driver.FOCAS.Host project first."
|
|
}
|
|
|
|
if (-not $FocasSharedSecret) {
|
|
$FocasSharedSecret = [System.Guid]::NewGuid().ToString('N')
|
|
Write-Host "Generated FocasSharedSecret — store it alongside the OtOpcUa service config."
|
|
}
|
|
|
|
$allowedSid = Resolve-Sid $ServiceAccount
|
|
|
|
# Idempotent install — remove + re-create if present.
|
|
$existing = Get-Service -Name $ServiceName -ErrorAction SilentlyContinue
|
|
if ($existing) {
|
|
Write-Host "Removing existing '$ServiceName' service..."
|
|
& $NssmPath stop $ServiceName confirm | Out-Null
|
|
& $NssmPath remove $ServiceName confirm | Out-Null
|
|
}
|
|
|
|
& $NssmPath install $ServiceName $hostExe | Out-Null
|
|
& $NssmPath set $ServiceName DisplayName 'OT-OPC-UA FOCAS Host (Tier-C isolated Fwlib32)' | Out-Null
|
|
& $NssmPath set $ServiceName Description 'Out-of-process Fwlib32.dll host for OtOpcUa FOCAS driver. Crash-isolated from the main OPC UA server.' | Out-Null
|
|
& $NssmPath set $ServiceName ObjectName $ServiceAccount | Out-Null
|
|
& $NssmPath set $ServiceName Start SERVICE_AUTO_START | Out-Null
|
|
& $NssmPath set $ServiceName AppStdout (Join-Path $env:ProgramData 'OtOpcUa\focas-host-stdout.log') | Out-Null
|
|
& $NssmPath set $ServiceName AppStderr (Join-Path $env:ProgramData 'OtOpcUa\focas-host-stderr.log') | Out-Null
|
|
& $NssmPath set $ServiceName AppRotateFiles 1 | Out-Null
|
|
& $NssmPath set $ServiceName AppRotateBytes 10485760 | Out-Null
|
|
|
|
& $NssmPath set $ServiceName AppEnvironmentExtra `
|
|
"OTOPCUA_FOCAS_PIPE=$FocasPipeName" `
|
|
"OTOPCUA_ALLOWED_SID=$allowedSid" `
|
|
"OTOPCUA_FOCAS_SECRET=$FocasSharedSecret" `
|
|
"OTOPCUA_FOCAS_BACKEND=$FocasBackend" | Out-Null
|
|
|
|
& $NssmPath set $ServiceName DependOnService OtOpcUa | Out-Null
|
|
|
|
Write-Host "Installed '$ServiceName' under '$ServiceAccount' (SID=$allowedSid)."
|
|
Write-Host "Pipe: \\.\pipe\$FocasPipeName Backend: $FocasBackend"
|
|
Write-Host "Start the service with: Start-Service $ServiceName"
|
|
Write-Host ""
|
|
Write-Host "NOTE: the Fwlib32 backend requires the licensed Fwlib32.dll on PATH"
|
|
Write-Host "alongside the Host exe. See docs/v2/focas-deployment.md."
|