updated to Charm V5.4R2
[charm.git] / README.cygwin
1                               Charm++ 5.4 (Release 2)
2
3        Copyright (C) 1989-2000 Regents of the University of Illinois
4
5 Now you can compile charm++ under Windows9x/2000/NT with Cygwin.
6 Note: This version of cygwin is still under testing.
7 Check the FAQ at end of this file for more help.
8
9
10                        Setup and Compilation
11                     ===========================
12
13 To compile charm on cygwin:
14 1. install cygwin from: http://sourceware.cygnus.com/cygwin
15    with inetutils, openssh, w32api packages and gcc of course. Remember to
16    choose default file type as "unix" at the beginning of cygwin installation.
17
18 2. before compiling, make sure you have /bin/sh correctly installed, otherwise
19    make a link from /bin/bash.exe:  ln -s /bin/bash.exe /bin/sh.exe
20    compile charm++:    ./build charm++ net-cygwin
21
22 3. setting up running environment:
23      There are several ways to do this, using rsh or ssh. 
24    Under Windows2000/NT, ssh is recommended, I once had difficulty to have 
25    inetd working.
26      Starting from Charm++ version 5.4, ++local option is added to start
27    node programs directly on your desktop machine. You no longer need rshd or 
28    sshd to start charm program on local machine. This is for testing purpose 
29    or small job run though, for best performance, launch one process per 
30    processor with rsh daemons.
31    Starting from Charm++ V5.4R2, you can also run Charm++ program in standalone
32    mode without charmrun.
33
34  ** RSH method **
35    setup /etc/inetd.conf and /etc/services to start rshd, 
36    Here is an example of /etc/inetd.conf:
37
38 ###
39 shell stream tcp nowait.1000  root /usr/sbin/in.rshd  in.rshd
40 ###
41
42    and an example of /etc/services:
43
44 ###   
45 shell     514/tcp    cmd
46 ###
47
48    before running charm program, start 'inetd' first to get rshd running.
49    Run debug mode 'inetd -d' to see the debug information.
50
51  ** SSH method **
52      Check /etc/passwd, make sure your home directory is correct. (it may be
53    empty there!)
54    run "/usr/bin/ssh-config" to setup all ssh config files.
55      Since openssh version 2.5.1p2, you have to run /usr/bin/ssh-host-config
56    for the first time to generate global config files and server keys; and 
57    run /usr/bin/ssh-user-config creates the private and public keys for a user.
58    You may need to modify /etc/sshd_config or /etc/ssh_config for your needs.
59      Setup ~/.shosts, or add your public key to your ~/.ssh/authorized_keys to 
60    allow you to login without password authentication.
61    now you can start sshd and run charm programs. To tell Charmrun to use ssh
62    instead of rsh(default), you need to add ++shell option in ~/.nodelist file:
63
64 group main ++shell /bin/ssh
65 host localhost 
66
67  ** run only on local machine with ++local **
68      This allows a user to run charm program on his/her desktop machine for 
69    testing purpose or running a small job without the hassle of setting up any 
70    rsh deamons. To launch a charm++ program on your local machine, use 
71    "++local" option via:
72   
73      ./charmrun +p4 ++local ./pgm
74
75  ** run in standalone mode **
76      You can run Charm++ program without charmrun after Charm++ V5.4R2.
77    Simply type executable and command line options:
78    ./pgm 
79    This will run only one copy of program locally.
80
81 4. If you have any problem with it, please check the FAQ below for help.
82    Let me know if it works or not by sending email to (ppl@uiuc.edu).
83
84
85
86
87                                     FAQ
88                               ==============
89
90  * Why would I use net-cygwin version?
91
92    First cygwin is free, it comes with free gcc compiler, cvs and openSSH.
93    You don't need expensive Visual C++ compiler to get work done. For unix 
94    fans, it is also a good idea to just turn your windows box to a unix 
95    workspace, and learn and run charm++ program uniformly on all platforms.
96
97  * How to get your latest version of Charm++?
98
99    You can use anonymous cvs login to checkout the latest version of charm.
100    (It may not be the latest stable version though)
101    1. login the cvs server:
102
103       cvs -d :pserver:checkout@thrift.cs.uiuc.edu:/expand6/cvsroot login
104
105       when CVS passwd is prompted, just type <Enter>.
106    2. checkout charm
107
108       cvs co -P charm
109
110       You should get latest charm source tree.
111    3. logout the cvs server
112
113       cvs logout
114
115  * Problem: Charm++ build script stops when it compile "ckfutures.ci", with 
116    error message: "Syntax error at line 1: parse error"
117
118    This happens when the .ci files have strange characters like '^M' at end
119    of each line. Don't use WinCVS to checkout charm because it will append
120    '^M' for each line. Use the cvs that comes free from cygwin.
121    After charm++ version 5.4, this bug is fixed.
122
123  * Problem: I got a runtime error "CthCreate failed to create fiber!".
124
125      net-cygwin uses Win32 Fiber in its user threads implementation. However, 
126    there is a limit upon the number of Fibers you can create at one time in 
127    the w32api of cygwin. The current limit (as I tested) is between 50-52. You 
128    have to reduce the number of processors or the number of charm++ threads
129    you create in the program to run the program under cygwin.
130
131
132