[Darwin] MTRDevice work blocks should only weakly reference self #37757

jtung-apple · 2025-02-25T06:05:46Z

This change fixes a previously missed spot in _scheduleNextUpdate: where self was strongly captured in a log line. This also added weakify/strongify for the blocks in the new -invokeCommands:queue:completion method.

Testing

Ran on-device testing with Xcode instruments and verified that once client goes away and the device screen is turned off, MTRDevice object was deallocated.

semanticdiff-com · 2025-02-25T06:05:49Z

Review changes with

github-actions · 2025-02-25T06:25:28Z

PR #37757: Size comparison from ff7398a to da22b2d

Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)

platform	target	config	section	`ff7398a`	`da22b2d`
bl602	lighting-app	bl602+mfd+littlefs+rpc	FLASH	1096608	1096608
			RAM	94842	94842
bl702	lighting-app	bl702+eth	FLASH	651586	651586
			RAM	33509	33509
		bl702+wifi	FLASH	828858	828858
			RAM	22233	22233
		bl706+mfd+rpc+littlefs	FLASH	1061254	1061254
			RAM	32157	32157
bl702l	contact-sensor-app	bl702l+mfd+littlefs	FLASH	892098	892098
			RAM	26896	26896
	lighting-app	bl702l+mfd+littlefs	FLASH	974994	974994
			RAM	24644	24644
cc13x4_26x4	lighting-app	LP_EM_CC1354P10_6	FLASH	815268	815268
			RAM	120256	120256
	lock-ftd	LP_EM_CC1354P10_6	FLASH	824188	824188
			RAM	125352	125352
	pump-app	LP_EM_CC1354P10_6	FLASH	771048	771048
			RAM	113724	113724
	pump-controller-app	LP_EM_CC1354P10_6	FLASH	755332	755332
			RAM	113932	113932
cc32xx	air-purifier	CC3235SF_LAUNCHXL	FLASH	538810	538810
			RAM	205112	205112
	lock	CC3235SF_LAUNCHXL	FLASH	572966	572966
			RAM	205360	205360
cyw30739	light	CYW30739B2-P5-EVK-01	unknown	2040	2040
			FLASH	656397	656397
			RAM	75324	75324
		CYW30739B2-P5-EVK-02	unknown	2040	2040
			FLASH	676257	676257
			RAM	77964	77964
		CYW30739B2-P5-EVK-03	unknown	2040	2040
			FLASH	676257	676257
			RAM	77964	77964
		CYW930739M2EVB-02	unknown	2040	2040
			FLASH	633181	633181
			RAM	70392	70392
	light-switch	CYW30739B2-P5-EVK-01	unknown	2040	2040
			FLASH	616261	616261
			RAM	71532	71532
		CYW30739B2-P5-EVK-02	unknown	2040	2040
			FLASH	635897	635897
			RAM	74076	74076
		CYW30739B2-P5-EVK-03	unknown	2040	2040
			FLASH	635897	635897
			RAM	74076	74076
	lock	CYW30739B2-P5-EVK-01	unknown	2040	2040
			FLASH	635757	635757
			RAM	74540	74540
		CYW30739B2-P5-EVK-02	unknown	2040	2040
			FLASH	655481	655481
			RAM	77084	77084
		CYW30739B2-P5-EVK-03	unknown	2040	2040
			FLASH	655481	655481
			RAM	77084	77084
	thermostat	CYW30739B2-P5-EVK-01	unknown	2040	2040
			FLASH	612105	612105
			RAM	68628	68628
		CYW30739B2-P5-EVK-02	unknown	2040	2040
			FLASH	631965	631965
			RAM	71268	71268
		CYW30739B2-P5-EVK-03	unknown	2040	2040
			FLASH	631965	631965
			RAM	71268	71268
efr32	lock-app	BRD4187C	FLASH	939496	939496
			RAM	159920	159920
		BRD4338a	FLASH	732504	732504
			RAM	234828	234828
	window-app	BRD4187C	FLASH	1031968	1031968
			RAM	128024	128024
esp32	all-clusters-app	c3devkit	DRAM	97312	97312
			FLASH	`1581984`	`1581984`
			IRAM	83820	83820
		m5stack	DRAM	116108	116108
			FLASH	1549974	1549974
			IRAM	117039	117039
linux	air-purifier-app	debug	unknown	4720	4720
			FLASH	`2649787`	`2649787`
			RAM	111088	111088
	all-clusters-app	debug	unknown	5528	5528
			FLASH	5921260	5921260
			RAM	513712	513712
	all-clusters-minimal-app	debug	unknown	5424	5424
			FLASH	5266294	5266294
			RAM	221112	221112
	bridge-app	debug	unknown	5440	5440
			FLASH	4624936	4624936
			RAM	199816	199816
	camera-app	debug	unknown	5424	5424
			FLASH	4671716	4671716
			RAM	194592	194592
	chip-tool	debug	unknown	6096	6096
			FLASH	13302251	13302251
			RAM	603392	603392
	chip-tool-ipv6only	arm64	unknown	21976	21976
			FLASH	11495208	11495208
			RAM	656112	656112
	fabric-admin	debug	unknown	5784	5784
			FLASH	11567149	11567149
			RAM	603176	603176
	fabric-bridge-app	debug	unknown	4688	4688
			FLASH	4452154	4452154
			RAM	187016	187016
	fabric-sync	debug	unknown	4944	4944
			FLASH	5569109	5569109
			RAM	470400	470400
	lighting-app	debug+rpc+ui	unknown	6152	6152
			FLASH	5515393	5515393
			RAM	203952	203952
	lock-app	debug	unknown	5392	5392
			FLASH	`4688404`	`4688404`
			RAM	191144	191144
	ota-provider-app	debug	unknown	4728	4728
			FLASH	4310584	4310584
			RAM	179832	179832
	ota-requestor-app	debug	unknown	4680	4680
			FLASH	`4440710`	`4440710`
			RAM	184320	184320
	shell	debug	unknown	4216	4216
			FLASH	2949084	2949084
			RAM	143672	143672
	thermostat-no-ble	arm64	unknown	9448	9448
			FLASH	`4138184`	`4138184`
			RAM	229016	229016
	tv-app	debug	unknown	5720	5720
			FLASH	5908021	5908021
			RAM	593832	593832
	tv-casting-app	debug	unknown	5296	5296
			FLASH	11472733	11472733
			RAM	718656	718656
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	FLASH	907676	907676
			RAM	142323	142323
		nrf7002dk_nrf5340_cpuapp	FLASH	901752	901752
			RAM	124663	124663
	all-clusters-minimal-app	nrf52840dk_nrf52840	FLASH	846280	846280
			RAM	141251	141251
nxp	contact	k32w0+release	FLASH	585232	585232
			RAM	70876	70876
		mcxw71+release	FLASH	600680	600680
			RAM	63096	63096
	light	k32w0+release	FLASH	611172	611172
			RAM	70164	70164
		k32w1+release	FLASH	685648	685648
			RAM	48584	48584
	lock	mcxw71+release	FLASH	749504	749504
			RAM	67500	67500
psoc6	all-clusters	cy8ckit_062s2_43012	FLASH	`1646172`	`1646172`
			RAM	211472	211472
	all-clusters-minimal	cy8ckit_062s2_43012	FLASH	1552940	1552940
			RAM	208288	208288
	light	cy8ckit_062s2_43012	FLASH	`1438612`	`1438612`
			RAM	197040	197040
	lock	cy8ckit_062s2_43012	FLASH	1467500	1467500
			RAM	224704	224704
qpg	lighting-app	qpg6105+debug	FLASH	662156	662156
			RAM	105116	105116
	lock-app	qpg6105+debug	FLASH	620272	620272
			RAM	99664	99664
stm32	light	STM32WB5MM-DK	FLASH	459800	459800
			RAM	141472	141472
telink	bridge-app	tl7218x	FLASH	665014	665014
			RAM	90728	90728
	contact-sensor-app	tlsr9528a_retention	FLASH	622058	622058
			RAM	31488	31488
	light-app-ota-shell-factory-data	tl3218x	FLASH	745198	745198
			RAM	40396	40396
		tl7218x	FLASH	753760	753760
			RAM	97540	97540
	light-switch-app-ota-compress-lzma-factory-data	tl7218x_retention	FLASH	680830	680830
			RAM	52192	52192
	light-switch-app-ota-compress-lzma-shell-factory-data	tlsr9528a	FLASH	709392	709392
			RAM	73400	73400
	lighting-app-ota-factory-data	tlsr9118bdk40d	FLASH	600572	600572
			RAM	138812	138812
	lighting-app-ota-rpc-factory-data-4mb	tlsr9518adk80d	FLASH	788800	788800
			RAM	96388	96388
tizen	all-clusters-app	arm	unknown	5076	5076
			FLASH	1750772	1750772
			RAM	93260	93260
	chip-tool-ubsan	arm	unknown	11492	11492
			FLASH	18983614	18983614
			RAM	8306240	8306240

src/darwin/Framework/CHIP/MTRDevice_Concrete.mm

github-actions · 2025-02-25T18:41:36Z

PR #37757: Size comparison from ff7398a to ad01794

Full report (7 builds for cc32xx, qpg, stm32, tizen)

platform	target	config	section	`ff7398a`	`ad01794`	change
cc32xx	air-purifier	CC3235SF_LAUNCHXL	FLASH	538810	538842	32
			RAM	205112	205112	0
	lock	CC3235SF_LAUNCHXL	FLASH	572966	572998	32
			RAM	205360	205360	0
qpg	lighting-app	qpg6105+debug	FLASH	662156	662188	32
			RAM	105116	105116	0
	lock-app	qpg6105+debug	FLASH	620272	620304	32
			RAM	99664	99664	0
stm32	light	STM32WB5MM-DK	FLASH	459800	459832	32
			RAM	141472	141472	0
tizen	all-clusters-app	arm	unknown	5076	5076	0
			FLASH	1750772	`1750852`	80
			RAM	93260	93260	0
	chip-tool-ubsan	arm	unknown	11492	11492	0
			FLASH	18983614	18983694	80
			RAM	8306240	8306240	0

This reverts commit ad01794.

github-actions · 2025-02-25T18:59:42Z

PR #37757: Size comparison from ff7398a to 9568ffb

Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)

platform	target	config	section	`ff7398a`	`9568ffb`	change
bl602	lighting-app	bl602+mfd+littlefs+rpc	FLASH	1096608	1096628	20
			RAM	94842	94842	0
bl702	lighting-app	bl702+eth	FLASH	651586	651606	20
			RAM	33509	33509	0
		bl702+wifi	FLASH	828858	828878	20
			RAM	22233	22233	0
		bl706+mfd+rpc+littlefs	FLASH	1061254	1061274	20
			RAM	32157	32157	0
bl702l	contact-sensor-app	bl702l+mfd+littlefs	FLASH	892098	892118	20
			RAM	26896	26896	0
	lighting-app	bl702l+mfd+littlefs	FLASH	974994	975014	20
			RAM	24644	24644	0
cc13x4_26x4	lighting-app	LP_EM_CC1354P10_6	FLASH	815268	815300	32
			RAM	120256	120256	0
	lock-ftd	LP_EM_CC1354P10_6	FLASH	824188	824220	32
			RAM	125352	125352	0
	pump-app	LP_EM_CC1354P10_6	FLASH	771048	771080	32
			RAM	113724	113724	0
	pump-controller-app	LP_EM_CC1354P10_6	FLASH	755332	755364	32
			RAM	113932	113932	0
cc32xx	air-purifier	CC3235SF_LAUNCHXL	FLASH	538810	538842	32
			RAM	205112	205112	0
	lock	CC3235SF_LAUNCHXL	FLASH	572966	572998	32
			RAM	205360	205360	0
cyw30739	light	CYW30739B2-P5-EVK-01	unknown	2040	2040	0
			FLASH	656397	656429	32
			RAM	75324	75324	0
		CYW30739B2-P5-EVK-02	unknown	2040	2040	0
			FLASH	676257	676289	32
			RAM	77964	77964	0
		CYW30739B2-P5-EVK-03	unknown	2040	2040	0
			FLASH	676257	676289	32
			RAM	77964	77964	0
		CYW930739M2EVB-02	unknown	2040	2040	0
			FLASH	633181	633213	32
			RAM	70392	70392	0
	light-switch	CYW30739B2-P5-EVK-01	unknown	2040	2040	0
			FLASH	616261	616293	32
			RAM	71532	71532	0
		CYW30739B2-P5-EVK-02	unknown	2040	2040	0
			FLASH	635897	635929	32
			RAM	74076	74076	0
		CYW30739B2-P5-EVK-03	unknown	2040	2040	0
			FLASH	635897	635929	32
			RAM	74076	74076	0
	lock	CYW30739B2-P5-EVK-01	unknown	2040	2040	0
			FLASH	635757	635789	32
			RAM	74540	74540	0
		CYW30739B2-P5-EVK-02	unknown	2040	2040	0
			FLASH	655481	655513	32
			RAM	77084	77084	0
		CYW30739B2-P5-EVK-03	unknown	2040	2040	0
			FLASH	655481	655513	32
			RAM	77084	77084	0
	thermostat	CYW30739B2-P5-EVK-01	unknown	2040	2040	0
			FLASH	612105	612137	32
			RAM	68628	68628	0
		CYW30739B2-P5-EVK-02	unknown	2040	2040	0
			FLASH	631965	631997	32
			RAM	71268	71268	0
		CYW30739B2-P5-EVK-03	unknown	2040	2040	0
			FLASH	631965	631997	32
			RAM	71268	71268	0
efr32	lock-app	BRD4187C	FLASH	939496	939536	40
			RAM	159920	159920	0
		BRD4338a	FLASH	732504	732536	32
			RAM	234828	234828	0
	window-app	BRD4187C	FLASH	1031968	1032000	32
			RAM	128024	128024	0
esp32	all-clusters-app	c3devkit	DRAM	97312	97312	0
			FLASH	`1581984`	`1582004`	20
			IRAM	83820	83820	0
		m5stack	DRAM	116108	116108	0
			FLASH	1549974	1550014	40
			IRAM	117039	117039	0
linux	air-purifier-app	debug	unknown	4720	4720	0
			FLASH	`2649787`	2649887	100
			RAM	111088	111088	0
	all-clusters-app	debug	unknown	5528	5528	0
			FLASH	5921260	5921360	100
			RAM	513712	513712	0
	all-clusters-minimal-app	debug	unknown	5424	5424	0
			FLASH	5266294	5266394	100
			RAM	221112	221112	0
	bridge-app	debug	unknown	5440	5440	0
			FLASH	4624936	4625036	100
			RAM	199816	199816	0
	camera-app	debug	unknown	5424	5424	0
			FLASH	4671716	4671816	100
			RAM	194592	194592	0
	chip-tool	debug	unknown	6096	6096	0
			FLASH	13302251	13302351	100
			RAM	603392	603392	0
	chip-tool-ipv6only	arm64	unknown	21976	21976	0
			FLASH	11495208	11495416	208
			RAM	656112	656112	0
	fabric-admin	debug	unknown	5784	5784	0
			FLASH	11567149	11567249	100
			RAM	603176	603176	0
	fabric-bridge-app	debug	unknown	4688	4688	0
			FLASH	4452154	`4452254`	100
			RAM	187016	187016	0
	fabric-sync	debug	unknown	4944	4944	0
			FLASH	5569109	5569205	96
			RAM	470400	470400	0
	lighting-app	debug+rpc+ui	unknown	6152	6152	0
			FLASH	5515393	5515489	96
			RAM	203952	203952	0
	lock-app	debug	unknown	5392	5392	0
			FLASH	`4688404`	4688504	100
			RAM	191144	191144	0
	ota-provider-app	debug	unknown	4728	4728	0
			FLASH	4310584	`4310684`	100
			RAM	179832	179832	0
	ota-requestor-app	debug	unknown	4680	4680	0
			FLASH	`4440710`	4440810	100
			RAM	184320	184320	0
	shell	debug	unknown	4216	4216	0
			FLASH	2949084	2949196	112
			RAM	143672	143672	0
	thermostat-no-ble	arm64	unknown	9448	9448	0
			FLASH	`4138184`	4138392	208
			RAM	229016	229016	0
	tv-app	debug	unknown	5720	5720	0
			FLASH	5908021	5908117	96
			RAM	593832	593832	0
	tv-casting-app	debug	unknown	5296	5296	0
			FLASH	11472733	11472829	96
			RAM	718656	718656	0
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	FLASH	907676	907708	32
			RAM	142323	142323	0
		nrf7002dk_nrf5340_cpuapp	FLASH	901752	901788	36
			RAM	124663	124663	0
	all-clusters-minimal-app	nrf52840dk_nrf52840	FLASH	846280	846312	32
			RAM	141251	141251	0
nxp	contact	k32w0+release	FLASH	585232	585256	24
			RAM	70876	70876	0
		mcxw71+release	FLASH	600680	600712	32
			RAM	63096	63096	0
	light	k32w0+release	FLASH	611172	611196	24
			RAM	70164	70164	0
		k32w1+release	FLASH	685648	685680	32
			RAM	48584	48584	0
	lock	mcxw71+release	FLASH	749504	749536	32
			RAM	67500	67500	0
psoc6	all-clusters	cy8ckit_062s2_43012	FLASH	`1646172`	1646188	16
			RAM	211472	211472	0
	all-clusters-minimal	cy8ckit_062s2_43012	FLASH	1552940	1552956	16
			RAM	208288	208288	0
	light	cy8ckit_062s2_43012	FLASH	`1438612`	1438644	32
			RAM	197040	197040	0
	lock	cy8ckit_062s2_43012	FLASH	1467500	1467516	16
			RAM	224704	224704	0
qpg	lighting-app	qpg6105+debug	FLASH	662156	662188	32
			RAM	105116	105116	0
	lock-app	qpg6105+debug	FLASH	620272	620304	32
			RAM	99664	99664	0
stm32	light	STM32WB5MM-DK	FLASH	459800	459832	32
			RAM	141472	141472	0
telink	bridge-app	tl7218x	FLASH	665014	665034	20
			RAM	90728	90728	0
	contact-sensor-app	tlsr9528a_retention	FLASH	622058	622078	20
			RAM	31488	31488	0
	light-app-ota-shell-factory-data	tl3218x	FLASH	745198	745218	20
			RAM	40396	40396	0
		tl7218x	FLASH	753760	753780	20
			RAM	97540	97540	0
	light-switch-app-ota-compress-lzma-factory-data	tl7218x_retention	FLASH	680830	680850	20
			RAM	52192	52192	0
	light-switch-app-ota-compress-lzma-shell-factory-data	tlsr9528a	FLASH	709392	709412	20
			RAM	73400	73400	0
	lighting-app-ota-factory-data	tlsr9118bdk40d	FLASH	600572	600592	20
			RAM	138812	138812	0
	lighting-app-ota-rpc-factory-data-4mb	tlsr9518adk80d	FLASH	788800	788820	20
			RAM	96388	96388	0
tizen	all-clusters-app	arm	unknown	5076	5076	0
			FLASH	1750772	`1750852`	80
			RAM	93260	93260	0
	chip-tool-ubsan	arm	unknown	11492	11492	0
			FLASH	18983614	18983694	80
			RAM	8306240	8306240	0

[Darwin] MTRDevice work blocks should only weakly reference self

da22b2d

jtung-apple added the darwin label Feb 25, 2025

jtung-apple requested a review from a team as a code owner February 25, 2025 06:05

pullapprove bot added the review - pending label Feb 25, 2025

bzbarsky-apple reviewed Feb 25, 2025

View reviewed changes

src/darwin/Framework/CHIP/MTRDevice_Concrete.mm Show resolved Hide resolved

Have invokeCommands call completion even when object is gone

ad01794

Revert "Have invokeCommands call completion even when object is gone"

9568ffb

This reverts commit ad01794.

woody-apple added the fast track label Feb 25, 2025

woody-apple approved these changes Feb 25, 2025

View reviewed changes

woody-apple requested a review from bzbarsky-apple February 25, 2025 19:56

bzbarsky-apple approved these changes Feb 25, 2025

View reviewed changes

mergify bot merged commit b10a85a into project-chip:master Feb 25, 2025
70 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Darwin] MTRDevice work blocks should only weakly reference self #37757

[Darwin] MTRDevice work blocks should only weakly reference self #37757

jtung-apple commented Feb 25, 2025

semanticdiff-com bot commented Feb 25, 2025

github-actions bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

[Darwin] MTRDevice work blocks should only weakly reference self #37757

[Darwin] MTRDevice work blocks should only weakly reference self #37757

Conversation

jtung-apple commented Feb 25, 2025

Testing

semanticdiff-com bot commented Feb 25, 2025

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

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

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

github-actions bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading