From 55b16959717084884fd4a0cbae6d19e3786c20c7 Mon Sep 17 00:00:00 2001 From: Mike Pall Date: Tue, 8 Dec 2009 19:46:35 +0100 Subject: RELEASE LuaJIT-2.0.0-beta1 --- doc/api.html | 203 +++++++++++++++++++++++++++++++++ doc/bluequad-print.css | 166 +++++++++++++++++++++++++++ doc/bluequad.css | 303 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/changes.html | 281 +++++++++++++++++++++++++++++++++++++++++++++ doc/contact.html | 84 ++++++++++++++ doc/faq.html | 141 +++++++++++++++++++++++ doc/img/contact.png | Bin 0 -> 1340 bytes doc/install.html | 216 +++++++++++++++++++++++++++++++++++ doc/luajit.html | 120 ++++++++++++++++++++ doc/running.html | 233 +++++++++++++++++++++++++++++++++++++ doc/status.html | 235 ++++++++++++++++++++++++++++++++++++++ 11 files changed, 1982 insertions(+) create mode 100644 doc/api.html create mode 100644 doc/bluequad-print.css create mode 100644 doc/bluequad.css create mode 100644 doc/changes.html create mode 100644 doc/contact.html create mode 100644 doc/faq.html create mode 100644 doc/img/contact.png create mode 100644 doc/install.html create mode 100644 doc/luajit.html create mode 100644 doc/running.html create mode 100644 doc/status.html (limited to 'doc') diff --git a/doc/api.html b/doc/api.html new file mode 100644 index 00000000..79788d95 --- /dev/null +++ b/doc/api.html @@ -0,0 +1,203 @@ + + + +API Extensions + + + + + + + + +
+Lua +
+ + +
+

+LuaJIT is fully upwards-compatible with Lua 5.1. It supports all +» standard Lua +library functions and the full set of +» Lua/C API +functions. +

+

+LuaJIT is also fully ABI-compatible to Lua 5.1 at the linker/dynamic +loader level. This means you can compile a C module against the +standard Lua headers and load the same shared library from either Lua +or LuaJIT. +

+ +

bit.* — Bitwise Operations

+

+LuaJIT supports all bitwise operations as defined by +» Lua BitOp: +

+
+bit.tobit  bit.tohex  bit.bnot    bit.band bit.bor  bit.bxor
+bit.lshift bit.rshift bit.arshift bit.rol  bit.ror  bit.bswap
+
+

+This module is a LuaJIT built-in — you don't need to download or +install Lua BitOp. The Lua BitOp site has full documentation for all +» Lua BitOp API functions. +

+

+Please make sure to require the module before using any of +its functions: +

+
+local bit = require("bit")
+
+

+An already installed Lua BitOp module is ignored by LuaJIT. +This way you can use bit operations from both Lua and LuaJIT on a +shared installation. +

+ +

jit.* — JIT compiler control

+

+The functions in this built-in module control the behavior +of the JIT compiler engine. +

+ +

jit.on()
+jit.off()

+

+Turns the whole JIT compiler on (default) or off. +

+

+These functions are typically used with the command line options +-j on or -j off. +

+ +

jit.flush()

+

+Flushes the whole cache of compiled code. +

+ +

jit.flush(tr)

+

+Flushes the code for the specified root trace and all of its +side traces from the cache. +

+ +

jit.on(func|true [,true|false])
+jit.off(func|true [,true|false])
+jit.flush(func|true [,true|false])

+

+jit.on enables JIT compilation for a Lua function (this is +the default). +

+

+jit.off disables JIT compilation for a Lua function and +flushes any already compiled code from the code cache. +

+

+jit.flush flushes the code, but doesn't affect the +enable/disable status. +

+

+The current function, i.e. the Lua function calling this library +function, can also be specified by passing true as the first +argument. +

+

+If the second argument is true, JIT compilation is also +enabled, disabled or flushed recursively for all subfunctions of a +function. With false only the subfunctions are affected. +

+

+The jit.on and jit.off functions only set a flag +which is checked when the function is about to be compiled. They do +not trigger immediate compilation. +

+

+Typical usage is jit.off(true, true) in the main chunk +of a module to turn off JIT compilation for the whole module for +debugging purposes. +

+ +

jit.version

+

+Contains the LuaJIT version string. +

+ +

jit.version_num

+

+Contains the version number of the LuaJIT core. Version xx.yy.zz +is represented by the decimal number xxyyzz. +

+ +

jit.arch

+

+Contains the target architecture name (CPU and optional ABI). +

+ +

jit.opt.* — JIT compiler optimization control

+

+This module provides the backend for the -O command line +option. +

+

+You can also use it programmatically, e.g.: +

+
+jit.opt.start(2) -- same as -O2
+jit.opt.start("-dce")
+jit.opt.start("hotloop=10", "hotexit=2")
+
+

+Unlike in LuaJIT 1.x, the module is built-in and +optimization is turned on by default! +It's no longer necessary to run require("jit.opt").start(), +which was one of the ways to enable optimization. +

+ +

jit.util.* — JIT compiler introspection

+

+This module holds functions to introspect the bytecode, generated +traces, the IR and the generated machine code. The functionality +provided by this module is still in flux and therefore undocumented. +

+

+The debug modules -jbc, -jv and -jdump make +extensive use of these functions. Please check out their source code, +if you want to know more. +

+
+
+ + + diff --git a/doc/bluequad-print.css b/doc/bluequad-print.css new file mode 100644 index 00000000..00a6b154 --- /dev/null +++ b/doc/bluequad-print.css @@ -0,0 +1,166 @@ +/* Copyright (C) 2004-2009 Mike Pall. + * + * You are welcome to use the general ideas of this design for your own sites. + * But please do not steal the stylesheet, the layout or the color scheme. + */ +body { + font-family: serif; + font-size: 11pt; + margin: 0 3em; + padding: 0; + border: none; +} +a:link, a:visited, a:hover, a:active { + text-decoration: none; + background: transparent; + color: #0000ff; +} +h1, h2, h3 { + font-family: sans-serif; + font-weight: bold; + text-align: left; + margin: 0.5em 0; + padding: 0; +} +h1 { + font-size: 200%; +} +h2 { + font-size: 150%; +} +h3 { + font-size: 125%; +} +p { + margin: 0 0 0.5em 0; + padding: 0; +} +ul, ol { + margin: 0.5em 0; + padding: 0 0 0 2em; +} +ul { + list-style: outside square; +} +ol { + list-style: outside decimal; +} +li { + margin: 0; + padding: 0; +} +dl { + margin: 1em 0; + padding: 1em; + border: 1px solid black; +} +dt { + font-weight: bold; + margin: 0; + padding: 0; +} +dt sup { + float: right; + margin-left: 1em; +} +dd { + margin: 0.5em 0 0 2em; + padding: 0; +} +table { + table-layout: fixed; + width: 100%; + margin: 1em 0; + padding: 0; + border: 1px solid black; + border-spacing: 0; + border-collapse: collapse; +} +tr { + margin: 0; + padding: 0; + border: none; +} +td { + text-align: left; + margin: 0; + padding: 0.2em 0.5em; + border-top: 1px solid black; + border-bottom: 1px solid black; +} +tr.separate td { + border-top: double; +} +tt, pre, code, kbd, samp { + font-family: monospace; + font-size: 75%; +} +kbd { + font-weight: bolder; +} +blockquote, pre { + margin: 1em 2em; + padding: 0; +} +img { + border: none; + vertical-align: baseline; + margin: 0; + padding: 0; +} +img.left { + float: left; + margin: 0.5em 1em 0.5em 0; +} +img.right { + float: right; + margin: 0.5em 0 0.5em 1em; +} +.flush { + clear: both; + visibility: hidden; +} +.hide, .noprint, #nav { + display: none !important; +} +.pagebreak { + page-break-before: always; +} +#site { + text-align: right; + font-family: sans-serif; + font-weight: bold; + margin: 0 1em; + border-bottom: 1pt solid black; +} +#site a { + font-size: 1.2em; +} +#site a:link, #site a:visited { + text-decoration: none; + font-weight: bold; + background: transparent; + color: #ffffff; +} +#logo { + color: #ff8000; +} +#head { + clear: both; + margin: 0 1em; +} +#main { + line-height: 1.3; + text-align: justify; + margin: 1em; +} +#foot { + clear: both; + font-size: 80%; + text-align: center; + margin: 0 1.25em; + padding: 0.5em 0 0 0; + border-top: 1pt solid black; + page-break-before: avoid; + page-break-after: avoid; +} diff --git a/doc/bluequad.css b/doc/bluequad.css new file mode 100644 index 00000000..7e52102f --- /dev/null +++ b/doc/bluequad.css @@ -0,0 +1,303 @@ +/* Copyright (C) 2004-2009 Mike Pall. + * + * You are welcome to use the general ideas of this design for your own sites. + * But please do not steal the stylesheet, the layout or the color scheme. + */ +/* colorscheme: + * + * site | head #4162bf/white | #6078bf/#e6ecff + * ------+------ ----------------+------------------- + * nav | main #bfcfff | #e6ecff/black + * + * nav: hiback loback #c5d5ff #b9c9f9 + * hiborder loborder #e6ecff #97a7d7 + * link hover #2142bf #ff0000 + * + * link: link visited hover #2142bf #8122bf #ff0000 + * + * main: boxback boxborder #f0f4ff #bfcfff + */ +body { + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 10pt; + margin: 0; + padding: 0; + border: none; + background: #e0e0e0; + color: #000000; +} +a:link { + text-decoration: none; + background: transparent; + color: #2142bf; +} +a:visited { + text-decoration: none; + background: transparent; + color: #8122bf; +} +a:hover, a:active { + text-decoration: underline; + background: transparent; + color: #ff0000; +} +h1, h2, h3 { + font-weight: bold; + text-align: left; + margin: 0.5em 0; + padding: 0; + background: transparent; +} +h1 { + font-size: 200%; + line-height: 3em; /* really 6em relative to body, match #site span */ + margin: 0; +} +h2 { + font-size: 150%; + color: #606060; +} +h3 { + font-size: 125%; + color: #404040; +} +p { + max-width: 600px; + margin: 0 0 0.5em 0; + padding: 0; +} +b { + color: #404040; +} +ul, ol { + max-width: 600px; + margin: 0.5em 0; + padding: 0 0 0 2em; +} +ul { + list-style: outside square; +} +ol { + list-style: outside decimal; +} +li { + margin: 0; + padding: 0; +} +dl { + max-width: 600px; + margin: 1em 0; + padding: 1em; + border: 1px solid #bfcfff; + background: #f0f4ff; +} +dt { + font-weight: bold; + margin: 0; + padding: 0; +} +dt sup { + float: right; + margin-left: 1em; + color: #808080; +} +dt a:visited { + text-decoration: none; + color: #2142bf; +} +dt a:hover, dt a:active { + text-decoration: none; + color: #ff0000; +} +dd { + margin: 0.5em 0 0 2em; + padding: 0; +} +div.tablewrap { /* for IE *sigh* */ + max-width: 600px; +} +table { + table-layout: fixed; + border-spacing: 0; + border-collapse: collapse; + max-width: 600px; + width: 100%; + margin: 1em 0; + padding: 0; + border: 1px solid #bfcfff; +} +tr { + margin: 0; + padding: 0; + border: none; +} +tr.odd { + background: #f0f4ff; +} +tr.separate td { + border-top: 1px solid #bfcfff; +} +td { + text-align: left; + margin: 0; + padding: 0.2em 0.5em; + border: none; +} +tt, code, kbd, samp { + font-family: Courier New, Courier, monospace; + line-height: 1.2; + font-size: 110%; +} +kbd { + font-weight: bolder; +} +blockquote, pre { + max-width: 600px; + margin: 1em 2em; + padding: 0; +} +pre { + line-height: 1.1; +} +pre.code { + line-height: 1.4; + margin: 0.5em 0 1em 0.5em; + padding: 0.5em 1em; + border: 1px solid #bfcfff; + background: #f0f4ff; +} +img { + border: none; + vertical-align: baseline; + margin: 0; + padding: 0; +} +img.left { + float: left; + margin: 0.5em 1em 0.5em 0; +} +img.right { + float: right; + margin: 0.5em 0 0.5em 1em; +} +.indent { + padding-left: 1em; +} +.flush { + clear: both; + visibility: hidden; +} +.hide, .noscreen { + display: none !important; +} +.ext { + color: #ff8000; +} +#site { + clear: both; + float: left; + width: 13em; + text-align: center; + font-weight: bold; + margin: 0; + padding: 0; + background: transparent; + color: #ffffff; +} +#site a { + font-size: 200%; +} +#site a:link, #site a:visited { + text-decoration: none; + font-weight: bold; + background: transparent; + color: #ffffff; +} +#site span { + line-height: 3em; /* really 6em relative to body, match h1 */ +} +#logo { + color: #ffb380; +} +#head { + margin: 0; + padding: 0 0 0 2em; + border-left: solid 13em #4162bf; + border-right: solid 3em #6078bf; + background: #6078bf; + color: #e6ecff; +} +#nav { + clear: both; + float: left; + overflow: hidden; + text-align: left; + line-height: 1.5; + width: 13em; + padding-top: 1em; + background: transparent; +} +#nav ul { + list-style: none outside; + margin: 0; + padding: 0; +} +#nav li { + margin: 0; + padding: 0; +} +#nav a { + display: block; + text-decoration: none; + font-weight: bold; + margin: 0; + padding: 2px 1em; + border-top: 1px solid transparent; + border-bottom: 1px solid transparent; + background: transparent; + color: #2142bf; +} +#nav a:hover, #nav a:active { + text-decoration: none; + border-top: 1px solid #97a7d7; + border-bottom: 1px solid #e6ecff; + background: #b9c9f9; + color: #ff0000; +} +#nav a.current, #nav a.current:hover, #nav a.current:active { + border-top: 1px solid #e6ecff; + border-bottom: 1px solid #97a7d7; + background: #c5d5ff; + color: #2142bf; +} +#nav ul ul a { + padding: 0 1em 0 2em; +} +#main { + line-height: 1.5; + text-align: left; + margin: 0; + padding: 1em 2em; + border-left: solid 13em #bfcfff; + border-right: solid 3em #e6ecff; + background: #e6ecff; +} +#foot { + clear: both; + font-size: 80%; + text-align: center; + margin: 0; + padding: 0.5em; + background: #6078bf; + color: #ffffff; +} +#foot a:link, #foot a:visited { + text-decoration: underline; + background: transparent; + color: #ffffff; +} +#foot a:hover, #foot a:active { + text-decoration: underline; + background: transparent; + color: #bfcfff; +} diff --git a/doc/changes.html b/doc/changes.html new file mode 100644 index 00000000..6c34b8be --- /dev/null +++ b/doc/changes.html @@ -0,0 +1,281 @@ + + + +LuaJIT Change History + + + + + + + + + +
+Lua +
+ + +
+

+This is a list of changes between the released versions of LuaJIT.
+The current development version is LuaJIT 2.0.0-beta1.
+The current stable version is LuaJIT 1.1.5. +

+

+Please check the +» Online Change History +to see whether newer versions are available. +

+ +
+

LuaJIT 2.0.0-beta1 — 2009-10-31

+
    +
  • This is the first public release of LuaJIT 2.0.
    • +
  • The whole VM has been rewritten from the ground up, so there's +no point in listing differences over earlier versions.
    • +
+
+ +
+

LuaJIT 1.1.5 — 2008-10-25

+ + +

LuaJIT 1.1.4 — 2008-02-05

+
    +
  • Merged with Lua 5.1.3. Fixes all +» known bugs in Lua 5.1.2.
    • +
  • Fixed possible (but unlikely) stack corruption while compiling +k^x expressions.
    • +
  • Fixed DynASM template for cmpss instruction.
    • +
+ +

LuaJIT 1.1.3 — 2007-05-24

+
    +
  • Merged with Lua 5.1.2. Fixes all +» known bugs in Lua 5.1.1.
    • +
  • Merged pending Lua 5.1.x fixes: "return -nil" bug, spurious count hook call.
    • +
  • Remove a (sometimes) wrong assertion in luaJIT_findpc().
    • +
  • DynASM now allows labels for displacements and .aword.
    • +
  • Fix some compiler warnings for DynASM glue (internal API change).
    • +
  • Correct naming for SSSE3 (temporarily known as SSE4) in DynASM and x86 disassembler.
    • +
  • The loadable debug modules now handle redirection to stdout +(e.g. -j trace=-).
    • +
+ +

LuaJIT 1.1.2 — 2006-06-24

+
    +
  • Fix MSVC inline assembly: use only local variables with +lua_number2int().
    • +
  • Fix "attempt to call a thread value" bug on Mac OS X: +make values of consts used as lightuserdata keys unique +to avoid joining by the compiler/linker.
    • +
+ +

LuaJIT 1.1.1 — 2006-06-20

+
    +
  • Merged with Lua 5.1.1. Fixes all +» known bugs in Lua 5.1.
    • +
  • Enforce (dynamic) linker error for EXE/DLL version mismatches.
    • +
  • Minor changes to DynASM: faster preprocessing, smaller encoding +for some immediates.
    • +
+

+This release is in sync with Coco 1.1.1 (see the +» Coco Change History). +

+ +

LuaJIT 1.1.0 — 2006-03-13

+
    +
  • Merged with Lua 5.1 (final).
    • + +
  • New JIT call frame setup: +
      +
    • The C stack is kept 16 byte aligned (faster). +Mandatory for Mac OS X on Intel, too.
      • +
    • Faster calling conventions for internal C helper functions.
      • +
    • Better instruction scheduling for function prologue, OP_CALL and +OP_RETURN.
      • +
    • + +
  • Miscellaneous optimizations: +
      +
    • Faster loads of FP constants. Remove narrow-to-wide store-to-load +forwarding stalls.
      • +
    • Use (scalar) SSE2 ops (if the CPU supports it) to speed up slot moves +and FP to integer conversions.
      • +
    • Optimized the two-argument form of OP_CONCAT (a..b).
      • +
    • Inlined OP_MOD (a%b). +With better accuracy than the C variant, too.
      • +
    • Inlined OP_POW (a^b). Unroll x^k or +use k^x = 2^(log2(k)*x) or call pow().
      • +
    • + +
  • Changes in the optimizer: +
      +
    • Improved hinting for table keys derived from table values +(t1[t2[x]]).
      • +
    • Lookup hinting now works with arbitrary object types and +supports index chains, too.
      • +
    • Generate type hints for arithmetic and comparison operators, +OP_LEN, OP_CONCAT and OP_FORPREP.
      • +
    • Remove several hint definitions in favour of a generic COMBINE hint.
      • +
    • Complete rewrite of jit.opt_inline module +(ex jit.opt_lib).
      • +
    • + +
  • Use adaptive deoptimization: +
      +
    • If runtime verification of a contract fails, the affected +instruction is recompiled and patched on-the-fly. +Regular programs will trigger deoptimization only occasionally.
      • +
    • This avoids generating code for uncommon fallback cases +most of the time. Generated code is up to 30% smaller compared to +LuaJIT 1.0.3.
      • +
    • Deoptimization is used for many opcodes and contracts: +
        +
      • OP_CALL, OP_TAILCALL: type mismatch for callable.
        • +
      • Inlined calls: closure mismatch, parameter number and type mismatches.
        • +
      • OP_GETTABLE, OP_SETTABLE: table or key type and range mismatches.
        • +
      • All arithmetic and comparison operators, OP_LEN, OP_CONCAT, +OP_FORPREP: operand type and range mismatches.
        • +
      • +
    • Complete redesign of the debug and traceback info +(bytecode ↔ mcode) to support deoptimization. +Much more flexible and needs only 50% of the space.
      • +
    • The modules jit.trace, jit.dumphints and +jit.dump handle deoptimization.
      • +
    • + +
  • Inlined many popular library functions +(for commonly used arguments only): +
      +
    • Most math.* functions (the 18 most used ones) +[2x-10x faster].
      • +
    • string.len, string.sub and string.char +[2x-10x faster].
      • +
    • table.insert, table.remove and table.getn +[3x-5x faster].
      • +
    • coroutine.yield and coroutine.resume +[3x-5x faster].
      • +
    • pairs, ipairs and the corresponding iterators +[8x-15x faster].
      • +
    • + +
  • Changes in the core and loadable modules and the stand-alone executable: +
      +
    • Added jit.version, jit.version_num +and jit.arch.
      • +
    • Reorganized some internal API functions (jit.util.*mcode*).
      • +
    • The -j dump output now shows JSUB names, too.
      • +
    • New x86 disassembler module written in pure Lua. No dependency +on ndisasm anymore. Flexible API, very compact (500 lines) +and complete (x87, MMX, SSE, SSE2, SSE3, SSSE3, privileged instructions).
      • +
    • luajit -v prints the LuaJIT version and copyright +on a separate line.
      • +
    • + +
  • Added SSE, SSE2, SSE3 and SSSE3 support to DynASM.
    • +
  • Miscellaneous doc changes. Added a section about +embedding LuaJIT.
    • +
+

+This release is in sync with Coco 1.1.0 (see the +» Coco Change History). +

+
+ +
+

LuaJIT 1.0.3 — 2005-09-08

+
    +
  • Even more docs.
    • +
  • Unified closure checks in jit.*.
    • +
  • Fixed some range checks in jit.util.*.
    • +
  • Fixed __newindex call originating from jit_settable_str().
    • +
  • Merged with Lua 5.1 alpha (including early bugfixes).
    • +
+

+This is the first public release of LuaJIT. +

+ +

LuaJIT 1.0.2 — 2005-09-02

+
    +
  • Add support for flushing the Valgrind translation cache
    +(MYCFLAGS= -DUSE_VALGRIND).
    • +
  • Add support for freeing executable mcode memory to the mmap()-based +variant for POSIX systems.
    • +
  • Reorganized the C function signature handling in +jit.opt_lib.
    • +
  • Changed to index-based hints for inlining C functions. +Still no support in the backend for inlining.
    • +
  • Hardcode HEAP_CREATE_ENABLE_EXECUTE value if undefined.
    • +
  • Misc. changes to the jit.* modules.
    • +
  • Misc. changes to the Makefiles.
    • +
  • Lots of new docs.
    • +
  • Complete doc reorg.
    • +
+

+Not released because Lua 5.1 alpha came out today. +

+ +

LuaJIT 1.0.1 — 2005-08-31

+
    +
  • Missing GC step in OP_CONCAT.
    • +
  • Fix result handling for C –> JIT calls.
    • +
  • Detect CPU feature bits.
    • +
  • Encode conditional moves (fucomip) only when supported.
    • +
  • Add fallback instructions for FP compares.
    • +
  • Add support for LUA_COMPAT_VARARG. Still disabled by default.
    • +
  • MSVC needs a specific place for the CALLBACK attribute +(David Burgess).
    • +
  • Misc. doc updates.
    • +
+

+Interim non-public release. +Special thanks to Adam D. Moss for reporting most of the bugs. +

+ +

LuaJIT 1.0.0 — 2005-08-29

+

+This is the initial non-public release of LuaJIT. +

+
+
+
+ + + diff --git a/doc/contact.html b/doc/contact.html new file mode 100644 index 00000000..36d5a825 --- /dev/null +++ b/doc/contact.html @@ -0,0 +1,84 @@ + + + +Contact + + + + + + + + +
+Lua +
+ + +
+

+Please send general questions to the +» Lua mailing list. +You can also send any questions you have directly to me: +

+ + + + + +

Copyright

+

+All documentation is +Copyright © 2005-2009 Mike Pall. +

+ + +
+
+ + + diff --git a/doc/faq.html b/doc/faq.html new file mode 100644 index 00000000..6f62e1eb --- /dev/null +++ b/doc/faq.html @@ -0,0 +1,141 @@ + + + +Frequently Asked Questions (FAQ) + + + + + + + + + +
+Lua +
+ + +
+
+
Q: Where can I learn more about Lua and LuaJIT?
+
+ +
+ +
+
Q: Where can I learn more about the compiler technology used by LuaJIT?
+
+I'm planning to write more documentation about the internals of LuaJIT. +In the meantime, please use the following Google Scholar searches +to find relevant papers:
+Search for: » Trace Compiler
+Search for: » JIT Compiler
+Search for: » Dynamic Language Optimizations
+Search for: » SSA Form
+Search for: » Linear Scan Register Allocation
+And, you know, reading the source is of course the only way to enlightenment. :-) +
+
+ +
+
Q: Why do I get this error: "attempt to index global 'arg' (a nil value)"?
+Q: My vararg functions fail after switching to LuaJIT!
+
LuaJIT is compatible to the Lua 5.1 language standard. It doesn't +support the implicit arg parameter for old-style vararg +functions from Lua 5.0.
Please convert your code to the +» Lua 5.1 +vararg syntax.
+
+ +
+
Q: Sometimes Ctrl-C fails to stop my Lua program. Why?
+
The interrupt signal handler sets a Lua debug hook. But this is +currently ignored by compiled code (this will eventually be fixed). If +your program is running in a tight loop and never falls back to the +interpreter, the debug hook never runs and can't throw the +"interrupted!" error.
In the meantime you have to press Ctrl-C +twice to get stop your program. That's similar to when it's stuck +running inside a C function under the Lua interpreter.
+
+ +
+
Q: Why doesn't my favorite power-patch for Lua apply against LuaJIT?
+
Because it's a completely redesigned VM and has very little code +in common with Lua anymore. Also, if the patch introduces changes to +the Lua semantics, this would need to be reflected everywhere in the +VM, from the interpreter up to all stages of the compiler.
Please +use only standard Lua language constructs. For many common needs you +can use source transformations or use wrapper or proxy functions. +The compiler will happily optimize away such indirections.
+
+ +
+
Q: Lua runs everywhere. Why doesn't LuaJIT support my CPU?
+
Because it's a compiler — it needs to generate native +machine code. This means the code generator must be ported to each +architecture. And the fast interpreter is written in assembler and +must be ported, too. This is quite an undertaking.
Currently only +x86 CPUs are supported. x64 support is in the works. Other +architectures will follow with sufficient demand and/or +sponsoring.
+
+ +
+
Q: When will feature X be added? When will the next version be released?
+
When it's ready.
+C'mon, it's open source — I'm doing it on my own time and you're +getting it for free. You can either contribute a patch or sponsor +the development of certain features, if they are important to you. +
+
+
+
+ + + diff --git a/doc/img/contact.png b/doc/img/contact.png new file mode 100644 index 00000000..9c73dc59 Binary files /dev/null and b/doc/img/contact.png differ diff --git a/doc/install.html b/doc/install.html new file mode 100644 index 00000000..b7211d21 --- /dev/null +++ b/doc/install.html @@ -0,0 +1,216 @@ + + + +Installation + + + + + + + + +
+Lua +
+ + +
+

+LuaJIT is only distributed as a source package. This page explains +how to build and install LuaJIT with different operating systems +and C compilers. +

+

+For the impatient (on POSIX systems): +

+
+make && sudo make install
+
+

+LuaJIT currently builds out-of-the box on all popular x86 systems +(Linux, Windows, OSX etc.). It builds and runs fine as a 32 bit +application under x64-based systems, too. +

+ +

Configuring LuaJIT

+

+The standard configuration should work fine for most installations. +Usually there is no need to tweak the settings, except when you want to +install to a non-standard path. The following three files hold all +user-configurable settings: +

+ +

+Please read the instructions given in these files, before changing +any settings. +

+ +

POSIX Systems (Linux, OSX, *BSD etc.)

+

Prerequisites

+

+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 +complete SDK. +

+

+E.g. on a current Debian/Ubuntu, install libc6-dev +with the package manager. Currently LuaJIT only builds as a 32 bit +application, so you actually need to install libc6-dev-i386 +when building on an x64 OS. +

+

+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: +

+
+tar zxf LuaJIT-2.0.0-beta1.tar.gz
+cd LuaJIT-2.0.0-beta1
+
+

Building LuaJIT

+

+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: +

+
+make
+
+

Installing LuaJIT

+

+The top-level Makefile installs LuaJIT by default under +/usr/local, i.e. the executable ends up in +/usr/local/bin and so on. You need to have root privileges +to write to this path. So, assuming sudo is installed on your system, +run the following command and enter your sudo password: +

+
+sudo make install
+
+

+Otherwise specify the directory prefix as an absolute path, e.g.: +

+
+sudo make install PREFIX=/opt/lj2
+
+

+But note that the installation prefix and the prefix for the module paths +(configured in src/luaconf.h) must match. +

+

+Note: to avoid overwriting a previous version, the beta test releases +only install the LuaJIT executable under the versioned name (i.e. +luajit-2.0.0-beta1). You probably want to create a symlink +for convenience, with a command like this: +

+
+sudo ln -sf luajit-2.0.0-beta1 /usr/local/bin/luajit
+
+ +

Windows Systems

+

Prerequisites

+

+Either install one of the open source SDKs +(» MinGW or +» Cygwin) which come with modified +versions of GCC plus the required development headers. +

+

+Or install Microsoft's Visual C++ (MSVC) — the freely downloadable +» Express Edition +works just fine. +

+

+Next, download the source package and unpack it using an archive manager +(e.g. the Windows Explorer) to a directory of your choice. +

+

Building with MSVC

+

+Open a "Visual Studio .NET Command Prompt" and cd to the +directory where you've unpacked the sources. Then run this command: +

+
+cd src
+msvcbuild
+
+

+Then follow the installation instructions below. +

+

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 where +you've unpacked the sources and run this command for MinGW: +

+
+cd src
+mingw32-make
+
+

+Or this command for Cygwin: +

+
+cd src
+make
+
+

+Then follow the installation instructions below. +

+

Installing LuaJIT

+

+Copy luajit.exe and lua51.dll +to a newly created directory (any location is ok). Add lua +and lua\jit directories below it and copy all Lua files +from the lib directory of the distribution to the latter directory. +

+

+There are no hardcoded +absolute path names — all modules are loaded relative to the +directory where luajit.exe is installed +(see src/luaconf.h). +

+
+
+ + + diff --git a/doc/luajit.html b/doc/luajit.html new file mode 100644 index 00000000..9b16ea37 --- /dev/null +++ b/doc/luajit.html @@ -0,0 +1,120 @@ + + + +LuaJIT + + + + + + + + +
+Lua +
+ + +
+

+LuaJIT is a Just-In-Time Compiler for the Lua* +programming language. +

+

+LuaJIT is Copyright © 2005-2008 Mike Pall. +LuaJIT is open source software, released under the +» MIT/X license. +

+

+* Lua is a powerful, dynamic and light-weight programming language +designed for extending applications. Lua is also frequently used as a +general-purpose, stand-alone language. More information about +Lua can be found at: » http://www.lua.org/ +

+

Compatibility

+

+LuaJIT implements the full set of language features defined by Lua 5.1. +The virtual machine (VM) is API- and ABI-compatible to the +standard Lua interpreter and can be deployed as a drop-in replacement. +

+

+LuaJIT offers more performance, at the expense of portability. It +currently runs on all popular operating systems based on x86 CPUs +(Linux, Windows, OSX etc.). It will be ported to x64 CPUs and other +platforms in the future, based on user demand and sponsoring. +

+ +

Overview

+

+LuaJIT has been successfully used as a scripting middleware in +games, 3D modellers, numerical simulations, trading platforms and many +other specialty applications. It combines high flexibility with high +performance and an unmatched low memory footprint: less than +120K for the VM plus less than 80K for the JIT compiler. +

+

+LuaJIT has been in continuous development since 2005. It's widely +considered to be one of the fastest dynamic language +implementations. It has outperfomed other dynamic languages on many +cross-language benchmarks since its first release — often by a +substantial margin. Only now, in 2009, other dynamic language VMs are +starting to catch up with the performance of LuaJIT 1.x … +

+

+2009 also marks the first release of the long-awaited LuaJIT 2.0. +The whole VM has been rewritten from the ground up and relentlessly +optimized for performance. It combines a high-speed interpreter, +written in assembler, with a state-of-the-art JIT compiler. +

+

+An innovative trace compiler is integrated with advanced, +SSA-based optimizations and a highly tuned code generation backend. This +allows a substantial reduction of the overhead associated with dynamic +language features. It's destined to break into the performance range +traditionally reserved for offline, static language compilers. +

+ +

More ...

+

+Click on the LuaJIT sub-topics in the navigation bar to learn more +about LuaJIT. +

+

+Click on the Logo in the upper left corner to visit +the LuaJIT project page on the web. All other links to online +resources are marked with a '»'. +

+
+
+ + + diff --git a/doc/running.html b/doc/running.html new file mode 100644 index 00000000..db69578c --- /dev/null +++ b/doc/running.html @@ -0,0 +1,233 @@ + + + +Running LuaJIT + + + + + + + + + +
+Lua +
+ + +
+

+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 +Lua statements or whole Lua applications from the command line. It has an +interactive mode, too. +

+

+Note: the beta test releases only install under the versioned name on +POSIX systems (to avoid overwriting a previous version). You either need +to type luajit-2.0.0-beta1 to start it or create a symlink +with a command like this: +

+
+sudo ln -sf luajit-2.0.0-beta1 /usr/local/bin/luajit
+
+

+Unlike previous versions optimization is turned on by default in +LuaJIT 2.0!
It's no longer necessary to use luajit -O. +

+ +

Command Line Options

+

+The luajit stand-alone executable is just a slightly modified +version of the regular lua stand-alone executable. +It supports the same basic options, too. luajit -h +prints a short list of the available options. Please have a look at the +» Lua manual +for details. +

+

+Two additional options control the behavior of LuaJIT: +

+ +

-j cmd[=arg[,arg...]]

+

+This option performs a LuaJIT control command or activates one of the +loadable extension modules. The command is first looked up in the +jit.* library. If no matching function is found, a module +named jit.<cmd> is loaded and the start() +function of the module is called with the specified arguments (if +any). The space between -j and cmd is optional. +

+

+Here are the available LuaJIT control commands: +

+ +

+The -jv and -jdump commands are extension modules +written in Lua. They are mainly used for debugging the JIT compiler +itself. For a description of their options and output format, please +read the comment block at the start of their source. +They can be found in the lib directory of the source +distribution or installed under the jit directory. By default +this is /usr/local/share/luajit-2.0.0-beta1/jit on POSIX +systems. +

+ +

-O[level]
+-O[+]flag -O-flag
+-Oparam=value

+

+This options allows fine-tuned control of the optimizations used by +the JIT compiler. This is mainly intended for debugging LuaJIT itself. +Please note that the JIT compiler is extremly fast (we are talking +about the microsecond to millisecond range). Disabling optimizations +doesn't have any visible impact on its overhead, but usually generates +code that runs slower. +

+

+The first form sets an optimization level — this enables a +specific mix of optimization flags. -O0 turns off all +optimizations and higher numbers enable more optimizations. Omitting +the level (i.e. just -O) sets the default optimization level, +which is -O3 in the current version. +

+

+The second form adds or removes individual optimization flags. +The third form sets a parameter for the VM or the JIT compiler +to a specific value. +

+

+You can either use this option multiple times (like -Ocse +-O-dce -Ohotloop=10) or separate several settings with a comma +(like -O+cse,-dce,hotloop=10). The settings are applied from +left to right and later settings override earlier ones. You can freely +mix the three forms, but note that setting an optimization level +overrides all earlier flags. +

+

+Here are the available flags and at what optimization levels they +are enabled: +

+ + + + + + + + + + + + + + + + + + + + + + + + +
Flag-O1-O2-O3 
fold•••Constant Folding, Simplifications and Reassociation
cse•••Common-Subexpression Elimination
dce•••Dead-Code Elimination
narrow ••Narrowing of numbers to integers
loop ••Loop Optimizations (code hoisting)
fwd  •Load Forwarding (L2L) and Store Forwarding (S2L)
dse  •Dead-Store Elimination
fuse  •Fusion of operands into instructions
+

+Here are the parameters and their default settings: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDefault 
maxtrace1000Max. number of traces in the cache
maxrecord2000Max. number of recorded IR instructions
maxirconst500Max. number of IR constants of a trace
maxside100Max. number of side traces of a root trace
maxsnap100Max. number of snapshots for a trace
hotloop57Number of iterations to detect a hot loop
hotexit10Number of taken exits to start a side trace
tryside4Number of attempts to compile a side trace
instunroll4Max. unroll factor for instable loops
loopunroll7Max. unroll factor for loop ops in side traces
callunroll3Max. unroll factor for pseudo-recursive calls
sizemcode32Size of each machine code area in KBytes (Windows: 64K)
maxmcode512Max. total size of all machine code areas in KBytes
+
+
+ + + diff --git a/doc/status.html b/doc/status.html new file mode 100644 index 00000000..23c14c76 --- /dev/null +++ b/doc/status.html @@ -0,0 +1,235 @@ + + + +Status & Roadmap + + + + + + + + + +
+Lua +
+ + +
+

+The LuaJIT 1.x series represents +the current stable branch. As of +this writing there have been no open bugs since about a year. So, if +you need a rock-solid VM, you are encouraged to fetch the latest +release of LuaJIT 1.x from the » Download +page. +

+

+LuaJIT 2.0 is the currently active +development branch. +It has Beta Test status and is still undergoing +substantial changes. It's expected to quickly mature within the next +months. You should definitely start to evaluate it for new projects +right now. But deploying it in production environments is not yet +recommended. +

+ +

Current Status

+

+This is a list of the things you should know about the LuaJIT 2.0 beta test: +

+ + +

Roadmap

+

+Rather than stating exact release dates (I'm well known for making +spectacularly wrong guesses), this roadmap lists the general project +plan, sorted by priority, as well as ideas for the future: +

+ +
+
+ + + -- cgit v1.2.3-55-g6feb