This project has been forked from https://github.com/rui314/chibicc
I want to play with it and to add some other options like choosing other linker than default ld. It's for learning purposes too, to try to understand existing code and to extend it. Using PVS.studio to find some potential issues and fix them.
Trying to work on issues and pull requests done in the original repository.
./chibicc --help or ./chibicc -h
chibicc is a C compiler based on chibicc created by Rui Ueyama.
See original project https://github.com/rui314/chibicc for more information
this chibicc contains only some differences for now like new parameters
chibicc usage :
--help or -h print the help
--version or -v print the version of chibicc
-cc1 run the cc1 function needs -cc1-input (-cc1-output optional) parameter
-fuse-ld to specify other linker than ld used by default
-x Specify the language of the following input files.
Permissible languages include: c assembler none
'none' means revert to the default behavior of
guessing the language based on the file's extension.
-S generate assembly file
-o path to output executable if omitted a.out generated
-c path to source to compile
-Xlinker <arg> Pass <arg> on to the linker.
-Wl,<options> Pass comma-separated <options> on to the linker.
-z <arg> Pass <arg> on to the linker.
-soname <arg> Pass -soname <arg> on to the linker.
--version-script <arg> Pass --version-script <arg> to the linker.
-I<path> Pass path to the include directories
-L<path> Pass path to the lib directories
-D<macro> define macro example -DM13
-U<macro> undefine macro example -UM13
-s to strip all symbols during linkage phasis
-M -MD -MP -MMD -MF <arg> -MT <arg> -MQ <arg> compiler write a list of input files to
stdout in a format that "make" command can read. This feature is
used to automate file dependency management
-fpic or -fPIC Generate position-independent code (PIC)
-fno-pic disables the generation of position-independent code with relative address references
-pie Create a dynamically linked position independent
-fpie Create a dynamically linked position independent
-fPIE Create a dynamically linked position independent
-fcommon is the default if not specified, it's mainly useful to enable legacy code to link without errors
-fno-common specifies that the compiler places uninitialized global variables in the BSS section of the object file.
-static pass to the linker to link a program statically
-pthread pass to the linker to link with lpthread library
-shared pass to the linker to produce a shared object which can then be linked with other objects to form an executable.
-hashmap-test to test the hashmap function
-idirafter <dir> apply to lookup for both the #include "file" and #include <file> directives.
-### to dump all commands executed by chibicc
-debug to dump all commands executed by chibicc in a log file in /tmp/chibicc.log
-E Stop after the preprocessing stage; do not run the compiler proper.
The output is in the form of preprocessed source code, which is sent to the standard output.
Input files that don’t require preprocessing are ignored.
-rpath <dir> Add a directory to the runtime library search path this parameter is passed to the linker.
This is used when linking an ELF executable with shared objects.
All -rpath arguments are concatenated and passed to the runtime linker,
which uses them to locate shared objects at runtime.
The -rpath option is also used when locating shared objects
which are needed by shared objects explicitly included in the link.
-dumpmachine it's required by some projects returns x86_64-linux-gnu
-dotfile generates a file with .dot extension that can be visualized using graphviz package
-dM Print macro definitions in -E mode instead of normal output
-print print all tokens in a log file in /tmp/chibicc.log
-A print Abstract Syntax Tree in a log file in /tmp/chibicc.log
chibicc [ -o <path> ] <file>
To compile chibicc with make :
make
To compile chibicc with cmake you need to install boost library. Then you can compile it with cmake :
cmake -S . -B ./build
cd build
make
Note that probably you need to define the include parameter and lib parameter to be able to execute these examples outside the chibicc directory. If you forgot you will have similar error message :
/usr/include/stdio.h:33: #include <stddef.h>
^ stddef.h: cannot open file: No such file or directory
To solve it, add the include and lib parameter like below assuming that we are in the parent chibicc directory :
chibicc pointerofpointers.c -I./chibicc/include -L./chibicc/lib
printing the help
./chibicc --help
./chibicc -h
printing the version
./chibicc --version
./chibicc -v
compiling and generating an executable
./chibicc -o ./test/hello ./test/hello.c
specifying another linker than the default one here lld :
./chibicc -o ./test/hello ./test/hello.c -fuse-ld ld.lld
specifying another linker than the default one here mold (https://github.com/rui314/mold)
./chibicc -o ./test/hello ./test/hello.c -fuse-ld mold
generating assembly file
./chibicc -S ./test/hello.c
generating a.out file if no parameter -o provided
./chibicc ./test/hello.c
generating the object only : it generates the pointerofpointers.o
./chibicc -c pointerofpointers.c -I./chibicc/include -L./chibicc/lib
generating executable from objects :
./chibicc pointerofpointers.o -o pointersofpointers
defining condition at compile time :
./chibicc -o ./test/mydefine ./test/define.c -DM13 -I../include -L../lib
./test/mydefine
3
undefining condition at compile time :
./chibicc -o ./test/mydefine ./test/define.c -UM13 -I../include -L../lib
./test/mydefine
4
By default the symbol tables is populated:
chibicc -o ./test/mydefine ./test/define.c
objdump -t ./test/mydefine
./test/mydefine: file format elf64-x86-64
SYMBOL TABLE:
0000000000000000 l df *ABS* 0000000000000000 crt1.o
0000000000400320 l O .note.ABI-tag 0000000000000020 \_\_abi_tag
0000000000000000 l df *ABS* 0000000000000000 crtstuff.c
Stripping symbol tables during linkage phasis adding -s parameter :
./chibicc -o ./test/mydefine ./test/define.c -s
objdump -t ./test/mydefine
./test/mydefine: file format elf64-x86-64
SYMBOL TABLE:
no symbols
other way to generate assembly file
./chibicc ./test/define.c -cc1 -cc1-input ./test/define.c -cc1-output mydefine.s
generating dependencies in std output :
./chibicc ./test/define.c -M
define.o: \
./test/define.c \
/usr/include/stdio.h \
/usr/include/x86_64-linux-gnu/bits/libc-header-start.h \
/usr/include/features.h \
generating dependencies in a output file with ".d" extension and generating executable a.out :
./chibicc ./test/define.c -MD
ls *.d
define.d
it means that if you don't use the ld linker or ld.lld probably some options should be conditionned depending your linker
lld-link: warning: ignoring unknown argument '-o'
lld-link: warning: ignoring unknown argument '-m'
lld-link: warning: ignoring unknown argument '-L/usr/lib/gcc/x86_64-linux-gnu/9'
lld-link: warning: ignoring unknown argument '-L/usr/lib/x86_64-linux-gnu'
lld-link: warning: ignoring unknown argument '-L/usr/lib64'
lld-link: warning: ignoring unknown argument '-L/lib64'
lld-link: warning: ignoring unknown argument '-L/usr/lib/x86_64-linux-gnu'
lld-link: warning: ignoring unknown argument '-L/usr/lib/x86_64-pc-linux-gnu'
lld-link: warning: ignoring unknown argument '-L/usr/lib/x86_64-redhat-linux'
lld-link: warning: ignoring unknown argument '-L/usr/lib'
lld-link: warning: ignoring unknown argument '-L/lib'
lld-link: warning: ignoring unknown argument '-dynamic-linker'
lld-link: warning: ignoring unknown argument '-lc'
lld-link: warning: ignoring unknown argument '-lgcc'
lld-link: warning: ignoring unknown argument '--as-needed'
lld-link: warning: ignoring unknown argument '-lgcc_s'
lld-link: warning: ignoring unknown argument '--no-as-needed'
List of options ignored :
"-O"
"-W"
"-g"
"-std="
"-std"
"-ffreestanding"
"-fno-omit-frame-pointer"
"-fomit-frame-pointer"
"-funwind-tables"
"-fno-stack-protector"
"-fno-strict-aliasing"
"-m64"
"-m32"
"--whole-archive"
"--no-whole-archive"
"-fsigned-char"
"-Bsymbolic"
"-z"
"defs"
"-flto"
"-flto=8"
"-pedantic"
"-nostdinc"
"-mno-red-zone"
"-fvisibility=default"
"-Werror=invalid-command-line-argument"
"-Werror=unknown-warning-option"
"-Wsign-compare"
"-Wundef"
"-Wpointer-arith"
"-Wvolatile-register-var"
"-Wformat"
"-Wformat-security"
"-Wduplicated-branches"
"-Wduplicated-cond"
"-Wbad-function-cast"
"-Wwrite-strings"
"-Wlogical-op"
"-Wshadow=local"
"-Wmultistatement-macros"
"-fstack-protector"
"-fstack-protector-strong"
"-fstack-clash-protection"
"-fdiagnostics-show-option"
"-fasynchronous-unwind-tables"
"-fexceptions"
"--print-search-dirs"
"-fdiagnostics-show-option"
"-Xc"
"-Aa"
"-rdynamic"
"-w"
"--param=ssp-buffer-size=4"
Adding dockerfile suggested by 0xc0 https://github.com/0xc0/chibicc/tree/new To build :
docker build -t chibicc .
Adding also a devcontainer for those that want to use visual code inside a container (needs vs code extension remote-containers).
tcc : tcc compiler (https://github.com/LuaDist/tcc.git)
chibicc -o tcc tcc.c -DTCC_TARGET_X86_64 -O2 -g -Wall -Wno-pointer-sign -lm -ldl
chibicc -o libtcc1.o -c lib/libtcc1.c -O2 -Wall
ar rcs libtcc1.a libtcc1.o
chibicc -o libtcc.o -c libtcc.c -DTCC_TARGET_X86_64 -O2 -g -Wall -Wno-pointer-sign
ar rcs libtcc.a libtcc.o
./texi2pod.pl tcc-doc.texi tcc.pod
pod2man --section=1 --center=" " --release=" " tcc.pod > tcc.1
chibicc -o libtcc_test tests/libtcc_test.c libtcc.a -I. -O2 -g -Wall -Wno-pointer-sign -lm -ldl
for some projects you need to define CC=chibicc before executing ./configure.
curl : https://github.com/curl/curl.git
autoreconf -fi
CC=chibicc CFLAGS=-fpic LDFLAGS=-fpic ./configure --with-openssl
make
make[2]: Entering directory ...
CC libcurl_la-altsvc.lo
CC libcurl_la-amigaos.lo
...
CC ../lib/curl_multibyte.o
CC ../lib/version_win32.o
CC ../lib/dynbuf.o
CCLD curl
make test
TESTDONE: 1635 tests were considered during 418 seconds.
TESTDONE: 1314 tests out of 1316 reported OK: 99%
TESTFAIL: These test cases failed: 557 1119
openssl : https://github.com/openssl/openssl.git
CC=chibicc ./Configure
You need to remove from the file from openssl/crypto/perlasm/x86_64-xlate.pl
my $section='.note.gnu.property, #alloc';
by :
my $section='.note.gnu.property';
make
make test
openssh-portable : https://github.com/openssh/openssh-portable.git
autoreconf -fi
CC=chibicc ./configure
make
luajit: https://github.com/LuaJIT/LuaJIT.git
CC=chibicc make
git: https://github.com/git/git.git
autoreconf -fi
CC=chibicc CFLAGS=-fPIC ./configure
make
make test
util-linux : https://github.com/util-linux/util-linux.git
Manually fixing the config.status and removing D["HAVE_UNION_SEMUN"]=" 1"
./autogen.sh
CC=chibicc CFLAGS=-fPIC ./configure
make
//to check if the compiled programs by chibicc work :
make check-programs
cd tests
run.sh
---------------------------------------------------------------------
All 280 tests PASSED
---------------------------------------------------------------------
nginx: https://github.com/nginx/nginx.git
CC=chibicc CFLAGS=-fPIC ./auto/configure
make
zlib: https://github.com/madler/zlib.git
CC=chibicc CFLAGS="-fPIC" ./configure
make
make test
...
*** zlib test OK ***
...
*** zlib shared test OK ***
...
*** zlib 64-bit test OK ***
vim: https://github.com/vim/vim.git
CC=chibicc CFLAGS="-fPIC" ./configure
make
make test
== SUMMARY ==
Test run on 2023 Sep 23 14:15:31
OK: 10
FAILED: 0: []
skipped: 0
libwepb: https://github.com/webmproject/libwebp.git
CC=chibicc CFLAGS="-fpic" LDFLAGS="-fpic -lpng -ljpeg" cmake -S . -B ./build
cd build
cmake --build .
~/libwebp/build$ ./img2webp -version
WebP Encoder version: 1.3.2
WebP Mux version: 1.3.2
libsharpyuv: 0.4.0
[no output file specified] [0 frames, 0 bytes].
memcached: https://github.com/memcached/memcached.git
autoreconf -fi
CC=chibicc CFLAGS=-fpic LDFLAGS=-fpic ./configure
make
make test
cpython: git clone [email protected]:python/cpython.git
CC=chibicc ./configure
make && make test
== Tests result: SUCCESS ==
10 slowest tests:
- test_imaplib: 52.3 sec
- test_signal: 49.1 sec
- test.test_concurrent_futures.test_wait: 48.4 sec
- test.test_multiprocessing_forkserver.test_processes: 41.1 sec
- test.test_multiprocessing_spawn.test_processes: 40.1 sec
- test.test_multiprocessing_spawn.test_misc: 36.5 sec
- test_io: 33.8 sec
- test.test_gdb.test_pretty_print: 33.4 sec
- test_socket: 33.4 sec
- test_xmlrpc: 29.1 sec
22 tests skipped:
test.test_asyncio.test_windows_events
test.test_asyncio.test_windows_utils test_bz2 test_dbm_gnu
test_dbm_ndbm test_devpoll test_idle test_ioctl test_kqueue
test_launcher test_msvcrt test_startfile test_tcl test_tkinter
test_ttk test_ttk_textonly test_turtle test_winapi
test_winconsoleio test_winreg test_winsound test_wmi
2 tests skipped (resource denied):
test_peg_generator test_zipfile64
448 tests OK.
Total duration: 2 min 41 sec
Total tests: run=42,576 skipped=1,689
Total test files: run=470/472 skipped=22 resource_denied=2
Result: SUCCESS
to be able to use meson with chibicc (meson doesn't know chibicc compiler), I changed the detect.py file in /usr/lib/python3/dist-packages/mesonbuild/compilers/detect.py to add support for chibicc. After that I can now using meson for some projects that are configured to use it.
lxc: https://github.com/lxc/lxc.git
Due to use of __attribute__((weak(alias))) in lxc/src/lxc/lxc.c, the linker is not able to find the symbols in the lxc library.
CC=chibicc \
CFLAGS="-fpic -Dlxc_attach_main=main -Dlxc_autostart_main=main -Dlxc_destroy_main=main -Dlxc_config_main=main -Dlxc_stop_main=main -Dlxc_info_main=main \
-Dlxc_checkpoint_main=main -Dlxc_cgroup_main=main -Dlxc_freeze_main=main -Dlxc_unfreeze_main=main -Dlxc_copy_main=main -Dlxc_device_main=main -Dlxc_execute_main=main \
-Dlxc_monitor_main=main -Dlxc_snapshot_main=main -Dlxc_console_main=main -Dlxc_ls_main=main -Dlxc_create_main=main -Dlxc_start_main=main -Dlxc_unshare_main=main \
-Dlxc_wait_main=main -Dlxc_top_main=main" \
LDFLAGS="-fpic -Wl,--undefined,lxc_attach_main -Wl,--undefined,lxc_autostart_main -Wl,--undefined,lxc_destroy_main -Wl,--undefined,lxc_config_main \
-Wl,--undefined,lxc_stop_main -Wl,--undefined,lxc_info_main -Wl,--undefined,lxc_checkpoint_main -Wl,--undefined,lxc_cgroup_main -Wl,--undefined,lxc_freeze_main \
-Wl,--undefined,lxc_unfreeze_main -Wl,--undefined,lxc_copy_main -Wl,--undefined,lxc_device_main -Wl,--undefined,lxc_execute_main -Wl,--undefined,lxc_monitor_main \
-Wl,--undefined,lxc_snapshot_main -Wl,--undefined,lxc_console_main -Wl,--undefined,lxc_ls_main -Wl,--undefined,lxc_create_main -Wl,--undefined,lxc_start_main \
-Wl,--undefined,lxc_start_main -Wl,--undefined,lxc_unshare_main -Wl,--undefined,lxc_wait_main -Wl,--undefined,lxc_top_main" \
meson build && cd build && meson compile
Some C projects doesn't compile for now or crash after being compiled with chibicc. It helps to find some bugs and to try to fix them!
VLC : https://github.com/videolan/vlc.git
./bootstrap
CC=chibicc CFLAGS="-fPIC" DEFS="-DHAVE_CONFIG_H -DHAVE_ATTRIBUTE_PACKED -DVLC_USED -DVLC_API -DVLC_DEPRECATED -DVLC_MALLOC" LDFLAGS="-fPIC" ./configure --disable-xcb --disable-qt --disable-a52
make all
VLC doesn't compile with chibicc some issues to fix later.
postgres: https://github.com/postgres/postgres.git
CC=chibicc ./configure --host x86_64-linux-gnu --disable-spinlocks
make
make check
Program received signal SIGSEGV, Segmentation fault.
#0 MemoryChunkSetHdrMask () at ../../../../src/include/utils/memutils_memorychunk.h:164
#1 0x0000000001f001b9 in AllocSetAlloc () at aset.c:885
the initdb command produced by chibicc failed with segmentation fault.
- trying to compile other C projects from source to see what is missing or which bug we have with chibicc.
- Trying to find the root cause of segmentation fault with postgres initdb command.
https://github.com/stormalf/chibicc/blob/main/ISSUES.md
To debug with gdb don't forget to use the set follow-fork-mode child because chibicc creates a child job.
gdb ./chibicc
(gdb) set follow-fork-mode child
(gdb) r issues/issue116.c -o issues/issue116
Starting program: /home/stormalf/ubuntu/chibicc/chibicc issues/issue116.c -o issues/issue116
[Attaching after process 174090 fork to child process 174091]
[New inferior 2 (process 174091)]
[Detaching after fork from parent process 174090]
[Inferior 1 (process 174090) detached]
process 174091 is executing new program: /home/stormalf/ubuntu/chibicc/chibicc
[Switching to process 174091]
Thread 2.1 "chibicc" hit Breakpoint 1, 0x0000000000432726 in parse () at parse.c:3703
3703 return "UNREACHABLE"; // Atomic e
Example of diagram generated with -dotfile parameter :
1.0.22.4 Fixing some issues with extended assembly (new test cases), adding r11 and r10 registers and adding "D" and "S" support for input and output.
Removing -fsanitize=cfi not supported by gcc. Adding core dump and segfault handler to have useful information when a segfault occurs.
Adding debug information for linker. Changing the order of extra linker parameters because if the specific path defined for a project is not the first one, it seems that the linker doesn't find the libraries (#ISS-173). Adding support for chibicc -xc -E -v - to print the include directories.
Ignoring two other attributes for compatibility with GCC : _attribute_((fallthrough)) and _attribute_((nonnull(1))). Adding a trick to fix the issue with lxc project in the README.md and Makefile. Adding some test cases for builtin functions to test with chibicc for later. Adding macro __builtin_choose_expr in stddef.h to fix issue found in the lxc project. Adding warning messages in purple like gcc. Fixing issue with extended assembly when atomic_sync_bool_compare_and_swap. Taking in account in extended assembly (-value) to negate the value. Adding builtin function __sync_fetch_and_add and __sync_fetch_and_sub. Adding other builtin_functions like gcc. Adding print AST with option -A (from @cosmopolitan).
https://github.com/stormalf/chibicc/blob/main/RELEASE_NOTES.md