1 Instructions to build Bacula using the MinGW64 on Linux
2 =======================================================
4 This file documents the tools (scripts) we use for building Bacula for
5 Microsoft Windows using the cross-compiler tools on a Linux system. We
6 use Ubuntu 8.04 so building on that system should definitely work. But there
7 shouldn't be any issues on other Linux distributions.
9 We don't officially support this method, but it is what we use, and it should
10 build on any Linux machine if you carefully follow the instructions and have
11 all the prerequisite programs loaded on your machine.
13 We expect that there may be problems on systems other than Linux where you
14 are pretty much on your own. However, we will try to provide responses to
15 your questions on the bacula-devel list, but we can't guarantee anything.
19 The new directory structure is:
21 bacula-top Top level directory -- any name
22 bacula Top level Bacula source directory -- any name
24 win32 Main directory where Windows version is built.
26 docs Top level Bacula documentation directory
28 depkgs-mingw32 (MinGW32) 3rd Party Dependencies for MinGW32 build
29 bin -- NOTE! depkgs-msvc is no longer suppored
32 man | Created by script
33 nsis |-- .../bacula/src/win32/build-depkgs-mingw32
39 inc A copy of the Windows VSS/inc directory
42 depkgs-mingw-w64 (MinGW64) 3rd Party Dependencies for MinGW64 build
53 inc A copy of the Windows VSS/inc directory
55 cross-tools (MinGW64/32) Cross compilation tools (gcc, g++, mingw32, ...)
57 gcc-mingw32 | Created by script
58 mingw32 |-- .../bacula/src/win32/build-win32-cross-tools
61 mingw-w64/x86_64-pc-mingw32 \ Take from http://sf.net/projects/mingw-w64
69 If you're reading this file you've probably already enlisted in the SVN tree or
70 extracted the contents of the source tar. If not you need to do that first.
72 You also need to download one of the doc tar balls and extract to your
73 top level Bacula directory.
75 The extracted doc directory name will be bacula-docs-version where version
76 is the version number. The directory must be renamed to docs (ie remove
77 the leading bacula- and the -version portion of the name).
79 Note, a number of packages must be installed to build the cross-tools
80 and the depkgs files. Most are rather standard such as gcc, g++,
81 make, ... However a few that you may not have are:
88 postgresql (at least client)
89 mysql (at least client)
90 SQLite3 (from depkgs or as package)
91 readline (readlineN-dev on Debian)
94 NB: On Debian, I had to remove /usr/bin/lorder for
95 postresql to build correctly.
97 Once the source is on your system, change to the win32 directory
98 cd .../bacula/src/win32
100 Download and build the cross compiler tools
101 ./build-win32-cross-tools
103 Download and build the 3rd party dependencies
104 ./build-depkgs-mingw32
106 Note, that during the build process you will see a moderate amount of
107 output. If something fails, it is probably because you don't have one
108 of the build dependencies (hopefully all mentioned above) loaded on your
109 system. To find out what is going wrong, do the following:
111 cd .../depkgs-mingw32/src/<package-name>
113 where <package-name> is where the package is unpacked and built. Normally
114 it is relatively obvious when looking at the src directory.
116 In that directory, you should find a make.log, which has the full details
117 of the compiles, links, and installs done for that package.
119 The mingw64 environment and all dependencies should be compiled with host
120 x86_64-pc-linux and target x86_64-pc-mingw32.
122 ---8<------8<-------8<--------
124 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32
126 ---8<------8<-------8<--------
128 (It can work with other setup). We are using binutils-2.19, gcc-4.3.2,
129 gmp-4.2.4, mpfr-2.3.2. The mingw64 project delivers binaries that should do the
132 Internal scripts and patches are using mingw32-xxx binaries, so you need to
133 make links in the gcc bin directory.
135 ---8<------8<-------8<--------
137 for i in x86_64-pc-mingw32-*
139 ln -s $i ${i##x86_64-pc-}
142 ---8<------8<-------8<--------
144 They provide also a pthread lib but we aren't sure that they will work, you
145 can compile it yourself using the pthreads-snap-2004-06-22.tar.gz (same as
146 mingw32) + pthread-win64.patch.
148 The openssl lib version is openssl-0.9.8j.tar.gz + openssl-win64.patch
150 See External-mingw-w64 for download location (available on www.bacula.org).
152 You need the header files from the Microsoft VSS SDK. Unfortunately the SDK
153 can only be downloaded and installed on a Windows system. We do not have
154 the right to distribute it, so you must download it yourself.
155 You can find it on Microsoft's web-site at:
157 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
159 If that link doesn't work then go to http://www.microsoft.com and search for
161 "download volume shadow copy service sdk"
163 we are currently using version 7.2 released 8/3/2005.
165 Normally the files will be installed in:
167 c:\Program Files\Microsoft\VSSSDK72
169 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
170 directory into .../depkgs-mingw32/vss/inc. and .../depkgs-mingw-w64/vss/inc
171 In doing so, please ensure that
172 the case in maintained on the directory and filenames -- some contain uppercase
175 The above only needs to be done once unless we change the cross-tools
176 or the dependencies versions. In general, you can run the script multiple
177 times with no problem. For it to work, you must have at a minimum the
190 and possibly other packages.
196 Finally, to build the Microsoft Windows version of Bacula, do the following:
198 cd .../bacula/src/win32
202 At this time, the installer doesn't work, binaries are located in
203 .../bacula/src/win32/release
205 If you have an older build environment, you might do the following
206 to ensure that you pick up all the new Win32 changes:
214 To build the win32 version (director/storage/filed) you need to clean all
215 objects from a previous build.
218 Updating the 3rd party package patches
219 ======================================
221 If one of the patches changes in .../bacula/src/win32/patches, you will
222 need to update the corresponding dependency.
224 Adding a new global function or global data
225 ===========================================
230 The code from the following directories is built into bacula.dll:
233 .../bacula/src/libfind
234 .../bacula/src/win32/compat
236 A new function or data variable which must be accessed from outside
237 of bacula.dll requires special treatment. It must be specifically
240 New data variables are exported by adding the macro DLL_IMP_EXP to
241 the variable declaration in the header file. All exported variables
242 must be declared in a header file and MUST NOT be declared in a
243 source file referencing the variable. Example, src/lib/runscript.h:
245 extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
249 extern int DLL_IMP_EXP num_jobs_run;
250 extern DLL_IMP_EXP dlist * last_jobs;
254 Exporting functions is now more or less automated. If you find that
255 a function name has been added, changed, or an argument modified,
256 simply do the following:
258 cd .../bacula/src/win32/lib
259 make (to build the .o files, note the link will fail)
260 ./make_def >bacula64.def
262 This should rebuild the bacula.def file, but it uses relative paths
263 and assumes you have the directory structure noted above. If you
264 are using something different, you can set the NM variable at the
265 top of the make_def file to use an absolute path to the correct
268 ===== manual changing of bacula32.def or bacula64.def no longer necessary =====
269 If you want to do it manually, please see below:
270 Exporting a function requires a bit more work. You must determine the
271 C++ mangled name of the new function.
273 strings .../bacula/src/win32/lib/<file>.o | grep <symbol>
275 Note, strings often will not show the desired symbol. In that case,
278 nm .../bacula/src/win32/lib/<file>.o
280 Replace <file> with the base part of the name of the source code file
281 which contains the new function. Replace <symbol> with the name of
282 the new function. Remove the leading underscore and place the result
285 .../bacula/src/win32/lib/bacula64.def
286 === end manual changing of bacula64.def ==========
288 If you add a new file, you will need to specify its name in
290 .../bacula/src/win32/lib/Makefile
292 .../bacula/src/win32/libbac/Makefile
295 Running gdb on the Win32 files
296 ==================================================
297 You can use the mingw64 gdb to debug Bacula on Win64 by downloading
298 it from Source Forge:
300 http://sourceforge.net/project/showfiles.php?group_id=202880&package_id=311650
303 Download one of their .exe versions, which is an installer that you
304 can run on Win32 to install gdb. This gdb is built with mingw64 so will
305 run independently of any cygwin installation. Note, not all the releases
306 come with an installer. I had to go back 3 or 4 versions to find it. Otherwise
307 you can download the source and build it. Thanks to Eric Bollengier for
311 Structure of the MinGW64/32 build environment
312 ==========================================
314 The basic strategy is each Makefile in the various subdirectories includes
315 Makefile.inc, defines variables and rules specific to what is being built,
316 then includes Makefile.rules which defines all the rules.
318 Makefile.inc defines the locations of all the dependencies and the compiler
319 and linker flags. It is automatically created from Makefile.inc.in. Any
320 changes must be made to Makefile.inc.in not Makefile.inc or they will be
321 overwritten the next time Makefile.inc.in is updated.
323 Makefile.rules defines a bunch of macros to simplify building. It also
324 includes all the basic rules for building objects, GUI and console
327 Makefile.template is a template for creating new Makefiles, if you are
328 creating a new directory, copy Makefile.template to Makefile in that
329 directory and edit to suit.