EQY Plugin ABI Mismatch causing "undefined symbol" error when running eqy check

[observerw]

Subject

[Flow] for any util, flow Makefile, or flow script issues.

Describe the bug

When using latest docker image, running basic synthesis will fail:

source /OpenROAD-flow-scripts/env.sh
cd /OpenROAD-flow-scripts/flow
make DESIGN_CONFIG=designs/sky130hd/gcd/config.mk

log file at logs/sky130hd/gcd/base/4_eqy_output/combine.log saids:

ERROR: Can't load module `/usr/local/bin/../share/yosys/plugins/eqy_combine.so': /usr/local/bin/../share/yosys/plugins/eqy_combine.so: undefined symbol: _ZN5Yosys5RTLIL10IDInternal8blackboxE

Expected Behavior

Seems to be a yosys plugin related issue. The flow is suppose to run successfully.

Environment

This issue can be reproduced in the standard openroad/orfs:latest image, which does not contains tools/OpenROAD repo.

To Reproduce

make DESIGN_CONFIG=designs/sky130hd/gcd/config.mk

gcd.zip

Relevant log output

Screenshots

No response

Additional Context

I've noticed that openroad/flow-ubuntu22.04-dev installs EQY and its plugins into /usr/local/share/yosys/plugins, but build_openroad.shcompiles a version of Yosys from the tools/yosys submodule and installs it into tools/install/yosys/. The env.sh add tools/install/yosys/bin/ to PATH, but the plugins in /usr/local/share/yosys/plugins are incompatible with the newer Yosys binary built from source.

[maliberty]

Short term you can use EQUIVALENCE_CHECK=0 to skip eqy.

@vvbandeira thoughts?

[observerw]

A Dockerfile I used to temporarily patch this issue:

FROM docker.io/openroad/orfs:latest

USER root

ENV DEBIAN_FRONTEND=noninteractive

RUN apt-get update && \
    apt-get install -y --no-install-recommends \
        curl \
        build-essential \
        libffi-dev \
        tcl-dev \
        zlib1g-dev && \
    rm -rf /var/lib/apt/lists/*

WORKDIR /OpenROAD-flow-scripts

# Download and rebuild EQY plugins to match the Yosys ABI in the image
RUN mkdir -p tools/eqy_src && \
    for f in eqy_combine.cc eqy_partition.cc eqy_recode.cc; do \
        curl -sL "https://raw.githubusercontent.com/YosysHQ/eqy/main/src/$f" -o "tools/eqy_src/$f"; \
    done && \
    YOSYS_CONFIG=/OpenROAD-flow-scripts/tools/install/yosys/bin/yosys-config && \
    PLUGIN_DIR=/OpenROAD-flow-scripts/tools/install/yosys/share/yosys/plugins && \
    mkdir -p "$PLUGIN_DIR" && \
    "$YOSYS_CONFIG" --build "$PLUGIN_DIR/eqy_combine.so" tools/eqy_src/eqy_combine.cc && \
    "$YOSYS_CONFIG" --build "$PLUGIN_DIR/eqy_partition.so" tools/eqy_src/eqy_partition.cc && \
    "$YOSYS_CONFIG" --build "$PLUGIN_DIR/eqy_recode.so" tools/eqy_src/eqy_recode.cc && \
    chmod o+rw -R "$PLUGIN_DIR" && \
    rm -rf tools/eqy_src