982a2dde23
It is currently possible to make non-atomic comparisons of atomic
values:
x := atomic.NewInt32(1)
y := atomic.NewInt32(1)
fmt.Println(*x == *y)
This is undesirable because it loads the value in a non-atomic way. The
correct method is,
x := atomic.NewInt32(1)
y := atomic.NewInt32(1)
fmt.Println(x.Load() == y.Load())
To prevent this, disallow comparison of atomic values by embedding an
uncomparable array into atomics. The empty array adds no runtime cost,
and does not increase the in-memory size of the structs. Inspired by
[go4.org/mem#RO][1].
[1]: 3dbcd07079/mem.go (L42)
Note that the Value struct, which embeds `"sync/atomic".Value` was also
changed. This will break usages in the following form, but that's
acceptable because unkeyed struct literals are among the exceptions
stated in the [Go 1 compatibility expectations][2].
import (
syncatomic "sync/atomic"
"go.uber.org/atomic"
)
atomic.Value{syncatomic.Value{..}}
[2]: https://golang.org/doc/go1compat#expectations
Resolves #72
96 lines
2.8 KiB
Go
96 lines
2.8 KiB
Go
// @generated Code generated by gen-atomicint.
|
|
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// 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 atomic
|
|
|
|
import (
|
|
"encoding/json"
|
|
"sync/atomic"
|
|
)
|
|
|
|
// Uint64 is an atomic wrapper around uint64.
|
|
type Uint64 struct {
|
|
nocmp // disallow non-atomic comparison
|
|
|
|
v uint64
|
|
}
|
|
|
|
// NewUint64 creates a new Uint64.
|
|
func NewUint64(i uint64) *Uint64 {
|
|
return &Uint64{v: i}
|
|
}
|
|
|
|
// Load atomically loads the wrapped value.
|
|
func (i *Uint64) Load() uint64 {
|
|
return atomic.LoadUint64(&i.v)
|
|
}
|
|
|
|
// Add atomically adds to the wrapped uint64 and returns the new value.
|
|
func (i *Uint64) Add(n uint64) uint64 {
|
|
return atomic.AddUint64(&i.v, n)
|
|
}
|
|
|
|
// Sub atomically subtracts from the wrapped uint64 and returns the new value.
|
|
func (i *Uint64) Sub(n uint64) uint64 {
|
|
return atomic.AddUint64(&i.v, ^(n - 1))
|
|
}
|
|
|
|
// Inc atomically increments the wrapped uint64 and returns the new value.
|
|
func (i *Uint64) Inc() uint64 {
|
|
return i.Add(1)
|
|
}
|
|
|
|
// Dec atomically decrements the wrapped uint64 and returns the new value.
|
|
func (i *Uint64) Dec() uint64 {
|
|
return i.Sub(1)
|
|
}
|
|
|
|
// CAS is an atomic compare-and-swap.
|
|
func (i *Uint64) CAS(old, new uint64) bool {
|
|
return atomic.CompareAndSwapUint64(&i.v, old, new)
|
|
}
|
|
|
|
// Store atomically stores the passed value.
|
|
func (i *Uint64) Store(n uint64) {
|
|
atomic.StoreUint64(&i.v, n)
|
|
}
|
|
|
|
// Swap atomically swaps the wrapped uint64 and returns the old value.
|
|
func (i *Uint64) Swap(n uint64) uint64 {
|
|
return atomic.SwapUint64(&i.v, n)
|
|
}
|
|
|
|
// MarshalJSON encodes the wrapped uint64 into JSON.
|
|
func (i *Uint64) MarshalJSON() ([]byte, error) {
|
|
return json.Marshal(i.Load())
|
|
}
|
|
|
|
// UnmarshalJSON decodes JSON into the wrapped uint64.
|
|
func (i *Uint64) UnmarshalJSON(b []byte) error {
|
|
var v uint64
|
|
if err := json.Unmarshal(b, &v); err != nil {
|
|
return err
|
|
}
|
|
i.Store(v)
|
|
return nil
|
|
}
|