Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: use mSystemState if systemState not passed in params #37451

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: use mSystemState if systemState not passed in params #37451

wants to merge 1 commit into from

Conversation

j0tunn
Copy link
Contributor

@j0tunn j0tunn commented Feb 7, 2025

Fallback to use current system state in case of calling InitControllerNOCChain without systemState parameter after controller initialization.
Now program will crash. After this fix it will try to use initialized controller system state, or caller will get concrete error.

Testing

Manual testing

@semanticdiff-com SemanticDiff.com
Copy link

Review changes with  SemanticDiff

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 7, 2025 •
edited
Loading

PR #37451: Size comparison from 1348a8a to 45b53ae

Full report (72 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
platform target config section 1348a8a 45b53ae change % change
bl602 lighting-app bl602+mfd+littlefs+rpc FLASH 1094778 1094778 0 0.0
RAM 103346 103346 0 0.0
bl702 lighting-app bl702+eth FLASH 650600 650600 0 0.0
RAM 25265 25265 0 0.0
bl702+wifi FLASH 828564 828564 0 0.0
RAM 13981 13981 0 0.0
bl706+mfd+rpc+littlefs FLASH 1057816 1057816 0 0.0
RAM 23893 23893 0 0.0
bl702l contact-sensor-app bl702l+mfd+littlefs FLASH 888502 888502 0 0.0
RAM 18504 18504 0 0.0
lighting-app bl702l+mfd+littlefs FLASH 971544 971544 0 0.0
RAM 16368 16368 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 838456 838456 0 0.0
RAM 123480 123480 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 823860 823860 0 0.0
RAM 125360 125360 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 771036 771036 0 0.0
RAM 113820 113820 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 755304 755304 0 0.0
RAM 114028 114028 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 538925 538925 0 0.0
RAM 205208 205208 0 0.0
lock CC3235SF_LAUNCHXL FLASH 572805 572805 0 0.0
RAM 205360 205360 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 679809 679809 0 0.0
RAM 78548 78548 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 699653 699653 0 0.0
RAM 81188 81188 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 699653 699653 0 0.0
RAM 81188 81188 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 656589 656589 0 0.0
RAM 73616 73616 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 616153 616153 0 0.0
RAM 71532 71532 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 635781 635781 0 0.0
RAM 74076 74076 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 635781 635781 0 0.0
RAM 74076 74076 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 635657 635657 0 0.0
RAM 74540 74540 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 655365 655365 0 0.0
RAM 77084 77084 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 655365 655365 0 0.0
RAM 77084 77084 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 612077 612077 0 0.0
RAM 68628 68628 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 631937 631937 0 0.0
RAM 71268 71268 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 631937 631937 0 0.0
RAM 71268 71268 0 0.0
efr32 lock-app BRD4187C FLASH 937120 937120 0 0.0
RAM 159904 159904 0 0.0
BRD4338a FLASH 730516 730516 0 0.0
RAM 234716 234716 0 0.0
window-app BRD4187C FLASH 1029808 1029808 0 0.0
RAM 128008 128008 0 0.0
esp32 all-clusters-app c3devkit DRAM 97312 97312 0 0.0
FLASH 1577574 1577574 0 0.0
IRAM 83820 83820 0 0.0
m5stack DRAM 116100 116100 0 0.0
FLASH 1545434 1545434 0 0.0
IRAM 117039 117039 0 0.0
linux air-purifier-app debug unknown 4760 4760 0 0.0
FLASH 2709805 2709805 0 0.0
RAM 132784 132784 0 0.0
all-clusters-app debug unknown 5568 5568 0 0.0
FLASH 5976268 5976268 0 0.0
RAM 531600 531600 0 0.0
all-clusters-minimal-app debug unknown 5464 5464 0 0.0
FLASH 5324612 5324612 0 0.0
RAM 242712 242712 0 0.0
bridge-app debug unknown 5480 5480 0 0.0
FLASH 4683224 4683224 0 0.0
RAM 221448 221448 0 0.0
chip-tool debug unknown 6120 6120 0 0.0
FLASH 13099952 13100044 92 0.0
RAM 596578 596578 0 0.0
chip-tool-ipv6only arm64 unknown 21816 21816 0 0.0
FLASH 11163376 11163488 112 0.0
RAM 648256 648256 0 0.0
fabric-admin debug unknown 5808 5808 0 0.0
FLASH 11388981 11389073 92 0.0
RAM 596362 596362 0 0.0
fabric-bridge-app debug unknown 4736 4736 0 0.0
FLASH 4508482 4508482 0 0.0
RAM 208632 208632 0 0.0
fabric-sync debug unknown 4976 4976 0 0.0
FLASH 5614773 5614869 96 0.0
RAM 483504 483504 0 0.0
lighting-app debug+rpc+ui unknown 6144 6144 0 0.0
FLASH 5630465 5630465 0 0.0
RAM 231792 231792 0 0.0
lock-app debug unknown 5416 5416 0 0.0
FLASH 4731818 4731818 0 0.0
RAM 207696 207696 0 0.0
ota-provider-app debug unknown 4776 4776 0 0.0
FLASH 4360788 4360788 0 0.0
RAM 201336 201336 0 0.0
ota-requestor-app debug unknown 4728 4728 0 0.0
FLASH 4498196 4498196 0 0.0
RAM 205920 205920 0 0.0
shell debug unknown 4256 4256 0 0.0
FLASH 3006445 3006445 0 0.0
RAM 160472 160472 0 0.0
thermostat-no-ble arm64 unknown 9512 9512 0 0.0
FLASH 4097736 4097736 0 0.0
RAM 246024 246024 0 0.0
tv-app debug unknown 5744 5744 0 0.0
FLASH 5953653 5953749 96 0.0
RAM 606904 606904 0 0.0
tv-casting-app debug unknown 5320 5320 0 0.0
FLASH 11273469 11273469 0 0.0
RAM 710864 710864 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 907584 907584 0 0.0
RAM 142411 142411 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 902100 902100 0 0.0
RAM 124755 124755 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 846188 846188 0 0.0
RAM 141339 141339 0 0.0
nxp contact k32w0+release FLASH 584768 584768 0 0.0
RAM 70876 70876 0 0.0
mcxw71+release FLASH 600232 600232 0 0.0
RAM 63096 63096 0 0.0
light k32w0+release FLASH 611076 611076 0 0.0
RAM 70268 70268 0 0.0
k32w1+release FLASH 685552 685552 0 0.0
RAM 48680 48680 0 0.0
lock mcxw71+release FLASH 749040 749040 0 0.0
RAM 67492 67492 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1646972 1646972 0 0.0
RAM 211576 211576 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1553876 1553876 0 0.0
RAM 208392 208392 0 0.0
light cy8ckit_062s2_43012 FLASH 1469604 1469604 0 0.0
RAM 200368 200368 0 0.0
lock cy8ckit_062s2_43012 FLASH 1467540 1467540 0 0.0
RAM 224704 224704 0 0.0
qpg lighting-app qpg6105+debug FLASH 662360 662360 0 0.0
RAM 105220 105220 0 0.0
lock-app qpg6105+debug FLASH 620148 620148 0 0.0
RAM 99664 99664 0 0.0
stm32 light STM32WB5MM-DK FLASH 483016 483016 0 0.0
RAM 144688 144688 0 0.0
telink bridge-app tl7218x FLASH 665410 665410 0 0.0
RAM 90828 90828 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 622172 622172 0 0.0
RAM 31500 31500 0 0.0
light-app-ota-shell-factory-data tl3218x FLASH 770956 770956 0 0.0
RAM 43568 43568 0 0.0
tl7218x FLASH 779458 779458 0 0.0
RAM 98704 98704 0 0.0
light-switch-app-ota-compress-lzma-factory-data tl7218x_retention FLASH 680770 680770 0 0.0
RAM 52192 52192 0 0.0
light-switch-app-ota-compress-lzma-shell-factory-data tlsr9528a FLASH 709324 709324 0 0.0
RAM 73400 73400 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 626260 626260 0 0.0
RAM 142032 142032 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 814104 814104 0 0.0
RAM 99608 99608 0 0.0
tizen all-clusters-app arm unknown 5104 5104 0 0.0
FLASH 1752644 1752644 0 0.0
RAM 93508 93508 0 0.0
chip-tool-ubsan arm unknown 11396 11396 0 0.0
FLASH 18698574 18698758 184 0.0
RAM 8183320 8183436 116 0.0

@andy31415
Copy link
Contributor

@j0tunn could you describe in the summary under what conditions we want to allow params to not initialize msystemstate?

I am trying to determine if this "use mSystemState" is generally something desirable as it adds a dependency chain of "this works if and only if mSystemState was initialized before" so the API seems to be slightly more coupled. I would generally lean towards "enforce params must always contain a system state" however unsure what the actual use case is here.

@j0tunn
Copy link
Contributor Author

j0tunn commented Feb 13, 2025 •
edited
Loading

@andy31415 scenario I'm trying to implement is to split commissioner initialization into two phases:

  1. general initalization without calling InitControllerNOCChain. It is possible if I'll pass parameters without operationalKeypair, controllerNOC and controllerRCAC
  2. separate call of InitControllerNOCChain

The reason to do so is the necessity to retry InitControllerNOCChain on cert validation fail. Drop old certs previously and call InitControllerNOCChain again. So new valid certs will be generated during the second call.

Commissioner initialization is performed via DeviceControllerFactory::SetupCommissioner and mSystemState is its private field, which is then passed to Commissioner::Init through parameters. And there is just no public API to get the system state to be able to pass it to InitControllerNOCChain.

So this PR just expands the API: you can pass systemState via params or you can use the mSystemState installed in Init call.
Or you'll get clear error code if nether systemState passed nor Init was called previously.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
controller review - pending
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@j0tunn @andy31415