aboutsummaryrefslogtreecommitdiff
path: root/tests/cluster/cluster_test.go
blob: 55a2b9951eba0bbc2427b4ed4fb221f3d9e3d9a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
// package cluster_test finds out what happens if multiple
// gocryptfs mounts write to one file concurrently
// (usually, nothing good).
//
// This use case is relevant for HPC clusters.
package cluster_test

import (
	"bytes"
	"errors"
	"io"
	"math/rand"
	"os"
	"sync"
	"syscall"
	"testing"

	"github.com/rfjakob/gocryptfs/v2/internal/contentenc"
	"github.com/rfjakob/gocryptfs/v2/tests/test_helpers"
)

// This test passes on XFS but fails on ext4 and tmpfs!!!
//
// Quoting https://lists.samba.org/archive/samba-technical/2019-March/133050.html
//
// > It turns out that xfs respects POSIX w.r.t "atomic read/write" and
// > this is implemented by taking a file-wide shared lock on every
// > buffered read.
// > This behavior is unique to XFS on Linux and is not optional.
// > Other Linux filesystems only guaranty page level atomicity for
// > buffered read/write.
//
// See also:
// * https://lore.kernel.org/linux-xfs/20190325001044.GA23020@dastard/
//   Dave Chinner: XFS is the only linux filesystem that provides this behaviour.
func TestClusterConcurrentRW(t *testing.T) {
	if os.Getenv("ENABLE_CLUSTER_TEST") != "1" {
		t.Skipf("This test is disabled by default because it fails unless on XFS.\n" +
			"Run it like this: ENABLE_CLUSTER_TEST=1 go test\n" +
			"Choose a backing directory by setting TMPDIR.")
	}

	const blocksize = contentenc.DefaultBS
	const fileSize = 25 * blocksize // 100 kiB

	cDir := test_helpers.InitFS(t)
	mnt1 := cDir + ".mnt1"
	mnt2 := cDir + ".mnt2"
	test_helpers.MountOrFatal(t, cDir, mnt1, "-extpass=echo test", "-wpanic=0")
	defer test_helpers.UnmountPanic(mnt1)
	test_helpers.MountOrFatal(t, cDir, mnt2, "-extpass=echo test", "-wpanic=0")
	defer test_helpers.UnmountPanic(mnt2)

	f1, err := os.Create(mnt1 + "/foo")
	if err != nil {
		t.Fatal(err)
	}
	defer f1.Close()
	// Preallocate space
	_, err = f1.WriteAt(make([]byte, fileSize), 0)
	if err != nil {
		t.Fatal(err)
	}
	f2, err := os.OpenFile(mnt2+"/foo", os.O_RDWR, 0)
	if err != nil {
		t.Fatal(err)
	}
	defer f2.Close()

	var wg sync.WaitGroup

	const loops = 10000
	writeThread := func(f *os.File) {
		defer wg.Done()
		buf := make([]byte, blocksize)
		for i := 0; i < loops; i++ {
			if t.Failed() {
				return
			}
			off := rand.Int63n(fileSize / blocksize)
			_, err := f.WriteAt(buf, off)
			if err != nil {
				t.Errorf("writeThread iteration %d: WriteAt failed: %v", i, err)
				return
			}
		}
	}
	readThread := func(f *os.File) {
		defer wg.Done()
		zeroBlock := make([]byte, blocksize)
		buf := make([]byte, blocksize)
		for i := 0; i < loops; i++ {
			if t.Failed() {
				return
			}
			off := rand.Int63n(fileSize / blocksize)
			_, err := f.ReadAt(buf, off)
			if err != nil {
				t.Errorf("readThread iteration %d: ReadAt failed: %v", i, err)
				return
			}
			if !bytes.Equal(buf, zeroBlock) {
				t.Errorf("readThread iteration %d: data mismatch", i)
				return
			}
		}
	}

	wg.Add(4)
	go writeThread(f1)
	go writeThread(f2)
	go readThread(f1)
	go readThread(f2)
	wg.Wait()
}

// Multiple hosts creating the same file at the same time could
// overwrite each other's file header, leading to data
// corruption. Passing "-sharedstorage" should prevent this.
func TestConcurrentCreate(t *testing.T) {
	cDir := test_helpers.InitFS(t)
	mnt1 := cDir + ".mnt1"
	mnt2 := cDir + ".mnt2"
	test_helpers.MountOrFatal(t, cDir, mnt1, "-extpass=echo test", "-wpanic=0", "-sharedstorage")
	defer test_helpers.UnmountPanic(mnt1)
	test_helpers.MountOrFatal(t, cDir, mnt2, "-extpass=echo test", "-wpanic=0", "-sharedstorage")
	defer test_helpers.UnmountPanic(mnt2)

	var wg sync.WaitGroup
	const loops = 10000

	createOrOpen := func(path string) (f *os.File, err error) {
		// Use the high-level os.Create/OpenFile instead of syscall.Open because we
		// *want* Go's EINTR retry logic. glibc open(2) has similar logic.
		f, err = os.OpenFile(path, os.O_CREATE|os.O_RDWR|os.O_EXCL, 0600)
		if err == nil {
			return
		}
		if !errors.Is(err, os.ErrExist) {
			t.Logf("POSIX compliance issue: exclusive create failed with unexpected error: err=%v", errors.Unwrap(err))
		}
		f, err = os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0600)
		if err == nil {
			return
		}
		t.Logf("POSIX compliance issue: non-exlusive create failed with err=%v", errors.Unwrap(err))
		return
	}

	workerThread := func(path string) {
		defer wg.Done()
		buf := make([]byte, 10)
		for i := 0; i < loops; i++ {
			if t.Failed() {
				return
			}
			f, err := createOrOpen(path)
			if err != nil {
				// retry
				continue
			}
			defer f.Close()
			_, err = f.WriteAt(buf, 0)
			if err != nil {
				t.Errorf("iteration %d: Pwrite: %v", i, err)
				return
			}
			buf2 := make([]byte, len(buf)+1)
			n, err := f.ReadAt(buf2, 0)
			if err != nil && err != io.EOF {
				t.Errorf("iteration %d: ReadAt: %v", i, err)
				return
			}
			buf2 = buf2[:n]
			if !bytes.Equal(buf, buf2) {
				t.Errorf("iteration %d: corrupt data received: %x", i, buf2)
				return
			}
			syscall.Unlink(path)
		}
	}

	wg.Add(2)
	go workerThread(mnt1 + "/foo")
	go workerThread(mnt2 + "/foo")
	wg.Wait()
}

func TestOpenTruncate(t *testing.T) {
	cDir := test_helpers.InitFS(t)
	mnt1 := cDir + ".mnt1"
	mnt2 := cDir + ".mnt2"
	test_helpers.MountOrFatal(t, cDir, mnt1, "-extpass=echo test", "-wpanic=0", "-sharedstorage")
	defer test_helpers.UnmountPanic(mnt1)
	test_helpers.MountOrFatal(t, cDir, mnt2, "-extpass=echo test", "-wpanic=0", "-sharedstorage")
	defer test_helpers.UnmountPanic(mnt2)

	var wg sync.WaitGroup
	const loops = 100

	writerThread := func(path string) {
		defer wg.Done()
		for i := 0; i < loops; i++ {
			if t.Failed() {
				return
			}
			f, err := os.Create(path)
			if err != nil {
				t.Logf("POSIX compliance issue: non-exlusive create failed with err=%v", errors.Unwrap(err))
				continue
			}
			_, err = f.WriteAt([]byte("foo"), 0)
			if err != nil {
				t.Errorf("iteration %d: WriteAt: %v", i, err)
			}
			f.Close()
		}
	}

	wg.Add(2)
	go writerThread(mnt1 + "/foo")
	go writerThread(mnt2 + "/foo")
	wg.Wait()
}