Merge pull request #4243 from RCoeurjoly/submodule_abc

Add YosysHQ/abc as a submodule located in abc.

.github/workflows/codeql.yml

@@ -15,7 +15,8 @@ jobs:
 
     - name: Checkout repository
       uses: actions/checkout@v4
-
+      with:
+       submodules: true
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v3
       with:

.github/workflows/emcc.yml

@@ -8,6 +8,8 @@ jobs:
     steps:
       - uses: mymindstorm/setup-emsdk@v14
       - uses: actions/checkout@v4
+        with:
+         submodules: true
       - name: Build
         run: |
           make config-emcc

.github/workflows/test-docs.yml

@@ -29,7 +29,8 @@ jobs:
 
       - name: Checkout Yosys
         uses: actions/checkout@v3
-
+        with:
+         submodules: true
       - name: Build yosys
         shell: bash
         run: |

.github/workflows/test-linux.yml

@@ -80,7 +80,8 @@ jobs:
 
       - name: Checkout Yosys
         uses: actions/checkout@v4
-
+        with:
+         submodules: true
       - name: Get iverilog
         shell: bash
         run: |

.github/workflows/test-macos.yml

@@ -36,7 +36,8 @@ jobs:
 
       - name: Checkout Yosys
         uses: actions/checkout@v4
-
+        with:
+         submodules: true
       - name: Get iverilog
         shell: bash
         run: |

.github/workflows/test-verific.yml

@@ -10,7 +10,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           persist-credentials: false
-
+          submodules: true
       - name: Runtime environment
         run: |
           echo "procs=$(nproc)" >> $GITHUB_ENV

.github/workflows/version.yml

@@ -13,6 +13,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
       - name: Take last commit
         id: log
         run: echo "message=$(git log --no-merges -1 --oneline)" >> $GITHUB_OUTPUT

.github/workflows/vs.yml

@@ -7,17 +7,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+         submodules: true
       - name: Build
         run: make vcxsrc YOSYS_VER=latest
       - uses: actions/upload-artifact@v4
         with:
           name: vcxsrc
           path: yosys-win32-vcxsrc-latest.zip
-  
+
   build:
     runs-on: windows-2019
     needs: yosys-vcxsrc
-    steps:  
+    steps:
       - uses: actions/download-artifact@v4
         with:
           name: vcxsrc

.github/workflows/wasi.yml

@@ -7,6 +7,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+         submodules: true
       - name: Build
         run: |
           WASI_SDK=wasi-sdk-19.0

.gitignore

@@ -18,7 +18,6 @@ __pycache__
 /coverage.info
 /coverage_html
 /Makefile.conf
-/abc
 /viz.js
 /yosys
 /yosys.exe
@@ -46,3 +45,4 @@ __pycache__
 /tests/unit/bintest/
 /tests/unit/objtest/
 /tests/ystests
+/build

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "abc"]
+	path = abc
+	url = https://github.com/YosysHQ/abc

Makefile

@@ -160,15 +160,6 @@ OBJS = kernel/version_$(GIT_REV).o
 bumpversion:
 	sed -i "/^YOSYS_VER := / s/+[0-9][0-9]*$$/+`git log --oneline c1ad377.. | wc -l`/;" Makefile
 
-# set 'ABCREV = default' to use abc/ as it is
-#
-# Note: If you do ABC development, make sure that 'abc' in this directory
-# is just a symlink to your actual ABC working directory, as 'make mrproper'
-# will remove the 'abc' directory and you do not want to accidentally
-# delete your work on ABC..
-ABCREV = 237d813
-ABCPULL = 1
-ABCURL ?= https://github.com/YosysHQ/abc
 ABCMKARGS = CC="$(CXX)" CXX="$(CXX)" ABC_USE_LIBSTDCXX=1 ABC_USE_NAMESPACE=abc VERBOSE=$(Q)
 
 # set ABCEXTERNAL = <abc-command> to use an external ABC instance
@@ -789,41 +780,40 @@ $(PROGRAM_PREFIX)yosys-config: misc/yosys-config.in
 			-e 's#@BINDIR@#$(strip $(BINDIR))#;' -e 's#@DATDIR@#$(strip $(DATDIR))#;' < $< > $(PROGRAM_PREFIX)yosys-config
 	$(Q) chmod +x $(PROGRAM_PREFIX)yosys-config
 
-abc/abc-$(ABCREV)$(EXE) abc/libabc-$(ABCREV).a:
+.PHONY: check-git-abc
+
+check-git-abc:
+	@if [ ! -d "$(YOSYS_SRC)/abc" ]; then \
+	    echo "Error: The 'abc' directory does not exist."; \
+			echo "Initialize the submodule: Run 'git submodule update --init' to set up 'abc' as a submodule."; \
+	    exit 1; \
+	elif git -C "$(YOSYS_SRC)" submodule status abc 2>/dev/null | grep -q '^ '; then \
+	    echo "'abc' is a git submodule. Continuing."; \
+	    exit 0; \
+	elif [ -f "$(YOSYS_SRC)/abc/.gitcommit" ] && grep -q '\$$Format:%h\$$' "$(YOSYS_SRC)/abc/.gitcommit"; then \
+	    echo "Error: 'abc' is not configured as a git submodule."; \
+	    echo "To resolve this:"; \
+	    echo "1. Back up your changes: Save any modifications from the 'abc' directory to another location."; \
+	    echo "2. Remove the existing 'abc' directory: Delete the 'abc' directory and all its contents."; \
+	    echo "3. Initialize the submodule: Run 'git submodule update --init' to set up 'abc' as a submodule."; \
+	    echo "4. Reapply your changes: Move your saved changes back to the 'abc' directory, if necessary."; \
+	    exit 1; \
+	else \
+	    echo "'abc' comes from a tarball. Continuing."; \
+	    exit 0; \
+	fi
+
+ABC_SOURCES := $(wildcard $(YOSYS_SRC)/abc/*)
+
+abc/abc$(EXE) abc/libabc.a: $(ABC_SOURCES) check-git-abc
 	$(P)
-ifneq ($(ABCREV),default)
+	$(Q) mkdir -p abc && $(MAKE) -C $(PROGRAM_PREFIX)abc -f "$(realpath $(YOSYS_SRC)/abc/Makefile)" ABCSRC="$(realpath $(YOSYS_SRC)/abc/)" $(S) $(ABCMKARGS) $(if $(filter %.a,$@),PROG="abc",PROG="abc$(EXE)") MSG_PREFIX="$(eval P_OFFSET = 5)$(call P_SHOW)$(eval P_OFFSET = 10) ABC: " $(if $(filter %.a,$@),libabc.a)
-	$(Q) if test -d abc/.hg; then \
-		echo 'REEBE: NOP qverpgbel vf n ut jbexvat pbcl! Erzbir nop/ naq er-eha "znxr".' | tr 'A-Za-z' 'N-ZA-Mn-za-m'; false; \
-	fi
-	$(Q) if test -d abc && test -d abc/.git && ! git -C abc diff-index --quiet HEAD; then \
-		echo 'REEBE: NOP pbagnvaf ybpny zbqvsvpngvbaf! Frg NOPERI=qrsnhyg va Lbflf Znxrsvyr!' | tr 'A-Za-z' 'N-ZA-Mn-za-m'; false; \
-	fi
-	$(Q) if test -d abc && ! test -d abc/.git && ! test "`cat abc/.gitcommit | cut -c1-7`" = "$(ABCREV)"; then \
-		echo 'REEBE: Qbjaybnqrq NOP irefvbaf qbrf abg zngpu! Qbjaybnq sebz:' | tr 'A-Za-z' 'N-ZA-Mn-za-m'; echo $(ABCURL)/archive/$(ABCREV).tar.gz; false; \
-	fi
-# set a variable so the test fails if git fails to run - when comparing outputs directly, empty string would match empty string
-	$(Q) if test -d abc && ! test -d abc/.git && test "`cat abc/.gitcommit | cut -c1-7`" = "$(ABCREV)"; then \
-		echo "Compiling local copy of ABC"; \
-	elif ! (cd abc 2> /dev/null && rev="`git rev-parse $(ABCREV)`" && test "`git rev-parse HEAD`" = "$$rev"); then \
-		test $(ABCPULL) -ne 0 || { echo 'REEBE: NOP abg hc gb qngr naq NOPCHYY frg gb 0 va Znxrsvyr!' | tr 'A-Za-z' 'N-ZA-Mn-za-m'; exit 1; }; \
-		echo "Pulling ABC from $(ABCURL):"; set -x; \
-		test -d abc || git clone $(ABCURL) abc; \
-		cd abc && $(MAKE) DEP= clean && git fetch $(ABCURL) && git checkout $(ABCREV); \
-	fi
-endif
-	$(Q) rm -f abc/abc-[0-9a-f]*
-	$(Q) $(MAKE) -C abc $(S) $(ABCMKARGS) $(if $(filter %.a,$@),PROG="abc-$(ABCREV)",PROG="abc-$(ABCREV)$(EXE)") MSG_PREFIX="$(eval P_OFFSET = 5)$(call P_SHOW)$(eval P_OFFSET = 10) ABC: " $(if $(filter %.a,$@),libabc-$(ABCREV).a)
 
-ifeq ($(ABCREV),default)
+$(PROGRAM_PREFIX)yosys-abc$(EXE): abc/abc$(EXE)
-.PHONY: abc/abc-$(ABCREV)$(EXE)
+	$(P) cp $< $(PROGRAM_PREFIX)yosys-abc$(EXE)
-.PHONY: abc/libabc-$(ABCREV).a
-endif
 
-$(PROGRAM_PREFIX)yosys-abc$(EXE): abc/abc-$(ABCREV)$(EXE)
+$(PROGRAM_PREFIX)yosys-libabc.a: abc/libabc.a
-	$(P) cp abc/abc-$(ABCREV)$(EXE) $(PROGRAM_PREFIX)yosys-abc$(EXE)
+	$(P) cp $< $(PROGRAM_PREFIX)yosys-libabc.a
-
-$(PROGRAM_PREFIX)yosys-libabc.a: abc/libabc-$(ABCREV).a
-	$(P) cp abc/libabc-$(ABCREV).a $(PROGRAM_PREFIX)yosys-libabc.a
 
 ifneq ($(SEED),)
 SEEDOPT="-S $(SEED)"
@@ -1141,9 +1131,6 @@ echo-yosys-ver:
 echo-git-rev:
 	@echo "$(GIT_REV)"
 
-echo-abc-rev:
-	@echo "$(ABCREV)"
-
 echo-cxx:
 	@echo "$(CXX)"
 

abc

@@ -0,0 +1 @@
+Subproject commit 237d81397fcc85dd3894bf1a449d2955cd3df02d