/
memo_table.go
411 lines (357 loc) · 11.9 KB
/
memo_table.go
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package encoding
import (
"math"
"unsafe"
"github.com/apache/arrow/go/v9/arrow"
"github.com/apache/arrow/go/v9/arrow/array"
"github.com/apache/arrow/go/v9/arrow/memory"
"github.com/apache/arrow/go/v9/internal/hashing"
"github.com/apache/arrow/go/v9/parquet"
)
//go:generate go run ../../../arrow/_tools/tmpl/main.go -i -data=physical_types.tmpldata memo_table_types.gen.go.tmpl
// MemoTable interface that can be used to swap out implementations of the hash table
// used for handling dictionary encoding. Dictionary encoding is built against this interface
// to make it easy for code generation and changing implementations.
//
// Values should remember the order they are inserted to generate a valid dictionary index
type MemoTable interface {
// Reset drops everything in the table allowing it to be reused
Reset()
// Size returns the current number of unique values stored in the table
// including whether or not a null value has been passed in using GetOrInsertNull
Size() int
// CopyValues populates out with the values currently in the table, out must
// be a slice of the appropriate type for the table type.
CopyValues(out interface{})
// CopyValuesSubset is like CopyValues but only copies a subset of values starting
// at the indicated index.
CopyValuesSubset(start int, out interface{})
WriteOut(out []byte)
WriteOutSubset(start int, out []byte)
// Get returns the index of the table the specified value is, and a boolean indicating
// whether or not the value was found in the table. Will panic if val is not the appropriate
// type for the underlying table.
Get(val interface{}) (int, bool)
// GetOrInsert is the same as Get, except if the value is not currently in the table it will
// be inserted into the table.
GetOrInsert(val interface{}) (idx int, existed bool, err error)
// GetNull returns the index of the null value and whether or not it was found in the table
GetNull() (int, bool)
// GetOrInsertNull returns the index of the null value, if it didn't already exist in the table,
// it is inserted.
GetOrInsertNull() (idx int, existed bool)
}
type NumericMemoTable interface {
MemoTable
// WriteOutLE writes the contents of the memo table out to the byteslice
// but ensures the values are little-endian before writing them (converting
// if on a big endian system).
WriteOutLE(out []byte)
// WriteOutSubsetLE writes the contents of the memo table out to the byteslice
// starting with the index indicated by start, but ensures the values are little
// endian before writing them (converting if on a big-endian system).
WriteOutSubsetLE(start int, out []byte)
}
// BinaryMemoTable is an extension of the MemoTable interface adding extra methods
// for handling byte arrays/strings/fixed length byte arrays.
type BinaryMemoTable interface {
MemoTable
// ValuesSize returns the total number of bytes needed to copy all of the values
// from this table.
ValuesSize() int
// CopyOffsets populates out with the start and end offsets of each value in the
// table data. Out should be sized to Size()+1 to accomodate all of the offsets.
CopyOffsets(out []int32)
// CopyOffsetsSubset is like CopyOffsets but only gets a subset of the offsets
// starting at the specified index.
CopyOffsetsSubset(start int, out []int32)
// CopyFixedWidthValues exists to cope with the fact that the table doesn't track
// the fixed width when inserting the null value into the databuffer populating
// a zero length byte slice for the null value (if found).
CopyFixedWidthValues(start int, width int, out []byte)
// VisitValues calls visitFn on each value in the table starting with the index specified
VisitValues(start int, visitFn func([]byte))
// Retain increases the reference count of the separately stored binary data that is
// kept alongside the table which contains all of the values in the table. This is
// safe to call simultaneously across multiple goroutines.
Retain()
// Release decreases the reference count by 1 of the separately stored binary data
// kept alongside the table containing the values. When the reference count goes to
// 0, the memory is freed. This is safe to call across multiple goroutines simultaneoulsy.
Release()
}
// NewInt32Dictionary returns a memotable interface for use with Int32 values only
func NewInt32Dictionary() MemoTable {
return hashing.NewInt32MemoTable(0)
}
// NewInt64Dictionary returns a memotable interface for use with Int64 values only
func NewInt64Dictionary() MemoTable {
return hashing.NewInt64MemoTable(0)
}
// NewFloat32Dictionary returns a memotable interface for use with Float32 values only
func NewFloat32Dictionary() MemoTable {
return hashing.NewFloat32MemoTable(0)
}
// NewFloat64Dictionary returns a memotable interface for use with Float64 values only
func NewFloat64Dictionary() MemoTable {
return hashing.NewFloat64MemoTable(0)
}
// NewBinaryDictionary returns a memotable interface for use with strings, byte slices,
// parquet.ByteArray and parquet.FixedLengthByteArray only.
func NewBinaryDictionary(mem memory.Allocator) BinaryMemoTable {
return hashing.NewBinaryMemoTable(0, -1, array.NewBinaryBuilder(mem, arrow.BinaryTypes.Binary))
}
const keyNotFound = hashing.KeyNotFound
// standard map based implementation of a binary memotable which is only kept around
// currently to be used as a benchmark against the memotables in the internal/hashing
// module as a baseline comparison.
func NewBinaryMemoTable(mem memory.Allocator) BinaryMemoTable {
return &binaryMemoTableImpl{
table: make(map[string]int),
nullIndex: keyNotFound,
builder: array.NewBinaryBuilder(mem, arrow.BinaryTypes.Binary),
}
}
type binaryMemoTableImpl struct {
table map[string]int
builder *array.BinaryBuilder
nullIndex int
}
func (m *binaryMemoTableImpl) Reset() {
m.table = make(map[string]int)
m.nullIndex = keyNotFound
m.builder.NewArray().Release()
}
func (m *binaryMemoTableImpl) CopyValues(out interface{}) {
m.CopyValuesSubset(0, out)
}
func (m *binaryMemoTableImpl) GetNull() (int, bool) {
return m.nullIndex, m.nullIndex != keyNotFound
}
func (m *binaryMemoTableImpl) ValuesSize() int {
return m.builder.DataLen()
}
func (m *binaryMemoTableImpl) Size() int {
sz := len(m.table)
if _, ok := m.GetNull(); ok {
sz++
}
return sz
}
func (m *binaryMemoTableImpl) valAsString(val interface{}) string {
switch v := val.(type) {
case string:
return v
case []byte:
return *(*string)(unsafe.Pointer(&v))
case parquet.ByteArray:
return *(*string)(unsafe.Pointer(&v))
case parquet.FixedLenByteArray:
return *(*string)(unsafe.Pointer(&v))
default:
panic("invalid type for value in binarymemotable")
}
}
func (m *binaryMemoTableImpl) Get(val interface{}) (int, bool) {
key := m.valAsString(val)
if p, ok := m.table[key]; ok {
return p, true
}
return keyNotFound, false
}
func (m *binaryMemoTableImpl) GetOrInsert(val interface{}) (idx int, found bool, err error) {
key := m.valAsString(val)
idx, found = m.table[key]
if !found {
idx = m.Size()
m.builder.AppendString(key)
m.table[key] = idx
}
return
}
func (m *binaryMemoTableImpl) GetOrInsertNull() (idx int, found bool) {
idx, found = m.GetNull()
if !found {
idx = m.Size()
m.nullIndex = idx
m.builder.AppendNull()
}
return
}
func (m *binaryMemoTableImpl) findOffset(idx int) uintptr {
val := m.builder.Value(idx)
for len(val) == 0 {
idx++
if idx >= m.builder.Len() {
break
}
val = m.builder.Value(idx)
}
if len(val) != 0 {
return uintptr(unsafe.Pointer(&val[0]))
}
return uintptr(m.builder.DataLen()) + m.findOffset(0)
}
func (m *binaryMemoTableImpl) CopyValuesSubset(start int, out interface{}) {
var (
first = m.findOffset(0)
offset = m.findOffset(int(start))
length = m.builder.DataLen() - int(offset-first)
)
outval := out.([]byte)
copy(outval, m.builder.Value(start)[0:length])
}
func (m *binaryMemoTableImpl) WriteOut(out []byte) {
m.CopyValues(out)
}
func (m *binaryMemoTableImpl) WriteOutSubset(start int, out []byte) {
m.CopyValuesSubset(start, out)
}
func (m *binaryMemoTableImpl) CopyFixedWidthValues(start, width int, out []byte) {
}
func (m *binaryMemoTableImpl) CopyOffsetsSubset(start int, out []int32) {
if m.builder.Len() <= start {
return
}
first := m.findOffset(0)
delta := m.findOffset(start)
for i := start; i < m.Size(); i++ {
offset := int32(m.findOffset(i) - delta)
out[i-start] = offset
}
out[m.Size()-start] = int32(m.builder.DataLen() - int(delta) - int(first))
}
func (m *binaryMemoTableImpl) CopyOffsets(out []int32) {
m.CopyOffsetsSubset(0, out)
}
func (m *binaryMemoTableImpl) VisitValues(start int, visitFn func([]byte)) {
for i := int(start); i < m.Size(); i++ {
visitFn(m.builder.Value(i))
}
}
func (m *binaryMemoTableImpl) Release() {
m.builder.Release()
}
func (m *binaryMemoTableImpl) Retain() {
m.builder.Retain()
}
// standard map based implementation of a float64 memotable which is only kept around
// currently to be used as a benchmark against the memotables in the internal/hashing
// module as a baseline comparison.
func NewFloat64MemoTable(memory.Allocator) MemoTable {
return &float64MemoTableImpl{
table: make(map[float64]struct {
value float64
memoIndex int
}),
nullIndex: keyNotFound,
nanIndex: keyNotFound,
}
}
type float64MemoTableImpl struct {
table map[float64]struct {
value float64
memoIndex int
}
nullIndex int
nanIndex int
}
func (m *float64MemoTableImpl) Reset() {
m.table = make(map[float64]struct {
value float64
memoIndex int
})
m.nullIndex = keyNotFound
m.nanIndex = keyNotFound
}
func (m *float64MemoTableImpl) GetNull() (int, bool) {
return m.nullIndex, m.nullIndex != keyNotFound
}
func (m *float64MemoTableImpl) Size() int {
sz := len(m.table)
if _, ok := m.GetNull(); ok {
sz++
}
if m.nanIndex != keyNotFound {
sz++
}
return sz
}
func (m *float64MemoTableImpl) GetOrInsertNull() (idx int, found bool) {
idx, found = m.GetNull()
if !found {
idx = m.Size()
m.nullIndex = idx
}
return
}
func (m *float64MemoTableImpl) Get(val interface{}) (int, bool) {
v := val.(float64)
if p, ok := m.table[v]; ok {
return p.memoIndex, true
}
if math.IsNaN(v) && m.nanIndex != keyNotFound {
return m.nanIndex, true
}
return keyNotFound, false
}
func (m *float64MemoTableImpl) GetOrInsert(val interface{}) (idx int, found bool, err error) {
v := val.(float64)
if math.IsNaN(v) {
if m.nanIndex == keyNotFound {
idx = m.Size()
m.nanIndex = idx
} else {
idx = m.nanIndex
found = true
}
return
}
p, ok := m.table[v]
if ok {
idx = p.memoIndex
} else {
idx = m.Size()
p.value = v
p.memoIndex = idx
m.table[v] = p
found = true
}
return
}
func (m *float64MemoTableImpl) CopyValues(out interface{}) {
m.CopyValuesSubset(0, out)
}
func (m *float64MemoTableImpl) CopyValuesSubset(start int, out interface{}) {
outval := out.([]float64)
for _, v := range m.table {
idx := v.memoIndex - start
if idx >= 0 {
outval[idx] = v.value
}
}
if m.nanIndex != keyNotFound {
outval[m.nanIndex] = math.NaN()
}
}
func (m *float64MemoTableImpl) WriteOut(out []byte) {
m.CopyValuesSubset(0, arrow.Float64Traits.CastFromBytes(out))
}
func (m *float64MemoTableImpl) WriteOutSubset(start int, out []byte) {
m.CopyValuesSubset(start, arrow.Float64Traits.CastFromBytes(out))
}