forked from mediocregopher/radix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
action.go
524 lines (456 loc) · 13.3 KB
/
action.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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
package radix
import (
"bufio"
"bytes"
"crypto/sha1"
"encoding/hex"
"fmt"
"io"
"strconv"
"strings"
"sync"
"github.com/mediocregopher/radix/v3/resp"
"github.com/mediocregopher/radix/v3/resp/resp2"
)
// Action performs a task using a Conn.
type Action interface {
// Keys returns the keys which will be acted on. Empty slice or nil may be
// returned if no keys are being acted on. The returned slice must not be
// modified.
Keys() []string
// Run actually performs the Action using the given Conn.
Run(c Conn) error
}
// CmdAction is a sub-class of Action which can be used in two different ways.
// The first is as a normal Action, where Run is called with a Conn and returns
// once the Action has been completed.
//
// The second way is as a Pipeline-able command, where one or more commands are
// written in one step (via the MarshalRESP method) and their results are read
// later (via the UnmarshalRESP method).
//
// When used directly with Do then MarshalRESP/UnmarshalRESP are not called, and
// when used in a Pipeline the Run method is not called.
type CmdAction interface {
Action
resp.Marshaler
resp.Unmarshaler
}
var noKeyCmds = map[string]bool{
"SENTINEL": true,
"CLUSTER": true,
"READONLY": true,
"READWRITE": true,
"ASKING": true,
"AUTH": true,
"ECHO": true,
"PING": true,
"QUIT": true,
"SELECT": true,
"SWAPDB": true,
"KEYS": true,
"MIGRATE": true,
"OBJECT": true,
"RANDOMKEY": true,
"WAIT": true,
"SCAN": true,
"EVAL": true,
"EVALSHA": true,
"SCRIPT": true,
"BGREWRITEAOF": true,
"BGSAVE": true,
"CLIENT": true,
"COMMAND": true,
"CONFIG": true,
"DBSIZE": true,
"DEBUG": true,
"FLUSHALL": true,
"FLUSHDB": true,
"INFO": true,
"LASTSAVE": true,
"MONITOR": true,
"ROLE": true,
"SAVE": true,
"SHUTDOWN": true,
"SLAVEOF": true,
"SLOWLOG": true,
"SYNC": true,
"TIME": true,
"DISCARD": true,
"EXEC": true,
"MULTI": true,
"UNWATCH": true,
"WATCH": true,
}
func cmdString(m resp.Marshaler) string {
// we go way out of the way here to display the command as it would be sent
// to redis. This is pretty similar logic to what the stub does as well
buf := new(bytes.Buffer)
if err := m.MarshalRESP(buf); err != nil {
return fmt.Sprintf("error creating string: %q", err.Error())
}
var ss []string
err := resp2.RawMessage(buf.Bytes()).UnmarshalInto(resp2.Any{I: &ss})
if err != nil {
return fmt.Sprintf("error creating string: %q", err.Error())
}
for i := range ss {
ss[i] = strconv.QuoteToASCII(ss[i])
}
return "[" + strings.Join(ss, " ") + "]"
}
func marshalBulkString(prevErr error, w io.Writer, str string) error {
if prevErr != nil {
return prevErr
}
return resp2.BulkString{S: str}.MarshalRESP(w)
}
func marshalBulkStringBytes(prevErr error, w io.Writer, b []byte) error {
if prevErr != nil {
return prevErr
}
return resp2.BulkStringBytes{B: b}.MarshalRESP(w)
}
////////////////////////////////////////////////////////////////////////////////
type cmdAction struct {
rcv interface{}
cmd string
args []string
flat bool
flatKey [1]string // use array to avoid allocation in Keys
flatArgs []interface{}
}
// BREAM: Benchmarks Rule Everything Around Me
var cmdActionPool sync.Pool
func getCmdAction() *cmdAction {
if ci := cmdActionPool.Get(); ci != nil {
return ci.(*cmdAction)
}
return new(cmdAction)
}
// Cmd is used to perform a redis command and retrieve a result. It should not
// be passed into Do more than once.
//
// If the receiver value of Cmd is a primitive, a slice/map, or a struct then a
// pointer must be passed in. It may also be an io.Writer, an
// encoding.Text/BinaryUnmarshaler, or a resp.Unmarshaler. See the package docs
// for more on how results are unmarshaled into the receiver.
func Cmd(rcv interface{}, cmd string, args ...string) CmdAction {
c := getCmdAction()
*c = cmdAction{
rcv: rcv,
cmd: cmd,
args: args,
}
return c
}
// FlatCmd is like Cmd, but the arguments can be of almost any type, and FlatCmd
// will automatically flatten them into a single array of strings. Like Cmd, a
// FlatCmd should not be passed into Do more than once.
//
// FlatCmd does _not_ work for commands whose first parameter isn't a key, or
// (generally) for MSET. Use Cmd for those.
//
// FlatCmd supports using a resp.LenReader (an io.Reader with a Len() method) as
// an argument. *bytes.Buffer is an example of a LenReader, and the resp package
// has a NewLenReader function which can wrap an existing io.Reader.
//
// FlatCmd also supports encoding.Text/BinaryMarshalers. It does _not_ currently
// support resp.Marshaler.
//
// The receiver to FlatCmd follows the same rules as for Cmd.
func FlatCmd(rcv interface{}, cmd, key string, args ...interface{}) CmdAction {
c := getCmdAction()
*c = cmdAction{
rcv: rcv,
cmd: cmd,
flat: true,
flatKey: [1]string{key},
flatArgs: args,
}
return c
}
func findStreamsKeys(args []string) []string {
for i, arg := range args {
if strings.ToUpper(arg) != "STREAMS" {
continue
}
// after STREAMS only stream keys and IDs can be given and since there must be the same number of keys and ids
// we can just take half of remaining arguments as keys. If the number of IDs does not match the number of
// keys the command will fail later when send to Redis so no need for us to handle that case.
ids := len(args[i+1:]) / 2
return args[i+1 : len(args)-ids]
}
return nil
}
func (c *cmdAction) Keys() []string {
if c.flat {
return c.flatKey[:]
}
cmd := strings.ToUpper(c.cmd)
if cmd == "BITOP" && len(c.args) > 1 { // antirez why you do this
return c.args[1:]
} else if cmd == "XINFO" {
if len(c.args) < 2 {
return nil
}
return c.args[1:2]
} else if cmd == "XGROUP" && len(c.args) > 1 {
return c.args[1:2]
} else if cmd == "XREAD" || cmd == "XREADGROUP" { // antirez why you still do this
return findStreamsKeys(c.args)
} else if noKeyCmds[cmd] || len(c.args) == 0 {
return nil
}
return c.args[:1]
}
func (c *cmdAction) flatMarshalRESP(w io.Writer) error {
var err error
a := resp2.Any{
I: c.flatArgs,
MarshalBulkString: true,
MarshalNoArrayHeaders: true,
}
arrL := 2 + a.NumElems()
err = resp2.ArrayHeader{N: arrL}.MarshalRESP(w)
err = marshalBulkString(err, w, c.cmd)
err = marshalBulkString(err, w, c.flatKey[0])
if err != nil {
return err
}
return a.MarshalRESP(w)
}
func (c *cmdAction) MarshalRESP(w io.Writer) error {
if c.flat {
return c.flatMarshalRESP(w)
}
err := resp2.ArrayHeader{N: len(c.args) + 1}.MarshalRESP(w)
err = marshalBulkString(err, w, c.cmd)
for i := range c.args {
err = marshalBulkString(err, w, c.args[i])
}
return err
}
func (c *cmdAction) UnmarshalRESP(br *bufio.Reader) error {
if err := (resp2.Any{I: c.rcv}).UnmarshalRESP(br); err != nil {
return err
}
cmdActionPool.Put(c)
return nil
}
func (c *cmdAction) Run(conn Conn) error {
if err := conn.Encode(c); err != nil {
return err
}
return conn.Decode(c)
}
func (c *cmdAction) String() string {
return cmdString(c)
}
func (c *cmdAction) ClusterCanRetry() bool {
return true
}
////////////////////////////////////////////////////////////////////////////////
// MaybeNil is a type which wraps a receiver. It will first detect if what's
// being received is a nil RESP type (either bulk string or array), and if so
// set Nil to true. If not the return value will be unmarshaled into Rcv
// normally.
type MaybeNil struct {
Nil bool
Rcv interface{}
}
// UnmarshalRESP implements the method for the resp.Unmarshaler interface.
func (mn *MaybeNil) UnmarshalRESP(br *bufio.Reader) error {
var rm resp2.RawMessage
if err := rm.UnmarshalRESP(br); err != nil {
return err
} else if rm.IsNil() {
mn.Nil = true
return nil
}
return rm.UnmarshalInto(resp2.Any{I: mn.Rcv})
}
////////////////////////////////////////////////////////////////////////////////
// EvalScript contains the body of a script to be used with redis' EVAL
// functionality. Call Cmd on a EvalScript to actually create an Action which
// can be run.
type EvalScript struct {
script, sum string
numKeys int
}
// NewEvalScript initializes a EvalScript instance. numKeys corresponds to the
// number of arguments which will be keys when Cmd is called
func NewEvalScript(numKeys int, script string) EvalScript {
sumRaw := sha1.Sum([]byte(script))
sum := hex.EncodeToString(sumRaw[:])
return EvalScript{
script: script,
sum: sum,
numKeys: numKeys,
}
}
var (
evalsha = []byte("EVALSHA")
eval = []byte("EVAL")
)
type evalAction struct {
EvalScript
args []string
rcv interface{}
eval bool
}
// Cmd is like the top-level Cmd but it uses the the EvalScript to perform an
// EVALSHA command (and will automatically fallback to EVAL as necessary). args
// must be at least as long as the numKeys argument of NewEvalScript.
func (es EvalScript) Cmd(rcv interface{}, args ...string) Action {
if len(args) < es.numKeys {
panic("not enough arguments passed into EvalScript.Cmd")
}
return &evalAction{
EvalScript: es,
args: args,
rcv: rcv,
}
}
func (ec *evalAction) Keys() []string {
return ec.args[:ec.numKeys]
}
func (ec *evalAction) MarshalRESP(w io.Writer) error {
// EVAL(SHA) script/sum numkeys args...
if err := (resp2.ArrayHeader{N: 3 + len(ec.args)}).MarshalRESP(w); err != nil {
return err
}
var err error
if ec.eval {
err = marshalBulkStringBytes(err, w, eval)
err = marshalBulkString(err, w, ec.script)
} else {
err = marshalBulkStringBytes(err, w, evalsha)
err = marshalBulkString(err, w, ec.sum)
}
err = marshalBulkString(err, w, strconv.Itoa(ec.numKeys))
for i := range ec.args {
err = marshalBulkString(err, w, ec.args[i])
}
return err
}
func (ec *evalAction) Run(conn Conn) error {
run := func(eval bool) error {
ec.eval = eval
if err := conn.Encode(ec); err != nil {
return err
}
return conn.Decode(resp2.Any{I: ec.rcv})
}
err := run(false)
if err != nil && strings.HasPrefix(err.Error(), "NOSCRIPT") {
err = run(true)
}
return err
}
func (ec *evalAction) ClusterCanRetry() bool {
return true
}
////////////////////////////////////////////////////////////////////////////////
type pipeline []CmdAction
// Pipeline returns an Action which first writes multiple commands to a Conn in
// a single write, then reads their responses in a single read. This reduces
// network delay into a single round-trip.
//
// Run will not be called on any of the passed in CmdActions.
//
// NOTE that, while a Pipeline performs all commands on a single Conn, it
// shouldn't be used by itself for MULTI/EXEC transactions, because if there's
// an error it won't discard the incomplete transaction. Use WithConn or
// EvalScript for transactional functionality instead.
func Pipeline(cmds ...CmdAction) Action {
return pipeline(cmds)
}
func (p pipeline) Keys() []string {
m := map[string]bool{}
for _, rc := range p {
for _, k := range rc.Keys() {
m[k] = true
}
}
keys := make([]string, 0, len(m))
for k := range m {
keys = append(keys, k)
}
return keys
}
func (p pipeline) Run(c Conn) error {
if err := c.Encode(p); err != nil {
return err
}
for i, cmd := range p {
if err := c.Decode(cmd); err != nil {
p.drain(c, len(p)-i-1)
return decodeErr(cmd, err)
}
}
return nil
}
func (p pipeline) drain(c Conn, n int) {
rcv := resp2.Any{I: nil}
for i := 0; i < n; i++ {
_ = c.Decode(&rcv)
}
}
func decodeErr(cmd CmdAction, err error) error {
c, ok := cmd.(*cmdAction)
if ok {
return fmt.Errorf(
"failed to decode pipeline CmdAction '%v' with keys %v: %v",
c.cmd,
c.Keys(),
err)
}
return fmt.Errorf(
"failed to decode pipeline CmdAction '%v': %v",
cmd,
err)
}
// MarshalRESP implements the resp.Marshaler interface, so that the pipeline can
// pass itself to the Conn.Encode method instead of calling Conn.Encode for each
// CmdAction in the pipeline.
//
// This helps with Conn implementations that flush their underlying buffers
// after each call to Encode, like the default default Conn implementation
// (connWrap) does, making better use of internal buffering and automatic
// flushing as well as reducing the number of syscalls that both the client and
// Redis need to do.
//
// Without this, using the default Conn implementation, big pipelines can easily
// spend much of their time just in flushing (in one case measured, up to 40%).
func (p pipeline) MarshalRESP(w io.Writer) error {
for _, cmd := range p {
if err := cmd.MarshalRESP(w); err != nil {
return err
}
}
return nil
}
////////////////////////////////////////////////////////////////////////////////
type withConn struct {
key [1]string // use array to avoid allocation in Keys
fn func(Conn) error
}
// WithConn is used to perform a set of independent Actions on the same Conn.
// key should be a key which one or more of the inner Actions is acting on, or
// "" if no keys are being acted on. The callback function is what should
// actually carry out the inner actions, and the error it returns will be
// passed back up immediately.
//
// NOTE that WithConn only ensures all inner Actions are performed on the same
// Conn, it doesn't make them transactional. Use MULTI/WATCH/EXEC within a
// WithConn for transactions, or use EvalScript
func WithConn(key string, fn func(Conn) error) Action {
return &withConn{[1]string{key}, fn}
}
func (wc *withConn) Keys() []string {
return wc.key[:]
}
func (wc *withConn) Run(c Conn) error {
return wc.fn(c)
}