From 749d7af464cd3c67f2a45fcba7de546ac1216a65 Mon Sep 17 00:00:00 2001
From: PascalCoin <bpascalblockchain@gmail.com>
Date: Wed, 4 Oct 2023 10:47:34 +0200
Subject: [PATCH] Added Log to TCacheMem

---
 src/libraries/abstractmem/UCacheMem.pas | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/src/libraries/abstractmem/UCacheMem.pas b/src/libraries/abstractmem/UCacheMem.pas
index 1323512d..87780bc9 100644
--- a/src/libraries/abstractmem/UCacheMem.pas
+++ b/src/libraries/abstractmem/UCacheMem.pas
@@ -122,6 +122,7 @@   TCacheMemStats = record
   TOnSaveDataProc = function(const ABuffer; AStartPos : Int64; ASize: Integer): Integer of object;
   TOnNeedsTotalSizeProc = function(const ABuffer; AStartPos : Int64; ASize: Integer): Integer of object;
   TOnFinalizedCacheProc = procedure(const ASender : TCacheMem; const AProcessDesc : String; AElapsedMilis: Int64) of object;
+  TOnLog = procedure(ASender : TObject; const ALog : String) of object;
 
   ECacheMem = Class(Exception);
 
@@ -143,6 +144,7 @@   TCacheMemStats = record
     FDefaultCacheDataBlocksSize : Int64;
     FGridCache : Boolean;
     FOnFlushedCache: TOnFinalizedCacheProc;
+    FOnLog: TOnLog;
     function FindCacheMemDataByPosition(APosition : Int64; out APCacheMemData : PCacheMemData) : Boolean;
     procedure Delete(var APCacheMemData : PCacheMemData); overload;
     function FlushCache(const AFlushCacheList : TOrderedList<PCacheMemData>) : Boolean; overload;
@@ -183,6 +185,7 @@   TCacheMemStats = record
     {$ENDIF}
     function GetStatsReport(AClearStats : Boolean) : String;
     property OnFlushedCache : TOnFinalizedCacheProc read FOnFlushedCache write FOnFlushedCache;
+    property OnLog : TOnLog read FOnLog write FOnLog;
   End;
 
 implementation
@@ -360,6 +363,7 @@ constructor TCacheMem.Create(AOnNeedDataProc : TOnNeedDataProc; AOnSaveDataProc
   FOldestUsed := Nil;
   FNewestUsed := Nil;
   FOnFlushedCache := Nil;
+  FOnLog := Nil;
 end;
 
 procedure TCacheMem.Delete(var APCacheMemData : PCacheMemData);
@@ -490,7 +494,8 @@ function TCacheMem.FlushCache: Boolean;
 
 function TCacheMem.FreeMem(const AMaxMemSize, AMaxBlocks: Int64) : Boolean;
 var
-  i, LTempCacheDataSize, LAuxCacheDataSize,
+  i, LTotalRemovedBlocks : Integer;
+  LTempCacheDataSize, LAuxCacheDataSize,
   LFinalMaxMemSize, LMaxPendingRounds : Int64;
   PToRemove, PToNext : PCacheMemData;
   LListToFlush : TOrderedList<PCacheMemData>;
@@ -509,12 +514,16 @@ function TCacheMem.FreeMem(const AMaxMemSize, AMaxBlocks: Int64) : Boolean;
   LPreviousCacheDataBlocks := FCacheDataBlocks;
   try
   {$ENDIF}
+  if Assigned(FOnLog) then begin
+    FOnLog(Self,Format('%s.FreeMem(MaxMem:%d,MaxBlocks:%d) Mem:%d Blocks:%d',[Self.ClassName,AMaxMemSize,AMaxBlocks,FCacheDataSize,FCacheDataBlocks]));
+  end;
 
   if (AMaxMemSize<0) then LFinalMaxMemSize := FCacheDataSize
   else LFinalMaxMemSize := AMaxMemSize;
   if (AMaxBlocks<0) then LMaxPendingRounds := 0
   else LMaxPendingRounds := FCacheDataBlocks - AMaxBlocks;
   //
+  LTotalRemovedBlocks := 0;
   PToRemove := FOldestUsed;
   LListToFlush := TOrderedList<PCacheMemData>.Create(False,_TCacheMemDataTree_Compare);
   try
@@ -524,6 +533,7 @@ function TCacheMem.FreeMem(const AMaxMemSize, AMaxBlocks: Int64) : Boolean;
       // Both conditions must be true
       ((LTempCacheDataSize > LFinalMaxMemSize) or (LMaxPendingRounds>0))
       do begin
+      inc(LTotalRemovedBlocks);
       Dec(LMaxPendingRounds);
       PToNext := PToRemove^.used_next; // Capture now to avoid future PToRemove updates
       Dec(LTempCacheDataSize, Int64(PToRemove^.GetSize));
@@ -550,11 +560,14 @@ function TCacheMem.FreeMem(const AMaxMemSize, AMaxBlocks: Int64) : Boolean;
     if (Result) and (LAuxCacheDataSize<>0) then raise ECacheMem.Create(Format('Inconsistent error on FreeMem Removed size %d<>0 with CacheDataSize %d (save list %d)',[LAuxCacheDataSize,FCacheDataSize,LListToFlush.Count]));
     if (Result) and (LTempCacheDataSize > FCacheDataSize) then raise ECacheMem.Create(Format('Inconsistent error on FreeMem Expected Cache size is Higher (%d > obtained %d) (save list %d)',[LTempCacheDataSize,FCacheDataSize,LListToFlush.Count]));
     if (Result) and (LMaxPendingRounds>0) then raise ECacheMem.Create(Format('Inconsistent error on FreeMem Expected Max Blocks %d <> obtained %d',[AMaxBlocks,FCacheDataBlocks]));
+    if Assigned(FOnLog) then begin
+      FOnLog(Self,Format('Final %s.FreeMem(MaxMem:%d,MaxBlocks:%d) Mem:%d (=Temporal Mem:%d) Blocks:%d Removed:%d Flushed:%d',
+        [Self.ClassName,AMaxMemSize,AMaxBlocks,FCacheDataSize,LTempCacheDataSize,FCacheDataBlocks,LTotalRemovedBlocks,LListToFlush.Count]));
+    end;
   finally
     LListToFlush.Free;
   end;
 
-  Result := (Result) And (FCacheDataSize <= AMaxMemSize);
   {$IFDEF ABSTRACTMEM_ENABLE_STATS}
   finally
   Inc(FCacheMemStats.freememCount);