Updated README and ChangeLog

2 files changed, 48 insertions, 21 deletions

diff --git a/ChangeLog b/ChangeLog
index e69de29..d2a0470 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -0,0 +1,19 @@
+2003-01-29: Jens Jakobsen <jj@openggsn.org>
+	Added -L../gtp to sgsnemu and ggsn makefiles so that make will
+	work without an installed libgtp.
+
+	Added sgsnemu check to check for valid pointer when deleting tun.
+
+	Removed enabling of ip_forward = 1 from ggsn.c and sgsnemu. From a
+	security point of view it was not very good that openggsn
+	automatically enabled routing.
+
+	Added ipup, ipdown and createif to sgsnemu/cmdline.ggo. Now
+	sgsnemu will set up default route and then execute ipup script
+	after tun device has been set up. After tun has been deleted the
+	ipdown script is executed.
+
+	Added support for ping to sgsnemu.
+
+	Added ipup and ipdown to ggsn/cmdline.ggo.
+	
diff --git a/README b/README
index d2a412c..acf94f7 100644
--- a/README
+++ b/README
@@ -23,22 +23,12 @@ depmod -a
 COMPILATION and INSTALLATION
 
 1 ./configure
-2 cd gtp
-3 make
-4 make install
-5 cd ..
-6 make
-7 make install
-8 Add /usr/local/lib to /etc/ld.so.conf
-9 Run ldconfig
+2 make
+3 make install
 
 You need to be root in order to install the package, but not in order
 to compile.
 
-Steps 2 to 5 are only needed the first time you install the
-package. Most likely steps 8 and 9 can be omitted as the path to
-libgtp is now included in Makefile.am for sgsnemu and ggsn.
-
 RUNNING
 
 sgsnemu
@@ -46,7 +36,7 @@ Edit the configuration file sgsnemu.conf found under
 openggsn/examples. Use sgsnemu -h for a list of available options.
 Start the emulator as root using the command:
 
-  sgsnemu -c examples/sgsnemu.conf -l 10.20.30.50 -r 10.20.30.40
+  sgsnemu -c examples/sgsnemu.conf -l 10.20.30.50 -r 10.20.30.40 --createif
 
 This will cause the sgsn emulator to bind to local address 10.20.30.50
 and connect to the ggsn found at 10.20.30.40. It will first send off
@@ -101,6 +91,22 @@ in a 3G radio access network. An important application of sgsnemu is
 the testing of roaming connectivity through a GPRS roaming exchange.
 
 
+*** Performance ***
+
+Two experiments were performed in order to test the performance of
+sgsnemu and ggsn. The ggsn used a 550 MHz Athlon with 384 MB of
+RAM. sgsnemu used a 1 GHz Athlon with 256 MB of RAM. Both machines had
+100 Mb/s NICs and were connected through a Netgear FS105 switch. Both
+tests were performed by sending ICMP echo packets from the ggsn to
+sgsnemu.
+
+89.4 Mb/s IP downlink throughput when sending 10001 ICMP ping packets
+with a payload of 1000 bytes. Transfer time 0.9 sec, no packets lost.
+
+17,1 Mb/s IP downlink throughput when sending 10001 ICMP ping packets with
+a payload of 100 bytes. Transfer time 0.6 sec, no packets lost.
+
+
 *** Required software ***
 
 TUN  (http://vtun.sourceforge.net/tun/)
@@ -138,10 +144,10 @@ SETTING UP AUTOTOOLS
 You do not need to perform this step if you are only going to compile
 the package:
 
-0 Get version from somewhere: Script to extract version from configure.ac
+0 Get version from somewhere: Script to extract version from configure.in
 1 Copy the latest config.guess and config.sub from ftp://ftp.gnu.org/gnu/config
-2 Run autoscan and copy configure.scan to configure.ac
-3 Add/edit the following lines in configure.ac:
+2 Run autoscan and copy configure.scan to configure.in
+3 Add/edit the following lines in configure.in:
 	AC_INIT(openggsn, 0.52, jj@openggsn.org)
 	AC_CONFIG_SRCDIR([gtp/gtp.c])
 	AM_CONFIG_HEADER([config.h])
@@ -152,8 +158,8 @@ the package:
   (ads copy of ltmain.sh)
 5 aclocal
 6 autoheader
-7 automake --add-missing
-  (Ads link to missing, install-sh, depcomp)
+7 automake --add-missing --copy
+  (Ads copy of mkinstalldirs missing, install-sh, depcomp)
 8 automake
 9 autoconf
 
@@ -185,6 +191,8 @@ Use ggsn -h for a list of available options. All options available on
 the command line can also be given in a configuration file. See
 examples/ggsn.conf for the format of this file.
 
+Remember to enable routing: echo 1 > /proc/sys/net/ipv4/ip_forward
+
 *** Running sgsnemu ***
 
 Use sgsnemu -h for a list of available options. All options available
@@ -233,16 +241,16 @@ either with your setup OR with the GRX connection OR with your roaming
 partners connection.
 
 If the above went well you might want to try to establish a PDP
-context to the remote GGSN. Note that you should be carefull when
+context to the remote GGSN. Note that you should be careful when
 establishing PDP contexts using sgsnemu as each established PDP
 context will result in a Charge Detail Record (CDR) being generated by
 the GGSN. You should use real IMSI and MSISDN from a valid test SIM
 card. Otherwise some poor customer might get charged for your
 testing. Also note that you are establishing a connection to the Gi
-netowrk, so please be carefull not to route internet traffic onto the
+network, so please be carefull not to route internet traffic onto the
 GPRS core network! Assuming you know what you are doing:
 
-     sgsnemu --fg --listen 10.20.30.50 --remote 10.20.30.40 --dns 10.20.38.51 --timelimit 10 --contexts 1 --apn internet --imsi 240011234567890 --msisdn 46702123456 --net 192.168.0.0 --mask 255.255.255.0
+     sgsnemu --fg --listen 10.20.30.50 --remote 10.20.30.40 --dns 10.20.38.51 --timelimit 10 --contexts 1 --apn internet --imsi 240011234567890 --msisdn 46702123456 --net 192.168.0.0 --mask 255.255.255.0 --createif
 
 sgsnemu will print something like the following on the screen: