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

[Darwin] MTRDevice should throttle deviceBecameActive callbacks #37436

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[Darwin] MTRDevice should throttle deviceBecameActive callbacks #37436

wants to merge 2 commits into from
+27 −5

Conversation

jtung-apple
Copy link
Contributor

@jtung-apple jtung-apple commented Feb 6, 2025 •
edited by woody-apple
Loading

Some testing is showing that if/when a device sends frequent subscription keepalives, it causes this API surface to generate too many callbacks. This PR addresses it by adding a simple throttle based on MTRDevice's minimum suggested subscription keep alive interval.

Testing

Verified locally and existing unit tests cover

@jtung-apple jtung-apple requested a review from a team as a code owner February 6, 2025 20:07
@semanticdiff-com SemanticDiff.com
Copy link

Review changes with  SemanticDiff

@github-actions GitHub Actions
Copy link

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

PR #37436: Size comparison from 2cf6dd8 to b80388a

Full report (57 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
platform target config section 2cf6dd8 b80388a change % change
bl602 lighting-app bl602+mfd+littlefs+rpc FLASH 1094024 1094024 0 0.0
RAM 103314 103314 0 0.0
bl702 lighting-app bl702+eth FLASH 650542 650542 0 0.0
RAM 25265 25265 0 0.0
bl702+wifi FLASH 828506 828506 0 0.0
RAM 13981 13981 0 0.0
bl706+mfd+rpc+littlefs FLASH 1057066 1057066 0 0.0
RAM 23861 23861 0 0.0
bl702l contact-sensor-app bl702l+mfd+littlefs FLASH 888444 888444 0 0.0
RAM 18504 18504 0 0.0
lighting-app bl702l+mfd+littlefs FLASH 971486 971486 0 0.0
RAM 16368 16368 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 838240 838240 0 0.0
RAM 123480 123480 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 823644 823644 0 0.0
RAM 125360 125360 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 770820 770820 0 0.0
RAM 113820 113820 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 755088 755088 0 0.0
RAM 114028 114028 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 538621 538621 0 0.0
RAM 205208 205208 0 0.0
lock CC3235SF_LAUNCHXL FLASH 572493 572493 0 0.0
RAM 205360 205360 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 679585 679585 0 0.0
RAM 78548 78548 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 699429 699429 0 0.0
RAM 81188 81188 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 699429 699429 0 0.0
RAM 81188 81188 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 656365 656365 0 0.0
RAM 73616 73616 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 615945 615945 0 0.0
RAM 71532 71532 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 635573 635573 0 0.0
RAM 74076 74076 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 635573 635573 0 0.0
RAM 74076 74076 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 635449 635449 0 0.0
RAM 74540 74540 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 655157 655157 0 0.0
RAM 77084 77084 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 655157 655157 0 0.0
RAM 77084 77084 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 611861 611861 0 0.0
RAM 68628 68628 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 631721 631721 0 0.0
RAM 71268 71268 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 631721 631721 0 0.0
RAM 71268 71268 0 0.0
efr32 lock-app BRD4187C FLASH 936408 936408 0 0.0
RAM 159872 159872 0 0.0
BRD4338a FLASH 730348 730348 0 0.0
RAM 234716 234716 0 0.0
window-app BRD4187C FLASH 1029656 1029656 0 0.0
RAM 128008 128008 0 0.0
esp32 all-clusters-app c3devkit DRAM 97312 97312 0 0.0
FLASH 1577420 1577420 0 0.0
IRAM 83820 83820 0 0.0
m5stack DRAM 116100 116100 0 0.0
FLASH 1545326 1545326 0 0.0
IRAM 117039 117039 0 0.0
linux chip-tool-ipv6only arm64 unknown 21816 21816 0 0.0
FLASH 11162800 11162800 0 0.0
RAM 648256 648256 0 0.0
thermostat-no-ble arm64 unknown 9512 9512 0 0.0
FLASH 4097192 4097192 0 0.0
RAM 246024 246024 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 907432 907432 0 0.0
RAM 142411 142411 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 901980 901980 0 0.0
RAM 124755 124755 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 846040 846040 0 0.0
RAM 141339 141339 0 0.0
nxp contact k32w0+release FLASH 584624 584624 0 0.0
RAM 70876 70876 0 0.0
mcxw71+release FLASH 599936 599936 0 0.0
RAM 63096 63096 0 0.0
light k32w0+release FLASH 610932 610932 0 0.0
RAM 70268 70268 0 0.0
k32w1+release FLASH 685336 685336 0 0.0
RAM 48680 48680 0 0.0
lock mcxw71+release FLASH 748832 748832 0 0.0
RAM 67492 67492 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1646740 1646740 0 0.0
RAM 211576 211576 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1553628 1553628 0 0.0
RAM 208392 208392 0 0.0
light cy8ckit_062s2_43012 FLASH 1469356 1469356 0 0.0
RAM 200368 200368 0 0.0
lock cy8ckit_062s2_43012 FLASH 1467308 1467308 0 0.0
RAM 224704 224704 0 0.0
qpg lighting-app qpg6105+debug FLASH 662216 662216 0 0.0
RAM 105220 105220 0 0.0
lock-app qpg6105+debug FLASH 619996 619996 0 0.0
RAM 99664 99664 0 0.0
stm32 light STM32WB5MM-DK FLASH 482872 482872 0 0.0
RAM 144688 144688 0 0.0
telink bridge-app tl7218x FLASH 665258 665258 0 0.0
RAM 90828 90828 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 622020 622020 0 0.0
RAM 31500 31500 0 0.0
light-app-ota-shell-factory-data tl3218x FLASH 770804 770804 0 0.0
RAM 43568 43568 0 0.0
tl7218x FLASH 779306 779306 0 0.0
RAM 98704 98704 0 0.0
light-switch-app-ota-compress-lzma-factory-data tl7218x_retention FLASH 680618 680618 0 0.0
RAM 52192 52192 0 0.0
light-switch-app-ota-compress-lzma-shell-factory-data tlsr9528a FLASH 709172 709172 0 0.0
RAM 73400 73400 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 626108 626108 0 0.0
RAM 142032 142032 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 813492 813492 0 0.0
RAM 99576 99576 0 0.0
tizen all-clusters-app arm unknown 5104 5104 0 0.0
FLASH 1752232 1752232 0 0.0
RAM 93508 93508 0 0.0
chip-tool-ubsan arm unknown 11396 11396 0 0.0
FLASH 18696694 18696694 0 0.0
RAM 8182536 8182536 0 0.0

@bzbarsky-apple
* Use a slightly shorter interval with its own define for deviceBecam…
ce5b841 
…eActive

  throttling.
* Log when we start throttling deviceBecameActive callbacks.
@github-actions GitHub Actions
Copy link

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

PR #37436: Size comparison from 2cf6dd8 to ce5b841

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 2cf6dd8 ce5b841 change % change
bl602 lighting-app bl602+mfd+littlefs+rpc FLASH 1094024 1094024 0 0.0
RAM 103314 103314 0 0.0
bl702 lighting-app bl702+eth FLASH 650542 650542 0 0.0
RAM 25265 25265 0 0.0
bl702+wifi FLASH 828506 828506 0 0.0
RAM 13981 13981 0 0.0
bl706+mfd+rpc+littlefs FLASH 1057066 1057066 0 0.0
RAM 23861 23861 0 0.0
bl702l contact-sensor-app bl702l+mfd+littlefs FLASH 888444 888444 0 0.0
RAM 18504 18504 0 0.0
lighting-app bl702l+mfd+littlefs FLASH 971486 971486 0 0.0
RAM 16368 16368 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 838240 838240 0 0.0
RAM 123480 123480 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 823644 823644 0 0.0
RAM 125360 125360 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 770820 770820 0 0.0
RAM 113820 113820 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 755088 755088 0 0.0
RAM 114028 114028 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 538621 538621 0 0.0
RAM 205208 205208 0 0.0
lock CC3235SF_LAUNCHXL FLASH 572493 572493 0 0.0
RAM 205360 205360 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 679585 679585 0 0.0
RAM 78548 78548 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 699429 699429 0 0.0
RAM 81188 81188 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 699429 699429 0 0.0
RAM 81188 81188 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 656365 656365 0 0.0
RAM 73616 73616 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 615945 615945 0 0.0
RAM 71532 71532 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 635573 635573 0 0.0
RAM 74076 74076 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 635573 635573 0 0.0
RAM 74076 74076 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 635449 635449 0 0.0
RAM 74540 74540 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 655157 655157 0 0.0
RAM 77084 77084 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 655157 655157 0 0.0
RAM 77084 77084 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 611861 611861 0 0.0
RAM 68628 68628 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 631721 631721 0 0.0
RAM 71268 71268 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 631721 631721 0 0.0
RAM 71268 71268 0 0.0
efr32 lock-app BRD4187C FLASH 936408 936408 0 0.0
RAM 159872 159872 0 0.0
BRD4338a FLASH 730348 730348 0 0.0
RAM 234716 234716 0 0.0
window-app BRD4187C FLASH 1029656 1029656 0 0.0
RAM 128008 128008 0 0.0
esp32 all-clusters-app c3devkit DRAM 97312 97312 0 0.0
FLASH 1577420 1577420 0 0.0
IRAM 83820 83820 0 0.0
m5stack DRAM 116100 116100 0 0.0
FLASH 1545326 1545326 0 0.0
IRAM 117039 117039 0 0.0
linux air-purifier-app debug unknown 4760 4760 0 0.0
FLASH 2709171 2709171 0 0.0
RAM 132784 132784 0 0.0
all-clusters-app debug unknown 5568 5568 0 0.0
FLASH 5975584 5975584 0 0.0
RAM 531600 531600 0 0.0
all-clusters-minimal-app debug unknown 5464 5464 0 0.0
FLASH 5323948 5323948 0 0.0
RAM 242712 242712 0 0.0
bridge-app debug unknown 5480 5480 0 0.0
FLASH 4682560 4682560 0 0.0
RAM 221448 221448 0 0.0
chip-tool debug unknown 6120 6120 0 0.0
FLASH 13099268 13099268 0 0.0
RAM 596578 596578 0 0.0
chip-tool-ipv6only arm64 unknown 21816 21816 0 0.0
FLASH 11162800 11162800 0 0.0
RAM 648256 648256 0 0.0
fabric-admin debug unknown 5808 5808 0 0.0
FLASH 11388297 11388297 0 0.0
RAM 596362 596362 0 0.0
fabric-bridge-app debug unknown 4736 4736 0 0.0
FLASH 4507818 4507818 0 0.0
RAM 208632 208632 0 0.0
fabric-sync debug unknown 4976 4976 0 0.0
FLASH 5614085 5614085 0 0.0
RAM 483504 483504 0 0.0
lighting-app debug+rpc+ui unknown 6144 6144 0 0.0
FLASH 5625217 5625217 0 0.0
RAM 231728 231728 0 0.0
lock-app debug unknown 5416 5416 0 0.0
FLASH 4731186 4731186 0 0.0
RAM 207696 207696 0 0.0
ota-provider-app debug unknown 4776 4776 0 0.0
FLASH 4360136 4360136 0 0.0
RAM 201336 201336 0 0.0
ota-requestor-app debug unknown 4728 4728 0 0.0
FLASH 4497640 4497640 0 0.0
RAM 205920 205920 0 0.0
shell debug unknown 4256 4256 0 0.0
FLASH 3005709 3005709 0 0.0
RAM 160472 160472 0 0.0
thermostat-no-ble arm64 unknown 9512 9512 0 0.0
FLASH 4097192 4097192 0 0.0
RAM 246024 246024 0 0.0
tv-app debug unknown 5744 5744 0 0.0
FLASH 5952965 5952965 0 0.0
RAM 606904 606904 0 0.0
tv-casting-app debug unknown 5320 5320 0 0.0
FLASH 11272797 11272797 0 0.0
RAM 710864 710864 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 907432 907432 0 0.0
RAM 142411 142411 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 901980 901980 0 0.0
RAM 124755 124755 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 846040 846040 0 0.0
RAM 141339 141339 0 0.0
nxp contact k32w0+release FLASH 584624 584624 0 0.0
RAM 70876 70876 0 0.0
mcxw71+release FLASH 599936 599936 0 0.0
RAM 63096 63096 0 0.0
light k32w0+release FLASH 610932 610932 0 0.0
RAM 70268 70268 0 0.0
k32w1+release FLASH 685336 685336 0 0.0
RAM 48680 48680 0 0.0
lock mcxw71+release FLASH 748832 748832 0 0.0
RAM 67492 67492 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1646740 1646740 0 0.0
RAM 211576 211576 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1553628 1553628 0 0.0
RAM 208392 208392 0 0.0
light cy8ckit_062s2_43012 FLASH 1469356 1469356 0 0.0
RAM 200368 200368 0 0.0
lock cy8ckit_062s2_43012 FLASH 1467308 1467308 0 0.0
RAM 224704 224704 0 0.0
qpg lighting-app qpg6105+debug FLASH 662216 662216 0 0.0
RAM 105220 105220 0 0.0
lock-app qpg6105+debug FLASH 619996 619996 0 0.0
RAM 99664 99664 0 0.0
stm32 light STM32WB5MM-DK FLASH 482872 482872 0 0.0
RAM 144688 144688 0 0.0
telink bridge-app tl7218x FLASH 665258 665258 0 0.0
RAM 90828 90828 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 622020 622020 0 0.0
RAM 31500 31500 0 0.0
light-app-ota-shell-factory-data tl3218x FLASH 770804 770804 0 0.0
RAM 43568 43568 0 0.0
tl7218x FLASH 779306 779306 0 0.0
RAM 98704 98704 0 0.0
light-switch-app-ota-compress-lzma-factory-data tl7218x_retention FLASH 680618 680618 0 0.0
RAM 52192 52192 0 0.0
light-switch-app-ota-compress-lzma-shell-factory-data tlsr9528a FLASH 709172 709172 0 0.0
RAM 73400 73400 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 626108 626108 0 0.0
RAM 142032 142032 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 813492 813492 0 0.0
RAM 99576 99576 0 0.0
tizen all-clusters-app arm unknown 5104 5104 0 0.0
FLASH 1752232 1752232 0 0.0
RAM 93508 93508 0 0.0
chip-tool-ubsan arm unknown 11396 11396 0 0.0
FLASH 18696694 18696694 0 0.0
RAM 8182536 8182536 0 0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@woody-apple woody-apple woody-apple approved these changes

Assignees
No one assigned
Labels
darwin fast track review - pending
Projects
[Platform] Darwin
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jtung-apple @woody-apple @bzbarsky-apple