Skip to content

Commit

Permalink
Add more documentation on the LLVM codegen
Browse files Browse the repository at this point in the history
Add the required LLVM version (3.3, according to comments in the source)
and note the performance relative to the other codegens (summarized from
the benchmarks in Brian Leibig's project report).
  • Loading branch information
tsuyoshi2 committed May 29, 2015
1 parent 15f6115 commit c18745b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/guide/src/LLVMCodegen.adoc
Expand Up @@ -6,6 +6,15 @@ The <:LLVMCodegen:> is a <:Codegen:code generator> that translates the
further optimized and compiled to native object code by the <:LLVM:>
toolchain.

It requires <:LLVM:> version 3.3 or greater to be installed.

In benchmarks performed on the <:RunningOnAMD64:AMD64> architecture,
code size with this generator is usually slightly smaller than either
the <:AMD64Codegen:native> or the <:CCodegen:C> code generators. Compile
time is worse than <:AMD64Codegen:native>, but slightly better than
<:CCodegen:C>. Run time is often better than either <:AMD64Codegen:native>
or <:CCodegen:C>.

== Implementation ==

* <!ViewGitFile(mlton,master,mlton/codegen/llvm-codegen/llvm-codegen.sig)>
Expand Down

0 comments on commit c18745b

Please sign in to comment.