pg_query_go does not work on MinGW (GCC on Windows)

[kanryu]

Summary

When I run a program using pg_query_go on Windows with go run, pg_query_go gets a build error.

What I tried

• a empty dir
• Save the sample code from README.md as main.go
• go mod init example.com/m
• go mod tidy
  • require github.com/pganalyze/pg_query_go/v6 v6.1.0
• go run main.go

Solution

Remove the -fstack-protector option from parser/perser.go. It is not supported on Windows.

Build errors encountered during the attempt

$ go run main.go
# command-line-arguments
C:\local\gnu\Go-1.22.0\pkg\tool\windows_amd64\link.exe: running gcc failed: exit status 1
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o: in function `_fingerprintRTEPermissionInfo':
C:/Users/kanryu/go/pkg/mod/github.com/pganalyze/pg_query_go/v6@v6.1.0/parser/include/pg_query_fingerprint_defs.c:6525: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o: in function `_fingerprintVar':
C:/Users/kanryu/go/pkg/mod/github.com/pganalyze/pg_query_go/v6@v6.1.0/parser/include/pg_query_fingerprint_defs.c:730: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o: in function `_fingerprintJsonReturning':
C:/Users/kanryu/go/pkg/mod/github.com/pganalyze/pg_query_go/v6@v6.1.0/parser/include/pg_query_fingerprint_defs.c:2695: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o: in function `_fingerprintNode':
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/pg_query_fingerprint.c:310: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o: in function `_fingerprintAlterCollationStmt':
C:/Users/kanryu/go/pkg/mod/github.com/pganalyze/pg_query_go/v6@v6.1.0/parser/include/pg_query_fingerprint_defs.c:9525: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o:C:/Users/kanryu/go/pkg/mod/github.com/pganalyze/pg_query_go/v6@v6.1.0/parser/include/pg_query_fingerprint_conds.c:579: more undefined references to `__stack_chk_fail' follow
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000005.o:pg_query_fingerprint.c:(.rdata$.refptr.__stack_chk_guard[.refptr.__stack_chk_guard]+0x0): undefined reference to `__stack_chk_guard'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000010.o: in function `pg_query_raw_parse':
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/pg_query_parse.c:116: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000011.o: in function `pg_query_raw_parse_plpgsql':
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/pg_query_parse_plpgsql.c:396: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000013.o: in function `pg_query_scan':
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/pg_query_scan.c:164: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000014.o: in function `pg_query_split_with_scanner':
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/pg_query_split.c:163: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000016.o: in function `protobuf_c_message_pack_to_buffer':
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/protobuf-c.c:2011: undefined reference to `__stack_chk_fail'
C:/local/gnu/TDM-GCC-64/bin/../lib/gcc/x86_64-w64-mingw32/10.3.0/../../../../x86_64-w64-mingw32/bin/ld.exe: C:\Users\kanryu\AppData\Local\Temp\go-link-995018982\000016.o:C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser/protobuf-c.c:1644: more undefined references to `__stack_chk_fail' follow
collect2.exe: error: ld returned 1 exit status

[lfittl]

We are testing Windows build in CI (https://github.com/pganalyze/pg_query_go/blob/main/.github/workflows/ci.yml#L15), however that builds using the Visual Studio build chain, not Mingw.

Is there a reason you are relying on Mingw?

You might be able to deactivate -fstack-protector specifically for Windows, by adding -fno-stack-protector like we add the include path here:

pg_query_go/parser/parser.go

Line 5 in 6042d40

#cgo windows CFLAGS: -Iinclude/postgres/port/win32

[kanryu]

@lfittl

Is there a reason you are relying on Mingw?

Thank you for your comment.
I tried to find out how to build it with msvc but I couldn't figure it out.
Instead, I tried building it with clang+llvm-18.1.8-x86_64-pc-windows-msvc, but got the following result.
I don't think it can be built with any compiler other than MinGW.

unistd.h and sys/time.h are header files that do not exist on Windows.

go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
go: github.com/sqlc-dev/sqlc@v1.29.0 requires go >= 1.23.0; switching to go1.23.9
# github.com/pganalyze/pg_query_go/v6/parser
pg_query_deparse.c:28:18: warning: 'strdup' is deprecated: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. See online help for details. [-Wdeprecated-declarations]
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\string.h:531:20: note: 'strdup' has been explicitly marked deprecated here
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\corecrt.h:428:50: note: expanded from macro '_CRT_NONSTDC_DEPRECATE'
C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/include\vcruntime.h:245:47: note: expanded from macro '_CRT_DEPRECATE_TEXT'
pg_query_deparse.c:40:22: warning: 'strdup' is deprecated: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. See online help for details. [-Wdeprecated-declarations]
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\string.h:531:20: note: 'strdup' has been explicitly marked deprecated here
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\corecrt.h:428:50: note: expanded from macro '_CRT_NONSTDC_DEPRECATE'
C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/include\vcruntime.h:245:47: note: expanded from macro '_CRT_DEPRECATE_TEXT'
pg_query_deparse.c:41:22: warning: 'strdup' is deprecated: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. See online help for details. [-Wdeprecated-declarations]
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\string.h:531:20: note: 'strdup' has been explicitly marked deprecated here
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\corecrt.h:428:50: note: expanded from macro '_CRT_NONSTDC_DEPRECATE'
C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/include\vcruntime.h:245:47: note: expanded from macro '_CRT_DEPRECATE_TEXT'
pg_query_deparse.c:42:22: warning: 'strdup' is deprecated: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. See online help for details. [-Wdeprecated-declarations]
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\string.h:531:20: note: 'strdup' has been explicitly marked deprecated here
C:/Program Files (x86)/Windows Kits/10/Include/10.0.22621.0/ucrt\corecrt.h:428:50: note: expanded from macro '_CRT_NONSTDC_DEPRECATE'
C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/include\vcruntime.h:245:47: note: expanded from macro '_CRT_DEPRECATE_TEXT'
# github.com/pganalyze/pg_query_go/v6/parser
pg_query_fingerprint.c:20:10: fatal error: 'unistd.h' file not found
C:\Users\kanryu\go\pkg\mod\github.com\pganalyze\pg_query_go\v6@v6.1.0\parser\include\postgres\port\win32\sys/resource.h:7:10: fatal error: 'sys/time.h' file not found

[lfittl]

Instead, I tried building it with clang+llvm-18.1.8-x86_64-pc-windows-msvc, but got the following result.
I don't think it can be built with any compiler other than MinGW.

Interesting issue - so I thought that MSVC worked, but you might be right that it doesn't work with the Go library, since we don't include the win32_msvc folder which includes a versio nof unistd.h.

For reference, here is the Makefile.msvc in the libpg_query source, which is confimed to build correctly with Visual Studio: https://github.com/pganalyze/libpg_query/blob/17-latest/Makefile.msvc

We may need additional modifications to parser.go to have a conditional include on -I./src/postgres/include/port/win32_msvc (basically around this line, but I think we do not want that when building with MinGW: https://github.com/pganalyze/pg_query_go/blob/main/parser/parser.go#L5)

Unfortunately I do not develop on Windows myself (neither does anyone on our team), so we would need your help here testing what is needed to make this work. It was a lot of work to get the initial port to Windows done working as expected, and I don't have the bandwidth currently do that kind of exploration/debugging again, but happy to give some tips on how we could resolve it.