/
riak_kv_put_fsm.erl
1459 lines (1336 loc) · 58.6 KB
/
riak_kv_put_fsm.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
%% -------------------------------------------------------------------
%%
%% riak_put_fsm: coordination of Riak PUT requests
%%
%% Copyright (c) 2007-2013 Basho Technologies, Inc. All Rights Reserved.
%%
%% This file is provided 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.
%%
%% -------------------------------------------------------------------
%% @doc coordination of Riak PUT requests
-module(riak_kv_put_fsm).
-ifdef(TEST).
-include_lib("eunit/include/eunit.hrl").
-endif.
-include_lib("riak_kv_vnode.hrl").
-include("riak_kv_wm_raw.hrl").
-include("riak_kv_types.hrl").
-include("stacktrace.hrl").
-compile({nowarn_deprecated_function,
[{gen_fsm, start_link, 3},
{gen_fsm, send_event, 2}]}).
-behaviour(gen_fsm).
-define(DEFAULT_OPTS, [{returnbody, false}, {update_last_modified, true}]).
-export([start/3,start/6,start/7]).
-export([start_link/3,start_link/6,start_link/7]).
-export([set_put_coordinator_failure_timeout/1,
get_put_coordinator_failure_timeout/0]).
-ifdef(TEST).
-export([test_link/4]).
-endif.
-export([init/1, handle_event/3, handle_sync_event/4,
handle_info/3, terminate/3, code_change/4]).
-export([prepare/2, validate/2, precommit/2,
waiting_local_vnode/2,
waiting_remote_vnode/2,
postcommit/2, finish/2]).
-type detail_info() :: timing.
-type detail() :: true |
false |
[detail_info()].
-type option() ::
%% Min number of primary (owner) vnodes participating
{pw, non_neg_integer()} |
%% Minimum number of vnodes receiving write
{w, non_neg_integer()} |
%% Minimum number of vnodes completing write
{dw, non_neg_integer()} |
{timeout, timeout()} |
%% Prevent precommit/postcommit hooks from running
disable_hooks |
%% Request additional details about request added as extra
%% element at the end of result tuple
{details, detail()} |
%% Sync-on-write setting, backend, one(co-ordinating) or all
{sync_on_write, atom()} |
%% Put the value as-is, do not increment the vclocks
%% to make the value a frontier.
asis |
%% Use a sloppy quorum, default = true
{sloppy_quorum, boolean()} |
%% The N value, default = value from bucket properties
{n_val, pos_integer()} |
%% Control server-side put failure retry, default = true.
%% Some CRDTs and other client operations that cannot tolerate
%% an automatic retry on the server side; those operations should
%% use {retry_put_coordinator_failure, false}.
{retry_put_coordinator_failure, boolean()} |
%% When selecting a coordinator, `mbox_check' controls wether
%% the vnode mailbox soft-limit is checked. see riak#gh1661
%% for details. NOTE: defaults to `true' but will be set to
%% `false' by the puts_fsm when it forwards to a new put fsm
%% i.e. ONLY forward once, when a coordinator is chosen, use
%% it.
{mbox_check, boolean()} |
{counter_op, any()} |
{crdt_op, any()}.
-type options() :: [option()].
-type preflist_entry() :: {Idx::non_neg_integer(), node()}.
%% the information about vnode mailbox queues used to select a
%% coordinator
-type mbox_data() :: [{preflist_entry(),
MBoxSize::error | non_neg_integer(),
MBoxSofLimit:: error | non_neg_integer()}] | [].
-export_type([option/0, options/0, detail/0, detail_info/0]).
-record(state, {from :: {raw, integer(), pid()},
robj :: riak_object:riak_object(),
options=[] :: options(),
n :: pos_integer() | undefined,
w :: non_neg_integer() | undefined,
dw :: non_neg_integer() | undefined,
pw :: non_neg_integer() | undefined,
node_confirms :: non_neg_integer() | undefined,
sync_on_write :: atom(),
coord_pl_entry :: {integer(), atom()} | undefined,
preflist2 :: riak_core_apl:preflist_ann() | undefined,
bkey :: {riak_object:bucket(), riak_object:key()},
req_id :: pos_integer() | undefined,
starttime = riak_core_util:moment()
:: pos_integer(), % start time to send to vnodes
timeout = infinity :: pos_integer()|infinity,
tref :: reference() | undefined,
vnode_options=[] :: list(),
returnbody = false :: boolean(),
allowmult = true :: boolean(),
precommit=[] :: list(),
postcommit=[] :: list(),
bucket_props :: list() | undefined,
putcore :: riak_kv_put_core:putcore() | undefined,
put_usecs :: undefined | non_neg_integer(),
timing = [] :: [{atom(), {non_neg_integer(), non_neg_integer(),
non_neg_integer()}}],
reply, % reply sent to client,
trace = false :: boolean(),
tracked_bucket=false :: boolean(), %% track per bucket stats
bad_coordinators = [] :: [atom()],
coordinator_timeout :: integer()
}).
-include("riak_kv_dtrace.hrl").
-define(PARSE_INDEX_PRECOMMIT, {struct, [{<<"mod">>, <<"riak_index">>}, {<<"fun">>, <<"parse_object_hook">>}]}).
-define(DEFAULT_TIMEOUT, 60000).
%% ===================================================================
%% Public API
%% ===================================================================
%% In place only for backwards compatibility
start(ReqId,RObj,W,DW,Timeout,ResultPid) ->
start_link(ReqId,RObj,W,DW,Timeout,ResultPid,[]).
%% In place only for backwards compatibility
start(ReqId,RObj,W,DW,Timeout,ResultPid,Options) ->
start_link(ReqId,RObj,W,DW,Timeout,ResultPid,Options).
start_link(ReqId,RObj,W,DW,Timeout,ResultPid) ->
start_link(ReqId,RObj,W,DW,Timeout,ResultPid,[]).
start_link(ReqId,RObj,W,DW,Timeout,ResultPid,Options) ->
start({raw, ReqId, ResultPid}, RObj, [{w, W}, {dw, DW}, {timeout, Timeout} | Options]).
start(From, Object, PutOptions) ->
Args = [From, Object, PutOptions],
case sidejob_supervisor:start_child(riak_kv_put_fsm_sj,
gen_fsm, start_link,
[?MODULE, Args, []]) of
{error, overload} ->
riak_kv_util:overload_reply(From),
{error, overload};
{ok, Pid} ->
{ok, Pid}
end.
%% Included for backward compatibility, in case someone is, say, passing around
%% a riak_client instace between nodes during a rolling upgrade. The old
%% `start_link' function has been renamed `start' since it doesn't actually link
%% to the caller.
start_link(From, Object, PutOptions) -> start(From, Object, PutOptions).
set_put_coordinator_failure_timeout(MS) when is_integer(MS), MS >= 0 ->
application:set_env(riak_kv, put_coordinator_failure_timeout, MS);
set_put_coordinator_failure_timeout(Bad) ->
lager:error("~s:set_put_coordinator_failure_timeout(~p) invalid",
[?MODULE, Bad]),
set_put_coordinator_failure_timeout(3000).
get_put_coordinator_failure_timeout() ->
app_helper:get_env(riak_kv, put_coordinator_failure_timeout, 3000).
make_ack_options(Options) ->
AckOption = get_option(ack_execute, Options),
AckCap = riak_core_capability:get({riak_kv, put_fsm_ack_execute}, disabled),
RetryCoord =
app_helper:get_env(riak_kv, retry_put_coordinator_failure, true) andalso
get_option(retry_put_coordinator_failure, Options, true),
case {AckOption, AckCap, RetryCoord} of
{Pid, _, _} when is_pid(Pid) ->
%% Some process (probably on another node) is already waiting
%% for an ack, no need to monitor here.
{false, Options};
{undefined, disabled, _} ->
{false, Options};
{undefined, _, false} ->
{false, Options};
{undefined, enabled, true} ->
{true, [
%% ack forwarder
{ack_execute, self()}| Options]}
end.
spawn_coordinator_proc(CoordNode, Mod, Fun, Args) ->
%% If the net_kernel cannot talk to CoordNode, then any variation
%% of the spawn BIF will block. The whole point of picking a new
%% coordinator node is being able to pick a new coordinator node
%% and try it ... without blocking for dozens of seconds.
spawn(fun() ->
proc_lib:spawn(CoordNode, Mod, Fun, Args)
end).
monitor_remote_coordinator(false = _UseAckP, _MiddleMan, _CoordNode, StateData) ->
{stop, normal, StateData};
monitor_remote_coordinator(true = _UseAckP, MiddleMan, CoordNode, StateData) ->
receive
{ack, CoordNodeFinal, now_executing} ->
case CoordNodeFinal of
CoordNode ->
ok;
_ ->
lager:warning("unexpected forward-ack from ~p, expected from ~p",
[CoordNodeFinal, CoordNode])
end,
{stop, normal, StateData}
after StateData#state.coordinator_timeout ->
exit(MiddleMan, kill),
Bad = StateData#state.bad_coordinators,
lager:warning("timed out waiting for forward-ack, adding ~p to bad coordinators",
[CoordNode]),
prepare(timeout, StateData#state{bad_coordinators=[CoordNode|Bad]})
end.
%% ===================================================================
%% Test API
%% ===================================================================
-ifdef(TEST).
%% Create a put FSM for testing. StateProps must include
%% starttime - start time in gregorian seconds
%% n - N-value for request (is grabbed from bucket props in prepare)
%% bkey - Bucket / Key
%% bucket_props - bucket properties
%% preflist2 - [{{Idx,Node},primary|fallback}] preference list
%%
%% As test, but linked to the caller
test_link(From, Object, PutOptions, StateProps) ->
gen_fsm:start_link(?MODULE, {test, [From, Object, PutOptions], StateProps}, []).
-endif.
%% ====================================================================
%% gen_fsm callbacks
%% ====================================================================
%% @private
init([From, RObj, Options0]) ->
BKey = {Bucket, Key} = {riak_object:bucket(RObj), riak_object:key(RObj)},
CoordTimeout = get_put_coordinator_failure_timeout(),
Trace = app_helper:get_env(riak_kv, fsm_trace_enabled),
Options = proplists:unfold(Options0),
StateData = #state{from = From,
robj = RObj,
bkey = BKey,
trace = Trace,
options = Options,
timing = riak_kv_fsm_timing:add_timing(prepare, []),
coordinator_timeout=CoordTimeout},
case Trace of
true ->
riak_core_dtrace:put_tag([Bucket, $,, Key]),
case riak_kv_util:is_x_deleted(RObj) of
true ->
TombNum = 1,
TombStr = <<"tombstone">>;
false ->
TombNum = 0,
TombStr = <<>>
end,
?DTRACE(?C_PUT_FSM_INIT, [TombNum], ["init", TombStr]);
_ ->
ok
end,
gen_fsm:send_event(self(), timeout),
{ok, prepare, StateData};
init({test, Args, StateProps}) ->
%% Call normal init
{ok, prepare, StateData} = init(Args),
%% Then tweak the state record with entries provided by StateProps
Fields = record_info(fields, state),
FieldPos = lists:zip(Fields, lists:seq(2, length(Fields)+1)),
F = fun({Field, Value}, State0) ->
Pos = get_option(Field, FieldPos),
setelement(Pos, State0, Value)
end,
TestStateData = lists:foldl(F, StateData, StateProps),
%% Enter into the validate state, skipping any code that relies on the
%% state of the rest of the system
{ok, validate, TestStateData}.
%% @private
prepare(timeout, State = #state{robj = RObj, options=Options}) ->
Bucket = riak_object:bucket(RObj),
BucketProps = get_bucket_props(Bucket),
StatTracked = get_option(stat_tracked, BucketProps, false),
N = get_n_val(Options, BucketProps),
get_preflist(N, State#state{tracked_bucket=StatTracked, bucket_props=BucketProps}).
%% @private
validate(timeout, StateData0 = #state{from = {raw, ReqId, _Pid},
options = Options0,
robj = RObj0,
n=N, bucket_props = BucketProps,
trace = Trace,
preflist2 = Preflist2}) ->
Timeout = get_option(timeout, Options0, ?DEFAULT_TIMEOUT),
PW0 = get_option(pw, Options0, default),
NodeConfirms0 = get_option(node_confirms, Options0, default),
W0 = get_option(w, Options0, default),
DW0 = get_option(dw, Options0, default),
SyncOnWrite0 = get_option(sync_on_write, Options0, default),
PW = riak_kv_util:expand_rw_value(pw, PW0, BucketProps, N),
NodeConfirms = riak_kv_util:expand_rw_value(node_confirms, NodeConfirms0, BucketProps, N),
W = riak_kv_util:expand_rw_value(w, W0, BucketProps, N),
SyncOnWrite = riak_kv_util:expand_sync_on_write(SyncOnWrite0, BucketProps),
%% Expand the DW value, but also ensure that DW <= W
DW1 = riak_kv_util:expand_rw_value(dw, DW0, BucketProps, N),
%% If no error occurred expanding DW also ensure that DW <= W
case DW1 of
error ->
DW = error;
_ ->
%% DW must always be 1 with node-based vclocks.
%% The coord vnode is responsible for incrementing the vclock
DW = erlang:max(DW1, 1)
end,
IdxType = [{Part, Type, Node} || {{Part, Node}, Type} <- Preflist2],
NumPrimaries = length([x || {_,primary} <- Preflist2]),
NumVnodes = length(Preflist2),
MinVnodes = lists:max([1, W, DW, PW]), % always need at least one vnode
if
PW =:= error ->
process_reply({error, {pw_val_violation, PW0}}, StateData0);
NodeConfirms =:= error ->
process_reply({error, {node_confirms_val_violation, NodeConfirms0}}, StateData0);
W =:= error ->
process_reply({error, {w_val_violation, W0}}, StateData0);
DW =:= error ->
process_reply({error, {dw_val_violation, DW0}}, StateData0);
(W > N) or (DW > N) or (PW > N) or (NodeConfirms > N)->
process_reply({error, {n_val_violation, N}}, StateData0);
PW > NumPrimaries ->
process_reply({error, {pw_val_unsatisfied, PW, NumPrimaries}}, StateData0);
NumVnodes < MinVnodes ->
process_reply({error, {insufficient_vnodes, NumVnodes,
need, MinVnodes}}, StateData0);
true ->
AllowMult = get_option(allow_mult, BucketProps),
Options = flatten_options(Options0 ++ ?DEFAULT_OPTS, []),
Disable = get_option(disable_hooks, Options),
Precommit =
if Disable -> [];
true ->
L = get_hooks(precommit, BucketProps),
L ++ [?PARSE_INDEX_PRECOMMIT]
end,
Postcommit =
if Disable -> [];
true -> get_hooks(postcommit, BucketProps, StateData0)
end,
{VNodeOpts0, ReturnBody} =
case get_option(returnbody, Options) of
true ->
{[], true};
_ ->
case Postcommit of
[] ->
{[], false};
_ ->
{[{returnbody,true}], false}
end
end,
RObj = apply_updates(RObj0, Options),
RR =
case get_option(asis, Options) of
true ->
Clock = riak_object:vclock(RObj),
MaybePrunedClock =
vclock:prune(
Clock, riak_core_util:moment(), BucketProps),
case {length(MaybePrunedClock), length(Clock)} of
{PVL, UPVL} when PVL < UPVL ->
true;
_ ->
false
end;
_ ->
false
end,
PutCore = riak_kv_put_core:init(N, W, PW, NodeConfirms, DW,
AllowMult,
ReturnBody,
IdxType),
Options1 = lists:keydelete(sync_on_write, 1, Options),
Options2 = [{sync_on_write, SyncOnWrite}|Options1],
Options3 = [{rr, RR}|Options2],
VNodeOpts = handle_options(Options3, VNodeOpts0),
StateData = StateData0#state{n=N,
w=W,
pw=PW, node_confirms=NodeConfirms, dw=DW,
allowmult=AllowMult,
precommit = Precommit,
postcommit = Postcommit,
req_id = ReqId,
robj = RObj,
putcore = PutCore,
vnode_options = VNodeOpts,
timeout = Timeout},
?DTRACE(Trace, ?C_PUT_FSM_VALIDATE, [N, W, PW, NodeConfirms, DW], []),
case Precommit of
[] -> % Nothing to run, spare the timing code
execute(StateData);
_ ->
new_state_timeout(precommit, StateData)
end
end.
apply_updates(RObj0, Options) ->
RObj1 =
case get_option(update_last_modified, Options) of
true ->
riak_object:update_last_modified(RObj0);
_ ->
RObj0
end,
riak_object:apply_updates(RObj1).
%% Run the precommit hooks
precommit(timeout, State = #state{precommit = []}) ->
execute(State);
precommit(timeout, State = #state{precommit = [Hook | Rest],
robj = RObj,
trace = Trace}) ->
Result = decode_precommit(invoke_hook(Hook, RObj), Trace),
case Result of
fail ->
?DTRACE(Trace, ?C_PUT_FSM_PRECOMMIT, [-1], []),
process_reply({error, precommit_fail}, State);
{fail, Reason} ->
?DTRACE(Trace, ?C_PUT_FSM_PRECOMMIT, [-1],
[dtrace_errstr(Reason)]),
process_reply({error, {precommit_fail, Reason}}, State);
Result ->
?DTRACE(Trace, ?C_PUT_FSM_PRECOMMIT, [0], []),
new_state_timeout(precommit,
State#state{robj = riak_object:apply_updates(Result),
precommit = Rest})
end.
%% @private
execute(State=#state{options = Options, timeout = Timeout, coord_pl_entry = CPL}) ->
%% If we are a forwarded coordinator, the originating node is expecting
%% an ack from us.
case get_option(ack_execute, Options) of
undefined ->
ok;
Pid ->
Pid ! {ack, node(), now_executing}
end,
TRef = schedule_timeout(Timeout),
NewState = State#state{tref = TRef},
case CPL of
undefined ->
execute_remote(NewState);
_ ->
execute_local(NewState)
end.
%% @private
%% Send the put coordinating put requests to the local vnode - the returned object
%% will guarantee a frontier object.
%% N.B. Not actually a state - here in the source to make reading the flow easier
execute_local(StateData=#state{robj=RObj, req_id = ReqId, bkey=BKey,
coord_pl_entry = {_Index, Node} = CoordPLEntry,
vnode_options=VnodeOptions,
trace = Trace,
starttime = StartTime}) ->
StateData1 =
case Trace of
true ->
?DTRACE(?C_PUT_FSM_EXECUTE_LOCAL, [], [atom2list(Node)]),
add_timing(execute_local, StateData);
_ ->
StateData
end,
riak_kv_vnode:coord_put(CoordPLEntry, BKey, RObj, ReqId, StartTime, VnodeOptions),
StateData2 = StateData1#state{robj = RObj},
%% Must always wait for local vnode - it contains the object with updated vclock
%% to use for the remotes. (Ignore optimization for N=1 case for now).
new_state(waiting_local_vnode, StateData2).
%% @private
waiting_local_vnode(request_timeout, StateData=#state{trace = Trace}) ->
?DTRACE(Trace, ?C_PUT_FSM_WAITING_LOCAL_VNODE, [-1], []),
process_reply({error,timeout}, StateData);
waiting_local_vnode(Result, StateData = #state{putcore = PutCore,
trace = Trace}) ->
UpdPutCore1 = riak_kv_put_core:add_result(Result, PutCore),
case Result of
{fail, Idx, Reason} ->
?DTRACE(Trace, ?C_PUT_FSM_WAITING_LOCAL_VNODE, [-1],
[integer_to_list(Idx)]),
%% Local vnode failure is enough to sink whole operation
process_reply({error, Reason}, StateData#state{putcore = UpdPutCore1});
{w, Idx, _ReqId} ->
?DTRACE(Trace, ?C_PUT_FSM_WAITING_LOCAL_VNODE, [1],
[integer_to_list(Idx)]),
{next_state, waiting_local_vnode, StateData#state{putcore = UpdPutCore1}};
{dw, Idx, PutObj, _ReqId} ->
%% Either returnbody is true or coord put merged with the existing
%% object and bumped the vclock. Either way use the returned
%% object for the remote vnode
?DTRACE(Trace, ?C_PUT_FSM_WAITING_LOCAL_VNODE, [2],
[integer_to_list(Idx)]),
execute_remote(StateData#state{robj = PutObj, putcore = UpdPutCore1});
{dw, Idx, _ReqId} ->
%% Write succeeded without changes to vclock required and returnbody false
?DTRACE(Trace, ?C_PUT_FSM_WAITING_LOCAL_VNODE, [2],
[integer_to_list(Idx)]),
execute_remote(StateData#state{putcore = UpdPutCore1})
end.
%% @private
%% Send the put requests to any remote nodes if necessary and decided if
%% enough responses have been received yet (i.e. if W/DW=1)
%% N.B. Not actually a state - here in the source to make reading the flow easier
execute_remote(StateData=#state{robj=RObj, req_id = ReqId,
preflist2 = Preflist2, bkey = BKey,
coord_pl_entry = CoordPLEntry,
vnode_options = VnodeOptions,
putcore = PutCore,
trace = Trace,
starttime = StartTime}) ->
Preflist = [IndexNode || {IndexNode, _Type} <- Preflist2,
IndexNode /= CoordPLEntry],
StateData1 =
case Trace of
true ->
Ps = [[atom2list(Nd), $,, integer_to_list(Idx)] ||
{Idx, Nd} <- lists:sublist(Preflist, 4)],
?DTRACE(?C_PUT_FSM_EXECUTE_REMOTE, [], [Ps]),
add_timing(execute_remote, StateData);
_ ->
StateData
end,
riak_kv_vnode:put(Preflist, BKey, RObj, ReqId, StartTime, VnodeOptions),
case riak_kv_put_core:enough(PutCore) of
true ->
{Reply, UpdPutCore} = riak_kv_put_core:response(PutCore),
process_reply(Reply, StateData1#state{putcore = UpdPutCore});
false ->
new_state(waiting_remote_vnode, StateData1)
end.
%% @private
waiting_remote_vnode(request_timeout, StateData=#state{trace = Trace}) ->
?DTRACE(Trace, ?C_PUT_FSM_WAITING_REMOTE_VNODE, [-1], []),
process_reply({error,timeout}, StateData);
waiting_remote_vnode(Result, StateData = #state{putcore = PutCore,
trace = Trace}) ->
case Trace of
true ->
ShortCode = riak_kv_put_core:result_shortcode(Result),
IdxStr = integer_to_list(riak_kv_put_core:result_idx(Result)),
?DTRACE(?C_PUT_FSM_WAITING_REMOTE_VNODE, [ShortCode], [IdxStr]);
_ ->
ok
end,
UpdPutCore1 = riak_kv_put_core:add_result(Result, PutCore),
case riak_kv_put_core:enough(UpdPutCore1) of
true ->
{Reply, UpdPutCore2} = riak_kv_put_core:response(UpdPutCore1),
process_reply(Reply, StateData#state{putcore = UpdPutCore2});
false ->
{next_state, waiting_remote_vnode, StateData#state{putcore = UpdPutCore1}}
end.
%% @private
postcommit(timeout, StateData = #state{postcommit = [], trace = Trace}) ->
?DTRACE(Trace, ?C_PUT_FSM_POSTCOMMIT, [0], []),
new_state_timeout(finish, StateData);
postcommit(timeout, StateData = #state{postcommit = [Hook | Rest],
trace = Trace,
putcore = PutCore}) ->
?DTRACE(Trace, ?C_PUT_FSM_POSTCOMMIT, [-2], []),
%% Process the next hook - gives sys:get_status messages a chance if hooks
%% take a long time.
{ReplyObj, UpdPutCore} = riak_kv_put_core:final(PutCore),
decode_postcommit(invoke_hook(Hook, ReplyObj), Trace),
new_state_timeout( postcommit, StateData#state{postcommit = Rest,
trace = Trace,
putcore = UpdPutCore});
%% still process hooks even if request timed out
postcommit(request_timeout, StateData = #state{trace = Trace}) ->
?DTRACE(Trace, ?C_PUT_FSM_POSTCOMMIT, [-3], []),
new_state_timeout(postcommit, StateData);
postcommit(Reply, StateData = #state{putcore = PutCore,
trace = Trace}) ->
case Trace of
true ->
ShortCode = riak_kv_put_core:result_shortcode(Reply),
IdxStr = integer_to_list(riak_kv_put_core:result_idx(Reply)),
?DTRACE(?C_PUT_FSM_POSTCOMMIT, [0, ShortCode], [IdxStr]);
_ ->
ok
end,
%% late responses - add to state. *Does not* recompute finalobj
UpdPutCore = riak_kv_put_core:add_result(Reply, PutCore),
new_state_timeout(postcommit, StateData#state{putcore = UpdPutCore}).
finish(timeout, StateData = #state{timing = Timing, reply = Reply,
bkey = {Bucket, _Key},
trace = Trace,
tracked_bucket = StatTracked,
options = Options}) ->
case Reply of
{error, _} ->
?DTRACE(Trace, ?C_PUT_FSM_FINISH, [-1], []),
ok;
_Ok ->
%% TODO: Improve reporting of timing
%% For now can add debug tracers to view the return from calc_timing
CRDTMod = case get_option(crdt_op, Options) of
#crdt_op{mod=Mod} -> Mod;
_ -> undefined
end,
{Duration, Stages} = riak_kv_fsm_timing:calc_timing(Timing),
ok = riak_kv_stat:update({put_fsm_time, Bucket, Duration,
Stages, StatTracked, CRDTMod}),
?DTRACE(Trace, ?C_PUT_FSM_FINISH, [0, Duration], [])
end,
{stop, normal, StateData};
finish(Reply, StateData = #state{putcore = PutCore,
trace = Trace}) ->
case Trace of
true ->
ShortCode = riak_kv_put_core:result_shortcode(Reply),
IdxStr = integer_to_list(riak_kv_put_core:result_idx(Reply)),
?DTRACE(?C_PUT_FSM_FINISH, [1, ShortCode], [IdxStr]);
_ ->
ok
end,
%% late responses - add to state. *Does not* recompute finalobj
UpdPutCore = riak_kv_put_core:add_result(Reply, PutCore),
new_state_timeout(finish, StateData#state{putcore = UpdPutCore}).
%% @private
handle_event(_Event, _StateName, StateData) ->
{stop,badmsg,StateData}.
%% @private
handle_sync_event(_Event, _From, _StateName, StateData) ->
{stop,badmsg,StateData}.
%% @private
handle_info(request_timeout, StateName, StateData) ->
?MODULE:StateName(request_timeout, StateData);
handle_info({ack, Node, now_executing}, StateName, StateData) ->
late_put_fsm_coordinator_ack(Node),
ok = riak_kv_stat:update(late_put_fsm_coordinator_ack),
{next_state, StateName, StateData};
handle_info({mbox, _}, StateName, StateData) ->
%% Delayed mailbox size check response, ignore it
{next_state, StateName, StateData};
handle_info(_Info, _StateName, StateData) ->
{stop,badmsg,StateData}.
%% @private
terminate(Reason, _StateName, _State) ->
Reason.
%% @private
code_change(_OldVsn, StateName, State, _Extra) -> {ok, StateName, State}.
%% ====================================================================
%% Internal functions
%% ====================================================================
%% Move to the new state, marking the time it started
new_state(StateName, StateData=#state{trace = true}) ->
{next_state, StateName, add_timing(StateName, StateData)};
new_state(StateName, StateData) ->
{next_state, StateName, StateData}.
%% Move to the new state, marking the time it started and trigger an immediate
%% timeout.
new_state_timeout(StateName, StateData=#state{trace = true}) ->
gen_fsm:send_event(self(), timeout),
{next_state, StateName, add_timing(StateName, StateData)};
new_state_timeout(StateName, StateData) ->
gen_fsm:send_event(self(), timeout),
{next_state, StateName, StateData}.
%% What to do once enough responses from vnodes have been received to reply
process_reply(Reply, StateData = #state{postcommit = PostCommit,
putcore = PutCore,
robj = RObj,
trace = Trace,
bkey = {Bucket, Key}}) ->
StateData1 = client_reply(Reply, StateData),
StateData2 = case PostCommit of
[] ->
StateData1;
_ ->
%% If postcommits defined, calculate final object
%% before any replies received after responding to
%% the client for a consistent view.
{_, UpdPutCore} = riak_kv_put_core:final(PutCore),
StateData1#state{putcore = UpdPutCore}
end,
case Reply of
ok ->
?DTRACE(Trace, ?C_PUT_FSM_PROCESS_REPLY, [0], []),
new_state_timeout(postcommit, StateData2);
{ok, _} ->
Values = riak_object:get_values(RObj),
%% TODO: more accurate sizing method
case Trace of
true ->
ApproxBytes = size(Bucket) + size(Key) +
lists:sum([size(V) || V <- Values]),
NumSibs = length(Values),
?DTRACE(?C_PUT_FSM_PROCESS_REPLY,
[1, ApproxBytes, NumSibs], []);
_ ->
ok
end,
new_state_timeout(postcommit, StateData2);
_ ->
?DTRACE(Trace, ?C_PUT_FSM_PROCESS_REPLY, [-1], []),
new_state_timeout(finish, StateData2)
end.
%%
%% Given an expanded proplist of options, take the first entry for any given key
%% and ignore the rest
%%
%% @private
flatten_options([], Opts) ->
Opts;
flatten_options([{Key, Value} | Rest], Opts) ->
case lists:keymember(Key, 1, Opts) of
true ->
flatten_options(Rest, Opts);
false ->
flatten_options(Rest, [{Key, Value} | Opts])
end.
%% @private
handle_options([], Acc) ->
Acc;
handle_options([{returnbody, true}|T], Acc) ->
VNodeOpts = [{returnbody, true} | Acc],
handle_options(T, VNodeOpts);
handle_options([{sync_on_write, Val}|T], Acc) ->
VNodeOpts = [{sync_on_write, Val} | Acc],
handle_options(T, VNodeOpts);
handle_options([{counter_op, _Amt}=COP|T], Acc) ->
VNodeOpts = [COP | Acc],
handle_options(T, VNodeOpts);
handle_options([{crdt_op, _Op}=COP|T], Acc) ->
VNodeOpts = [COP | Acc],
handle_options(T, VNodeOpts);
handle_options([{K, _V} = Opt|T], Acc)
when K == sloppy_quorum; K == n_val ->
%% Take these options as-is
handle_options(T, [Opt|Acc]);
handle_options([{rr, true}|T], Acc) ->
handle_options(T, [{rr, true}|Acc]);
handle_options([{_,_}|T], Acc) -> handle_options(T, Acc).
%% Invokes the hook and returns a tuple of
%% {Lang, Called, Result}
%% Where Called = {Mod, Fun} if Lang = erlang
invoke_hook({struct, Hook}=HookDef, RObj) ->
Mod = get_option(<<"mod">>, Hook),
Fun = get_option(<<"fun">>, Hook),
if (Mod == undefined orelse Fun == undefined) ->
{error, {invalid_hook_def, HookDef}};
true -> invoke_hook(Mod, Fun, RObj)
end;
invoke_hook(HookDef, _RObj) ->
{error, {invalid_hook_def, HookDef}}.
invoke_hook(Mod0, Fun0, RObj) when Mod0 /= undefined, Fun0 /= undefined ->
Mod = binary_to_atom(Mod0, utf8),
Fun = binary_to_atom(Fun0, utf8),
try
{erlang, {Mod, Fun}, Mod:Fun(RObj)}
catch
Class:Exception ->
{erlang, {Mod, Fun}, {'EXIT', Mod, Fun, Class, Exception}}
end;
invoke_hook(_, _, _) ->
{error, {invalid_hook_def, no_hook}}.
-spec decode_precommit(any(), boolean()) -> fail | {fail, any()} |
riak_object:riak_object().
decode_precommit({erlang, {Mod, Fun}, Result}, Trace) ->
%% TODO: For DTrace things, we will err on the side of taking the
%% time to format the error results into strings to pass to
%% the probes. If this ends up being too slow, then revisit.
case Result of
fail ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_PRECOMMIT, [-1], []),
ok = riak_kv_stat:update(precommit_fail),
lager:debug("Pre-commit hook ~p:~p failed, no reason given",
[Mod, Fun]),
fail;
{fail, Reason} ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_PRECOMMIT, [-2],
[dtrace_errstr(Reason)]),
ok = riak_kv_stat:update(precommit_fail),
lager:debug("Pre-commit hook ~p:~p failed with reason ~p",
[Mod, Fun, Reason]),
Result;
{'EXIT', Mod, Fun, Class, Exception} ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_PRECOMMIT, [-3],
[dtrace_errstr({Mod, Fun, Class, Exception})]),
ok = riak_kv_stat:update(precommit_fail),
lager:debug("Problem invoking pre-commit hook ~p:~p -> ~p:~p~n~p",
[Mod,Fun,Class,Exception, ?_current_stacktrace_()]),
{fail, {hook_crashed, {Mod, Fun, Class, Exception}}};
Obj ->
try
riak_object:ensure_robject(Obj)
catch X:Y ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_PRECOMMIT, [-4],
[dtrace_errstr({Mod, Fun, X, Y})]),
ok = riak_kv_stat:update(precommit_fail),
lager:debug("Problem invoking pre-commit hook ~p:~p,"
" invalid return ~p",
[Mod, Fun, Result]),
{fail, {invalid_return, {Mod, Fun, Result}}}
end
end;
decode_precommit({error, Reason}, Trace) ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_PRECOMMIT, [-8],
[dtrace_errstr(Reason)]),
ok = riak_kv_stat:update(precommit_fail),
lager:debug("Problem invoking pre-commit hook: ~p", [Reason]),
{fail, Reason}.
decode_postcommit({erlang, {M,F}, Res}, Trace) ->
case Res of
fail ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_POSTCOMMIT, [-1], []),
ok = riak_kv_stat:update(postcommit_fail),
lager:debug("Post-commit hook ~p:~p failed, no reason given",
[M, F]);
{fail, Reason} ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_POSTCOMMIT, [-2],
[dtrace_errstr(Reason)]),
ok = riak_kv_stat:update(postcommit_fail),
lager:debug("Post-commit hook ~p:~p failed with reason ~p",
[M, F, Reason]);
{'EXIT', _, _, Class, Ex} ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_POSTCOMMIT, [-3],
[dtrace_errstr({M, F, Class, Ex})]),
ok = riak_kv_stat:update(postcommit_fail),
Stack = ?_current_stacktrace_(),
lager:debug("Problem invoking post-commit hook ~p:~p -> ~p:~p~n~p",
[M, F, Class, Ex, Stack]),
ok;
_ ->
ok
end;
decode_postcommit({error, {invalid_hook_def, Def}}, Trace) ->
?DTRACE(Trace, ?C_PUT_FSM_DECODE_POSTCOMMIT, [-4], [dtrace_errstr(Def)]),
ok = riak_kv_stat:update(postcommit_fail),
lager:debug("Invalid post-commit hook definition ~p", [Def]).
get_hooks(HookType, BucketProps) ->
Hooks = get_option(HookType, BucketProps, []),
case Hooks of
<<"none">> ->
[];
Hooks when is_list(Hooks) ->
Hooks
end.
get_hooks(postcommit, BucketProps, #state{bkey=BKey}) ->
BaseHooks = get_hooks(postcommit, BucketProps),
CondHooks = riak_kv_hooks:get_conditional_postcommit(BKey, BucketProps),
BaseHooks ++ (CondHooks -- BaseHooks).
get_option(Name, Options) ->
get_option(Name, Options, undefined).
get_option(Name, Options, Default) ->
case lists:keyfind(Name, 1, Options) of
{_, Val} ->
Val;
false ->
Default
end.
schedule_timeout(infinity) ->
undefined;
schedule_timeout(Timeout) ->
erlang:send_after(Timeout, self(), request_timeout).
client_reply(Reply, State = #state{from = {raw, ReqId, Pid},
timing = Timing0,
options = Options}) ->
Timing = riak_kv_fsm_timing:add_timing(reply, Timing0),
Reply2 = case get_option(details, Options, false) of
false ->
Reply;
[] ->
Reply;
Details ->
add_client_info(Reply, Details,
State#state{timing = Timing})
end,
Pid ! {ReqId, Reply2},
State#state{reply = Reply,
timing = Timing}.
add_client_info(Reply, Details, State) ->
Info = client_info(Details, State, []),
case Reply of
ok ->
{ok, Info};
{OkError, ObjReason} ->
{OkError, ObjReason, Info}
end.
client_info(true, StateData, Info) ->
client_info(default_details(), StateData, Info);
client_info([], _StateData, Info) ->
Info;
client_info([timing | Rest], StateData = #state{timing = Timing}, Info) ->
%% Duration is time from receiving request to responding
{ResponseUsecs, Stages} = riak_kv_fsm_timing:calc_timing(Timing),
client_info(Rest, StateData, [{response_usecs, ResponseUsecs},
{stages, Stages} | Info]).
default_details() ->
[timing].
%% Add timing information to the state
add_timing(Stage, State = #state{timing = Timing}) ->
State#state{timing = riak_kv_fsm_timing:add_timing(Stage, Timing)}.
atom2list(A) when is_atom(A) ->
atom_to_list(A);
atom2list(P) when is_pid(P)->
pid_to_list(P). % eunit tests
dtrace_errstr(Term) ->
io_lib:format("~P", [Term, 12]).
%% This function is for dbg tracing purposes
late_put_fsm_coordinator_ack(_Node) ->
ok.
-spec get_bucket_props(riak_object:bucket()) -> list().
get_bucket_props(Bucket) ->
{ok, DefaultProps} = application:get_env(riak_core, default_bucket_props),
BucketProps = riak_core_bucket:get_bucket(Bucket),
%% typed buckets never fall back to defaults
case is_tuple(Bucket) of
false ->
lists:keymerge(
1,
lists:keysort(1, BucketProps),