Fuzzer improvements.

phase_of_moon and friday_13th determined using rn2() instead of local
time if fuzzing.  Don't reseed using init_random() if fuzzing.  Allow
set_random to be called outside of hacklib.  rn2_on_display_rng uses
rn2 if fuzzing so that we have a single source of random that we can
ensure is reproducible.  Implement rul() that returns a random unsigned
long.  Fix bug in fuzzer handling of ntposkey which would cause us to use
unitialized values for x and y.  Added command line arguments to allow
auto starting and stopping of fuzzer.  Add a logging facility for the
fuzzer to use to record activity.  Added some scripts used to automate
fuzzer testing on windows.
This commit is contained in:
Bart House
2019-07-14 00:20:09 -07:00
parent aa95e20ca7
commit 435f1c4626
14 changed files with 337 additions and 8 deletions

View File

@@ -436,6 +436,8 @@ boolean resuming;
#ifdef MAIL
ckmailstatus();
#endif
fuzzer_check();
rhack((char *) 0);
}
if (u.utotype) /* change dungeon level */
@@ -583,6 +585,8 @@ newgame()
{
int i;
fuzzer_auto_start();
#ifdef MFLOPPY
gameDiskPrompt();
#endif
@@ -922,4 +926,131 @@ const char *opts;
#endif
return;
}
static FILE * g_fuzzer_log_file = NULL;
static int g_fuzzer_log_level = LOG_MINIMAL;
/* fuzzer_start() starts the fuzzer opening the fuzzer log file */
void
fuzzer_start()
{
if (!iflags.debug_fuzzer) {
const char * fq_replay;
iflags.debug_fuzzer = TRUE;
iflags.fuzzer_auto_start = FALSE;
nhassert(g_fuzzer_log_file == NULL);
fq_replay = fqname("fuzzer.log", SAVEPREFIX, 0);
g_fuzzer_log_file = fopen(fq_replay, "w");
}
}
/* fuzzer_stop() stops the fuzzer and close the fuzzer log file */
void
fuzzer_stop()
{
if (iflags.debug_fuzzer) {
if(g_fuzzer_log_file != NULL) {
fclose(g_fuzzer_log_file);
g_fuzzer_log_file = NULL;
}
}
}
/* fuzzer_toggle() toggles fuzzer state */
void
fuzzer_toggle()
{
if (iflags.debug_fuzzer)
fuzzer_stop();
else
fuzzer_start();
}
/* fuzzer_log() is used to place messages in the file 'fuzzer.log'. This
* log is the primary tool for monitoring fuzzer activity and tracking down
* issues that the fuzzer is able to reproduce.
*/
void
fuzzer_log
VA_DECL2(int, level, const char *, str)
{
VA_START(str);
VA_INIT(str, char *);
if (!g_fuzzer_log_file)
return;
if (iflags.verbose_logging_start != 0 && moves >= iflags.verbose_logging_start)
g_fuzzer_log_level = LOG_VERBOSE;
if (level <= g_fuzzer_log_level)
Vfprintf(g_fuzzer_log_file, str, VA_ARGS);
VA_END();
}
/* fuzzer_check() is called prior to rhack(0) to allow the fuzzer to
* check if it should stop and to allow it to reseed the game.
*/
void
fuzzer_check()
{
if (iflags.debug_fuzzer)
{
if (moves >= iflags.fuzzer_stop_and_save) {
iflags.fuzzer_saving = TRUE;
dosave0();
exit_nhwindows("Goodbye from the fuzzer...");
fuzzer_stop();
nh_terminate(EXIT_SUCCESS);
}
unsigned long seed = rul();
set_random(seed, rn2);
fuzzer_log(LOG_MINIMAL, "SEED:%ld:%lu\n", moves, seed);
}
}
/* fuzzer_auto_start is called when creating a new game to allow
* the fuzzer to start itself.
*/
void
fuzzer_auto_start()
{
if (iflags.fuzzer_auto_start) {
nhassert(!iflags.debug_fuzzer);
fuzzer_start();
unsigned long seed = rul();
set_random(seed, rn2);
fuzzer_log(LOG_MINIMAL, "START:%ld:%lu\n", moves, seed);
}
}
/* fuzzer_msg_history is called during save file recovery to allow
* the fuzzer to snoop the messages being recovered. The fuzzer
* saves a seed as a message in save files and this is the mechanism
* used to recover that seed if the fuzzer is being auto started.
*/
boolean
fuzzer_msg_history(msg)
const char * msg;
{
long saved_moves;
unsigned long saved_seed;
if (sscanf(msg, "SEED:%ld:%lu", &saved_moves, &saved_seed) == 2) {
nhassert(saved_moves == moves);
if (iflags.fuzzer_auto_start) {
fuzzer_start();
set_random(saved_seed, rn2);
fuzzer_log(LOG_MINIMAL, "START:%ld:%lu\n", moves, saved_seed);
}
return TRUE;
}
return FALSE;
}
/*allmain.c*/

View File

@@ -854,7 +854,7 @@ STATIC_DCL struct tm *NDECL(getlt);
/* Sets the seed for the random number generator */
#ifdef USE_ISAAC64
static void
void
set_random(seed, fn)
unsigned long seed;
int FDECL((*fn), (int));
@@ -865,7 +865,7 @@ int FDECL((*fn), (int));
#else /* USE_ISAAC64 */
/*ARGSUSED*/
static void
void
set_random(seed, fn)
unsigned long seed;
int FDECL((*fn), (int)) UNUSED;
@@ -917,7 +917,7 @@ int FDECL((*fn), (int));
{
/* only reseed if we are certain that the seed generation is unguessable
* by the players. */
if (has_strong_rngseed)
if (has_strong_rngseed && !iflags.debug_fuzzer)
init_random(fn);
}
@@ -1108,6 +1108,9 @@ phase_of_the_moon() /* 0-7, with 0: new, 4: full */
register struct tm *lt = getlt();
register int epact, diy, goldn;
if(iflags.debug_fuzzer)
return rn2(8);
diy = lt->tm_yday;
goldn = (lt->tm_year % 19) + 1;
epact = (11 * goldn + 18) % 30;
@@ -1122,6 +1125,9 @@ friday_13th()
{
register struct tm *lt = getlt();
if(iflags.debug_fuzzer)
return rn2(30);
/* tm_wday (day of week; 0==Sunday) == 5 => Friday */
return (boolean) (lt->tm_wday == 5 && lt->tm_mday == 13);
}

View File

@@ -1231,6 +1231,8 @@ register int fd;
panic("restore_msghistory: msg too big (%d)", msgsize);
mread(fd, (genericptr_t) msg, msgsize);
msg[msgsize] = '\0';
if(fuzzer_msg_history(msg))
continue;
putmsghistory(msg, TRUE);
++msgcount;
}

View File

@@ -56,10 +56,21 @@ int FDECL((*fn), (int));
(int) sizeof seed);
}
unsigned long
rul()
{
unsigned long value;
value = (unsigned long) isaac64_next_uint64(&rnglist[CORE].rng_state);
fuzzer_log(LOG_VERBOSE, "RANDOM:%llu\n", value);
return value;
}
static int
RND(int x)
{
return (isaac64_next_uint64(&rnglist[CORE].rng_state) % x);
return (rul() % x);
}
/* 0 <= rn2(x) < x, but on a different sequence from the "main" rn2;
@@ -69,6 +80,8 @@ int
rn2_on_display_rng(x)
register int x;
{
if (iflags.debug_fuzzer)
return rn2(x);
return (isaac64_next_uint64(&rnglist[DISP].rng_state) % x);
}
@@ -94,6 +107,20 @@ register int x;
seed *= 2739110765;
return (int)((seed >> 16) % (unsigned)x);
}
unsigned long
rul()
{
#if defined(LINT) && defined(UNIX)
return (unsigned long) rand();
#else /* LINT */
#if defined(UNIX) || defined(RANDOM)
return (unsigned long) Rand();
#else
return (unsigned long) (Rand() >> 3);
#endif /* defined(UNIX) || defined(RANDOM) */
#endif /* LINT */
}
#endif /* USE_ISAAC64 */
/* 0 <= rn2(x) < x */

View File

@@ -139,7 +139,7 @@ dosave0()
return 0;
#endif
HUP if (iflags.window_inited) {
HUP if (!iflags.debug_fuzzer && iflags.window_inited) {
nh_uncompress(fq_save);
fd = open_savefile();
if (fd > 0) {
@@ -1238,6 +1238,18 @@ int fd, mode;
bwrite(fd, (genericptr_t) msg, msglen);
++msgcount;
}
/* If the fuzzer is stopping and saving, save a seed as a message.
In 3.7, we will modify the save file format and save the seed
directly in the saved game state. */
if (iflags.fuzzer_saving) {
char message[BUFSIZ];
unsigned long seed = rul();
sprintf(message, "SEED:%ld:%lu", moves, seed);
fuzzer_log(LOG_MINIMAL, "STOP:%ld:%lu\n", moves, seed);
msglen = strlen(message);
bwrite(fd, (genericptr_t) &msglen, sizeof msglen);
bwrite(fd, (genericptr_t) message, msglen);
}
bwrite(fd, (genericptr_t) &minusone, sizeof (int));
}
debugpline1("Stored %d messages into savefile.", msgcount);