update information for building charm++ on a x64 machine with Microsoft
[charm.git] / README.win
1
2                           Charm++ for Win32/64
3
4        Copyright (C) 1989-2004 Regents of the University of Illinois
5
6 You can compile charm++ under Windows9x/2000/NT with VC++ plus Cygwin.
7 Cygwin are ports of the popular GNU development tools and utilities for 
8 Windows 9x/2K and NT, which emulates a UNIX environment under Windows.
9
10 Note that since November 2005, Windows98 is not supported with VC++.
11 Support for WindowsNT/XP is improved to take advantage of the creation of
12 symbolic link under WindowsNT. In addition, the Microsoft Visual Studio Express
13 edition (which is free for download and registeration) doesn't include 64-bit 
14 compiler and other 64-bit tools, therefore, to build charm++ for 64-bit windows, a standard Microsoft Visual Studio is required.
15  
16 Please read the FAQ at end of this file.
17
18
19                        Setup and Compilation
20                     ===========================
21 (Note: building charm++ for 64-bit windows follows the exact way of building
22  for 32-bit windows. Therefore, changing "win32" to "win64" in the following 
23  paragraphs gives you the guide to build charm++ for 64-bit windows.)
24
25 To compile charm with VC++:
26 1. install cygwin from: http://sourceware.cygnus.com/cygwin
27    Remember to choose default file type as "unix" at the beginning of 
28    cygwin installation.
29
30 2. Start a Cygwin's Bash Shell window, type "cl" to make sure VC++ compiler 
31    command line mode is correctly set. If it is not correctly set, you need to 
32    run the VCVARS32.BAT, or vcvarsall.bat (after VC++ 8.0) at Windows startup 
33    time. 
34    VCVARS32.BAT can be located in your VC++ install directory, usually at: 
35    /Program Files/Microsoft Visual Studio/VC98/Bin
36    For Microsoft Visual C++ 8.0 and beyond, it is usually located at:
37    C:\Program Files\Microsoft Visual Studio 9.0\VC\vcvarsall.bat
38
39    However VCVARS32.BAT, or vcvarsall.bat (a DOS Batch) cannot be executed 
40    under Bash Shell, you have to: 
41    for Win8x: put it into AUTOEXEC.BAT; 
42    for WinNT/WindowsXP/Vista: you have to call VCVARS32.BAT in cygwin.bat 
43               which is the target of the Cygwin icon on your desktop. 
44               For example, if cygwin is installed under c:\cygwin,
45               modify c:\cygwin\cygwin.bat to something like:
46
47    >>>>>>>>>>>>>>>>>>>
48    @echo off
49
50    call "C:\Program Files\Microsoft Visual Studio 9.0\VC\vcvarsall"
51
52    C:
53    chdir D:\cygwin\bin
54
55    bash --login -i
56    >>>>>>>>>>>>>>>>>>>>
57
58 3. This step is optional if you have installed Microsoft Visual Studio under 
59    the following (default) location: 
60      /Program Files/Microsoft Visual Studio 8\VC
61    In case it is not at this directory, edit the following (text) files to 
62    modify VCC_DIR and SDK_DIR to point to your visual studio c++ and 
63           Microsoft SDK directories:
64     src\arch\win32\unix2nt_ar
65     src\arch\win32\unix2nt_cc  
66
67 4. Now you can compile Charm++ like Unix, for example:
68
69    ./build charm++ net-win32
70
71    this will build all Charm++ executables under net-win32/bin and all libs
72    under net-win32/lib
73
74
75
76                      Compile and Run Charm++ Programs
77                   ======================================
78
79 1. After Charm++ compilation is complete, you can try some sample programs under
80    net-win32\pgms. For example, 
81    cd net-win32/pgms/charm++/megatest, and type "make",
82    it will invoke Charm++'s "charmc"(VC++ wrapper) to compile the test 
83    programs and generates an executable "pgm.exe" and a charm++'s parallel
84    run utility program - "charmrun.exe".
85    Now you have two choices of running the executable:
86    (1) locally on your desktop, using:
87        ./charmrun +p1 ./pgm ++local
88        this will fork one copy of node program on your local machine. You can 
89        choose using more than one virtual processors, e.g. using +p3  option.
90        Starting from Charm 5.4R2, You can also run, simply type executable and 
91        command line options:
92        ./pgm 
93        This will run only one copy of program locally.
94
95    (2) run in parallel across machines:
96        In this case, you need to write a .nodelist file under your home
97        directory(~) in bash terminal, here is an example:
98
99 group main
100 host hostname1
101 host hostname2 
102
103        Next, you need to start charmd.exe, which is under net-win32/bin on
104        all the nodes as listed in the .nodelist file.
105        Now run the Charm++ program, for example:
106        ./charmrun +p2 ./pgm
107
108
109    For details of Charm++ compilation options and charmrun comman line options
110 explanation, please check the manuals on charm.cs.uiuc.edu web site manual 
111 section.
112    If you have any problem or suggestion, please let me know by sending
113 email to (ppl@cs.uiuc.edu).
114
115
116
117                                     FAQ
118                               ==============
119
120
121  1. I don't like Cygwin, can I compile Charm++ without Cygwin?
122
123    Yes, there is an un-documented way to compile Charm++ under MS-DOS windows 
124    with VC++ and nmake. However, this is only occasionally maintained and not 
125    guarranteed to always work.
126    Follow this steps:
127    1 open a MS-DOS windows, cd to Charm++ directory, and mkdir net-win32\tmp;
128    2 cd to net-win32\tmp, copy Makefile.win32 from 
129      charm\src\Common\scripts\Makefile.win32 to current directory;
130    3 type: nmake /f Makefile.win32
131    4 To compile Charm++ programs, see the Makefile.win32 examples under
132      net-win32\pgms\charm++\megatest\Makefile.win32
133      The command to use is: nmake /f Makefile.win32
134      Basically you need to specify all the charm++ libraries to link against,
135      because shell script charmc is not available,
136
137  2. I just downloaded Charm++ net-win32 binaries from your website, how to use it?
138
139    The recommended way to run windows binary is under Cygwin.
140    First, unzip the binary packages to desired location; Set PATH environment
141    varaible to include the charm bin/ directory. That's it, you can now cd 
142    to Charm++ testsuite directory, for example: pgms/charm++/megatest, to 
143    compile your first Charm++ program using "make".
144    If you don't want to use Cygwin, you have to use "nmake" to compile Charm++
145    programs, see the Makefile example under: 
146    pgms/charm++/megatest/Makefile.win32.
147
148  3. How to compile under Windows98?
149
150    Compiling Charm++ with cygwin/gnu compiler (net-cygwin) under Windows98 
151    is still supported. However, we don't support VC++ with Windows98 any more.
152    To compile Charm++ under Windows98, one can check out Charm++ version
153    before November 2005.