README - WebStone 1.1

WARNING: WebStone 1.1 removed a significant load-generation latency
	from some systems. DO NOT compare results generated by 
	WebStone 1.1 or later with results generated by ANY 
	previous versions.

This is the WebStone benchmark. Quick and dirty install:
	- set up a Web server
	- put this directory on a seperate machine (the "controller")
	- make all 
		(unless you're running IRIX 5.3 -
		IRIX binaries are included)
	- make install
	- edit conf/testbed to reflect your site
	- ./webstone -genfiles will put the files in conf/fileset 
		onto your Web server.
	- ./webstone

If you'd like to try out the GUI for WebStone:
	- follow the above steps (you don't have to edit testbed)
	- make sure you have a Web browser installed
	- ./configure
	- ./webstone -gui

Files of interest:
	Makefile: Wrapper file for make.
	README: This document.
	README-DynamicWorkload: Documentation for the CGI-bin/NS-API workload
	configure: finds binaries for the GUI.
	webstone: wrapper shell script for everything. 
		Takes options:
		-gui: start the GUI mode
		-kill: kill stray WebStone processes
		-genfiles: build files from conf/fileset and rcp onto server
		-results: report results from bin/runs

Files of interest (./src):
	Makefile, *.c, *.h: The Webstone source code

Files of interest (./bin):
	checkfilelist: uses rsh to check web server for files in filelist.
	distribute: copies webstone binary to webclients.
	genfiles, genrand: generates files of arbitrary length.
	getstats: Collects network statistics from Web server, clients.
	killbench: terminates stray WebStone processes.
	rebootall: reboots all WebStone webclients.
	runbench: wrapper script for WebStone.
	webmaster: WebStone controller executable.
	webstone: WebStone client executable.
	wscollect: reports results in tabular format.

Files of interest (./conf):
	filelist: default list of files on the Web server,
		with workload description.
	filelist.photo: Model of a popular Web site 
		containing photographic images.
	filelist.ss: Model of SGI's Silicon Surf WWW site.
	fileset: list of files for genfiles to create.
	testbed: config file describing Web server, client, and network setup.

Documentation (./doc):
	FAQ.html: The FAQ, current as of this distribution.
	LICENSE: Legal status of WebStone.
	testbed.help: Explains the parameters in conf/testbed.
	webstone-white-paper.ps: The original WebStone white paper.
	webstone.gif: The WebStone logo.

Additional documentation:
	FAQ.html: Frequently Asked Questions, with answers
	webstone.ps: PostScript white paper on WebStone

Problems, etc. may be addressed to the WebStone mailing list.
Read the FAQ for details.

Release Notes (1.1):
	* New dynamic workload - see "README-DynamicWorkload"
	* Improved webclient performance by combining GET and ACCEPT
		HTTP headers in one write() call.
	* Improved webclient performance on systems that always attempt
		to map protocol names to numbers using YP.
	* WARNING: since the old code introduced a significant latency
		in some systems, DO NOT compare WebStone 1.1 results
		with results generated by any previous versions.

Release Notes (1.0.3):
	* Netscape Server 1.1.2 exposed a couple bugs, which I've now fixed.

Release Notes (1.0.2):
	* Fixed runbench so that ITERATIONS, MINCLIENTS, and MAXCLIENTS don't
		have to have a common denominator any more.
	* Fixed a few cosmetic bugs.

Release Notes (1.0.1):
	* Fixed select() bug in webmaster

Release Notes (1.0 final):
	* Fixed the "Error reading 2nd timing info" bug
	* Fixed numerous bugs in the GUI
	* Froze feature set. Work can now begin on WebStone 1.1

New features and changes (1.0b3):
	* New Web browser GUI
		NOTE: most Web browsers take up substantial CPU time.
		If you run the GUI, we recommend that you make the controller 
		a separate machine, and don't run any WebStone clients on it.
	* Minor bug fixes
		Squashed some dubious error messages, fixed some client-
		controller communications problems.
	* Reporting changes
		Changes the units and order of the final summary statistics.
		Basically, this is for my own convenience, so I don't have to
		massage the data quite so much before using it. wscollect
		now reports only the metrics I regard as important - but all
		metrics are still reported in the runs/*/run files.

LEGAL STUFF:

This file and all files contained in this directory are 
copyright 1995, Silicon Graphics, Inc.

This software is provided without support and without any obligation on the 
part of Silicon Graphics, Inc. to assist in its use, correction, modification 
or enhancement. There is no guarantee that this software will be included in 
future software releases, and it probably will not be included.

THIS SOFTWARE IS PROVIDED "AS IS" WITH NO WARRANTIES OF ANY KIND INCLUDING THE 
WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE, 
OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE. 

In no event will Silicon Graphics, Inc. be liable for any lost revenue or 
profits or other special, indirect and consequential damages, even if 
Silicon Graphics, Inc. has been advised of the possibility of such damages. 

