optimisations

Author: BRUNER Patrick

src/LogExpert.Core/Classes/Log/LogBuffer.cs

@@ -20,24 +20,18 @@ public class LogBuffer
     private LogLine[] _lineArray;
     private int _lineArrayLength; // capacity of the rented array
 
-    //private readonly List<LogLine> _lineList;
-
     private int MAX_LINES = 500;
 
     #endregion
 
     #region cTor
 
-    //public LogBuffer() { }
-
     // Don't use a primary constructor here: field initializers (like MAX_LINES) run before primary constructor parameters are assigned,
     // so MAX_LINES would always be set to its default value before the constructor body can assign it. Use a regular constructor instead.
     public LogBuffer (ILogFileInfo fileInfo, int maxLines)
     {
         FileInfo = fileInfo;
         MAX_LINES = maxLines;
-        //_lineList = new(MAX_LINES);
-
         _lineArray = ArrayPool<LogLine>.Shared.Rent(maxLines);
         _lineArrayLength = _lineArray.Length;
 #if DEBUG
@@ -89,8 +83,6 @@ public long Size
 
     public void AddLine (LogLine lineMemory, long filePos)
     {
-        //_lineList.Add(lineMemory);
-
         if (LineCount < _lineArrayLength)
         {
             _lineArray[LineCount] = lineMemory;
@@ -112,7 +104,6 @@ public void AddLine (LogLine lineMemory, long filePos)
     public void ClearLines ()
     {
         Array.Clear(_lineArray, 0, LineCount);
-        //_lineList.Clear();
         LineCount = 0;
     }
 
@@ -140,8 +131,6 @@ public void Reinitialise (ILogFileInfo fileInfo, int maxLines)
 
     public void DisposeContent ()
     {
-        //_lineList.Clear();
-
         if (_lineArray != null)
         {
             Array.Clear(_lineArray, 0, LineCount);
@@ -161,9 +150,6 @@ public void DisposeContent ()
         return num < LineCount && num >= 0
         ? _lineArray[num]
         : null;
-        //return num < _lineList.Count && num >= 0
-        //    ? _lineList[num]
-        //    : null;
     }
 
     /// <summary>

src/LogExpert.Core/Classes/Log/LogBufferPool.cs

@@ -20,6 +20,13 @@ public LogBuffer Rent (ILogFileInfo fileInfo, int maxLines)
         return new LogBuffer(fileInfo, maxLines);
     }
 
+    /// <summary>
+    /// Returns a <see cref="LogBuffer"/> to the pool for reuse.
+    /// </summary>
+    /// <remarks>
+    /// Disposing the buffer's content is handled by this method, so callers should not dispose the buffer themselves.
+    /// </remarks>
+    /// <param name="buffer">The buffer to return.</param>
     public void Return (LogBuffer buffer)
     {
         ArgumentNullException.ThrowIfNull(buffer);

src/LogExpert.Core/Classes/Log/LogfileReader.cs

@@ -55,7 +55,7 @@ public partial class LogfileReader : IAutoLogLineMemoryColumnizerCallback, IDisp
     private bool _disposed;
     private ILogFileInfo _watchedILogFileInfo;
 
-    private bool _isLineCountDirty = true;
+    private volatile bool _isLineCountDirty = true;
 
     private volatile bool _isFailModeCheckCallPending;
     private volatile bool _isFastFailOnGetLogLine;
@@ -183,12 +183,17 @@ public int LineCount
                 else
                 {
                     AcquireBufferListReaderLock();
-                    foreach (var buffer in _bufferList.Values)
+                    try
                     {
-                        field += buffer.LineCount;
+                        foreach (var buffer in _bufferList.Values)
+                        {
+                            field += buffer.LineCount;
+                        }
+                    }
+                    finally
+                    {
+                        ReleaseBufferListReaderLock();
                     }
-
-                    ReleaseBufferListReaderLock();
                 }
 
                 _isLineCountDirty = false;
@@ -410,10 +415,10 @@ public int ShiftBuffers ()
 
                 foreach (var logFileInfo in lostILogFileInfoList)
                 {
-                    var lastBuffer = DeleteBuffersForInfo(logFileInfo, false);
-                    if (lastBuffer != null)
+                    var lastDeletedBufferInfo = DeleteBuffersForInfo(logFileInfo, false);
+                    if (lastDeletedBufferInfo != null)
                     {
-                        offset += lastBuffer.StartLine + lastBuffer.LineCount;
+                        offset += lastDeletedBufferInfo.Value.StartLine + lastDeletedBufferInfo.Value.LineCount;
                     }
                 }
 
@@ -1061,39 +1066,43 @@ private ValueTask<ILogLineMemory> GetLogLineMemoryInternal (int lineNum)
         }
 
         AcquireBufferListReaderLock();
-        var (logBuffer, _) = GetBufferForLineWithIndex(lineNum);
-        if (logBuffer == null)
-        {
-            ReleaseBufferListReaderLock();
-            _logger.Error("Cannot find buffer for line {0}, file: {1}{2}", lineNum, _fileName, IsMultiFile ? " (MultiFile)" : "");
-            return default;
-        }
-
-        var lockTaken = false;
         try
         {
-            logBuffer.AcquireContentLock(ref lockTaken);
+            var (logBuffer, _) = GetBufferForLineWithIndex(lineNum);
+            if (logBuffer == null)
+            {
+                _logger.Error("Cannot find buffer for line {0}, file: {1}{2}", lineNum, _fileName, IsMultiFile ? " (MultiFile)" : "");
+                return default;
+            }
 
-            if (logBuffer.IsDisposed)
+            var lockTaken = false;
+            try
             {
-                lock (logBuffer.FileInfo)
+                logBuffer.AcquireContentLock(ref lockTaken);
+
+                if (logBuffer.IsDisposed)
                 {
-                    ReReadBuffer(logBuffer);
+                    lock (logBuffer.FileInfo)
+                    {
+                        ReReadBuffer(logBuffer);
+                    }
                 }
-            }
 
-            var line = logBuffer.GetLineMemoryOfBlock(lineNum - logBuffer.StartLine);
-            return line.HasValue
-            ? new ValueTask<ILogLineMemory>(line.Value)
-            : default;
+                var line = logBuffer.GetLineMemoryOfBlock(lineNum - logBuffer.StartLine);
+                return line.HasValue
+                ? new ValueTask<ILogLineMemory>(line.Value)
+                : default;
+            }
+            finally
+            {
+                if (lockTaken)
+                {
+                    logBuffer.ReleaseContentLock();
+                }
+            }
         }
         finally
         {
-            if (lockTaken)
-            {
-                logBuffer.ReleaseContentLock();
-            }
-
             ReleaseBufferListReaderLock();
         }
     }
@@ -1204,12 +1213,12 @@ private void ReplaceBufferInfos (ILogFileInfo oldLogFileInfo, ILogFileInfo newLo
     /// <param name="matchNamesOnly">
     /// true to match buffers by file name only; false to require an exact object match for the log file information.
     /// </param>
-    /// <returns>The last LogBuffer instance that was removed; or null if no matching buffers were found.</returns>
-    private LogBuffer DeleteBuffersForInfo (ILogFileInfo iLogFileInfo, bool matchNamesOnly)
+    /// <returns>The StartLine and LineCount of the Logbuffer that was removed or null</returns>
+    private (int StartLine, int LineCount)? DeleteBuffersForInfo (ILogFileInfo iLogFileInfo, bool matchNamesOnly)
     {
         _logger.Info($"Deleting buffers for file {iLogFileInfo.FullName}");
         ClearBufferState();
-        LogBuffer lastRemovedBuffer = null;
+        (int StartLine, int LineCount)? lastRemovedInfo = null;
         IList<LogBuffer> deleteList = [];
 
         if (matchNamesOnly)
@@ -1218,7 +1227,7 @@ private LogBuffer DeleteBuffersForInfo (ILogFileInfo iLogFileInfo, bool matchNam
             {
                 if (buffer.FileInfo.FullName.Equals(iLogFileInfo.FullName, StringComparison.Ordinal))
                 {
-                    lastRemovedBuffer = buffer;
+                    lastRemovedInfo = (buffer.StartLine, buffer.LineCount);
                     deleteList.Add(buffer);
                 }
             }
@@ -1229,7 +1238,7 @@ private LogBuffer DeleteBuffersForInfo (ILogFileInfo iLogFileInfo, bool matchNam
             {
                 if (buffer.FileInfo == iLogFileInfo)
                 {
-                    lastRemovedBuffer = buffer;
+                    lastRemovedInfo = (buffer.StartLine, buffer.LineCount);
                     deleteList.Add(buffer);
                 }
             }
@@ -1238,18 +1247,32 @@ private LogBuffer DeleteBuffersForInfo (ILogFileInfo iLogFileInfo, bool matchNam
         foreach (var buffer in deleteList)
         {
             RemoveFromBufferList(buffer);
+
+            var lockTaken = false;
+            try
+            {
+                buffer.AcquireContentLock(ref lockTaken);
+                _bufferPool.Return(buffer);
+            }
+            finally
+            {
+                if (lockTaken)
+                {
+                    buffer.ReleaseContentLock();
+                }
+            }
         }
 
-        if (lastRemovedBuffer == null)
+        if (lastRemovedInfo == null)
         {
             _logger.Info(CultureInfo.InvariantCulture, "lastRemovedBuffer is null");
         }
         else
         {
-            _logger.Info(CultureInfo.InvariantCulture, "lastRemovedBuffer: startLine={0}", lastRemovedBuffer.StartLine);
+            _logger.Info(CultureInfo.InvariantCulture, $"lastRemovedBuffer: startLine={lastRemovedInfo.Value.StartLine}, lineCount={lastRemovedInfo.Value.LineCount}");
         }
 
-        return lastRemovedBuffer;
+        return lastRemovedInfo;
     }
 
     /// <summary>
@@ -1306,12 +1329,6 @@ private void ReadToBufferList (ILogFileInfo logFileInfo, long filePos, int start
                     logBuffer = _bufferPool.Rent(logFileInfo, _maxLinesPerBuffer);
                     logBuffer.StartLine = startLine;
                     logBuffer.StartPos = filePos;
-                    // logBuffer.PrevBuffersDroppedLinesSum = droppedLines;
-                    // logBuffer = new LogBuffer(logFileInfo, _maxLinesPerBuffer)
-                    // {
-                    //     StartLine = startLine,
-                    //     StartPos = filePos
-                    // };
 
                     UpgradeBufferlistLockToWriterLock();
 
@@ -1333,12 +1350,6 @@ private void ReadToBufferList (ILogFileInfo logFileInfo, long filePos, int start
                         logBuffer = _bufferPool.Rent(logFileInfo, _maxLinesPerBuffer);
                         logBuffer.StartLine = startLine;
                         logBuffer.StartPos = filePos;
-                        // logBuffer.PrevBuffersDroppedLinesSum = droppedLines;
-                        // logBuffer = new LogBuffer(logFileInfo, _maxLinesPerBuffer)
-                        // {
-                        //     StartLine = startLine,
-                        //     StartPos = filePos
-                        // };
 
                         UpgradeBufferlistLockToWriterLock();
 
@@ -1424,13 +1435,6 @@ private void ReadToBufferList (ILogFileInfo logFileInfo, long filePos, int start
                             newBuffer.StartPos = filePos;
                             newBuffer.PrevBuffersDroppedLinesSum = droppedLines;
 
-                            //var newBuffer = new LogBuffer(logFileInfo, _maxLinesPerBuffer)
-                            //{
-                            //    StartLine = lineNum,
-                            //    StartPos = filePos,
-                            //    PrevBuffersDroppedLinesSum = droppedLines
-                            //};
-
                             AcquireBufferListWriterLock();
 
                             try
@@ -1580,7 +1584,6 @@ private void GarbageCollectLruCache ()
                     try
                     {
                         removed.LogBuffer.AcquireContentLock(ref lockTaken);
-                        //removed.LogBuffer.DisposeContent();
                         _bufferPool.Return(removed.LogBuffer);
                     }
                     finally
@@ -1646,7 +1649,7 @@ private void ClearLru ()
             try
             {
                 entry.LogBuffer.AcquireContentLock(ref lockTaken);
-                entry.LogBuffer.DisposeContent();
+                _bufferPool.Return(entry.LogBuffer);
             }
             finally
             {
@@ -1760,7 +1763,7 @@ private void ReReadBuffer (LogBuffer logBuffer)
 #if DEBUG
         Util.AssertTrue(
             _bufferListLock.IsReadLockHeld || _bufferListLock.IsUpgradeableReadLockHeld || _bufferListLock.IsWriteLockHeld,
-            "No lock held for buffer list in GetBufferForLineCore");
+            "No lock held for buffer list in GetBufferForLineWithIndex");
         long startTime = Environment.TickCount;
 #endif
         var arr = _bufferList.Values;
@@ -1845,7 +1848,7 @@ private void ReReadBuffer (LogBuffer logBuffer)
         }
 #if DEBUG
         long endTime = Environment.TickCount;
-        _logger.Debug($"getBufferForLine({lineNum}) duration: {endTime - startTime} ms.");
+        _logger.Debug($"GetBufferForLineWithIndex({lineNum}) duration: {endTime - startTime} ms.");
 #endif
         return (null, -1);
     }
@@ -1905,11 +1908,8 @@ private void GetLineMemoryFinishedCallback (ILogLineMemory line)
     private LogBuffer GetFirstBufferForFileByLogBuffer (LogBuffer logBuffer, int index)
     {
         var info = logBuffer.FileInfo;
-        AcquireBufferListReaderLock();
-
         if (index == -1)
         {
-            ReleaseBufferListReaderLock();
             return null;
         }
 
@@ -1925,7 +1925,6 @@ private LogBuffer GetFirstBufferForFileByLogBuffer (LogBuffer logBuffer, int ind
             resultBuffer = _bufferList.Values[index];
         }
 
-        ReleaseBufferListReaderLock();
         return resultBuffer;
     }
 
@@ -1944,14 +1943,12 @@ private async Task MonitorThreadProc ()
         //IFileSystemPlugin fs = PluginRegistry.GetInstance().FindFileSystemForUri(this.watchedILogFileInfo.FullName);
         _logger.Info(CultureInfo.InvariantCulture, "MonitorThreadProc() for file {0}", _watchedILogFileInfo.FullName);
 
-        long oldSize;
         try
         {
             OnLoadingStarted(new LoadFileEventArgs(_fileName, 0, false, 0, false));
             ReadFiles();
             if (!_isDeleted)
             {
-                oldSize = _fileLength;
                 OnLoadingFinished();
             }
         }
@@ -1988,7 +1985,6 @@ private async Task MonitorThreadProc ()
                     }
                     else
                     {
-                        oldSize = _fileLength;
                         FileChanged();
                     }
                 }