Cross compiling for Windows under Linux: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | > **Note:** Rewrite in progress, original content is retained inside comment tags; will pop up here again as it's reviewed and updated as necessary. | |
| 2 | 2 | ||
| 3 | 3 | ## General | |
| 4 | 4 | ||
| 5 | 5 | One of the FPC's features is its ability to cross-compile. It's very useful to be able to make Windows (32-bit and 64-bit) from your Linux workstation. Everything we do here relates to FPC, no changes are needed to Lazarus. | |
| 6 | 6 | ||
| 7 | 7 | It's very important to note that these instructions apply to a FPC that was installed from packages from SourceForge; if you are using packages from your Linux distribution then they will almost certainly not work. In fact, in many cases, Linux distribution repository packages may not support building cross-compiles. Please consider uninstalling the distribution's packages and replacing them with ones from the [official FPC/Lazarus SourceForge repository](https://sourceforge.net/projects/lazarus/files/Lazarus). | |
| 8 | 8 | ||
| 9 | 9 | These instructions have been tested on Ubuntu Linux 21.04 "The Hirsute Hippo" and openSUSE Leap 15.3. | |
| 10 | 10 | ||
| 11 | 11 | ### Install FPC/Lazarus | |
| 12 | 12 | ||
| 13 | 13 | If you already have a working FPC/Lazarus install obtained from SourceForge, then skip this step. Install FPC and Lazarus using the SourceForge method as detailed in [[Installing Lazarus on Linux|Installing Lazarus on Linux § Build Lazarus from Source]] It's a good idea to fire it up and make sure you can build and compile a simple app first. | |
| 14 | 14 | ||
| 15 | 15 | ### Setting up x86_64 Linux to Windows Cross-compile | |
| 16 | 16 | ||
| 17 | 17 | Note, we assume the use of FPC 3.2.2, if you're using a different version, put the right numbers in yourself! | |
| 18 | 18 | ||
| 19 | 19 | The process here is to build the pre-compiled FPC units to suit Windows (both 32-bit and 64-bit) and, of course, the Windows compilers, ppcross386 and ppcross64. We then put a symlink to the compilers in the right place and make sure your FPC config files know about the Windows pre-compiled units. | |
| 20 | 20 | ||
| 21 | 21 | Now to make a cross-compiler, the following needs to be done as root. It's easier (but slightly riskier) to `sudo` (or `su`) and stay as root for the whole process, so please be careful. We will set a temporary environment variable containing the FPC version number to make copy and pasting easy (assuming you are using FPC 3.2.2). | |
| 22 | 22 | ||
| 23 | 23 | ```shell | |
| 24 | 24 | sudo -i | |
| 25 | 25 | export FPCVER="3.2.2" | |
| 26 | 26 | cd "/usr/share/fpcsrc/${FPCVER}" | |
| 27 | 27 | make clean all OS_TARGET=win64 CPU_TARGET=x86_64 | |
| 28 | 28 | make clean all OS_TARGET=win32 CPU_TARGET=i386 | |
| 29 | 29 | ``` | |
| 30 | 30 | ||
| 31 | 31 | Those steps take awhile each. Watch for errors as the compile report scrolls by. It builds Windows versions of the units in the FPC-SRC tree. The next lines are pretty quick; they copy the units to `/usr/lib/fpc/${FPCVER}/units` and the ones after that make symlinks to the cross-compilers. | |
| 32 | 32 | ||
| 33 | 33 | ``` bash | |
| 34 | 34 | make crossinstall OS_TARGET=win64 CPU_TARGET=x86_64 INSTALL_PREFIX=/usr | |
| 35 | 35 | make crossinstall OS_TARGET=win32 CPU_TARGET=i386 INSTALL_PREFIX=/usr | |
| 36 | 36 | ln -sf "/usr/lib/fpc/${FPCVER}/ppcrossx64" /usr/bin/ppcrossx64 | |
| 37 | 37 | ln -sf "/usr/lib/fpc/${FPCVER}/ppcross386" /usr/bin/ppcross386 | |
| 38 | 38 | ``` | |
| 39 | 39 | ||
| 40 | 40 | Assuming you did not see any errors, does your `fpc.cfg` file need attention? | |
| 41 | 41 | ||
| 42 | 42 | ``` bash | |
| 43 | 43 | grep 'Fu' /etc/fpc.cfg | |
| 44 | 44 | ``` | |
| 45 | 45 | ||
| 46 | 46 | Does the result listed include `-Fu/usr/lib/fpc/${fpcversion}/units/${fpctarget}/*`? If not, you need to fire up your favorite editor and add it. Look for the first line in the sample below, and when you find it, add the second line as shown. | |
| 47 | 47 | ||
| 48 | 48 | ```text | |
| 49 | 49 | # searchpath for units and other system dependent things | |
| 50 | 50 | -Fu/usr/lib/fpc/${fpcversion}/units/${fpctarget}/* | |
| 51 | 51 | ``` | |
| 52 | 52 | ||
| 53 | - | ||
| 53 | + | That's it, press Ctrl+D to get out of the risky root mode, and test it out. | |
| 54 | 54 | ||
| 55 | 55 | ### Testing | |
| 56 | 56 | ||
| 57 | 57 | Fire up Lazarus and open a new project, then: | |
| 58 | 58 | ||
| 59 | 59 | - Project ⇒ ProjectOptions ⇒ ConfigAndTarget, and set Target OS (-T) to Win64 | |
| 60 | 60 | - Project ⇒ ProjectOptions ⇒ ConfigAndTarget, and set LCLWidgetType to Win32 | |
| 61 | 61 | - Run ⇒ Build | |
| 62 | 62 | - Project ⇒ ProjectOptions ⇒ ConfigAndTarget, and set Target OS (-T) to Win32 | |
| 63 | 63 | - Project ⇒ ProjectOptions ⇒ ConfigAndTarget, and set Target CPU Family (-P) to i386 | |
| 64 | 64 | - Project ⇒ ProjectOptions ⇒ AdditionsAndOverRides, and set LCLWidgetType to Win32 | |
| 65 | 65 | - Run ⇒ Build | |
| 66 | 66 | ||
| 67 | 67 | Obviously, you cannot 'run' that binary, but if one is made, it's almost certainly okay. | |
| 68 | 68 | ||
| 69 | 69 | ## Lazarus/LCL | |
| 70 | 70 | ||
| 71 | 71 | ### Cross-compiling the LCL and Lazarus components | |
| 72 | 72 | ||
| 73 | 73 | The IDE automatically cross-compiles all used packages when you change the target of your project and build it. | |
| 74 | 74 | ||
| 75 | 75 | ### Cross-compiling a project | |
| 76 | 76 | ||
| 77 | 77 | Lazarus projects can have 'Modes', and it's convenient to set a mode for each compilation you want to perform. Here you can make Linux64 binaries and Windows 32-bit and 64-bit executables, so make a mode for each and apply the appropriate settings to each mode. | |
| 78 | 78 | ||
| 79 | 79 | In Project ⇒ ProjectOptions ⇒ ConfigAndTarget, set the Target OS to 'win64' and in "Additions and Overrides" click "Set LCL WidgetType" and select win32. That's all. The next time you build, you will create a win64 executable. | |
| 80 | 80 | ||
| 81 | 81 | Similarly, to make a Win32 executable, do the above but also set Project ⇒ ProjectOptions ⇒ ConfigAndTarget and set Target CPU Family (-P) to i386. | |
| 82 | 82 | ||
| 83 | 83 | The IDE will rescan for the Windows units, so that 'Find declaration' and code completion features will now work with the win32 rtl instead of the Linux rtl. | |
| 84 | 84 | ||
| 85 | 85 | ### Hints for cross-compiling with Lazarus | |
| 86 | 86 | ||
| 87 | 87 | If you create an application/package for multiple targets, you will often do the following: | |
| 88 | 88 | ||
| 89 | 89 | - Fix a bug | |
| 90 | 90 | - Compile and test it under Linux, then | |
| 91 | 91 | - Compile and test it under Win32 | |
| 92 | 92 | ||
| 93 | 93 | Because normally you overwrite your .ppu files you have to recompile everything, every time you switch. However, this is not necessary; the Lazarus IDE supports macros. | |
| 94 | 94 | ||
| 95 | 95 | #### Example 1: Cross-compiling a project for Linux and Win32 | |
| 96 | 96 | ||
| 97 | 97 | Set Project ⇒ Compiler Options ⇒ Paths ⇒ Unit Output directory to \$(TargetOS). This macro will be replaced by the value in Code ⇒ TargetOS in lowercase (i.e. "linux" for Linux and "win32" for Win32). The output directory is relative to your project directory (the directory where your .lpi file is). Create `linux` and `win32` directories in your project directory. | |
| 98 | 98 | ||
| 99 | 99 | When you click on the "Show Options" button at the bottom of the compiler options, you will see a `-FElinux/` or `-FEwin32/`. This option tells the compiler where to write the output (e.g. .ppu/.o files). | |
| 100 | 100 | ||
| 101 | 101 | #### Example 2: Cross-compiling a project for various platforms and widget sets | |
| 102 | 102 | ||
| 103 | 103 | Set the Unit output directory to \$(TargetCPU)/\$(TargetOS)/\$(LCLWidgetType) and create the sub-directories for all targets. This path construction is also used by the LCL. | |
| 104 | 104 | ||
| 105 | 105 | The same can be done for packages. | |
| 106 | 106 | ||
| 107 | 107 | ### Cross-compiling and Lazarus packages | |
| 108 | 108 | ||
| 109 | 109 | Lazarus packages are not limited to libraries, they can be used to compile nearly everything and the IDE automatically recompiles them, if needed. | |
| 110 | 110 | ||
| 111 | 111 | Packages can inherit compiler options. For example, a project that uses a package inherits the output directory of the package. In other words, the output directory of the package is added to the unit search path of the project. See for yourself in IDE: Project ⇒ Compiler options ⇒ Inherited. | |
| 112 | 112 | ||
| 113 | 113 | Inheritance normally works only one way, but there are exceptions: | |
| 114 | 114 | ||
| 115 | 115 | - The target platform (OS and CPU) of the project override the target for all used packages. That means if you set the Target OS of the project to "win32" and compile the project, the IDE will check if the used packages need to be recompiled for this Target OS. For example: | |
| 116 | 116 | - Package A has as output directory: lib/\$(TargetOS). Project uses A. | |
| 117 | 117 | ||
| 118 | 118 | 1. The project is built for linux. The IDE compiles A for linux in \<PackageDirOfA\>/lib/linux/, then it compiles the project for linux. | |
| 119 | 119 | 2. The project is built for win32. The IDE compiles A for win32 in \<PackageDirOfA\>/lib/win32/, then it compiles the project for win32. | |
| 120 | 120 | 3. The project is built again for linux. The IDE checks A for linux and does not recompile it, then it compiles the project for linux. | |
| 121 | 121 | ||
| 122 | 122 | So using the macros saves a lot of time. | |
| 123 | 123 | ||
| 124 | 124 | ## See also | |
| 125 | 125 | ||
| 126 | 126 | - [[Cross compiling]] | |
| 127 | 127 | - [[buildfaq]] | |
| 128 | 128 | ||
| 129 | 129 | --- | |
| 130 | 130 | *From the Free Pascal wiki, page "Cross compiling for Windows under Linux", as it stood on 2023-09-20 after a change by RogueScholar, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 131 | 131 | Category: Cross compilation | |
| 132 | 132 | Category: FPC | |
| 133 | 133 | Category: Lazarus |