~mcf/cproc

ref: 0e9f74cb67f2227f888e9a127624f77d83aee270 cproc/README.md -rw-r--r-- 3.5 KiB
0e9f74cb — Michael Forney Use enum type for expr->builtin.kind 1 year, 11 months ago

builds.sr.ht status

This is a C11 compiler using QBE as a backend. It is released under the ISC license.

Several GNU C extensions are also implemented.

There is still much to do and some parts of the code are a little rough, but it currently implements most of the language and is capable of building some useful software including itself, mcpp, binutils, and more.

It was inspired by several other small C compilers including 8cc, c, and scc.

#Requirements

The compiler itself is written in standard C11 and can be built with any conforming C11 compiler.

The POSIX driver depends on POSIX.1-2008 interfaces, and the Makefile requires a POSIX-compatible make(1).

At runtime, you will need QBE, an assembler, and a linker for the target system. Since the preprocessor is not yet implemented, an external one is currently required as well.

#Building

You will need to create a config.h appropriate for the target system. If missing, a default version will be created from config.def.h, which should work for most glibc systems, or musl systems with -D 'DYNAMICLINKER="/lib/ld-musl-x86_64.so.1"'.

You may also want to customize your environment or config.mk with the appropriate CC, CFLAGS and LDFLAGS.

Once this is done, you can build with

make

#Bootstrap

The Makefile includes several other targets that can be used for bootstrapping. These targets require the ability to run the tools specified in config.h.

  • **stage2**: Build the compiler with the initial (stage1) output.
  • **stage3**: Build the compiler with the stage2 output.
  • **bootstrap**: Build the stage2 and stage3 compilers, and verify that they are byte-wise identical.

#What's missing

  • Digraph and trigraph sequences (6.4.6p3 and 5.2.1.1, will not be implemented).
  • Wide string literals and character constants (#35 and #36).
  • Variable-length arrays (#1).
  • volatile-qualified types (#7).
  • _Thread_local storage-class specifier (#5).
  • long double type (#3).
  • Inline assembly (#5).
  • Preprocessor (#6).
  • Generation of position independent code (i.e. shared libraries, modules, PIEs).
  • Currently only x86_64 is supported and tested, though QBE also supports aarch64, so it is possible that it works as well.

#Issue tracker

Please report any issues to https://todo.sr.ht/~mcf/cc-issues.

#Contributing

Send patches to me (address in commit log), or pull-requests on the GitHub mirror. Once I decide on a project name, a mailing list will be created, which will then become the preferred form of contribution.