mirror of
https://github.com/syncthing/syncthing.git
synced 2024-11-15 18:08:45 -07:00
all: Add comment to ensure correct atomics alignment (fixes #5813)
Per the sync/atomic bug note: > On ARM, x86-32, and 32-bit MIPS, it is the caller's > responsibility to arrange for 64-bit alignment of 64-bit words > accessed atomically. The first word in a variable or in an > allocated struct, array, or slice can be relied upon to be > 64-bit aligned. All atomic accesses of 64-bit variables in syncthing code base are currently ok (i.e they are all 64-bit aligned). Generally, the bug is triggered because of incorrect alignement of struct fields. Free variables (declared in a function) are guaranteed to be 64-bit aligned by the Go compiler. To ensure the code remains correct upon further addition/removal of fields, which would change the currently correct alignment, I added the following comment where required: // atomic, must remain 64-bit aligned See https://golang.org/pkg/sync/atomic/#pkg-note-BUG.
This commit is contained in:
parent
20c8dbd9ed
commit
f1a7dd766e
@ -86,9 +86,9 @@ func getStatus(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type rateCalculator struct {
|
type rateCalculator struct {
|
||||||
|
counter *int64 // atomic, must remain 64-bit aligned
|
||||||
rates []int64
|
rates []int64
|
||||||
prev int64
|
prev int64
|
||||||
counter *int64
|
|
||||||
startTime time.Time
|
startTime time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -10,8 +10,8 @@ import (
|
|||||||
|
|
||||||
type countingReader struct {
|
type countingReader struct {
|
||||||
io.Reader
|
io.Reader
|
||||||
tot int64 // bytes
|
tot int64 // bytes (atomic, must remain 64-bit aligned)
|
||||||
last int64 // unix nanos
|
last int64 // unix nanos (atomic, must remain 64-bit aligned)
|
||||||
}
|
}
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@ -37,8 +37,8 @@ func (c *countingReader) Last() time.Time {
|
|||||||
|
|
||||||
type countingWriter struct {
|
type countingWriter struct {
|
||||||
io.Writer
|
io.Writer
|
||||||
tot int64 // bytes
|
tot int64 // bytes (atomic, must remain 64-bit aligned)
|
||||||
last int64 // unix nanos
|
last int64 // unix nanos (atomic, must remain 64-bit aligned)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *countingWriter) Write(bs []byte) (int, error) {
|
func (c *countingWriter) Write(bs []byte) (int, error) {
|
||||||
|
@ -537,7 +537,7 @@ func (w *walker) handleError(ctx context.Context, context, path string, err erro
|
|||||||
// A byteCounter gets bytes added to it via Update() and then provides the
|
// A byteCounter gets bytes added to it via Update() and then provides the
|
||||||
// Total() and one minute moving average Rate() in bytes per second.
|
// Total() and one minute moving average Rate() in bytes per second.
|
||||||
type byteCounter struct {
|
type byteCounter struct {
|
||||||
total int64
|
total int64 // atomic, must remain 64-bit aligned
|
||||||
metrics.EWMA
|
metrics.EWMA
|
||||||
stop chan struct{}
|
stop chan struct{}
|
||||||
}
|
}
|
||||||
|
@ -39,7 +39,7 @@ const (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type writeTrackingPacketConn struct {
|
type writeTrackingPacketConn struct {
|
||||||
lastWrite int64
|
lastWrite int64 // atomic, must remain 64-bit aligned
|
||||||
net.PacketConn
|
net.PacketConn
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user