@tsplc/build 0.0.0-stage → 0.2.0

package/docker/install/extract.py

@@ -0,0 +1,43 @@
+"""Extract the 3.5.22.30 InstallShield payload (adapted from the Mac guide)."""
+import ctypes
+import mmap
+from pathlib import Path
+import struct
+import sys
+import zlib
+
+library = ctypes.CDLL(str(Path(__file__).with_name("decode.so")))
+library.decode.argtypes = [ctypes.c_void_p, ctypes.c_size_t, ctypes.c_char_p, ctypes.c_size_t]
+output = Path(sys.argv[2]).resolve()
+output.mkdir(parents=True, exist_ok=True)
+with open(sys.argv[1], "rb") as installer:
+    with mmap.mmap(installer.fileno(), 0, access=mmap.ACCESS_READ) as data:
+        position = data.find(b"ISSetupStream\0", 1300000)
+        if position < 0:
+            raise ValueError("Not the supported CODESYS 64 3.5.22.30 installer")
+        count, archive_type = struct.unpack_from("<HI", data, position + 14)
+        position += 46
+        for _ in range(count):
+            name_length, flags, length, compressed = struct.unpack_from("<II2xI8xH", data, position)
+            position += 48 if archive_type == 4 else 24
+            name = data[position:position + name_length].decode("utf-16le").rstrip("\0")
+            position += name_length
+            target = output / name.replace("\\", "/")
+            if not target.resolve().is_relative_to(output) or position + length > len(data):
+                raise ValueError("Invalid installer archive entry")
+            target.parent.mkdir(parents=True, exist_ok=True)
+            key = bytes(c ^ b"\x13\x35\x86\x07"[i % 4] for i, c in enumerate(name.encode()))
+            print(name, flush=True)
+            decompressor = zlib.decompressobj() if compressed else None
+            with target.open("wb") as destination:
+                for offset in range(0, length, 1048576):
+                    block = ctypes.create_string_buffer(data[position + offset:position + min(offset + 1048576, length)])
+                    size = len(block) - 1
+                    if flags & 4:
+                        library.decode(block, size, key, len(key))
+                    destination.write(decompressor.decompress(block.raw[:size]) if decompressor else block.raw[:size])
+                if decompressor:
+                    destination.write(decompressor.flush())
+                    if not decompressor.eof:
+                        raise ValueError("Incomplete compressed installer entry")
+            position += length

package/docker/install/helper-launcher.c

@@ -0,0 +1,46 @@
+#include <windows.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <wchar.h>
+
+/* Adapt the legacy package-manager protocol to the bundled metadata helper.
+   APPDOMAIN_MANAGER_* belongs to the old reflection helper, not helper 2. */
+int wmain(int argc, wchar_t **argv) {
+    if (argc == 2 && !wcscmp(argv[1], L"-getAppDomainManagerAssembly")) {
+        fputs("Utilities, Version=3.5.22.30, Culture=neutral, PublicKeyToken=83380e73b2486719", stdout);
+        return 0;
+    }
+    if (argc == 2 && !wcscmp(argv[1], L"-getAppDomainManagerType")) {
+        fputs("_3S.CoDeSys.Utilities.InstallerAppDomainManager", stdout);
+        return 0;
+    }
+    wchar_t path[32768];
+    DWORD length = GetModuleFileNameW(NULL, path, 32768);
+    if (!length || length >= 32768) return 1;
+    wchar_t *name = wcsrchr(path, L'\\');
+    if (!name || name - path + 27 >= 32768) return 1;
+    wcscpy(name + 1, L"CoreInstallerSupport2.exe");
+    const wchar_t *args = GetCommandLineW();
+    if (*args == L'"') { args++; while (*args && *args != L'"') args++; if (*args) args++; }
+    else while (*args && *args != L' ' && *args != L'\t') args++;
+    size_t size = wcslen(path) + wcslen(args) + 4;
+    wchar_t *command = calloc(size, sizeof(wchar_t));
+    if (!command) return 1;
+    swprintf(command, size, L"\"%ls\"%ls", path, args);
+    SetEnvironmentVariableW(L"APPDOMAIN_MANAGER_ASM", NULL);
+    SetEnvironmentVariableW(L"APPDOMAIN_MANAGER_TYPE", NULL);
+    STARTUPINFOW startup = { .cb = sizeof(startup) };
+    PROCESS_INFORMATION process;
+    if (!CreateProcessW(path, command, NULL, NULL, TRUE, 0, NULL, NULL, &startup, &process)) {
+        fwprintf(stderr, L"Cannot start CODESYS metadata helper: Windows error %lu\n", GetLastError());
+        free(command);
+        return 1;
+    }
+    free(command);
+    CloseHandle(process.hThread);
+    DWORD result = 1;
+    if (WaitForSingleObject(process.hProcess, INFINITE) == WAIT_OBJECT_0)
+        GetExitCodeProcess(process.hProcess, &result);
+    CloseHandle(process.hProcess);
+    return (int)result;
+}

package/docker/install/install.sh

@@ -0,0 +1,94 @@
+#!/bin/sh
+set -eu
+# Keep fatal Windows exceptions visible without enabling routine Wine traces.
+export WINEDEBUG=-all,err+seh
+work=/tmp/codesys-setup
+msi="$work/CODESYS 64 3.5.22.30.msi"
+test -f "$msi"
+# Use the same CLR configuration for installation and the verified compiler.
+python3 - "$WINEPREFIX/drive_c/CODESYS-3.5.22.30/CODESYS/Common" <<'PY'
+import pathlib, sys
+for name in ("CODESYS.exe", "PackageManagerCLI.exe", "CoreInstallerSupport2.exe"):
+    path = pathlib.Path(sys.argv[1]) / (name + ".config")
+    text = path.read_text(encoding="utf-8-sig")
+    if "<runtime>" not in text:
+        raise ValueError("Missing CLR runtime configuration: " + name)
+    path.write_text(text.replace("<runtime>", '<runtime><gcConcurrent enabled="false" />', 1))
+PY
+mkdir "$work/streams"
+(cd "$work/streams" && msiinfo export "$msi" ISSetupFile > "$work/setup-files.tsv")
+python3 - "$msi" "$work/setup-files.tsv" "$WINEPREFIX/drive_c" <<'PY'
+import csv, pathlib, subprocess, sys, zipfile
+msi, table, output = sys.argv[1:]
+packages = {
+    r"Packages\CODESYS Scripting 4.2.0.0.package": "scripting.package",
+    r"Packages\CODESYS RISC Front End 4.0.2.0.package": "risc.package",
+    r"Packages\CODESYS Code Generator ARM64 4.0.1.0.package": "arm64.package",
+    r"Packages\CODESYS Library Dependency Inspection 1.1.0.0.package": "library-inspection.package",
+    r"Packages\CODESYS Base Libraries 4.0.1.0.package": "base-libraries.package",
+    r"Packages\CODESYS Visualization Support 4.7.0.0.package": "visualization-support.package",
+    r"Packages\CODESYS Math Libraries 4.0.0.0.package": "math-libraries.package",
+    r"Packages\CODESYS Recipes 4.7.0.0.package": "recipes.package",
+    r"Packages\CODESYS Trace 4.4.0.0.package": "trace.package",
+    r"Packages\CODESYS Visualization 4.10.0.0.package": "visualization.package",
+    r"Packages\CODESYS Communication 4.8.0.0.package": "communication.package",
+    r"Packages\CODESYS Ethernet Adapter 4.2.0.0.package": "ethernet-adapter.package",
+    r"Packages\CODESYS EDS Import 4.3.0.0.package": "eds-import.package",
+    r"Packages\CODESYS NetX 4.1.0.0.package": "netx.package",
+    r"Packages\CODESYS EtherNetIP 4.9.1.0.package": "ethernetip.package",
+    r"Packages\CODESYS SoftMotion 4.20.2.0.package": "softmotion.package",
+    r"Packages\CODESYS Modbus 4.6.0.0.package": "modbus.package",
+}
+with open(table, newline="") as source:
+    for row in csv.DictReader(source, delimiter="\t"):
+        name = row["FileName"]
+        if name in packages:
+            target = pathlib.Path(output) / packages.pop(name)
+            with target.open("wb") as destination:
+                subprocess.run(["msiinfo", "extract", msi, row["Stream"]], stdout=destination, check=True)
+            with zipfile.ZipFile(target) as package:
+                if package.testzip() is not None:
+                    raise ValueError("Corrupt package: " + name)
+            print("Extracted " + name, flush=True)
+if packages:
+    raise ValueError("Missing bundled packages: " + ", ".join(packages))
+PY
+printf '%s\r\n' '@echo off' 'cd /d C:\CODESYS-3.5.22.30\CODESYS\Common' \
+    'set "packageComponents="' \
+    'if "%~1"=="visualization" set "packageComponents=--components=2;3;4"' \
+    'PackageManagerCLI.exe --profile="CODESYS V3.5 SP22 Patch 3" --install="C:\%~1.package" %packageComponents% --noConsole --verbose --cancelOnException --logFile="C:\package-install.log"' \
+    'set "packageStatus=%errorlevel%"' \
+    'if not "%packageStatus%"=="0" echo PackageManagerCLI Windows exit status: %packageStatus%' \
+    'exit /b %packageStatus%' > "$WINEPREFIX/drive_c/install-package.cmd"
+# Symbol publishing also resolves AlarmManager and VisuShared. Visualization
+# supplies those libraries and requires Communication to be installed first.
+# Its official component IDs select Libraries, Visualization Profiles and License;
+# the PlugIns component creates Windows shortcuts unsupported by Wine.
+# Generated device trees need the Ethernet adapter, EDS converter and EtherNet/IP
+# scanner; EtherNet/IP references NetX, which must be installed before it.
+# Control for Linux SL requires SoftMotion's SM3_Basic and SM3_CNC libraries.
+# Generated Modbus channels need the Modbus TCP devices and their editor plugin.
+for package in scripting risc arm64 library-inspection base-libraries visualization-support math-libraries recipes trace communication visualization ethernet-adapter eds-import netx ethernetip softmotion modbus; do
+    if timeout --foreground 15m script -q -e -c "wine cmd /d /c 'C:\\install-package.cmd' '$package'" /dev/null; then
+        echo "Installed $package package"
+    else
+        status=$?
+        echo "Package $package installer exited with status $status"
+        python3 - "$WINEPREFIX/drive_c/package-install.log" <<'PY' || true
+import pathlib, sys
+path = pathlib.Path(sys.argv[1])
+try:
+    if path.exists():
+        data = path.read_bytes()
+        text = data.decode('utf-16', errors='replace') if data.startswith(b'\xff\xfe') else data.decode(errors='replace')
+        print(text[-24000:])
+except OSError as error:
+    print('Could not read package install log: ' + str(error), file=sys.stderr)
+PY
+        exit "$status"
+    fi
+done
+wineserver -k
+wineserver -w
+rm -rf "$work" "$WINEPREFIX/drive_c/scripting.package" "$WINEPREFIX/drive_c/users/builder/Temp/"*
+chmod -R a+rX "$WINEPREFIX"

package/docker/install/prerequisites.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+set -eu
+timeout --foreground 3m env WINEDLLOVERRIDES='mscoree,mshtml=' wine wineboot -u
+timeout --foreground 40m winetricks -q dotnet48 vcrun2022 msxml6 win10
+for exe in CODESYS.exe PackageManagerCLI.exe IPMCLI.exe PackageManager.exe \
+    LACUtil.exe ImportLibraryProfile.exe CoreInstallerSupport.exe CoreInstallerSupport2.exe \
+    DeletePlugInCache.exe RepairMenuConfig.exe Dependencies.exe PackageManagerSelfUpdater.exe \
+    VisualStylesEditor.exe Html5ControlEditor.exe; do
+    wine reg add "HKCU\\Software\\Wine\\AppDefaults\\$exe\\DllOverrides" /v '*security' /t REG_SZ /d native /f
+done
+wine regsvr32 /s oleaut32.dll
+wine 'C:\windows\syswow64\regsvr32.exe' /s oleaut32.dll
+wine reg add 'HKCU\Software\Microsoft\Avalon.Graphics' /v DisableHWAcceleration /t REG_DWORD /d 1 /f
+wineserver -k
+wineserver -w

package/docker/install/verify.py

@@ -0,0 +1,133 @@
+"""Verify the installed compiler and its symbol-publishing dependencies offline."""
+from __future__ import print_function
+
+import io
+import re
+
+try:
+    unicode
+except NameError:
+    unicode = str
+
+
+def fail_on_errors(engine):
+    errors = []
+    for category in engine.system.get_message_categories():
+        messages = engine.system.get_message_objects(
+            category, engine.Severity.Error | engine.Severity.FatalError,
+        )
+        for message in messages:
+            project = getattr(message, 'project', None)
+            location = unicode(project.path) if project is not None else unicode(category)
+            errors.append(location + ': ' + unicode(message.text))
+    if errors:
+        raise RuntimeError('CODESYS installation verification failed:\n' + '\n'.join(errors))
+
+
+# Controllers a build can target: the bundled ARM64 description for the local
+# Virtual Control, and Control for Linux SL from its official package. Linux SL
+# skips the reopen check: its SoftMotion libraries carry visualization templates
+# whose System_VisuElem* placeholders resolve only through a project's
+# visualization profile, which scripting cannot give a new project. Its compile
+# and boot application still prove the device, code generator and libraries.
+CONTROLLERS = (
+    (r'C:\codesys-device', 'codesys-verification', 4096, '0000 1008', '4.22.0.0', True),
+    (r'C:\codesys-device-linux-sl', 'codesys-verification-linux-sl', 4102, '0000 0005', '4.22.0.0', False),
+)
+
+
+def uses_byte_addressing(description):
+    """CODESYS numbers %IW and %ID by element unless the device sets this target setting."""
+    return re.search(
+        r'name="byte-addressing"[^>]*>\s*<(?:\w+:)?value>\s*true\s*<', description, re.IGNORECASE,
+    ) is not None
+
+
+def verify_controller(engine, stem, kind, identifier, version, reopen):
+    from System import Guid
+
+    path = 'C:\\' + stem + '.project'
+    project = engine.projects.create(path, primary=True)
+    try:
+        project.add('Device', kind, identifier, version)
+        application = project.active_application
+        if application is None:
+            raise RuntimeError('Verification device did not create an Application')
+        program = application.create_program('PLC_PRG')
+        program.textual_declaration.replace(
+            "PROGRAM PLC_PRG\nVAR\n"
+            "    {attribute 'symbol' := 'readwrite'}\n"
+            "    Counter : UDINT;\nEND_VAR\n"
+        )
+        program.textual_implementation.replace('Counter := Counter + 1;\n')
+        task = application.create_task_configuration().create_task('MainTask')
+        task.kind_of_task = engine.KindOfTask.Cyclic
+        task.priority = '1'
+        task.interval_unit = 'ms'
+        task.interval = '20'
+        task.pous.add('PLC_PRG')
+        application.create_symbol_config(
+            True, True, Guid('{0141eb75-141b-4ea1-9a8c-75f952b22a6c}'),
+        )
+        project.save()
+        for category in engine.system.get_message_categories():
+            engine.system.clear_messages(category)
+        application.clean()
+        application.rebuild()
+        fail_on_errors(engine)
+        application.generate_code()
+        fail_on_errors(engine)
+        application.create_boot_application('C:\\' + stem + '.app', True, False)
+        fail_on_errors(engine)
+        project.save()
+        project.close()
+        project = None
+        if not reopen:
+            return
+
+        # Compilation can succeed before missing transitive libraries are
+        # reported. Reopening exercises library resolution on the saved project.
+        project = engine.projects.open(path, primary=True)
+        project.active_application.get_library_manager().get_libraries(recursive=True)
+        engine.system.delay(1000)
+        fail_on_errors(engine)
+    finally:
+        if project is not None:
+            project.close()
+
+
+def verify(engine):
+    engine.system.script_prompt_handling = engine.ScriptPromptHandling.LogPrompts
+    for directory, _, _, _, _, _ in CONTROLLERS:
+        path = directory + r'\codesyscontrol.devdesc.xml'
+        with io.open(path, encoding='utf-8-sig') as description:
+            # tsPLC places and checks numeric I/O assuming element addressing.
+            if uses_byte_addressing(description.read()):
+                raise RuntimeError(path + ' sets byte-addressing; tsPLC supports element addressing only')
+        engine.device_repository.import_device(
+            path=path,
+            source=engine.device_repository.sources[0],
+            save_device_cache=True,
+        )
+    for _, stem, kind, identifier, version, reopen in CONTROLLERS:
+        verify_controller(engine, stem, kind, identifier, version, reopen)
+    # Generated device trees place these descriptions under the controller.
+    repository = engine.device_repository
+    for kind, identifier, version in ((110, '0000 0002', '4.2.0.0'), (100, '0000 100B', '4.9.0.0')):
+        if repository.get_device(repository.create_device_identification(kind, identifier, version)) is None:
+            raise RuntimeError('Missing EtherNet/IP device description {0} {1}'.format(kind, identifier))
+    print('CODESYS ARM64 and Linux SL compilation and symbol publishing, ARM64 project reopen: PASS')
+
+
+if __name__ == '__main__':
+    import ctypes
+    import scriptengine
+    import traceback
+
+    native_exit = ctypes.windll.kernel32.ExitProcess
+    try:
+        verify(scriptengine)
+    except Exception:
+        traceback.print_exc()
+        native_exit(1)
+    native_exit(0)

package/docker/install/verify.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+set -eu
+# Verify with the AMD64 Wine/CLR used by the compiler, after setup's FEX stage.
+export WINEDEBUG=-all,err+seh
+# Require fresh artifacts from this invocation, including on reused prefixes.
+rm -f "$WINEPREFIX/drive_c/codesys-verification.project" \
+    "$WINEPREFIX/drive_c/codesys-verification.app" \
+    "$WINEPREFIX/drive_c/codesys-verification.crc"
+printf '%s\r\n' '@echo off' 'cd /d C:\CODESYS-3.5.22.30\CODESYS\Common' \
+    'CODESYS.exe --profile="CODESYS V3.5 SP22 Patch 3" --noUI --textPrompts --runscript="C:\verify.py"' \
+    'exit /b %errorlevel%' > "$WINEPREFIX/drive_c/verify.cmd"
+transcript="$WINEPREFIX/drive_c/codesys-verification.log"
+if timeout --foreground 15m script -q -e -c "wine cmd /d /c 'C:\\verify.cmd'" "$transcript"; then
+    :
+else
+    status=$?
+    echo "CODESYS verification exited with status $status; transcript: $transcript" >&2
+    exit "$status"
+fi
+# A Wine helper can assert while the main compiler still returns zero.
+python3 - "$transcript" <<'PY'
+import pathlib, re, sys
+path = pathlib.Path(sys.argv[1])
+text = path.read_bytes().decode(errors='replace')
+text = re.sub(r'\x1b\[[0-?]*[ -/]*[@-~]', '', text).replace('\r', '')
+assertion = re.search(r'^assertion failed \[[^\n]+\]:[^\n]*\n[ \t]*\(ThreadContext[^\n]*\)', text, re.M)
+if assertion:
+    raise SystemExit('Wine translation aborted: ' + ' '.join(assertion.group().split()) + '. See ' + str(path))
+PY
+test -s "$WINEPREFIX/drive_c/codesys-verification.project"
+test -s "$WINEPREFIX/drive_c/codesys-verification.app"
+test -s "$WINEPREFIX/drive_c/codesys-verification.crc"
+wineserver -k
+wineserver -w