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

Log lengths of strings in payload logging. #20934

Merged

Conversation

bzbarsky-apple
Copy link
Contributor

Logs lengths of UTF-8 strings in chars and octet strings in bytes.

Problem

Our logging does not make it clear when char strings have trailing nulls.

Change overview

Make it clearer.

Testing

Ensured that I see reasonable lengths logged for commissioning payloads and reading the VendorName property.

@github-actions
Copy link

github-actions bot commented Jul 19, 2022

PR #20934: Size comparison from fcd6594 to 10a8564

Increases (3 builds for linux, telink)
platform target config section fcd6594 10a8564 change % change
linux chip-tool-ipv6only arm64 (read only) 10038380 10038460 80 0.0
.rodata 479820 479884 64 0.0
.text 7978196 7978212 16 0.0
thermostat-no-ble arm64 (read only) 2603116 2603212 96 0.0
.rodata 165748 165812 64 0.0
.text 2197072 2197104 32 0.0
telink lighting-app tlsr9518adk80d (read/write) 818732 818740 8 0.0
text 583344 583346 2 0.0
Decreases (3 builds for k32w, nrfconnect, telink)
platform target config section fcd6594 10a8564 change % change
k32w light k32w061+release (read/write) 660924 660908 -16 -0.0
.text 583592 583576 -16 -0.0
nrfconnect all-clusters-minimal-app nrf52840dk_nrf52840 text 801920 801916 -4 -0.0
telink light-switch-app tlsr9518adk80d text 566814 566812 -2 -0.0
Full report (14 builds for bl602, cyw30739, k32w, linux, mbed, nrfconnect, telink)
platform target config section fcd6594 10a8564 change % change
bl602 lighting-app bl602 (read/write) 1379762 1379762 0 0.0
.bss 116962 116962 0 0.0
.data 4480 4480 0 0.0
.text 1050416 1050416 0 0.0
bl602+rpc (read/write) 1425170 1425170 0 0.0
.bss 124410 124410 0 0.0
.data 4600 4600 0 0.0
.text 1082072 1082072 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 582142 582142 0 0.0
.app_xip_area 460704 460704 0 0.0
.bss 64232 64232 0 0.0
.data 716 716 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
lock cyw930739m2evb_01 (read/write) 588058 588058 0 0.0
.app_xip_area 461892 461892 0 0.0
.bss 68960 68960 0 0.0
.data 720 720 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 585474 585474 0 0.0
.app_xip_area 464884 464884 0 0.0
.bss 63440 63440 0 0.0
.data 660 660 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
k32w light k32w061+release (read/write) 660924 660908 -16 -0.0
.bss 69540 69540 0 0.0
.data 1992 1992 0 0.0
.text 583592 583576 -16 -0.0
lock k32w061+release (read/write) 687908 687908 0 0.0
.bss 70004 70004 0 0.0
.data 2004 2004 0 0.0
.text 610100 610100 0 0.0
linux chip-tool-ipv6only arm64 (read only) 10038380 10038460 80 0.0
(read/write) 694801 694801 0 0.0
.bss 42993 42993 0 0.0
.data 3304 3304 0 0.0
.data.rel.ro 630920 630920 0 0.0
.dynamic 528 528 0 0.0
.got 13656 13656 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 479820 479884 64 0.0
.text 7978196 7978212 16 0.0
thermostat-no-ble arm64 (read only) 2603116 2603212 96 0.0
(read/write) 158481 158481 0 0.0
.bss 65281 65281 0 0.0
.data 1704 1704 0 0.0
.data.rel.ro 83368 83368 0 0.0
.dynamic 528 528 0 0.0
.got 5104 5104 0 0.0
.init 24 24 0 0.0
.init_array 400 400 0 0.0
.rodata 165748 165812 64 0.0
.text 2197072 2197104 32 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2449128 2449128 0 0.0
.bss 213940 213940 0 0.0
.data 5872 5872 0 0.0
.text 1411772 1411772 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1176643 1176643 0 0.0
bss 142900 142900 0 0.0
rodata 142204 142204 0 0.0
text 812636 812636 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 (read/write) 1156675 1156675 0 0.0
bss 142136 142136 0 0.0
rodata 133748 133748 0 0.0
text 801920 801916 -4 -0.0
telink light-switch-app tlsr9518adk80d (read/write) 798700 798700 0 0.0
bss 70576 70576 0 0.0
noinit 40416 40416 0 0.0
text 566814 566812 -2 -0.0
lighting-app tlsr9518adk80d (read/write) 818732 818740 8 0.0
bss 71420 71420 0 0.0
noinit 40416 40416 0 0.0
text 583344 583346 2 0.0

Logs lengths of UTF-8 strings in chars and octet strings in bytes.
@bzbarsky-apple bzbarsky-apple force-pushed the log-payload-string-lengths branch from 10a8564 to a71e3eb Compare July 19, 2022 15:12
@github-actions
Copy link

github-actions bot commented Jul 19, 2022

PR #20934: Size comparison from fcd6594 to a71e3eb

Increases (15 builds for esp32, linux)
platform target config section fcd6594 a71e3eb change % change
esp32 all-clusters-app c3devkit (read only) 1021762 1021798 36 0.0
(read/write) 1486026 1486098 72 0.0
.flash.rodata 215912 215984 72 0.0
.flash.text 1021762 1021798 36 0.0
m5stack (read only) 1075507 1075535 28 0.0
(read/write) 488064 488128 64 0.0
.flash.rodata 246324 246388 64 0.0
.flash.text 1070123 1070151 28 0.0
linux all-clusters-app debug (read only) 2975641 2975753 112 0.0
.rodata 264733 264797 64 0.0
.text 2532930 2532978 48 0.0
all-clusters-minimal-app debug (read only) 2822201 2822329 128 0.0
.rodata 265661 265757 96 0.0
.text 2381218 2381250 32 0.0
bridge-app debug+rpc (read only) 2322489 2322585 96 0.0
.rodata 198240 198304 64 0.0
.text 1962226 1962258 32 0.0
chip-tool debug (read only) 10297761 10297873 112 0.0
.rodata 515765 515829 64 0.0
.text 8333684 8333732 48 0.0
chip-tool-ipv6only arm64 (read only) 10038380 10038460 80 0.0
.rodata 479820 479884 64 0.0
.text 7978196 7978212 16 0.0
lighting-app debug+rpc (read only) 2560265 2560377 112 0.0
.rodata 214088 214152 64 0.0
.text 2175922 2175970 48 0.0
lock-app debug (read only) 2525097 2525209 112 0.0
.rodata 229064 229128 64 0.0
.text 2130578 2130626 48 0.0
ota-provider-app debug (read only) 2328673 2328817 144 0.0
.rodata 203832 203928 96 0.0
.text 1961778 1961826 48 0.0
ota-requestor-app debug (read only) 2446281 2446425 144 0.0
.rodata 207584 207680 96 0.0
.text 2067234 2067282 48 0.0
shell debug (read only) 2562545 2562657 112 0.0
.rodata 228114 228178 64 0.0
.text 2177042 2177090 48 0.0
thermostat-no-ble arm64 (read only) 2603116 2603212 96 0.0
.rodata 165748 165812 64 0.0
.text 2197072 2197104 32 0.0
tv-app debug (read only) 3110585 3110697 112 0.0
.rodata 249504 249568 64 0.0
.text 2672898 2672946 48 0.0
tv-casting-app debug (read only) 5358625 5358737 112 0.0
.rodata 332841 332905 64 0.0
.text 4760098 4760146 48 0.0
Decreases (1 build for telink)
platform target config section fcd6594 a71e3eb change % change
telink light-switch-app tlsr9518adk80d text 566814 566810 -4 -0.0
Full report (43 builds for bl602, cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section fcd6594 a71e3eb change % change
bl602 lighting-app bl602 (read/write) 1379762 1379762 0 0.0
.bss 116962 116962 0 0.0
.data 4480 4480 0 0.0
.text 1050416 1050416 0 0.0
bl602+rpc (read/write) 1425170 1425170 0 0.0
.bss 124410 124410 0 0.0
.data 4600 4600 0 0.0
.text 1082072 1082072 0 0.0
cc13x2_26x2 all-clusters-app LP_CC2652R7 (read only) 668599 668599 0 0.0
(read/write) 182640 182640 0 0.0
.bss 74132 74132 0 0.0
.data 3356 3356 0 0.0
.rodata 88319 88319 0 0.0
.text 579964 579964 0 0.0
all-clusters-minimal-app LP_CC2652R7 (read only) 634223 634223 0 0.0
(read/write) 157700 157700 0 0.0
.bss 73428 73428 0 0.0
.data 3356 3356 0 0.0
.rodata 77551 77551 0 0.0
.text 556348 556348 0 0.0
lock-ftd LP_CC2652R7 (read only) 671811 671811 0 0.0
(read/write) 169604 169604 0 0.0
.bss 71196 71196 0 0.0
.data 3280 3280 0 0.0
.rodata 76451 76451 0 0.0
.text 594880 594880 0 0.0
lock-mtd LP_CC2652R7 (read only) 654095 654095 0 0.0
(read/write) 183008 183008 0 0.0
.bss 66884 66884 0 0.0
.data 3280 3280 0 0.0
.rodata 101199 101199 0 0.0
.text 552416 552416 0 0.0
pump-app LP_CC2652R7 (read only) 680795 680795 0 0.0
(read/write) 161468 161468 0 0.0
.bss 71276 71276 0 0.0
.data 3280 3280 0 0.0
.rodata 88811 88811 0 0.0
.text 591500 591500 0 0.0
pump-controller-app LP_CC2652R7 (read only) 666587 666587 0 0.0
(read/write) 175796 175796 0 0.0
.bss 71396 71396 0 0.0
.data 3276 3276 0 0.0
.rodata 84675 84675 0 0.0
.text 581432 581432 0 0.0
shell LP_CC2652R7 (read only) 661098 661098 0 0.0
(read/write) 185644 185644 0 0.0
.bss 76436 76436 0 0.0
.data 3360 3360 0 0.0
.rodata 85098 85098 0 0.0
.text 575684 575684 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 582142 582142 0 0.0
.app_xip_area 460704 460704 0 0.0
.bss 64232 64232 0 0.0
.data 716 716 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
lock cyw930739m2evb_01 (read/write) 588058 588058 0 0.0
.app_xip_area 461892 461892 0 0.0
.bss 68960 68960 0 0.0
.data 720 720 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 585474 585474 0 0.0
.app_xip_area 464884 464884 0 0.0
.bss 63440 63440 0 0.0
.data 660 660 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read/write) 1084792 1084792 0 0.0
.bss 133044 133044 0 0.0
.data 2048 2048 0 0.0
.text 949680 949680 0 0.0
BRD4161A+rpc (read/write) 1139084 1139084 0 0.0
.bss 149724 149724 0 0.0
.data 2260 2260 0 0.0
.text 987076 987076 0 0.0
BRD4161A+rs911x (read/write) 950160 950160 0 0.0
.bss 140768 140768 0 0.0
.data 2048 2048 0 0.0
.text 807324 807324 0 0.0
lock-app BRD4161A+wf200 (read/write) 1128004 1128004 0 0.0
.bss 144136 144136 0 0.0
.data 2056 2056 0 0.0
.text 981792 981792 0 0.0
window-app BRD4161A (read/write) 1078284 1078284 0 0.0
.bss 134516 134516 0 0.0
.data 2076 2076 0 0.0
.text 941672 941672 0 0.0
esp32 all-clusters-app c3devkit (read only) 1021762 1021798 36 0.0
(read/write) 1486026 1486098 72 0.0
.dram0.bss 70080 70080 0 0.0
.dram0.data 14600 14600 0 0.0
.flash.rodata 215912 215984 72 0.0
.flash.text 1021762 1021798 36 0.0
.iram0.text 62902 62902 0 0.0
m5stack (read only) 1075507 1075535 28 0.0
(read/write) 488064 488128 64 0.0
.dram0.bss 75600 75600 0 0.0
.dram0.data 34144 34144 0 0.0
.flash.rodata 246324 246388 64 0.0
.flash.text 1070123 1070151 28 0.0
.iram0.text 123267 123267 0 0.0
k32w light k32w061+release (read/write) 660924 660924 0 0.0
.bss 69540 69540 0 0.0
.data 1992 1992 0 0.0
.text 583592 583592 0 0.0
lock k32w061+release (read/write) 687908 687908 0 0.0
.bss 70004 70004 0 0.0
.data 2004 2004 0 0.0
.text 610100 610100 0 0.0
linux all-clusters-app debug (read only) 2975641 2975753 112 0.0
(read/write) 155152 155152 0 0.0
.bss 61696 61696 0 0.0
.data 2048 2048 0 0.0
.data.rel.ro 85160 85160 0 0.0
.dynamic 608 608 0 0.0
.got 4568 4568 0 0.0
.init 27 27 0 0.0
.init_array 1064 1064 0 0.0
.rodata 264733 264797 64 0.0
.text 2532930 2532978 48 0.0
all-clusters-minimal-app debug (read only) 2822201 2822329 128 0.0
(read/write) 146824 146824 0 0.0
.bss 60896 60896 0 0.0
.data 2048 2048 0 0.0
.data.rel.ro 77720 77720 0 0.0
.dynamic 608 608 0 0.0
.got 4488 4488 0 0.0
.init 27 27 0 0.0
.init_array 1056 1056 0 0.0
.rodata 265661 265757 96 0.0
.text 2381218 2381250 32 0.0
bridge-app debug+rpc (read only) 2322489 2322585 96 0.0
(read/write) 125640 125640 0 0.0
.bss 48960 48960 0 0.0
.data 3824 3824 0 0.0
.data.rel.ro 67096 67096 0 0.0
.dynamic 608 608 0 0.0
.got 4392 4392 0 0.0
.init 27 27 0 0.0
.init_array 736 736 0 0.0
.rodata 198240 198304 64 0.0
.text 1962226 1962258 32 0.0
chip-tool debug (read only) 10297761 10297873 112 0.0
(read/write) 629640 629640 0 0.0
.bss 24760 24760 0 0.0
.data 3234 3234 0 0.0
.data.rel.ro 595256 595256 0 0.0
.dynamic 608 608 0 0.0
.got 5088 5088 0 0.0
.init 27 27 0 0.0
.init_array 648 648 0 0.0
.rodata 515765 515829 64 0.0
.text 8333684 8333732 48 0.0
chip-tool-ipv6only arm64 (read only) 10038380 10038460 80 0.0
(read/write) 694801 694801 0 0.0
.bss 42993 42993 0 0.0
.data 3304 3304 0 0.0
.data.rel.ro 630920 630920 0 0.0
.dynamic 528 528 0 0.0
.got 13656 13656 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 479820 479884 64 0.0
.text 7978196 7978212 16 0.0
lighting-app debug+rpc (read only) 2560265 2560377 112 0.0
(read/write) 129664 129664 0 0.0
.bss 49472 49472 0 0.0
.data 2096 2096 0 0.0
.data.rel.ro 72248 72248 0 0.0
.dynamic 608 608 0 0.0
.got 4392 4392 0 0.0
.init 27 27 0 0.0
.init_array 824 824 0 0.0
.rodata 214088 214152 64 0.0
.text 2175922 2175970 48 0.0
lock-app debug (read only) 2525097 2525209 112 0.0
(read/write) 124648 124648 0 0.0
.bss 47872 47872 0 0.0
.data 1712 1712 0 0.0
.data.rel.ro 69208 69208 0 0.0
.dynamic 608 608 0 0.0
.got 4424 4424 0 0.0
.init 27 27 0 0.0
.init_array 800 800 0 0.0
.rodata 229064 229128 64 0.0
.text 2130578 2130626 48 0.0
ota-provider-app debug (read only) 2328673 2328817 144 0.0
(read/write) 118448 118448 0 0.0
.bss 47520 47520 0 0.0
.data 1944 1944 0 0.0
.data.rel.ro 63192 63192 0 0.0
.dynamic 608 608 0 0.0
.got 4488 4488 0 0.0
.init 27 27 0 0.0
.init_array 680 680 0 0.0
.rodata 203832 203928 96 0.0
.text 1961778 1961826 48 0.0
ota-requestor-app debug (read only) 2446281 2446425 144 0.0
(read/write) 125384 125384 0 0.0
.bss 49888 49888 0 0.0
.data 2232 2232 0 0.0
.data.rel.ro 67416 67416 0 0.0
.dynamic 608 608 0 0.0
.got 4480 4480 0 0.0
.init 27 27 0 0.0
.init_array 736 736 0 0.0
.rodata 207584 207680 96 0.0
.text 2067234 2067282 48 0.0
shell debug (read only) 2562545 2562657 112 0.0
(read/write) 141240 141240 0 0.0
.bss 57480 57480 0 0.0
.data 1264 1264 0 0.0
.data.rel.ro 76792 76792 0 0.0
.dynamic 608 608 0 0.0
.got 4136 4136 0 0.0
.init 27 27 0 0.0
.init_array 936 936 0 0.0
.rodata 228114 228178 64 0.0
.text 2177042 2177090 48 0.0
thermostat-no-ble arm64 (read only) 2603116 2603212 96 0.0
(read/write) 158481 158481 0 0.0
.bss 65281 65281 0 0.0
.data 1704 1704 0 0.0
.data.rel.ro 83368 83368 0 0.0
.dynamic 528 528 0 0.0
.got 5104 5104 0 0.0
.init 24 24 0 0.0
.init_array 400 400 0 0.0
.rodata 165748 165812 64 0.0
.text 2197072 2197104 32 0.0
tv-app debug (read only) 3110585 3110697 112 0.0
(read/write) 257840 257840 0 0.0
.bss 167048 167048 0 0.0
.data 4848 4848 0 0.0
.data.rel.ro 79496 79496 0 0.0
.dynamic 608 608 0 0.0
.got 4848 4848 0 0.0
.init 27 27 0 0.0
.init_array 960 960 0 0.0
.rodata 249504 249568 64 0.0
.text 2672898 2672946 48 0.0
tv-casting-app debug (read only) 5358625 5358737 112 0.0
(read/write) 157800 157800 0 0.0
.bss 51048 51048 0 0.0
.data 2416 2416 0 0.0
.data.rel.ro 98032 98032 0 0.0
.dynamic 608 608 0 0.0
.got 4736 4736 0 0.0
.init 27 27 0 0.0
.init_array 920 920 0 0.0
.rodata 332841 332905 64 0.0
.text 4760098 4760146 48 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2449128 2449128 0 0.0
.bss 213940 213940 0 0.0
.data 5872 5872 0 0.0
.text 1411772 1411772 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1176643 1176643 0 0.0
bss 142900 142900 0 0.0
rodata 142204 142204 0 0.0
text 812636 812636 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 (read/write) 1156675 1156675 0 0.0
bss 142136 142136 0 0.0
rodata 133748 133748 0 0.0
text 801920 801920 0 0.0
p6 all-clusters-app default (read only) 882136 882136 0 0.0
(read/write) 1685036 1685036 0 0.0
.bss 148560 148560 0 0.0
.data 2648 2648 0 0.0
.text 1525440 1525440 0 0.0
all-clusters-minimal-app default (read only) 882856 882856 0 0.0
(read/write) 1629180 1629180 0 0.0
.bss 147840 147840 0 0.0
.data 2648 2648 0 0.0
.text 1470304 1470304 0 0.0
light-app default (read only) 891160 891160 0 0.0
(read/write) 1549220 1549220 0 0.0
.bss 139744 139744 0 0.0
.data 2440 2440 0 0.0
.text 1398648 1398648 0 0.0
lock-app default (read only) 891288 891288 0 0.0
(read/write) 1576220 1576220 0 0.0
.bss 139600 139600 0 0.0
.data 2456 2456 0 0.0
.text 1425776 1425776 0 0.0
telink light-switch-app tlsr9518adk80d (read/write) 798700 798700 0 0.0
bss 70576 70576 0 0.0
noinit 40416 40416 0 0.0
text 566814 566810 -4 -0.0
lighting-app tlsr9518adk80d (read/write) 818732 818732 0 0.0
bss 71420 71420 0 0.0
noinit 40416 40416 0 0.0
text 583344 583344 0 0.0

@woody-apple woody-apple merged commit a488d9a into project-chip:master Jul 19, 2022
@bzbarsky-apple bzbarsky-apple deleted the log-payload-string-lengths branch July 19, 2022 21:37
github-actions bot pushed a commit that referenced this pull request Jul 19, 2022
Logs lengths of UTF-8 strings in chars and octet strings in bytes.
woody-apple added a commit that referenced this pull request Jul 20, 2022
Logs lengths of UTF-8 strings in chars and octet strings in bytes.

Co-authored-by: Boris Zbarsky <[email protected]>
isiu-apple pushed a commit to isiu-apple/connectedhomeip that referenced this pull request Sep 16, 2022
Logs lengths of UTF-8 strings in chars and octet strings in bytes.
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.

6 participants