chore: remove unused extra files from goreleaser configuration

.gitea/workflows/release-tag.yaml

@@ -1,4 +1,4 @@
-name: Release Tag
+name: Release
 on:
   push:
     tags:
@@ -6,6 +6,7 @@ on:
 
 jobs:
   release:
+    name: Build versioned release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.gitea/workflows/test-pr.yaml

@@ -1,4 +1,4 @@
-name: PR Check
+name: CI
 on:
   - pull_request
 

.gitignore

@@ -1,3 +1,2 @@
-dist/
 tmp/
 __*.exe

.goreleaser.yaml

@@ -5,15 +5,13 @@ before:
     - go mod tidy
 
 builds:
-  - ldflags:
+- env:
-      - -X s1d3sw1ped/SteamCache2/version.Version={{.Version}}
+  - CGO_ENABLED=0
-    env:
+  goos:
-      - CGO_ENABLED=0
+  - linux
-    goos:
+  - windows
-      - linux
+  goarch:
-      - windows
+  - amd64
-    goarch:
-      - amd64
 
 archives:
   - format: tar.gz
@@ -36,7 +34,6 @@ changelog:
       - "^test:"
 
 release:
-  name_template: '{{.ProjectName}}-{{.Version}}'
   footer: >-
 
     ---

.vscode/launch.json

@@ -5,42 +5,15 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Launch Memory & Disk",
+            "name": "Launch Package",
             "type": "go",
             "request": "launch",
             "mode": "auto",
             "program": "${workspaceFolder}/main.go",
             "args": [
-                "--memory",
+                "--memory", "1G",
-                "1G",
+                "--disk", "10G",
-                "--disk",
+                "--disk-path", "tmp/disk",
-                "10G",
-                "--disk-path",
-                "tmp/disk",
-            ],
-        },
-        {
-            "name": "Launch Disk Only",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "${workspaceFolder}/main.go",
-            "args": [
-                "--disk",
-                "10G",
-                "--disk-path",
-                "tmp/disk",
-            ],
-        },
-        {
-            "name": "Launch Memory Only",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "${workspaceFolder}/main.go",
-            "args": [
-                "--memory",
-                "1G",
             ],
         }
     ]

README.md

@@ -55,8 +55,7 @@ This will direct any requests to `lancache.steamcontent.com` to your SteamCache2
 
 ## License
 
-See the [LICENSE](LICENSE) file for details.
+This project is licensed. See the [LICENSE](LICENSE) file for details.
-But just for clarity this covers all files in this project unless stated in the individual file.
 
 ## Acknowledgements
 

cmd/root.go

@@ -1,3 +1,24 @@
+/*
+Copyright © 2025 s1d3sw1ped
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
 package cmd
 
 import (
@@ -46,9 +67,9 @@ func Execute() {
 }
 
 func init() {
-	rootCmd.Flags().StringVarP(&memory, "memory", "m", "0", "The size of the memory cache")
+	rootCmd.Flags().StringVarP(&memory, "memory", "m", "100MB", "The size of the memory cache")
-	rootCmd.Flags().IntVarP(&memorymultiplier, "memory-gc", "M", 10, "The gc value for the memory cache")
+	rootCmd.Flags().IntVarP(&memorymultiplier, "memory-multiplier", "M", 10, "The multiplier for the memory cache")
-	rootCmd.Flags().StringVarP(&disk, "disk", "d", "0", "The size of the disk cache")
+	rootCmd.Flags().StringVarP(&disk, "disk", "d", "10GB", "The size of the disk cache")
-	rootCmd.Flags().IntVarP(&diskmultiplier, "disk-gc", "D", 100, "The gc value for the disk cache")
+	rootCmd.Flags().IntVarP(&diskmultiplier, "disk-multiplier", "D", 10, "The multiplier for the disk cache")
-	rootCmd.Flags().StringVarP(&diskpath, "disk-path", "p", "", "The path to the disk cache")
+	rootCmd.Flags().StringVarP(&diskpath, "disk-path", "p", "tmp/steamcache2-disk", "The path to the disk cache")
 }

cmd/version.go

@@ -1,23 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"os"
-	"s1d3sw1ped/SteamCache2/version"
-
-	"github.com/spf13/cobra"
-)
-
-// versionCmd represents the version command
-var versionCmd = &cobra.Command{
-	Use:   "version",
-	Short: "prints the version of SteamCache2",
-	Long:  `Prints the version of SteamCache2. This command is useful for checking the version of the application.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Fprintln(os.Stderr, "SteamCache2", version.Version)
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(versionCmd)
-}

main.go

@@ -1,9 +1,27 @@
+/*
+Copyright © 2025 s1d3sw1ped
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
 package main
 
-import (
+import "s1d3sw1ped/SteamCache2/cmd"
-	"s1d3sw1ped/SteamCache2/cmd"
-	_ "s1d3sw1ped/SteamCache2/version" // Import the version package for global version variable
-)
 
 func main() {
 	cmd.Execute()

steamcache/avgcachestate/avgcachestate.go

@@ -14,15 +14,11 @@ type AvgCacheState struct {
 
 // New creates a new average cache state with the given size.
 func New(size int) *AvgCacheState {
-	a := &AvgCacheState{
+	return &AvgCacheState{
 		size: size,
 		avgs: make([]cachestate.CacheState, size),
 		mu:   sync.Mutex{},
 	}
-
-	a.Clear()
-
-	return a
 }
 
 // Clear resets the average cache state to zero.
@@ -30,9 +26,7 @@ func (a *AvgCacheState) Clear() {
 	a.mu.Lock()
 	defer a.mu.Unlock()
 
-	for i := 0; i < len(a.avgs); i++ {
+	a.avgs = make([]cachestate.CacheState, a.size) // zeroed
-		a.avgs[i] = cachestate.CacheStateMiss
-	}
 }
 
 // Add adds a cache state to the average cache state.
@@ -51,13 +45,16 @@ func (a *AvgCacheState) Avg() float64 {
 	a.mu.Lock()
 	defer a.mu.Unlock()
 
-	var hits int
+	var hits, misses int
-
 	for _, cs := range a.avgs {
-		if cs == cachestate.CacheStateHit {
+		switch cs {
+		case cachestate.CacheStateHit:
 			hits++
+		case cachestate.CacheStateMiss:
+			misses++
 		}
 	}
+	total := hits + misses
 
-	return float64(hits) / float64(len(a.avgs))
+	return float64(hits) / float64(total)
 }

steamcache/gc.go

@@ -1,42 +1,73 @@
 package steamcache
 
 import (
+	"s1d3sw1ped/SteamCache2/steamcache/logger"
 	"s1d3sw1ped/SteamCache2/vfs"
 	"s1d3sw1ped/SteamCache2/vfs/cachestate"
 	"time"
 
+	"github.com/docker/go-units"
 	"golang.org/x/exp/rand"
 )
 
-// RandomGC randomly deletes files until we've reclaimed enough space.
+func randomgc(vfss vfs.VFS, stats []*vfs.FileInfo) int64 {
-func randomgc(vfss vfs.VFS, size uint) (uint, uint) {
+	// Pick a random file to delete
-
+	randfile := stats[rand.Intn(len(stats))]
-	// Randomly delete files until we've reclaimed enough space.
+	sz := randfile.Size()
-	random := func(vfss vfs.VFS, stats []*vfs.FileInfo) int64 {
+	err := vfss.Delete(randfile.Name())
-		randfile := stats[rand.Intn(len(stats))]
+	if err != nil {
-		sz := randfile.Size()
+		// If we failed to delete the file, log it and return 0
-		err := vfss.Delete(randfile.Name())
+		// logger.Logger.Error().Err(err).Msgf("Failed to delete %s", randfile.Name())
-		if err != nil {
+		return 0
-			return 0
-		}
-
-		return sz
 	}
 
+	return sz
+}
+
+func memorygc(vfss vfs.VFS, size int) {
+	tstart := time.Now()
 	deletions := 0
 	targetreclaim := int64(size)
 	var reclaimed int64
 
 	stats := vfss.StatAll()
 	for {
-		reclaimed += random(vfss, stats)
+		reclaimed += randomgc(vfss, stats)
 		deletions++
 		if reclaimed >= targetreclaim {
 			break
 		}
 	}
 
-	return uint(reclaimed), uint(deletions)
+	logger.Logger.Info().
+		Str("name", vfss.Name()).
+		Str("duration", time.Since(tstart).String()).
+		Str("reclaimed", units.HumanSize(float64(reclaimed))).
+		Int("deletions", deletions).
+		Msgf("GC")
+}
+
+func diskgc(vfss vfs.VFS, size int) {
+	tstart := time.Now()
+	deletions := 0
+	targetreclaim := int64(size)
+	var reclaimed int64
+
+	stats := vfss.StatAll()
+	for {
+		reclaimed += randomgc(vfss, stats)
+		deletions++
+		if reclaimed >= targetreclaim {
+			break
+		}
+	}
+
+	logger.Logger.Info().
+		Str("name", vfss.Name()).
+		Str("duration", time.Since(tstart).String()).
+		Str("reclaimed", units.HumanSize(float64(reclaimed))).
+		Int("deletions", deletions).
+		Msgf("GC")
 }
 
 func cachehandler(fi *vfs.FileInfo, cs cachestate.CacheState) bool {

steamcache/steamcache.go

@@ -8,7 +8,6 @@ import (
 	"os"
 	"s1d3sw1ped/SteamCache2/steamcache/avgcachestate"
 	"s1d3sw1ped/SteamCache2/steamcache/logger"
-	"s1d3sw1ped/SteamCache2/version"
 	"s1d3sw1ped/SteamCache2/vfs"
 	"s1d3sw1ped/SteamCache2/vfs/cache"
 	"s1d3sw1ped/SteamCache2/vfs/cachestate"
@@ -30,9 +29,6 @@ type SteamCache struct {
 	memory *memory.MemoryFS
 	disk   *disk.DiskFS
 
-	memorygc *gc.GCFS
-	diskgc   *gc.GCFS
-
 	hits *avgcachestate.AvgCacheState
 
 	dirty bool
@@ -50,78 +46,49 @@ func New(address string, memorySize string, memoryMultiplier int, diskSize strin
 		panic(err)
 	}
 
-	c := cache.New(
+	m := memory.New(memorysize)
-		cachehandler,
+	d := disk.New(diskPath, disksize)
-	)
-
-	var m *memory.MemoryFS
-	var mgc *gc.GCFS
-	if memorysize > 0 {
-		m = memory.New(memorysize)
-		mgc = gc.New(m, memoryMultiplier, randomgc)
-	}
-
-	var d *disk.DiskFS
-	var dgc *gc.GCFS
-	if disksize > 0 {
-		d = disk.New(diskPath, disksize)
-		dgc = gc.New(d, diskMultiplier, randomgc)
-	}
-
-	// configure the cache to match the specified mode (memory only, disk only, or memory and disk) based on the provided sizes
-	if disksize == 0 && memorysize != 0 {
-		//memory only mode - no disk
-
-		c.SetSlow(mgc)
-		logger.Logger.Info().Bool("memory", true).Bool("disk", false).Msg("configuration")
-	} else if disksize != 0 && memorysize == 0 {
-		// disk only mode
-
-		c.SetSlow(dgc)
-		logger.Logger.Info().Bool("memory", false).Bool("disk", true).Msg("configuration")
-	} else if disksize != 0 && memorysize != 0 {
-		// memory and disk mode
-
-		c.SetFast(mgc)
-		c.SetSlow(dgc)
-		logger.Logger.Info().Bool("memory", true).Bool("disk", true).Msg("configuration")
-	} else {
-		// no memory or disk isn't a valid configuration
-		logger.Logger.Error().Bool("memory", false).Bool("disk", false).Msg("configuration invalid :( exiting")
-		os.Exit(1)
-	}
 
 	sc := &SteamCache{
 		address: address,
-		vfs:     syncfs.New(c),
+		vfs: syncfs.New(
+			cache.New(
+				gc.New(
+					m,
+					memoryMultiplier,
+					memorygc,
+				),
+				gc.New(
+					d,
+					diskMultiplier,
+					diskgc,
+				),
+				cachehandler,
+			),
+		),
 
 		memory: m,
 		disk:   d,
 
-		memorygc: mgc,
+		hits: avgcachestate.New(10000),
-		diskgc:   dgc,
-
-		hits: avgcachestate.New(100),
 	}
 
-	if d != nil {
+	if d.Size() > d.Capacity() {
-		if d.Size() > d.Capacity() {
+		diskgc(d, int(d.Size()-d.Capacity()))
-			randomgc(d, uint(d.Size()-d.Capacity()))
-		}
 	}
 
 	return sc
 }
 
 func (sc *SteamCache) Run() {
-	logger.Logger.Info().Str("address", sc.address).Str("version", version.Version).Msg("listening")
+	logger.Logger.Info().Str("address", sc.address).Msg("listening")
 
 	sc.mu.Lock()
 	sc.dirty = true
 	sc.mu.Unlock()
 
 	sc.LogStats()
-	t := time.NewTicker(1 * time.Second)
+	t := time.NewTicker(10 * time.Second)
 	go func() {
 		for range t.C {
 			sc.LogStats()
@@ -143,49 +110,11 @@ func (sc *SteamCache) LogStats() {
 	sc.mu.Lock()
 	defer sc.mu.Unlock()
 	if sc.dirty {
-
-		logger.Logger.Info().Msg("") // empty line to separate log entries for better readability
-
-		if sc.memory != nil { // only log memory if memory is enabled
-			lifetimeBytes, lifetimeFiles, reclaimedBytes, deletedFiles, gcTime := sc.memorygc.Stats()
-
-			logger.Logger.Info().
-				Str("size", units.HumanSize(float64(sc.memory.Size()))).
-				Str("capacity", units.HumanSize(float64(sc.memory.Capacity()))).
-				Str("files", fmt.Sprintf("%d", len(sc.memory.StatAll()))).
-				Msg("memory")
-
-			logger.Logger.Info().
-				Str("data_total", units.HumanSize(float64(lifetimeBytes))).
-				Uint("files_total", lifetimeFiles).
-				Str("data", units.HumanSize(float64(reclaimedBytes))).
-				Uint("files", deletedFiles).
-				Str("gc_time", gcTime.String()).
-				Msg("memory_gc")
-		}
-
-		if sc.disk != nil { // only log disk if disk is enabled
-			lifetimeBytes, lifetimeFiles, reclaimedBytes, deletedFiles, gcTime := sc.diskgc.Stats()
-
-			logger.Logger.Info().
-				Str("size", units.HumanSize(float64(sc.disk.Size()))).
-				Str("capacity", units.HumanSize(float64(sc.disk.Capacity()))).
-				Str("files", fmt.Sprintf("%d", len(sc.disk.StatAll()))).
-				Msg("disk")
-
-			logger.Logger.Info().
-				Str("data_total", units.HumanSize(float64(lifetimeBytes))).
-				Uint("files_total", lifetimeFiles).
-				Str("data", units.HumanSize(float64(reclaimedBytes))).
-				Uint("files", deletedFiles).
-				Str("gc_time", gcTime.String()).
-				Msg("disk_gc")
-		}
-
 		logger.Logger.Info().
+			Str("memory", fmt.Sprintf("%s/%s", units.HumanSize(float64(sc.memory.Size())), units.HumanSize(float64(sc.memory.Capacity())))).Int("memory-files", len(sc.memory.StatAll())).
+			Str("disk", fmt.Sprintf("%s/%s", units.HumanSize(float64(sc.disk.Size())), units.HumanSize(float64(sc.disk.Capacity())))).Int("disk-files", len(sc.disk.StatAll())).
 			Str("hitrate", fmt.Sprintf("%.2f%%", sc.hits.Avg()*100)).
-			Msg("cache")
+			Msg("stats")
-
 		sc.dirty = false
 	}
 }

version/version.go

@@ -1,3 +0,0 @@
-package version
-
-var Version string

vfs/cache/cache.go

@@ -21,24 +21,23 @@ type CacheFS struct {
 type CacheHandler func(*vfs.FileInfo, cachestate.CacheState) bool
 
 // New creates a new CacheFS. fast is used for caching, and slow is used for storage. fast should obviously be faster than slow.
-func New(cacheHandler CacheHandler) *CacheFS {
+func New(fast, slow vfs.VFS, cacheHandler CacheHandler) *CacheFS {
+	if slow == nil {
+		panic("slow is nil")
+	}
+
+	if fast == slow {
+		panic("fast and slow are the same")
+	}
+
 	return &CacheFS{
+		fast: fast,
+		slow: slow,
+
 		cacheHandler: cacheHandler,
 	}
 }
 
-func (c *CacheFS) SetSlow(vfs vfs.VFS) {
-	if vfs == nil {
-		panic("vfs is nil") // panic if the vfs is nil
-	}
-
-	c.slow = vfs
-}
-
-func (c *CacheFS) SetFast(vfs vfs.VFS) {
-	c.fast = vfs
-}
-
 // cacheState returns the state of the file at key.
 func (c *CacheFS) cacheState(key string) cachestate.CacheState {
 	if c.fast != nil {

vfs/cache/cache_test.go

@@ -20,9 +20,7 @@ func TestNew(t *testing.T) {
 	fast := testMemory()
 	slow := testMemory()
 
-	cache := New(nil)
+	cache := New(fast, slow, nil)
-	cache.SetFast(fast)
-	cache.SetSlow(slow)
 	if cache == nil {
 		t.Fatal("expected cache to be non-nil")
 	}
@@ -37,9 +35,7 @@ func TestNewPanics(t *testing.T) {
 		}
 	}()
 
-	cache := New(nil)
+	New(nil, nil, nil)
-	cache.SetFast(nil)
-	cache.SetSlow(nil)
 }
 
 func TestSetAndGet(t *testing.T) {
@@ -47,9 +43,7 @@ func TestSetAndGet(t *testing.T) {
 
 	fast := testMemory()
 	slow := testMemory()
-	cache := New(nil)
+	cache := New(fast, slow, nil)
-	cache.SetFast(fast)
-	cache.SetSlow(slow)
 
 	key := "test"
 	value := []byte("value")
@@ -72,8 +66,7 @@ func TestSetAndGetNoFast(t *testing.T) {
 	t.Parallel()
 
 	slow := testMemory()
-	cache := New(nil)
+	cache := New(nil, slow, nil)
-	cache.SetSlow(slow)
 
 	key := "test"
 	value := []byte("value")
@@ -96,11 +89,9 @@ func TestCaching(t *testing.T) {
 
 	fast := testMemory()
 	slow := testMemory()
-	cache := New(func(fi *vfs.FileInfo, cs cachestate.CacheState) bool {
+	cache := New(fast, slow, func(fi *vfs.FileInfo, cs cachestate.CacheState) bool {
 		return true
 	})
-	cache.SetFast(fast)
-	cache.SetSlow(slow)
 
 	key := "test"
 	value := []byte("value")
@@ -157,9 +148,7 @@ func TestGetNotFound(t *testing.T) {
 
 	fast := testMemory()
 	slow := testMemory()
-	cache := New(nil)
+	cache := New(fast, slow, nil)
-	cache.SetFast(fast)
-	cache.SetSlow(slow)
 
 	_, err := cache.Get("nonexistent")
 	if !errors.Is(err, vfserror.ErrNotFound) {
@@ -172,9 +161,7 @@ func TestDelete(t *testing.T) {
 
 	fast := testMemory()
 	slow := testMemory()
-	cache := New(nil)
+	cache := New(fast, slow, nil)
-	cache.SetFast(fast)
-	cache.SetSlow(slow)
 
 	key := "test"
 	value := []byte("value")
@@ -198,9 +185,7 @@ func TestStat(t *testing.T) {
 
 	fast := testMemory()
 	slow := testMemory()
-	cache := New(nil)
+	cache := New(fast, slow, nil)
-	cache.SetFast(fast)
-	cache.SetSlow(slow)
 
 	key := "test"
 	value := []byte("value")

vfs/disk/disk.go

@@ -27,24 +27,6 @@ type DiskFS struct {
 
 // New creates a new DiskFS.
 func new(root string, capacity int64, skipinit bool) *DiskFS {
-	if capacity <= 0 {
-		panic("disk capacity must be greater than 0") // panic if the capacity is less than or equal to 0
-	}
-
-	if root == "" {
-		panic("disk root must not be empty") // panic if the root is empty
-	}
-
-	fi, err := os.Stat(root)
-	if err != nil {
-		if !os.IsNotExist(err) {
-			panic(err) // panic if the error is something other than not found
-		}
-	}
-	if !fi.IsDir() {
-		panic("disk root must be a directory") // panic if the root is not a directory
-	}
-
 	dfs := &DiskFS{
 		root:     root,
 		info:     make(map[string]*vfs.FileInfo),
@@ -78,12 +60,7 @@ func (d *DiskFS) init() {
 	d.walk(d.root)
 	d.sg.Wait()
 
-	logger.Logger.Info().
+	logger.Logger.Info().Str("name", d.Name()).Str("root", d.root).Str("capacity", units.HumanSize(float64(d.capacity))).Str("duration", time.Since(tstart).String()).Msg("init")
-		Str("name", d.Name()).
-		Str("root", d.root).
-		Str("capacity", units.HumanSize(float64(d.capacity))).
-		Str("duration", time.Since(tstart).String()).
-		Msg("init")
 }
 
 func (d *DiskFS) walk(path string) {

vfs/gc/gc.go

@@ -4,8 +4,6 @@ import (
 	"fmt"
 	"s1d3sw1ped/SteamCache2/vfs"
 	"s1d3sw1ped/SteamCache2/vfs/vfserror"
-	"sync"
-	"time"
 )
 
 // Ensure GCFS implements VFS.
@@ -14,23 +12,14 @@ var _ vfs.VFS = (*GCFS)(nil)
 // GCFS is a virtual file system that calls a GC handler when the disk is full. The GC handler is responsible for freeing up space on the disk. The GCFS is a wrapper around another VFS.
 type GCFS struct {
 	vfs.VFS
-	multiplier int
+	multiplier   int
-
+	gcHanderFunc GCHandlerFunc
-	// protected by mu
-	gcHanderFunc                 GCHandlerFunc
-	lifetimeBytes, lifetimeFiles uint
-	reclaimedBytes, deletedFiles uint
-	gcTime                       time.Duration
-	mu                           sync.Mutex
 }
 
 // GCHandlerFunc is a function that is called when the disk is full and the GCFS needs to free up space. It is passed the VFS and the size of the file that needs to be written. Its up to the implementation to free up space. How much space is freed is also up to the implementation.
-type GCHandlerFunc func(vfs vfs.VFS, size uint) (reclaimedBytes uint, deletedFiles uint)
+type GCHandlerFunc func(vfs vfs.VFS, size int)
 
 func New(vfs vfs.VFS, multiplier int, gcHandlerFunc GCHandlerFunc) *GCFS {
-	if multiplier <= 0 {
-		multiplier = 1 // if the multiplier is less than or equal to 0 set it to 1 will be slow but the user can set it to a higher value if they want
-	}
 	return &GCFS{
 		VFS:          vfs,
 		multiplier:   multiplier,
@@ -38,44 +27,13 @@ func New(vfs vfs.VFS, multiplier int, gcHandlerFunc GCHandlerFunc) *GCFS {
 	}
 }
 
-// Stats returns the lifetime bytes, lifetime files, reclaimed bytes and deleted files.
-// The lifetime bytes and lifetime files are the total bytes and files that have been freed up by the GC handler.
-// The reclaimed bytes and deleted files are the bytes and files that have been freed up by the GC handler since last call to Stats.
-// The gc time is the total time spent in the GC handler since last call to Stats.
-// The reclaimed bytes and deleted files and gc time are reset to 0 after the call to Stats.
-func (g *GCFS) Stats() (lifetimeBytes, lifetimeFiles, reclaimedBytes, deletedFiles uint, gcTime time.Duration) {
-	g.mu.Lock()
-	defer g.mu.Unlock()
-
-	g.lifetimeBytes += g.reclaimedBytes
-	g.lifetimeFiles += g.deletedFiles
-
-	lifetimeBytes = g.lifetimeBytes
-	lifetimeFiles = g.lifetimeFiles
-	reclaimedBytes = g.reclaimedBytes
-	deletedFiles = g.deletedFiles
-	gcTime = g.gcTime
-
-	g.reclaimedBytes = 0
-	g.deletedFiles = 0
-	g.gcTime = time.Duration(0)
-
-	return
-}
-
 // Set overrides the Set method of the VFS interface. It tries to set the key and src, if it fails due to disk full error, it calls the GC handler and tries again. If it still fails it returns the error.
 func (g *GCFS) Set(key string, src []byte) error {
-	g.mu.Lock()
-	defer g.mu.Unlock()
 	err := g.VFS.Set(key, src) // try to set the key and src
 
 	if err == vfserror.ErrDiskFull && g.gcHanderFunc != nil { // if the error is disk full and there is a GC handler
-		tstart := time.Now()
+		g.gcHanderFunc(g.VFS, len(src)*g.multiplier) // call the GC handler
-		reclaimedBytes, deletedFiles := g.gcHanderFunc(g.VFS, uint(len(src)*g.multiplier)) // call the GC handler
+		err = g.VFS.Set(key, src)                    // try again after GC if it still fails return the error
-		g.gcTime += time.Since(tstart)
-		g.reclaimedBytes += reclaimedBytes
-		g.deletedFiles += deletedFiles
-		err = g.VFS.Set(key, src) // try again after GC if it still fails return the error
 	}
 
 	return err

vfs/gc/gc_test.go

@@ -6,6 +6,7 @@ import (
 	"s1d3sw1ped/SteamCache2/vfs/memory"
 	"sort"
 	"testing"
+	"time"
 
 	"golang.org/x/exp/rand"
 )
@@ -14,11 +15,13 @@ func TestGCSmallRandom(t *testing.T) {
 	t.Parallel()
 
 	m := memory.New(1024 * 1024 * 16)
-	gc := New(m, 10, func(vfs vfs.VFS, size uint) (uint, uint) {
+	gc := New(m, 10, func(vfs vfs.VFS, size int) {
+		tstart := time.Now()
 		deletions := 0
-		var reclaimed uint
+		targetreclaim := int64(size)
+		var reclaimed int64
 
-		t.Logf("GC starting to reclaim %d bytes", size)
+		t.Logf("GC starting to reclaim %d bytes", targetreclaim)
 
 		stats := vfs.StatAll()
 		sort.Slice(stats, func(i, j int) bool {
@@ -28,7 +31,7 @@ func TestGCSmallRandom(t *testing.T) {
 
 		// Delete the oldest files until we've reclaimed enough space.
 		for _, s := range stats {
-			sz := uint(s.Size()) // Get the size of the file
+			sz := s.Size() // Get the size of the file
 			err := vfs.Delete(s.Name())
 			if err != nil {
 				panic(err)
@@ -38,11 +41,12 @@ func TestGCSmallRandom(t *testing.T) {
 
 			// t.Logf("GC deleting %s, %v", s.Name(), s.AccessTime().Format(time.RFC3339Nano))
 
-			if reclaimed >= size { // We've reclaimed enough space
+			if reclaimed >= targetreclaim { // We've reclaimed enough space
 				break
 			}
 		}
-		return uint(reclaimed), uint(deletions)
+
+		t.Logf("GC took %v to reclaim %d bytes by deleting %d files", time.Since(tstart), reclaimed, deletions)
 	})
 
 	for i := 0; i < 10000; i++ {
@@ -66,11 +70,13 @@ func TestGCLargeRandom(t *testing.T) {
 	t.Parallel()
 
 	m := memory.New(1024 * 1024 * 16) // 16MB
-	gc := New(m, 10, func(vfs vfs.VFS, size uint) (uint, uint) {
+	gc := New(m, 10, func(vfs vfs.VFS, size int) {
+		tstart := time.Now()
 		deletions := 0
-		var reclaimed uint
+		targetreclaim := int64(size)
+		var reclaimed int64
 
-		t.Logf("GC starting to reclaim %d bytes", size)
+		t.Logf("GC starting to reclaim %d bytes", targetreclaim)
 
 		stats := vfs.StatAll()
 		sort.Slice(stats, func(i, j int) bool {
@@ -80,17 +86,17 @@ func TestGCLargeRandom(t *testing.T) {
 
 		// Delete the oldest files until we've reclaimed enough space.
 		for _, s := range stats {
-			sz := uint(s.Size()) // Get the size of the file
+			sz := s.Size() // Get the size of the file
 			vfs.Delete(s.Name())
 			reclaimed += sz // Track how much space we've reclaimed
 			deletions++     // Track how many files we've deleted
 
-			if reclaimed >= size { // We've reclaimed enough space
+			if reclaimed >= targetreclaim { // We've reclaimed enough space
 				break
 			}
 		}
 
-		return uint(reclaimed), uint(deletions)
+		t.Logf("GC took %v to reclaim %d bytes by deleting %d files", time.Since(tstart), reclaimed, deletions)
 	})
 
 	for i := 0; i < 10000; i++ {

vfs/memory/memory.go

@@ -25,10 +25,6 @@ type MemoryFS struct {
 
 // New creates a new MemoryFS.
 func New(capacity int64) *MemoryFS {
-	if capacity <= 0 {
-		panic("memory capacity must be greater than 0") // panic if the capacity is less than or equal to 0
-	}
-
 	return &MemoryFS{
 		files:    make(map[string]*file),
 		capacity: capacity,