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

   1
   2 Instructions for cross compiling the Win32/64 FD on Linux
   3 =======================================================
   4
   5 This file documents the tools (scripts) we use for building Bacula for
   6 Microsoft Windows using the cross-compiler tools on a Linux system.  We
   7 use Ubuntu 8.04 so building on that system should definitely work.  But there
   8 shouldn't be any issues on other Linux distributions.
   9
  10 We don't officially support this method, but it is what we use, and it should
  11 build on any Linux machine if you carefully follow the instructions and have
  12 all the prerequisite programs loaded on your machine.
  13
  14 We 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 Note: the environment variable DEPKGS must point to a directory that
  19 contains: depkgs-mingw32 depkgs-mingw-w64 and cross-tools
  20
  21 Directory Structure
  22 =====================
  23 The new directory structure is:
  24
  25  xxx  (any directory)
  26     bacula                   Top level Bacula source directory -- any name
  27       src
  28         win32                Main directory where Windows version is built.
  29
  30     docs                     Top level Bacula documentation directory
  31
  32  yyy (any directory, but pointed to by the DEPKGS environment variable)
  33     depkgs-mingw32 (MinGW32) 3rd Party Dependencies for MinGW32 build
  34       bin              --    NOTE!  depkgs-msvc is no longer suppored
  35       include            |
  36       lib                |
  37       man                |   Created by script
  38       nsis               |-- .../bacula/src/win32/build-depkgs-mingw32
  39       scons              |
  40       share              |
  41       src                |
  42       ssl              --
  43       vss
  44         inc                  A copy of the Windows VSS/inc directory
  45
  46
  47     depkgs-mingw-w64 (MinGW64) 3rd Party Dependencies for MinGW64 build
  48       bin              --
  49       include            |
  50       lib                |
  51       man                |
  52       nsis               |
  53       scons              |
  54       share              |
  55       src                |
  56       ssl              --
  57       vss
  58         inc                  A copy of the Windows VSS/inc directory
  59
  60     cross-tools (MinGW64/32)  Cross compilation tools (gcc, g++, mingw32, ...)
  61       binutils-mingw32 --
  62       gcc-mingw32        |   Created by script
  63       mingw32            |-- .../bacula/src/win32/build-win32-cross-tools
  64       mingw-utils        |
  65       source           --
  66       mingw-w64/x86_64-pc-mingw32  \ Taken from http://sf.net/projects/mingw-w64
  67       mingw-w64/bin/               /
  68
  69
  70
  71 One-time Setup
  72 ==============
  73
  74 If you're reading this file you've probably already cloned the GIT source tree or
  75 extracted the contents of the source tar. If not you need to do that first.
  76
  77 You also need to download one of the doc tar balls and extract to your
  78 top level Bacula directory. For the moment, the 3.0.2 version of the
  79 installer requires doc files in the old 2.4.4 format.
  80
  81 The extracted doc directory name will be bacula-docs-version where version
  82 is the version number.  The directory must be renamed to docs (ie remove
  83 the leading bacula- and the -version portion of the name).
  84
  85 An alternative to setting up the old documents that are needed by the Win32
  86 installer, you may comment out the following lines in
  87 src/win32/win32_installer/Makefile:
  88
  89 #DOC_FILES := \
  90 #       manual/bacula.pdf \
  91 #       manual/bacula/*.html \
  92 #       manual/bacula/*.png  \
  93 #       manual/bacula/*.css
  94
  95 Note, a number of packages must be installed to build the cross-tools
  96 and the depkgs files.  Most are rather standard such as gcc, g++,
  97 make, ...  However a few that you may not have are:
  98
  99   texinfo
 100   flex
 101   bison
 102   patch (Debian)
 103   m4
 104   postgresql (at least client)
 105   mysql (at least client)
 106   SQLite3 (from depkgs or as package)
 107   readline (readlineN-dev on Debian)
 108   ...
 109
 110 NB: On Debian, I had to remove /usr/bin/lorder for
 111 postresql to build correctly.
 112
 113 Build the 32 bit cross-tools and mingw32:
 114
 115 Once the source is on your system, change to the win32 directory
 116         cd .../bacula/src/win32
 117
 118 Download and build the cross compiler tools
 119         ./build-win32-cross-tools
 120
 121 Download and build the 3rd party dependencies
 122         ./build-depkgs-mingw32
 123
 124 Note, that during the build process you will see a moderate amount of
 125 output and some warnings.  If something more serious happens
 126 and the build fails, it is probably because you don't have one
 127 of the build dependencies (hopefully all mentioned above) loaded on your
 128 system. To find out what is going wrong, do the following:
 129
 130   cd .../depkgs-mingw32/src/<package-name>
 131
 132 where <package-name> is where the package is unpacked and built. Normally
 133 it is relatively obvious when looking at the src directory.
 134
 135 In that directory, you should find a make.log, which has the full details
 136 of the compiles, links, and installs done for that package.
 137
 138 ===
 139 Building the 64 bit cross-tools and mingw64:
 140
 141 When building the mingw64 environment and all dependencies
 142 (cross-tools, and depkgs-mingw64) should be compiled by hand with
 143 host=x86_64-pc-linux and target=x86_64-pc-mingw32.
 144
 145 For that, use this configure line :
 146 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/cross-tools
 147 or
 148 ./configure --host=x86_64-pc-linux --target=x86_64-pc-mingw32 --prefix=$ROOT/depkgs-mingw64
 149
 150 (It can work with other setup). We are using binutils-2.19, gcc-4.3.2,
 151 gmp-4.2.4, mpfr-2.3.2. The mingw64 project delivers binaries that should do the
 152 work.
 153
 154 The Win64 internal scripts and patches use the  mingw32-xxx binaries, so you need to
 155 make links in the gcc bin ($ROOT/cross-tools/mingw-w64/bin) directory.
 156
 157 ---8<------8<-------8<--------
 158
 159 for i in x86_64-pc-mingw32-*
 160 do
 161     ln -s $i ${i##x86_64-pc-}
 162 done
 163
 164 ---8<------8<-------8<--------
 165
 166 They provide also a pthread lib but we aren't sure that they will work, you
 167 can compile it yourself using the pthreads-snap-2004-06-22.tar.gz (same as
 168 mingw32) + pthread-win64.patch.
 169
 170 The openssl lib version is openssl-0.9.8j.tar.gz + openssl-win64.patch
 171
 172 See External-mingw-w64 for download location (available on www.bacula.org).
 173
 174 You need the header files from the Microsoft VSS SDK.  Unfortunately the SDK
 175 can only be downloaded and installed on a Windows system.  We do not have
 176 the right to distribute it, so you must download it yourself.
 177 You can find it on Microsoft's web-site at:
 178
 179 http://www.microsoft.com/downloads/details.aspx?FamilyID=0b4f56e4-0ccc-4626-826a-ed2c4c95c871&DisplayLang=en
 180
 181 If that link doesn't work then go to http://www.microsoft.com and search for
 182
 183         "download volume shadow copy service sdk"
 184
 185 we are currently using version 7.2 released 8/3/2005 (a bit old, but it
 186 works).
 187
 188 Normally the files will be installed in:
 189
 190         c:\Program Files\Microsoft\VSSSDK72
 191
 192 You only need to copy everything under the c:\Program Files\Microsoft\VSSSDK72\inc
 193 directory into .../depkgs-mingw32/vss/inc. and .../depkgs-mingw-w64/vss/inc
 194 In doing so, please ensure that
 195 the case in maintained on the directory and filenames -- some contain uppercase
 196 characters !!!
 197
 198 The above only needs to be done once unless we change the cross-tools
 199 or the dependencies versions.  In general, you can run the script multiple
 200 times with no problem.  For it to work, you must have at a minimum the
 201 following:
 202
 203         gcc
 204         g++
 205         patch
 206         wget
 207         texinfo
 208         bison
 209         flex
 210         python
 211         unzip
 212         tar
 213
 214 and possibly other packages.
 215
 216
 217 Building
 218 ========
 219
 220 Finally, to build the Microsoft Windows version of Bacula, do the following:
 221
 222    cd .../bacula/src/win32
 223    make clean
 224    ./makeall
 225
 226 or
 227   cd .../bacula/src/win32
 228   make clean
 229   make
 230   make WIN64=yes
 231
 232 This builds both the 32 bit version and the 64 bit version.
 233 The binaries are in the release32 and release64 directories.
 234
 235
 236
 237 Updating the 3rd party package patches
 238 ======================================
 239
 240 If one of the patches changes in .../bacula/src/win32/patches, you will
 241 need to update the corresponding dependency.
 242
 243 Adding a new global function or global data
 244 ===========================================
 245
 246 bacula.dll
 247 ----------
 248
 249 The code from the following directories is built into bacula.dll:
 250
 251    .../bacula/src/lib
 252    .../bacula/src/libfind
 253    .../bacula/src/win32/compat
 254
 255 A new function or data variable which must be accessed from outside
 256 of bacula.dll requires special treatment.  It must be specifically
 257 exported.
 258
 259 New data variables are exported by adding the macro DLL_IMP_EXP to
 260 the variable declaration in the header file.  All exported variables
 261 must be declared in a header file and MUST NOT be declared in a
 262 source file referencing the variable. Example, src/lib/runscript.h:
 263
 264 extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
 265
 266 or src/jcr.h
 267
 268 extern int DLL_IMP_EXP num_jobs_run;
 269 extern DLL_IMP_EXP dlist * last_jobs;
 270 ...
 271
 272
 273 Exporting functions is now more or less automated.  If you find that
 274 a function name has been added, changed, or an argument modified,
 275 simply do the following:
 276
 277    cd .../bacula/src/win32/lib
 278    make                  (to build the .o files, note the link will fail)
 279    ./make_def >bacula64.def   or >bacula64.def
 280
 281 This should rebuild the bacula.def file, but it uses relative paths
 282 and assumes you have the directory structure noted above. If you
 283 are using something different, you can set the NM variable at the
 284 top of the make_def file to use an absolute path to the correct
 285 directory.
 286
 287 ===== manual changing of bacula32.def or bacula64.def no longer necessary =====
 288 If you want to do it manually, please see below:
 289 Exporting a function requires a bit more work.  You must determine the
 290 C++ mangled name of the new function.
 291
 292    strings .../bacula/src/win32/lib/<file>.o | grep <symbol>
 293
 294 Note, strings often will not show the desired symbol. In that case,
 295 use:
 296
 297    nm .../bacula/src/win32/lib/<file>.o
 298
 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 file
 303
 304    .../bacula/src/win32/lib/bacula64.def
 305 === end manual changing of bacula64.def ==========
 306
 307 If you add a new file, you will need to specify its name in
 308
 309    .../bacula/src/win32/lib/Makefile
 310 and
 311    .../bacula/src/win32/libbac/Makefile
 312
 313
 314 Running gdb on the Win32 files
 315 ==================================================
 316 You can use the mingw64 gdb to debug Bacula on Win64 by downloading
 317 it from Source Forge:
 318
 319 http://sourceforge.net/project/showfiles.php?group_id=202880&package_id=311650
 320
 321
 322 Download one of their .exe versions, which is an installer that you
 323 can run on Win32 to install gdb.  This gdb is built with mingw64 so will
 324 run independently of any cygwin installation.  Note, not all the releases
 325 come with an installer. I had to go back 3 or 4 versions to find it.  Otherwise
 326 you can download the source and build it.  Thanks to Eric Bollengier for
 327 this tip.
 328
 329
 330 Structure of the MinGW64/32 build environment
 331 ==========================================
 332
 333 The basic strategy is each Makefile in the various subdirectories includes
 334 Makefile.inc, defines variables and rules specific to what is being built,
 335 then includes Makefile.rules which defines all the rules.
 336
 337 Makefile.inc defines the locations of all the dependencies and the compiler
 338 and linker flags.  It is automatically created from Makefile.inc.in.  Any
 339 changes must be made to Makefile.inc.in not Makefile.inc or they will be
 340 overwritten the next time Makefile.inc.in is updated.
 341
 342 Makefile.rules defines a bunch of macros to simplify building.  It also
 343 includes all the basic rules for building objects, GUI and console
 344 executables, etc.
 345
 346 Makefile.template is a template for creating new Makefiles, if you are
 347 creating a new directory, copy Makefile.template to Makefile in that
 348 directory and edit to suit.