| blob | 218663151cd29a059a27f1000bce046c5bc1323b |
2 <html>
3 <head>
14 }
18 }
22 }
25 }
28 }
31 }
32 </style>
33 </head>
34 <body>
37 </div>
40 </div>
42 <ul><li>
44 <ul><li>
46 </li><li>
48 </li><li>
50 </li></ul>
51 </li><li>
53 <ul><li>
55 <ul><li>
57 </li><li>
59 </li><li>
61 </li></ul>
62 </li><li>
64 </li><li>
66 </li></ul>
67 </li><li>
69 </li><li>
71 </li><li>
73 </li></ul>
74 </div>
76 <p>
77 LuaJIT is only distributed as source code — get it from the
78 <a href="https://luajit.org/download.html"><span class="ext">»</span> git repository</a>. This page explains how to build
79 and install the LuaJIT binary and library for different operating systems.
80 </p>
81 <p>
82 For the impatient (on POSIX systems):
83 </p>
85 make && sudo make install
86 </pre>
89 <p>
90 LuaJIT currently builds out-of-the box on most systems. Please check the
91 supported operating systems and CPU architectures on the
93 </p>
94 <p>
95 Building LuaJIT requires a recent toolchain based on GCC, Clang/LLVM or
96 MSVC++.
97 </p>
98 <p>
99 The Makefile-based build system requires GNU Make and supports
100 cross-builds.
101 </p>
102 <p>
103 Batch files are provided for MSVC++ builds and console cross-builds.
104 </p>
107 <p>
108 The standard configuration should work fine for most installations.
109 Usually there is no need to tweak the settings. The following files
110 hold all user-configurable settings:
111 </p>
112 <ul>
114 only).</li>
116 under POSIX, MinGW or Cygwin.</li>
118 MSVC (Visual Studio).</li>
119 </ul>
120 <p>
121 Please read the instructions given in these files, before changing
122 any settings.
123 </p>
127 <p>
128 Depending on your distribution, you may need to install a package for a
129 compiler (GCC or Clang/LLVM), the development headers and/or a complete SDK.
131 package manager.
132 </p>
133 </pre>
135 <p>
136 The supplied Makefiles try to auto-detect the settings needed for your
137 operating system and your compiler. They need to be run with GNU Make,
138 which is probably the default on your system, anyway. Simply run:
139 </p>
141 make
142 </pre>
143 <p>
144 This always builds a native binary, depending on the host OS
145 you're running this command on. Check the section on
147 </p>
148 <p>
150 You can add an extra prefix to the search paths by appending the
152 </p>
154 make PREFIX=/home/myself/lj2
155 </pre>
156 <p>
157 Please use the LuaJIT 2.1 branch to compile for
159 </p>
161 <p>
162 The top-level Makefile installs LuaJIT by default under
165 to write to this path. So, assuming sudo is installed on your system,
166 run the following command and enter your sudo password:
167 </p>
169 sudo make install
170 </pre>
171 <p>
172 Otherwise specify the directory prefix as an absolute path, e.g.:
173 </p>
175 make install PREFIX=/home/myself/lj2
176 </pre>
177 <p>
178 Obviously the prefixes given during build and installation need to be the same.
179 </p>
183 <p>
184 Either install one of the open source SDKs
186 <a href="https://www.cygwin.com/"><span class="ext">»</span> Cygwin</a>), which come with a modified
187 GCC plus the required development headers.
188 Or install Microsoft's Visual Studio (MSVC).
189 </p>
191 <p>
193 directory with the source code and run these commands:
194 </p>
196 cd src
197 msvcbuild
198 </pre>
199 <p>
201 Then follow the installation instructions below.
202 </p>
204 <p>
205 Open a command prompt window and make sure the MinGW or Cygwin programs
207 Then run this command for MinGW:
208 </p>
210 mingw32-make
211 </pre>
212 <p>
213 Or this command for Cygwin:
214 </p>
216 make
217 </pre>
218 <p>
219 Then follow the installation instructions below.
220 </p>
222 <p>
224 directory) to a newly created directory (any location is ok).
227 to the latter directory.
228 </p>
229 <p>
230 There are no hardcoded
231 absolute path names — all modules are loaded relative to the
234 </p>
237 <p>
238 The GNU Makefile-based build system allows cross-compiling on any host
239 for any supported target, as long as both architectures have the same
240 pointer size. If you want to cross-compile to any 32 bit target on an
241 x64 OS, you need to install the multilib development package (e.g.
244 </p>
245 <p>
247 target OS differ, or you'll get assembler or linker errors. E.g. if
248 you're compiling on a Windows or macOS host for embedded Linux or Android,
250 minimal target OS, you may need to disable the built-in allocator in
253 </p>
254 <p>
255 The examples below only show some popular targets — please check
257 </p>
259 # Cross-compile to a 32 bit binary on a multilib x64 OS
262 # Cross-compile on Debian/Ubuntu for Windows (mingw32 package)
264 </pre>
267 toolchain (Binutils, GCC and a matching libc). The prefix may vary
270 use the canonical toolchain triplets for Linux.
271 </p>
272 <p>
273 Since there's often no easy way to detect CPU features at runtime, it's
274 important to compile with the proper CPU or architecture settings. You
275 can specify these when building the toolchain yourself. Or add
278 too. Otherwise, LuaJIT may not run at the full performance of your target
279 CPU.
280 </p>
282 # ARM soft-float
286 # ARM soft-float ABI with VFP (example for Cortex-A8)
290 # ARM hard-float ABI with VFP (armhf, requires recent toolchain)
293 # PPC
295 # PPC/e500v2 (fast interpreter only)
298 # MIPS big-endian
300 # MIPS little-endian
302 </pre>
303 <p>
304 You can cross-compile for <b id="android">Android</b> using the <a href="https://developer.android.com/ndk/"><span class="ext">»</span> Android NDK</a>.
305 Please adapt the environment variables to match the install locations and the
307 </p>
309 # Android/ARM, armeabi-v7a (ARMv7 VFP), Android 4.1+ (JB)
311 NDKDIR=/opt/android/ndk
312 NDKBIN=$NDKDIR/toolchains/llvm/prebuilt/linux-x86_64/bin
313 NDKCROSS=$NDKBIN/arm-linux-androideabi-
314 NDKCC=$NDKBIN/armv7a-linux-androideabi16-clang
318 TARGET_STRIP=$NDKBIN/llvm-strip
319 </pre>
320 <p>
321 Please use the LuaJIT 2.1 branch to compile for
323 </p>
326 <p>
327 Building LuaJIT for consoles requires both a supported host compiler
328 (x86 or x64) and a cross-compiler from the official console SDK.
329 </p>
330 <p>
331 Due to restrictions on consoles, the JIT compiler is disabled and only
332 the fast interpreter is built. This is still faster than plain Lua,
333 but much slower than the JIT compiler. The FFI is disabled, too, since
334 it's not very useful in such an environment.
335 </p>
336 <p>
338 which can be linked against your game, just like the Lua library.
339 </p>
340 <p>
344 </p>
347 </pre>
348 <p>
349 To cross-compile for the other consoles from a Windows host, open a
353 and run the build command given in the table:
354 </p>
360 </tr>
365 </tr>
370 </tr>
375 </tr>
376 </table>
377 <p>
379 file for more options.
380 </p>
383 <p>
384 LuaJIT is API-compatible with Lua 5.1. If you've already embedded Lua
385 into your application, you probably don't need to do anything to switch
386 to LuaJIT, except link with a different library:
387 </p>
388 <ul>
389 <li>It's strongly suggested to build LuaJIT separately using the supplied
391 source files into your build tree. You'll most likely get the internal build
392 dependencies wrong or mess up the compiler flags. Treat LuaJIT like any
393 other external library and link your application with either the dynamic
394 or static library, depending on your needs.</li>
395 <li>If you want to load C modules compiled for plain Lua
398 <ul><li>On POSIX systems you can either link to the shared library
399 or link the static library into your application. In the latter case
400 you'll need to export all public symbols from your main executable
403 <li>Since Windows symbols are bound to a specific DLL name, you need to
405 the DLL). You may link LuaJIT statically on Windows only if you don't
406 intend to load Lua/C modules at runtime.
407 </li></ul>
408 </li>
409 </ul>
411 <ul>
412 <li>Here's a
413 <a href="http://lua-users.org/wiki/SimpleLuaApiExample"><span class="ext">»</span> simple example</a>
414 for embedding Lua or LuaJIT into your application.</li>
420 <li>To change or extend the list of standard libraries to load, copy
423 will not be activated.</li>
425 is already built-in. There's no need to statically link
426 <a href="https://bitop.luajit.org/"><span class="ext">»</span> Lua BitOp</a> to your application.</li>
427 </ul>
430 <p>
431 The LuaJIT build system has extra provisions for the needs of most
432 POSIX-based distributions. If you're a package maintainer for
434 avoid patching, subverting, autotoolizing or messing up the build system
435 in unspeakable ways.
436 </p>
437 <p>
439 of the Makefiles. And please do not hand-pick files for your packages —
442 </p>
443 <p>
444 The build system uses GNU make and auto-detects most settings based on
445 the host you're building it on. This should work fine for native builds,
446 even when sandboxed. You may need to pass some of the following flags to
448 for a regular distribution build:
449 </p>
450 <ul>
453 the paths needed to locate the shared library.</li>
455 to a shadow tree instead of the root tree of the build system.</li>
461 like cross-builds:
462 <tt>BUILDMODE, CC, HOST_CC, STATIC_CC, DYNAMIC_CC, CFLAGS, HOST_CFLAGS,
463 TARGET_CFLAGS, LDFLAGS, HOST_LDFLAGS, TARGET_LDFLAGS, TARGET_SHLDFLAGS,
464 TARGET_FLAGS, LIBS, HOST_LIBS, TARGET_LIBS, CROSS, HOST_SYS, TARGET_SYS
465 </tt></li>
466 </ul>
467 <p>
468 The build system has a special target for an amalgamated build, i.e.
470 and allows GCC to generate faster and shorter code. Alas, this requires
471 lots of memory during the build. This may be a problem for some users,
472 that's why it's not enabled by default. But it shouldn't be a problem for
473 most build farms. It's recommended that binary distributions use this
474 target for their LuaJIT builds.
475 </p>
476 <p>
477 The tl;dr version of the above:
478 </p>
480 make amalg PREFIX=/usr && \
481 make install PREFIX=/usr DESTDIR=/tmp/buildroot
482 </pre>
483 <p>
484 Finally, if you encounter any difficulties, please
486 package onto unsuspecting users. Because they'll usually gonna complain
487 to me (the upstream) and not you (the package maintainer), anyway.
488 </p>
490 </div>
495 ·
497 </span>
498 </div>
499 </body>
500 </html>