install.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  2. <html>
  3. <head>
  4. <title>Installation</title>
  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  6. <meta name="Author" content="Mike Pall">
  7. <meta name="Copyright" content="Copyright (C) 2005-2014, Mike Pall">
  8. <meta name="Language" content="en">
  9. <link rel="stylesheet" type="text/css" href="bluequad.css" media="screen">
  10. <link rel="stylesheet" type="text/css" href="bluequad-print.css" media="print">
  11. <style type="text/css">
  12. table.compat {
  13. line-height: 1.2;
  14. font-size: 80%;
  15. }
  16. table.compat td {
  17. border: 1px solid #bfcfff;
  18. height: 2.5em;
  19. }
  20. table.compat tr.compathead td {
  21. font-weight: bold;
  22. border-bottom: 2px solid #bfcfff;
  23. }
  24. tr.compathead td.compatos {
  25. vertical-align: top;
  26. }
  27. table.compat td.compatcpu {
  28. width: 18%;
  29. border-right: 2px solid #bfcfff;
  30. }
  31. td.compatos {
  32. width: 21%;
  33. vertical-align: middle;
  34. }
  35. td.compatno {
  36. background-color: #d0d0d0;
  37. }
  38. </style>
  39. </head>
  40. <body>
  41. <div id="site">
  42. <a href="http://luajit.org"><span>Lua<span id="logo">JIT</span></span></a>
  43. </div>
  44. <div id="head">
  45. <h1>Installation</h1>
  46. </div>
  47. <div id="nav">
  48. <ul><li>
  49. <a href="luajit.html">LuaJIT</a>
  50. <ul><li>
  51. <a href="http://luajit.org/download.html">Download <span class="ext">&raquo;</span></a>
  52. </li><li>
  53. <a class="current" href="install.html">Installation</a>
  54. </li><li>
  55. <a href="running.html">Running</a>
  56. </li></ul>
  57. </li><li>
  58. <a href="extensions.html">Extensions</a>
  59. <ul><li>
  60. <a href="ext_ffi.html">FFI Library</a>
  61. <ul><li>
  62. <a href="ext_ffi_tutorial.html">FFI Tutorial</a>
  63. </li><li>
  64. <a href="ext_ffi_api.html">ffi.* API</a>
  65. </li><li>
  66. <a href="ext_ffi_semantics.html">FFI Semantics</a>
  67. </li></ul>
  68. </li><li>
  69. <a href="ext_jit.html">jit.* Library</a>
  70. </li><li>
  71. <a href="ext_c_api.html">Lua/C API</a>
  72. </li><li>
  73. <a href="ext_profiler.html">Profiler</a>
  74. </li></ul>
  75. </li><li>
  76. <a href="status.html">Status</a>
  77. <ul><li>
  78. <a href="changes.html">Changes</a>
  79. </li></ul>
  80. </li><li>
  81. <a href="faq.html">FAQ</a>
  82. </li><li>
  83. <a href="http://luajit.org/performance.html">Performance <span class="ext">&raquo;</span></a>
  84. </li><li>
  85. <a href="http://wiki.luajit.org/">Wiki <span class="ext">&raquo;</span></a>
  86. </li><li>
  87. <a href="http://luajit.org/list.html">Mailing List <span class="ext">&raquo;</span></a>
  88. </li></ul>
  89. </div>
  90. <div id="main">
  91. <p>
  92. LuaJIT is only distributed as a source package. This page explains
  93. how to build and install LuaJIT with different operating systems
  94. and C&nbsp;compilers.
  95. </p>
  96. <p>
  97. For the impatient (on POSIX systems):
  98. </p>
  99. <pre class="code">
  100. make &amp;&amp; sudo make install
  101. </pre>
  102. <p>
  103. LuaJIT currently builds out-of-the box on most systems.
  104. Here's the compatibility matrix for the supported combinations of
  105. operating systems, CPUs and compilers:
  106. </p>
  107. <table class="compat">
  108. <tr class="compathead">
  109. <td class="compatcpu">CPU / OS</td>
  110. <td class="compatos"><a href="#posix">Linux</a> or<br><a href="#android">Android</a></td>
  111. <td class="compatos"><a href="#posix">*BSD, Other</a></td>
  112. <td class="compatos"><a href="#posix">OSX 10.4+</a> or<br><a href="#ios">iOS 3.0+</a></td>
  113. <td class="compatos"><a href="#windows">Windows<br>XP/Vista/7</a></td>
  114. </tr>
  115. <tr class="odd separate">
  116. <td class="compatcpu">x86 (32 bit)</td>
  117. <td class="compatos">GCC 4.x<br>GCC 3.4</td>
  118. <td class="compatos">GCC 4.x<br>GCC 3.4</td>
  119. <td class="compatos">GCC 4.x<br>GCC 3.4</td>
  120. <td class="compatos">MSVC, MSVC/EE<br>WinSDK<br>MinGW, Cygwin</td>
  121. </tr>
  122. <tr class="even">
  123. <td class="compatcpu">x64 (64 bit)</td>
  124. <td class="compatos">GCC 4.x</td>
  125. <td class="compatos">ORBIS (<a href="#ps4">PS4</a>)</td>
  126. <td class="compatos">GCC 4.x</td>
  127. <td class="compatos">MSVC + SDK v7.0<br>WinSDK v7.0</td>
  128. </tr>
  129. <tr class="odd">
  130. <td class="compatcpu"><a href="#cross2">ARMv5+<br>ARM9E+</a></td>
  131. <td class="compatos">GCC 4.2+</td>
  132. <td class="compatos">GCC 4.2+<br>PSP2 (<a href="#psvita">PS VITA</a>)</td>
  133. <td class="compatos">GCC 4.2+</td>
  134. <td class="compatos compatno">&nbsp;</td>
  135. </tr>
  136. <tr class="even">
  137. <td class="compatcpu"><a href="#cross2">PPC</a></td>
  138. <td class="compatos">GCC 4.3+</td>
  139. <td class="compatos">GCC 4.3+<br>GCC 4.1 (<a href="#ps3">PS3</a>)</td>
  140. <td class="compatos compatno">&nbsp;</td>
  141. <td class="compatos">XEDK (<a href="#xbox360">Xbox 360</a>)</td>
  142. </tr>
  143. <tr class="odd">
  144. <td class="compatcpu"><a href="#cross2">MIPS</a></td>
  145. <td class="compatos">GCC 4.3+</td>
  146. <td class="compatos">GCC 4.3+</td>
  147. <td class="compatos compatno">&nbsp;</td>
  148. <td class="compatos compatno">&nbsp;</td>
  149. </tr>
  150. </table>
  151. <h2>Configuring LuaJIT</h2>
  152. <p>
  153. The standard configuration should work fine for most installations.
  154. Usually there is no need to tweak the settings. The following files
  155. hold all user-configurable settings:
  156. </p>
  157. <ul>
  158. <li><tt>src/luaconf.h</tt> sets some configuration variables.</li>
  159. <li><tt>Makefile</tt> has settings for <b>installing</b> LuaJIT (POSIX
  160. only).</li>
  161. <li><tt>src/Makefile</tt> has settings for <b>compiling</b> LuaJIT
  162. under POSIX, MinGW or Cygwin.</li>
  163. <li><tt>src/msvcbuild.bat</tt> has settings for compiling LuaJIT with
  164. MSVC or WinSDK.</li>
  165. </ul>
  166. <p>
  167. Please read the instructions given in these files, before changing
  168. any settings.
  169. </p>
  170. <h2 id="posix">POSIX Systems (Linux, OSX, *BSD etc.)</h2>
  171. <h3>Prerequisites</h3>
  172. <p>
  173. Depending on your distribution, you may need to install a package for
  174. GCC, the development headers and/or a complete SDK. E.g. on a current
  175. Debian/Ubuntu, install <tt>libc6-dev</tt> with the package manager.
  176. </p>
  177. <p>
  178. Download the current source package of LuaJIT (pick the .tar.gz),
  179. if you haven't already done so. Move it to a directory of your choice,
  180. open a terminal window and change to this directory. Now unpack the archive
  181. and change to the newly created directory:
  182. </p>
  183. <pre class="code">
  184. tar zxf LuaJIT-2.0.3.tar.gz
  185. cd LuaJIT-2.0.3</pre>
  186. <h3>Building LuaJIT</h3>
  187. <p>
  188. The supplied Makefiles try to auto-detect the settings needed for your
  189. operating system and your compiler. They need to be run with GNU Make,
  190. which is probably the default on your system, anyway. Simply run:
  191. </p>
  192. <pre class="code">
  193. make
  194. </pre>
  195. <p>
  196. This always builds a native x86, x64 or PPC binary, depending on the host OS
  197. you're running this command on. Check the section on
  198. <a href="#cross">cross-compilation</a> for more options.
  199. </p>
  200. <p>
  201. By default, modules are only searched under the prefix <tt>/usr/local</tt>.
  202. You can add an extra prefix to the search paths by appending the
  203. <tt>PREFIX</tt> option, e.g.:
  204. </p>
  205. <pre class="code">
  206. make PREFIX=/home/myself/lj2
  207. </pre>
  208. <p>
  209. Note for OSX: if the <tt>MACOSX_DEPLOYMENT_TARGET</tt> environment
  210. variable is not set, then it's forced to <tt>10.4</tt>.
  211. </p>
  212. <h3>Installing LuaJIT</h3>
  213. <p>
  214. The top-level Makefile installs LuaJIT by default under
  215. <tt>/usr/local</tt>, i.e. the executable ends up in
  216. <tt>/usr/local/bin</tt> and so on. You need root privileges
  217. to write to this path. So, assuming sudo is installed on your system,
  218. run the following command and enter your sudo password:
  219. </p>
  220. <pre class="code">
  221. sudo make install
  222. </pre>
  223. <p>
  224. Otherwise specify the directory prefix as an absolute path, e.g.:
  225. </p>
  226. <pre class="code">
  227. make install PREFIX=/home/myself/lj2
  228. </pre>
  229. <p>
  230. Obviously the prefixes given during build and installation need to be the same.
  231. </p>
  232. <h2 id="windows">Windows Systems</h2>
  233. <h3>Prerequisites</h3>
  234. <p>
  235. Either install one of the open source SDKs
  236. (<a href="http://mingw.org/"><span class="ext">&raquo;</span>&nbsp;MinGW</a> or
  237. <a href="http://www.cygwin.com/"><span class="ext">&raquo;</span>&nbsp;Cygwin</a>), which come with a modified
  238. GCC plus the required development headers.
  239. </p>
  240. <p>
  241. Or install Microsoft's Visual C++ (MSVC). The freely downloadable
  242. <a href="http://www.microsoft.com/Express/VC/"><span class="ext">&raquo;</span>&nbsp;Express Edition</a>
  243. works just fine, but only contains an x86 compiler.
  244. </p>
  245. <p>
  246. The freely downloadable
  247. <a href="http://msdn.microsoft.com/en-us/windowsserver/bb980924.aspx"><span class="ext">&raquo;</span>&nbsp;Windows SDK</a>
  248. only comes with command line tools, but this is all you need to build LuaJIT.
  249. It contains x86 and x64 compilers.
  250. </p>
  251. <p>
  252. Next, download the source package and unpack it using an archive manager
  253. (e.g. the Windows Explorer) to a directory of your choice.
  254. </p>
  255. <h3>Building with MSVC</h3>
  256. <p>
  257. Open a "Visual Studio .NET Command Prompt", <tt>cd</tt> to the
  258. directory where you've unpacked the sources and run these commands:
  259. </p>
  260. <pre class="code">
  261. cd src
  262. msvcbuild
  263. </pre>
  264. <p>
  265. Then follow the installation instructions below.
  266. </p>
  267. <h3>Building with the Windows SDK</h3>
  268. <p>
  269. Open a "Windows SDK Command Shell" and select the x86 compiler:
  270. </p>
  271. <pre class="code">
  272. setenv /release /x86
  273. </pre>
  274. <p>
  275. Or select the x64 compiler:
  276. </p>
  277. <pre class="code">
  278. setenv /release /x64
  279. </pre>
  280. <p>
  281. Then <tt>cd</tt> to the directory where you've unpacked the sources
  282. and run these commands:
  283. </p>
  284. <pre class="code">
  285. cd src
  286. msvcbuild
  287. </pre>
  288. <p>
  289. Then follow the installation instructions below.
  290. </p>
  291. <h3>Building with MinGW or Cygwin</h3>
  292. <p>
  293. Open a command prompt window and make sure the MinGW or Cygwin programs
  294. are in your path. Then <tt>cd</tt> to the directory where
  295. you've unpacked the sources and run this command for MinGW:
  296. </p>
  297. <pre class="code">
  298. mingw32-make
  299. </pre>
  300. <p>
  301. Or this command for Cygwin:
  302. </p>
  303. <pre class="code">
  304. make
  305. </pre>
  306. <p>
  307. Then follow the installation instructions below.
  308. </p>
  309. <h3>Installing LuaJIT</h3>
  310. <p>
  311. Copy <tt>luajit.exe</tt> and <tt>lua51.dll</tt> (built in the <tt>src</tt>
  312. directory) to a newly created directory (any location is ok).
  313. Add <tt>lua</tt> and <tt>lua\jit</tt> directories below it and copy
  314. all Lua files from the <tt>src\jit</tt> directory of the distribution
  315. to the latter directory.
  316. </p>
  317. <p>
  318. There are no hardcoded
  319. absolute path names &mdash; all modules are loaded relative to the
  320. directory where <tt>luajit.exe</tt> is installed
  321. (see <tt>src/luaconf.h</tt>).
  322. </p>
  323. <h2 id="cross">Cross-compiling LuaJIT</h2>
  324. <p>
  325. The GNU Makefile-based build system allows cross-compiling on any host
  326. for any supported target, as long as both architectures have the same
  327. pointer size. If you want to cross-compile to any 32 bit target on an
  328. x64 OS, you need to install the multilib development package (e.g.
  329. <tt>libc6-dev-i386</tt> on Debian/Ubuntu) and build a 32 bit host part
  330. (<tt>HOST_CC="gcc -m32"</tt>).
  331. </p>
  332. <p>
  333. You need to specify <tt>TARGET_SYS</tt> whenever the host OS and the
  334. target OS differ, or you'll get assembler or linker errors. E.g. if
  335. you're compiling on a Windows or OSX host for embedded Linux or Android,
  336. you need to add <tt>TARGET_SYS=Linux</tt> to the examples below. For a
  337. minimal target OS, you may need to disable the built-in allocator in
  338. <tt>src/Makefile</tt> and use <tt>TARGET_SYS=Other</tt>. The examples
  339. below only show some popular targets &mdash; please check the comments
  340. in <tt>src/Makefile</tt> for more details.
  341. </p>
  342. <pre class="code">
  343. # Cross-compile to a 32 bit binary on a multilib x64 OS
  344. make CC="gcc -m32"
  345. # Cross-compile on Debian/Ubuntu for Windows (mingw32 package)
  346. make HOST_CC="gcc -m32" CROSS=i586-mingw32msvc- TARGET_SYS=Windows
  347. </pre>
  348. <p id="cross2">
  349. The <tt>CROSS</tt> prefix allows specifying a standard GNU cross-compile
  350. toolchain (Binutils, GCC and a matching libc). The prefix may vary
  351. depending on the <tt>--target</tt> the toolchain was built for (note the
  352. <tt>CROSS</tt> prefix has a trailing <tt>"-"</tt>). The examples below
  353. use the canonical toolchain triplets for Linux.
  354. </p>
  355. <p>
  356. Since there's often no easy way to detect CPU features at runtime, it's
  357. important to compile with the proper CPU or architecture settings. You
  358. can specify these when building the toolchain yourself. Or add
  359. <tt>-mcpu=...</tt> or <tt>-march=...</tt> to <tt>TARGET_CFLAGS</tt>. For
  360. ARM it's important to have the correct <tt>-mfloat-abi=...</tt> setting,
  361. too. Otherwise LuaJIT may not run at the full performance of your target
  362. CPU.
  363. </p>
  364. <pre class="code">
  365. # ARM soft-float
  366. make HOST_CC="gcc -m32" CROSS=arm-linux-gnueabi- \
  367. TARGET_CFLAGS="-mfloat-abi=soft"
  368. # ARM soft-float ABI with VFP (example for Cortex-A8)
  369. make HOST_CC="gcc -m32" CROSS=arm-linux-gnueabi- \
  370. TARGET_CFLAGS="-mcpu=cortex-a8 -mfloat-abi=softfp"
  371. # ARM hard-float ABI with VFP (armhf, requires recent toolchain)
  372. make HOST_CC="gcc -m32" CROSS=arm-linux-gnueabihf-
  373. # PPC
  374. make HOST_CC="gcc -m32" CROSS=powerpc-linux-gnu-
  375. # MIPS big-endian
  376. make HOST_CC="gcc -m32" CROSS=mips-linux-
  377. # MIPS little-endian
  378. make HOST_CC="gcc -m32" CROSS=mipsel-linux-
  379. </pre>
  380. <p>
  381. You can cross-compile for <b id="android">Android</b> using the <a href="http://developer.android.com/sdk/ndk/index.html"><span class="ext">&raquo;</span>&nbsp;Android NDK</a>.
  382. The environment variables need to match the install locations and the
  383. desired target platform. E.g. Android&nbsp;4.0 corresponds to ABI level&nbsp;14.
  384. For details check the folder <tt>docs</tt> in the NDK directory.
  385. </p>
  386. <p>
  387. Only a few common variations for the different CPUs, ABIs and platforms
  388. are listed. Please use your own judgement for which combination you want
  389. to build/deploy or which lowest common denominator you want to pick:
  390. </p>
  391. <pre class="code">
  392. # Android/ARM, armeabi (ARMv5TE soft-float), Android 2.2+ (Froyo)
  393. NDK=/opt/android/ndk
  394. NDKABI=8
  395. NDKVER=$NDK/toolchains/arm-linux-androideabi-4.6
  396. NDKP=$NDKVER/prebuilt/linux-x86/bin/arm-linux-androideabi-
  397. NDKF="--sysroot $NDK/platforms/android-$NDKABI/arch-arm"
  398. make HOST_CC="gcc -m32" CROSS=$NDKP TARGET_FLAGS="$NDKF"
  399. # Android/ARM, armeabi-v7a (ARMv7 VFP), Android 4.0+ (ICS)
  400. NDK=/opt/android/ndk
  401. NDKABI=14
  402. NDKVER=$NDK/toolchains/arm-linux-androideabi-4.6
  403. NDKP=$NDKVER/prebuilt/linux-x86/bin/arm-linux-androideabi-
  404. NDKF="--sysroot $NDK/platforms/android-$NDKABI/arch-arm"
  405. NDKARCH="-march=armv7-a -mfloat-abi=softfp -Wl,--fix-cortex-a8"
  406. make HOST_CC="gcc -m32" CROSS=$NDKP TARGET_FLAGS="$NDKF $NDKARCH"
  407. # Android/MIPS, mips (MIPS32R1 hard-float), Android 4.0+ (ICS)
  408. NDK=/opt/android/ndk
  409. NDKABI=14
  410. NDKVER=$NDK/toolchains/mipsel-linux-android-4.6
  411. NDKP=$NDKVER/prebuilt/linux-x86/bin/mipsel-linux-android-
  412. NDKF="--sysroot $NDK/platforms/android-$NDKABI/arch-mips"
  413. make HOST_CC="gcc -m32" CROSS=$NDKP TARGET_FLAGS="$NDKF"
  414. # Android/x86, x86 (i686 SSE3), Android 4.0+ (ICS)
  415. NDK=/opt/android/ndk
  416. NDKABI=14
  417. NDKVER=$NDK/toolchains/x86-4.6
  418. NDKP=$NDKVER/prebuilt/linux-x86/bin/i686-linux-android-
  419. NDKF="--sysroot $NDK/platforms/android-$NDKABI/arch-x86"
  420. make HOST_CC="gcc -m32" CROSS=$NDKP TARGET_FLAGS="$NDKF"
  421. </pre>
  422. <p>
  423. You can cross-compile for <b id="ios">iOS 3.0+</b> (iPhone/iPad) using the <a href="http://developer.apple.com/devcenter/ios/index.action"><span class="ext">&raquo;</span>&nbsp;iOS SDK</a>.
  424. The environment variables need to match the iOS SDK version:
  425. </p>
  426. <p style="font-size: 8pt;">
  427. Note: <b>the JIT compiler is disabled for iOS</b>, because regular iOS Apps
  428. are not allowed to generate code at runtime. You'll only get the performance
  429. of the LuaJIT interpreter on iOS. This is still faster than plain Lua, but
  430. much slower than the JIT compiler. Please complain to Apple, not me.
  431. Or use Android. :-p
  432. </p>
  433. <pre class="code">
  434. IXCODE=`xcode-select -print-path`
  435. ISDK=$IXCODE/Platforms/iPhoneOS.platform/Developer
  436. ISDKVER=iPhoneOS6.0.sdk
  437. ISDKP=$ISDK/usr/bin/
  438. ISDKF="-arch armv7 -isysroot $ISDK/SDKs/$ISDKVER"
  439. make HOST_CC="gcc -m32 -arch i386" CROSS=$ISDKP TARGET_FLAGS="$ISDKF" \
  440. TARGET_SYS=iOS
  441. </pre>
  442. <h3 id="consoles">Cross-compiling for consoles</h3>
  443. <p>
  444. Building LuaJIT for consoles requires both a supported host compiler
  445. (x86 or x64) and a cross-compiler (to PPC or ARM) from the official
  446. console SDK.
  447. </p>
  448. <p>
  449. Due to restrictions on consoles, the JIT compiler is disabled and only
  450. the fast interpreter is built. This is still faster than plain Lua,
  451. but much slower than the JIT compiler. The FFI is disabled, too, since
  452. it's not very useful in such an environment.
  453. </p>
  454. <p>
  455. The following commands build a static library <tt>libluajit.a</tt>,
  456. which can be linked against your game, just like the Lua library.
  457. </p>
  458. <p>
  459. To cross-compile for <b id="ps3">PS3</b> from a Linux host (requires
  460. 32&nbsp;bit GCC, i.e. multilib Linux/x64) or a Windows host (requires
  461. 32&nbsp;bit MinGW), run this command:
  462. </p>
  463. <pre class="code">
  464. make HOST_CC="gcc -m32" CROSS=ppu-lv2-
  465. </pre>
  466. <p>
  467. To cross-compile for <b id="ps4">PS4</b> from a Windows host,
  468. open a "Visual Studio .NET Command Prompt" (64&nbsp;bit host compiler),
  469. <tt>cd</tt> to the directory where you've unpacked the sources and
  470. run the following commands:
  471. </p>
  472. <pre class="code">
  473. cd src
  474. ps4build
  475. </pre>
  476. <p>
  477. To cross-compile for <b id="psvita">PS Vita</b> from a Windows host,
  478. open a "Visual Studio .NET Command Prompt" (32&nbsp;bit host compiler),
  479. <tt>cd</tt> to the directory where you've unpacked the sources and
  480. run the following commands:
  481. </p>
  482. <pre class="code">
  483. cd src
  484. psvitabuild
  485. </pre>
  486. <p>
  487. To cross-compile for <b id="xbox360">Xbox 360</b> from a Windows host,
  488. open a "Visual Studio .NET Command Prompt" (32&nbsp;bit host compiler),
  489. <tt>cd</tt> to the directory where you've unpacked the sources and run
  490. the following commands:
  491. </p>
  492. <pre class="code">
  493. cd src
  494. xedkbuild
  495. </pre>
  496. <h2 id="embed">Embedding LuaJIT</h2>
  497. <p>
  498. LuaJIT is API-compatible with Lua 5.1. If you've already embedded Lua
  499. into your application, you probably don't need to do anything to switch
  500. to LuaJIT, except link with a different library:
  501. </p>
  502. <ul>
  503. <li>It's strongly suggested to build LuaJIT separately using the supplied
  504. build system. Please do <em>not</em> attempt to integrate the individual
  505. source files into your build tree. You'll most likely get the internal build
  506. dependencies wrong or mess up the compiler flags. Treat LuaJIT like any
  507. other external library and link your application with either the dynamic
  508. or static library, depending on your needs.</li>
  509. <li>If you want to load C modules compiled for plain Lua
  510. with <tt>require()</tt>, you need to make sure the public symbols
  511. (e.g. <tt>lua_pushnumber</tt>) are exported, too:
  512. <ul><li>On POSIX systems you can either link to the shared library
  513. or link the static library into your application. In the latter case
  514. you'll need to export all public symbols from your main executable
  515. (e.g. <tt>-Wl,-E</tt> on Linux) and add the external dependencies
  516. (e.g. <tt>-lm -ldl</tt> on Linux).</li>
  517. <li>Since Windows symbols are bound to a specific DLL name, you need to
  518. link to the <tt>lua51.dll</tt> created by the LuaJIT build (do not rename
  519. the DLL). You may link LuaJIT statically on Windows only if you don't
  520. intend to load Lua/C modules at runtime.
  521. </li></ul>
  522. </li>
  523. <li>
  524. If you're building a 64 bit application on OSX which links directly or
  525. indirectly against LuaJIT, you need to link your main executable
  526. with these flags:
  527. <pre class="code">
  528. -pagezero_size 10000 -image_base 100000000
  529. </pre>
  530. Also, it's recommended to <tt>rebase</tt> all (self-compiled) shared libraries
  531. which are loaded at runtime on OSX/x64 (e.g. C extension modules for Lua).
  532. See: <tt>man rebase</tt>
  533. </li>
  534. </ul>
  535. <p>Additional hints for initializing LuaJIT using the C API functions:</p>
  536. <ul>
  537. <li>Here's a
  538. <a href="http://lua-users.org/wiki/SimpleLuaApiExample"><span class="ext">&raquo;</span>&nbsp;simple example</a>
  539. for embedding Lua or LuaJIT into your application.</li>
  540. <li>Make sure you use <tt>luaL_newstate</tt>. Avoid using
  541. <tt>lua_newstate</tt>, since this uses the (slower) default memory
  542. allocator from your system (no support for this on x64).</li>
  543. <li>Make sure you use <tt>luaL_openlibs</tt> and not the old Lua 5.0 style
  544. of calling <tt>luaopen_base</tt> etc. directly.</li>
  545. <li>To change or extend the list of standard libraries to load, copy
  546. <tt>src/lib_init.c</tt> to your project and modify it accordingly.
  547. Make sure the <tt>jit</tt> library is loaded or the JIT compiler
  548. will not be activated.</li>
  549. <li>The <tt>bit.*</tt> module for bitwise operations
  550. is already built-in. There's no need to statically link
  551. <a href="http://bitop.luajit.org/"><span class="ext">&raquo;</span>&nbsp;Lua BitOp</a> to your application.</li>
  552. </ul>
  553. <h2 id="distro">Hints for Distribution Maintainers</h2>
  554. <p>
  555. The LuaJIT build system has extra provisions for the needs of most
  556. POSIX-based distributions. If you're a package maintainer for
  557. a distribution, <em>please</em> make use of these features and
  558. avoid patching, subverting, autotoolizing or messing up the build system
  559. in unspeakable ways.
  560. </p>
  561. <p>
  562. There should be absolutely no need to patch <tt>luaconf.h</tt> or any
  563. of the Makefiles. And please do not hand-pick files for your packages &mdash;
  564. simply use whatever <tt>make install</tt> creates. There's a reason
  565. for all of the files <em>and</em> directories it creates.
  566. </p>
  567. <p>
  568. The build system uses GNU make and auto-detects most settings based on
  569. the host you're building it on. This should work fine for native builds,
  570. even when sandboxed. You may need to pass some of the following flags to
  571. <em>both</em> the <tt>make</tt> and the <tt>make install</tt> command lines
  572. for a regular distribution build:
  573. </p>
  574. <ul>
  575. <li><tt>PREFIX</tt> overrides the installation path and should usually
  576. be set to <tt>/usr</tt>. Setting this also changes the module paths and
  577. the paths needed to locate the shared library.</li>
  578. <li><tt>DESTDIR</tt> is an absolute path which allows you to install
  579. to a shadow tree instead of the root tree of the build system.</li>
  580. <li><tt>MULTILIB</tt> sets the architecture-specific library path component
  581. for multilib systems. The default is <tt>lib</tt>.</li>
  582. <li>Have a look at the top-level <tt>Makefile</tt> and <tt>src/Makefile</tt>
  583. for additional variables to tweak. The following variables <em>may</em> be
  584. overridden, but it's <em>not</em> recommended, except for special needs
  585. like cross-builds:
  586. <tt>BUILDMODE, CC, HOST_CC, STATIC_CC, DYNAMIC_CC, CFLAGS, HOST_CFLAGS,
  587. TARGET_CFLAGS, LDFLAGS, HOST_LDFLAGS, TARGET_LDFLAGS, TARGET_SHLDFLAGS,
  588. TARGET_FLAGS, LIBS, HOST_LIBS, TARGET_LIBS, CROSS, HOST_SYS, TARGET_SYS
  589. </tt></li>
  590. </ul>
  591. <p>
  592. The build system has a special target for an amalgamated build, i.e.
  593. <tt>make amalg</tt>. This compiles the LuaJIT core as one huge C file
  594. and allows GCC to generate faster and shorter code. Alas, this requires
  595. lots of memory during the build. This may be a problem for some users,
  596. that's why it's not enabled by default. But it shouldn't be a problem for
  597. most build farms. It's recommended that binary distributions use this
  598. target for their LuaJIT builds.
  599. </p>
  600. <p>
  601. The tl;dr version of the above:
  602. </p>
  603. <pre class="code">
  604. make amalg PREFIX=/usr && \
  605. make install PREFIX=/usr DESTDIR=/tmp/buildroot
  606. </pre>
  607. <p>
  608. Finally, if you encounter any difficulties, please
  609. <a href="contact.html">contact me</a> first, instead of releasing a broken
  610. package onto unsuspecting users. Because they'll usually gonna complain
  611. to me (the upstream) and not you (the package maintainer), anyway.
  612. </p>
  613. <br class="flush">
  614. </div>
  615. <div id="foot">
  616. <hr class="hide">
  617. Copyright &copy; 2005-2014 Mike Pall
  618. <span class="noprint">
  619. &middot;
  620. <a href="contact.html">Contact</a>
  621. </span>
  622. </div>
  623. </body>
  624. </html>