forked from mccoy/medici
-
Notifications
You must be signed in to change notification settings - Fork 4
/
principe.erl
1054 lines (974 loc) · 35.8 KB
/
principe.erl
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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%%% The contents of this file are subject to the Erlang Public License,
%%% Version 1.1, (the "License"); you may not use this file except in
%%% compliance with the License. You should have received a copy of the
%%% Erlang Public License along with this software. If not, it can be
%%% retrieved via the world wide web at http://www.erlang.org/.
%%%
%%% Software distributed under the License is distributed on an "AS IS"
%%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%%% the License for the specific language governing rights and limitations
%%% under the License.
%%%-------------------------------------------------------------------
%%% File: principe.erl
%%% @author Jim McCoy <mccoy@mad-scientist.com>
%%% @copyright Copyright (c) 2009, Jim McCoy. All Rights Reserved.
%%%
%%% @doc
%%% A thin Erlang wrapper for the Tokyo Tyrant network database protocol.
%%% Requires a Tyrant server that uses the 0.91 protocol version (Tyrant
%%% servers of version 1.1.23 and beyond.)
%%%
%%% Note: The Tyrant protocol is sensitive to endianness. Specifically, while
%%% the server will take in data in network-order it will store it internally
%%% in big or little endianness depending on the architecture that the Tyrant
%%% server is running on. For many use-cases this is not a problem, but if you
%%% plan on storing an int or float and then operating on it using the addint,
%%% adddouble, or script extension functions which may just grab the internal
%%% data directly then it is necessary to store numbers in the proper format for
%%% the remote database. In these cases use the put* and adddouble functions which
%%% take an additional parameter to specify endianness of the remote database.
%%% There are also versions of the misc() and misc_no_update() functions that
%%% specify remote database byte-order for proper encoding of integers and floats
%%% in those functions.
%%% @end
%%%-------------------------------------------------------------------
-module(principe).
-export([connect/0,
connect/1,
put/3,
put/4,
putkeep/3,
putkeep/4,
putcat/3,
putcat/4,
putshl/4,
putshl/5,
putnr/3,
putnr/4,
out/2,
get/2,
mget/2,
vsiz/2,
iterinit/1,
iternext/1,
fwmkeys/3,
addint/3,
adddouble/3,
adddouble/4,
adddouble/5,
sync/1,
optimize/2,
vanish/1,
rnum/1,
size/1,
stat/1,
copy/2,
restore/3,
restore_with_check/3,
setmst/3,
misc/3,
misc/4,
misc_no_update/3,
misc_no_update/4,
ext/5]).
-include("principe.hrl").
%%====================================================================
%% The Tokyo Tyrant access functions
%%====================================================================
%% @spec connect() -> {ok, port()} | error()
%%
%% @doc
%% Establish a connection to the tyrant service.
%% @end
connect() ->
connect([]).
%% @spec connect(ConnectProps::proplist()) -> {ok, port()} | error()
%%
%% @doc
%% Establish a connection to the tyrant service using properties in the
%% ConnectProps proplist to determine the hostname, port number and tcp
%% socket options for the connection. Any missing parameters are filled
%% in using the module defaults.
%% @end
connect(ConnectProps) ->
Hostname = proplists:get_value(hostname, ConnectProps, ?TSERVER),
Port = proplists:get_value(port, ConnectProps, ?TPORT),
Opts = proplists:get_value(connect_opts, ConnectProps),
case Opts of
undefined ->
gen_tcp:connect(Hostname, Port, ?TOPTS);
_ ->
gen_tcp:connect(Hostname, Port, Opts)
end.
%% @spec put(Socket::port(),
%% Key::key(),
%% Value::value_or_num()) -> ok | error()
%%
%% @doc
%% Call the Tyrant server to store a new value for the given key.
%% @end
put(Socket, Key, Value) when is_integer(Value), Value < 4294967296 ->
put(Socket, Key, <<Value:32>>);
put(Socket, Key, Value) when is_float(Value) ->
put(Socket, Key, <<Value:64/float>>);
put(Socket, Key, Value) ->
?T2(?PUT),
?R_SUCCESS.
%% @spec put(Socket::port(),
%% Key::key(),
%% Value::value_or_num(),
%% endian()) -> ok | error()
%%
%% @doc
%% Call the Tyrant server to store a new value for the given key, the
%% fourth parameter determines how integer and float values are stored
%% on the remote database.
%% @end
put(Socket, Key, Value, big) ->
put(Socket, Key, Value);
put(Socket, Key, Value, little) when is_integer(Value) ->
put(Socket, Key, <<Value:32/little>>);
put(Socket, Key, Value, little) when is_float(Value) ->
put(Socket, Key, <<Value:64/little-float>>);
put(Socket, Key, Value, little) ->
put(Socket, Key, Value).
%% @spec putkeep(Socket::port(),
%% Key::key(),
%% Value::value_or_num()) -> ok | error()
%%
%% @doc
%% Call the Tyrant server to put a new key/value pair into the remote
%% database. Will return an error if there is already a value for the
%% Key provided.
%% @end
putkeep(Socket, Key, Value) when is_integer(Value), Value < 4294967296 ->
putkeep(Socket, Key, <<Value:32>>);
putkeep(Socket, Key, Value) when is_float(Value) ->
putkeep(Socket, Key, <<Value:64/float>>);
putkeep(Socket, Key, Value) ->
?T2(?PUTKEEP),
?R_SUCCESS.
%% @spec putkeep(Socket::port(),
%% Key::key(),
%% Value::value_or_num()
%% endian()) -> ok | error()
%%
%% @doc
%% Call the Tyrant server to put a new key/value pair into the remote
%% database. Will return an error if there is already a value for the
%% Key provided. The fourth parameter determines endianness for encoding
%% numbers on the remote database.
%% @end
putkeep(Socket, Key, Value, big) ->
putkeep(Socket, Key, Value);
putkeep(Socket, Key, Value, little) when is_integer(Value), Value < 4294967296 ->
putkeep(Socket, Key, <<Value:32/little>>);
putkeep(Socket, Key, Value, little) when is_float(Value) ->
putkeep(Socket, Key, <<Value:64/little-float>>);
putkeep(Socket, Key, Value, little) ->
putkeep(Socket, Key, Value).
%% @spec putcat(Socket::port(),
%% Key::key(),
%% Value::value_or_num()) -> ok | error()
%%
%% @doc
%% Concatenate a value to the end of the current value for a given key
%% that is stored in the remote database. If Key does not already
%% exist in the database then this call will operate the same as put().
%% @end
putcat(Socket, Key, Value) when is_integer(Value), Value < 4294967296 ->
putcat(Socket, Key, <<Value:32>>);
putcat(Socket, Key, Value) when is_float(Value) ->
putcat(Socket, Key, <<Value:64/float>>);
putcat(Socket, Key, Value) ->
?T2(?PUTCAT),
?R_SUCCESS.
%% @spec putcat(Socket::port(),
%% Key::key(),
%% Value::value_or_num(),
%% endian()) -> ok | error()
%%
%% @doc
%% Concatenate a value to the end of the current value for a given key
%% that is stored in the remote database. If Key does not already
%% exist in the database then this call will operate the same as put().
%% The last parameter determines endian encoding on the remote database.
%% @end
putcat(Socket, Key, Value, big) ->
putcat(Socket, Key, Value);
putcat(Socket, Key, Value, little) when is_integer(Value), Value < 4294967296 ->
putcat(Socket, Key, <<Value:32/little>>);
putcat(Socket, Key, Value, little) when is_float(Value) ->
putcat(Socket, Key, <<Value:64/little-float>>);
putcat(Socket, Key, Value, little) ->
putcat(Socket, Key, Value).
%% @spec putshl(Socket::port(),
%% Key::key(),
%% Value::value_or_num(),
%% Width::integer()) -> ok | error()
%%
%% @doc
%% Concatenate a value to a given key in the remote database and shift the
%% resulting value to the left until it is Width bytes long.
%% @end
putshl(Socket, Key, Value, Width) when is_integer(Value), Value < 4294967296 ->
putshl(Socket, Key, <<Value:32>>, Width);
putshl(Socket, Key, Value, Width) when is_float(Value) ->
putshl(Socket, Key, <<Value:64/float>>, Width);
putshl(Socket, Key, Value, Width) when is_integer(Width) ->
gen_tcp:send(Socket, [<<?PUTSHL:16>>,
<<(iolist_size(Key)):32>>,
<<(iolist_size(Value)):32>>,
<<Width:32>>, Key, Value]),
?R_SUCCESS.
%% @spec putshl(Socket::port(),
%% Key::key(),
%% Value::value_or_num(),
%% Width::integer(),
%% endian()) -> ok | error()
%%
%% @doc
%% Concatenate a value to a given key in the remote database and shift the
%% resulting value to the left until it is Width bytes long. The last
%% parameter determines byte-order encoding for the remote database.
%% @end
putshl(Socket, Key, Value, Width, big) ->
putshl(Socket, Key, Value, Width);
putshl(Socket, Key, Value, Width, little) when is_integer(Value), Value < 4294967296 ->
putshl(Socket, Key, <<Value:32/little>>, Width);
putshl(Socket, Key, Value, Width, little) when is_float(Value) ->
putshl(Socket, Key, <<Value:64/little-float>>, Width);
putshl(Socket, Key, Value, Width, little) ->
putshl(Socket, Key, Value, Width).
%% @spec putnr(Socket::port(),
%% Key::key(),
%% Value::value_or_num()) -> ok
%%
%% @doc
%% Put a key/value pair to the remote database and do not wait for a response.
%% @end
putnr(Socket, Key, Value) when is_integer(Value), Value < 4294967296 ->
putnr(Socket, Key, <<Value:32>>);
putnr(Socket, Key, Value) when is_float(Value) ->
putnr(Socket, Key, <<Value:64/float>>);
putnr(Socket, Key, Value) ->
?T2(?PUTNR),
ok.
%% @spec putnr(Socket::port(),
%% Key::key(),
%% Value::value_or_num(),
%% endian()) -> ok
%%
%% @doc
%% Put a key/value pair to the remote database and do not wait for a response.
%% The fourth parameter will decide how numbers are encoded for the remote
%% database.
%% @end
putnr(Socket, Key, Value, big) ->
putnr(Socket, Key, Value);
putnr(Socket, Key, Value, little) when is_integer(Value), Value < 4294967296 ->
putnr(Socket, Key, <<Value:32/little>>);
putnr(Socket, Key, Value, little) when is_float(Value) ->
putnr(Socket, Key, <<Value:64/little-float>>);
putnr(Socket, Key, Value, little) ->
putnr(Socket, Key, Value).
%% @spec out(Socket::port(),
%% Key::key()) -> ok | error()
%%
%% @doc
%% Remove a key from the remote database. Will return an error if Key is
%% not in the database.
%% @end
out(Socket, Key) ->
?T1(?OUT),
?R_SUCCESS.
%% @spec get(Socket::port(),
%% Key::key()) -> binary() | error()
%%
%% @doc Get the value for a given key
get(Socket, Key) ->
?T1(?GET),
?R_SIZE_DATA.
%% @spec mget(Socket::port(),
%% KeyList::keylist()) -> [{Key::binary(), Value::binary()}] | error()
%%
%% @doc Get the values for a list of keys
mget(Socket, KeyList) when is_list(KeyList) ->
gen_tcp:send(Socket, [<<?MGET:16>>,
<<(length(KeyList)):32>>,
[[<<(iolist_size(Key)):32>>, Key] || Key <- KeyList]
]),
?R_4TUPLE.
%% @spec vsiz(Socket::port(),
%% Key::key()) -> integer()
%%
%% @doc Get the size of the value for a given key.
vsiz(Socket, Key) ->
?T1(?VSIZ),
?R_INT32.
%% @spec iterinit(Socket::port()) -> ok | error()
%%
%% @doc Start iteration protocol. WARNING: The tyrant iteration protocol has no
%% concurrency controls whatsoever, so if multiple clients try to do iteration
%% they will stomp all over each other!
%% @end
iterinit(Socket) ->
?T0(?ITERINIT),
?R_SUCCESS.
%% @spec iternext(Socket::port()) -> Key::binary() | error()
%%
%% @doc Get the next key/value pair in the iteration protocol
iternext(Socket) ->
?T0(?ITERNEXT),
?R_SIZE_DATA.
%% @spec fwmkeys(Socket::port(),
%% Prefix::iolist(),
%% MaxKeys::integer()) -> [binary()]
%%
%% @doc Return a number of keys that match a given prefix.
fwmkeys(Socket, Prefix, MaxKeys) when is_integer(MaxKeys) ->
gen_tcp:send(Socket, [<<?FWMKEYS:16>>,
<<(iolist_size(Prefix)):32>>,
<<MaxKeys:32>>, Prefix]),
?R_2TUPLE.
%% @spec addint(Socket::port(),
%% Key::key(),
%% Int::integer()) -> integer() | error()
%%
%% @doc Add an integer value to the existing value of a key, returns new value
addint(Socket, Key, Int) when is_integer(Int) ->
gen_tcp:send(Socket, [<<?ADDINT:16>>, <<(iolist_size(Key)):32>>, <<Int:32>>, Key]),
?R_INT32.
%% @spec adddouble(Socket::port(),
%% Key::key(),
%% Double::float()) -> {Integral::integer(), Fractional::integer()} | error()
%%
%% @doc Add a float to the existing value of a key, returns new value.
adddouble(Socket, Key, Double) when is_float(Double) ->
IntPart = trunc(Double),
FracPart = trunc((Double - IntPart) * 1.0e12),
gen_tcp:send(Socket, [<<?ADDDOUBLE:16>>,
<<(iolist_size(Key)):32>>,
<<IntPart:64>>,
<<FracPart:64>>,
Key]),
?R_SIZE64_SIZE64.
%% @spec adddouble(Socket::port(),
%% Key::key(),
%% Double::float() | IntPart::integer(),
%% endian() | FracPart::integer()) -> {Integral::integer(), Fractional::integer()} | error()
%%
%% @doc
%% Add a float to the existing value of a key, returns new value. The byte-order
%% of the remote database is specified by the last parameter.
%% @end
adddouble(Socket, Key, Double, big) ->
adddouble(Socket, Key, Double);
adddouble(Socket, Key, Double, little) when is_float(Double) ->
IntPart = trunc(Double),
FracPart = trunc((Double - IntPart) * 1.0e12),
gen_tcp:send(Socket, [<<?ADDDOUBLE:16>>,
<<(iolist_size(Key)):32>>,
<<IntPart:64/little>>,
<<FracPart:64/little>>,
Key]),
?R_SIZE64_SIZE64;
%% Need to stuff this one in here because the arity is 4
adddouble(Socket, Key, IntPart, FracPart) when is_integer(IntPart), is_integer(FracPart) ->
gen_tcp:send(Socket, [<<?ADDDOUBLE:16>>,
<<(iolist_size(Key)):32>>,
<<IntPart:64>>,
<<FracPart:64>>,
Key]),
?R_SIZE64_SIZE64.
%% @spec adddouble(Socket::port(),
%% Key::key(),
%% Integral::integer(),
%% Fractional::integer(),
%% endian()) -> {Integral::integer(), Fractional::integer()} | error()
%%
%% @doc
%% The raw adddouble function for those who need a bit more control on float adds
%% The last parameter determines remote database byte-order.
%% @end
adddouble(Socket, Key, IntPart, FracPart, little) when is_integer(IntPart), is_integer(FracPart) ->
gen_tcp:send(Socket, [<<?ADDDOUBLE:16>>,
<<(iolist_size(Key)):32>>,
<<IntPart:64/little>>,
<<FracPart:64/little>>,
Key]),
?R_SIZE64_SIZE64;
adddouble(Socket, Key, IntPart, FracPart, big) when is_integer(IntPart), is_integer(FracPart) ->
gen_tcp:send(Socket, [<<?ADDDOUBLE:16>>,
<<(iolist_size(Key)):32>>,
<<IntPart:64>>,
<<FracPart:64>>,
Key]),
?R_SIZE64_SIZE64.
%% @spec sync(Socket::port()) -> ok | error()
%%
%% @doc Call sync() on the remote database
sync(Socket) ->
?T0(?SYNC),
?R_SUCCESS.
%% @spec vanish(Socket::port()) -> ok | error()
%%
%% @doc Remove all records from the remote database.
vanish(Socket) ->
?T0(?VANISH),
?R_SUCCESS.
%% @spec optimize(Socket::port(),
%% iolist()) -> ok | error()
%%
%% @doc Change the remote database tuning parameters. The second parameter
%% should be a list of the database tuning parameters that will be applied
%% at the remote end (e.g. "#bnum=1000000#opts=ld").
%% @end
optimize(Socket, Key) ->
?T1(?OPTIMIZE), % Using 'Key' so that the macro binds properly...
?R_SUCCESS.
%% @spec rnum(Socket::port()) -> integer() | error()
%%
%% @doc Get the number of records in the remote database.
rnum(Socket) ->
?T0(?RNUM),
?R_INT64.
%% @spec size(Socket::port()) -> integer() | error()
%%
%% @doc Get the size in bytes of the remote database.
size(Socket) ->
?T0(?SIZE),
?R_INT64.
%% @spec stat(Socket::port()) -> proplist() | error()
%%
%% @doc Get the status string of a remote database.
stat(Socket) ->
?T0(?STAT),
StatString = ?R_SIZE_DATA,
case StatString of
{error, Reason} ->
{error, Reason};
GoodStat ->
stat_to_proplist(GoodStat)
end.
stat_to_proplist(StatBin) ->
stat_to_proplist(string:tokens(binary_to_list(StatBin), "\n\t"), []).
stat_to_proplist([], Acc) ->
Acc;
stat_to_proplist([H1, H2 | T], Acc) ->
stat_to_proplist(T, [{list_to_atom(H1), H2} | Acc]).
%% @spec copy(Socket::port(),
%% iolist()) -> ok | error()
%%
%% @doc Make a copy of the database file of the remote database.
copy(Socket, Key) when is_binary(Key) ->
?T1(?COPY), % Using 'Key' so that the macro binds properly...
?R_SUCCESS.
%% @spec restore(Socket::port(),
%% PathName::iolist(),
%% TimeStamp::integer,
%% Options::) -> ok | error()
%%
%% @doc Restore the database to a particular point in time from the update log.
restore(Socket, PathName, TimeStamp) ->
gen_tcp:send(Socket, [<<?RESTORE:16>>,
<<(iolist_size(PathName)):32>>,
<<TimeStamp:64>>,
<<0:32>>,
PathName]),
?R_SUCCESS.
%% @spec restore_with_check(Socket::port(),
%% PathName::iolist(),
%% TimeStamp::integer) -> ok | error()
%%
%% @doc Restore the database to a particular point in time from the update log and
%% perform a consistency check
%% @end
restore_with_check(Socket, PathName, TimeStamp) ->
gen_tcp:send(Socket, [<<?RESTORE:16>>,
<<(iolist_size(PathName)):32>>,
<<TimeStamp:64>>,
<<1:32>>,
PathName]),
?R_SUCCESS.
%% @spec setmst(Socket::port(),
%% HostName::iolist(),
%% Port::integer) -> ok | error()
%%
%% @doc Set the replication master of a remote database server.
setmst(Socket, HostName, Port) when is_integer(Port) ->
gen_tcp:send(Socket, [<<?SETMST:16>>,
<<(iolist_size(HostName)):32>>,
<<Port:32>>, HostName]),
?R_SUCCESS.
%% @spec repl(Socket::port(),
%% TimeStamp::integer(),
%% Sid::integer())
%%
%% @doc Initiate master->slave replication to the server id provided starting at a
%% given timestamp.
%% repl(Socket, TimeStamp, Sid) ->
%% gen_tcp:send(Socket, [<<?SETMST:16>>,
%% <<TimeStamp:64>>,
%% <<Sid:32>>]),
%% ?R_SUCCESS.
%% @spec misc(Socket::port(),
%% Func::iolist(),
%% Args::arglist()) -> [binary()] | error()
%% @type arglist() = [iolist()]
%%
%% @doc
%% Tyrant misc() call that writes to the update logs
%% All database types support putlist, outlist, and getlist.
%% putlist -> store records, Args is list of sequential keys and values, returns []
%% outlist -> remove records, Args is list of keys, returns []
%% getlist -> retrieve records, args is list of keys, returns list of values
%% Table database supports setindex, search, and genuid.
%% setindex -> set the column index, Arg is name of col and type of col data, returns success val
%% search -> run a search on the columns, returns list of values
%% genuid -> generate unique ID number, returns integer
%% @end
misc(Socket, Func, Args) when length(Args) > 0 ->
gen_tcp:send(Socket, [<<?MISC:16>>,
<<(iolist_size(Func)):32>>, <<0:32>>,
<<(length(Args)):32>>,
Func,
misc_arg_encode(big, Args)
]),
?R_2TUPLE;
misc(Socket, Func, _Args) ->
gen_tcp:send(Socket, [<<?MISC:16>>,
<<(iolist_size(Func)):32>>, <<0:32>>,
<<0:32>>,
Func]),
?R_2TUPLE.
%% @spec misc(Socket::port(),
%% Func::iolist(),
%% Args::arglist(),
%% endian()) -> [binary()] | error()
%% @type arglist() = [iolist()]
%%
%% @doc
%% Tyrant misc() call that writes to the update logs with a specific
%% byte-order for encoding
%% All database types support putlist, outlist, and getlist.
%% putlist -> store records, Args is list of sequential keys and values, returns []
%% outlist -> remove records, Args is list of keys, returns []
%% getlist -> retrieve records, args is list of keys, returns list of values
%% Table database supports setindex, search, and genuid.
%% setindex -> set the column index, Arg is name of col and type of col data, returns success val
%% search -> run a search on the columns, returns list of values
%% genuid -> generate unique ID number, returns integer
%% @end
misc(Socket, Func, Args, big) ->
misc(Socket, Func, Args);
misc(Socket, Func, Args, little) when length(Args) > 0 ->
gen_tcp:send(Socket, [<<?MISC:16>>,
<<(iolist_size(Func)):32>>, <<0:32>>,
<<(length(Args)):32>>,
Func,
misc_arg_encode(little, Args)
]),
?R_2TUPLE;
misc(Socket, Func, Args, _Endian) ->
misc(Socket, Func, Args).
%% @spec misc_no_update(Socket::port(),
%% Func::iolist(),
%% Args::arglist()) -> [binary()] | error()
%% @type arglist() = [iolist()]
%%
%% @doc Tyrant misc() call that does not write to the update logs
misc_no_update(Socket, Func, Args) when length(Args) > 0 ->
gen_tcp:send(Socket, [<<?MISC:16>>,
<<(iolist_size(Func)):32>>, <<1:32>>,
<<(length(Args)):32>>,
Func,
misc_arg_encode(big, Args)
]),
?R_2TUPLE;
misc_no_update(Socket, Func, _Args) ->
gen_tcp:send(Socket, [<<?MISC:16>>,
<<(iolist_size(Func)):32>>, <<1:32>>,
<<0:32>>,
Func]),
?R_2TUPLE.
%% @spec misc_no_update(Socket::port(),
%% Func::iolist(),
%% Args::arglist(),
%% endian()) -> [binary()] | error()
%% @type arglist() = [iolist()]
%%
%% @doc Tyrant misc() call that does not write to the update logs.
misc_no_update(Socket, Func, Args, big) ->
misc_no_update(Socket, Func, Args);
misc_no_update(Socket, Func, Args, little) when length(Args) > 0 ->
gen_tcp:send(Socket, [<<?MISC:16>>,
<<(iolist_size(Func)):32>>, <<1:32>>,
<<(length(Args)):32>>,
Func,
misc_arg_encode(little, Args)
]),
?R_2TUPLE;
misc_no_update(Socket, Func, Args, little) ->
misc_no_update(Socket, Func, Args).
%% Encoding helper for misc() that tries to keep integers in the
%% proper form for the remote database.
misc_arg_encode(Endian, ArgList) ->
misc_arg_encode(Endian, ArgList, []).
misc_arg_encode(_Endian, [], ArgList) ->
lists:reverse(ArgList);
misc_arg_encode(big, [Arg | Tail], ArgList) when is_integer(Arg), Arg < 4294967296 ->
misc_arg_encode(big, Tail, [[<<4:32>>, <<Arg:32>>] | ArgList]);
misc_arg_encode(little, [Arg | Tail], ArgList) when is_integer(Arg), Arg < 4294967296 ->
misc_arg_encode(little, Tail, [[<<4:32>>, <<Arg:32/little>>] | ArgList]);
misc_arg_encode(big, [Arg | Tail], ArgList) when is_float(Arg) ->
misc_arg_encode(big, Tail, [[<<8:32>>, <<Arg:64/float>>] | ArgList]);
misc_arg_encode(little, [Arg | Tail], ArgList) when is_float(Arg) ->
misc_arg_encode(little, Tail, [[<<8:32>>, <<Arg:64/float-little>>] | ArgList]);
misc_arg_encode(Endian, [Arg | Tail], ArgList) ->
misc_arg_encode(Endian, Tail, [[<<(iolist_size(Arg)):32>>, Arg] | ArgList]).
%% @spec ext(Socket::port(),
%% Func::iolist(),
%% Opts::proplist(),
%% Key::iolist(),
%% Value::iolist()) -> ok | error()
%%
%% @doc Call a function defined by the Tyrant script language extensions.
ext(Socket, Func, Opts, Key, Value) ->
%% TODO: Opts needs to be parsed. Probably as a proplist [record_lock, global_lock, neither...]
gen_tcp:send(Socket, [<<?EXT:16>>, <<(iolist_size(Func)):32>>, <<Opts:32>>,
<<(iolist_size(Key)):32>>, <<(iolist_size(Value)):32>>,
Func, Key, Value]),
?R_SIZE_DATA.
%%====================================================================
%% Handle response from the server
%%====================================================================
%% @spec (ResponseHandler::function()) -> ok | error() | term()
%%
%% @private Get the response from a Tyrant request, parse it, and return the
%% data or error code.
%% @end
tyrant_response(ResponseHandler) ->
receive
{tcp, _, <<1:8, _Rest/binary>>} ->
{error, invalid_operation};
{tcp, _, <<2:8, _Rest/binary>>} ->
{error, no_host_found};
{tcp, _, <<3:8, _Rest/binary>>} ->
{error, connection_refused};
{tcp, _, <<4:8, _Rest/binary>>} ->
{error, send_error};
{tcp, _, <<5:8, _Rest/binary>>} ->
{error, recv_error};
{tcp, _, <<6:8, _Rest/binary>>} ->
{error, existing_record};
{tcp, _, <<7:8, _Rest/binary>>} ->
{error, no_such_record};
{tcp, _, <<ErrorCode:8, _Rest/binary>>} when ErrorCode =/= 0 ->
{error, ErrorCode};
{tcp_closed, _} ->
{error, conn_closed};
{tcp_error, _, _} ->
{error, conn_error};
Data ->
ResponseHandler(Data)
after ?TIMEOUT ->
{error, timeout}
end.
%% receive 8-bit success flag
recv_success({tcp, _, <<0:8>>}) ->
ok;
%% TODO: find out why principe_table:search enters this clause
%% as table becomes large. {Update from Jim to Jim: this was probably
%% due to data chunks that was recently fixed due to the bug Bhasker
%% spotted -- try yanking this and checking again...}
recv_success({tcp, _, _})->
ok.
%% receive 8-bit success flag + 32-bit int (endianness determined by remote database)
recv_size({tcp, _, <<0:8, ValSize:32>>}) ->
ValSize;
recv_size({tcp, _, <<0:8, SmallBin/binary>>}) ->
{ValSize, _Rest} = recv_until(SmallBin, 4),
ValSize.
%% receive 8-bit success flag + 64-bit int
recv_size64({tcp, _, <<0:8, ValSize:64>>}) ->
ValSize;
recv_size64({tcp, _, <<0:8, SmallBin/binary>>}) ->
{ValSize, _Rest} = recv_until(SmallBin, 8),
ValSize.
%% receive 8-bit success flag + 64-bit int + 64-bit int
recv_size64_size64({tcp, _, <<0:8, V1:64, V2:64>>}) ->
{V1, V2};
recv_size64_size64({tcp, _, <<0:8, SmallBin/binary>>}) ->
%% Did not get a full chunk of data, so get more.
{V1, V2Bin} = recv_until(SmallBin, 8),
{V2, _Rest} = recv_until(V2Bin, 8),
{V1, V2}.
%% receive 8-bit success flag + length1 + data1
recv_size_data({tcp, _, <<0:8, Size:32, Data/binary>>}) when byte_size(Data) >= Size ->
<<Value:Size/binary, _Rest/binary>> = Data,
Value;
recv_size_data({tcp, _, <<0:8, Size:32, Data/binary>>}) ->
%% Have at least the size, need to pull more for the data payload.
{Value, _Rest} = recv_until(Data, Size),
Value;
recv_size_data({tcp, _, <<0:8, SmallBin/binary>>}) ->
%% Did not even get the size, pull size, then pull data.
{<<Size:32>>, TailBin} = recv_until(SmallBin, 4),
{Value, _Rest} = recv_until(TailBin, Size),
Value.
%% receive 8-bit success flag + count + (length1, length2, data1, data2)*count
recv_count_4tuple({tcp, _, <<0:8, 0:32, _Rest/binary>>}) ->
[];
recv_count_4tuple({tcp, _, <<0:8, Cnt:32, Rest/binary>>}) ->
{KeyVals, _} = lists:foldl(
%% This fold should grab/process one value per iteration.
fun(_IterCount, {Vals, <<KeySize:32, ValSize:32, Bin/binary>>}) ->
%% We have at least the key and value sizes, so make recv_until's
%% job easier and just ask it to split/pull the data elements.
{Key, ValBin} = recv_until(Bin, KeySize),
{Value, RestBin} = recv_until(ValBin, ValSize),
{[{Key, Value}] ++ Vals, RestBin};
(_IterCount, {Vals, <<SmallBin/binary>>}) ->
%% Not enough in SmallBin to even get the sizes, read the key and
%% value sizes then read enough to get the new data elements.
{<<KeySize:32>>, ValSizeAndDataBin} = recv_until(SmallBin, 4),
{<<ValSize:32>>, DataBin} = recv_until(ValSizeAndDataBin, 4),
{Key, ValBin} = recv_until(DataBin, KeySize),
{Value, RestBin} = recv_until(ValBin, ValSize),
{[{Key, Value}] ++ Vals, RestBin}
end,
{[], Rest}, lists:seq(1, Cnt)
),
lists:reverse(KeyVals).
%% receive 8-bit success flag + count + (length1, data1)*count
recv_count_2tuple({tcp, _, <<0:8, 0:32, _Rest/binary>>}) ->
[];
recv_count_2tuple({tcp, _, <<0:8, Cnt:32, Rest/binary>>}) ->
{Data, _} = lists:foldl(
%% This fold should grab/process one value per iteration.
fun(_IterCount, {Vals, <<Size:32, Bin/binary>>}) ->
%% We have at least the key sizes, so make recv_until's job
%% easier and just ask it to split/pull the data element.
{NewVal, RestBin} = recv_until(Bin, Size),
{[NewVal] ++ Vals, RestBin};
(_IterCount, {Vals, <<SmallBin/binary>>}) ->
%% Not enough in SmallBin to even get the size, read the size then read
%% enough to get the new data element.
{<<Size:32>>, RestBin} = recv_until(SmallBin, 4),
{NewVal, SecondRestBin} = recv_until(RestBin, Size),
{[NewVal] ++ Vals, SecondRestBin}
end,
{[], Rest}, lists:seq(1, Cnt)
),
lists:reverse(Data).
%% receive length-delimited data that may require multiple pulls from the socket
recv_until(Bin, ReqLength) when byte_size(Bin) < ReqLength ->
receive
{tcp, _, Data} ->
Combined = <<Bin/binary, Data/binary>>,
recv_until(Combined, ReqLength);
{tcp_closed, _} ->
{error, conn_closed};
{error, closed} ->
{error, conn_closed}
after ?TIMEOUT ->
{error, timeout}
end;
recv_until(Bin, ReqLength) ->
<<Required:ReqLength/binary, Rest/binary>> = Bin,
{Required, Rest}.
%% Some standard types for edoc
%%
%% @type key() = iolist()
%% @type value() = iolist()
%% @type value_or_num() = iolist() | integer() | float()
%% @type keylist() = [key()]
%% @type error() = {error, term()}
%% @type endian() = little | big
%% EUnit tests
%%
-ifdef(EUNIT).
test_setup() ->
{ok, Socket} = ?MODULE:connect(),
ok = ?MODULE:vanish(Socket),
Socket.
get_random_count() ->
get_random_count(1000).
get_random_count(Max) ->
crypto:start(),
{A1,A2,A3} = now(),
random:seed(A1, A2, A3),
round(Max * random:uniform()).
put_get_test() ->
Socket = test_setup(),
?assert(?MODULE:put(Socket, "put_get1", "testval") =:= ok),
?assert(?MODULE:put(Socket, <<"put_get2">>, <<32,145,56,0,14>>) =:= ok),
?assert(?MODULE:get(Socket, <<"put_get1">>) =:= <<"testval">>),
?assert(?MODULE:get(Socket, "put_get2") =:= <<32, 145, 56, 0, 14>>),
case proplists:get_value(bigend, ?MODULE:stat(Socket)) of
"0" ->
?assert(?MODULE:put(Socket, <<"put_get3">>, 42, little) =:= ok),
?assert(?MODULE:get(Socket, <<"put_get3">>) =:= <<42:32/little>>);
"1" ->
?assert(?MODULE:put(Socket, <<"put_get3">>, 42, big) =:= ok),
?assert(?MODULE:get(Socket, <<"put_get3">>) =:= <<42:32>>)
end.
put_get_random_test() ->
Socket = test_setup(),
ElementCount = get_random_count(),
PutVals = lists:foldl(fun(_Seq, Acc) ->
KeySize = random:uniform(1024),
Key = crypto:rand_bytes(KeySize),
ValSize = random:uniform(65536),
Val = crypto:rand_bytes(ValSize),
ok = ?MODULE:put(Socket, Key, Val),
[{Key, Val} | Acc]
end, [], lists:seq(1, ElementCount)),
lists:foreach(fun({K, V}) ->
?assert(?MODULE:get(Socket, K) =:= V)
end, PutVals),
ok.
putkeep_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"test">>, <<"foo">>),
?assert(?MODULE:get(Socket, <<"test">>) =:= <<"foo">>),
?assertMatch({error, _}, ?MODULE:putkeep(Socket, <<"test">>, <<"bar">>)),
?assert(?MODULE:get(Socket, <<"test">>) =:= <<"foo">>), % no effect if key already exists before putkeep
ok = ?MODULE:putkeep(Socket, <<"another">>, <<"baz">>),
?assert(?MODULE:get(Socket, <<"another">>) =:= <<"baz">>), % puts the key if key does not exist already
ok.
putcat_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"putcat1">>, <<"foo">>),
% append "bar" to the end
ok = ?MODULE:putcat(Socket, <<"putcat1">>, <<"bar">>),
?assert(?MODULE:get(Socket, <<"putcat1">>) =:= <<"foobar">>),
ok.
putshl_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"putshl">>, <<"foo">>),
% append "bar" to the end and shift to the left to retain the width of "4"
ok = ?MODULE:putshl(Socket, <<"putshl">>, <<"bar">>, 4),
?assert(?MODULE:get(Socket, <<"putshl">>) =:= <<"obar">>),
ok.
putnr_test() ->
Socket = test_setup(),
?MODULE:putnr(Socket, <<"putnr1">>, <<"no reply">>),
?assert(?MODULE:get(Socket, <<"putnr1">>) =:= <<"no reply">>),
ok.
out_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"out1">>, <<"to remove">>),
?assert(?MODULE:get(Socket, <<"out1">>) =:= <<"to remove">>),
ok = ?MODULE:out(Socket, <<"out1">>),
?assertMatch({error, _}, ?MODULE:get(Socket, <<"out1">>)),
ok.
mget_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"mget1">>, <<"alice">>),
ok = ?MODULE:put(Socket, <<"mget2">>, <<"bob">>),
ok = ?MODULE:put(Socket, <<"mget3">>, <<"carol">>),
ok = ?MODULE:put(Socket, <<"mget4">>, <<"trent">>),
?assert(?MODULE:mget(Socket, [<<"mget1">>, <<"mget2">>,
<<"mget3">>, <<"mget4">>]) =:=
[{<<"mget1">>, <<"alice">>},
{<<"mget2">>, <<"bob">>},
{<<"mget3">>, <<"carol">>},
{<<"mget4">>, <<"trent">>}]),
ok.
vsiz_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"vsiz1">>, <<"vsiz test">>),
?assert(?MODULE:vsiz(Socket, <<"vsiz1">>) =:= 9),
ok.
vanish_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"vanish1">>, <<"going away">>),
ok = ?MODULE:vanish(Socket),
?assertMatch({error, _}, ?MODULE:get(Socket, <<"vanish1">>)),
ok.
iter_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"a">>, <<"first">>),
ok = ?MODULE:iterinit(Socket),
<<"a">> = ?MODULE:iternext(Socket), % "a" should be the first key
% Now to test a bit of real iteration
ok = ?MODULE:put(Socket, <<"b">>, <<"second">>),
ok = ?MODULE:put(Socket, <<"c">>, <<"third">>),
ok = ?MODULE:iterinit(Socket),
One = ?MODULE:iternext(Socket),
Two = ?MODULE:iternext(Socket),
Three = ?MODULE:iternext(Socket),
?assertMatch({error, _}, ?MODULE:iternext(Socket)),
?assertMatch([<<"a">>, <<"b">>, <<"c">>], lists:sort([One, Two, Three])),
ok.
fwmkeys_test() ->
Socket = test_setup(),
ok = ?MODULE:put(Socket, <<"fwmkeys1">>, <<"1">>),
ok = ?MODULE:put(Socket, <<"fwmkeys2">>, <<"2">>),
ok = ?MODULE:put(Socket, <<"fwmkeys3">>, <<"3">>),
ok = ?MODULE:put(Socket, <<"fwmkeys4">>, <<"4">>),
Keys1 = ?MODULE:fwmkeys(Socket, <<"fwmkeys">>, 4),
?assert(length(Keys1) =:= 4),
?assert(lists:member(<<"fwmkeys1">>, Keys1)),
?assert(lists:member(<<"fwmkeys2">>, Keys1)),
?assert(lists:member(<<"fwmkeys3">>, Keys1)),
?assert(lists:member(<<"fwmkeys4">>, Keys1)),
Keys2 = ?MODULE:fwmkeys(Socket, <<"fwmkeys">>, 2),
?assert(length(Keys2) =:= 2),
ok.
addint_test() ->
Socket = test_setup(),
case proplists:get_value(bigend, ?MODULE:stat(Socket)) of
"0" ->
?MODULE:put(Socket, <<"addint1">>, 100, little);
"1" ->