git.sur5r.net Git - bacula/bacula/blob - bacula/src/win32/README.mingw32

   1 Instructions to build Bacula using the MinGW32 on Linux
   2 =======================================================
   3
   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.
   8
   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.
  12
  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.
  17
  18 One-time Setup
  19 ==============
  20
  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.
  23
  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 ...
  27
  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).
  31
  32 Once the source is on your system, change to the win32 directory
  33         cd .../bacula/src/win32
  34
  35 Download and build the cross compiler tools
  36         ./build-win32-cross-tools
  37
  38 Download and build the 3rd party dependencies
  39         ./build-depkgs-mingw32
  40
  41 Note, that during the build process you will see a moderate amount of
  42 output. If something fails, it is probably because you don't have one
  43 of the build dependencies (hopefully all mentioned above) loaded on your
  44 system. To find out what is going wrong, do the following:
  45
  46   cd .../depkgs-mingw32/src/<package-name>
  47
  48 where <package-name> is where the package is unpacked and built. Normally
  49 it is relatively obvious when looking at the src directory.
  50
  51 In that directory, you should find a make.log, which has the full details
  52 of the compiles, links, and installs done for that package.
  53
  54 Note, if you are building on a 64 bit machine, please know that
  55 the build for the depkgs-mingw32/scons puts the python scons libraries
  56 in depkgs-mingw32/scons/lib64 but when running scons it looks for the
  57 libs in depkgs-mingw32/scons/lib. So adding symlink from
  58 depkgs-mingw32/scons/lib64 to depkgs-mingw32/scons/lib will fix the
  59 problem.
  60
  61 You need the header files from the Microsoft VSS SDK.  Unfortunately the SDK
  62 can only be downloaded and installed on a Windows system.  You can find it on
  63 Microsoft's web-site at:
  64
  65 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
  66
  67 If that link doesn't work then go to http://www.microsoft.com and search for
  68
  69         "download volume shadow copy service sdk"
  70
  71 we are currently using version 7.2 released 8/3/2005.
  72
  73 Normally the files will be installed in:
  74
  75         c:\Program Files\Microsoft\VSSSDK72
  76
  77 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
  78 directory into .../depkgs-mingw32/vss/inc.  In doing so, please ensure that
  79 the case in maintained on the directory and filenames -- some contain uppercase
  80 characters !!!
  81
  82 The above only needs to be done once unless we change the cross-tools
  83 or the dependencies versions.  In general, you can run the script multiple
  84 times with no problem.  For it to work, you must have at a minimum the
  85 following:
  86
  87         gcc
  88         g++
  89         wget
  90         texinfo
  91         bison
  92
  93 and possibly other packages.
  94
  95
  96 Building
  97 ========
  98
  99 Finally, to build the Microsoft Windows version of Bacula, do the following:
 100
 101    cd .../bacula/src/win32
 102    make
 103
 104 If all goes well, you will end with all the executables in the
 105 .../bacula/src/win32/release directory.
 106
 107 If you have an older build environment, you might do the following
 108 to ensure that you pick up all the new Win32 changes:
 109
 110    cd .../bacula
 111    make clean
 112    cvs -q update -d -P
 113    cd src/win32
 114    make
 115
 116 The installer is now built as part of the default rule when you
 117 say "make" in the src/win32 directory.
 118
 119
 120 Updating the 3rd party package patches
 121 ======================================
 122
 123 If one of the patches changes in .../bacula/src/win32/patches, you will
 124 need to update the corresponding dependency.  You can install new patches
 125 by doing the following (we assume the patch in question is for openssl).
 126
 127    cd .../bacula/src/win32
 128    ./build-depkgs-mingw32 -C openssl
 129
 130 NOTE: The -C means clobber.  Any local changes to the source code in
 131       the .../depkgs-mingw32/src directory will be lost.  The source
 132       will be reextracted from the archive and the current patches
 133       will be applied.
 134
 135
 136 Adding a new global function or global data
 137 ===========================================
 138
 139 bacula.dll
 140 ----------
 141
 142 The code from the following directories is built into bacula.dll:
 143
 144    .../bacula/src/lib
 145    .../bacula/src/libfind
 146    .../bacula/src/win32/compat
 147
 148 A new function or data variable which must be accessed from outside
 149 of bacula.dll requires special treatment.  It must be specifically
 150 exported.
 151
 152 New data variables are exported by adding the macro DLL_IMP_EXP to
 153 the variable declaration in the header file.  All exported variables
 154 must be declared in a header file and MUST NOT be declared in a
 155 source file referencing the variable.
 156
 157 Exporting functions is now more or less automated.  If you find that
 158 a function name has been added, changed, or an argument modified,
 159 simply do the following:
 160
 161    cd .../bacula/src/win32/dll
 162    make                  (to build the .o files, note the link will fail)
 163    ./make_def >bacula.def
 164
 165 This should rebuild the bacula.def file.
 166
 167 ===== manual changing of bacula.def no longer necessary =====
 168 If you want to do it manually, please see below:
 169 Exporting a function requires a bit more work.  You must determine the
 170 C++ mangled name of the new function.
 171
 172    strings .../bacula/src/win32/dll/<file>.o | grep <symbol>
 173
 174 Note, strings often will not show the desired symbol. In that case,
 175 use:
 176
 177    nm .../bacula/src/win32/dll/<file>.o
 178
 179 Replace <file> with the base part of the name of the source code file
 180 which contains the new function.  Replace <symbol> with the name of
 181 the new function.  Remove the leading underscore and place the result
 182 in the file
 183
 184    .../bacula/src/win32/dll/bacula.def
 185 === end manual changing of bacula.def ==========
 186
 187 If you add a new file, you will need to specify its name in
 188
 189    .../bacula/src/win32/dll/Makefile
 190 and
 191    .../bacula/src/win32/libbac/Makefile
 192
 193 bacula_cats.dll
 194 ---------------
 195
 196 The code from the .../bacula/src/cats directory is built into database
 197 provider specific libraries of the form cats_<db>.dll.
 198
 199 The database specific portion <db> is mysql for MySQL, pgsql for
 200 PostgreSQL, sqlite for SQLite, and bdb for the built-in Bacula database.
 201
 202 During installation of the Director, one of the database libraries is
 203 copied to the system and renamed bacula_cats.dll.
 204
 205 A new function or data variable which must be accessed from outside
 206 of bacula_cats.dll requires special treatment.  It must be specifically
 207 exported.
 208
 209 New data variables are exported by placing their name in the file
 210 .../bacula/src/win32/cats/bacula_cats.def.
 211
 212 As with the bacula.def file above, this is now more or less automated.
 213 When the link dies, simply do the following:
 214
 215    cd .../bacula/src/win32
 216    make                  (to build the .o files, note the link will fail)
 217    cd cats
 218    ./make_def >bacula_cats.def
 219
 220 This should rebuild the bacula_cats.def file. Note, if you have
 221 changed any data entry points, you will need to modify the make_def
 222 script -- it should be rather obvious.
 223
 224
 225 ===== manual changing of bacula_cats.def no longer necessary =====
 226 Exporting a function requires a bit more work.  You must determine the
 227 C++ mangled name of the new function.
 228
 229    strings .../bacula/src/win32/cats/cats_*/<file>.o | grep <symbol>
 230
 231 Note, strings often will not show the desired symbol. In that case,
 232 use:
 233
 234    nm .../bacula/src/win32/dll/<file>.o
 235
 236 Replace <file> with the base part of the name of the source code file
 237 which contains the new function.  Replace <symbol> with the name of
 238 the new function.  Remove the leading underscore and place the result
 239 in the .../bacula/src/win32/cats/bacula_cats.def file.
 240 === end manual changing of bacula_cats.def ==========
 241
 242
 243 Structure of the MinGW32 build environment
 244 ==========================================
 245
 246 The basic strategy is each Makefile in the various subdirectories includes
 247 Makefile.inc, defines variables and rules specific to what is being built,
 248 then includes Makefile.rules which defines all the rules.
 249
 250 Makefile.inc defines the locations of all the dependencies and the compiler
 251 and linker flags.  It is automatically created from Makefile.inc.in.  Any
 252 changes must be made to Makefile.inc.in not Makefile.inc or they will be
 253 overwritten the next time Makefile.inc.in is updated.
 254
 255 Makefile.rules defines a bunch of macros to simplify building.  It also
 256 includes all the basic rules for building objects, GUI and console
 257 executables, etc.
 258
 259 Makefile.template is a template for creating new Makefiles, if you are
 260 creating a new directory, copy Makefile.template to Makefile in that
 261 directory and edit to suit.