/
system_cloud_internal.cpp
1387 lines (1244 loc) · 46.4 KB
/
system_cloud_internal.cpp
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
/**
Copyright (c) 2013-2015 Particle Industries, Inc. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation, either
version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
******************************************************************************
*/
#include "logging.h"
#include "spark_wiring_string.h"
#include "spark_wiring_cloud.h"
#include "spark_wiring_ticks.h"
#include "spark_wiring_ipaddress.h"
#include "spark_wiring_led.h"
#include "spark_wiring_vector.h"
#include "system_cloud_internal.h"
#include "system_mode.h"
#include "system_task.h"
#include "system_threading.h"
#include "system_user.h"
#include "spark_wiring_string.h"
#include "spark_protocol_functions.h"
#include "core_hal.h"
#include "deviceid_hal.h"
#include "ota_flash_hal.h"
#include "product_store_hal.h"
#include "rtc_hal.h"
#include "socket_hal.h"
#include "rgbled.h"
#include "spark_macros.h" // for S2M
#include "string_convert.h"
#include "core_hal.h"
#include "hal_platform.h"
#include "bootloader.h"
#include "system_string_interpolate.h"
#if HAL_PLATFORM_CLOUD_UDP
#include "dtls_session_persist.h"
#endif // HAL_PLATFORM_CLOUD_UDP
#include "bytes2hexbuf.h"
#include "system_event.h"
#include "system_cloud_connection.h"
#include "system_network_internal.h"
#include "str_util.h"
#include "scope_guard.h"
#if HAL_PLATFORM_MUXER_MAY_NEED_DELAY_IN_TX
#include "network/ncp/cellular/ncp.h"
#include "network/ncp/cellular/cellular_ncp_client.h"
#endif // HAL_PLATFORM_MUXER_MAY_NEED_DELAY_IN_TX
#include "system_version.h"
#include "firmware_update.h"
#include "server_config.h"
#if HAL_PLATFORM_ASSETS
#include "asset_manager.h"
#endif // HAL_PLATFORM_ASSETS
#if PLATFORM_ID == PLATFORM_GCC
#include "device_config.h"
#endif
#include "control/common.h" // FIXME: Move to another directory
#include "cloud/cloud.pb.h"
#include "nanopb_misc.h"
#include <stdio.h>
#include <stdint.h>
#include <algorithm>
using namespace particle;
using namespace particle::system;
using particle::protocol::ProtocolError;
#if PLATFORM_ID != PLATFORM_GCC && PLATFORM_ID != PLATFORM_NEWHAL
using particle::control::common::DecodedString;
using particle::control::common::DecodedCString;
#endif
extern volatile uint8_t SPARK_UPDATE_PENDING_EVENT_RECEIVED;
namespace particle {
namespace {
constexpr const char CLAIM_EVENTS[] = "spark/device/claim/";
constexpr const char RESET_EVENT[] = "spark/device/reset";
constexpr const char KEY_RESTORE_EVENT[] = "spark/device/key/restore";
constexpr const char DEVICE_UPDATES_EVENT[] = "particle/device/updates/";
constexpr const char FORCED_EVENT[] = "forced";
constexpr const char UPDATES_PENDING_EVENT[] = "pending";
Vector<User_Var_Lookup_Table_t> g_cloudVars;
Vector<User_Func_Lookup_Table_t> g_cloudFuncs;
inline bool isSuffix(const char* eventName, const char* prefix, const char* suffix) {
// todo - sanity check parameters?
return !strncmp(eventName+strlen(prefix), suffix, strlen(eventName)-strlen(prefix));
}
inline uint8_t dataToFlag(const char* data) {
return !strncmp(data, "true", strlen(data));
}
/**
* Handler for system cloud events.
*/
void systemEventHandler(const char* name, const char* data)
{
if (startsWith(name, DEVICE_UPDATES_EVENT)) {
const uint8_t flagValue = dataToFlag(data);
if (isSuffix(name, DEVICE_UPDATES_EVENT, FORCED_EVENT)) {
system_set_flag(SYSTEM_FLAG_OTA_UPDATE_FORCED, flagValue, nullptr);
}
else if (isSuffix(name, DEVICE_UPDATES_EVENT, UPDATES_PENDING_EVENT)) {
const auto statusBefore = system_get_update_status(nullptr);
SPARK_UPDATE_PENDING_EVENT_RECEIVED = 1;
system_set_flag(SYSTEM_FLAG_OTA_UPDATE_PENDING, flagValue, nullptr);
const auto statusAfter = system_get_update_status(nullptr);
if (statusAfter != statusBefore) {
system_notify_event(firmware_update_status, statusAfter);
}
}
}
else if (!strncmp(name, CLAIM_EVENTS, strlen(CLAIM_EVENTS))) {
LOG(TRACE, "Claim code received by the cloud and cleared locally.");
HAL_Set_Claim_Code(NULL);
}
else if (!strcmp(name, RESET_EVENT)) {
if (data && *data) {
if (!strcmp("safe mode", data)) {
System.enterSafeMode();
} else if (!strcmp("dfu", data)) {
System.dfu(false);
} else if (!strcmp("reboot", data)) {
System.reset();
} else if (!strcmp("network", data)) {
LOG(WARN, "Received a command to reset the network");
// Reset all active network interfaces asynchronously
const auto task = new(std::nothrow) ISRTaskQueue::Task();
if (task) {
task->func = [](ISRTaskQueue::Task* task) {
delete task;
resetNetworkInterfaces();
};
SystemISRTaskQueue.enqueue(task);
}
}
}
}
#if PLATFORM_ID != PLATFORM_GCC
else if (!strncmp(name, KEY_RESTORE_EVENT, strlen(KEY_RESTORE_EVENT))) {
LOG(WARN, "Received key restore event");
int r = ServerConfig::instance()->restoreDefaultSettings();
if (r < 0) {
LOG(ERROR, "Failed to restore default server settings: %d", r);
// Reset anyway
}
system_pending_shutdown(RESET_REASON_CONFIG_UPDATE);
}
#endif // PLATFORM_ID != PLATFORM_GCC
}
#if HAL_PLATFORM_OTA_PROTOCOL_V3
int startFirmwareUpdate(size_t fileSize, const char* fileHash, size_t* partialSize, unsigned flags, int moduleFunction) {
#if HAL_PLATFORM_ASSETS
CHECK(AssetManager::instance().prepareForOta(fileSize, flags, moduleFunction));
#endif // HAL_PLATFORM_ASSETS
CHECK(FirmwareUpdate::instance()->startUpdate(fileSize, fileHash, partialSize,
FirmwareUpdateFlags::fromUnderlying(flags)));
return 0;
}
int finishFirmwareUpdate(unsigned flags) {
return FirmwareUpdate::instance()->finishUpdate(FirmwareUpdateFlags::fromUnderlying(flags));
}
int saveFirmwareChunk(const char* chunkData, size_t chunkSize, size_t chunkOffset, size_t partialSize) {
return FirmwareUpdate::instance()->saveChunk(chunkData, chunkSize, chunkOffset, partialSize);
}
#endif // HAL_PLATFORM_OTA_PROTOCOL_V3
} // namespace
int sendApplicationDescription() {
LOG(INFO, "Sending application DESCRIBE");
int r = spark_protocol_post_description(sp, protocol::DescriptionType::DESCRIBE_APPLICATION, nullptr);
if (r != 0) {
return spark_protocol_to_system_error(r);
}
LOG(INFO, "Sending subscriptions");
spark_protocol_send_subscriptions(sp);
return 0;
}
void registerSystemSubscriptions() {
bool ok = Particle.subscribe("particle", systemEventHandler, MY_DEVICES);
ok = Particle.subscribe("spark", systemEventHandler, MY_DEVICES) && ok;
if (!ok) {
LOG(ERROR, "Particle.subscribe() failed");
}
}
void clearSessionData() {
#if HAL_PLATFORM_CLOUD_UDP
LOG(INFO, "Clearing session data");
SessionPersistDataOpaque d = {};
const int r = Spark_Save(&d, sizeof(d), SparkCallbacks::PERSIST_SESSION, nullptr);
if (r < 0) {
LOG(ERROR, "Spark_Save() failed: %d", r);
}
#endif
}
size_t cloudVariableCount() {
return g_cloudVars.size();
}
int getCloudVariableInfo(size_t index, const char** name, int* type) {
if (index >= (size_t)g_cloudVars.size()) {
return SYSTEM_ERROR_OUT_OF_RANGE;
}
const auto& info = g_cloudVars.at(index);
if (name) {
*name = info.userVarKey;
}
if (type) {
*type = info.userVarType;
}
return 0;
}
size_t cloudFunctionCount() {
return g_cloudFuncs.size();
}
int getCloudFunctionInfo(size_t index, const char** name) {
if (index >= (size_t)g_cloudFuncs.size()) {
return SYSTEM_ERROR_OUT_OF_RANGE;
}
const auto& info = g_cloudFuncs.at(index);
if (name) {
*name = info.userFuncKey;
}
return 0;
}
} // namespace particle
extern uint8_t feature_cloud_udp;
extern volatile bool cloud_socket_aborted;
static volatile uint32_t lastCloudEvent = 0;
static uint32_t particle_key_errors = ParticleKeyErrorFlag::NO_ERROR;
const int CLAIM_CODE_SIZE = 63;
int userVarType(const char *varKey);
int userFuncSchedule(const char *funcKey, const char *paramString, SparkDescriptor::FunctionResultCallback callback, void* reserved);
static void formatResetReasonEventData(int reason, uint32_t data, char *buf, size_t size);
ProtocolFacade* sp;
void (*random_seed_from_cloud_handler)(unsigned int) = nullptr;
/**
* This is necessary since spark_protocol_instance() was defined in both system_cloud
* and communication dynalibs. (Not sure why - just an oversight.)
* Renaming this method, but keeping in the dynalib for backwards compatibility with wiring code
* version 1. Wiring code compiled against version 2 will not use this function, since the
* code will be linked to spark_protocol_instance() in comms lib.
*/
ProtocolFacade* system_cloud_protocol_instance(void)
{
if (!sp)
sp = spark_protocol_instance();
return sp;
}
User_Var_Lookup_Table_t* find_var_by_key(const char* varKey)
{
for (auto& var: g_cloudVars) {
if (strncmp(var.userVarKey, varKey, USER_VAR_KEY_LENGTH) == 0) {
return &var;
}
}
return nullptr;
}
User_Var_Lookup_Table_t* find_var_by_key_or_add(const char* varKey, const void* userVar, Spark_Data_TypeDef userVarType, spark_variable_t* extra)
{
User_Var_Lookup_Table_t item = {};
item.userVar = userVar;
item.userVarType = userVarType;
if (extra) {
item.update = extra->update;
if (offsetof(spark_variable_t, copy) + sizeof(spark_variable_t::copy) <= extra->size) {
item.copy = extra->copy;
}
}
memcpy(item.userVarKey, varKey, std::min<size_t>(strlen(varKey), USER_VAR_KEY_LENGTH));
User_Var_Lookup_Table_t* result = find_var_by_key(varKey);
if (result) {
*result = item;
} else if ((size_t)g_cloudVars.size() < USER_VAR_MAX_COUNT) {
if (g_cloudVars.append(std::move(item))) {
result = &g_cloudVars.last();
} else {
LOG(ERROR, "Memory allocation error");
}
} else {
LOG(ERROR, "Too many cloud variables");
}
return result;
}
User_Func_Lookup_Table_t* find_func_by_key(const char* funcKey)
{
for (auto& func: g_cloudFuncs) {
if (strncmp(func.userFuncKey, funcKey, USER_FUNC_KEY_LENGTH) == 0) {
return &func;
}
}
return nullptr;
}
User_Func_Lookup_Table_t* find_func_by_key_or_add(const char* funcKey, const cloud_function_descriptor* desc)
{
User_Func_Lookup_Table_t item = {};
item.pUserFunc = desc->fn;
item.pUserFuncData = desc->data;
memcpy(item.userFuncKey, funcKey, std::min<size_t>(strlen(funcKey), USER_FUNC_KEY_LENGTH));
User_Func_Lookup_Table_t* result = find_func_by_key(funcKey);
if (result) {
*result = item;
} else if ((size_t)g_cloudFuncs.size() < USER_FUNC_MAX_COUNT) {
if (g_cloudFuncs.append(std::move(item))) {
result = &g_cloudFuncs.last();
} else {
LOG(ERROR, "Memory allocation error");
}
} else {
LOG(ERROR, "Too many cloud functions");
}
return result;
}
int call_raw_user_function(void* data, const char* param, void* reserved)
{
user_function_int_str_t* fn = (user_function_int_str_t*)(data);
String p(param);
return (*fn)(p);
}
inline uint32_t crc(const void* data, size_t len)
{
return HAL_Core_Compute_CRC32((const uint8_t*)data, len);
}
template <typename T>
uint32_t crc(const T& t)
{
return crc(&t, sizeof(t));
}
uint32_t string_crc(const char* s)
{
return crc(s, strlen(s));
}
/**
* Computes the checksum of the registered functions.
* The function name is used to compute the checksum.
*/
uint32_t compute_functions_checksum()
{
uint32_t checksum = 0;
for (const auto& func: g_cloudFuncs) {
checksum += string_crc(func.userFuncKey);
}
return checksum;
}
/**
* Computes the checksum of the registered variables.
* The checksum is derived from the variable name and type.
*/
uint32_t compute_variables_checksum()
{
uint32_t checksum = 0;
for (const auto& var: g_cloudVars) {
checksum += string_crc(var.userVarKey);
checksum += crc(var.userVarType);
}
return checksum;
}
/**
* Computes the checksum of all functions and variables.
*/
uint32_t compute_describe_app_checksum()
{
uint32_t chk[2];
chk[0] = compute_variables_checksum();
chk[1] = compute_functions_checksum();
return crc(chk, sizeof(chk));
}
uint32_t compute_describe_system_checksum()
{
hal_system_info_t info;
memset(&info, 0, sizeof(info));
info.size = sizeof(info);
HAL_System_Info(&info, true, NULL);
uint32_t checksum = info.platform_id;
for (int i=0; i<info.module_count; i++)
{
checksum += crc(info.modules[i].suffix.sha);
}
HAL_System_Info(&info, false, NULL);
return checksum;
}
/**
* Register a function.
* @param desc
* @param reserved
* @return
*/
bool spark_function_internal(const cloud_function_descriptor* desc, void* reserved)
{
User_Func_Lookup_Table_t* item = NULL;
if (NULL != desc->fn && NULL != desc->funcKey && strlen(desc->funcKey)<=USER_FUNC_KEY_LENGTH)
{
item=find_func_by_key_or_add(desc->funcKey, desc);
}
return item!=NULL;
}
void invokeEventHandlerInternal(uint16_t handlerInfoSize, FilteringEventHandler* handlerInfo,
const char* event_name, const char* data, void* reserved)
{
if(handlerInfo->handler_data)
{
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wcast-function-type"
EventHandlerWithData handler = (EventHandlerWithData) handlerInfo->handler;
#pragma GCC diagnostic pop
handler(handlerInfo->handler_data, event_name, data);
}
else
{
handlerInfo->handler(event_name, data);
}
}
void invokeEventHandlerString(uint16_t handlerInfoSize, FilteringEventHandler* handlerInfo,
const String& name, const String& data, void* reserved)
{
invokeEventHandlerInternal(handlerInfoSize, handlerInfo, name.c_str(), data.c_str(), reserved);
}
bool is_system_handler(uint16_t handlerInfoSize, FilteringEventHandler* handlerInfo) {
// for now we hack this to recognize our own system handler
return handlerInfo->handler == systemEventHandler;
}
void invokeEventHandler(uint16_t handlerInfoSize, FilteringEventHandler* handlerInfo,
const char* event_name, const char* event_data, void* reserved)
{
if (is_system_handler(handlerInfoSize, handlerInfo) || system_thread_get_state(NULL)==spark::feature::DISABLED)
{
invokeEventHandlerInternal(handlerInfoSize, handlerInfo, event_name, event_data, reserved);
}
else
{
// copy the buffers to dynamically allocated storage.
String name(event_name);
String data(event_data);
APPLICATION_THREAD_CONTEXT_ASYNC(invokeEventHandlerString(handlerInfoSize, handlerInfo, name, data, reserved));
}
}
#if HAL_PLATFORM_CLOUD_UDP
using particle::protocol::SessionPersistOpaque;
using particle::protocol::SessionPersistData;
using particle::protocol::AppStateDescriptor;
int Spark_Save(const void* buffer, size_t length, uint8_t type, void* reserved)
{
if (type==SparkCallbacks::PERSIST_SESSION)
{
static_assert(sizeof(SessionPersistOpaque::connection)>=sizeof(g_system_cloud_session_data),"connection space in session is not large enough");
// save the current connection to the persisted session
SessionPersistOpaque* persist = (SessionPersistOpaque*)buffer;
if (persist->is_valid())
{
memcpy(persist->connection_data(), &g_system_cloud_session_data, sizeof(g_system_cloud_session_data));
}
return HAL_System_Backup_Save(0, buffer, length, nullptr);
}
return -1; // eek. define a constant for this error - Unknown Type.
}
int Spark_Restore(void* buffer, size_t max_length, uint8_t type, void* reserved)
{
#if PLATFORM_ID == PLATFORM_MSOM
// FIXME: Force new session handshake for now
return 0;
#else
size_t length = 0;
int error = HAL_System_Backup_Restore(0, buffer, max_length, &length, nullptr);
if (error)
length = 0;
return length;
#endif
}
void update_persisted_state(std::function<void(SessionPersistOpaque&)> fn)
{
SessionPersistOpaque persist;
if (Spark_Restore(&persist, sizeof(persist), SparkCallbacks::PERSIST_SESSION, nullptr)==sizeof(persist) && persist.is_valid())
{
fn(persist);
Spark_Save(&persist, sizeof(persist), SparkCallbacks::PERSIST_SESSION, nullptr);
}
}
uint32_t compute_cloud_state_checksum(SparkAppStateSelector::Enum stateSelector, SparkAppStateUpdate::Enum operation, uint32_t value, void* reserved)
{
if (operation == SparkAppStateUpdate::COMPUTE_AND_PERSIST) {
switch (stateSelector)
{
case SparkAppStateSelector::DESCRIBE_APP:
update_persisted_state([](SessionPersistData& data){
data.describe_app_crc = compute_describe_app_checksum();
data.app_state_flags |= AppStateDescriptor::APP_DESCRIBE_CRC;
});
break;
case SparkAppStateSelector::DESCRIBE_SYSTEM:
update_persisted_state([](SessionPersistData& data){
data.describe_system_crc = compute_describe_system_checksum();
data.app_state_flags |= AppStateDescriptor::SYSTEM_DESCRIBE_CRC;
});
break;
}
}
else if (operation == SparkAppStateUpdate::PERSIST)
{
switch (stateSelector) {
case SparkAppStateSelector::SUBSCRIPTIONS: {
update_persisted_state([value](SessionPersistData& data){
data.subscriptions_crc = value;
data.app_state_flags |= AppStateDescriptor::SUBSCRIPTIONS_CRC;
});
break;
}
case SparkAppStateSelector::PROTOCOL_FLAGS: {
update_persisted_state([value](SessionPersistData& data){
data.protocol_flags = value;
data.app_state_flags |= AppStateDescriptor::PROTOCOL_FLAGS;
});
break;
}
case SparkAppStateSelector::SYSTEM_MODULE_VERSION: {
update_persisted_state([value](SessionPersistData& data){
data.system_version = value;
data.app_state_flags |= AppStateDescriptor::SYSTEM_MODULE_VERSION;
});
break;
}
case SparkAppStateSelector::MAX_MESSAGE_SIZE: {
update_persisted_state([value](SessionPersistData& data){
data.max_message_size = value;
data.app_state_flags |= AppStateDescriptor::MAX_MESSAGE_SIZE;
});
break;
}
case SparkAppStateSelector::MAX_BINARY_SIZE: {
update_persisted_state([value](SessionPersistData& data){
data.max_binary_size = value;
data.app_state_flags |= AppStateDescriptor::MAX_BINARY_SIZE;
});
break;
}
case SparkAppStateSelector::OTA_CHUNK_SIZE: {
update_persisted_state([value](SessionPersistData& data){
data.ota_chunk_size = value;
data.app_state_flags |= AppStateDescriptor::OTA_CHUNK_SIZE;
});
break;
}
default:
break;
}
}
else if (operation == SparkAppStateUpdate::COMPUTE)
{
switch (stateSelector)
{
case SparkAppStateSelector::DESCRIBE_APP:
return compute_describe_app_checksum();
case SparkAppStateSelector::DESCRIBE_SYSTEM:
return compute_describe_system_checksum();
}
}
else if (operation == SparkAppStateUpdate::RESET && stateSelector == SparkAppStateSelector::ALL)
{
update_persisted_state([](SessionPersistData& data) {
data.app_state_flags = 0;
});
}
return 0;
}
#endif /* HAL_PLATFORM_CLOUD_UDP */
void system_set_time(uint32_t time, unsigned param, void*)
{
struct timeval tv = {
.tv_sec = (time_t)time,
.tv_usec = 0
};
hal_rtc_set_time(&tv, nullptr);
system_notify_event(time_changed, time_changed_sync);
}
namespace {
// LED status for the test signal that can be triggered from the cloud
class LEDCloudSignalStatus: public LEDStatus {
public:
explicit LEDCloudSignalStatus(LEDPriority priority) :
LEDStatus(LED_PATTERN_CUSTOM, priority),
ticks_(0),
index_(0) {
updateColor();
}
protected:
virtual void update(system_tick_t t) override {
if (t >= ticks_) {
// Change LED color
if (++index_ == COLOR_COUNT) {
index_ = 0;
}
updateColor();
} else {
ticks_ -= t; // Update timing
}
}
private:
uint16_t ticks_;
uint8_t index_;
void updateColor() {
setColor(COLORS[index_]);
ticks_ = 100;
}
static const uint32_t COLORS[];
static const size_t COLOR_COUNT;
};
const uint32_t LEDCloudSignalStatus::COLORS[] = { 0xEE82EE, 0x4B0082, 0x0000FF, 0x00FF00, 0xFFFF00, 0xFFA500, 0xFF0000 }; // VIBGYOR
const size_t LEDCloudSignalStatus::COLOR_COUNT = sizeof(LEDCloudSignalStatus::COLORS) / sizeof(LEDCloudSignalStatus::COLORS[0]);
void clientMessagesProcessed(void* reserved) {
if (SPARK_CLOUD_HANDSHAKE_PENDING) {
SPARK_CLOUD_HANDSHAKE_NOTIFY_DONE = 1;
SPARK_CLOUD_HANDSHAKE_PENDING = 0;
LOG(INFO, "All handshake messages have been processed");
}
}
bool publishSafeModeEventIfNeeded() {
if (system_mode() == SAFE_MODE) {
LOG(INFO, "Sending safe mode event");
return publishEvent("spark/device/safemode", "");
}
return true; // ok
}
void handleServerMovedRequest(const char* reqData, size_t reqSize, ServerMovedResponseCallback respCallback, void* ctx) {
clear_system_error_message();
#if PLATFORM_ID != PLATFORM_GCC && PLATFORM_ID != PLATFORM_NEWHAL
int result = SYSTEM_ERROR_UNKNOWN;
NAMED_SCOPE_GUARD(respGuard, {
respCallback(result, ctx);
});
// Parse the request
// TODO: Add a helper function to initialize a buffered stream and decode Protobuf data in one call
auto stream = pb_istream_init(nullptr /* reserved */);
if (!stream) {
result = SYSTEM_ERROR_NO_MEMORY;
return;
}
NAMED_SCOPE_GUARD(streamGuard, {
pb_istream_free(stream, nullptr /* reserved */);
});
bool ok = pb_istream_from_buffer_ex(stream, (const pb_byte_t*)reqData, reqSize, nullptr /* reserved */);
if (!ok) {
result = SYSTEM_ERROR_INTERNAL;
return;
}
particle_cloud_ServerMovedPermanentlyRequest pbReq = {};
DecodedCString pbAddr(&pbReq.server_addr); // Decode to a null-terminated string
DecodedString pbPubKey(&pbReq.server_pub_key);
DecodedString pbSign(&pbReq.sign);
ok = pb_decode(stream, &particle_cloud_ServerMovedPermanentlyRequest_msg, &pbReq);
if (!ok) {
SYSTEM_ERROR_MESSAGE("Failed to parse ServerMoved request");
result = SYSTEM_ERROR_BAD_DATA;
return;
}
pb_istream_free(stream, nullptr);
streamGuard.dismiss();
// Validate the request
ServerConfig::ServerMovedRequest req;
req.address = pbAddr.data;
req.port = pbReq.server_port;
req.publicKey = (const uint8_t*)pbPubKey.data;
req.publicKeySize = pbPubKey.size;
req.signature = (const uint8_t*)pbSign.data;
req.signatureSize = pbSign.size;
int r = ServerConfig::instance()->validateServerMovedRequest(req);
if (r < 0) {
SYSTEM_ERROR_MESSAGE("Failed to validate ServerMoved request: %d", r);
result = r;
return;
}
// Reply to the server
respCallback(SYSTEM_ERROR_NONE, ctx);
respGuard.dismiss();
// Gracefully disconnect from the cloud and clear the session data
CloudConnectionSettings::instance()->setPendingDisconnectOptions(CloudDisconnectOptions().graceful(true)
.clearSession(true));
cloud_disconnect(CLOUD_DISCONNECT_GRACEFULLY, CLOUD_DISCONNECT_REASON_SERVER_MOVED);
// Apply the new server settings
r = ServerConfig::instance()->updateSettings(req);
if (r < 0) {
LOG(ERROR, "Failed to update server settings: %d", r);
// Reset anyway
}
system_pending_shutdown(RESET_REASON_CONFIG_UPDATE);
#else
respCallback(SYSTEM_ERROR_NOT_SUPPORTED, ctx);
#endif // PLATFORM_ID == PLATFORM_GCC && PLATFORM_ID != PLATFORM_NEWHAL
}
#if HAL_PLATFORM_COMPRESSED_OTA
// Minimum bootloader version required to support compressed/combined OTA updates
const uint16_t COMPRESSED_OTA_MIN_BOOTLOADER_VERSION = 1000; // 2.0.0
#endif // HAL_PLATFORM_COMPRESSED_OTA
} // namespace
void Spark_Signal(bool on, unsigned, void*)
{
static LEDCloudSignalStatus ledCloudSignal(LED_PRIORITY_IMPORTANT);
ledCloudSignal.setActive(on);
}
size_t system_interpolate_cloud_server_hostname(const char* var, size_t var_len, char* buf, size_t buf_len)
{
if (var_len==2 && memcmp("id", var, 2)==0)
{
String deviceID = spark_deviceID();
size_t id_len = deviceID.length();
SystemVersionInfo sys_ver = {};
sys_ver.size = sizeof(SystemVersionInfo);
system_version_info(&sys_ver, nullptr);
uint8_t mv = BYTE_N(sys_ver.versionNumber, 3);
String majorVer = String::format(".v%d", mv);
size_t mv_len = majorVer.length();
if (buf_len > (id_len + mv_len)) {
memcpy(buf, deviceID.c_str(), id_len);
memcpy(buf + id_len, majorVer.c_str(), mv_len);
return id_len + mv_len;
}
}
return 0;
}
int userVarType(const char *varKey)
{
User_Var_Lookup_Table_t* item = find_var_by_key(varKey);
return item ? item->userVarType : -1;
}
SparkReturnType::Enum protocolVariableType(Spark_Data_TypeDef type) {
switch (type) {
case CLOUD_VAR_BOOLEAN:
return SparkReturnType::BOOLEAN;
case CLOUD_VAR_DOUBLE:
return SparkReturnType::DOUBLE;
case CLOUD_VAR_STRING:
return SparkReturnType::STRING;
default:
return SparkReturnType::INT;
}
}
size_t variableDataSize(const void* data, Spark_Data_TypeDef type) {
switch (type) {
case CLOUD_VAR_BOOLEAN:
return sizeof(bool);
case CLOUD_VAR_DOUBLE:
return sizeof(double);
case CLOUD_VAR_STRING:
return data ? strlen((const char*)data) : 0;
default:
return sizeof(uint32_t);
}
}
void getUserVarResult(int error, int type, void* data, size_t size, SparkDescriptor::GetVariableCallback callback,
void* context) {
SYSTEM_THREAD_CONTEXT_ASYNC(getUserVarResult(error, type, data, size, callback, context));
callback(error, type, data, size, context);
}
void getUserVarImpl(User_Var_Lookup_Table_t* item, SparkDescriptor::GetVariableCallback callback, void* context)
{
APPLICATION_THREAD_CONTEXT_ASYNC(getUserVarImpl(item, callback, context));
size_t size = 0;
void* copy = nullptr;
NAMED_SCOPE_GUARD(copyGuard, {
free(copy);
});
if (item->copy) {
const int result = item->copy(item->userVar, ©, &size);
if (result < 0) {
getUserVarResult(ProtocolError::NO_MEMORY, 0 /* type */, nullptr /* data */, 0 /* size */, callback, context);
return;
}
} else {
const void* data = nullptr;
if (item->update) {
data = item->update(item->userVarKey, item->userVarType, item->userVar, nullptr);
} else {
data = item->userVar;
}
size = variableDataSize(data, item->userVarType);
if (size > 0) {
copy = malloc(size);
if (!copy) {
getUserVarResult(ProtocolError::NO_MEMORY, 0, nullptr, 0, callback, context);
return;
}
memcpy(copy, data, size);
}
}
const auto type = protocolVariableType(item->userVarType); // Spark_Data_TypeDef -> SparkReturnType::Enum
getUserVarResult(ProtocolError::NO_ERROR, type, copy, size, callback, context);
copyGuard.dismiss();
}
void getUserVar(const char* varKey, SparkDescriptor::GetVariableCallback callback, void* context)
{
const auto item = find_var_by_key(varKey);
if (item) {
getUserVarImpl(item, callback, context);
} else {
callback(ProtocolError::NOT_FOUND, 0 /* type */, nullptr /* data */, 0 /* size */, context);
}
}
void userFuncScheduleImpl(User_Func_Lookup_Table_t* item, const char* paramString, bool freeParamString, SparkDescriptor::FunctionResultCallback callback)
{
int result = item->pUserFunc(item->pUserFuncData, paramString, NULL);
if (freeParamString)
delete paramString;
// run the cloud return on the system thread again
SYSTEM_THREAD_CONTEXT_ASYNC(callback((const void*)long(result), SparkReturnType::INT));
callback((const void*)long(result), SparkReturnType::INT);
}
int userFuncSchedule(const char *funcKey, const char *paramString, SparkDescriptor::FunctionResultCallback callback, void* reserved)
{
// for now, we invoke the function directly and return the result via the callback
User_Func_Lookup_Table_t* item = find_func_by_key(funcKey);
if (!item)
return -1;
#if PLATFORM_THREADING
paramString = strdup(paramString); // ensure we have a copy since the oriignal isn't guaranteed to be available once this function returns.
APPLICATION_THREAD_CONTEXT_ASYNC_RESULT(userFuncScheduleImpl(item, paramString, true, callback), 0);
userFuncScheduleImpl(item, paramString, true, callback);
#else
userFuncScheduleImpl(item, paramString, false, callback);
#endif
return 0;
}
static const char* resetReasonString(System_Reset_Reason reason)
{
switch (reason) {
case RESET_REASON_UNKNOWN:
return "unknown";
case RESET_REASON_PIN_RESET:
return "pin_reset";
case RESET_REASON_POWER_MANAGEMENT:
return "power_management";
case RESET_REASON_POWER_DOWN:
return "power_down";
case RESET_REASON_POWER_BROWNOUT:
return "power_brownout";
case RESET_REASON_WATCHDOG:
return "watchdog";
case RESET_REASON_UPDATE:
return "update";
case RESET_REASON_UPDATE_ERROR:
return "update_error";
case RESET_REASON_UPDATE_TIMEOUT:
return "update_timeout";
case RESET_REASON_FACTORY_RESET:
return "factory_reset";
case RESET_REASON_SAFE_MODE:
return "safe_mode";
case RESET_REASON_DFU_MODE:
return "dfu_mode";
case RESET_REASON_PANIC:
return "panic";
case RESET_REASON_USER:
return "user";
case RESET_REASON_CONFIG_UPDATE:
return "config_update";
default:
return nullptr;
}
}
static const char* panicCodeString(ePanicCode code)
{
switch (code) {
case HardFault:
return "hard_fault";
case MemManage:
return "memory_fault";
case BusFault:
return "bus_fault";
case UsageFault:
return "usage_fault";
case OutOfHeap:
return "out_of_heap";
case AssertionFailure:
return "assert_failed";
case StackOverflow:
return "stack_overflow";
default:
return nullptr;
}
}
static void formatResetReasonEventData(int reason, uint32_t data, char *buf, size_t size)
{
// TODO: Consider using numeric reason codes instead of string identifiers for uniformity
// with the CoAP protocol
// Reset reason
int n = 0;
const char* s = resetReasonString((System_Reset_Reason)reason);
if (s) {
n = snprintf(buf, size, "%s", s);
} else {
n = snprintf(buf, size, "%d", (int)reason); // Print as numeric code
}
if (n < 0 || n >= (int)size) {
return;
}
buf += n;
size -= n;
// Additional data for selected reason codes
if (reason == RESET_REASON_PANIC) {
s = panicCodeString((ePanicCode)data);
if (s) {
n = snprintf(buf, size, ", %s", s);