Skip to content

coresight: Fix CTI module refcount leak by making it a helper device

James Clark linux-arm-kernel lkml 6 versions – Applied

Status from this message: Queued to coresight/next

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v6 Latest13 patches 1 replyApplied
  2. v513 patches 14 repliesSuperseded
  3. v413 patches 2 repliesSuperseded
Earlier versions · 3
VersionPostedPatchesRepliesStatus
v313 patches14 repliesSuperseded
v29 patches27 repliesSuperseded
v18 patches1 replySuperseded

Changes in v6 from the cover letter

* Formatting fixes
* helper->type != CORESIGHT_DEV_TYPE_HELPER -> !coresight_is_helper()
* Remove ect from coresight_dev_type and add a static assert so that it stays in sync with the enum

Patches in v6 Applied

#Subject and filesSizeRepliesApplied
1/13coresight: Fix loss of connection info when a module is unloadeddrivers/hwtracing/coresight/coresight-core.c+2 -70 replies
2/13coresight: Use enum type for cs_mode wherever possibledrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-etb10.c drivers/hwtracing/coresight/coresight-etm3x-core.c +11 more+40 -340 replies
3/13coresight: Change name of pdata->connsdrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-platform.c drivers/hwtracing/coresight/coresight-tmc-etr.c +1 more+22 -220 replies
4/13coresight: Rename nr_outports to nr_outconnsdrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-platform.c drivers/hwtracing/coresight/coresight-tmc-etr.c +1 more+39 -390 replies
5/13coresight: Rename connection members to make the direction explicitdrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-platform.c drivers/hwtracing/coresight/coresight-sysfs.c +2 more+55 -560 replies
6/13coresight: Dynamically add connectionsdrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-platform.c include/linux/coresight.h+77 -780 replies
7/13coresight: Store pointers to connections rather than an array of themdrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-platform.c drivers/hwtracing/coresight/coresight-priv.h +2 more+44 -300 replies
8/13coresight: Simplify connection fixup mechanismdrivers/hwtracing/coresight/coresight-core.c+32 -520 replies
9/13coresight: Store in-connections as well as out-connectionsdrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-platform.c drivers/hwtracing/coresight/coresight-sysfs.c +1 more+95 -500 replies
10/13coresight: Make refcount a property of the connectiondrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-etb10.c drivers/hwtracing/coresight/coresight-funnel.c +8 more+126 -2430 replies
11/13coresight: Refactor out buffer allocation function for ETRdrivers/hwtracing/coresight/coresight-tmc-etr.c drivers/hwtracing/coresight/coresight-tmc.h+45 -70 replies
12/13coresight: Enable and disable helper devices adjacent to the pathdrivers/hwtracing/coresight/coresight-catu.c drivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-etm-perf.c +3 more+188 -550 replies
13/13coresight: Fix CTI module refcount leak by making it a helper devicedrivers/hwtracing/coresight/coresight-core.c drivers/hwtracing/coresight/coresight-cti-core.c drivers/hwtracing/coresight/coresight-cti-sysfs.c +4 more+81 -1320 replies

Reviews trailers per patch

All 13 patches have a Reviewed-by or Acked-by.

PatchSuzuki K PouloseMike Leach
1/13T-b R-b
2/13R-b
3/13R-b
4/13R-b
5/13R-b
6/13R-b
7/13R-b
8/13R-b
9/13R-b
10/13R-b
11/13R-b
12/13R-b
13/13R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v6 thread

Cover letter [PATCH v6 00/13] coresight: Fix CTI module refcount leak by making it a helper device

Changes since v5:

* Formatting fixes
* helper->type != CORESIGHT_DEV_TYPE_HELPER -> !coresight_is_helper()
* Remove ect from coresight_dev_type and add a static assert so that it stays in sync with the enum

------------------

Changes since v4:

* Update commit message on patch 1
* Drop previous change that added lockdep checks to coresight_add_helper() because they are already in mutex_lock(). But keep extra comment.
* Check for allocation failure in coresight_add_out_conn()

------------------

Changes since v3:

* Put connection loss fix at the beginning so that it can be backported
* Replace coresight_find_link_{x}() with coresight_find_out_connection()
* Reorder coresight_enable_source() arguments for consistency
* Add source and destination reference counts so that two link devices connected together don't clash
* Add coresight_is_helper()
* Fix overwriting csdev bug in coresight_orphan_match()
* Don't clear conns[i]->dest_fwnode in coresight_remove_conns() in case it's used again
* Use dev instead of adev->dev for devmem allocation in acpi_coresight_parse_graph() so that it's consistent with DT mode and doesn't cause a warning on free.
* Rename coresight_add_helper_mutex() -> coresight_add_helper()
* Ensure coresight_mutex isn't already held in coresight_add_helper()
* Return new connection from coresight_add_out_conn()
* Comment and formatting improvements

------------------

Changes since v2:

* Make out_conns array contiguous instead of sparse which simplifies filling and using it. New connections are always added to the end
* Store pointers to individual connection objects so that they can be shared between inputs and outputs
* Fix an existing bug where connection info was lost when unloading a device
* Simplify connection fixup functions. Now the orphan mechanism is used for inputs in the same way as outputs to guarantee that all connections have both an input and an output set
* Use input connections to disconnect devices on unload instead of iterating through them all
* Make refcount a property of the connection rather than use it's own array based on the number of inputs and outputs
* Fix a bug in v2 where helpers attached to the source device weren't disabled because coresight-etm-perf.c was making a raw call to disable rather than using a helper.
* Change names of connection members to make direction explicit now that the connection is shared between input and outputs

------------------

Changes since v1:

* Don't dereference handle in tmc_etr_get_buffer() when not in perf mode.
* Fix some W=1 warnings
* Add a commit to rename child/output in terms of local/remote

-------------------

Currently there is a refcount leak in CTI when using system wide mode or tracing multithreaded applications. See the last commit for a reproducer. This prevents the module from being unloaded.

Historically there have been a few issues and fixes attempted around here which have resulted in some extra logic and a member to keep track of CTI being enabled 'struct coresight_device->ect_enabled'. The fix in commit 665c157e0204 ("coresight: cti: Fix hang in cti_disable_hw()") was also related to CTI having its own enable/disable path which came later than other devices.

If we make CTI a helper device and enable helper devices adjacent to the path we get very similar enable/disable behavior to now, but with more reuse of the existing reference counting logic in the coresight core code. This also affects CATU which can have a little bit of its hard coded enable/disable code removed.

Enabling CATU on the generic path does require that input connections are tracked so that it can get its associated ETR buffer.

Applies to coresight/next (18996a113f256) but everything except the first fixes commit requires the realloc_array patch here [1].

Also available in full here [2].

[1]: https://lore.kernel.org/linux-arm-kernel/[email protected]/
[2]: https://gitlab.arm.com/linux-arm/linux-jc/-/tree/james-cs-cti-module-refcount-fix-v6

James Clark (13):
coresight: Fix loss of connection info when a module is unloaded
coresight: Use enum type for cs_mode wherever possible
coresight: Change name of pdata->conns
coresight: Rename nr_outports to nr_outconns
coresight: Rename connection members to make the direction explicit
coresight: Dynamically add connections
coresight: Store pointers to connections rather than an array of them
coresight: Simplify connection fixup mechanism
coresight: Store in-connections as well as out-connections
coresight: Make refcount a property of the connection
coresight: Refactor out buffer allocation function for ETR
coresight: Enable and disable helper devices adjacent to the path
coresight: Fix CTI module refcount leak by making it a helper device

 drivers/hwtracing/coresight/coresight-catu.c  |  21 +-
 drivers/hwtracing/coresight/coresight-core.c  | 605 +++++++++---------
 .../hwtracing/coresight/coresight-cti-core.c  |  52 +-
 .../hwtracing/coresight/coresight-cti-sysfs.c |   4 +-
 drivers/hwtracing/coresight/coresight-cti.h   |   4 +-
 drivers/hwtracing/coresight/coresight-etb10.c |  13 +-
 .../hwtracing/coresight/coresight-etm-perf.c  |   4 +-
 .../coresight/coresight-etm3x-core.c          |   6 +-
 .../coresight/coresight-etm4x-core.c          |   6 +-
 .../hwtracing/coresight/coresight-funnel.c    |  26 +-
 .../hwtracing/coresight/coresight-platform.c  | 269 +++-----
 drivers/hwtracing/coresight/coresight-priv.h  |  17 +-
 .../coresight/coresight-replicator.c          |  23 +-
 drivers/hwtracing/coresight/coresight-stm.c   |   6 +-
 drivers/hwtracing/coresight/coresight-sysfs.c |  17 +-
 .../hwtracing/coresight/coresight-tmc-etf.c   |  26 +-
 .../hwtracing/coresight/coresight-tmc-etr.c   | 110 ++--
 drivers/hwtracing/coresight/coresight-tmc.h   |   2 +
 drivers/hwtracing/coresight/coresight-tpda.c  |  23 +-
 drivers/hwtracing/coresight/coresight-tpdm.c  |   4 +-
 drivers/hwtracing/coresight/coresight-tpiu.c  |   7 +-
 drivers/hwtracing/coresight/coresight-trbe.c  |   3 +-
 drivers/hwtracing/coresight/ultrasoc-smb.c    |  11 +-
 drivers/hwtracing/coresight/ultrasoc-smb.h    |   2 +-
 include/linux/coresight.h                     | 126 ++--
 25 files changed, 714 insertions(+), 673 deletions(-)
Signature · 1 line
2.34.1