1 This software has been released under the terms of the IBM Public
2 License. For details, see the LICENSE file in the top-level source
3 directory or on-line at http://www.openafs.org/dl/license10.html
5 The document now provides a step by step procedure that takes the user
6 from a basic Windows 2000/XP/2003 workstation to an OpenAFS development
7 environment. Details are provided so that a 'beginning' windows
8 developer can build an OpenAFS installable package for Windows 2000/XP/2003.
11 As of the OpenAFS 1.3 release series, Windows platforms released
12 prior to Windows 2000 are not being supported. The InstallShield
13 installer is still in the source tree but is no longer supported.
14 A new open source installer based on NSIS 2.07 replaces it.
16 *********** Windows 2000/XP/2003 Build Process ****************
18 Building OpenAFS for Windows requires configuring a Windows
19 development system by installing compilation tools and header files.
20 Open AFS Software development can be done on Windows 2000 or XP. The
21 target system, where OpenAFS will be installed, should be either
22 Windows 2000, Windows XP, or Windows 2003. The building process is
23 controlled by a nmake file that generates the necessary binaries and
24 binds them into an install package.
26 The following steps describe how to configure Windows 2000/XP:
28 A. Obtain a copy of the OpenAFS Source Tree
29 B. Install Compiler and Development tools.
30 C. Install SDK header files
31 D. Configure NTBUILD.BAT
32 E. Set program version Level
33 F. Build Win2000 binaries
35 H. Build NSIS Install Package
37 J. Build Wix MSI Install Package
41 The Microsoft development tools require anywhere from 660 MB to 1.8GB
42 of storage depending on which compilers are selected. The following
43 versions are supported:
45 Microsoft Visual Studio .NET
46 available via a MSDN subscription
48 Microsoft Visual Studio .NET 2003 (recommended)
49 available via a MSDN subscription
51 Microsoft Visual Studio .NET 2005 (do not use for production)
52 available via a MSDN subscription
54 The following Microsoft SDK is required:
56 Microsoft Platform SDK for Windows XP SP2 [Core, Data Access and Installer SDKs are required]
57 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/downlevel.htm [IE required]
58 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
60 The following Microsoft DDK is required:
62 Microsoft Windows Server 2003 SP1 DDK
63 available via a MSDN subscription or via free CD
64 http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx
66 The NSIS installer requires about 14 MB of storage. The following
69 Nullsoft Scriptable Installation System 2.07
70 http://nsis.sourceforge.net/home/
72 The WiX installer requires about 18 MB of storage. The following
76 http://prdownloads.sourceforge.net/wix/sources-2.0.2217.0.zip
78 The InstallShield scripts (although not supported) require version 5.5
79 of InstallShiled. Version 6.0 or higher of InstallShield are not
82 The OpenAFS Source directory requires about 360 MB storage. The Source
83 directory size includes additional space for files that will be
84 generated during the build process.
87 STEP A. Obtain a copy of the Open AFS Source Tree.
89 Transfer OpenAFS source tree onto your hardrive. The source can be
90 downloaded from the OpenAFS web site:
91 http://www.OpenAFS.org/release/snapindex.html.
93 For this example, download source for version 1.3.74 using the
95 http://www.openafs.org/dl/openafs/1.3.74/openafs-1.3.74-src.tar
97 HINT: DailySnapShots are pre-release source trees and much more
98 likely to have compilation errors. If this is your first attempt, do
99 your build based on a release version of the source, e.g. 1.3.74. Once
100 you have completed a build process successfully, you can experiment with
103 You will need an unzip utility that can expand compressed tar files.
104 For example "Pkzip for Windows" from Pkware will uncompress tar files.
105 (http://www.pkware.com/)
107 Expand the downloaded tar file (openafs-1.3.74-src.tar) into target
108 directory (c:\OpenAFS), the unzip routine will expand the source into a
110 c:\OpenAFS\OpenAFS-1.3.74\src
112 Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS
113 base directory (aka %AFSROOT%):
115 From a DOS command prompt window, enter the following copy commands:
117 cd c:\OpenAFS\OpenAFS-1.3.74
118 copy src\NTMakefile .
119 copy src\ntbuild.bat .
122 The AFS base directory should look something like the following:
124 c:\OpenAFS\OpenAFS-1.3.74\
130 STEP B. Install compiler and development tools.
132 Install a copy of Microsoft Visual Studio .NET, Visual Studio .NET 2003,
133 or Visual Studio .NET 2005. The "Typical" install setting is sufficient.
135 (1) You can reduce the installation size by selecting "Custom" install
136 and remove all but the following Options:
141 (2) When asked, Select to Register Environment Variables.
144 STEP C. Install SDK header files.
146 Files from Microsoft's Platform SDK for Windows XP SP2 is required to
147 complete a build on Windows 2000/XP/2003. You can install the "Core, Data
148 Access and Installer SDKs" from
150 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
152 by using Internet Explorer 5.x or higher. (Active X controls are required)
153 If you do not which to use IE a complete SDK package is available from
155 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
157 The header files that are required are found from a Microsoft SDK are:
159 npapi.h (Windows 2000,XP,2003 builds)
160 netcfgx.h (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
161 netcfgn.h (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
163 These files come from the following Microsoft DDKs/SDKs:
166 Windows XP SP2 Platform SDK - include/
168 netcfgn.h, netcfgx.h:
169 Windows XP/2003 DDK - inc/wxp/
172 STEP D. Configure NTBUILD.BAT.
174 The NTBUILD.BAT file copied to the OpenAFS base directory must be
175 customized for use on your development system. The following variables
176 must be defined to match your configuration:
178 AFSVER_CL: Set to 1200 if using MS Visual C++ 6.0
179 Set to 1300 if using MS Visual Studio .NET
180 Set to 1310 if using MS Visual Studio .NET 2003
181 Set to 1400 if using MS Visual Studio .NET 2005
183 MSVCDIR: Set to the short name version of the directory into which
184 the visual C++ compiler was installed regardless of version
186 MSSDKDIR: Set to the short name of the directory into which
187 the Platform SDK was installed
189 NTDDKDIR: Set the short name of the directory containing the npapi.h file
191 AFSROOT: Set to the short name of the OpenAFS Base directory. This
192 cannot be set to a UNC path.
195 STEP E. Set version and installation options (optional)
197 Add a CellServDB file to install area. CellServDB contains the entries
198 for the various cell names. You can download a general purpose one
200 http://grand.central.org/dl/cellservdb/CellServDB
201 then copy it to %AFSROOT%\src\WINNT\install\NSIS and name it afsdcell.ini
203 Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k
204 AFSPRODUCT_VER_MAJOR - Version Major Number
205 AFSPRODUCT_VER_MINOR - Version Minor Number
206 AFSPRODUCT_VER_PATCH - Version Patch Number
207 AFSPRODUCT_VER_BUILD - Version Build Number
208 CELLSERVDB_INSTALL - The default file name for the CellServDB
209 included in the install Package.
210 CELLNAME_DEFAULT - The default home cell name.
211 CELLSERVDB_WEB - The default web address to obtain CellServDB
213 For example: in the file %AFSROOT%\src\config\NTMakefile.i386_nt40 you would
216 AFSPRODUCT_VER_MAJOR=1
217 AFSPRODUCT_VER_MINOR=3
218 AFSPRODUCT_VER_PATCH=7400
219 AFSPRODUCT_VER_BUILD=0
220 CELLNAME_DEFAULT=openafs.org
221 CELLSERVDB_INSTALL=CellServDB.GrandCentral
222 CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB
224 During the Open AFS installation process the user will be presented
225 with two choices for the CellServDB: Local copy (CELLSERVDB_INSTALL) and
226 one that can be downloaded from the web (CELLSERVDB_WEB).
228 STEP F. Begin the build
230 (1) From Windows 2000/XP/2003 open up a DOS prompt window.
232 (2) Change to the %AFSROOT% directory
234 (3) Configure the environment variables:
238 (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
239 Visual Studio environment you installed.
241 (b) Execute the SETENV.BAT file with the parameters "/2000 /RETAIL"
243 (c) Execute the NTBUILD.BAT file with the parameter "free"
247 (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
248 Visual Studio environment you installed.
250 (b) Execute the SETENV.BAT file with the parameters "/2000 /DEBUG"
252 (c) Execute the NTBUILD.BAT file with the parameter "checked"
254 (4) Clean the work area:
256 nmake /f NTMakefile clean
258 (5) Build the complete Windows 2000/XP/2003 development environment.
260 nmake /f NTMakefile install
262 While the build is running you will see many compile warnings. This
263 behavior is normal; the build process is successful as long as the build
264 process doesn't terminate with an error ("nmake.exe return code 0x2")
265 and it displays 'Build Finished Successfully'.
268 STEP G. Install NSIS 2.07 (optional).
270 Download the Nullsoft Scriptable Installation System (NSIS) 2.07 from
272 http://nsis.sourceforge.net/home/
274 Run the nsis20.exe installer.
276 NOTE: The NSIS installer may be rebuilt from source files
278 C:\Program Files\NSIS\Source
280 to enable options not built into the default configuration. The
281 OpenAFS installers are built using a modified version of the NSIS
282 sources. The following changes were made to exehead\config.h.
284 NSIS_MAX_STRLEN set to 4096
285 NSIS_CONFIG_LOG defined
286 NSIS_CONFIG_LOG_ODS defined
289 STEP H. Build OpenAFS NSIS install package
291 From the %AFSROOT% directory execute:
293 nmake /f NTMakefile NSIS
296 STEP I. Install Wix MSI Installer
298 Download the Wix 2.0.2217.0 installer from
300 http://prdownloads.sourceforge.net/wix/sources-2.0.2217.0.zip
302 Apply the following patches to the source tree and execute
306 from the \src\wix directory.
308 Index: src/wix/Common.cs
309 ===================================================================
310 RCS file: /cvsroot/wix/wix/src/wix/Common.cs,v
311 retrieving revision 1.7
312 diff -w -r1.7 Common.cs
314 > public static long GetFileTimeFromDateTime(string dateTime)
316 > System.DateTime sdt = System.Xml.XmlConvert.ToDateTime(dateTime);
317 > return sdt.ToFileTime();
320 Index: src/wix/Compiler.cs
321 ===================================================================
322 RCS file: /cvsroot/wix/wix/src/wix/Compiler.cs,v
323 retrieving revision 1.14
324 diff -w -r1.14 Compiler.cs
326 < this.AddRegistryKey(sourceLineNumbers, null, MsiInterop.MsidbRegistryRootClassesRoot, String.Concat("CLSID\\", classId, "\\", context[i]), String.Empty, String.Concat("\"[!", fileServer, "]", argument == null ? String.Empty : " ", argument, "\""), componentId); // ClassId context
328 > this.AddRegistryKey(sourceLineNumbers, null, MsiInterop.MsidbRegistryRootClassesRoot, String.Concat("CLSID\\", classId, "\\", context[i]), String.Empty, String.Concat("\"[#", fileServer, "]", argument == null ? String.Empty : " ", argument, "\""), componentId); // ClassId context
330 > // if a Value attribute was given by itself, make this a type 19 custom action
331 > if( sourceBits == 0 && targetBits == MsiInterop.MsidbCustomActionTypeTextData )
333 > sourceBits = MsiInterop.MsidbCustomActionTypeSourceFile;
337 < minDate = attrib.Value;
339 > minDate = Common.GetFileTimeFromDateTime( attrib.Value ).ToString();
341 < maxDate = attrib.Value;
343 > maxDate = Common.GetFileTimeFromDateTime( attrib.Value ).ToString();
346 > switch (attrib.Value)
349 > events |= MsiInterop.MsidbServiceControlEventDelete;
352 > events |= MsiInterop.MsidbServiceControlEventUninstallDelete;
355 > events |= MsiInterop.MsidbServiceControlEventDelete | MsiInterop.MsidbServiceControlEventUninstallDelete;
361 Index: src/wix/Preprocessor.cs
362 ===================================================================
363 RCS file: /cvsroot/wix/wix/src/wix/Preprocessor.cs,v
364 retrieving revision 1.6
365 diff -w -r1.6 Preprocessor.cs
367 < context = new IfContext(context.IsTrue & context.Active, this.variables.ContainsKey(reader.Value.Trim()), IfState.If);
369 > context = new IfContext(context.IsTrue & context.Active, this.IsDefined(reader.Value.Trim()), IfState.If);
371 < context = new IfContext(context.IsTrue & context.Active, !this.variables.ContainsKey(reader.Value.Trim()), IfState.If);
373 > context = new IfContext(context.IsTrue & context.Active, !this.IsDefined(reader.Value.Trim()), IfState.If);
376 > throw new WixPreprocessorException(this.GetCurrentSourceLineNumbers(), this.PreprocessVariables(reader.Value));
378 > /// Returns true if the symbol exists.
380 > /// <param name="symbol">symbol name to check</param>
381 > /// <returns>true if symbol is defined</returns>
382 > private bool IsDefined(string symbol)
384 > if( symbol.StartsWith("env.") )
385 > return Environment.GetEnvironmentVariable(symbol.Substring(4)) != null;
386 > if( symbol.StartsWith("var.") )
387 > return this.variables.ContainsKey(symbol.Substring(4));
388 > if( symbol.StartsWith("sys.") )
389 > return this.systemVariables.ContainsKey(symbol.Substring(4));
390 > return this.variables.ContainsKey(symbol);
394 Index: src/wix/wix.csproj
395 ===================================================================
396 RCS file: /cvsroot/wix/wix/src/wix/wix.csproj,v
397 retrieving revision 1.4
398 diff -w -r1.4 wix.csproj
400 > RelPath = "Xsd\wix.xsx"
401 > DependentUpon = "wix.xsd"
402 > BuildAction = "None"
407 > RelPath = "Xsd\wixloc.xsx"
408 > DependentUpon = "wixloc.xsd"
409 > BuildAction = "None"
413 STEP J. Build Wix MSI install package
415 From the %AFSROOT% directory execute:
417 nmake /f NTMakefile wix
419 Make sure the binaries installed to \src\wix\release\ship are
420 available in the PATH environment variable
423 STEP K. Final Results
425 The build process generates its binaries in %AFSROOT%\DEST. The subdirectory
426 would look like the following:
428 %AFSROOT%\DEST\{checked,free}\
437 Bin - contains build utilities.
438 root.client - contains Open AFS binaries
439 root.server - contain Open AFS Server binaries
440 WinInstall\OpenAFSforWindows.exe - is the NSIS install package
441 WinInstall\openafs-en_US.msi - is the WiX MSI install package
444 STEP L. Optional Items
446 The build process has an error table that is compiled for many OpenAFS
447 applications. This table is generated by Unix based tools. It is not
448 normally necessary to modify this table so pre-generated source files
449 are included in the OpenAFS source. If you need to make modifications
450 in these areas the Unix base tools that run on Windows can be found on
451 the web. For example:
455 Below is a short explanation how to update the error table.
457 (1) Install flex and bison from a Unix based tool provider.
459 (2) Make changes to the source files.
461 There are two files in the source tree that are processed with lex
462 and yacc on UNIX systems, src/comerr/et_lex.lex.l and
463 src/comerr/error_table.y, that when processed produce the files
464 et_lex.lex_nt.c, error_table_nt.c, and error_table_nt.h.
466 Since NT does not include lex and yacc or any equivalent tools, we
467 have provided the output files that lex and yacc produce (using Win32
468 ports of flex and bison). This will allow builds to work for anyone
469 who does not need to change the .l and .y files.
471 If you do need to change et_lex.lex.l, then you will need to install
472 Win32 port of flex on your system. Put flex.exe in a directory on the
475 If you do need to change error_table.y, then you will need to install
476 a Win32 port of bison on your system. Put bison.exe in a directory on
477 the path, configure bison as explained in step 5, and rebuild.
479 You can also attempt to use other replacements for lex and yacc. This
480 will require modifying the LEX and YACC settings in
481 /config/NTMakefile.i386_nt40. If the replacements require different
482 command line options than flex and bison, then you may also need to
483 change src/comerr/NTMakefile.
485 (3) Generate new OpenAFS binaries