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

   1 Instructions to build Bacula using the MinGW64 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 Ubuntu 8.04 so building on that system should definitely work.  But there
   7 shouldn't be any issues on other Linux distributions.
   8
   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.
  12
  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.
  16
  17 Directory Structure
  18 =====================
  19 The new directory structure is:
  20
  21   bacula-top                 Top level directory -- any name
  22     bacula                   Top level Bacula source directory -- any name
  23       src
  24         win32                Main directory where Windows version is built.
  25
  26     docs                     Top level Bacula documentation directory
  27
  28     depkgs-mingw32 (MinGW32) 3rd Party Dependencies for MinGW32 build
  29       bin              --    NOTE!  depkgs-msvc is no longer suppored
  30       include            |
  31       lib                |
  32       man                |   Created by script
  33       nsis               |-- .../bacula/src/win32/build-depkgs-mingw32
  34       scons              |
  35       share              |
  36       src                |
  37       ssl              --
  38       vss
  39         inc                  A copy of the Windows VSS/inc directory
  40
  41
  42     depkgs-mingw-w64 (MinGW64) 3rd Party Dependencies for MinGW64 build
  43       bin              --
  44       include            |
  45       lib                |
  46       man                |
  47       nsis               |
  48       scons              |
  49       share              |
  50       src                |
  51       ssl              --
  52       vss
  53         inc                  A copy of the Windows VSS/inc directory
  54
  55     cross-tools (MinGW64/32)  Cross compilation tools (gcc, g++, mingw32, ...)
  56       binutils-mingw32 --
  57       gcc-mingw32        |   Created by script
  58       mingw32            |-- .../bacula/src/win32/build-win32-cross-tools
  59       mingw-utils        |
  60       source           --
  61       mingw-w64/x86_64-pc-mingw32  \ Taken from http://sf.net/projects/mingw-w64
  62       mingw-w64/bin/               /
  63
  64
  65
  66 One-time Setup
  67 ==============
  68
  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.
  71
  72 You also need to download one of the doc tar balls and extract to your
  73 top level Bacula directory.
  74
  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).
  78
  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:
  82
  83   texinfo
  84   flex
  85   bison
  86   patch (Debian)
  87   m4
  88   postgresql (at least client)
  89   mysql (at least client)
  90   SQLite3 (from depkgs or as package)
  91   readline (readlineN-dev on Debian)
  92   ...
  93
  94 NB: On Debian, I had to remove /usr/bin/lorder for
  95 postresql to build correctly.
  96
  97 Once the source is on your system, change to the win32 directory
  98         cd .../bacula/src/win32
  99
 100 Download and build the cross compiler tools
 101         ./build-win32-cross-tools
 102
 103 Download and build the 3rd party dependencies
 104         ./build-depkgs-mingw32
 105
 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:
 110
 111   cd .../depkgs-mingw32/src/<package-name>
 112
 113 where <package-name> is where the package is unpacked and built. Normally
 114 it is relatively obvious when looking at the src directory.
 115
 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.
 118
 119 When building the mingw64 environment and all dependencies (cross-tools, and depkgs-mingw64)
 120 should be compiled by hand with host=x86_64-pc-linux and target=x86_64-pc-mingw32.
 121 For that, use this configure line :
 122
 123 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/cross-tools
 124 or
 125 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/depkgs-mingw64
 126
 127 (It can work with other setup). We are using binutils-2.19, gcc-4.3.2,
 128 gmp-4.2.4, mpfr-2.3.2. The mingw64 project delivers binaries that should do the
 129 work.
 130
 131 Internal scripts and patches are using mingw32-xxx binaries, so you need to
 132 make links in the gcc bin ($ROOT/cross-tools/mingw-w64/bin) directory.
 133
 134 ---8<------8<-------8<--------
 135
 136 for i in x86_64-pc-mingw32-*
 137 do
 138     ln -s $i ${i##x86_64-pc-}
 139 done
 140
 141 ---8<------8<-------8<--------
 142
 143 They provide also a pthread lib but we aren't sure that they will work, you
 144 can compile it yourself using the pthreads-snap-2004-06-22.tar.gz (same as
 145 mingw32) + pthread-win64.patch.
 146
 147 The openssl lib version is openssl-0.9.8j.tar.gz + openssl-win64.patch
 148
 149 See External-mingw-w64 for download location (available on www.bacula.org).
 150
 151 You need the header files from the Microsoft VSS SDK.  Unfortunately the SDK
 152 can only be downloaded and installed on a Windows system.  We do not have
 153 the right to distribute it, so you must download it yourself.
 154 You can find it on Microsoft's web-site at:
 155
 156 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
 157
 158 If that link doesn't work then go to http://www.microsoft.com and search for
 159
 160         "download volume shadow copy service sdk"
 161
 162 we are currently using version 7.2 released 8/3/2005.
 163
 164 Normally the files will be installed in:
 165
 166         c:\Program Files\Microsoft\VSSSDK72
 167
 168 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
 169 directory into .../depkgs-mingw32/vss/inc. and .../depkgs-mingw-w64/vss/inc
 170 In doing so, please ensure that
 171 the case in maintained on the directory and filenames -- some contain uppercase
 172 characters !!!
 173
 174 The above only needs to be done once unless we change the cross-tools
 175 or the dependencies versions.  In general, you can run the script multiple
 176 times with no problem.  For it to work, you must have at a minimum the
 177 following:
 178
 179         gcc
 180         g++
 181         wget
 182         texinfo
 183         bison
 184         flex
 185         python
 186         unzip
 187         tar
 188
 189 and possibly other packages.
 190
 191
 192 Building
 193 ========
 194
 195 Finally, to build the Microsoft Windows version of Bacula, do the following:
 196
 197    cd .../bacula/src/win32
 198    make clean
 199    make WIN64=yes
 200
 201 At this time, the installer doesn't work, binaries are located in
 202 .../bacula/src/win32/release
 203
 204 If you have an older build environment, you might do the following
 205 to ensure that you pick up all the new Win32 changes:
 206
 207    cd .../bacula
 208    make clean
 209    svn update
 210    cd src/win32
 211    make WIN64=yes
 212
 213 To build the win32 version (director/storage/filed) you need to clean all
 214 objects from a previous build.
 215
 216
 217 Updating the 3rd party package patches
 218 ======================================
 219
 220 If one of the patches changes in .../bacula/src/win32/patches, you will
 221 need to update the corresponding dependency.
 222
 223 Adding a new global function or global data
 224 ===========================================
 225
 226 bacula.dll
 227 ----------
 228
 229 The code from the following directories is built into bacula.dll:
 230
 231    .../bacula/src/lib
 232    .../bacula/src/libfind
 233    .../bacula/src/win32/compat
 234
 235 A new function or data variable which must be accessed from outside
 236 of bacula.dll requires special treatment.  It must be specifically
 237 exported.
 238
 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:
 243
 244 extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
 245
 246 or src/jcr.h
 247
 248 extern int DLL_IMP_EXP num_jobs_run;
 249 extern DLL_IMP_EXP dlist * last_jobs;
 250 ...
 251
 252
 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:
 256
 257    cd .../bacula/src/win32/lib
 258    make                  (to build the .o files, note the link will fail)
 259    ./make_def >bacula64.def
 260
 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
 265 directory.
 266
 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.
 271
 272    strings .../bacula/src/win32/lib/<file>.o | grep <symbol>
 273
 274 Note, strings often will not show the desired symbol. In that case,
 275 use:
 276
 277    nm .../bacula/src/win32/lib/<file>.o
 278
 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
 282 in the file
 283
 284    .../bacula/src/win32/lib/bacula64.def
 285 === end manual changing of bacula64.def ==========
 286
 287 If you add a new file, you will need to specify its name in
 288
 289    .../bacula/src/win32/lib/Makefile
 290 and
 291    .../bacula/src/win32/libbac/Makefile
 292
 293
 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:
 298
 299 http://sourceforge.net/project/showfiles.php?group_id=202880&package_id=311650
 300
 301
 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
 307 this tip.
 308
 309
 310 Structure of the MinGW64/32 build environment
 311 ==========================================
 312
 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.
 316
 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.
 321
 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
 324 executables, etc.
 325
 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.