2009-12-08 10:46:35 -08:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>Installation</title>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
<meta name="Author" content="Mike Pall">
|
2010-01-09 05:28:11 -08:00
|
|
|
<meta name="Copyright" content="Copyright (C) 2005-2010, Mike Pall">
|
2009-12-08 10:46:35 -08:00
|
|
|
<meta name="Language" content="en">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="bluequad.css" media="screen">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="bluequad-print.css" media="print">
|
2010-03-07 08:12:21 -08:00
|
|
|
<style type="text/css">
|
|
|
|
|
table.compat {
|
|
|
|
|
line-height: 1.2;
|
2010-03-08 17:45:47 -08:00
|
|
|
width: 40em;
|
2010-03-07 08:12:21 -08:00
|
|
|
}
|
|
|
|
|
tr.compathead td {
|
|
|
|
|
font-weight: bold;
|
|
|
|
|
}
|
|
|
|
|
td.compatos {
|
|
|
|
|
width: 40%;
|
|
|
|
|
}
|
|
|
|
|
td.compatcc {
|
|
|
|
|
width: 30%;
|
|
|
|
|
vertical-align: top;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
2009-12-08 10:46:35 -08:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div id="site">
|
|
|
|
|
<a href="http://luajit.org"><span>Lua<span id="logo">JIT</span></span></a>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="head">
|
|
|
|
|
<h1>Installation</h1>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="nav">
|
|
|
|
|
<ul><li>
|
|
|
|
|
<a href="luajit.html">LuaJIT</a>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<a class="current" href="install.html">Installation</a>
|
|
|
|
|
</li><li>
|
|
|
|
|
<a href="running.html">Running</a>
|
|
|
|
|
</li><li>
|
|
|
|
|
<a href="api.html">API Extensions</a>
|
|
|
|
|
</li></ul>
|
|
|
|
|
</li><li>
|
|
|
|
|
<a href="status.html">Status</a>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<a href="changes.html">Changes</a>
|
|
|
|
|
</li></ul>
|
|
|
|
|
</li><li>
|
|
|
|
|
<a href="faq.html">FAQ</a>
|
|
|
|
|
</li><li>
|
2010-03-19 13:01:14 -07:00
|
|
|
<a href="http://luajit.org/performance.html">Performance <span class="ext">»</span></a>
|
|
|
|
|
</li><li>
|
2009-12-08 10:46:35 -08:00
|
|
|
<a href="http://luajit.org/download.html">Download <span class="ext">»</span></a>
|
|
|
|
|
</li></ul>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="main">
|
|
|
|
|
<p>
|
|
|
|
|
LuaJIT is only distributed as a source package. This page explains
|
|
|
|
|
how to build and install LuaJIT with different operating systems
|
|
|
|
|
and C compilers.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
For the impatient (on POSIX systems):
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
make && sudo make install
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
2010-03-07 08:12:21 -08:00
|
|
|
LuaJIT currently builds out-of-the box on most x86 or x64 systems.
|
|
|
|
|
Here's the compatibility matrix for the supported combinations of
|
|
|
|
|
operating system, CPU and compilers:
|
|
|
|
|
</p>
|
|
|
|
|
<table class="compat">
|
|
|
|
|
<tr class="compathead">
|
|
|
|
|
<td class="compatos">Operating system</td>
|
|
|
|
|
<td class="compatcc">x86 (32 bit)</td>
|
|
|
|
|
<td class="compatcc">x64 (64 bit)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr class="odd separate">
|
|
|
|
|
<td class="compatos">Linux</td>
|
|
|
|
|
<td class="compatcc">GCC 4.x<br>GCC 3.4</td>
|
|
|
|
|
<td class="compatcc">GCC 4.x</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr class="even">
|
|
|
|
|
<td class="compatos">Windows 98/XP/Vista/7</td>
|
|
|
|
|
<td class="compatcc">MSVC (EE)<br>Windows SDK<br>MinGW (GCC)<br>Cygwin (GCC)</td>
|
2010-03-08 17:45:47 -08:00
|
|
|
<td class="compatcc">MSVC + SDK v7.0<br>Windows SDK v7.0</td>
|
2010-03-07 08:12:21 -08:00
|
|
|
</tr>
|
|
|
|
|
<tr class="odd">
|
|
|
|
|
<td class="compatos">OSX 10.3-10.6</td>
|
|
|
|
|
<td class="compatcc">GCC 4.x<br>GCC 3.4</td>
|
|
|
|
|
<td class="compatcc">GCC 4.x</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr class="even">
|
|
|
|
|
<td class="compatos">*BSD, other</td>
|
|
|
|
|
<td class="compatcc">GCC 4.x<br>GCC 3.4</td>
|
|
|
|
|
<td class="compatcc">(not supported)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2009-12-08 10:46:35 -08:00
|
|
|
|
|
|
|
|
<h2>Configuring LuaJIT</h2>
|
|
|
|
|
<p>
|
|
|
|
|
The standard configuration should work fine for most installations.
|
2009-12-08 10:49:20 -08:00
|
|
|
Usually there is no need to tweak the settings. The following files
|
|
|
|
|
hold all user-configurable settings:
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<ul>
|
2009-12-08 10:49:20 -08:00
|
|
|
<li><tt>src/luaconf.h</tt> sets some configuration variables.</li>
|
|
|
|
|
<li><tt>Makefile</tt> has settings for <b>installing</b> LuaJIT (POSIX
|
2009-12-08 10:46:35 -08:00
|
|
|
only).</li>
|
2009-12-08 10:49:20 -08:00
|
|
|
<li><tt>src/Makefile</tt> has settings for <b>compiling</b> LuaJIT
|
|
|
|
|
under POSIX, MinGW and Cygwin.</li>
|
2009-12-08 10:46:35 -08:00
|
|
|
<li><tt>src/msvcbuild.bat</tt> has settings for compiling LuaJIT with
|
|
|
|
|
MSVC.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>
|
|
|
|
|
Please read the instructions given in these files, before changing
|
|
|
|
|
any settings.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<h2 id="posix">POSIX Systems (Linux, OSX, *BSD etc.)</h2>
|
|
|
|
|
<h3>Prerequisites</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Depending on your distribution, you may need to install a package for
|
|
|
|
|
GCC (GCC 3.4 or later required), the development headers and/or a
|
2010-03-04 10:07:38 -08:00
|
|
|
complete SDK. E.g. on a current Debian/Ubuntu, install <tt>libc6-dev</tt>
|
|
|
|
|
with the package manager.
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
Download the current source package (pick the .tar.gz), if you haven't
|
|
|
|
|
already done so. Move it to a directory of your choice, open a
|
|
|
|
|
terminal window and change to this directory. Now unpack the archive
|
|
|
|
|
and change to the newly created directory:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
2010-08-24 06:10:40 -07:00
|
|
|
tar zxf LuaJIT-2.0.0-beta5.tar.gz
|
|
|
|
|
cd LuaJIT-2.0.0-beta5</pre>
|
2009-12-08 10:46:35 -08:00
|
|
|
<h3>Building LuaJIT</h3>
|
|
|
|
|
<p>
|
|
|
|
|
The supplied Makefiles try to auto-detect the settings needed for your
|
|
|
|
|
operating system and your compiler. They need to be run with GNU Make,
|
|
|
|
|
which is probably the default on your system, anyway. Simply run:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
make
|
|
|
|
|
</pre>
|
2010-01-17 13:02:13 -08:00
|
|
|
<p>
|
2010-03-04 10:07:38 -08:00
|
|
|
This always builds a native x86 or x64 binary, depending on your OS.
|
2010-01-17 13:02:13 -08:00
|
|
|
</p>
|
2009-12-08 10:49:20 -08:00
|
|
|
<p>
|
|
|
|
|
By default modules are only searched under the prefix <tt>/usr/local</tt>.
|
|
|
|
|
You can add an extra prefix to the search paths by appending the
|
|
|
|
|
<tt>PREFIX</tt> option, e.g.:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
make PREFIX=/home/myself/lj2
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Note for OSX: <tt>MACOSX_DEPLOYMENT_TARGET</tt> is set to <tt>10.4</tt>
|
|
|
|
|
in <tt>src/Makefile</tt>. Change it, if you want to build on an older version.
|
|
|
|
|
</p>
|
2009-12-08 10:46:35 -08:00
|
|
|
<h3>Installing LuaJIT</h3>
|
|
|
|
|
<p>
|
|
|
|
|
The top-level Makefile installs LuaJIT by default under
|
|
|
|
|
<tt>/usr/local</tt>, i.e. the executable ends up in
|
2010-01-17 13:02:13 -08:00
|
|
|
<tt>/usr/local/bin</tt> and so on. You need root privileges
|
2009-12-08 10:46:35 -08:00
|
|
|
to write to this path. So, assuming sudo is installed on your system,
|
|
|
|
|
run the following command and enter your sudo password:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
sudo make install
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Otherwise specify the directory prefix as an absolute path, e.g.:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
2009-12-08 10:49:20 -08:00
|
|
|
make install PREFIX=/home/myself/lj2
|
2009-12-08 10:46:35 -08:00
|
|
|
</pre>
|
|
|
|
|
<p>
|
2009-12-08 10:49:20 -08:00
|
|
|
Obviously the prefixes given during build and installation need to be the same.
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<p style="color: #c00000;">
|
|
|
|
|
Note: to avoid overwriting a previous version, the beta test releases
|
|
|
|
|
only install the LuaJIT executable under the versioned name (i.e.
|
2010-08-24 06:10:40 -07:00
|
|
|
<tt>luajit-2.0.0-beta5</tt>). You probably want to create a symlink
|
2009-12-08 10:46:35 -08:00
|
|
|
for convenience, with a command like this:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code" style="color: #c00000;">
|
2010-08-24 06:10:40 -07:00
|
|
|
sudo ln -sf luajit-2.0.0-beta5 /usr/local/bin/luajit
|
2009-12-08 10:46:35 -08:00
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<h2 id="windows">Windows Systems</h2>
|
|
|
|
|
<h3>Prerequisites</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Either install one of the open source SDKs
|
|
|
|
|
(<a href="http://mingw.org/"><span class="ext">»</span> MinGW</a> or
|
2009-12-08 10:49:20 -08:00
|
|
|
<a href="http://www.cygwin.com/"><span class="ext">»</span> Cygwin</a>), which come with a modified
|
|
|
|
|
GCC plus the required development headers.
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<p>
|
2010-01-17 13:02:13 -08:00
|
|
|
Or install Microsoft's Visual C++ (MSVC). The freely downloadable
|
2009-12-08 10:46:35 -08:00
|
|
|
<a href="http://www.microsoft.com/Express/VC/"><span class="ext">»</span> Express Edition</a>
|
2010-01-17 13:02:13 -08:00
|
|
|
works just fine, but only contains an x86 compiler.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
The freely downloadable
|
|
|
|
|
<a href="http://msdn.microsoft.com/en-us/windowsserver/bb980924.aspx"><span class="ext">»</span> Windows SDK</a>
|
|
|
|
|
only comes with command line tools, but this is all you need to build LuaJIT.
|
|
|
|
|
It contains x86 and x64 compilers.
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
Next, download the source package and unpack it using an archive manager
|
|
|
|
|
(e.g. the Windows Explorer) to a directory of your choice.
|
|
|
|
|
</p>
|
|
|
|
|
<h3>Building with MSVC</h3>
|
|
|
|
|
<p>
|
2009-12-08 10:49:20 -08:00
|
|
|
Open a "Visual Studio .NET Command Prompt", <tt>cd</tt> to the
|
|
|
|
|
directory where you've unpacked the sources and run these commands:
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
cd src
|
|
|
|
|
msvcbuild
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Then follow the installation instructions below.
|
|
|
|
|
</p>
|
2010-01-17 13:02:13 -08:00
|
|
|
<h3>Building with the Windows SDK</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Open a "Windows SDK Command Shell" and select the x86 compiler:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
setenv /release /x86
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
2010-02-28 12:45:38 -08:00
|
|
|
Or select the x64 compiler:
|
2010-01-17 13:02:13 -08:00
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
setenv /release /x64
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Then <tt>cd</tt> to the directory where you've unpacked the sources
|
|
|
|
|
and run these commands:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
cd src
|
|
|
|
|
msvcbuild
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Then follow the installation instructions below.
|
|
|
|
|
</p>
|
2009-12-08 10:46:35 -08:00
|
|
|
<h3>Building with MinGW or Cygwin</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Open a command prompt window and make sure the MinGW or Cygwin programs
|
|
|
|
|
are in your path. Then <tt>cd</tt> to the directory where
|
|
|
|
|
you've unpacked the sources and run this command for MinGW:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
mingw32-make
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Or this command for Cygwin:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
make
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
Then follow the installation instructions below.
|
|
|
|
|
</p>
|
|
|
|
|
<h3>Installing LuaJIT</h3>
|
|
|
|
|
<p>
|
2009-12-08 10:49:20 -08:00
|
|
|
Copy <tt>luajit.exe</tt> and <tt>lua51.dll</tt> (built in the <tt>src</tt>
|
|
|
|
|
directory) to a newly created directory (any location is ok).
|
|
|
|
|
Add <tt>lua</tt> and <tt>lua\jit</tt> directories below it and copy
|
|
|
|
|
all Lua files from the <tt>lib</tt> directory of the distribution
|
|
|
|
|
to the latter directory.
|
2009-12-08 10:46:35 -08:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
There are no hardcoded
|
|
|
|
|
absolute path names — all modules are loaded relative to the
|
|
|
|
|
directory where <tt>luajit.exe</tt> is installed
|
|
|
|
|
(see <tt>src/luaconf.h</tt>).
|
|
|
|
|
</p>
|
2010-03-04 10:07:38 -08:00
|
|
|
|
|
|
|
|
<h2>Cross-compiling LuaJIT</h2>
|
|
|
|
|
<p>
|
|
|
|
|
The build system has limited support for cross-compilation. For details
|
|
|
|
|
check the comments in <tt>src/Makefile</tt>. Here are some popular examples:
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
You can cross-compile to a 32 bit binary on a multilib x64 OS by
|
2010-03-07 08:12:21 -08:00
|
|
|
installing the multilib development packages (e.g. <tt>libc6-dev-i386</tt>
|
2010-03-04 10:07:38 -08:00
|
|
|
on Debian/Ubuntu) and running:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
make CC="gcc -m32"
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
|
|
|
|
You can cross-compile for a Windows target on Debian/Ubuntu by
|
|
|
|
|
installing the <tt>mingw32</tt> package and running:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
2010-08-27 09:32:24 -07:00
|
|
|
make HOST_CC="gcc -m32" CROSS=i586-mingw32msvc- TARGET_SYS=Windows
|
2010-03-04 10:07:38 -08:00
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<h2>Embedding LuaJIT</h2>
|
|
|
|
|
<p>
|
|
|
|
|
LuaJIT is API-compatible with Lua 5.1. If you've already embedded Lua
|
|
|
|
|
into your application, you probably don't need to do anything to switch
|
|
|
|
|
to LuaJIT, except link with a different library. Additional hints:
|
|
|
|
|
</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Make sure you use <tt>luaL_newstate</tt>. Avoid using
|
|
|
|
|
<tt>lua_newstate</tt>, since this uses the (slower) default memory
|
|
|
|
|
allocator from your system (no support for this on x64).</tt></li>
|
|
|
|
|
<li>Make sure you use <tt>luaL_openlibs</tt> and not the old Lua 5.0 style
|
|
|
|
|
of calling <tt>luaopen_base</tt> etc. directly.</li>
|
|
|
|
|
<li>To change which standard libraries to load, copy <tt>src/lib_init.c</tt>
|
|
|
|
|
to your project and modify it accordingly. Make sure the <tt>jit</tt>
|
|
|
|
|
library is loaded or the JIT compiler will not be activated.</li>
|
|
|
|
|
<li>Here's a
|
|
|
|
|
<a href="http://lua-users.org/wiki/SimpleLuaApiExample"><span class="ext">»</span> simple example</a>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>
|
|
|
|
|
64 bit applications on OSX must be linked with these options
|
|
|
|
|
(only the main executable):
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
-pagezero_size 10000 -image_base 100000000
|
|
|
|
|
</pre>
|
2010-03-07 08:12:21 -08:00
|
|
|
<p>
|
|
|
|
|
It's recommended to <tt>rebase</tt> all (self-compiled) shared libraries
|
|
|
|
|
which are loaded at runtime on OSX/x64 (e.g. C extension modules for Lua).
|
|
|
|
|
See: <tt>man rebase</tt>
|
|
|
|
|
</p>
|
2009-12-08 10:46:35 -08:00
|
|
|
<br class="flush">
|
|
|
|
|
</div>
|
|
|
|
|
<div id="foot">
|
|
|
|
|
<hr class="hide">
|
2010-01-09 05:28:11 -08:00
|
|
|
Copyright © 2005-2010 Mike Pall
|
2009-12-08 10:46:35 -08:00
|
|
|
<span class="noprint">
|
|
|
|
|
·
|
|
|
|
|
<a href="contact.html">Contact</a>
|
|
|
|
|
</span>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
