<# .SYNOPSIS Captures the native AVEVA client's GetRuntimeParameter wire traffic (HCAL roadmap R1.2) so the WCF op name, handle type (uint vs the string-handle wall), and the btRequest/btResponse buffer format can be decoded instead of guessed. .DESCRIPTION Drives the .NET-Framework NativeTraceHarness's `runtime-param` scenario against the live Historian with an IL-rewritten copy of aahClientManaged.dll whose ClientMessageEncoder.WriteMessage AND ReadMessage are instrumented to log every MDAS body (the same pipeline that produced every other proven request/response shape). The harness opens a normal authenticated process connection and calls HistorianAccess.GetRuntimeParameter(List names, out List results, out err). Decode with scripts/decode-runtime-param-capture.py: locate the WCF.WriteMessage.Body whose op carries the parameter name(s) -> that is the GetRuntimeParameter request; read off the SOAP action / op name, the leading handle param, and the btRequest layout. The paired WCF.ReadMessage.Body is the btResponse (the CRetVariant value list). .NOTES Read-only status call; no data is written. Artifacts are diagnostic and gitignored. Sanitize before copying anything into docs/ -- never commit raw capture NDJSON, credentials, hostnames, or customer tag names. #> [CmdletBinding()] param( [string]$ServerName = "localhost", [int]$TcpPort = 32568, # Semicolon-separated runtime parameter names. HistorianVersion is a known-good name # (returns the server version string) so the response decode has a real value. [string]$Names = "HistorianVersion", [string]$Configuration = "Debug" ) $ErrorActionPreference = "Stop" $repoRoot = Split-Path -Parent $PSScriptRoot Set-Location $repoRoot $reProj = Join-Path $repoRoot "tools\AVEVA.Historian.ReverseEngineering\AVEVA.Historian.ReverseEngineering.csproj" $harnessProj = Join-Path $repoRoot "tools\AVEVA.Historian.NativeTraceHarness\AVEVA.Historian.NativeTraceHarness.csproj" $instrProj = Join-Path $repoRoot "tools\AVEVA.Historian.ReverseInstrumentation\AVEVA.Historian.ReverseInstrumentation.csproj" $captureDir = Join-Path $repoRoot "artifacts\reverse-engineering\instrumented-wcf-runtime-param" $currentCopy = Join-Path $captureDir "current-copy" $instrDll = Join-Path $captureDir "aahClientManaged.dll" $capturePath = Join-Path $captureDir "runtime-param-capture-latest.ndjson" Write-Host "== Building tooling ($Configuration) ==" -ForegroundColor Cyan dotnet build $reProj -c $Configuration --nologo -v q | Out-Null dotnet build $instrProj -c $Configuration --nologo -v q | Out-Null dotnet build $harnessProj -c $Configuration --nologo -v q | Out-Null $instrSourceDll = Get-ChildItem -Recurse (Join-Path $repoRoot "tools\AVEVA.Historian.ReverseInstrumentation\bin\$Configuration") ` -Filter "AVEVA.Historian.ReverseInstrumentation.dll" | Select-Object -First 1 -ExpandProperty FullName if (-not $instrSourceDll) { throw "ReverseInstrumentation.dll not found under bin\$Configuration." } Write-Host "== Instrumenting WriteMessage + ReadMessage ==" -ForegroundColor Cyan New-Item -ItemType Directory -Force -Path $captureDir | Out-Null # Chain via a distinct intermediate file (reading+writing the same path drops the second # hook on the mixed-mode native image). Final dll carries both hooks with distinct Phase # strings: WCF.WriteMessage.Body and WCF.ReadMessage.Body. $writeOnly = Join-Path $captureDir "aahClientManaged.write.dll" dotnet run --no-build -c $Configuration --project $reProj -- ` instrument-wcf-writemessage (Join-Path $repoRoot "current\aahClientManaged.dll") $writeOnly | Out-Null dotnet run --no-build -c $Configuration --project $reProj -- ` instrument-wcf-readmessage $writeOnly $instrDll | Out-Null Write-Host "== Staging current-copy ==" -ForegroundColor Cyan robocopy (Join-Path $repoRoot "current") $currentCopy /MIR /NJH /NJS /NDL /NP /NC /NS | Out-Null Copy-Item -Force $instrDll (Join-Path $currentCopy "aahClientManaged.dll") Copy-Item -Force $instrSourceDll (Join-Path $currentCopy "AVEVA.Historian.ReverseInstrumentation.dll") $harnessDll = Join-Path $currentCopy "aahClientManaged.dll" if (Test-Path $capturePath) { Remove-Item -Force $capturePath } $env:AVEVA_HISTORIAN_RE_CAPTURE = $capturePath Write-Host "== Capturing runtime-param ==" -ForegroundColor Green $harnessArgs = @( "--scenario", "runtime-param", "--server-name", $ServerName, "--tcp-port", "$TcpPort", "--runtime-param-names", $Names, "--current-dir", $currentCopy, "--managed-dll-path", $harnessDll ) $harnessJson = $null try { $prevEap = $ErrorActionPreference $ErrorActionPreference = "Continue" $harnessJson = & dotnet run --no-build -c $Configuration --project $harnessProj -- @harnessArgs 2>&1 } catch { Write-Host " (runtime-param raised: $($_.Exception.Message))" -ForegroundColor Yellow } finally { $ErrorActionPreference = $prevEap } Remove-Item Env:\AVEVA_HISTORIAN_RE_CAPTURE -ErrorAction SilentlyContinue $recCount = if (Test-Path $capturePath) { (Get-Content $capturePath | Where-Object { $_.Trim() }).Count } else { 0 } Write-Host "`n== Capture summary ==" -ForegroundColor Cyan Write-Host " -> $recCount records -> $capturePath" Write-Host "Harness output (GetRuntimeParameterReturned / Results):" -ForegroundColor Cyan $harnessJson | Select-Object -Last 20 Write-Host "`nDecode with: python scripts\decode-runtime-param-capture.py" -ForegroundColor Cyan