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.
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
31 depkgs-msvc (MS VC++) 3rd Party Dependencies for Microsoft VC++ build.
35 man | Created by script
36 nsis |-- .../bacula/src/win32/build-depkgs-mingw32
42 inc A copy of the Windows VSS/inc directory
44 cross-tools (MinGW32) Cross compilation tools (gcc, g++, mingw32, ...)
46 gcc-mingw32 | Created by script
47 mingw32 |-- .../bacula/src/win32/build-win32-cross-tools
55 If you're reading this file you've probably already enlisted in the SVN tree or
56 extracted the contents of the source tar. If not you need to do that first.
58 You also need to download one of the doc tar balls and extract to your
59 top level Bacula directory. It is referred to as bacula-top in the
60 diagram located in README.win32. It will be signified in this file as ...
62 The extracted doc directory name will be bacula-docs-version where version
63 is the version number. The directory must be renamed to docs (ie remove
64 the leading bacula- and the -version portion of the name).
66 Note, a number of packages must be installed to build the cross-tools
67 and the depkgs files. Most are rather standard such as gcc, g++,
68 make, ... However a few that you may not have are:
75 postgresql (at least client)
76 mysql (at least client)
77 SQLite3 (from depkgs or as package)
78 readline (readlineN-dev on Debian)
81 Once the source is on your system, change to the win32 directory
82 cd .../bacula/src/win32
84 Download and build the cross compiler tools
85 ./build-win32-cross-tools
87 Download and build the 3rd party dependencies
88 ./build-depkgs-mingw32
90 Note, that during the build process you will see a moderate amount of
91 output. If something fails, it is probably because you don't have one
92 of the build dependencies (hopefully all mentioned above) loaded on your
93 system. To find out what is going wrong, do the following:
95 cd .../depkgs-mingw32/src/<package-name>
97 where <package-name> is where the package is unpacked and built. Normally
98 it is relatively obvious when looking at the src directory.
100 In that directory, you should find a make.log, which has the full details
101 of the compiles, links, and installs done for that package.
103 Note, if you are building on a 64 bit machine, please know that
104 the build for the depkgs-mingw32/scons puts the python scons libraries
105 in depkgs-mingw32/scons/lib64 but when running scons it looks for the
106 libs in depkgs-mingw32/scons/lib. So adding symlink from
107 depkgs-mingw32/scons/lib64 to depkgs-mingw32/scons/lib will fix the
110 You need the header files from the Microsoft VSS SDK. Unfortunately the SDK
111 can only be downloaded and installed on a Windows system. You can find it on
112 Microsoft's web-site at:
114 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
116 If that link doesn't work then go to http://www.microsoft.com and search for
118 "download volume shadow copy service sdk"
120 we are currently using version 7.2 released 8/3/2005.
122 Normally the files will be installed in:
124 c:\Program Files\Microsoft\VSSSDK72
126 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
127 directory into .../depkgs-mingw32/vss/inc. In doing so, please ensure that
128 the case in maintained on the directory and filenames -- some contain uppercase
131 The above only needs to be done once unless we change the cross-tools
132 or the dependencies versions. In general, you can run the script multiple
133 times with no problem. For it to work, you must have at a minimum the
143 and possibly other packages.
149 Finally, to build the Microsoft Windows version of Bacula, do the following:
151 cd .../bacula/src/win32
154 If all goes well, you will end with all the executables in the
155 .../bacula/src/win32/release directory.
157 If you have an older build environment, you might do the following
158 to ensure that you pick up all the new Win32 changes:
166 The installer is now built as part of the default rule when you
167 say "make" in the src/win32 directory.
170 Updating the 3rd party package patches
171 ======================================
173 If one of the patches changes in .../bacula/src/win32/patches, you will
174 need to update the corresponding dependency. You can install new patches
175 by doing the following (we assume the patch in question is for openssl).
177 cd .../bacula/src/win32
178 ./build-depkgs-mingw32 -C openssl
180 NOTE: The -C means clobber. Any local changes to the source code in
181 the .../depkgs-mingw32/src directory will be lost. The source
182 will be reextracted from the archive and the current patches
186 Adding a new global function or global data
187 ===========================================
192 The code from the following directories is built into bacula.dll:
195 .../bacula/src/libfind
196 .../bacula/src/win32/compat
198 A new function or data variable which must be accessed from outside
199 of bacula.dll requires special treatment. It must be specifically
202 New data variables are exported by adding the macro DLL_IMP_EXP to
203 the variable declaration in the header file. All exported variables
204 must be declared in a header file and MUST NOT be declared in a
205 source file referencing the variable. Example, src/lib/runscript.h:
207 extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
211 extern int DLL_IMP_EXP num_jobs_run;
212 extern DLL_IMP_EXP dlist * last_jobs;
216 Exporting functions is now more or less automated. If you find that
217 a function name has been added, changed, or an argument modified,
218 simply do the following:
220 cd .../bacula/src/win32/dll
221 make (to build the .o files, note the link will fail)
222 ./make_def >bacula.def
224 This should rebuild the bacula.def file, but it uses relative paths
225 and assumes you have the directory structure noted above. If you
226 are using something different, you can set the NM variable at the
227 top of the make_def file to use an absolute path to the correct
230 ===== manual changing of bacula.def no longer necessary =====
231 If you want to do it manually, please see below:
232 Exporting a function requires a bit more work. You must determine the
233 C++ mangled name of the new function.
235 strings .../bacula/src/win32/dll/<file>.o | grep <symbol>
237 Note, strings often will not show the desired symbol. In that case,
240 nm .../bacula/src/win32/dll/<file>.o
242 Replace <file> with the base part of the name of the source code file
243 which contains the new function. Replace <symbol> with the name of
244 the new function. Remove the leading underscore and place the result
247 .../bacula/src/win32/dll/bacula.def
248 === end manual changing of bacula.def ==========
250 If you add a new file, you will need to specify its name in
252 .../bacula/src/win32/dll/Makefile
254 .../bacula/src/win32/libbac/Makefile
259 The code from the .../bacula/src/cats directory is built into database
260 provider specific libraries of the form cats_<db>.dll.
262 The database specific portion <db> is mysql for MySQL, pgsql for
263 PostgreSQL, sqlite for SQLite, and bdb for the built-in Bacula database.
265 During installation of the Director, one of the database libraries is
266 copied to the system and renamed bacula_cats.dll.
268 A new function or data variable which must be accessed from outside
269 of bacula_cats.dll requires special treatment. It must be specifically
272 New data variables are exported by placing their name in the file
273 .../bacula/src/win32/cats/bacula_cats.def.
275 As with the bacula.def file above, this is now more or less automated.
276 When the link dies, simply do the following:
278 cd .../bacula/src/win32
279 make (to build the .o files, note the link will fail)
281 ./make_def >bacula_cats.def
283 This should rebuild the bacula_cats.def file. Note, if you have
284 changed any data entry points, you will need to modify the make_def
285 script -- it should be rather obvious.
288 ===== manual changing of bacula_cats.def no longer necessary =====
289 Exporting a function requires a bit more work. You must determine the
290 C++ mangled name of the new function.
292 strings .../bacula/src/win32/cats/cats_*/<file>.o | grep <symbol>
294 Note, strings often will not show the desired symbol. In that case,
297 nm .../bacula/src/win32/dll/<file>.o
299 Replace <file> with the base part of the name of the source code file
300 which contains the new function. Replace <symbol> with the name of
301 the new function. Remove the leading underscore and place the result
302 in the .../bacula/src/win32/cats/bacula_cats.def file.
303 === end manual changing of bacula_cats.def ==========
306 Structure of the MinGW32 build environment
307 ==========================================
309 The basic strategy is each Makefile in the various subdirectories includes
310 Makefile.inc, defines variables and rules specific to what is being built,
311 then includes Makefile.rules which defines all the rules.
313 Makefile.inc defines the locations of all the dependencies and the compiler
314 and linker flags. It is automatically created from Makefile.inc.in. Any
315 changes must be made to Makefile.inc.in not Makefile.inc or they will be
316 overwritten the next time Makefile.inc.in is updated.
318 Makefile.rules defines a bunch of macros to simplify building. It also
319 includes all the basic rules for building objects, GUI and console
322 Makefile.template is a template for creating new Makefiles, if you are
323 creating a new directory, copy Makefile.template to Makefile in that
324 directory and edit to suit.