Source Optimizer

lua-users home

Lua Source Optimizer is a utility that optimizes Lua source code some, mainly by [inlining functions].


Inlining is a form of partial evaluation [1].


The code requires the [Metalua 0.5] (development branch).

It consists of these files:

Quick Start

Download tar file from .

tar xzvf fab13n-metalua-28e8e1037ab33d96c123667f4c3fc94b5aca83bc.tar.gz
mv fab13n-metalua-28e8e1037ab33d96c123667f4c3fc94b5aca83bc metalua
cd metalua && make

Download sourceoptimizer.mlua and place in metalua/build/lib/dmlib .
Download sourceoptimize.lua and place in metalua/ .
Download fib.lua example and place in metalua/ .

./build/bin/metalua sourceoptimize.lua fib.lua
# or
./build/bin/metalua sourceoptimize.lua fib.lua  | lua -


This is a basic example:

-- input:
local y=-1
local function square(x) return x*x end
local function g(x) return x >= 0 and square(square(x))+1 or 1 end
while (function() y = g(y)^(1/4) return y < 2 end)() do

-- output:
local y = - 1
while 1 do
   local __v13x = y
   local __v10 = 0 <= __v13x
   if __v10 then
      local __v12x = __v13x
      local __v14x = __v12x * __v12x
      __v10 = __v14x * __v14x + 1
   local __v11 = __v10
   if not __v11 then
      __v11 = 1
   y = __v11 ^ (1 / 4)
   if not (y < 2) then
   print (y)

Examples of inlining some of the Lua examples (after adding "local" before function names, which is required for inlining) are below:

Capability Notes

The code will inline anonymous functions that are immediately evaluated:

x=(function(x) return x*x end)(y())
--> local __v1x=y() x=__v1x*__v1x

and local functions that are "constant" (function variable never modified):

local function square(x) return x*x end; x=square(y())
--> local __v1x=y() x=__v1x*__v1x

It eliminates dead functions, such as functions that are fully inlined (as above). It correctly performs transformations to convert expressions into statements:

x = y or (function(x)z=1 return x*x end)(w)
--> local __v2=y if not __v2 then local __v1x=w z=1 __v2=__v1x*__v1x end x=__v2

if (function()x=x+1 return x end)() then f()
elseif (function()y=y+1 return y end)() then g()
else h() end
--> x=x+1 if x then f()else y=y+1 if y then g()else h()end end

Functions that use setfenv and stack levels with the debug library might not inline correctly. This potentially could occur on access to any global variable:

local function f() local _ = x end

In theory we should not inline the above function since the access to global variable x "might" trigger a metatable on the global environment, which in turn might alter the environment of f, so inlining f would alter the environment of f's caller. (Environments will not be an issue anymore in LuaFiveTwo, but some debug functions still utilize stack levels.) Ideally, the translator should be extended to support pragmas inside Lua comments that define how aggressive we want to inline:

local function f() local _ = x end

This could be on a per-function basis or can be a more global default setting in the file. (See luaanalyze in LuaFish for suggested syntax design.)

See source code of sourceoptimizer.mlua for further details.


Warning: may not work correctly for odd cases where inlined function uses setfenv or debug functions that utilize stack levels (see above). The getfenv/setfenv issue will be less significant in LuaFiveTwo.

Possible Applications

Possible Extensions



RecentChanges · preferences
edit · history
Last edited September 18, 2010 10:22 pm GMT (diff)