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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
|
// Copyright 2023 Huan Du. All rights reserved.
// Licensed under the MIT license that can be found in the LICENSE file.
package clone
import (
"reflect"
"runtime"
"sync"
"unsafe"
)
var typeOfAllocator = reflect.TypeOf(Allocator{})
// defaultAllocator is the default allocator and allocates memory from heap.
var defaultAllocator = &Allocator{
new: heapNew,
makeSlice: heapMakeSlice,
makeMap: heapMakeMap,
makeChan: heapMakeChan,
isScalar: IsScalar,
}
// Allocator is a utility type for memory allocation.
type Allocator struct {
parent *Allocator
pool unsafe.Pointer
new func(pool unsafe.Pointer, t reflect.Type) reflect.Value
makeSlice func(pool unsafe.Pointer, t reflect.Type, len, cap int) reflect.Value
makeMap func(pool unsafe.Pointer, t reflect.Type, n int) reflect.Value
makeChan func(pool unsafe.Pointer, t reflect.Type, buffer int) reflect.Value
isScalar func(t reflect.Kind) bool
cachedStructTypes sync.Map
cachedPointerTypes sync.Map
cachedCustomFuncTypes sync.Map
}
// FromHeap creates an allocator which allocate memory from heap.
func FromHeap() *Allocator {
return NewAllocator(nil, nil)
}
// NewAllocator creates an allocator which allocate memory from the pool.
// Both pool and methods are optional.
//
// If methods.New is not nil, the allocator itself is created by calling methods.New.
//
// The pool is a pointer to the memory pool which is opaque to the allocator.
// It's methods's responsibility to allocate memory from the pool properly.
func NewAllocator(pool unsafe.Pointer, methods *AllocatorMethods) (allocator *Allocator) {
parent := methods.parent()
new := methods.new(parent, pool)
// Allocate the allocator from the pool.
val := new(pool, typeOfAllocator)
allocator = (*Allocator)(unsafe.Pointer(val.Pointer()))
runtime.KeepAlive(val)
allocator.pool = pool
allocator.new = new
allocator.makeSlice = methods.makeSlice(parent, pool)
allocator.makeMap = methods.makeMap(parent, pool)
allocator.makeChan = methods.makeChan(parent, pool)
allocator.isScalar = methods.isScalar(parent)
if parent == nil {
parent = defaultAllocator
}
allocator.parent = parent
return
}
// New returns a new zero value of t.
func (a *Allocator) New(t reflect.Type) reflect.Value {
return a.new(a.pool, t)
}
// MakeSlice creates a new zero-initialized slice value of t with len and cap.
func (a *Allocator) MakeSlice(t reflect.Type, len, cap int) reflect.Value {
return a.makeSlice(a.pool, t, len, cap)
}
// MakeMap creates a new map with minimum size n.
func (a *Allocator) MakeMap(t reflect.Type, n int) reflect.Value {
return a.makeMap(a.pool, t, n)
}
// MakeChan creates a new chan with buffer.
func (a *Allocator) MakeChan(t reflect.Type, buffer int) reflect.Value {
return a.makeChan(a.pool, t, buffer)
}
// Clone recursively deep clone val to a new value with memory allocated from a.
func (a *Allocator) Clone(val reflect.Value) reflect.Value {
return a.clone(val, true)
}
func (a *Allocator) clone(val reflect.Value, inCustomFunc bool) reflect.Value {
if !val.IsValid() {
return val
}
state := &cloneState{
allocator: a,
}
if inCustomFunc {
state.skipCustomFuncValue = val
}
return state.clone(val)
}
// CloneSlowly recursively deep clone val to a new value with memory allocated from a.
// It marks all cloned values internally, thus it can clone v with cycle pointer.
func (a *Allocator) CloneSlowly(val reflect.Value) reflect.Value {
return a.cloneSlowly(val, true)
}
func (a *Allocator) cloneSlowly(val reflect.Value, inCustomFunc bool) reflect.Value {
if !val.IsValid() {
return val
}
state := &cloneState{
allocator: a,
visited: visitMap{},
invalid: invalidPointers{},
}
if inCustomFunc {
state.skipCustomFuncValue = val
}
cloned := state.clone(val)
state.fix(cloned)
return cloned
}
func (a *Allocator) loadStructType(t reflect.Type) (st structType) {
st, ok := a.lookupStructType(t)
if ok {
return
}
num := t.NumField()
pointerFields := make([]structFieldType, 0, num)
// Find pointer fields in depth-first order.
for i := 0; i < num; i++ {
field := t.Field(i)
ft := field.Type
k := ft.Kind()
if a.isScalar(k) {
continue
}
switch k {
case reflect.Array:
if ft.Len() == 0 {
continue
}
elem := ft.Elem()
if a.isScalar(elem.Kind()) {
continue
}
if elem.Kind() == reflect.Struct {
if fst := a.loadStructType(elem); fst.CanShadowCopy() {
continue
}
}
case reflect.Struct:
if fst := a.loadStructType(ft); fst.CanShadowCopy() {
continue
}
}
pointerFields = append(pointerFields, structFieldType{
Offset: field.Offset,
Index: i,
})
}
if len(pointerFields) == 0 {
pointerFields = nil // Release memory ASAP.
}
st = structType{
PointerFields: pointerFields,
}
// Load custom function.
current := a
for current != nil {
if fn, ok := current.cachedCustomFuncTypes.Load(t); ok {
st.fn = fn.(Func)
break
}
current = current.parent
}
a.cachedStructTypes.LoadOrStore(t, st)
return
}
func (a *Allocator) lookupStructType(t reflect.Type) (st structType, ok bool) {
var v interface{}
current := a
for current != nil {
v, ok = current.cachedStructTypes.Load(t)
if ok {
st = v.(structType)
return
}
current = current.parent
}
return
}
func (a *Allocator) isOpaquePointer(t reflect.Type) (ok bool) {
current := a
for current != nil {
if _, ok = current.cachedPointerTypes.Load(t); ok {
return
}
current = current.parent
}
return
}
// MarkAsScalar marks t as a scalar type so that all clone methods will copy t by value.
// If t is not struct or pointer to struct, MarkAsScalar ignores t.
//
// In the most cases, it's not necessary to call it explicitly.
// If a struct type contains scalar type fields only, the struct will be marked as scalar automatically.
//
// Here is a list of types marked as scalar by default:
// - time.Time
// - reflect.Value
func (a *Allocator) MarkAsScalar(t reflect.Type) {
for t.Kind() == reflect.Ptr {
t = t.Elem()
}
if t.Kind() != reflect.Struct {
return
}
a.cachedStructTypes.Store(t, zeroStructType)
}
// MarkAsOpaquePointer marks t as an opaque pointer so that all clone methods will copy t by value.
// If t is not a pointer, MarkAsOpaquePointer ignores t.
//
// Here is a list of types marked as opaque pointers by default:
// - `elliptic.Curve`, which is `*elliptic.CurveParam` or `elliptic.p256Curve`;
// - `reflect.Type`, which is `*reflect.rtype` defined in `runtime`.
func (a *Allocator) MarkAsOpaquePointer(t reflect.Type) {
if t.Kind() != reflect.Ptr {
return
}
a.cachedPointerTypes.Store(t, struct{}{})
}
// SetCustomFunc sets a custom clone function for type t.
// If t is not struct or pointer to struct, SetCustomFunc ignores t.
//
// If fn is nil, remove the custom clone function for type t.
func (a *Allocator) SetCustomFunc(t reflect.Type, fn Func) {
if fn == nil {
a.cachedCustomFuncTypes.Delete(t)
return
}
for t.Kind() == reflect.Ptr {
t = t.Elem()
}
if t.Kind() != reflect.Struct {
return
}
a.cachedCustomFuncTypes.Store(t, fn)
}
func heapNew(pool unsafe.Pointer, t reflect.Type) reflect.Value {
return reflect.New(t)
}
func heapMakeSlice(pool unsafe.Pointer, t reflect.Type, len, cap int) reflect.Value {
return reflect.MakeSlice(t, len, cap)
}
func heapMakeMap(pool unsafe.Pointer, t reflect.Type, n int) reflect.Value {
return reflect.MakeMapWithSize(t, n)
}
func heapMakeChan(pool unsafe.Pointer, t reflect.Type, buffer int) reflect.Value {
return reflect.MakeChan(t, buffer)
}
|