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.

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

[Python] fixed subscription crash #32257

Merged

Conversation

tianfeng-yang
Copy link
Contributor

@tianfeng-yang tianfeng-yang commented Feb 22, 2024

Fixed #32310

  1. The end of the ReadClient life cycle is OnDone. If OnError happend, OnDone will eventually be executed. In the existing Python code, delete it is executed in OnDone. At this time, pCallback and pReadClient (moved from pychip_ReadClient_Read) have both been deleted. , After that, if the python application executes SubscriptionTransaction.Shutdown() or delete, pychip_ReadClient_Abort will be executed, which will cause pCallback to be deleted again, causing the application to crash. Therefore, when calling Shuddown() or delete on the python side, you need to determine whether OnError happend. If OnError happend, you do not need to call pychip_ReadClient_Abort again. If not, it is a normal delete behavior on the application side.
  2. The destructor of ReadClient also describes that after deleting ReadClient, OnDone will not be executed, so we can directly delete ReadClient in the callback of OnDone(the life cycle of ReadClient has ended), so that there is no need to move the memory of pReadClient to ReadClientCallback in pychip_ReadClient_Read.
    @notes: There is no problem moving ReadClient to pCallback here, but WriteClientCallback is also not moved, just for consistency reasons.

Follow the advice

The following two points are split into PR #32308

  1. Subscription support host test mode, align to chip-tool
  2. Export GetSubscriptionTimeoutMs interface to check if the subscription is alive.

@yunhanw-google
Copy link
Contributor

yunhanw-google commented Apr 17, 2024

@tianfeng-yang I would suggest to use ShutdownSubscriptions from https://github.com/project-chip/connectedhomeip/blob/master/src/app/InteractionModelEngine.cpp#L296, and remove abort API. and leave the below unchanged.

    *pReadClient = readClient.get();
    *pCallback   = callback.get();

    callback->AdoptReadClient(std::move(readClient));

    callback.release();

@tianfeng-yang
Copy link
Contributor Author

tianfeng-yang commented Apr 18, 2024

@tianfeng-yang I would suggest to use ShutdownSubscriptions from https://github.com/project-chip/connectedhomeip/blob/master/src/app/InteractionModelEngine.cpp#L296, and remove abort API. and leave the below unchanged.

    *pReadClient = readClient.get();
    *pCallback   = callback.get();

    callback->AdoptReadClient(std::move(readClient));

    callback.release();

Changing the API like this is a bit extensive, and I can't confirm whether it will cause a chain reaction.
And ShutdownSubscriptions will close all subscriptions in the device dimension, which is inconsistent with expectations.

@tianfeng-yang
Copy link
Contributor Author

Follow the advice

@tianfeng-yang tianfeng-yang reopened this Oct 9, 2024
Copy link

github-actions bot commented Oct 9, 2024

PR #32257: Size comparison from a629204 to e10817e

Full report (20 builds for cc13x4_26x4, cc32xx, nrfconnect, nxp, qpg, stm32, tizen)
platform target config section a629204 e10817e change % change
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 829348 829348 0 0.0
RAM 123292 123292 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 814672 814672 0 0.0
RAM 125172 125172 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 761236 761236 0 0.0
RAM 113664 113664 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 745464 745464 0 0.0
RAM 113856 113856 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 616978 616978 0 0.0
RAM 205396 205396 0 0.0
lock CC3235SF_LAUNCHXL FLASH 657074 657074 0 0.0
RAM 205548 205548 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 914252 914252 0 0.0
RAM 142199 142199 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 885056 885056 0 0.0
RAM 140338 140338 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 847668 847668 0 0.0
RAM 141101 141101 0 0.0
nxp contact k32w1+release FLASH 596712 596712 0 0.0
RAM 63016 63016 0 0.0
mcxw71+release FLASH 596472 596472 0 0.0
RAM 63016 63016 0 0.0
light k32w1+release FLASH 682712 682712 0 0.0
RAM 48648 48648 0 0.0
mcxw71+release FLASH 682712 682712 0 0.0
RAM 48648 48648 0 0.0
lock k32w1+release FLASH 705056 705056 0 0.0
RAM 67156 67156 0 0.0
mcxw71+release FLASH 705064 705064 0 0.0
RAM 67156 67156 0 0.0
qpg lighting-app qpg6105+debug FLASH 660344 660344 0 0.0
RAM 105236 105236 0 0.0
lock-app qpg6105+debug FLASH 618356 618356 0 0.0
RAM 99704 99704 0 0.0
stm32 light STM32WB5MM-DK FLASH 481640 481640 0 0.0
RAM 144684 144684 0 0.0
tizen all-clusters-app arm unknown 4904 4904 0 0.0
FLASH 1725936 1725936 0 0.0
RAM 89084 89084 0 0.0
chip-tool-ubsan arm unknown 10456 10456 0 0.0
FLASH 17544794 17544794 0 0.0
RAM 7642532 7642532 0 0.0

@tianfeng-yang tianfeng-yang marked this pull request as ready for review October 9, 2024 07:20
Copy link

github-actions bot commented Oct 9, 2024

PR #32257: Size comparison from a629204 to d5f2d56

Full report (88 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
platform target config section a629204 d5f2d56 change % change
bl602 lighting-app bl602 FLASH 1280626 1280626 0 0.0
RAM 95808 95808 0 0.0
bl602+mfd FLASH 1308674 1308674 0 0.0
RAM 95464 95464 0 0.0
bl602+rpc FLASH 1335302 1335302 0 0.0
RAM 103784 103784 0 0.0
bl702 lighting-app bl702 FLASH 945052 945052 0 0.0
RAM 15105 15105 0 0.0
bl702+mfd FLASH 957506 957506 0 0.0
RAM 14769 14769 0 0.0
bl702+rpc FLASH 1051210 1051210 0 0.0
RAM 23661 23661 0 0.0
bl706-eth FLASH 658184 658184 0 0.0
RAM 24745 24745 0 0.0
bl706-wifi FLASH 824980 824980 0 0.0
RAM 13965 13965 0 0.0
bl702l lighting-app bl702l FLASH 961988 961988 0 0.0
RAM 16804 16804 0 0.0
bl702l+mfd FLASH 974750 974750 0 0.0
RAM 16468 16468 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 829348 829348 0 0.0
RAM 123292 123292 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 814672 814672 0 0.0
RAM 125172 125172 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 761236 761236 0 0.0
RAM 113664 113664 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 745464 745464 0 0.0
RAM 113856 113856 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 616978 616978 0 0.0
RAM 205396 205396 0 0.0
lock CC3235SF_LAUNCHXL FLASH 657074 657074 0 0.0
RAM 205548 205548 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 678317 678317 0 0.0
RAM 78508 78508 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 698169 698169 0 0.0
RAM 81140 81140 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 698169 698169 0 0.0
RAM 81140 81140 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 655097 655097 0 0.0
RAM 73576 73576 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 614653 614653 0 0.0
RAM 71468 71468 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 634289 634289 0 0.0
RAM 74020 74020 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 634289 634289 0 0.0
RAM 74020 74020 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 633965 633965 0 0.0
RAM 74516 74516 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 653681 653681 0 0.0
RAM 77068 77068 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 653681 653681 0 0.0
RAM 77068 77068 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 609269 609269 0 0.0
RAM 68604 68604 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 629129 629129 0 0.0
RAM 71236 71236 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 629129 629129 0 0.0
RAM 71236 71236 0 0.0
efr32 lighting-app BRD4187C FLASH 933860 933860 0 0.0
RAM 135876 135876 0 0.0
lock-app BRD2605a FLASH 740264 740256 -8 -0.0
RAM 230248 230248 0 0.0
BRD4338a FLASH 740912 740904 -8 -0.0
RAM 230280 230280 0 0.0
window-app BRD4187C FLASH 1017264 1017264 0 0.0
RAM 127812 127812 0 0.0
esp32 all-clusters-app c3devkit DRAM 94088 94088 0 0.0
FLASH 1538452 1538452 0 0.0
IRAM 82538 82538 0 0.0
m5stack DRAM 115032 115032 0 0.0
FLASH 1548914 1548914 0 0.0
IRAM 117039 117039 0 0.0
linux air-purifier-app debug unknown 4688 4688 0 0.0
FLASH 2780123 2780123 0 0.0
RAM 129488 129488 0 0.0
all-clusters-app debug unknown 5528 5528 0 0.0
FLASH 6084120 6084120 0 0.0
RAM 512416 512416 0 0.0
all-clusters-minimal-app debug unknown 5424 5424 0 0.0
FLASH 5417370 5417370 0 0.0
RAM 241200 241200 0 0.0
bridge-app debug unknown 5408 5408 0 0.0
FLASH 4750844 4750844 0 0.0
RAM 218384 218384 0 0.0
chip-tool debug unknown 5960 5960 0 0.0
FLASH 12673638 12673638 0 0.0
RAM 563410 563410 0 0.0
chip-tool-ipv6only arm64 unknown 20736 20736 0 0.0
FLASH 11307376 11307376 0 0.0
RAM 613728 613728 0 0.0
fabric-admin debug unknown 5792 5792 0 0.0
FLASH 11019607 11019607 0 0.0
RAM 563066 563066 0 0.0
fabric-bridge-app debug unknown 4632 4632 0 0.0
FLASH 4574040 4574040 0 0.0
RAM 205048 205048 0 0.0
lighting-app debug+rpc+ui unknown 6056 6056 0 0.0
FLASH 5691425 5691425 0 0.0
RAM 228488 228488 0 0.0
lock-app debug unknown 5344 5344 0 0.0
FLASH 4800406 4800406 0 0.0
RAM 204472 204472 0 0.0
ota-provider-app debug unknown 4720 4720 0 0.0
FLASH 4429830 4429830 0 0.0
RAM 198192 198192 0 0.0
ota-requestor-app debug unknown 4656 4656 0 0.0
FLASH 4568644 4568644 0 0.0
RAM 202760 202760 0 0.0
shell debug unknown 4216 4216 0 0.0
FLASH 3110173 3110173 0 0.0
RAM 159280 159280 0 0.0
thermostat-no-ble arm64 unknown 9448 9448 0 0.0
FLASH 4318432 4318432 0 0.0
RAM 242888 242888 0 0.0
tv-app debug unknown 5624 5624 0 0.0
FLASH 6028309 6028309 0 0.0
RAM 585952 585952 0 0.0
tv-casting-app debug unknown 5208 5208 0 0.0
FLASH 10870877 10870877 0 0.0
RAM 651888 651888 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 914252 914252 0 0.0
RAM 142199 142199 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 885056 885056 0 0.0
RAM 140338 140338 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 847668 847668 0 0.0
RAM 141101 141101 0 0.0
nxp contact k32w0+release FLASH 582008 582008 0 0.0
RAM 70792 70792 0 0.0
k32w1+release FLASH 596712 596712 0 0.0
RAM 63016 63016 0 0.0
mcxw71+release FLASH 596472 596472 0 0.0
RAM 63016 63016 0 0.0
light k32w0+release FLASH 618572 618572 0 0.0
RAM 70256 70256 0 0.0
k32w1+release FLASH 682712 682712 0 0.0
RAM 48648 48648 0 0.0
mcxw71+release FLASH 682712 682712 0 0.0
RAM 48648 48648 0 0.0
lock k32w1+release FLASH 705056 705056 0 0.0
RAM 67156 67156 0 0.0
mcxw71+release FLASH 705064 705064 0 0.0
RAM 67156 67156 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1646148 1646148 0 0.0
RAM 210888 210888 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1552212 1552212 0 0.0
RAM 207688 207688 0 0.0
light cy8ckit_062s2_43012 FLASH 1467684 1467684 0 0.0
RAM 200688 200688 0 0.0
lock cy8ckit_062s2_43012 FLASH 1464756 1464756 0 0.0
RAM 225048 225048 0 0.0
qpg lighting-app qpg6105+debug FLASH 660344 660344 0 0.0
RAM 105236 105236 0 0.0
lock-app qpg6105+debug FLASH 618356 618356 0 0.0
RAM 99704 99704 0 0.0
stm32 light STM32WB5MM-DK FLASH 481640 481640 0 0.0
RAM 144684 144684 0 0.0
telink air-quality-sensor-app tlsr9528a_retention FLASH 620746 620746 0 0.0
RAM 50488 50488 0 0.0
all-clusters-app tlsr9118bdk40d FLASH 687944 687944 0 0.0
RAM 148328 148328 0 0.0
all-clusters-minimal-app tlsr9528a FLASH 780936 780936 0 0.0
RAM 110280 110280 0 0.0
bridge-app tlsr9258a FLASH 680842 680842 0 0.0
RAM 91144 91144 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 620510 620510 0 0.0
RAM 50440 50440 0 0.0
light-switch-app-ota-shell-factory-data tlsr9528a FLASH 708452 708452 0 0.0
RAM 73780 73780 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 625448 625448 0 0.0
RAM 144308 144308 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 811208 811208 0 0.0
RAM 98940 98940 0 0.0
lock-app-dfu tlsr9528a FLASH 656416 656416 0 0.0
RAM 66500 66500 0 0.0
ota-requestor-app tlsr9258a FLASH 696820 696820 0 0.0
RAM 90736 90736 0 0.0
pump-app-usb tlsr9518adk80d FLASH 634144 634144 0 0.0
RAM 55316 55316 0 0.0
pump-controller-app tlsr9518adk80d FLASH 611334 611334 0 0.0
RAM 52560 52560 0 0.0
shell tlsr9518adk80d FLASH 467872 467872 0 0.0
RAM 68168 68168 0 0.0
smoke_co_alarm-app tlsr9528a_retention FLASH 627660 627660 0 0.0
RAM 52160 52160 0 0.0
temperature-measurement-app-mars-ota tlsr9518adk80d FLASH 653466 653466 0 0.0
RAM 56108 56108 0 0.0
thermostat tlsr9518adk80d FLASH 638066 638066 0 0.0
RAM 52952 52952 0 0.0
window-covering tlsr9118bdk40d FLASH 524204 524204 0 0.0
RAM 97284 97284 0 0.0
tizen all-clusters-app arm unknown 4904 4904 0 0.0
FLASH 1725936 1725936 0 0.0
RAM 89084 89084 0 0.0
chip-tool-ubsan arm unknown 10456 10456 0 0.0
FLASH 17544794 17544794 0 0.0
RAM 7642532 7642532 0 0.0

@andy31415
Copy link
Contributor

NOTE on old PR staleness review: this PR seems to be under active development and could use some reviews.

@yunhanw-google yunhanw-google enabled auto-merge (squash) October 11, 2024 16:12
@yunhanw-google yunhanw-google merged commit dcb4444 into project-chip:master Oct 14, 2024
70 checks passed
agners added a commit to agners/connectedhomeip that referenced this pull request Oct 16, 2024
agners added a commit to agners/connectedhomeip that referenced this pull request Oct 16, 2024
This reimplements project-chip#32257 without reformatting Python files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] python subscription crashed when error happend
5 participants