$ svn checkout http://llvm-py.googlecode.com/svn/trunk/ llvm-py+
$ svn co http://llvm-py.googlecode.com/svn/trunk/ llvm-py
llvm-py is developed by Mahadevan R, in his spare time, without being -paid for it. He can be reached at mdevan.foobar@gmail.com, on the -llvm-dev mailing list and irc.oftc.net#llvm (mdevan).
+llvm-py is developed by Mahadevan R, in his spare time. He can be +reached at mdevan.foobar@gmail.com, on the llvm-dev mailing list and +irc.oftc.net#llvm (mdevan).
Many thanks to the guys over at LLVM for all the nifty software.
llvm-py is just hatching. It needs your patches and suggestions to -grow up. Please contribute! All patches are welcome. Here are some links -to start hacking away:
-| - Google code hosting - | -- http://code.google.com/p/llvm-py/ - | -
| - Browse SVN - | -- http://code.google.com/p/llvm-py/source/browse - | -
| - Issues tracker - | -- http://code.google.com/p/llvm-py/issues/list - | -
You can make a difference, just by:
++getting llvm-py to work on an as-yet-untested platform +
++adding support for more LLVM features into llvm-py +
++sending in patches for bugs you come across +
++improving the test scripts and documentation +
++spreading the word +
+Useful links:
++Google code hosting: http://code.google.com/p/llvm-py/ +
++Browse SVN: http://code.google.com/p/llvm-py/source/browse +
++Issues tracker: http://code.google.com/p/llvm-py/issues/list +
+SVN HEAD can be checked out like so:
$ svn checkout http://llvm-py.googlecode.com/svn/trunk/ llvm-py+
$ svn co http://llvm-py.googlecode.com/svn/trunk/ llvm-py
Mahadevan R (mdevan.foobar@gmail.com) is available to answer your -queries.
+Usual caveats apply: cutting edge, may be broken (but usually not), +update and merge before sending patches etc.
-Wrap GenericValue, function call args for execution engine. -
--done. -
--Add APIs to read/write .bc and .ll files. -
--Wrap lto. -
--Add examples. -
--Update documentation. -
--Improve tests. -
-The latest release is 0.2.1, released 18-Jun-2008 (Changelog +
The latest release is 0.3, released 8-Sep-2008 (Changelog below).
Download it here:
0.3, in progress: +0.3, 8-Sep-2008: + * Passes added. + * Assembly support: create modules from .ll files. + * Various bug fixes. + * Bitcode support: convert modules to bitcode and vice versa. * Intrinsics added. * JIT Tutorials ported (Sebastien Binet). * GenericValue added. Used by ExecutionEngine.run(). @@ -158,7 +176,7 @@ package.
llvm-py is just hatching. It should be stable enough to start hacking -away, though. Be sure to send in a patch (or shout at the author) if you -miss any specific LLVM API.
+away, though. Be sure to send in a patch if you miss any specific LLVM +API.Availability: llvm-py is available (as a source package) for LLVM 2.3 -and Python 2.5. It has been built and tested on Linux/i386, and has been -reported to work with OpenBSD. It is expected to be usable on -various unices, as well as with Python 2.4 and LLVM 2.3+svn, with -minimal changes, if any.
+and Python 2.5. It has been built and tested on Linux (x86, amd64) and +is reported to work with OpenBSD. It is expected to be usable on +various unices, as well as with Python 2.4. +LLVM 2.4: Read this if you're using LLVM +2.4!
+ 0.3 released. Passes, intrinsics, bitcode, assembly! +
+llvm-py requires verion 2.3 of LLVM. It will not work with previous -versions.
+versions. If you're using LLVM 2.4, see below.llvm-py has been built and tested with Python 2.5. It should work with Python 2.4, with minimal changes, if any.
@@ -140,32 +140,67 @@ installed, it is recommended to remove it first, as described llvm-py this way:$ tar jxvf llvm-py-0.2.tar.bz2 -$ cd llvm-py-0.2 +$ tar jxvf llvm-py-0.3.tar.bz2 +$ cd llvm-py-0.3 $ sudo python setup.py install
If you need to tell the build script where llvm-config is, do it this way:
$ tar jxvf llvm-py-0.2.tar.bz2 -$ cd llvm-py-0.2 +$ tar jxvf llvm-py-0.3.tar.bz2 +$ cd llvm-py-0.3 $ sudo python setup.py install --llvm-config=/home/mdevan/llvm/Release/bin/llvm-config
To build a debug version of llvm-py, that links against the debug libraries of LLVM, use this:
$ tar jxvf llvm-py-0.2.tar.bz2 -$ cd llvm-py-0.2 +$ tar jxvf llvm-py-0.3.tar.bz2 +$ cd llvm-py-0.3 $ python setup.py build -g --llvm-config=/home/mdevan/llvm/Debug/bin/llvm-config $ sudo python setup.py install --llvm-config=/home/mdevan/llvm/Debug/bin/llvm-config
Be warned that debug binaries will be huge (100MB+) !
+Be warned that debug binaries will be huge (100MB+) ! They are required +only if you need to debug into LLVM also.
setup.py is a standard Python distutils script. See the Python documentation regarding Installing Python Modules and Distributing Python Modules for more information on such scripts.
+LLVM 2.4 is currently in progress. There are incompatible API changes +from LLVM 2.3. The latest release of llvm-py will not compile against +it.
+The llvm-py SVN has a branch called +llvm2.4, +which attempts to track the changes happening in LLVM 2.4. There are +however, some caveats:
++There are no releases from this branch. +
++When LLVM 2.4 is released, then these changes will be merged to main. + From then on llvm-py will support LLVM 2.4 and no longer LLVM 2.3. +
++This branch is not religiously kept up-to-date with the changes + happening in LLVM SVN. Therefore, it may not work for you, but might + still be worth a try. +
+llvm-py can be checked out from this branch like this:
+$ svn co http://llvm-py.googlecode.com/svn/branches/llvm2.4 llvm-py-2.4+
The rest of the steps (build, install) remain the same as before.
To get rid of llvm-py completely, if you wish to do so:
Modules can also be constructed from LLVM assembly files (.ll files). +The static method from_assembly can be used for this. Similar to the +from_bitcode method, this one also takes a file-like object as +argument:
+# create a module from an assembly file +llfile = file("test.ll") +my_module = Module.from_assembly(llfile) +
Modules can be converted into their assembly representation by +stringifying them (see below).
+ Create a new Module instance by parsing the LLVM assembly file + represented by the file-like object fileobj. +
+The corresponding -LLVM docs +LLVM docs provide more information.
The alignment of any parameter can also be set via set_argument(a) where a is a power of 2.
The class llvm.core.BasicBlock represents a basic block of -instructions. Basic blocks are logically contained within functions, and -can be constructed only via Function objects. Use the -Function.append_basic_block() method for this:
-# create a function -func = module.add_function(functy, "fn") -# add a basic block, named 'entry', to the function -bblk = func.append_basic_block("entry") -
The list of all
+TODO
TODO
The class llvm.core.Instruction represents an LLVM IR instruction. -Instruction objects can be created only via a builder.
TODO
TODO
TODO
TODO
+TODO. For now, see test/example-jit.py.
TODO
+TODO. For now, see test/passes.py.