1 /*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "single_ver_sync_state_machine.h"
17
18 #include <cmath>
19 #include <climits>
20 #include <algorithm>
21
22 #include "db_errno.h"
23 #include "log_print.h"
24 #include "sync_operation.h"
25 #include "message_transform.h"
26 #include "sync_types.h"
27 #include "db_common.h"
28 #include "runtime_context.h"
29 #include "performance_analysis.h"
30 #include "single_ver_sync_target.h"
31 #include "single_ver_data_sync.h"
32 #include "single_ver_data_sync_utils.h"
33
34 namespace DistributedDB {
35 using Event = SingleVerSyncStateMachine::Event;
36 using State = SingleVerSyncStateMachine::State;
37 namespace {
38 // used for state switch table
39 const int CURRENT_STATE_INDEX = 0;
40 const int EVENT_INDEX = 1;
41 const int OUTPUT_STATE_INDEX = 2;
42
43 // drop v1 and v2 table by one optimize, dataSend mode in all version go with slide window mode.
44 // State switch table v3, has three columns, CurrentState, Event, and OutSate
45 const std::vector<std::vector<uint8_t>> STATE_SWITCH_TABLE_V3 = {
46 {State::IDLE, Event::START_SYNC_EVENT, State::TIME_SYNC},
47
48 // In TIME_SYNC state
49 {State::TIME_SYNC, Event::TIME_SYNC_FINISHED_EVENT, State::ABILITY_SYNC},
50 {State::TIME_SYNC, Event::TIME_OUT_EVENT, State::SYNC_TIME_OUT},
51 {State::TIME_SYNC, Event::INNER_ERR_EVENT, State::INNER_ERR},
52
53 // In ABILITY_SYNC state, compare version num and schema
54 {State::ABILITY_SYNC, Event::VERSION_NOT_SUPPOR_EVENT, State::INNER_ERR},
55 {State::ABILITY_SYNC, Event::ABILITY_SYNC_FINISHED_EVENT, State::START_INITIACTIVE_DATA_SYNC},
56 {State::ABILITY_SYNC, Event::TIME_OUT_EVENT, State::SYNC_TIME_OUT},
57 {State::ABILITY_SYNC, Event::INNER_ERR_EVENT, State::INNER_ERR},
58 {State::ABILITY_SYNC, Event::CONTROL_CMD_EVENT, State::SYNC_CONTROL_CMD},
59
60 // In START_INITIACTIVE_DATA_SYNC state, send a sync request, and send first packt of data sync
61 {State::START_INITIACTIVE_DATA_SYNC, Event::NEED_ABILITY_SYNC_EVENT, State::ABILITY_SYNC},
62 {State::START_INITIACTIVE_DATA_SYNC, Event::TIME_OUT_EVENT, State::SYNC_TIME_OUT},
63 {State::START_INITIACTIVE_DATA_SYNC, Event::INNER_ERR_EVENT, State::INNER_ERR},
64 {State::START_INITIACTIVE_DATA_SYNC, Event::SEND_FINISHED_EVENT, State::START_PASSIVE_DATA_SYNC},
65 {State::START_INITIACTIVE_DATA_SYNC, Event::RE_SEND_DATA_EVENT, State::START_INITIACTIVE_DATA_SYNC},
66 {State::START_INITIACTIVE_DATA_SYNC, Event::NEED_TIME_SYNC_EVENT, State::TIME_SYNC},
67
68 // In START_PASSIVE_DATA_SYNC state, do response pull request, and send first packt of data sync
69 {State::START_PASSIVE_DATA_SYNC, Event::SEND_FINISHED_EVENT, State::START_PASSIVE_DATA_SYNC},
70 {State::START_PASSIVE_DATA_SYNC, Event::RESPONSE_TASK_FINISHED_EVENT, State::WAIT_FOR_RECEIVE_DATA_FINISH},
71 {State::START_PASSIVE_DATA_SYNC, Event::TIME_OUT_EVENT, State::SYNC_TIME_OUT},
72 {State::START_PASSIVE_DATA_SYNC, Event::INNER_ERR_EVENT, State::INNER_ERR},
73 {State::START_PASSIVE_DATA_SYNC, Event::NEED_ABILITY_SYNC_EVENT, State::ABILITY_SYNC},
74 {State::START_PASSIVE_DATA_SYNC, Event::RE_SEND_DATA_EVENT, State::START_PASSIVE_DATA_SYNC},
75 {State::START_PASSIVE_DATA_SYNC, Event::NEED_TIME_SYNC_EVENT, State::TIME_SYNC},
76
77 // In WAIT_FOR_RECEIVE_DATA_FINISH,
78 {State::WAIT_FOR_RECEIVE_DATA_FINISH, Event::RECV_FINISHED_EVENT, State::SYNC_TASK_FINISHED},
79 {State::WAIT_FOR_RECEIVE_DATA_FINISH, Event::START_PULL_RESPONSE_EVENT, State::START_PASSIVE_DATA_SYNC},
80 {State::WAIT_FOR_RECEIVE_DATA_FINISH, Event::TIME_OUT_EVENT, State::SYNC_TIME_OUT},
81 {State::WAIT_FOR_RECEIVE_DATA_FINISH, Event::INNER_ERR_EVENT, State::INNER_ERR},
82 {State::WAIT_FOR_RECEIVE_DATA_FINISH, Event::NEED_ABILITY_SYNC_EVENT, State::ABILITY_SYNC},
83
84 {State::SYNC_CONTROL_CMD, Event::SEND_FINISHED_EVENT, State::SYNC_TASK_FINISHED},
85 {State::SYNC_CONTROL_CMD, Event::TIME_OUT_EVENT, State::SYNC_TIME_OUT},
86 {State::SYNC_CONTROL_CMD, Event::INNER_ERR_EVENT, State::INNER_ERR},
87 {State::SYNC_CONTROL_CMD, Event::NEED_ABILITY_SYNC_EVENT, State::ABILITY_SYNC},
88
89 // In SYNC_TASK_FINISHED,
90 {State::SYNC_TASK_FINISHED, Event::ALL_TASK_FINISHED_EVENT, State::IDLE},
91 {State::SYNC_TASK_FINISHED, Event::START_SYNC_EVENT, State::TIME_SYNC},
92
93 // SYNC_TIME_OUT and INNE_ERR state, just do some exception resolve
94 {State::SYNC_TIME_OUT, Event::ANY_EVENT, State::SYNC_TASK_FINISHED},
95 {State::INNER_ERR, Event::ANY_EVENT, State::SYNC_TASK_FINISHED},
96 };
97 }
98
99 std::mutex SingleVerSyncStateMachine::stateSwitchTableLock_;
100 std::vector<StateSwitchTable> SingleVerSyncStateMachine::stateSwitchTables_;
101 bool SingleVerSyncStateMachine::isStateSwitchTableInited_ = false;
102
SingleVerSyncStateMachine()103 SingleVerSyncStateMachine::SingleVerSyncStateMachine()
104 : context_(nullptr),
105 syncInterface_(nullptr),
106 timeSync_(nullptr),
107 abilitySync_(nullptr),
108 dataSync_(nullptr),
109 currentRemoteVersionId_(0)
110 {
111 }
112
~SingleVerSyncStateMachine()113 SingleVerSyncStateMachine::~SingleVerSyncStateMachine()
114 {
115 LOGD("~SingleVerSyncStateMachine");
116 Clear();
117 }
118
Initialize(ISyncTaskContext * context,ISyncInterface * syncInterface,const std::shared_ptr<Metadata> & metaData,ICommunicator * communicator)119 int SingleVerSyncStateMachine::Initialize(ISyncTaskContext *context, ISyncInterface *syncInterface,
120 const std::shared_ptr<Metadata> &metaData, ICommunicator *communicator)
121 {
122 if ((context == nullptr) || (syncInterface == nullptr) || (metaData == nullptr) || (communicator == nullptr)) {
123 return -E_INVALID_ARGS;
124 }
125
126 int errCode = SyncStateMachine::Initialize(context, syncInterface, metaData, communicator);
127 if (errCode != E_OK) {
128 return errCode;
129 }
130
131 timeSync_ = std::make_shared<TimeSync>();
132 dataSync_ = std::make_shared<SingleVerDataSync>();
133 abilitySync_ = std::make_unique<AbilitySync>();
134 if ((timeSync_ == nullptr) || (dataSync_ == nullptr) || (abilitySync_ == nullptr)) {
135 timeSync_ = nullptr;
136 dataSync_ = nullptr;
137 abilitySync_ = nullptr;
138 return -E_OUT_OF_MEMORY;
139 }
140
141 errCode = timeSync_->Initialize(communicator, metaData, syncInterface, context->GetDeviceId());
142 if (errCode != E_OK) {
143 goto ERROR_OUT;
144 }
145 errCode = dataSync_->Initialize(syncInterface, communicator, metaData, context->GetDeviceId());
146 if (errCode != E_OK) {
147 goto ERROR_OUT;
148 }
149 errCode = abilitySync_->Initialize(communicator, syncInterface, metaData, context->GetDeviceId());
150 if (errCode != E_OK) {
151 goto ERROR_OUT;
152 }
153 abilitySync_->InitAbilitySyncFinishStatus(*context);
154
155 currentState_ = IDLE;
156 context_ = static_cast<SingleVerSyncTaskContext *>(context);
157 syncInterface_ = static_cast<SyncGenericInterface *>(syncInterface);
158
159 InitStateSwitchTables();
160 InitStateMapping();
161 return E_OK;
162
163 ERROR_OUT:
164 Clear();
165 return errCode;
166 }
167
SyncStep()168 void SingleVerSyncStateMachine::SyncStep()
169 {
170 RefObject::IncObjRef(context_);
171 RefObject::IncObjRef(communicator_);
172 int errCode = RuntimeContext::GetInstance()->ScheduleTask([this] { SyncStepInnerLocked(); });
173 if (errCode != E_OK) {
174 LOGE("[StateMachine][SyncStep] Schedule SyncStep failed");
175 RefObject::DecObjRef(communicator_);
176 RefObject::DecObjRef(context_);
177 }
178 }
179
ReceiveMessageCallback(Message * inMsg)180 int SingleVerSyncStateMachine::ReceiveMessageCallback(Message *inMsg)
181 {
182 int errCode = MessageCallbackPre(inMsg);
183 if (errCode != E_OK) {
184 LOGE("[StateMachine] message pre check failed");
185 return errCode;
186 }
187 switch (inMsg->GetMessageId()) {
188 case TIME_SYNC_MESSAGE:
189 errCode = TimeMarkSyncRecv(inMsg);
190 break;
191 case ABILITY_SYNC_MESSAGE:
192 errCode = AbilitySyncRecv(inMsg);
193 break;
194 case DATA_SYNC_MESSAGE:
195 case QUERY_SYNC_MESSAGE:
196 errCode = DataPktRecv(inMsg);
197 break;
198 case CONTROL_SYNC_MESSAGE:
199 errCode = ControlPktRecv(inMsg);
200 break;
201 default:
202 errCode = -E_NOT_SUPPORT;
203 }
204 return errCode;
205 }
206
SyncStepInnerLocked()207 void SingleVerSyncStateMachine::SyncStepInnerLocked()
208 {
209 if (context_->IncUsedCount() != E_OK) {
210 goto SYNC_STEP_OUT;
211 }
212 {
213 std::lock_guard<std::mutex> lock(stateMachineLock_);
214 SyncStepInner();
215 }
216 context_->SafeExit();
217
218 SYNC_STEP_OUT:
219 RefObject::DecObjRef(communicator_);
220 RefObject::DecObjRef(context_);
221 }
222
SyncStepInner()223 void SingleVerSyncStateMachine::SyncStepInner()
224 {
225 Event event = INNER_ERR_EVENT;
226 do {
227 auto iter = stateMapping_.find(currentState_);
228 if (iter != stateMapping_.end()) {
229 event = static_cast<Event>(iter->second());
230 } else {
231 LOGE("[StateMachine][SyncStepInner] can not find state=%d,label=%s,dev=%s", currentState_,
232 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
233 break;
234 }
235 } while (event != Event::WAIT_ACK_EVENT && SwitchMachineState(event) == E_OK && currentState_ != IDLE);
236 }
237
SetCurStateErrStatus()238 void SingleVerSyncStateMachine::SetCurStateErrStatus()
239 {
240 currentState_ = State::INNER_ERR;
241 }
242
StartSyncInner()243 int SingleVerSyncStateMachine::StartSyncInner()
244 {
245 PerformanceAnalysis *performance = PerformanceAnalysis::GetInstance();
246 if (performance != nullptr) {
247 performance->StepTimeRecordStart(PT_TEST_RECORDS::RECORD_MACHINE_START_TO_PUSH_SEND);
248 }
249 int errCode = PrepareNextSyncTask();
250 if (errCode == E_OK) {
251 SwitchStateAndStep(Event::START_SYNC_EVENT);
252 }
253 return errCode;
254 }
255
AbortInner()256 void SingleVerSyncStateMachine::AbortInner()
257 {
258 LOGE("[StateMachine][AbortInner] error occurred,abort,label=%s,dev=%s", dataSync_->GetLabel().c_str(),
259 STR_MASK(context_->GetDeviceId()));
260 if (context_->IsKilled()) {
261 dataSync_->ClearDataMsg();
262 }
263 dataSync_->ClearSyncStatus();
264 ContinueToken token;
265 context_->GetContinueToken(token);
266 if (token != nullptr) {
267 syncInterface_->ReleaseContinueToken(token);
268 }
269 context_->SetContinueToken(nullptr);
270 context_->Clear();
271 }
272
GetStateSwitchTables() const273 const std::vector<StateSwitchTable> &SingleVerSyncStateMachine::GetStateSwitchTables() const
274 {
275 return stateSwitchTables_;
276 }
277
PrepareNextSyncTask()278 int SingleVerSyncStateMachine::PrepareNextSyncTask()
279 {
280 int errCode = StartWatchDog();
281 if (errCode != E_OK && errCode != -E_UNEXPECTED_DATA) {
282 LOGE("[StateMachine][PrepareNextSyncTask] WatchDog start failed,err=%d", errCode);
283 return errCode;
284 }
285 if (errCode == -E_UNEXPECTED_DATA) {
286 LOGI("[PrepareNextSyncTask] timer already exists, reset the timer.");
287 (void)ResetWatchDog();
288 }
289
290 if (currentState_ != State::IDLE && currentState_ != State::SYNC_TASK_FINISHED) {
291 LOGW("[StateMachine][PrepareNextSyncTask] PreSync may get an err, state=%" PRIu8 ",dev=%s",
292 currentState_, STR_MASK(context_->GetDeviceId()));
293 currentState_ = State::IDLE;
294 }
295 return E_OK;
296 }
297
SendNotifyPacket(uint32_t sessionId,uint32_t sequenceId,uint32_t inMsgId)298 void SingleVerSyncStateMachine::SendNotifyPacket(uint32_t sessionId, uint32_t sequenceId, uint32_t inMsgId)
299 {
300 dataSync_->SendSaveDataNotifyPacket(context_,
301 std::min(context_->GetRemoteSoftwareVersion(), SOFTWARE_VERSION_CURRENT), sessionId, sequenceId, inMsgId);
302 }
303
CommErrAbort(uint32_t sessionId)304 void SingleVerSyncStateMachine::CommErrAbort(uint32_t sessionId)
305 {
306 std::lock_guard<std::mutex> lock(stateMachineLock_);
307 uint32_t requestSessionId = context_->GetRequestSessionId();
308 if ((sessionId != 0) && ((requestSessionId == 0) || (sessionId != requestSessionId))) {
309 return;
310 }
311 context_->SetCommNormal(false);
312 if (SwitchMachineState(Event::INNER_ERR_EVENT) == E_OK) {
313 SyncStep();
314 }
315 }
316
InitStateSwitchTables()317 void SingleVerSyncStateMachine::InitStateSwitchTables()
318 {
319 if (isStateSwitchTableInited_) {
320 return;
321 }
322
323 std::lock_guard<std::mutex> lock(stateSwitchTableLock_);
324 if (isStateSwitchTableInited_) {
325 return;
326 }
327
328 InitStateSwitchTable(SINGLE_VER_SYNC_PROCTOL_V3, STATE_SWITCH_TABLE_V3);
329 std::sort(stateSwitchTables_.begin(), stateSwitchTables_.end(),
330 [](const auto &tableA, const auto &tableB) {
331 return tableA.version > tableB.version;
332 }); // descending
333 isStateSwitchTableInited_ = true;
334 }
335
InitStateSwitchTable(uint32_t version,const std::vector<std::vector<uint8_t>> & switchTable)336 void SingleVerSyncStateMachine::InitStateSwitchTable(uint32_t version,
337 const std::vector<std::vector<uint8_t>> &switchTable)
338 {
339 StateSwitchTable table;
340 table.version = version;
341 for (const auto &stateSwitch : switchTable) {
342 if (stateSwitch.size() <= OUTPUT_STATE_INDEX) {
343 LOGE("[StateMachine][InitSwitchTable] stateSwitch size err,size=%zu", stateSwitch.size());
344 return;
345 }
346 if (table.switchTable.count(stateSwitch[CURRENT_STATE_INDEX]) == 0) {
347 EventToState eventToState; // new EventToState
348 eventToState[stateSwitch[EVENT_INDEX]] = stateSwitch[OUTPUT_STATE_INDEX];
349 table.switchTable[stateSwitch[CURRENT_STATE_INDEX]] = eventToState;
350 } else { // key stateSwitch[CURRENT_STATE_INDEX] already has EventToState
351 EventToState &eventToState = table.switchTable[stateSwitch[CURRENT_STATE_INDEX]];
352 eventToState[stateSwitch[EVENT_INDEX]] = stateSwitch[OUTPUT_STATE_INDEX];
353 }
354 }
355 stateSwitchTables_.push_back(table);
356 }
357
InitStateMapping()358 void SingleVerSyncStateMachine::InitStateMapping()
359 {
360 stateMapping_[TIME_SYNC] = [this] { return DoTimeSync(); };
361 stateMapping_[ABILITY_SYNC] = [this] { return DoAbilitySync(); };
362 stateMapping_[WAIT_FOR_RECEIVE_DATA_FINISH] = [this] { return DoWaitForDataRecv(); };
363 stateMapping_[SYNC_TASK_FINISHED] = [this] { return DoSyncTaskFinished(); };
364 stateMapping_[SYNC_TIME_OUT] = [this] { return DoTimeout(); };
365 stateMapping_[INNER_ERR] = [this] { return DoInnerErr(); };
366 stateMapping_[START_INITIACTIVE_DATA_SYNC] = [this] { return DoInitiactiveDataSyncWithSlidingWindow(); };
367 stateMapping_[START_PASSIVE_DATA_SYNC] = [this] { return DoPassiveDataSyncWithSlidingWindow(); };
368 stateMapping_[SYNC_CONTROL_CMD] = [this] { return DoInitiactiveControlSync(); };
369 }
370
DoInitiactiveDataSyncWithSlidingWindow() const371 Event SingleVerSyncStateMachine::DoInitiactiveDataSyncWithSlidingWindow() const
372 {
373 LOGD("[StateMachine][activeDataSync] mode=%d,label=%s,dev=%s", context_->GetMode(),
374 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
375 int errCode = E_OK;
376 switch (context_->GetMode()) {
377 case SyncModeType::PUSH:
378 case SyncModeType::QUERY_PUSH:
379 context_->SetOperationStatus(SyncOperation::OP_RECV_FINISHED);
380 errCode = dataSync_->SyncStart(context_->GetMode(), context_);
381 break;
382 case SyncModeType::PULL:
383 case SyncModeType::QUERY_PULL:
384 context_->SetOperationStatus(SyncOperation::OP_SEND_FINISHED);
385 errCode = dataSync_->SyncStart(context_->GetMode(), context_);
386 break;
387 case SyncModeType::PUSH_AND_PULL:
388 case SyncModeType::QUERY_PUSH_PULL:
389 errCode = dataSync_->SyncStart(context_->GetMode(), context_);
390 break;
391 case SyncModeType::RESPONSE_PULL:
392 errCode = dataSync_->SyncStart(context_->GetMode(), context_);
393 break;
394 default:
395 errCode = -E_NOT_SUPPORT;
396 break;
397 }
398 if (errCode == E_OK) {
399 return Event::WAIT_ACK_EVENT;
400 }
401 // once E_EKEYREVOKED error occurred, PUSH_AND_PULL mode should wait for ack to pull remote data.
402 if (SyncOperation::TransferSyncMode(context_->GetMode()) == SyncModeType::PUSH_AND_PULL &&
403 errCode == -E_EKEYREVOKED) {
404 return Event::WAIT_ACK_EVENT;
405 }
406
407 // when response task step dataSync again while request task is running, ignore the errCode
408 bool ignoreInnerErr = (context_->GetResponseSessionId() != 0 && context_->GetRequestSessionId() != 0);
409 Event event = TransformErrCodeToEvent(errCode);
410 return (ignoreInnerErr && event == INNER_ERR_EVENT) ? SEND_FINISHED_EVENT : event;
411 }
412
DoPassiveDataSyncWithSlidingWindow()413 Event SingleVerSyncStateMachine::DoPassiveDataSyncWithSlidingWindow()
414 {
415 {
416 RefObject::AutoLock lock(context_);
417 if (context_->GetRspTargetQueueSize() != 0) {
418 PreStartPullResponse();
419 } else if (context_->GetResponseSessionId() == 0 ||
420 context_->GetRetryStatus() == static_cast<int>(SyncTaskContext::NO_NEED_RETRY)) {
421 return RESPONSE_TASK_FINISHED_EVENT;
422 }
423 }
424 int errCode = dataSync_->SyncStart(SyncModeType::RESPONSE_PULL, context_);
425 if (errCode != E_OK) {
426 LOGE("[SingleVerSyncStateMachine][DoPassiveDataSyncWithSlidingWindow] response pull send failed[%d]", errCode);
427 return RESPONSE_TASK_FINISHED_EVENT;
428 }
429 return Event::WAIT_ACK_EVENT;
430 }
431
DoInitiactiveControlSync() const432 Event SingleVerSyncStateMachine::DoInitiactiveControlSync() const
433 {
434 LOGD("[StateMachine][activeControlSync] mode=%d,label=%s,dev=%s", context_->GetMode(),
435 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
436 context_->SetOperationStatus(SyncOperation::OP_RECV_FINISHED);
437 int errCode = dataSync_->ControlCmdStart(context_);
438 if (errCode == E_OK) {
439 return Event::WAIT_ACK_EVENT;
440 }
441 context_->SetTaskErrCode(errCode);
442 return TransformErrCodeToEvent(errCode);
443 }
444
HandleControlAckRecv(const Message * inMsg)445 int SingleVerSyncStateMachine::HandleControlAckRecv(const Message *inMsg)
446 {
447 std::lock_guard<std::mutex> lock(stateMachineLock_);
448 if (IsNeedResetWatchdog(inMsg)) {
449 (void)ResetWatchDog();
450 }
451 int errCode = dataSync_->ControlCmdAckRecv(context_, inMsg);
452 ControlAckRecvErrCodeHandle(errCode);
453 SwitchStateAndStep(TransformErrCodeToEvent(errCode));
454 return E_OK;
455 }
456
DoWaitForDataRecv() const457 Event SingleVerSyncStateMachine::DoWaitForDataRecv() const
458 {
459 if (context_->GetRspTargetQueueSize() != 0) {
460 return START_PULL_RESPONSE_EVENT;
461 }
462 if (context_->GetOperationStatus() == SyncOperation::OP_FINISHED_ALL) {
463 return RECV_FINISHED_EVENT;
464 }
465 if (SyncOperation::TransferSyncMode(context_->GetMode()) == SyncModeType::PUSH_AND_PULL &&
466 context_->GetOperationStatus() == SyncOperation::OP_EKEYREVOKED_FAILURE &&
467 context_->GetRemoteSoftwareVersion() > SOFTWARE_VERSION_RELEASE_2_0) {
468 return RECV_FINISHED_EVENT;
469 }
470 return Event::WAIT_ACK_EVENT;
471 }
472
DoTimeSync() const473 Event SingleVerSyncStateMachine::DoTimeSync() const
474 {
475 timeSync_->SetTimeSyncFinishIfNeed();
476 if (timeSync_->IsNeedSync()) {
477 CommErrHandler handler = nullptr;
478 // Auto sync need do retry don't use errHandler to return.
479 if (!context_->IsAutoSync()) {
480 handler = [this, context = context_, requestSessionId = context_->GetRequestSessionId()](int ret) {
481 SyncTaskContext::CommErrHandlerFunc(ret, context, requestSessionId);
482 };
483 }
484 int errCode = timeSync_->SyncStart(handler, context_->GetRequestSessionId());
485 if (errCode == E_OK) {
486 return Event::WAIT_ACK_EVENT;
487 }
488 context_->SetTaskErrCode(errCode);
489 return TransformErrCodeToEvent(errCode);
490 }
491
492 return Event::TIME_SYNC_FINISHED_EVENT;
493 }
494
DoAbilitySync() const495 Event SingleVerSyncStateMachine::DoAbilitySync() const
496 {
497 uint16_t remoteCommunicatorVersion = 0;
498 int errCode = communicator_->GetRemoteCommunicatorVersion(context_->GetDeviceId(), remoteCommunicatorVersion);
499 if (errCode != E_OK && errCode != -E_NOT_FOUND) {
500 LOGE("[StateMachine][DoAbilitySync] Get RemoteCommunicatorVersion errCode=%d", errCode);
501 return Event::INNER_ERR_EVENT;
502 }
503 // Fistr version, not support AbilitySync
504 if (remoteCommunicatorVersion == 0 && errCode != -E_NOT_FOUND) {
505 context_->SetRemoteSoftwareVersion(SOFTWARE_VERSION_EARLIEST);
506 return GetEventAfterTimeSync(context_->GetMode());
507 }
508 if (abilitySync_->GetAbilitySyncFinishedStatus()) {
509 return GetEventAfterTimeSync(context_->GetMode());
510 }
511
512 CommErrHandler handler = [this, context = context_, requestSessionId = context_->GetRequestSessionId()](int ret) {
513 SyncTaskContext::CommErrHandlerFunc(ret, context, requestSessionId);
514 };
515 LOGI("[StateMachine][AbilitySync] start abilitySync,label=%s,dev=%s", dataSync_->GetLabel().c_str(),
516 STR_MASK(context_->GetDeviceId()));
517 errCode = abilitySync_->SyncStart(context_->GetRequestSessionId(), context_->GetSequenceId(),
518 remoteCommunicatorVersion, handler, context_);
519 if (errCode != E_OK) {
520 LOGE("[StateMachine][DoAbilitySync] ability sync start failed,errCode=%d", errCode);
521 return TransformErrCodeToEvent(errCode);
522 }
523 return Event::WAIT_ACK_EVENT;
524 }
525
GetEventAfterTimeSync(int mode) const526 Event SingleVerSyncStateMachine::GetEventAfterTimeSync(int mode) const
527 {
528 if (mode == SyncModeType::SUBSCRIBE_QUERY || mode == SyncModeType::UNSUBSCRIBE_QUERY) {
529 return Event::CONTROL_CMD_EVENT;
530 }
531 return Event::ABILITY_SYNC_FINISHED_EVENT;
532 }
533
DoSyncTaskFinished()534 Event SingleVerSyncStateMachine::DoSyncTaskFinished()
535 {
536 StopWatchDog();
537 dataSync_->ClearSyncStatus();
538 RefObject::AutoLock lock(syncContext_);
539 int errCode = ExecNextTask();
540 if (errCode == E_OK) {
541 return Event::START_SYNC_EVENT;
542 }
543 return TransformErrCodeToEvent(errCode);
544 }
545
DoTimeout()546 Event SingleVerSyncStateMachine::DoTimeout()
547 {
548 RefObject::AutoLock lock(context_);
549 if (context_->GetMode() == SyncModeType::SUBSCRIBE_QUERY) {
550 std::shared_ptr<SubscribeManager> subManager = context_->GetSubscribeManager();
551 if (subManager != nullptr) {
552 subManager->DeleteLocalSubscribeQuery(context_->GetDeviceId(), context_->GetQuery());
553 }
554 }
555 context_->Abort(SyncOperation::OP_TIMEOUT);
556 context_->Clear();
557 AbortInner();
558 return Event::ANY_EVENT;
559 }
560
DoInnerErr()561 Event SingleVerSyncStateMachine::DoInnerErr()
562 {
563 RefObject::AutoLock lock(context_);
564 if (!context_->IsCommNormal()) {
565 if (context_->GetMode() == SyncModeType::SUBSCRIBE_QUERY) {
566 std::shared_ptr<SubscribeManager> subManager = context_->GetSubscribeManager();
567 if (subManager != nullptr) {
568 subManager->DeleteLocalSubscribeQuery(context_->GetDeviceId(), context_->GetQuery());
569 }
570 }
571 context_->Abort(SyncOperation::OP_COMM_ABNORMAL);
572 } else {
573 int status = GetSyncOperationStatus(context_->GetTaskErrCode());
574 context_->Abort(status);
575 }
576 context_->Clear();
577 AbortInner();
578 return Event::ANY_EVENT;
579 }
580
AbilitySyncRecv(const Message * inMsg)581 int SingleVerSyncStateMachine::AbilitySyncRecv(const Message *inMsg)
582 {
583 if (inMsg->GetMessageType() == TYPE_REQUEST) {
584 int errCode = abilitySync_->RequestRecv(inMsg, context_);
585 if (errCode != E_OK && inMsg->GetSessionId() == context_->GetResponseSessionId()) {
586 context_->SetTaskErrCode(errCode);
587 std::lock_guard<std::mutex> lock(stateMachineLock_);
588 SwitchStateAndStep(Event::INNER_ERR_EVENT);
589 }
590 return E_OK;
591 }
592 return AbilitySyncResponseRecv(inMsg);
593 }
594
AbilitySyncResponseRecv(const Message * inMsg)595 int SingleVerSyncStateMachine::AbilitySyncResponseRecv(const Message *inMsg)
596 {
597 if (inMsg->GetMessageType() == TYPE_RESPONSE && AbilityMsgSessionIdCheck(inMsg)) {
598 std::lock_guard<std::mutex> lock(stateMachineLock_);
599 int errCode = abilitySync_->AckRecv(inMsg, context_);
600 (void)ResetWatchDog();
601 if (errCode == -E_ABILITY_SYNC_FINISHED) {
602 LOGI("[StateMachine][AbilitySyncRecv] ability sync finished with both kv,label=%s,dev=%s",
603 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
604 abilitySync_->SetAbilitySyncFinishedStatus(true, *context_);
605 JumpStatusAfterAbilitySync(context_->GetMode());
606 } else if (errCode != E_OK) {
607 LOGE("[StateMachine][AbilitySyncRecv] handle ackRecv failed,errCode=%d", errCode);
608 SwitchStateAndStep(TransformErrCodeToEvent(errCode));
609 } else if (context_->GetRemoteSoftwareVersion() <= SOFTWARE_VERSION_RELEASE_2_0) {
610 abilitySync_->SetAbilitySyncFinishedStatus(true, *context_);
611 LOGI("[StateMachine][AbilitySyncRecv] ability Sync Finished,label=%s,dev=%s",
612 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
613 currentRemoteVersionId_ = context_->GetRemoteSoftwareVersionId();
614 JumpStatusAfterAbilitySync(context_->GetMode());
615 }
616 return E_OK;
617 }
618 if (inMsg->GetMessageType() == TYPE_NOTIFY) {
619 return AbilitySyncNotifyRecv(inMsg);
620 }
621 LOGE("[StateMachine][AbilitySyncRecv] msg type invalid");
622 return -E_NOT_SUPPORT;
623 }
624
HandleDataRequestRecv(const Message * inMsg)625 int SingleVerSyncStateMachine::HandleDataRequestRecv(const Message *inMsg)
626 {
627 TimeOffset offset = 0;
628 auto [systemOffset, senderLocalOffset] = SingleVerDataSyncUtils::GetTimeOffsetFromRequestMsg(inMsg);
629 int errCode = timeSync_->GenerateTimeOffsetIfNeed(systemOffset, senderLocalOffset);
630 if (errCode != E_OK) {
631 (void)dataSync_->SendDataAck(context_, inMsg, errCode, 0);
632 return errCode;
633 }
634 uint32_t timeout = communicator_->GetTimeout(context_->GetDeviceId());
635 // If message is data sync request, we should check timeoffset.
636 errCode = timeSync_->GetTimeOffset(offset, timeout);
637 if (errCode != E_OK) {
638 LOGE("[StateMachine][HandleDataRequestRecv] GetTimeOffset err! errCode=%d", errCode);
639 return errCode;
640 }
641 context_->SetTimeOffset(offset);
642 PerformanceAnalysis *performance = PerformanceAnalysis::GetInstance();
643 if (performance != nullptr) {
644 performance->StepTimeRecordStart(PT_TEST_RECORDS::RECORD_DATA_REQUEST_RECV_TO_SEND_ACK);
645 }
646 DecRefCountOfFeedDogTimer(SyncDirectionFlag::RECEIVE);
647
648 // RequestRecv will save data, it may cost a long time.
649 // So we need to send save data notify to keep remote alive.
650 bool isNeedStop = StartSaveDataNotify(inMsg->GetSessionId(), inMsg->GetSequenceId(), inMsg->GetMessageId());
651 {
652 std::lock_guard<std::mutex> lockWatchDog(stateMachineLock_);
653 if (IsNeedResetWatchdog(inMsg)) {
654 (void)ResetWatchDog();
655 }
656 }
657 WaterMark pullEndWaterkark = 0;
658 errCode = dataSync_->DataRequestRecv(context_, inMsg, pullEndWaterkark);
659 if (performance != nullptr) {
660 performance->StepTimeRecordEnd(PT_TEST_RECORDS::RECORD_DATA_REQUEST_RECV_TO_SEND_ACK);
661 }
662 // only higher than 102 version receive this errCode here.
663 // while both RequestSessionId is not equal,but get this errCode;slwr would seem to handle first secquencid.
664 // so while receive the same secquencid after abiitysync it wouldn't handle.
665 if (errCode == -E_NEED_ABILITY_SYNC) {
666 if (isNeedStop) {
667 StopSaveDataNotify();
668 }
669 return errCode;
670 }
671 {
672 std::lock_guard<std::mutex> lock(stateMachineLock_);
673 DataRecvErrCodeHandle(inMsg->GetSessionId(), errCode);
674 if (pullEndWaterkark > 0) {
675 AddPullResponseTarget(inMsg, pullEndWaterkark);
676 }
677 }
678 if (isNeedStop) {
679 StopSaveDataNotify();
680 }
681 return E_OK;
682 }
683
HandleDataAckRecvWithSlidingWindow(int errCode,const Message * inMsg,bool ignoreInnerErr)684 void SingleVerSyncStateMachine::HandleDataAckRecvWithSlidingWindow(int errCode, const Message *inMsg,
685 bool ignoreInnerErr)
686 {
687 if (errCode == -E_RE_SEND_DATA) { // LOCAL_WATER_MARK_NOT_INIT
688 dataSync_->ClearSyncStatus();
689 }
690 if (errCode == -E_NO_DATA_SEND || errCode == -E_SEND_DATA) {
691 int ret = dataSync_->TryContinueSync(context_, inMsg);
692 if (ret == -E_FINISHED) {
693 SwitchStateAndStep(Event::SEND_FINISHED_EVENT);
694 return;
695 } else if (ret == E_OK) { // do nothing and waiting for all ack receive
696 return;
697 }
698 errCode = ret;
699 }
700 ResponsePullError(errCode, ignoreInnerErr);
701 }
702
NeedAbilitySyncHandle()703 void SingleVerSyncStateMachine::NeedAbilitySyncHandle()
704 {
705 // if the remote device version num is overdue,
706 // mean the version num has been reset when syncing data,
707 // there should not clear the new version cache again.
708 if (currentRemoteVersionId_ == context_->GetRemoteSoftwareVersionId()) {
709 LOGI("[StateMachine] set remote version 0, currentRemoteVersionId_ = %" PRIu64, currentRemoteVersionId_);
710 context_->SetRemoteSoftwareVersion(0);
711 } else {
712 currentRemoteVersionId_ = context_->GetRemoteSoftwareVersionId();
713 }
714 abilitySync_->SetAbilitySyncFinishedStatus(false, *context_);
715 }
716
HandleDataAckRecv(const Message * inMsg)717 int SingleVerSyncStateMachine::HandleDataAckRecv(const Message *inMsg)
718 {
719 if (inMsg->GetMessageType() == TYPE_RESPONSE) {
720 DecRefCountOfFeedDogTimer(SyncDirectionFlag::SEND);
721 }
722 std::lock_guard<std::mutex> lock(stateMachineLock_);
723 // Unfortunately we use stateMachineLock_ in many sync process
724 // So a bad ack will check before the lock and wait
725 // And then another process is running, it will get the lock.After this process, the ack became invalid.
726 // If we don't check ack again, it will be delivered to dataSyncer.
727 if (!IsPacketValid(inMsg)) {
728 return -E_INVALID_ARGS;
729 }
730 if (IsNeedResetWatchdog(inMsg)) {
731 (void)ResetWatchDog();
732 }
733 if (context_->GetRemoteSoftwareVersion() > SOFTWARE_VERSION_RELEASE_2_0 && !dataSync_->AckPacketIdCheck(inMsg)) {
734 // packetId not match but sequence id matched scene, means resend map has be rebuilt
735 // this is old ack, should be dropped and wait for the same packetId sequence.
736 return E_OK;
737 }
738 // AckRecv will save meta data, it may cost a long time. if another thread is saving data
739 // So we need to send save data notify to keep remote alive.
740 // e.g. remote do pull sync
741 bool isNeedStop = StartSaveDataNotify(inMsg->GetSessionId(), inMsg->GetSequenceId(), inMsg->GetMessageId());
742 int errCode = dataSync_->AckRecv(context_, inMsg);
743 if (isNeedStop) {
744 StopSaveDataNotify();
745 }
746 if (errCode == -E_NEED_ABILITY_SYNC || errCode == -E_RE_SEND_DATA || errCode == -E_NEED_TIME_SYNC) {
747 StopFeedDogForSync(SyncDirectionFlag::SEND);
748 } else if (errCode == -E_SAVE_DATA_NOTIFY) {
749 return errCode;
750 }
751 // when this msg is from response task while request task is running, ignore the errCode
752 bool ignoreInnerErr = inMsg->GetSessionId() == context_->GetResponseSessionId() &&
753 context_->GetRequestSessionId() != 0;
754 DataAckRecvErrCodeHandle(errCode, !ignoreInnerErr);
755 HandleDataAckRecvWithSlidingWindow(errCode, inMsg, ignoreInnerErr);
756 return errCode;
757 }
758
DataPktRecv(Message * inMsg)759 int SingleVerSyncStateMachine::DataPktRecv(Message *inMsg)
760 {
761 PerformanceAnalysis *performance = PerformanceAnalysis::GetInstance();
762 int errCode = E_OK;
763 switch (inMsg->GetMessageType()) {
764 case TYPE_REQUEST:
765 ScheduleMsgAndHandle(inMsg);
766 errCode = -E_NOT_NEED_DELETE_MSG;
767 break;
768 case TYPE_RESPONSE:
769 case TYPE_NOTIFY:
770 if (performance != nullptr) {
771 performance->StepTimeRecordEnd(PT_TEST_RECORDS::RECORD_DATA_SEND_REQUEST_TO_ACK_RECV);
772 performance->StepTimeRecordStart(PT_TEST_RECORDS::RECORD_ACK_RECV_TO_USER_CALL_BACK);
773 }
774 errCode = HandleDataAckRecv(inMsg);
775 break;
776 default:
777 errCode = -E_INVALID_ARGS;
778 break;
779 }
780 return errCode;
781 }
782
ScheduleMsgAndHandle(Message * inMsg)783 void SingleVerSyncStateMachine::ScheduleMsgAndHandle(Message *inMsg)
784 {
785 dataSync_->PutDataMsg(inMsg);
786 while (true) {
787 bool isNeedHandle = true;
788 bool isNeedContinue = true;
789 Message *msg = dataSync_->MoveNextDataMsg(context_, isNeedHandle, isNeedContinue);
790 if (!isNeedContinue) {
791 break;
792 }
793 if (msg == nullptr) {
794 if (dataSync_->IsNeedReloadQueue()) {
795 continue;
796 }
797 dataSync_->ScheduleInfoHandle(false, false, nullptr);
798 break;
799 }
800 bool isNeedClearMap = false;
801 if (isNeedHandle) {
802 int errCode = HandleDataRequestRecv(msg);
803 if (context_->IsReceiveWaterMarkErr() || errCode == -E_NEED_ABILITY_SYNC || errCode == -E_NEED_TIME_SYNC) {
804 isNeedClearMap = true;
805 }
806 if (errCode == -E_TIMEOUT) {
807 isNeedHandle = false;
808 }
809 } else {
810 dataSync_->SendFinishedDataAck(context_, msg);
811 }
812 if (context_->GetRemoteSoftwareVersion() < SOFTWARE_VERSION_RELEASE_3_0) {
813 // for lower version, no need to handle map schedule info, just reset schedule working status
814 isNeedHandle = false;
815 }
816 dataSync_->ScheduleInfoHandle(isNeedHandle, isNeedClearMap, msg);
817 delete msg;
818 }
819 }
820
ControlPktRecv(Message * inMsg)821 int SingleVerSyncStateMachine::ControlPktRecv(Message *inMsg)
822 {
823 int errCode = E_OK;
824 switch (inMsg->GetMessageType()) {
825 case TYPE_REQUEST:
826 errCode = dataSync_->ControlCmdRequestRecv(context_, inMsg);
827 break;
828 case TYPE_RESPONSE:
829 errCode = HandleControlAckRecv(inMsg);
830 break;
831 default:
832 errCode = -E_INVALID_ARGS;
833 break;
834 }
835 return errCode;
836 }
837
StepToTimeout(TimerId timerId)838 void SingleVerSyncStateMachine::StepToTimeout(TimerId timerId)
839 {
840 std::lock_guard<std::mutex> lock(stateMachineLock_);
841 TimerId timer = syncContext_->GetTimerId();
842 if (timer != timerId) {
843 return;
844 }
845 SwitchStateAndStep(Event::TIME_OUT_EVENT);
846 }
847
848 namespace {
849 struct StateNode {
850 int errCode = 0;
851 SyncOperation::Status status = SyncOperation::OP_WAITING;
852 };
853 }
GetSyncOperationStatus(int errCode) const854 int SingleVerSyncStateMachine::GetSyncOperationStatus(int errCode) const
855 {
856 static const StateNode stateNodes[] = {
857 { -E_SCHEMA_MISMATCH, SyncOperation::OP_SCHEMA_INCOMPATIBLE },
858 { -E_EKEYREVOKED, SyncOperation::OP_EKEYREVOKED_FAILURE },
859 { -E_SECURITY_OPTION_CHECK_ERROR, SyncOperation::OP_SECURITY_OPTION_CHECK_FAILURE },
860 { -E_BUSY, SyncOperation::OP_BUSY_FAILURE },
861 { -E_NOT_PERMIT, SyncOperation::OP_PERMISSION_CHECK_FAILED },
862 { -E_TIMEOUT, SyncOperation::OP_TIMEOUT },
863 { -E_INVALID_QUERY_FORMAT, SyncOperation::OP_QUERY_FORMAT_FAILURE },
864 { -E_INVALID_QUERY_FIELD, SyncOperation::OP_QUERY_FIELD_FAILURE },
865 { -E_FEEDBACK_UNKNOWN_MESSAGE, SyncOperation::OP_NOT_SUPPORT },
866 { -E_FEEDBACK_COMMUNICATOR_NOT_FOUND, SyncOperation::OP_COMM_ABNORMAL },
867 { -E_NOT_SUPPORT, SyncOperation::OP_NOT_SUPPORT },
868 { -E_INTERCEPT_DATA_FAIL, SyncOperation::OP_INTERCEPT_DATA_FAIL },
869 { -E_MAX_LIMITS, SyncOperation::OP_MAX_LIMITS },
870 { -E_DISTRIBUTED_SCHEMA_CHANGED, SyncOperation::OP_SCHEMA_CHANGED },
871 { -E_NOT_REGISTER, SyncOperation::OP_NOT_SUPPORT },
872 { -E_DENIED_SQL, SyncOperation::OP_DENIED_SQL },
873 { -E_REMOTE_OVER_SIZE, SyncOperation::OP_MAX_LIMITS },
874 { -E_INVALID_PASSWD_OR_CORRUPTED_DB, SyncOperation::OP_NOTADB_OR_CORRUPTED }
875 };
876 const auto &result = std::find_if(std::begin(stateNodes), std::end(stateNodes), [errCode](const auto &node) {
877 return node.errCode == errCode;
878 });
879 return result == std::end(stateNodes) ? SyncOperation::OP_FAILED : static_cast<int>((*result).status);
880 }
881
TimeMarkSyncRecv(const Message * inMsg)882 int SingleVerSyncStateMachine::TimeMarkSyncRecv(const Message *inMsg)
883 {
884 LOGD("[StateMachine][TimeMarkSyncRecv] type=%d,label=%s,dev=%s", inMsg->GetMessageType(),
885 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
886 {
887 std::lock_guard<std::mutex> lock(stateMachineLock_);
888 (void)ResetWatchDog();
889 }
890 if (inMsg->GetMessageType() == TYPE_REQUEST) {
891 return timeSync_->RequestRecv(inMsg);
892 } else if (inMsg->GetMessageType() == TYPE_RESPONSE) {
893 int errCode = timeSync_->AckRecv(inMsg, context_->GetRequestSessionId());
894 if (errCode != E_OK) {
895 LOGE("[StateMachine][TimeMarkSyncRecv] AckRecv failed errCode=%d", errCode);
896 if (inMsg->GetSessionId() != 0 && inMsg->GetSessionId() == context_->GetRequestSessionId()) {
897 context_->SetTaskErrCode(errCode);
898 InnerErrorAbort(inMsg->GetSessionId());
899 }
900 return errCode;
901 }
902 std::lock_guard<std::mutex> lock(stateMachineLock_);
903 SwitchStateAndStep(TIME_SYNC_FINISHED_EVENT);
904 return E_OK;
905 } else {
906 return -E_INVALID_ARGS;
907 }
908 }
909
Clear()910 void SingleVerSyncStateMachine::Clear()
911 {
912 dataSync_ = nullptr;
913 timeSync_ = nullptr;
914 abilitySync_ = nullptr;
915 context_ = nullptr;
916 syncInterface_ = nullptr;
917 }
918
IsPacketValid(const Message * inMsg) const919 bool SingleVerSyncStateMachine::IsPacketValid(const Message *inMsg) const
920 {
921 if (inMsg == nullptr) {
922 return false;
923 }
924
925 if ((inMsg->GetMessageId() < TIME_SYNC_MESSAGE) || (inMsg->GetMessageId() >= UNKNOW_MESSAGE)) {
926 LOGE("[StateMachine][IsPacketValid] Message is invalid, id=%d", inMsg->GetMessageId());
927 return false;
928 }
929 // filter invalid ack at first
930 bool isResponseType = (inMsg->GetMessageType() == TYPE_RESPONSE);
931 if (isResponseType && (inMsg->GetMessageId() == CONTROL_SYNC_MESSAGE) &&
932 (inMsg->GetSessionId() != context_->GetRequestSessionId())) {
933 LOGE("[StateMachine][IsPacketValid] Control Message is invalid, label=%s, dev=%s",
934 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
935 return false;
936 }
937 if (isResponseType && (inMsg->GetMessageId() != TIME_SYNC_MESSAGE) &&
938 (inMsg->GetSessionId() != context_->GetRequestSessionId()) &&
939 (inMsg->GetSessionId() != context_->GetResponseSessionId())) {
940 LOGE("[StateMachine][IsPacketValid] Data Message is invalid, label=%s, dev=%s",
941 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
942 return false;
943 }
944
945 // timeSync and abilitySync don't need to check sequenceId
946 if (inMsg->GetMessageId() == TIME_SYNC_MESSAGE || inMsg->GetMessageId() == ABILITY_SYNC_MESSAGE ||
947 inMsg->GetMessageId() == CONTROL_SYNC_MESSAGE) {
948 return true;
949 }
950 // sequenceId will be checked in dataSync
951 return true;
952 }
953
PreStartPullResponse()954 void SingleVerSyncStateMachine::PreStartPullResponse()
955 {
956 SingleVerSyncTarget target;
957 context_->PopResponseTarget(target);
958 context_->SetEndMark(target.GetEndWaterMark());
959 context_->SetResponseSessionId(target.GetResponseSessionId());
960 context_->SetMode(SyncModeType::RESPONSE_PULL);
961 context_->ReSetSequenceId();
962 context_->SetQuerySync(target.IsQuerySync());
963 context_->SetQuery(target.GetQuery());
964 }
965
CheckIsStartPullResponse() const966 bool SingleVerSyncStateMachine::CheckIsStartPullResponse() const
967 {
968 // Other state will step to do pull response, only this statem we need to step the statemachine
969 if (currentState_ == WAIT_FOR_RECEIVE_DATA_FINISH) {
970 return true;
971 }
972 return false;
973 }
974
MessageCallbackPre(const Message * inMsg)975 int SingleVerSyncStateMachine::MessageCallbackPre(const Message *inMsg)
976 {
977 RefObject::AutoLock lock(context_);
978 if (context_->IsKilled()) {
979 return -E_OBJ_IS_KILLED;
980 }
981
982 if (!IsPacketValid(inMsg)) {
983 return -E_INVALID_ARGS;
984 }
985 return E_OK;
986 }
987
AddPullResponseTarget(const Message * inMsg,WaterMark pullEndWatermark)988 void SingleVerSyncStateMachine::AddPullResponseTarget(const Message *inMsg, WaterMark pullEndWatermark)
989 {
990 int messageType = static_cast<int>(inMsg->GetMessageId());
991 uint32_t sessionId = inMsg->GetSessionId();
992 if (pullEndWatermark == 0) {
993 LOGE("[StateMachine][AddPullResponseTarget] pullEndWatermark is 0!");
994 return;
995 }
996 if (context_->GetResponseSessionId() == sessionId || context_->FindResponseSyncTarget(sessionId)) {
997 LOGI("[StateMachine][AddPullResponseTarget] task is already running");
998 return;
999 }
1000 const DataRequestPacket *packet = inMsg->GetObject<DataRequestPacket>();
1001 if (packet == nullptr) {
1002 LOGE("[AddPullResponseTarget] get packet object failed");
1003 return;
1004 }
1005 SingleVerSyncTarget *targetTmp = new (std::nothrow) SingleVerSyncTarget;
1006 if (targetTmp == nullptr) {
1007 LOGE("[StateMachine][AddPullResponseTarget] add failed, may oom");
1008 return;
1009 }
1010 targetTmp->SetTaskType(ISyncTarget::RESPONSE);
1011 if (messageType == QUERY_SYNC_MESSAGE) {
1012 targetTmp->SetQuery(packet->GetQuery());
1013 targetTmp->SetQuerySync(true);
1014 }
1015 targetTmp->SetMode(SyncModeType::RESPONSE_PULL);
1016 targetTmp->SetEndWaterMark(pullEndWatermark);
1017 targetTmp->SetResponseSessionId(sessionId);
1018 if (context_->AddSyncTarget(targetTmp) != E_OK) {
1019 delete targetTmp;
1020 return;
1021 }
1022 if (CheckIsStartPullResponse()) {
1023 SwitchStateAndStep(TransformErrCodeToEvent(-E_NEED_PULL_REPONSE));
1024 }
1025 }
1026
TransformErrCodeToEvent(int errCode) const1027 Event SingleVerSyncStateMachine::TransformErrCodeToEvent(int errCode) const
1028 {
1029 switch (errCode) {
1030 case -E_TIMEOUT:
1031 return TransforTimeOutErrCodeToEvent();
1032 case -static_cast<int>(VERSION_NOT_SUPPOR_EVENT):
1033 return Event::VERSION_NOT_SUPPOR_EVENT;
1034 case -E_SEND_DATA:
1035 return Event::SEND_DATA_EVENT;
1036 case -E_NO_DATA_SEND:
1037 return Event::SEND_FINISHED_EVENT;
1038 case -E_RECV_FINISHED:
1039 return Event::RECV_FINISHED_EVENT;
1040 case -E_NEED_ABILITY_SYNC:
1041 return Event::NEED_ABILITY_SYNC_EVENT;
1042 case -E_NO_SYNC_TASK:
1043 return Event::ALL_TASK_FINISHED_EVENT;
1044 case -E_NEED_PULL_REPONSE:
1045 return Event::START_PULL_RESPONSE_EVENT;
1046 case -E_RE_SEND_DATA:
1047 return Event::RE_SEND_DATA_EVENT;
1048 case -E_NEED_TIME_SYNC:
1049 return Event::NEED_TIME_SYNC_EVENT;
1050 default:
1051 return Event::INNER_ERR_EVENT;
1052 }
1053 }
1054
IsNeedResetWatchdog(const Message * inMsg) const1055 bool SingleVerSyncStateMachine::IsNeedResetWatchdog(const Message *inMsg) const
1056 {
1057 if (inMsg == nullptr) {
1058 return false;
1059 }
1060
1061 if (IsNeedErrCodeHandle(inMsg->GetSessionId())) {
1062 return true;
1063 }
1064
1065 int msgType = inMsg->GetMessageType();
1066 if (msgType == TYPE_RESPONSE || msgType == TYPE_NOTIFY) {
1067 if (inMsg->GetSessionId() == context_->GetResponseSessionId()) {
1068 // Pull response ack also should reset watchdog
1069 return true;
1070 }
1071 }
1072
1073 return false;
1074 }
1075
TransforTimeOutErrCodeToEvent() const1076 Event SingleVerSyncStateMachine::TransforTimeOutErrCodeToEvent() const
1077 {
1078 if (syncContext_->IsSyncTaskNeedRetry() && (syncContext_->GetRetryTime() < syncContext_->GetSyncRetryTimes())) {
1079 return Event::WAIT_TIME_OUT_EVENT;
1080 } else {
1081 return Event::TIME_OUT_EVENT;
1082 }
1083 }
1084
IsNeedErrCodeHandle(uint32_t sessionId) const1085 bool SingleVerSyncStateMachine::IsNeedErrCodeHandle(uint32_t sessionId) const
1086 {
1087 // omit to set sessionId so version_3 should skip to compare sessionid.
1088 if (sessionId == context_->GetRequestSessionId() ||
1089 context_->GetRemoteSoftwareVersion() == SOFTWARE_VERSION_RELEASE_2_0) {
1090 return true;
1091 }
1092 return false;
1093 }
1094
PushPullDataRequestEvokeErrHandle()1095 void SingleVerSyncStateMachine::PushPullDataRequestEvokeErrHandle()
1096 {
1097 // the pushpull sync task should wait for send finished after remote dev get data occur E_EKEYREVOKED error.
1098 if (context_->GetRemoteSoftwareVersion() > SOFTWARE_VERSION_RELEASE_2_0 &&
1099 SyncOperation::TransferSyncMode(context_->GetMode()) == SyncModeType::PUSH_AND_PULL) { // LCOV_EXCL_BR_LINE
1100 LOGI("data request errCode = %d, wait for send finished", -E_EKEYREVOKED);
1101 context_->SetTaskErrCode(-E_EKEYREVOKED);
1102 context_->SetOperationStatus(SyncOperation::OP_RECV_FINISHED);
1103 SwitchStateAndStep(Event::RECV_FINISHED_EVENT);
1104 } else {
1105 context_->SetTaskErrCode(-E_EKEYREVOKED);
1106 SwitchStateAndStep(Event::INNER_ERR_EVENT);
1107 }
1108 }
1109
DataRecvErrCodeHandle(uint32_t sessionId,int errCode)1110 void SingleVerSyncStateMachine::DataRecvErrCodeHandle(uint32_t sessionId, int errCode)
1111 {
1112 if (IsNeedErrCodeHandle(sessionId)) {
1113 switch (errCode) {
1114 case E_OK:
1115 break;
1116 case -E_NOT_PERMIT:
1117 context_->SetOperationStatus(SyncOperation::OP_PERMISSION_CHECK_FAILED);
1118 break;
1119 case -E_RECV_FINISHED:
1120 context_->SetOperationStatus(SyncOperation::OP_RECV_FINISHED);
1121 SwitchStateAndStep(Event::RECV_FINISHED_EVENT);
1122 break;
1123 case -E_EKEYREVOKED:
1124 PushPullDataRequestEvokeErrHandle();
1125 break;
1126 case -E_BUSY:
1127 case -E_DISTRIBUTED_SCHEMA_CHANGED:
1128 case -E_DISTRIBUTED_SCHEMA_NOT_FOUND:
1129 case -E_FEEDBACK_COMMUNICATOR_NOT_FOUND:
1130 case -E_FEEDBACK_UNKNOWN_MESSAGE:
1131 case -E_INTERCEPT_DATA_FAIL:
1132 case -E_INVALID_PASSWD_OR_CORRUPTED_DB:
1133 case -E_INVALID_QUERY_FIELD:
1134 case -E_INVALID_QUERY_FORMAT:
1135 case -E_MAX_LIMITS:
1136 case -E_NOT_REGISTER:
1137 case -E_NOT_SUPPORT:
1138 case -E_SECURITY_OPTION_CHECK_ERROR:
1139 context_->SetTaskErrCode(errCode);
1140 SwitchStateAndStep(Event::INNER_ERR_EVENT);
1141 break;
1142 default:
1143 SwitchStateAndStep(Event::INNER_ERR_EVENT);
1144 break;
1145 }
1146 }
1147 }
1148
AbilityMsgSessionIdCheck(const Message * inMsg)1149 bool SingleVerSyncStateMachine::AbilityMsgSessionIdCheck(const Message *inMsg)
1150 {
1151 if (inMsg != nullptr && inMsg->GetSessionId() == context_->GetRequestSessionId()) { // LCOV_EXCL_BR_LINE
1152 return true;
1153 }
1154 LOGE("[AbilitySync] session check failed,dev=%s", STR_MASK(context_->GetDeviceId()));
1155 return false;
1156 }
1157
GetSyncType(uint32_t messageId) const1158 SyncType SingleVerSyncStateMachine::GetSyncType(uint32_t messageId) const
1159 {
1160 if (messageId == QUERY_SYNC_MESSAGE) { // LCOV_EXCL_BR_LINE
1161 return SyncType::QUERY_SYNC_TYPE;
1162 }
1163 return SyncType::MANUAL_FULL_SYNC_TYPE;
1164 }
1165
DataAckRecvErrCodeHandle(int errCode,bool handleError)1166 void SingleVerSyncStateMachine::DataAckRecvErrCodeHandle(int errCode, bool handleError)
1167 {
1168 switch (errCode) {
1169 case -E_NEED_ABILITY_SYNC:
1170 NeedAbilitySyncHandle();
1171 break;
1172 case -E_NEED_TIME_SYNC:
1173 timeSync_->ClearTimeSyncFinish();
1174 break;
1175 case -E_NOT_PERMIT:
1176 if (handleError) {
1177 context_->SetOperationStatus(SyncOperation::OP_PERMISSION_CHECK_FAILED);
1178 }
1179 break;
1180 case -E_BUSY:
1181 case -E_DISTRIBUTED_SCHEMA_CHANGED:
1182 case -E_DISTRIBUTED_SCHEMA_NOT_FOUND:
1183 case -E_EKEYREVOKED:
1184 case -E_FEEDBACK_COMMUNICATOR_NOT_FOUND:
1185 case -E_FEEDBACK_UNKNOWN_MESSAGE:
1186 case -E_INTERCEPT_DATA_FAIL:
1187 case -E_INVALID_PASSWD_OR_CORRUPTED_DB:
1188 case -E_INVALID_QUERY_FIELD:
1189 case -E_INVALID_QUERY_FORMAT:
1190 case -E_MAX_LIMITS:
1191 case -E_NOT_REGISTER:
1192 case -E_NOT_SUPPORT:
1193 case -E_SECURITY_OPTION_CHECK_ERROR:
1194 if (handleError) {
1195 context_->SetTaskErrCode(errCode);
1196 }
1197 break;
1198 default:
1199 break;
1200 }
1201 }
1202
IsNeedTriggerQueryAutoSync(Message * inMsg,QuerySyncObject & query)1203 bool SingleVerSyncStateMachine::IsNeedTriggerQueryAutoSync(Message *inMsg, QuerySyncObject &query)
1204 {
1205 return SingleVerDataSyncUtils::IsNeedTriggerQueryAutoSync(inMsg, query);
1206 }
1207
JumpStatusAfterAbilitySync(int mode)1208 void SingleVerSyncStateMachine::JumpStatusAfterAbilitySync(int mode)
1209 {
1210 if ((mode == SyncModeType::SUBSCRIBE_QUERY) || (mode == SyncModeType::UNSUBSCRIBE_QUERY)) {
1211 SwitchStateAndStep(CONTROL_CMD_EVENT);
1212 } else {
1213 SwitchStateAndStep(ABILITY_SYNC_FINISHED_EVENT);
1214 }
1215 }
1216
ControlAckRecvErrCodeHandle(int errCode)1217 void SingleVerSyncStateMachine::ControlAckRecvErrCodeHandle(int errCode)
1218 {
1219 switch (errCode) {
1220 case -E_NEED_ABILITY_SYNC:
1221 NeedAbilitySyncHandle();
1222 break;
1223 case -E_NO_DATA_SEND:
1224 context_->SetOperationStatus(SyncOperation::OP_SEND_FINISHED);
1225 break;
1226 case -E_NOT_PERMIT:
1227 context_->SetOperationStatus(SyncOperation::OP_PERMISSION_CHECK_FAILED);
1228 break;
1229 // other errCode use default
1230 default:
1231 context_->SetTaskErrCode(errCode);
1232 break;
1233 }
1234 }
1235
GetLocalWaterMark(const DeviceID & deviceId,uint64_t & outValue)1236 void SingleVerSyncStateMachine::GetLocalWaterMark(const DeviceID &deviceId, uint64_t &outValue)
1237 {
1238 metadata_->GetLocalWaterMark(deviceId, outValue);
1239 }
1240
GetSendQueryWaterMark(const std::string & queryId,const DeviceID & deviceId,bool isAutoLift,uint64_t & outValue)1241 int SingleVerSyncStateMachine::GetSendQueryWaterMark(const std::string &queryId, const DeviceID &deviceId,
1242 bool isAutoLift, uint64_t &outValue)
1243 {
1244 return metadata_->GetSendQueryWaterMark(queryId, deviceId, outValue, isAutoLift);
1245 }
1246
ResponsePullError(int errCode,bool ignoreInnerErr)1247 void SingleVerSyncStateMachine::ResponsePullError(int errCode, bool ignoreInnerErr)
1248 {
1249 Event event = TransformErrCodeToEvent(errCode);
1250 if (event == INNER_ERR_EVENT) {
1251 if (ignoreInnerErr) {
1252 event = RESPONSE_TASK_FINISHED_EVENT;
1253 } else if (context_ != nullptr) {
1254 context_->SetTaskErrCode(errCode);
1255 }
1256 }
1257 SwitchStateAndStep(event);
1258 }
1259
InnerErrorAbort(uint32_t sessionId)1260 void SingleVerSyncStateMachine::InnerErrorAbort(uint32_t sessionId)
1261 {
1262 std::lock_guard<std::mutex> lock(stateMachineLock_);
1263 uint32_t requestSessionId = context_->GetRequestSessionId();
1264 if (sessionId != requestSessionId) {
1265 LOGD("[SingleVerSyncStateMachine][InnerErrorAbort] Ignore abort by different sessionId");
1266 return;
1267 }
1268 if (SwitchMachineState(Event::INNER_ERR_EVENT) == E_OK) {
1269 SyncStep();
1270 }
1271 }
1272
NotifyClosing()1273 void SingleVerSyncStateMachine::NotifyClosing()
1274 {
1275 if (timeSync_ != nullptr) {
1276 timeSync_->Close();
1277 }
1278 }
1279
AbilitySyncNotifyRecv(const Message * inMsg)1280 int SingleVerSyncStateMachine::AbilitySyncNotifyRecv(const Message *inMsg)
1281 {
1282 const AbilitySyncAckPacket *packet = inMsg->GetObject<AbilitySyncAckPacket>();
1283 if (packet == nullptr) {
1284 return -E_INVALID_ARGS;
1285 }
1286 int ackCode = packet->GetAckCode();
1287 if (ackCode != AbilitySync::CHECK_SUCCESS && ackCode != AbilitySync::LAST_NOTIFY) {
1288 LOGE("[StateMachine][AbilitySyncRecv] ackCode check failed,ackCode=%d", ackCode);
1289 context_->SetTaskErrCode(ackCode);
1290 std::lock_guard<std::mutex> lock(stateMachineLock_);
1291 SwitchStateAndStep(Event::INNER_ERR_EVENT);
1292 return E_OK;
1293 }
1294 if (ackCode == AbilitySync::LAST_NOTIFY && AbilityMsgSessionIdCheck(inMsg)) {
1295 abilitySync_->SetAbilitySyncFinishedStatus(true, *context_);
1296 // while recv last notify means ability sync finished,it is better to reset watchDog to avoid timeout.
1297 LOGI("[StateMachine][AbilitySyncRecv] ability sync finished,label=%s,dev=%s",
1298 dataSync_->GetLabel().c_str(), STR_MASK(context_->GetDeviceId()));
1299 context_->SetRemoteSoftwareVersion(packet->GetSoftwareVersion());
1300 currentRemoteVersionId_ = context_->GetRemoteSoftwareVersionId();
1301 std::lock_guard<std::mutex> lock(stateMachineLock_);
1302 (void)ResetWatchDog();
1303 JumpStatusAfterAbilitySync(context_->GetMode());
1304 } else if (ackCode != AbilitySync::LAST_NOTIFY) {
1305 abilitySync_->AckNotifyRecv(inMsg, context_);
1306 }
1307 return E_OK;
1308 }
1309
SchemaChange()1310 void SingleVerSyncStateMachine::SchemaChange()
1311 {
1312 abilitySync_->SetAbilitySyncFinishedStatus(false, *context_);
1313 }
1314
TimeChange()1315 void SingleVerSyncStateMachine::TimeChange()
1316 {
1317 if (timeSync_ == nullptr) {
1318 LOGW("[SingleVerSyncStateMachine] time sync is null when time change");
1319 return;
1320 }
1321 timeSync_->ClearTimeSyncFinish();
1322 }
1323 } // namespace DistributedDB
1324