2 Instructions for cross compiling the Win32/64 FD on Linux
3 =======================================================
5 This file documents the tools (scripts) we use for building Bacula for
6 Microsoft Windows using the cross-compiler tools on a Linux system. We
7 use Ubuntu 8.04 so building on that system should definitely work. But there
8 shouldn't be any issues on other Linux distributions.
10 We don't officially support this method, but it is what we use, and it should
11 build on any Linux machine if you carefully follow the instructions and have
12 all the prerequisite programs loaded on your machine.
14 We expect that there may be problems on systems other than Linux where you
15 are pretty much on your own. However, we will try to provide responses to
16 your questions on the bacula-devel list, but we can't guarantee anything.
18 Note: the environment variable DEPKGS must point to a directory that
19 contains: depkgs-mingw32 depkgs-mingw-w64 and cross-tools
23 The new directory structure is:
26 bacula Top level Bacula source directory -- any name
28 win32 Main directory where Windows version is built.
30 docs Top level Bacula documentation directory
32 yyy (any directory, but pointed to by the DEPKGS environment variable)
33 depkgs-mingw32 (MinGW32) 3rd Party Dependencies for MinGW32 build
34 bin -- NOTE! depkgs-msvc is no longer suppored
37 man | Created by script
38 nsis |-- .../bacula/src/win32/build-depkgs-mingw32
44 inc A copy of the Windows VSS/inc directory
47 depkgs-mingw-w64 (MinGW64) 3rd Party Dependencies for MinGW64 build
58 inc A copy of the Windows VSS/inc directory
60 cross-tools (MinGW64/32) Cross compilation tools (gcc, g++, mingw32, ...)
62 gcc-mingw32 | Created by script
63 mingw32 |-- .../bacula/src/win32/build-win32-cross-tools
66 mingw-w64/x86_64-pc-mingw32 \ Taken from http://sf.net/projects/mingw-w64
74 If you're reading this file you've probably already enlisted in the SVN tree or
75 extracted the contents of the source tar. If not you need to do that first.
77 You also need to download one of the doc tar balls and extract to your
78 top level Bacula directory.
80 The extracted doc directory name will be bacula-docs-version where version
81 is the version number. The directory must be renamed to docs (ie remove
82 the leading bacula- and the -version portion of the name).
84 Note, a number of packages must be installed to build the cross-tools
85 and the depkgs files. Most are rather standard such as gcc, g++,
86 make, ... However a few that you may not have are:
93 postgresql (at least client)
94 mysql (at least client)
95 SQLite3 (from depkgs or as package)
96 readline (readlineN-dev on Debian)
99 NB: On Debian, I had to remove /usr/bin/lorder for
100 postresql to build correctly.
102 Build the 32 bit cross-tools and mingw32:
104 Once the source is on your system, change to the win32 directory
105 cd .../bacula/src/win32
107 Download and build the cross compiler tools
108 ./build-win32-cross-tools
110 Download and build the 3rd party dependencies
111 ./build-depkgs-mingw32
113 Note, that during the build process you will see a moderate amount of
114 output. If something fails, it is probably because you don't have one
115 of the build dependencies (hopefully all mentioned above) loaded on your
116 system. To find out what is going wrong, do the following:
118 cd .../depkgs-mingw32/src/<package-name>
120 where <package-name> is where the package is unpacked and built. Normally
121 it is relatively obvious when looking at the src directory.
123 In that directory, you should find a make.log, which has the full details
124 of the compiles, links, and installs done for that package.
127 Building the 64 bit cross-tools and mingw64:
129 When building the mingw64 environment and all dependencies
130 (cross-tools, and depkgs-mingw64) should be compiled by hand with
131 host=x86_64-pc-linux and target=x86_64-pc-mingw32.
133 For that, use this configure line :
134 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/cross-tools
136 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/depkgs-mingw64
138 (It can work with other setup). We are using binutils-2.19, gcc-4.3.2,
139 gmp-4.2.4, mpfr-2.3.2. The mingw64 project delivers binaries that should do the
142 Internal scripts and patches are using mingw32-xxx binaries, so you need to
143 make links in the gcc bin ($ROOT/cross-tools/mingw-w64/bin) directory.
145 ---8<------8<-------8<--------
147 for i in x86_64-pc-mingw32-*
149 ln -s $i ${i##x86_64-pc-}
152 ---8<------8<-------8<--------
154 They provide also a pthread lib but we aren't sure that they will work, you
155 can compile it yourself using the pthreads-snap-2004-06-22.tar.gz (same as
156 mingw32) + pthread-win64.patch.
158 The openssl lib version is openssl-0.9.8j.tar.gz + openssl-win64.patch
160 See External-mingw-w64 for download location (available on www.bacula.org).
162 You need the header files from the Microsoft VSS SDK. Unfortunately the SDK
163 can only be downloaded and installed on a Windows system. We do not have
164 the right to distribute it, so you must download it yourself.
165 You can find it on Microsoft's web-site at:
167 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
169 If that link doesn't work then go to http://www.microsoft.com and search for
171 "download volume shadow copy service sdk"
173 we are currently using version 7.2 released 8/3/2005.
175 Normally the files will be installed in:
177 c:\Program Files\Microsoft\VSSSDK72
179 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
180 directory into .../depkgs-mingw32/vss/inc. and .../depkgs-mingw-w64/vss/inc
181 In doing so, please ensure that
182 the case in maintained on the directory and filenames -- some contain uppercase
185 The above only needs to be done once unless we change the cross-tools
186 or the dependencies versions. In general, you can run the script multiple
187 times with no problem. For it to work, you must have at a minimum the
200 and possibly other packages.
206 Finally, to build the Microsoft Windows version of Bacula, do the following:
208 cd .../bacula/src/win32
213 cd .../bacula/src/win32
218 This builds both the 32 bit version and the 64 bit version.
219 The binaries are in the release32 and release64 directories.
223 Updating the 3rd party package patches
224 ======================================
226 If one of the patches changes in .../bacula/src/win32/patches, you will
227 need to update the corresponding dependency.
229 Adding a new global function or global data
230 ===========================================
235 The code from the following directories is built into bacula.dll:
238 .../bacula/src/libfind
239 .../bacula/src/win32/compat
241 A new function or data variable which must be accessed from outside
242 of bacula.dll requires special treatment. It must be specifically
245 New data variables are exported by adding the macro DLL_IMP_EXP to
246 the variable declaration in the header file. All exported variables
247 must be declared in a header file and MUST NOT be declared in a
248 source file referencing the variable. Example, src/lib/runscript.h:
250 extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
254 extern int DLL_IMP_EXP num_jobs_run;
255 extern DLL_IMP_EXP dlist * last_jobs;
259 Exporting functions is now more or less automated. If you find that
260 a function name has been added, changed, or an argument modified,
261 simply do the following:
263 cd .../bacula/src/win32/lib
264 make (to build the .o files, note the link will fail)
265 ./make_def >bacula64.def or >bacula64.def
267 This should rebuild the bacula.def file, but it uses relative paths
268 and assumes you have the directory structure noted above. If you
269 are using something different, you can set the NM variable at the
270 top of the make_def file to use an absolute path to the correct
273 ===== manual changing of bacula32.def or bacula64.def no longer necessary =====
274 If you want to do it manually, please see below:
275 Exporting a function requires a bit more work. You must determine the
276 C++ mangled name of the new function.
278 strings .../bacula/src/win32/lib/<file>.o | grep <symbol>
280 Note, strings often will not show the desired symbol. In that case,
283 nm .../bacula/src/win32/lib/<file>.o
285 Replace <file> with the base part of the name of the source code file
286 which contains the new function. Replace <symbol> with the name of
287 the new function. Remove the leading underscore and place the result
290 .../bacula/src/win32/lib/bacula64.def
291 === end manual changing of bacula64.def ==========
293 If you add a new file, you will need to specify its name in
295 .../bacula/src/win32/lib/Makefile
297 .../bacula/src/win32/libbac/Makefile
300 Running gdb on the Win32 files
301 ==================================================
302 You can use the mingw64 gdb to debug Bacula on Win64 by downloading
303 it from Source Forge:
305 http://sourceforge.net/project/showfiles.php?group_id=202880&package_id=311650
308 Download one of their .exe versions, which is an installer that you
309 can run on Win32 to install gdb. This gdb is built with mingw64 so will
310 run independently of any cygwin installation. Note, not all the releases
311 come with an installer. I had to go back 3 or 4 versions to find it. Otherwise
312 you can download the source and build it. Thanks to Eric Bollengier for
316 Structure of the MinGW64/32 build environment
317 ==========================================
319 The basic strategy is each Makefile in the various subdirectories includes
320 Makefile.inc, defines variables and rules specific to what is being built,
321 then includes Makefile.rules which defines all the rules.
323 Makefile.inc defines the locations of all the dependencies and the compiler
324 and linker flags. It is automatically created from Makefile.inc.in. Any
325 changes must be made to Makefile.inc.in not Makefile.inc or they will be
326 overwritten the next time Makefile.inc.in is updated.
328 Makefile.rules defines a bunch of macros to simplify building. It also
329 includes all the basic rules for building objects, GUI and console
332 Makefile.template is a template for creating new Makefiles, if you are
333 creating a new directory, copy Makefile.template to Makefile in that
334 directory and edit to suit.