Reconfiguration¶
As discussed in the application kick-starting section, the Loader component (or any component inheriting from it) is responsible for configuring and starting a standard MARTe applicaton (i.e. one that relies on the MARTeApp.cpp).
The Loader component also offers a reconfiguration interface (see Loader::Reconfigure) that can be used in runtime to modify the configuration of an application that is already in execution.
Any component inheriting from the Loader class can implement the PostInit method in order to receive runtime configuration parameters (e.g. a TCP port where to listen for new configurations).
The Loader also offers a set of pre-defined message triggers that are sent: before the configuration is modified; after the configuration is (successfully) applied; in case a configuration error occurs; and if a configuration occurs and the user has configured the option to reload the last valid configuration.
Finally, the Loader components also allows to query the currently loaded configuration (see Loader::GetLastValidConfiguration).
The ConfigurationLoaderTCP in an implementation that allows changing the runtime configuration over a TCP connection.
Examples¶
Valid reconfiguration¶
This is an example of a MARTeApp that uses a ConfigurationLoaderTCP.
Start the application with the -m parameter.
To modify a configuration, start the application and, on another console, type nc localhost 24680 < RTApp-9-reload.cfg.
The new configuration has a higher cycle time so that the frequency at which the signals are printed into console should significantly increase.
To return to a configuration running at a lower frequency, on another console, type nc localhost 24680 < RTApp-9-reload-2.cfg.
ConfigurationLoaderTCP application (Run with NAME_OF_THE_MESSAGE=StateMachine:START and NAME_OF_THE_CONFIGURATION_FILE=RTApp-9.cfg)¶
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 | +LoaderPostInit = {
Class = ReferenceContainer
+Parameters = {
Class = ConfigurationDatabase
Port = 24680//The port where to listen for the TCP messages.
ReloadLast = true //Reload old configuration in case of (re)configuration failure? Default = true. If true the FailedConfiguration message will not to be sent.
}
+Messages = {
Class = ReferenceContainer
+PreConfiguration = { //Optional message to send before the configuration is applied.
Class = Message
Destination = StateMachine
Function = STOP
Mode = ExpectsReply
}
+PostConfiguration = { //Optional message to send if the configuration was successfully applied.
Class = Message
Destination = StateMachine
Function = START
Mode = ExpectsReply
}
}
}
+StateMachine = {
Class = StateMachine
+INITIAL = {
Class = ReferenceContainer
+START = {
Class = StateMachineEvent
NextState = "STATE1"
NextStateError = "ERROR"
Timeout = 0
+ChangeToState1Msg = {
Class = Message
Destination = TestApp
Mode = ExpectsReply
Function = PrepareNextState
+Parameters = {
Class = ConfigurationDatabase
param1 = State1
}
}
+StartNextStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StartNextStateExecution
Mode = ExpectsReply
}
}
}
+STATE1 = {
Class = ReferenceContainer
+GOTOSTATE2 = {
Class = StateMachineEvent
NextState = "STATE2"
NextStateError = "ERROR"
Timeout = 0
+PrepareChangeToState2Msg = {
Class = Message
Destination = TestApp
Mode = ExpectsReply
Function = PrepareNextState
+Parameters = {
Class = ConfigurationDatabase
param1 = State2
}
}
+StopCurrentStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StopCurrentStateExecution
Mode = ExpectsReply
}
+StartNextStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StartNextStateExecution
Mode = ExpectsReply
}
}
+STOP = {
Class = StateMachineEvent
NextState = "STOPPED"
NextStateError = "ERROR"
Timeout = 0
+StopCurrentStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StopCurrentStateExecution
Mode = ExpectsReply
}
}
+ERROR = {
Class = StateMachineEvent
NextState = "ERROR"
NextStateError = "ERROR"
}
}
+STATE2 = {
Class = ReferenceContainer
+GOTOSTATE1 = {
Class = StateMachineEvent
NextState = "STATE1"
NextStateError = "ERROR"
Timeout = 0
+PrepareChangeToState1Msg = {
Class = Message
Destination = TestApp
Mode = ExpectsReply
Function = PrepareNextState
+Parameters = {
Class = ConfigurationDatabase
param1 = State1
}
}
+StopCurrentStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StopCurrentStateExecution
Mode = ExpectsReply
}
+StartNextStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StartNextStateExecution
Mode = ExpectsReply
}
}
+STOP = {
Class = StateMachineEvent
NextState = "STOPPED"
NextStateError = "ERROR"
Timeout = 0
+StopCurrentStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StopCurrentStateExecution
Mode = ExpectsReply
}
}
+ERROR = {
Class = StateMachineEvent
NextState = "ERROR"
NextStateError = "ERROR"
}
}
+STOPPED = {
Class = ReferenceContainer
+START = {
Class = StateMachineEvent
NextState = "STATE1"
NextStateError = "ERROR"
Timeout = 0
+ChangeToState1Msg = {
Class = Message
Destination = TestApp
Mode = ExpectsReply
Function = PrepareNextState
+Parameters = {
Class = ConfigurationDatabase
param1 = State1
}
}
+StartNextStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StartNextStateExecution
Mode = ExpectsReply
}
}
}
+ERROR = {
Class = ReferenceContainer
+ENTER = {
Class = ReferenceContainer
+StopCurrentStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StopCurrentStateExecution
Mode = ExpectsReply
}
+PrepareChangeToErrorMsg = {
Class = Message
Destination = TestApp
Mode = ExpectsReply
Function = PrepareNextState
+Parameters = {
Class = ConfigurationDatabase
param1 = StateError
}
}
+StartNextStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StartNextStateExecution
Mode = ExpectsReply
}
}
+RESET = {
Class = StateMachineEvent
NextState = "STATE1"
NextStateError = "STATE1"
Timeout = 0
+StopCurrentStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StopCurrentStateExecution
Mode = ExpectsReply
}
+PrepareChangeToState1Msg = {
Class = Message
Destination = TestApp
Mode = ExpectsReply
Function = PrepareNextState
+Parameters = {
Class = ConfigurationDatabase
param1 = State1
}
}
+StartNextStateExecutionMsg = {
Class = Message
Destination = TestApp
Function = StartNextStateExecution
Mode = ExpectsReply
}
}
}
}
$TestApp = {
Class = RealTimeApplication
+Functions = {
Class = ReferenceContainer
+GAMTimer = {
Class = IOGAM
InputSignals = {
Counter = {
DataSource = Timer
Type = uint32
}
Time = {
Frequency = 1
DataSource = Timer
Type = uint32
}
}
OutputSignals = {
Counter = {
DataSource = DDB1
Type = uint32
}
Time = {
DataSource = DDB1
Type = uint32
}
}
}
+GAMVariable1 = {
Class = VariableGAMExample1
Gains = {2, 3, 4}
InputSignals = {
Counter = {
DataSource = DDB1
Type = uint32
}
}
OutputSignals = {
GainCounter1Thread1 = {
DataSource = DDB1
Type = uint32
}
GainCounter2Thread1 = {
DataSource = DDB1
Type = uint32
}
GainCounter3Thread1 = {
DataSource = DDB1
Type = uint32
}
}
}
+GAMT1TSynchOut = {
Class = IOGAM
InputSignals = {
GainCounter1Thread1 = {
DataSource = DDB1
Type = uint32
}
GainCounter2Thread1 = {
DataSource = DDB1
Type = uint32
}
GainCounter3Thread1 = {
DataSource = DDB1
Type = uint32
}
}
OutputSignals = {
GainCounter1Thread1 = {
DataSource = RTThreadSynch
Type = uint32
}
GainCounter2Thread1 = {
DataSource = RTThreadSynch
Type = uint32
}
GainCounter3Thread1 = {
DataSource = RTThreadSynch
Type = uint32
}
}
}
+GAMT1T2Interface = {
Class = IOGAM
InputSignals = {
GainCounter1Thread1 = {
DataSource = RTThreadSynch
Type = uint32
Samples = 2 //Run at half the frequency of thread 1
}
GainCounter2Thread1 = {
DataSource = RTThreadSynch
Type = uint32
Samples = 2 //Run at half the frequency of thread 1
}
GainCounter3Thread1 = {
DataSource = RTThreadSynch
Type = uint32
Samples = 2 //Run at half the frequency of thread 1
}
}
OutputSignals = {
GainCounter1Thread2 = {
DataSource = DDB1
Type = uint32
Samples = 1
NumberOfDimensions = 1
NumberOfElements = 2 //2 elements for each cycle (as it waits for 2 samples)
}
GainCounter2Thread2 = {
DataSource = DDB1
Type = uint32
Samples = 1
NumberOfDimensions = 1
NumberOfElements = 2 //2 elements for each cycle (as it waits for 2 samples)
}
GainCounter3Thread2 = {
DataSource = DDB1
Type = uint32
Samples = 1
NumberOfDimensions = 1
NumberOfElements = 2 //2 elements for each cycle (as it waits for 2 samples)
}
}
}
+GAMT1T3Interface = {
Class = IOGAM
InputSignals = {
GainCounter1Thread1 = {
DataSource = RTThreadSynch
Type = uint32
Samples = 4 //Run at one quarter of the frequency of thread 1
}
GainCounter2Thread1 = {
DataSource = RTThreadSynch
Type = uint32
Samples = 4 //Run at one quarter the frequency of thread 1
}
GainCounter3Thread1 = {
DataSource = RTThreadSynch
Type = uint32
Samples = 4 //Run at one quarter the frequency of thread 1
}
}
OutputSignals = {
GainCounter1Thread3 = {
DataSource = DDB1
Type = uint32
Samples = 1
NumberOfDimensions = 1
NumberOfElements = 4 //4 elements for each cycle (as it waits for 4 samples)
}
GainCounter2Thread3 = {
DataSource = DDB1
Type = uint32
Samples = 1
NumberOfDimensions = 1
NumberOfElements = 4 //4 elements for each cycle (as it waits for 4 samples)
}
GainCounter3Thread3 = {
DataSource = DDB1
Type = uint32
Samples = 1
NumberOfDimensions = 1
NumberOfElements = 4 //4 elements for each cycle (as it waits for 4 samples)
}
}
}
+GAMDisplayThread1 = {
Class = IOGAM
InputSignals = {
Counter = {
DataSource = DDB1
Type = uint32
}
GainCounter1Thread1 = {
DataSource = DDB1
Type = uint32
}
GainCounter2Thread1 = {
DataSource = DDB1
Type = uint32
}
GainCounter3Thread1 = {
DataSource = DDB1
Type = uint32
}
}
OutputSignals = {
Counter = {
DataSource = LoggerDataSource
Type = uint32
}
GainCounter1Thread1 = {
DataSource = LoggerDataSource
Type = uint32
}
GainCounter2Thread1 = {
DataSource = LoggerDataSource
Type = uint32
}
GainCounter3Thread1 = {
DataSource = LoggerDataSource
Type = uint32
}
}
}
+GAMDisplayThread2 = {
Class = IOGAM
InputSignals = {
GainCounter1Thread2 = {
DataSource = DDB1
Type = uint32
}
GainCounter2Thread2 = {
DataSource = DDB1
Type = uint32
}
GainCounter3Thread2 = {
DataSource = DDB1
Type = uint32
}
}
OutputSignals = {
GainCounter1Thread2 = {
DataSource = LoggerDataSource
Type = uint32
NumberOfDimensions = 1
NumberOfElements = 2
}
GainCounter2Thread2 = {
DataSource = LoggerDataSource
Type = uint32
NumberOfDimensions = 1
NumberOfElements = 2
}
GainCounter3Thread2 = {
DataSource = LoggerDataSource
Type = uint32
NumberOfDimensions = 1
NumberOfElements = 2
}
}
}
+GAMDisplayThread3 = {
Class = IOGAM
InputSignals = {
GainCounter1Thread3 = {
DataSource = DDB1
Type = uint32
}
GainCounter2Thread3 = {
DataSource = DDB1
Type = uint32
}
GainCounter3Thread3 = {
DataSource = DDB1
Type = uint32
}
}
OutputSignals = {
GainCounter1Thread3 = {
DataSource = LoggerDataSource
Type = uint32
NumberOfDimensions = 1
NumberOfElements = 4
}
GainCounter2Thread3 = {
DataSource = LoggerDataSource
Type = uint32
NumberOfDimensions = 1
NumberOfElements = 4
}
GainCounter3Thread3 = {
DataSource = LoggerDataSource
Type = uint32
NumberOfDimensions = 1
NumberOfElements = 4
}
}
}
}
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB1
+DDB1 = {
Class = GAMDataSource
}
+LoggerDataSource = {
Class = LoggerDataSource
}
+Timings = {
Class = TimingDataSource
}
+RTThreadSynch = {
Class = RealTimeThreadSynchronisation
Timeout = 5000 //Timeout in ms to wait for the thread to cycle.
}
+Timer = {
Class = LinuxTimer
SleepNature = "Default"
Signals = {
Counter = {
Type = uint32
}
Time = {
Type = uint32
}
}
}
}
+States = {
Class = ReferenceContainer
+State1 = {
Class = RealTimeState
+Threads = {
Class = ReferenceContainer
+Thread1 = {
Class = RealTimeThread
CPUs = 0x1
Functions = {GAMTimer GAMVariable1 GAMT1TSynchOut GAMDisplayThread1}
}
}
}
+State2 = {
Class = RealTimeState
+Threads = {
Class = ReferenceContainer
+Thread1 = {
Class = RealTimeThread
CPUs = 0x1
Functions = {GAMTimer GAMVariable1 GAMT1TSynchOut GAMDisplayThread1}
}
+Thread2 = {
Class = RealTimeThread
CPUs = 0x2
Functions = {GAMT1T2Interface GAMDisplayThread2}
}
+Thread3 = {
Class = RealTimeThread
CPUs = 0x4
Functions = {GAMT1T3Interface GAMDisplayThread3}
}
}
}
+StateError = {
Class = RealTimeState
+Threads = {
Class = ReferenceContainer
+Thread1 = {
Class = RealTimeThread
CPUs = 0x1
Functions = {GAMTimer}
}
}
}
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = Timings
}
}
|
Invalid reconfiguration¶
Given that the application was launched with the parameter ReloadLast=true, a failed reconfiguration attempt will trigger the reloading of the last valid configuration.
To load an invalid configuration, start the application and, on another console, type nc localhost 24680 < RTApp-9-reload-fail.cfg. Notice that the application will continue to run at the original frequency.