Add the --show-errors and --show-max-delay command-line options to the

ossshell test program.

FossilOrigin-Name: 626bdca98e0cd78ae873d97e75bb7d544ca18759c9f1e67f4adf03daca7fe5bf

2 files changed, 89 insertions, 11 deletions

diff --git a/test/ossfuzz.c b/test/ossfuzz.c
index 97d101e17..6790d194d 100644
--- a/test/ossfuzz.c
+++ b/test/ossfuzz.c
@@ -4,8 +4,26 @@
 */
 #include <stddef.h>
 #include <stdint.h>
+#include <stdio.h>
+#include <string.h>
 #include "sqlite3.h"
 
+/* Global debugging settings.  OSS-Fuzz will have all debugging turned
+** off.  But if LLVMFuzzerTestOneInput() is called interactively from
+** the ossshell utility program, then these flags might be set.
+*/
+static unsigned mDebug = 0;
+#define FUZZ_SQL_TRACE       0x0001   /* Set an sqlite3_trace() callback */
+#define FUZZ_SHOW_MAX_DELAY  0x0002   /* Show maximum progress callback delay */
+#define FUZZ_SHOW_ERRORS     0x0004   /* Print error messages from SQLite */
+
+/* The ossshell utility program invokes this interface to see the
+** debugging flags.  Unused by OSS-Fuzz.
+*/
+void ossfuzz_set_debug_flags(unsigned x){
+  mDebug = x;
+}
+
 /* Return the current real-world time in milliseconds since the
 ** Julian epoch (-4714-11-24).
 */
@@ -23,6 +41,17 @@ static sqlite3_int64 timeOfDay(void){
   return t;
 }
 
+/* An instance of the following object is passed by pointer as the
+** client data to various callbacks.
+*/
+typedef struct FuzzCtx {
+  sqlite3 *db;               /* The database connection */
+  sqlite3_int64 iCutoffTime; /* Stop processing at this time. */
+  sqlite3_int64 iLastCb;     /* Time recorded for previous progress callback */
+  sqlite3_int64 mxInterval;  /* Longest interval between two progress calls */
+  unsigned nCb;              /* Number of progress callbacks */
+} FuzzCtx;
+
 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
 /*
 ** Progress handler callback.
@@ -30,9 +59,14 @@ static sqlite3_int64 timeOfDay(void){
 ** The argument is the cutoff-time after which all processing should
 ** stop.  So return non-zero if the cut-off time is exceeded.
 */
-static int progress_handler(void *pReturn) {
-  sqlite3_int64 iCutoffTime = *(sqlite3_int64*)pReturn;
-  return timeOfDay()>=iCutoffTime;
+static int progress_handler(void *pClientData) {
+  FuzzCtx *p = (FuzzCtx*)pClientData;
+  sqlite3_int64 iNow = timeOfDay();
+  int rc = iNow>=p->iCutoffTime;
+  sqlite3_int64 iDiff = iNow - p->iLastCb;
+  if( iDiff > p->mxInterval ) p->mxInterval = iDiff;
+  p->nCb++;
+  return rc;
 }
 #endif
 
@@ -54,12 +88,12 @@ static int exec_handler(void *pCnt, int argc, char **argv, char **namev){
 int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size) {
   int execCnt = 0;         /* Abort row callback when count reaches zero */
   char *zErrMsg = 0;       /* Error message returned by sqlite_exec() */
-  sqlite3 *db;             /* The database connection */
   uint8_t uSelector;       /* First byte of input data[] */
   int rc;                  /* Return code from various interfaces */
   char *zSql;              /* Zero-terminated copy of data[] */
-  sqlite3_int64 iCutoff;   /* Cutoff timer */
+  FuzzCtx cx;              /* Fuzzing context */
 
+  memset(&cx, 0, sizeof(cx));
   if( size<3 ) return 0;   /* Early out if unsufficient data */
 
   /* Extract the selector byte from the beginning of the input.  But only
@@ -72,7 +106,7 @@ int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size) {
   }
 
   /* Open the database connection.  Only use an in-memory database. */
-  rc = sqlite3_open_v2("fuzz.db", &db,
+  rc = sqlite3_open_v2("fuzz.db", &cx.db,
            SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY, 0);
   if( rc ) return 0;
 
@@ -82,12 +116,13 @@ int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size) {
   ** (which will block further processing) if more than 10 seconds have
   ** elapsed since the start of the test.
   */
-  iCutoff = timeOfDay() + 10000;  /* Now + 10 seconds */
-  sqlite3_progress_handler(db, 10, progress_handler, (void*)&iCutoff);
+  cx.iLastCb = timeOfDay();
+  cx.iCutoffTime = cx.iLastCb + 10000;  /* Now + 10 seconds */
+  sqlite3_progress_handler(cx.db, 10, progress_handler, (void*)&cx);
 #endif
 
   /* Bit 1 of the selector enables foreign key constraints */
-  sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_FKEY, uSelector&1, &rc);
+  sqlite3_db_config(cx.db, SQLITE_DBCONFIG_ENABLE_FKEY, uSelector&1, &rc);
   uSelector >>= 1;
 
   /* Remaining bits of the selector determine a limit on the number of
@@ -97,11 +132,21 @@ int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size) {
   /* Run the SQL.  The sqlite_exec() interface expects a zero-terminated
   ** string, so make a copy. */
   zSql = sqlite3_mprintf("%.*s", (int)size, data);
-  sqlite3_exec(db, zSql, exec_handler, (void*)&execCnt, &zErrMsg);
+  sqlite3_exec(cx.db, zSql, exec_handler, (void*)&execCnt, &zErrMsg);
+
+  /* Show any errors */
+  if( (mDebug & FUZZ_SHOW_ERRORS)!=0 && zErrMsg ){
+    printf("Error: %s\n", zErrMsg);
+  }
 
   /* Cleanup and return */
   sqlite3_free(zErrMsg);
   sqlite3_free(zSql);
-  sqlite3_close(db);
+  sqlite3_close(cx.db);
+
+  if( mDebug & FUZZ_SHOW_MAX_DELAY ){
+    printf("Progress callback count....... %d\n", cx.nCb);
+    printf("Max time between callbacks.... %d ms\n", (int)cx.mxInterval);
+  }
   return 0;
 }
diff --git a/test/ossshell.c b/test/ossshell.c
index 15902a912..00cc3391c 100644
--- a/test/ossshell.c
+++ b/test/ossshell.c
@@ -9,6 +9,7 @@
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 #include "sqlite3.h"
 
 /*
@@ -16,6 +17,13 @@
 */
 int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size);
 
+/* Must match equivalent #defines in ossfuzz.c */
+#define FUZZ_SQL_TRACE       0x0001   /* Set an sqlite3_trace() callback */
+#define FUZZ_SHOW_MAX_DELAY  0x0002   /* Show maximum progress callback delay */
+#define FUZZ_SHOW_ERRORS     0x0004   /* Show SQL errors */
+extern void ossfuzz_set_debug_flags(unsigned);
+
+
 
 /*
 ** Read files named on the command-line and invoke the fuzzer for
@@ -27,9 +35,32 @@ int main(int argc, char **argv){
   int nErr = 0;
   uint8_t *zBuf = 0;
   size_t sz;
+  unsigned mDebug = 0;
 
   for(i=1; i<argc; i++){
     const char *zFilename = argv[i];
+    if( zFilename[0]=='-' ){
+      if( zFilename[1]=='-' ) zFilename++;
+      if( strcmp(zFilename, "-show-errors")==0 ){
+        mDebug |= FUZZ_SHOW_ERRORS;
+        ossfuzz_set_debug_flags(mDebug);
+      }else
+      if( strcmp(zFilename, "-show-max-delay")==0 ){
+        mDebug |= FUZZ_SHOW_MAX_DELAY;
+        ossfuzz_set_debug_flags(mDebug);
+      }else
+      if( strcmp(zFilename, "-sql-trace")==0 ){
+        mDebug |= FUZZ_SQL_TRACE;
+        ossfuzz_set_debug_flags(mDebug);
+      }else
+      {
+        printf("unknown option \"%s\"\n", argv[i]);
+        printf("should be one of: --show-errors --show-max-delay"
+               " --sql-trace\n");
+        exit(1);
+      }
+      continue;
+    }
     in = fopen(zFilename, "rb");
     if( in==0 ){
       fprintf(stderr, "cannot open \"%s\"\n", zFilename);
@@ -50,8 +81,10 @@ int main(int argc, char **argv){
       nErr++;
     }else{
       printf("%s... ", zFilename);
+      if( mDebug ) printf("\n");
       fflush(stdout);
       (void)LLVMFuzzerTestOneInput(zBuf, sz);
+      if( mDebug ) printf("%s: ", zFilename);
       printf("ok\n");
     }
     fclose(in);