Skip to content

Commit

Permalink
Update documentation, increase max filename length
Browse files Browse the repository at this point in the history
I've updating the documentation to better reflect the fact that memory
use can now be limited. I've also increased the maximum filename length
to 160 characters.
  • Loading branch information
Brian "DragonLord" Wong authored and Brian "DragonLord" Wong committed Dec 28, 2014
1 parent 236c3ed commit 25e8884
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 8 deletions.
8 changes: 7 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,10 @@
- Added the ability to limit memory use. The memory limit is specified at
runtime in megabytes as the first parameter to the benchmark executable. The
output directory name is now specified by the second parameter.
- Fixed a typo in the out-of-memory error message.
- Fixed a typo in the out-of-memory error message.

## 0.3.1 (December 28, 2014)

- Updated documentation to reflect the memory limiting feature.
- Increased the maximum file name length to 200 characters.
- Minor stylistic changes in code.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ disk paging to complete the computation, resulting in a dramatic slowdown and an
attendant drop in QUIPS. Specifically, the benchmark stops when the QUIPS for
the previous trial drops belows a predefined ratio of the peak QUIPS attained
during the benchmark or when the shortest lap in a trial takes longer than a
predefined amount of time. (More details on how to set these limits follow.)
predefined amount of time. Alternatively, the maximum amount of memory to use
can be set and the benchmark will stop when this limit is reached. (More details
on how to set these limits follow.)

## Building and configuration

Expand Down Expand Up @@ -75,7 +77,8 @@ An example build command would look like this:
A Makefile is included to simplify compilation of the benchmark. Running `make`
or `mingw32-make` will generate binaries which use `DSIZE` of 16-, 32-, and
64-bit integers as well as single-, double-, and extended-precision
floating-point numbers.
floating-point numbers. The Makefile currently assumes GCC; modify it as needed
if you are using a different compiler.

The macros in the "Adjustable Defines" section of `hi64.h` determine the
behavior of the benchmark, such as when to stop the benchmark and how many laps
Expand Down Expand Up @@ -150,7 +153,8 @@ directory does not exist, the benchmark will not run. (This unusual output
behavior was inherited from the original HINT code and will be changed in a
future release to make the program easier to use.)

The program runs until the `STOPRT` or `STOPTM` thresholds are reached. This
The program runs until the `STOPRT` or `STOPTM` thresholds are reached, or until
the specified memory limit is reached. If no memory limit is specified, this
generally means that the system will run out of memory and start swapping to
disk heavily before the benchmark is finished.

Expand Down
6 changes: 3 additions & 3 deletions hi64.c
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
int main(int argc, char *argv[])
{
FILE *curv; /* Output file for QUIPS curve */
char filnm[80]; /* Output file name */
char filnm[200]; /* Output file name */

Speed qdata[NSAMP]; /* Array to keep track of QUIPs and time */

Expand Down Expand Up @@ -63,7 +63,7 @@ int main(int argc, char *argv[])
t0, /* Starting time */
t1, /* Ending time */
tdelta, /* Timer resolution */
/* tlast, */ /* Time of last recorded trial */
/* tlast, */ /* Time of last recorded trial */
tscout; /* Time for initial survey */

int64_t dbits, /* Number of bits of accuracy for dmax */
Expand All @@ -77,7 +77,7 @@ int main(int argc, char *argv[])

char* suffix; /* Suffix for data.suffix directory */

printf("\nHI64 System Benchmark, Version 0.3.0");
printf("\nHI64 System Benchmark, Version 0.3.1");
printf(" (December 28, 2014)\n");
printf("Derived from HINT originally developed by");
printf(" John L. Gustafson & Quinn O. Snell,\n");
Expand Down
3 changes: 2 additions & 1 deletion hi64.h
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,8 @@
/* run out of decent-speed memory well before this */
#endif

#define MXPROC 32 /* Maximum number of processors to use in shared */ /* memory configuration. Adjust as necessary. */
#define MXPROC 32 /* Maximum number of processors to use in shared */
/* memory configuration. Adjust as necessary. */

/******************************************************************************/
/* Non-Adjustable Defines */
Expand Down

0 comments on commit 25e8884

Please sign in to comment.