1 Instructions to build Bacula using the MinGW32 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 Fedora Core 5 and SuSE so those should definitely work. But there
7 shouldn't be any issues on other Linux distributions.
9 We don't officially support this script, 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 It has also been tested on other systems such as FreeBSD and CentOS. We
14 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.
21 If you're reading this file you've probably already enlisted in the SVN tree or
22 extracted the contents of the source tar. If not you need to do that first.
24 You also need to download one of the doc tar balls and extract to your
25 top level Bacula directory. It is referred to as bacula-top in the
26 diagram located in README.win32. It will be signified in this file as ...
28 The extracted doc directory name will be bacula-docs-version where version
29 is the version number. The directory must be renamed to docs (ie remove
30 the leading bacula- and the -version portion of the name).
32 Note, a number of packages must be installed to build the cross-tools
33 and the depkgs files. Most are rather standard such as gcc, g++,
34 make, ... However a few that you may not have are:
43 Once the source is on your system, change to the win32 directory
44 cd .../bacula/src/win32
46 Download and build the cross compiler tools
47 ./build-win32-cross-tools
49 Download and build the 3rd party dependencies
50 ./build-depkgs-mingw32
52 Note, that during the build process you will see a moderate amount of
53 output. If something fails, it is probably because you don't have one
54 of the build dependencies (hopefully all mentioned above) loaded on your
55 system. To find out what is going wrong, do the following:
57 cd .../depkgs-mingw32/src/<package-name>
59 where <package-name> is where the package is unpacked and built. Normally
60 it is relatively obvious when looking at the src directory.
62 In that directory, you should find a make.log, which has the full details
63 of the compiles, links, and installs done for that package.
65 Note, if you are building on a 64 bit machine, please know that
66 the build for the depkgs-mingw32/scons puts the python scons libraries
67 in depkgs-mingw32/scons/lib64 but when running scons it looks for the
68 libs in depkgs-mingw32/scons/lib. So adding symlink from
69 depkgs-mingw32/scons/lib64 to depkgs-mingw32/scons/lib will fix the
72 You need the header files from the Microsoft VSS SDK. Unfortunately the SDK
73 can only be downloaded and installed on a Windows system. You can find it on
74 Microsoft's web-site at:
76 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
78 If that link doesn't work then go to http://www.microsoft.com and search for
80 "download volume shadow copy service sdk"
82 we are currently using version 7.2 released 8/3/2005.
84 Normally the files will be installed in:
86 c:\Program Files\Microsoft\VSSSDK72
88 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
89 directory into .../depkgs-mingw32/vss/inc. In doing so, please ensure that
90 the case in maintained on the directory and filenames -- some contain uppercase
93 The above only needs to be done once unless we change the cross-tools
94 or the dependencies versions. In general, you can run the script multiple
95 times with no problem. For it to work, you must have at a minimum the
104 and possibly other packages.
110 Finally, to build the Microsoft Windows version of Bacula, do the following:
112 cd .../bacula/src/win32
115 If all goes well, you will end with all the executables in the
116 .../bacula/src/win32/release directory.
118 If you have an older build environment, you might do the following
119 to ensure that you pick up all the new Win32 changes:
127 The installer is now built as part of the default rule when you
128 say "make" in the src/win32 directory.
131 Updating the 3rd party package patches
132 ======================================
134 If one of the patches changes in .../bacula/src/win32/patches, you will
135 need to update the corresponding dependency. You can install new patches
136 by doing the following (we assume the patch in question is for openssl).
138 cd .../bacula/src/win32
139 ./build-depkgs-mingw32 -C openssl
141 NOTE: The -C means clobber. Any local changes to the source code in
142 the .../depkgs-mingw32/src directory will be lost. The source
143 will be reextracted from the archive and the current patches
147 Adding a new global function or global data
148 ===========================================
153 The code from the following directories is built into bacula.dll:
156 .../bacula/src/libfind
157 .../bacula/src/win32/compat
159 A new function or data variable which must be accessed from outside
160 of bacula.dll requires special treatment. It must be specifically
163 New data variables are exported by adding the macro DLL_IMP_EXP to
164 the variable declaration in the header file. All exported variables
165 must be declared in a header file and MUST NOT be declared in a
166 source file referencing the variable.
168 Exporting functions is now more or less automated. If you find that
169 a function name has been added, changed, or an argument modified,
170 simply do the following:
172 cd .../bacula/src/win32/dll
173 make (to build the .o files, note the link will fail)
174 ./make_def >bacula.def
176 This should rebuild the bacula.def file.
178 ===== manual changing of bacula.def no longer necessary =====
179 If you want to do it manually, please see below:
180 Exporting a function requires a bit more work. You must determine the
181 C++ mangled name of the new function.
183 strings .../bacula/src/win32/dll/<file>.o | grep <symbol>
185 Note, strings often will not show the desired symbol. In that case,
188 nm .../bacula/src/win32/dll/<file>.o
190 Replace <file> with the base part of the name of the source code file
191 which contains the new function. Replace <symbol> with the name of
192 the new function. Remove the leading underscore and place the result
195 .../bacula/src/win32/dll/bacula.def
196 === end manual changing of bacula.def ==========
198 If you add a new file, you will need to specify its name in
200 .../bacula/src/win32/dll/Makefile
202 .../bacula/src/win32/libbac/Makefile
207 The code from the .../bacula/src/cats directory is built into database
208 provider specific libraries of the form cats_<db>.dll.
210 The database specific portion <db> is mysql for MySQL, pgsql for
211 PostgreSQL, sqlite for SQLite, and bdb for the built-in Bacula database.
213 During installation of the Director, one of the database libraries is
214 copied to the system and renamed bacula_cats.dll.
216 A new function or data variable which must be accessed from outside
217 of bacula_cats.dll requires special treatment. It must be specifically
220 New data variables are exported by placing their name in the file
221 .../bacula/src/win32/cats/bacula_cats.def.
223 As with the bacula.def file above, this is now more or less automated.
224 When the link dies, simply do the following:
226 cd .../bacula/src/win32
227 make (to build the .o files, note the link will fail)
229 ./make_def >bacula_cats.def
231 This should rebuild the bacula_cats.def file. Note, if you have
232 changed any data entry points, you will need to modify the make_def
233 script -- it should be rather obvious.
236 ===== manual changing of bacula_cats.def no longer necessary =====
237 Exporting a function requires a bit more work. You must determine the
238 C++ mangled name of the new function.
240 strings .../bacula/src/win32/cats/cats_*/<file>.o | grep <symbol>
242 Note, strings often will not show the desired symbol. In that case,
245 nm .../bacula/src/win32/dll/<file>.o
247 Replace <file> with the base part of the name of the source code file
248 which contains the new function. Replace <symbol> with the name of
249 the new function. Remove the leading underscore and place the result
250 in the .../bacula/src/win32/cats/bacula_cats.def file.
251 === end manual changing of bacula_cats.def ==========
254 Structure of the MinGW32 build environment
255 ==========================================
257 The basic strategy is each Makefile in the various subdirectories includes
258 Makefile.inc, defines variables and rules specific to what is being built,
259 then includes Makefile.rules which defines all the rules.
261 Makefile.inc defines the locations of all the dependencies and the compiler
262 and linker flags. It is automatically created from Makefile.inc.in. Any
263 changes must be made to Makefile.inc.in not Makefile.inc or they will be
264 overwritten the next time Makefile.inc.in is updated.
266 Makefile.rules defines a bunch of macros to simplify building. It also
267 includes all the basic rules for building objects, GUI and console
270 Makefile.template is a template for creating new Makefiles, if you are
271 creating a new directory, copy Makefile.template to Makefile in that
272 directory and edit to suit.