ArchiSteamFarm.CustomPlugins.PeriodicGC/PeriodicGCPlugin.cs

   1 // ----------------------------------------------------------------------------------------------
   2 //     _                _      _  ____   _                           _____
   3 //    / \    _ __  ___ | |__  (_)/ ___| | |_  ___   __ _  _ __ ___  |  ___|__ _  _ __  _ __ ___
   4 //   / _ \  | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_  / _` || '__|| '_ ` _ \
   5 //  / ___ \ | |  | (__ | | | || | ___) || |_|  __/| (_| || | | | | ||  _|| (_| || |   | | | | | |
   6 // /_/   \_\|_|   \___||_| |_||_||____/  \__|\___| \__,_||_| |_| |_||_|   \__,_||_|   |_| |_| |_|
   7 // ----------------------------------------------------------------------------------------------
   8 // |
   9 // Copyright 2015-2024 Łukasz "JustArchi" Domeradzki
  10 // Contact: JustArchi@JustArchi.net
  11 // |
  12 // Licensed under the Apache License, Version 2.0 (the "License");
  13 // you may not use this file except in compliance with the License.
  14 // You may obtain a copy of the License at
  15 // |
  16 // http://www.apache.org/licenses/LICENSE-2.0
  17 // |
  18 // Unless required by applicable law or agreed to in writing, software
  19 // distributed under the License is distributed on an "AS IS" BASIS,
  20 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21 // See the License for the specific language governing permissions and
  22 // limitations under the License.
  23
  24 using System;
  25 using System.ComponentModel.DataAnnotations;
  26 using System.Composition;
  27 using System.Runtime;
  28 using System.Text.Json.Serialization;
  29 using System.Threading;
  30 using System.Threading.Tasks;
  31 using ArchiSteamFarm.Core;
  32 using ArchiSteamFarm.Plugins.Interfaces;
  33 using JetBrains.Annotations;
  34
  35 namespace ArchiSteamFarm.CustomPlugins.PeriodicGC;
  36
  37 [Export(typeof(IPlugin))]
  38 [UsedImplicitly]
  39 internal sealed class PeriodicGCPlugin : IPlugin {
  40         private const byte GCPeriod = 60; // In seconds
  41
  42         private static readonly object LockObject = new();
  43         private static readonly Timer PeriodicGCTimer = new(PerformGC);
  44
  45         [JsonInclude]
  46         [Required]
  47         public string Name => nameof(PeriodicGCPlugin);
  48
  49         [JsonInclude]
  50         [Required]
  51         public Version Version => typeof(PeriodicGCPlugin).Assembly.GetName().Version ?? throw new InvalidOperationException(nameof(Version));
  52
  53         public Task OnLoaded() {
  54                 TimeSpan timeSpan = TimeSpan.FromSeconds(GCPeriod);
  55
  56                 ASF.ArchiLogger.LogGenericWarning($"Periodic GC will occur every {timeSpan.ToHumanReadable()}. Please keep in mind that this plugin should be used for debugging tests only.");
  57
  58                 lock (LockObject) {
  59                         PeriodicGCTimer.Change(timeSpan, timeSpan);
  60                 }
  61
  62                 return Task.CompletedTask;
  63         }
  64
  65         private static void PerformGC(object? state = null) {
  66                 ASF.ArchiLogger.LogGenericWarning($"Performing GC, current memory: {GC.GetTotalMemory(false) / 1024} KB.");
  67
  68                 lock (LockObject) {
  69                         GCSettings.LargeObjectHeapCompactionMode = GCLargeObjectHeapCompactionMode.CompactOnce;
  70                         GC.Collect(GC.MaxGeneration, GCCollectionMode.Forced, true, true);
  71                 }
  72
  73                 ASF.ArchiLogger.LogGenericWarning($"GC finished, current memory: {GC.GetTotalMemory(false) / 1024} KB.");
  74         }
  75 }