All documentation is -Copyright © 2005-2022 Mike Pall. +Copyright © 2005-2023 Mike Pall.
@@ -102,7 +102,7 @@-This library is a work in progress. More -functionality will be added soon. -
-The string buffer library is built into LuaJIT by default, but it's not @@ -685,7 +679,7 @@
Contains the version number of the LuaJIT core. Version xx.yy.zz
-is represented by the decimal number xxyyzz.
+is represented by the decimal number xxyyzz.
+DEPRECATED after the switch to
+» rolling releases. zz is frozen at 99.
LuaJIT is fully upwards-compatible with Lua 5.1. It supports all
» standard Lua
@@ -425,9 +426,7 @@ C++ Exception Interoperability
on the C stack. The contents of the C++ exception object
pass through unmodified.
-For MSVC for Windows 64 bit this requires compilation of your C++ code
-with /EHa.C++ Exception Interoperability
-LuaJIT is only distributed as a source package. This page explains -how to build and install LuaJIT with different operating systems -and C compilers. +LuaJIT is only distributed as source code — get it from the +» git repository. This page explains how to build +and install the LuaJIT binary and library for different operating systems.
For the impatient (on POSIX systems): @@ -90,201 +90,21 @@
-LuaJIT currently builds out-of-the box on most systems: +LuaJIT currently builds out-of-the box on most systems. Please check the +supported operating systems and CPU architectures on the +» status page.
-| OS | -Min. Version | -Requirements | -LuaJIT Versions | -
| Windows | -7 | -x86 or x64, ARM64: TBA | -v2.0 – | -
| Linux | -- | - | v2.0 – | -
| *BSD | -- | - | v2.0 – | -
| macOS (OSX) | -10.4 | -- | v2.1 – | -
| POSIX | -- | mmap, dlopen | -v2.0 – | -
| Android | -4.0 | -Recent Android NDK | -v2.0 – | -
| iOS | -3.0 | -Xcode iOS SDK | -v2.1 – | -
| PS3 | -- | PS3 SDK | -v2.0 – v2.1 EOL | -
| PS4 | -- | PS4 SDK (ORBIS) | -v2.0 – | -
| PS5 | -- | PS5 SDK (PROSPERO) | -v2.1 – | -
| PS Vita | -- | PS Vita SDK (PSP2) | -v2.0 – v2.1 EOL | -
| Xbox 360 | -- | Xbox 360 SDK (XEDK) | -v2.0 – v2.1 EOL | -
| Xbox One | -- | Xbox One SDK (DURANGO) | -v2.1 – | -
| Nintendo Switch | -- | NintendoSDK + NX Addon | -v2.1 – | -
-The codebase has compatibility defines for some more systems, but -without official support. -
-Building LuaJIT requires a recent toolchain based on GCC, Clang/LLVM or MSVC++.
The Makefile-based build system requires GNU Make and supports -cross-builds. Batch files are provided for MSVC++ builds and console cross-builds.
-| CPU | -Bits | -Requirements | -Variants | -LuaJIT Versions | -
| x86 | -32 | -v2.1+: SSE2 | -- | v2.0 – | -
| x64 | -64 | -- | - | v2.0 – | -
| ARM | -32 | -ARMv5+, ARM9E+ | -hard-fp + soft-fp | -v2.0 – | -
| ARM64 | -64 | -- | ARM64le + ARM64be | -v2.1 – | -
| PPC32 | -32 | -- | hard-fp + soft-fp | -v2.0 – v2.1 EOL | -
| PPC/e500 | -32 | -e500v2 | -- | v2.0 EOL | -
| MIPS32 | -32 | -MIPS32r1 – r5 | -hard-fp + soft-fp | -v2.0 – | -
| MIPS64 | -64 | -MIPS64r1 – r5 | -hard-fp + soft-fp | -v2.1 – | -
| MIPS64 | -64 | -MIPS64r6 | -hard-fp + soft-fp | -v2.1 EOL | -
| RISC-V | -64 | -RVA22+ | -- | TBA | -
-There are no plans to add historic architectures or to continue support -for end-of-life (EOL) architectures, for which no new CPUs are commonly -available anymore. Likewise, there are no plans to support marginal -and/or de-facto-dead architectures. +Batch files are provided for MSVC++ builds and console cross-builds.
-Depending on your distribution, you may need to install a package for -GCC, the development headers and/or a complete SDK. E.g. on a current -Debian/Ubuntu, install libc6-dev with the package manager. +Depending on your distribution, you may need to install a package for a +compiler (GCC or Clang/LLVM), the development headers and/or a complete SDK. +E.g. on a current Debian/Ubuntu, install build-essential with the +package manager.
--The recommended way to fetch the latest version is to do a pull from -the git repository. -
--Alternatively, download the latest source package of LuaJIT (pick the .tar.gz). -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 (replace XX.YY.ZZ with the version you downloaded): -
--tar zxf LuaJIT-XX.YY.ZZ.tar.gz -cd LuaJIT-XX.YY.ZZ
@@ -394,15 +201,10 @@
-Next, pull from the git repository or download the source package and -unpack it using an archive manager (e.g. the Windows Explorer) to -a directory of your choice. -
-Open a "Visual Studio Command Prompt" (either x86 or x64), cd to the -directory where you've unpacked the sources and run these commands: +Open a "Visual Studio Command Prompt" (x86, x64 or ARM64), cd to the +directory with the source code and run these commands:
cd src @@ -412,11 +214,14 @@Building with MSVC
Check the msvcbuild.bat file for more options. Then follow the installation instructions below. ++For an x64 to ARM64 cross-build run this first: vcvarsall.bat x64_arm64 +
Building with MinGW or Cygwin
Open a command prompt window and make sure the MinGW or Cygwin programs -are in your path. Then cd to the directory of the git repository -or where you've unpacked the sources. Then run this command for MinGW: +are in your path. Then cd to the directory of the git repository. +Then run this command for MinGW:
mingw32-make @@ -518,15 +323,15 @@Cross-compiling LuaJIT
make HOST_CC="gcc -m32" CROSS=arm-linux-gnueabihf- # ARM64 -make CROSS=aarch64-linux- +make CROSS=aarch64-linux-gnu- # PPC make HOST_CC="gcc -m32" CROSS=powerpc-linux-gnu- # MIPS32 big-endian -make HOST_CC="gcc -m32" CROSS=mips-linux- +make HOST_CC="gcc -m32" CROSS=mips-linux-gnu- # MIPS32 little-endian -make HOST_CC="gcc -m32" CROSS=mipsel-linux- +make HOST_CC="gcc -m32" CROSS=mipsel-linux-gnu- # MIPS64 big-endian make CROSS=mips-linux- TARGET_CFLAGS="-mips64r2 -mabi=64" @@ -605,8 +410,8 @@Cross-compiling for consoles
To cross-compile for the other consoles from a Windows host, open a "Native Tools Command Prompt for VS". You need to choose either the 32 or the 64 bit version of the host compiler to match the target. -Then cd to the src directory below where you've -unpacked the sources and run the build command given in the table: +Then cd to the src directory below the source code +and run the build command given in the table:
| 3x - 100x |
-115 KB VM |
-90 KB JIT |
-63 KLOC C |
-24 KLOC ASM |
-11 KLOC Lua |
-
LuaJIT has been successfully used as a scripting middleware in games, appliances, network and graphics apps, numerical simulations, -trading platforms and many other specialty applications. It scales from -embedded devices, smartphones, desktops up to server farms. It combines -high flexibility with high performance -and an unmatched low memory footprint. +trading platforms and many other specialty applications. +
++LuaJIT is part of a hundred million web sites, huge SaaS installations, +network switches, set-top boxes and other embedded devices. You've probably +already used LuaJIT without knowing about it. +
++LuaJIT scales from embedded devices, smartphones, desktops up to server +farms. It combines high flexibility with high performance and an unmatched +low memory footprint.
LuaJIT has been in continuous development since 2005. It's widely @@ -220,7 +193,7 @@
LuaJIT has only a single stand-alone executable, called luajit on POSIX systems or luajit.exe on Windows. It can be used to run simple @@ -119,7 +120,8 @@