Skip to content

Commit

Permalink
Fix concurrency issue in MemMapFs.Mkdir/MkdirAll
Browse files Browse the repository at this point in the history
* The backing map is protected by a RWMutex
* This commit double checks for the existence of the directory inside the write lock to avoid potential data races when multiple goroutines tries to create
the same directory.

Fixes #361
Fixes #298
  • Loading branch information
bep committed Nov 14, 2022
1 parent 2a70f2b commit 9d8d6ff
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 0 deletions.
5 changes: 5 additions & 0 deletions memmap.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,11 @@ func (m *MemMapFs) Mkdir(name string, perm os.FileMode) error {
}

m.mu.Lock()
// Dobule check that it doesn't exist.
if _, ok := m.getData()[name]; ok {
m.mu.Unlock()
return &os.PathError{Op: "mkdir", Path: name, Err: ErrFileExists}
}
item := mem.CreateDir(name)
mem.SetMode(item, os.ModeDir|perm)
m.getData()[name] = item
Expand Down
77 changes: 77 additions & 0 deletions memmap_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,16 @@ package afero
import (
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"runtime"
"strings"
"sync"
"testing"
"time"

"github.com/stretchr/testify/require"
)

func TestNormalizePath(t *testing.T) {
Expand Down Expand Up @@ -692,3 +697,75 @@ func TestMemFsLstatIfPossible(t *testing.T) {
t.Fatalf("Function indicated lstat was called. This should never be true.")
}
}

func TestListFilesAfterConcurrencyFileWrite(t *testing.T) {
const dir = "test_dir"
const n = 1000
mfs := NewMemMapFs().(*MemMapFs)
assert := require.New(t)

allFilePaths := make([]string, 0, n)

// run concurrency test
var wg sync.WaitGroup
for i := 0; i < n; i++ {
fp := filepath.Join(
dir,
fmt.Sprintf("%02d", n%10),
fmt.Sprintf("%d.txt", i),
)
allFilePaths = append(allFilePaths, fp)

wg.Add(1)
go func() {
defer wg.Done()

if err := mfs.MkdirAll(filepath.Dir(fp), 0755); err != nil {
assert.NoError(err)
}

wt, err := mfs.Create(fp)
if err != nil {
assert.NoError(err)
}
assert.NoError(err)
defer func() {
assert.NoError(wt.Close())
}()

// write 30 bytes
for j := 0; j < 10; j++ {
_, err := wt.Write([]byte("000"))
assert.NoError(err)
}
}()
}
wg.Wait()

// Test1: find all files by full path access
seen := make(map[string]bool)
for _, fp := range allFilePaths {
if seen[fp] {
fmt.Println("duplicate file path:", fp)
}
info, err := mfs.Stat(fp)
assert.NoErrorf(err, "stat file %s", fp)
assert.Equalf(int64(30), info.Size(), "file %s size unmatch", fp)
seen[fp] = true
}

// Test2: find all files by walk
foundFiles := make([]string, 0, n)
wErr := Walk(mfs, dir, func(path string, info fs.FileInfo, err error) error {
assert.NoError(err)
if info.IsDir() {
return nil // skip dir
}
if strings.HasSuffix(info.Name(), ".txt") {
foundFiles = append(foundFiles, path)
}
return nil
})
assert.NoError(wErr, "walk")
assert.Equal(n, len(foundFiles), "missing files")
}

0 comments on commit 9d8d6ff

Please sign in to comment.