Changeset 13 for trunk/txlib

Timestamp:

05/13/06 20:33:09 (3 years ago)

Author:

jvw

Message:

Logfile size-limit and automatic logfile rotation, very useful for crash tracing

Location:

trunk/txlib

Files:

• include/txcon.h (modified) (3 diffs)
• include/txlib.h (modified) (3 diffs)
• txcon.c (modified) (3 diffs)
• txlib.c (modified) (1 diff)
• txlogfil.c (modified) (6 diffs)
• txparse.c (modified) (2 diffs)
• txstdcmd.c (modified) (4 diffs)
• txtrace.c (modified) (1 diff)
• txvers.h (modified) (1 diff)

trunk/txlib/include/txcon.h

@@ -1183 +1183 @@
 BOOL TxAppendToLogFile                          // RET   logfile opened
 (
-   char                *fname                   // IN    name of (new) logfile
+   char               *fname,                   // IN    name of (new) logfile
+   BOOL                verbose                  // IN    Show the action
 );
 
@@ -1214 +1215 @@
 );
 
+// Construct name for new logfile based upon a sequence number 0..n
+char *TxBuildLogName                            // RET   filename
+(
+   ULONG               seq,                     // IN    sequence number
+   TXLN                buf                      // IN    filename buffer
+);
 
 // Output textual information in array of char-pointers
@@ -1235 +1242 @@
 );
 
+// Set logfile maximum size per file
+void TxSetLogMaxSize
+(
+   ULONG               size                     // IN    maximum size, bytes
+);
+
+// Set logfile number of files to retain on cycle, #files besides .log itself
+void TxSetLogRetain
+(
+   ULONG               retain                   // IN    retain count
+);
 
 // Make ascii-dump of data area on TxPrint output

trunk/txlib/include/txlib.h

@@ -1092 +1092 @@
 #define TxaOptStr(o,e,d)        TxaOptionStr(     TXA_CUR,o,e,d)
 #define TxaOptNum(o,e,d)        TxaOptionNum(     TXA_CUR,o,e,d)
+#define TxaOptBkmg(o,d,m)       TxaOptionBkmg(    TXA_CUR,o,d,m)
 #define TxaOptValue(o)          TxaGetOption(     TXA_CUR,o)
 #define TxaOptCount()           TxaGetOptc(       TXA_CUR  )
@@ -1105 +1106 @@
 #define TxaExeSwitchStr(o,e,d)  TxaOptionStr(     TXA_1ST,o,e,d)
 #define TxaExeSwitchNum(o,e,d)  TxaOptionNum(     TXA_1ST,o,e,d)
+#define TxaExeSwitchBkmg(o,d,m) TxaOptionBkmg(    TXA_1ST,o,d,m)
 #define TxaExeSwitchValue(o)    TxaGetOption(     TXA_1ST,o)
 #define TxaExeOptc()            TxaGetOptc(       TXA_1ST  )
@@ -1280 +1282 @@
    char               *error,                   // IN    error text or NULL
    ULONG               deflt                    // IN    default value
+);
+
+// Get option value num/string, with bytes/kilo/mega/giga modifier and default
+ULONG TxaOptionBkmg                             // RET   number value in bytes
+(
+   TXHANDLE            txh,                     // IN    TXA handle
+   char                option,                  // IN    option character
+   ULONG               def,                     // IN    default value
+   BYTE                mod                      // IN    b,kb,mb,gb modifier
 );
 

trunk/txlib/txcon.c

@@ -75 +75 @@
 static  char  txc_ansi   = A_ON;
 
+//- logfile cycling and size control
+static  ULONG      log_written = 0;             // bytes written on this file
+static  ULONG      log_maxsize = 0;             // maximum size per logfile
+static  ULONG      log_seq_num = 0;             // sequence number 0..n
+static  ULONG      log_retain  = 0;             // log recycle retain count
 
 //- Note: 256 color strings sorted in default PC order
@@ -460 +465 @@
 
 /*****************************************************************************/
+// Set logfile maximum size per file
+/*****************************************************************************/
+void TxSetLogMaxSize
+(
+   ULONG               size                     // IN    maximum size, bytes
+)
+{
+   log_maxsize = size;
+}                                               // end 'TxSetLogMaxSize'
+/*---------------------------------------------------------------------------*/
+
+
+/*****************************************************************************/
+// Set logfile number of files to retain on cycle, #files besides .log itself
+/*****************************************************************************/
+void TxSetLogRetain
+(
+   ULONG               retain                   // IN    retain count
+)
+{
+   log_retain = retain;
+}                                               // end 'TxSetLogRetain'
+/*---------------------------------------------------------------------------*/
+
+
+/*****************************************************************************/
 // printf-like print on stdout, LOG filehandle and raw/clean copy hooks
 /*****************************************************************************/
@@ -528 +559 @@
                TxAscii827( txm_buff, TXASCII827_TRANS);
             }
+
+            if ((log_maxsize > size) && (log_written > (log_maxsize - size)))
+            {
+               TXLN    fname;
+
+               log_written = 0;                 // avoid recursive cycling
+               fprintf( log_handle, "\nClosing logfile at size limit\n");
+
+               TxAppendToLogFile( NULL, FALSE); // close current log, quiet
+               if (log_seq_num >= log_retain)   // need to delete one
+               {
+                  TxBuildLogName( log_seq_num - log_retain, fname);
+                  remove( fname);               // delete a logfile (cycle)
+               }
+               TxBuildLogName( (log_retain) ? ++log_seq_num : 0, fname);
+               TxAppendToLogFile( fname, FALSE); // open next logfile, quiet
+               log_handle  = TxQueryLogFile( &log7bit, &logreopen);
+               fprintf( log_handle, "Start next logfile: '%s'\n", fname);
+            }
+            else
+            {
+               log_written += size;             // maintain total size in log
+            }
+
             fprintf( log_handle, "%s", txm_buff);
             if (logreopen)

trunk/txlib/txlib.c

@@ -139 +139 @@
 )
 {
-   TxAppendToLogFile("");
+   TxAppendToLogFile("", TRUE);
    #if defined (USEWINDOWING)
       TxInputTerminate();                       // stop windowed KBD/MOU input

trunk/txlib/txlogfil.c

@@ -39 +39 @@
 #include <txlib.h>
 
-static  FILE          *log_handle = 0;
-static  TXLN           log_fname;
-static  BOOL           log_7bit   = TRUE;
-static  BOOL           log_reopen = FALSE;      // reopen on each line
+static  FILE      *log_handle  = 0;
+static  TXLN       log_fname   = "logfile";
+static  BOOL       log_7bit    = TRUE;
+static  BOOL       log_reopen  = FALSE;         // reopen on each line
 
 /*****************************************************************************/
@@ -49 +49 @@
 BOOL TxAppendToLogFile                          // RET   logfile opened
 (
-   char                *fname                   // IN    name of (new) logfile
+   char               *fname,                   // IN    name of (new) logfile
+   BOOL                verbose                  // IN    Show the action
 )
 {
    if (log_handle != 0)                         // close old one
    {
-      TxPrint("Closing logfile   : '%s'\n", log_fname);
+      if (verbose)
+      {
+         TxPrint("Closing logfile   : '%s'\n", log_fname);
+      }
       fclose(log_handle);
       log_handle = 0;
@@ -65 +69 @@
          TxFnameExtension( log_fname, "log");
       }
-      if ((log_handle = fopen(log_fname, "a" TXFMODE)) == 0)
+      if (((log_handle = fopen(log_fname, "a" TXFMODE)) == 0) && (verbose))
       {
          TxPrint("Error opening log : '%s'\n", log_fname);
@@ -72 +76 @@
       {
          TxLogfileState( DEVICE_ON);            // always ON for new file
-         if (TxaOptUnSet('7'))                  // NO strip to 7-bit ASCII
-         {
-            log_7bit = FALSE;
-         }
-         if (TxaExeArgc() != 0)                 // Switches already parsed ?
-         {                                      // (-q = quiet switch to come)
-            TxPrint("Appending to log  : '%s' (%s-bit ASCII)\n",
-                      log_fname, (log_7bit) ? "7" : "8");
+         if (verbose)                           // avoid any TxPrint when
+         {                                      // working in quiet mode
+            if (TxaOptUnSet('7'))               // NO strip to 7-bit ASCII
+            {
+               log_7bit = FALSE;
+            }
+            if (TxaExeArgc() != 0)              // Switches already parsed ?
+            {                                   // (-q = quiet switch to come)
+               TxPrint("Appending to log  : '%s' (%s-bit ASCII)\n",
+                         log_fname, (log_7bit) ? "7" : "8");
+            }
          }
       }
@@ -148 +155 @@
 /*---------------------------------------------------------------------------*/
 
+
 /*****************************************************************************/
 // Get name for current logfile, if any
@@ -166 +174 @@
 /*---------------------------------------------------------------------------*/
 
+
+/*****************************************************************************/
+// Construct name for new logfile based upon a sequence number 0..n
+/*****************************************************************************/
+char *TxBuildLogName                            // RET   filename or NULL
+(
+   ULONG               seq,                     // IN    sequence number
+   TXLN                buf                      // IN    filename buffer
+)
+{
+   char               *rc = buf;
+   TXTS                ext;
+
+   if (seq == 0)                                // first will be .log
+   {
+      strcpy( ext, "log");
+   }
+   else
+   {
+      sprintf( ext, "l%02lu", seq);
+   }
+   strcpy( rc, log_fname);
+
+   TxStripExtension( rc);                       // remove current extension
+   TxFnameExtension( rc, ext);                  // and add new one
+
+   return (rc);
+}                                               // end 'TxBuildLogName'
+/*---------------------------------------------------------------------------*/
+

trunk/txlib/txparse.c

@@ -249 +249 @@
 
 /*****************************************************************************/
+// Get option value num/string, with bytes/kilo/mega/giga modifier and default
+/*****************************************************************************/
+ULONG TxaOptBkmg                                // RET   number value in bytes
+(
+   TXHANDLE            txh,                     // IN    TXA handle
+   char                option,                  // IN    option character
+   ULONG               def,                     // IN    default value
+   BYTE                mod                      // IN    b,kb,mb,gb modifier
+)
+{
+   ULONG               rc = 0;                  // function return
+   BYTE                unit = TXA_DFUNIT;
+   TXA_OPTION         *opt;                     // option pointer
+
+   ENTER();
+   TRACES(("Option: '%c' default: %8.8lx mod:%2.2hx = '%c'\n",
+            option, def, mod, mod));
+
+   if ((opt = TxaOptValue( option)) != NULL)    // get the option details
+   {
+      switch (opt->type)
+      {
+         case TXA_STRING:
+            rc   = TxaParseNumber( opt->value.string, TX_RADIX_STD_CLASS, &unit);
+         case TXA_NO_VAL:
+            rc   = def;
+            break;
+
+         default:                               // convert, default is MiB!
+            rc   = opt->value.number;
+            unit = opt->unit;
+            break;
+      }
+   }
+   if (unit == TXA_DFUNIT)
+   {
+      unit = mod;
+   }
+   switch (tolower(unit))
+   {
+      case 'g':
+         if (rc >= 4)
+         {
+            rc = 0xffffffff;
+            break;
+         }
+         else
+         {
+            rc *= 1024;                         // Giga
+         }
+      case 'm': rc *= 1024;                     // Mega
+      case 'k': rc *= 1024;                     // Kilo
+      default:  break;                          // Bytes, OK
+   }
+   RETURN (rc);
+}                                               // end 'TxaParseBkmgNumber'
+/*---------------------------------------------------------------------------*/
+
+
+/*****************************************************************************/
 // Read one item (option or argument) and store it in the txa element
 /*****************************************************************************/
@@ -680 +740 @@
 
 /*****************************************************************************/
+// Get option value num/string, with bytes/kilo/mega/giga modifier and default
+/*****************************************************************************/
+ULONG TxaOptionBkmg                             // RET   number value in bytes
+(
+   TXHANDLE            txh,                     // IN    TXA handle
+   char                option,                  // IN    option character
+   ULONG               def,                     // IN    default value
+   BYTE                mod                      // IN    b,kb,mb,gb modifier
+)
+{
+   ULONG               rc = 0;                  // function return
+   BYTE                unit = TXA_DFUNIT;
+   TXA_OPTION         *opt;                     // option pointer
+
+   ENTER();
+   TRACES(("Option: '%c' default: %8.8lx mod:%2.2hx = '%c'\n",
+            option, def, mod, mod));
+
+   if ((opt = TxaOptValue( option)) != NULL)    // get the option details
+   {
+      switch (opt->type)
+      {
+         case TXA_STRING:
+            rc   = TxaParseNumber( opt->value.string, TX_RADIX_STD_CLASS, &unit);
+         case TXA_NO_VAL:
+            rc   = def;
+            break;
+
+         default:                               // convert, default is MiB!
+            rc   = opt->value.number;
+            unit = opt->unit;
+            break;
+      }
+   }
+   if (unit == TXA_DFUNIT)
+   {
+      unit = mod;
+   }
+   switch (tolower(unit))
+   {
+      case 'g': rc *= 1024;                     // Giga
+      case 'm': rc *= 1024;                     // Mega
+      case 'k': rc *= 1024;                     // Kilo
+      default:  break;                          // Bytes, OK
+   }
+   RETURN (rc);
+}                                               // end 'TxaOptionBkmg'
+/*---------------------------------------------------------------------------*/
+
+
+/*****************************************************************************/
 // Get reference to specified argument-string
 /*****************************************************************************/

trunk/txlib/txstdcmd.c

@@ -101 +101 @@
          TxSetLogReOpen( TxaOption('r'));
       }
-      TxAppendToLogFile( c1);
+      if (TxaOptSet('m'))
+      {
+         TxSetLogMaxSize( TxaOptBkmg( 'm', 2047, 'k'));
+      }
+      if (TxaOptSet('f'))
+      {
+         TxSetLogRetain( TxaOptNum('f', NULL, 1));
+      }
+      TxAppendToLogFile( c1, TRUE);
    }
    else if (stricmp(c0, "trace"    ) == 0)
@@ -110 +118 @@
                   "Usage:  trace  [-r] [-s] [-t] [level | filename]\n\n"
                   "   -d[:xx]      add xx ms delay for each trace line, slowdown\n"
+                  "   -f[:ff]      retain ff numbered logfiles when cycling\n"
+                  "   -m[:mm]      cycle to next logfile after size mm\n"
                   "   -r           close and reopen log on each line (slow)\n"
                   "   -r-          open log just once (this is the default)\n"
@@ -139 +149 @@
             TxTrLogOnly =   !TxaOption('s');    // to screen with -s
          }
+         if (TxaOptSet('m'))
+         {
+            TxSetLogMaxSize( TxaOptBkmg( 'm', 2047, 'k'));
+         }
+         if (TxaOptSet('f'))
+         {
+            TxSetLogRetain( TxaOptNum('f', NULL, 1));
+         }
          if (isdigit( c1[0]))                   // setting a level
          {
@@ -147 +165 @@
             if (strlen( c1))
             {
-               TxAppendToLogFile( c1);
+               TxAppendToLogFile( c1, TRUE);
                TxTrLevel = 100;
             }

trunk/txlib/txtrace.c

@@ -125 +125 @@
 
          sprintf( trcfile, "%s-%lu", prefix, TxTrLevel);
-         TxAppendToLogFile( trcfile);
+         TxAppendToLogFile( trcfile, TRUE);
       }
    }

trunk/txlib/txvers.h

@@ -40 +40 @@
 // Originally developed for LPTool/DFSee utilities, open-sourced in 2005
 //
-#define TXLIB_V "1.07 04-05-2006" // JvW Avoid (history) popup from other list
+#define TXLIB_V "1.08 12-05-2006" // JvW Logfile maximum size and auto-cycling
+//efine TXLIB_V "1.07 04-05-2006" // JvW Avoid (history) popup from other list
 //efine TXLIB_V "1.07 02-05-2006" // JvW Ctrl-D on cmdline, auto NEXT history
 //efine TXLIB_V "1.07 30-04-2006" // JvW Ctrl-D, delete history-item from popup