Search code examples
c++clangllvmcode-generation

What does the CodeModel in Clang / LLVM refer to?


I have been looking through the Clang / LLVM source-code and I came across the CodeModel property of CodeGenOptions.

Based on this method, the valid values appear to be: "small", "kernel", "medium" and "large".

What do this property control?

How do I go about choosing the correct value for my application?


Solution

  • Code model is a term from AMD64 ABI (see 3.5.1 from https://www.intel.com/content/dam/develop/external/us/en/documents/mpx-linux64-abi.pdf for more information).

    In short - the majority of the offsets inside x86-64 instructions are PC-relative, however the immediate field inside instructions is only 32-bit long. Therefore if the data is located "far" from the code (more than 32-bit apart), then one could not use immediate field inside the instructions to efficiently encode the offset and should calculate the address explicitly. The code model provides various restrictions on the relative location of code and data.

    If you're compiling everything statically, then 'small' is safe (and default). If you're JIT'ing, then everything is possible especially if ASLR is enabled and you'd need to use medium / large code model.