2 Instructions to build Bacula using the Mingw 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.
20 The new directory structure is:
22 bacula-top Top level directory -- any name
23 bacula Top level Bacula source directory -- any name
25 win32 Main directory where Windows version is built.
27 docs Top level Bacula documentation directory
29 depkgs-mingw32 (MinGW32) 3rd Party Dependencies for MinGW32 build
30 bin -- NOTE! depkgs-msvc is no longer suppored
33 man | Created by script
34 nsis |-- .../bacula/src/win32/build-depkgs-mingw32
40 inc A copy of the Windows VSS/inc directory
43 depkgs-mingw-w64 (MinGW64) 3rd Party Dependencies for MinGW64 build
54 inc A copy of the Windows VSS/inc directory
56 cross-tools (MinGW64/32) Cross compilation tools (gcc, g++, mingw32, ...)
58 gcc-mingw32 | Created by script
59 mingw32 |-- .../bacula/src/win32/build-win32-cross-tools
62 mingw-w64/x86_64-pc-mingw32 \ Taken from http://sf.net/projects/mingw-w64
70 If you're reading this file you've probably already enlisted in the SVN tree or
71 extracted the contents of the source tar. If not you need to do that first.
73 You also need to download one of the doc tar balls and extract to your
74 top level Bacula directory.
76 The extracted doc directory name will be bacula-docs-version where version
77 is the version number. The directory must be renamed to docs (ie remove
78 the leading bacula- and the -version portion of the name).
80 Note, a number of packages must be installed to build the cross-tools
81 and the depkgs files. Most are rather standard such as gcc, g++,
82 make, ... However a few that you may not have are:
89 postgresql (at least client)
90 mysql (at least client)
91 SQLite3 (from depkgs or as package)
92 readline (readlineN-dev on Debian)
95 NB: On Debian, I had to remove /usr/bin/lorder for
96 postresql to build correctly.
98 Build the 32 bit cross-tools and mingw32:
100 Once the source is on your system, change to the win32 directory
101 cd .../bacula/src/win32
103 Download and build the cross compiler tools
104 ./build-win32-cross-tools
106 Download and build the 3rd party dependencies
107 ./build-depkgs-mingw32
109 Note, that during the build process you will see a moderate amount of
110 output. If something fails, it is probably because you don't have one
111 of the build dependencies (hopefully all mentioned above) loaded on your
112 system. To find out what is going wrong, do the following:
114 cd .../depkgs-mingw32/src/<package-name>
116 where <package-name> is where the package is unpacked and built. Normally
117 it is relatively obvious when looking at the src directory.
119 In that directory, you should find a make.log, which has the full details
120 of the compiles, links, and installs done for that package.
122 Build the 64 bit cross-tools and mingw64:
123 When building the mingw64 environment and all dependencies
124 (cross-tools, and depkgs-mingw64) should be compiled by hand with
125 host=x86_64-pc-linux and target=x86_64-pc-mingw32.
127 For that, use this configure line :
128 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/cross-tools
130 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/depkgs-mingw64
132 (It can work with other setup). We are using binutils-2.19, gcc-4.3.2,
133 gmp-4.2.4, mpfr-2.3.2. The mingw64 project delivers binaries that should do the
136 Internal scripts and patches are using mingw32-xxx binaries, so you need to
137 make links in the gcc bin ($ROOT/cross-tools/mingw-w64/bin) directory.
139 ---8<------8<-------8<--------
141 for i in x86_64-pc-mingw32-*
143 ln -s $i ${i##x86_64-pc-}
146 ---8<------8<-------8<--------
148 They provide also a pthread lib but we aren't sure that they will work, you
149 can compile it yourself using the pthreads-snap-2004-06-22.tar.gz (same as
150 mingw32) + pthread-win64.patch.
152 The openssl lib version is openssl-0.9.8j.tar.gz + openssl-win64.patch
154 See External-mingw-w64 for download location (available on www.bacula.org).
156 You need the header files from the Microsoft VSS SDK. Unfortunately the SDK
157 can only be downloaded and installed on a Windows system. We do not have
158 the right to distribute it, so you must download it yourself.
159 You can find it on Microsoft's web-site at:
161 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
163 If that link doesn't work then go to http://www.microsoft.com and search for
165 "download volume shadow copy service sdk"
167 we are currently using version 7.2 released 8/3/2005.
169 Normally the files will be installed in:
171 c:\Program Files\Microsoft\VSSSDK72
173 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
174 directory into .../depkgs-mingw32/vss/inc. and .../depkgs-mingw-w64/vss/inc
175 In doing so, please ensure that
176 the case in maintained on the directory and filenames -- some contain uppercase
179 The above only needs to be done once unless we change the cross-tools
180 or the dependencies versions. In general, you can run the script multiple
181 times with no problem. For it to work, you must have at a minimum the
194 and possibly other packages.
200 Finally, to build the Microsoft Windows version of Bacula, do the following:
202 cd .../bacula/src/win32
207 cd .../bacula/src/win32
212 This builds both the 32 bit version and the 64 bit version.
213 The binaries are in the release32 and release64 directories.
217 Updating the 3rd party package patches
218 ======================================
220 If one of the patches changes in .../bacula/src/win32/patches, you will
221 need to update the corresponding dependency.
223 Adding a new global function or global data
224 ===========================================
229 The code from the following directories is built into bacula.dll:
232 .../bacula/src/libfind
233 .../bacula/src/win32/compat
235 A new function or data variable which must be accessed from outside
236 of bacula.dll requires special treatment. It must be specifically
239 New data variables are exported by adding the macro DLL_IMP_EXP to
240 the variable declaration in the header file. All exported variables
241 must be declared in a header file and MUST NOT be declared in a
242 source file referencing the variable. Example, src/lib/runscript.h:
244 extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
248 extern int DLL_IMP_EXP num_jobs_run;
249 extern DLL_IMP_EXP dlist * last_jobs;
253 Exporting functions is now more or less automated. If you find that
254 a function name has been added, changed, or an argument modified,
255 simply do the following:
257 cd .../bacula/src/win32/lib
258 make (to build the .o files, note the link will fail)
259 ./make_def >bacula64.def or >bacula64.def
261 This should rebuild the bacula.def file, but it uses relative paths
262 and assumes you have the directory structure noted above. If you
263 are using something different, you can set the NM variable at the
264 top of the make_def file to use an absolute path to the correct
267 ===== manual changing of bacula32.def or bacula64.def no longer necessary =====
268 If you want to do it manually, please see below:
269 Exporting a function requires a bit more work. You must determine the
270 C++ mangled name of the new function.
272 strings .../bacula/src/win32/lib/<file>.o | grep <symbol>
274 Note, strings often will not show the desired symbol. In that case,
277 nm .../bacula/src/win32/lib/<file>.o
279 Replace <file> with the base part of the name of the source code file
280 which contains the new function. Replace <symbol> with the name of
281 the new function. Remove the leading underscore and place the result
284 .../bacula/src/win32/lib/bacula64.def
285 === end manual changing of bacula64.def ==========
287 If you add a new file, you will need to specify its name in
289 .../bacula/src/win32/lib/Makefile
291 .../bacula/src/win32/libbac/Makefile
294 Running gdb on the Win32 files
295 ==================================================
296 You can use the mingw64 gdb to debug Bacula on Win64 by downloading
297 it from Source Forge:
299 http://sourceforge.net/project/showfiles.php?group_id=202880&package_id=311650
302 Download one of their .exe versions, which is an installer that you
303 can run on Win32 to install gdb. This gdb is built with mingw64 so will
304 run independently of any cygwin installation. Note, not all the releases
305 come with an installer. I had to go back 3 or 4 versions to find it. Otherwise
306 you can download the source and build it. Thanks to Eric Bollengier for
310 Structure of the MinGW64/32 build environment
311 ==========================================
313 The basic strategy is each Makefile in the various subdirectories includes
314 Makefile.inc, defines variables and rules specific to what is being built,
315 then includes Makefile.rules which defines all the rules.
317 Makefile.inc defines the locations of all the dependencies and the compiler
318 and linker flags. It is automatically created from Makefile.inc.in. Any
319 changes must be made to Makefile.inc.in not Makefile.inc or they will be
320 overwritten the next time Makefile.inc.in is updated.
322 Makefile.rules defines a bunch of macros to simplify building. It also
323 includes all the basic rules for building objects, GUI and console
326 Makefile.template is a template for creating new Makefiles, if you are
327 creating a new directory, copy Makefile.template to Makefile in that
328 directory and edit to suit.