Unify SystemPool and lib/support/Pool

[kghost]

Problem

We have too many pool implementations

Change overview

Unify the interface of system/SystemPool and lib/support/pool. This PR change the interface of SystemPool to match lib/support/Pool. The pool provides following interface functions:

    T * CreateObject(Args&&... args)
    void ReleaseObject(T * object)
    template <typename Function> bool ForEachActiveObject(Function && function)

And also provides statistics interface:

    void ResetStatistics() {}
    void GetStatistics(Stats::count_t & aNumInUse, Stats::count_t & aHighWatermark) {}

Following features are decoupled from the pool implementation:

• Reference counter: if the target require this feature, it can derive from lib/core/ReferenceCounted class
• DeferredRelease: this feature should be orthogonal to pool implementation, the target class should implement it by itself.

Files changes:
Removed

• src/system/SystemObject.cpp
• src/system/SystemObject.h

Implementation on platforms with heap (POSIX):

• src/system/SystemPoolHeap.h

Implementation on platforms w/o heap (Embedded):

• src/system/SystemPoolNonHeap.h
• src/system/SystemPoolNonHeapBitmapAllocator.cpp
• src/system/SystemPoolNonHeapBitmapAllocator.h

Statistics:

• src/system/SystemPoolStatistics.h

Select implementation based on pre-defined macro

• src/system/SystemPool.h

Note: this PR depends on #9674 (merged) and #9678

Testing

Verified on posix platform.

Next PR will remove lib/support/Pool and migrate all usage to SystemPool.

[github-actions]

Size increase report for "gn_qpg-example-build" from 8e86c9e

File	Section	File	VM
chip-qpg6100-lighting-example.out	.text	268	268
chip-qpg6100-lighting-example.out	.bss	0	16
chip-qpg6100-lighting-example.out	.data	8	8
chip-qpg6100-lighting-example.out	.heap	0	-24

Full report output

BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-qpg6100-lighting-example.out.map and ./pull_artifact/chip-qpg6100-lighting-example.out.map:

BLOAT EXECUTION FAILED WITH CODE 1:
bloaty: unknown file type for file './pull_artifact/chip-qpg6100-lighting-example.out.map'

Comparing ./master_artifact/chip-qpg6100-lighting-example.out and ./pull_artifact/chip-qpg6100-lighting-example.out:

sections,vmsize,filesize
.debug_str,0,5448
.debug_loc,0,1960
.debug_ranges,0,736
.strtab,0,530
.symtab,0,384
.text,268,268
.debug_frame,0,172
.debug_aranges,0,64
.bss,16,0
.data,8,8
.shstrtab,0,2
.heap,-24,0
[Unmapped],0,-268
.debug_abbrev,0,-5606
.debug_line,0,-11604
.debug_info,0,-292854

[github-actions]

Size increase report for "nrfconnect-example-build" from 8e86c9e

File	Section	File	VM
chip-lock.elf	text	168	168
chip-lock.elf	bss	0	32
chip-lock.elf	init_array	8	8
chip-shell.elf	text	172	172
chip-shell.elf	bss	0	26
chip-shell.elf	init_array	8	8
chip-shell.elf	device_handles	-4	-4
chip-shell.elf	[LOAD #3 [RW]]	0	-26

Full report output

BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-lock.elf and ./pull_artifact/chip-lock.elf:

sections,vmsize,filesize
.debug_str,0,5253
.debug_loc,0,1619
.debug_ranges,0,568
.strtab,0,364
.symtab,0,336
text,168,168
.debug_frame,0,128
.debug_aranges,0,48
bss,32,0
init_array,8,8
.debug_abbrev,0,-4318
.debug_line,0,-16361
.debug_info,0,-344185

Comparing ./master_artifact/chip-shell.elf and ./pull_artifact/chip-shell.elf:

sections,vmsize,filesize
.debug_str,0,5246
.debug_loc,0,1814
.debug_ranges,0,568
.strtab,0,364
.symtab,0,336
.debug_abbrev,0,289
text,172,172
.debug_frame,0,128
.debug_aranges,0,48
bss,26,0
init_array,8,8
device_handles,-4,-4
[LOAD #3 [RW]],-26,0
.debug_line,0,-7140
.debug_info,0,-151785

[github-actions]

Size increase report for "esp32-example-build" from 8e86c9e

File	Section	File	VM
chip-all-clusters-app.elf	.dram0.bss	0	648
chip-all-clusters-app.elf	.flash.text	412	412
chip-all-clusters-app.elf	.iram0.text_end	0	56
chip-all-clusters-app.elf	.dram0.heap_start	0	8
chip-all-clusters-app.elf	.flash.rodata	-16	-16
chip-all-clusters-app.elf	.iram0.text	-56	-56

Full report output

BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-all-clusters-app.elf and ./pull_artifact/chip-all-clusters-app.elf:

sections,vmsize,filesize
.debug_info,0,2837091
.debug_line,0,25222
.debug_abbrev,0,12065
.debug_str,0,6678
[Unmapped],0,3756
.debug_loc,0,1804
.dram0.bss,648,0
.strtab,0,587
.debug_ranges,0,448
.flash.text,412,412
.debug_frame,0,372
.symtab,0,128
.debug_aranges,0,120
.iram0.text_end,56,0
.dram0.heap_start,8,0
.shstrtab,0,1
.flash.rodata,-16,-16
.iram0.text,-56,-56

[andy31415]

@kghost - conflicts

[msandstedt]

Is this superseded by #9748? It appears that PR already includes most or all of this content.

If so, we should close this or at least mark it for no-merge.

[yufengwangca]

No, we should not change std::mutex to std::recursive_mutex, we already have consensus before not using recursive_mutex in our SDK, this will hide some problems which is extremely difficult to debug

[yufengwangca]

We should use std::mutex instead of std::recursive_mutex

[yufengwangca]

Is this superseded by #9748? It appears that PR already includes most or all of this content.

If so, we should close this or at least mark it for no-merge.

Yes, same change is also included in #9748, and there is change request on that PR, we should close this one and proceed with #9748

[stale]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

[stale]

This stale pull request has been automatically closed. Thank you for your contributions.