1505d282ac
* Regenerate code to update copyright end year to 2023 * Test behaviour of default values initialized in different ways This adds repro tests for #126 and #129 * Fix Swap and CompareAndSwap for Value wrappers Fixes #126, #129 All atomic types can be used without initialization, e.g., `var v <AtomicType>`. This works fine for integer types as the initialized value of 0 matches the default value for the user-facing type. However, for Value wrappers, they are initialized to `nil`, which is a value that can't be set (triggers a panic) so the default value for the user-facing type is forced to be stored as a different value. This leads to multiple possible values representing the default user-facing type. E.g., an `atomic.String` with value `""` may be represented by the underlying atomic as either `nil`, or `""`. This causes issues when we don't handle the `nil` value correctly, causing to panics in `Swap` and incorrectly not swapping values in `CompareAndSwap`. This change fixes the above issues by: * Requiring `pack` and `unpack` function in gen-atomicwrapper as the only place we weren't supplying them was for `String`, and the branching adds unnecessary complexity, especially with added `nil` handling. * Extending `CompareAndSwap` for `Value` wrappers to try an additional `CompareAndSwap(nil, <new>)` only if the original `CompareAndSwap` fails and the old value is the zero value.
89 lines
2.5 KiB
Go
89 lines
2.5 KiB
Go
// @generated Code generated by gen-atomicwrapper.
|
|
|
|
// Copyright (c) 2020-2023 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"
|
|
)
|
|
|
|
// Bool is an atomic type-safe wrapper for bool values.
|
|
type Bool struct {
|
|
_ nocmp // disallow non-atomic comparison
|
|
|
|
v Uint32
|
|
}
|
|
|
|
var _zeroBool bool
|
|
|
|
// NewBool creates a new Bool.
|
|
func NewBool(val bool) *Bool {
|
|
x := &Bool{}
|
|
if val != _zeroBool {
|
|
x.Store(val)
|
|
}
|
|
return x
|
|
}
|
|
|
|
// Load atomically loads the wrapped bool.
|
|
func (x *Bool) Load() bool {
|
|
return truthy(x.v.Load())
|
|
}
|
|
|
|
// Store atomically stores the passed bool.
|
|
func (x *Bool) Store(val bool) {
|
|
x.v.Store(boolToInt(val))
|
|
}
|
|
|
|
// CAS is an atomic compare-and-swap for bool values.
|
|
//
|
|
// Deprecated: Use CompareAndSwap.
|
|
func (x *Bool) CAS(old, new bool) (swapped bool) {
|
|
return x.CompareAndSwap(old, new)
|
|
}
|
|
|
|
// CompareAndSwap is an atomic compare-and-swap for bool values.
|
|
func (x *Bool) CompareAndSwap(old, new bool) (swapped bool) {
|
|
return x.v.CompareAndSwap(boolToInt(old), boolToInt(new))
|
|
}
|
|
|
|
// Swap atomically stores the given bool and returns the old
|
|
// value.
|
|
func (x *Bool) Swap(val bool) (old bool) {
|
|
return truthy(x.v.Swap(boolToInt(val)))
|
|
}
|
|
|
|
// MarshalJSON encodes the wrapped bool into JSON.
|
|
func (x *Bool) MarshalJSON() ([]byte, error) {
|
|
return json.Marshal(x.Load())
|
|
}
|
|
|
|
// UnmarshalJSON decodes a bool from JSON.
|
|
func (x *Bool) UnmarshalJSON(b []byte) error {
|
|
var v bool
|
|
if err := json.Unmarshal(b, &v); err != nil {
|
|
return err
|
|
}
|
|
x.Store(v)
|
|
return nil
|
|
}
|