Skip to content

RFC iio: improve handling of direct mode claim and release

Jonathan Cameron linux-iio 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest27 patches 21 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/27iio: core: Rework claim and release of direct mode to work with sparse.include/linux/iio/iio.h+22 -010 replies
2/27iio: chemical: scd30: Switch to sparse friendly claim/release_direct()drivers/iio/chemical/scd30_core.c+5 -41 reply
3/27iio: temperature: tmp006: Stop using iio_device_claim_direct_scoped()drivers/iio/temperature/tmp006.c+19 -140 replies
4/27iio: imu: st_lsm6dsx: Switch to sparse friendly claim/release_direct()drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_core.c+6 -80 replies
5/27iio: proximity: sx9310: Stop using iio_device_claim_direct_scoped()drivers/iio/proximity/sx9310.c+13 -60 replies
6/27iio: proximity: sx9324: Stop using iio_device_claim_direct_scoped()drivers/iio/proximity/sx9324.c+13 -60 replies
7/27iio: proximity: sx9360: Stop using iio_device_claim_direct_scoped()drivers/iio/proximity/sx9360.c+13 -60 replies
8/27iio: accel: adxl367: Stop using iio_device_claim_direct_scoped()drivers/iio/accel/adxl367.c+106 -880 replies
9/27iio: adc: ad4000: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad4000.c+38 -236 replies
10/27iio: adc: ad4130: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad4130.c+4 -60 replies
11/27iio: adc: ad4130: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad4130.c+7 -10 replies
12/27iio: adc: ad4695: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad4695.c+133 -1070 replies
13/27iio: adc: ad7606: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad7606.c+7 -70 replies
14/27iio: adc: ad7625: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad7625.c+6 -30 replies
15/27iio: adc: ad7779: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad7779.c+63 -400 replies
16/27iio: adc: ad9467: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ad9467.c+16 -70 replies
17/27iio: adc: max1363: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/max1363.c+89 -760 replies
18/27iio: adc: rtq6056: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/rtq6056.c+25 -140 replies
19/27iio: adc: ti-adc161s626: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ti-adc161s626.c+7 -70 replies
20/27iio: adc: ti-ads1119: Stop using iio_device_claim_direct_scoped()drivers/iio/adc/ti-ads1119.c+11 -60 replies
21/27iio: addac: ad74413r: Stop using iio_device_claim_direct_scoped()drivers/iio/addac/ad74413r.c+9 -50 replies
22/27iio: chemical: ens160: Stop using iio_device_claim_direct_scoped()drivers/iio/chemical/ens160_core.c+21 -110 replies
23/27iio: dac: ad3552r-hs: Stop using iio_device_claim_direct_scoped()drivers/iio/dac/ad3552r-hs.c+9 -60 replies
24/27iio: dac: ad8460: Stop using iio_device_claim_direct_scoped()drivers/iio/dac/ad8460.c+12 -60 replies
25/27iio: dummy: Stop using iio_device_claim_direct_scoped()drivers/iio/dummy/iio_simple_dummy.c+70 -490 replies
26/27iio: imu: bmi323: Stop using iio_device_claim_direct_scoped()drivers/iio/imu/bmi323/bmi323_core.c+32 -190 replies
27/27iio: light: bh1745: Stop using iio_device_claim_direct_scoped()drivers/iio/light/bh1745.c+9 -90 replies

Reviews trailers per patch

1 of 27 patches has a Reviewed-by or Acked-by.

Patch[email protected]Marcelo Schmitt
1/27
2/27
3/27
4/27
5/27
6/27
7/27
8/27
9/27A-b R-b T-b
10/27
11/27
12/27
13/27
14/27
15/27
16/27
17/27
18/27
19/27
20/27
21/27
22/27
23/27
24/27
25/27
26/27
27/27

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

Read the v1 thread

Cover letter [RFC PATCH 00/27] iio: improve handling of direct mode claim and release

From: Jonathan Cameron <[email protected]>

Note I haven't attempted to CC relevant people for specific drivers. I'll do that for a non RFC version if we move forwards.

Effectively two linked things in this series:

1) Ripping out iio_device_claim_direct_scoped()
2) Enabling use of sparse to check the claim is always released.

The iio_device_claim_direct_scoped() was an interesting experiment built on conditional scoped guards, but it has been the source of a range of esoteric build warnings and is awkward to use.

Several attempts have been made to improve the related handling but in the end it looks like this is just too hard to use and too prone to tripping up the compiler. So time to rip it out. Most recent discussion was around if_not_cond_guard()
https://lore.kernel.org/all/CAHk-=wi8C2yZF_y_T180-v+dSZAhps5QghS_2tKfn-+xAghYPQ@mail.gmail.com/
which looked like a promising avenue but ran into problems and got reverted.

A large part of the advantage of scoped cleanup is that it removes the possibility of failing to call the 'destructor' which here released the claim on direct mode (implementation detail is that corresponds to unlocking a mutex). It's a shame to lose that but we do have other infrastructure to prevent such common mistakes, lock markings + sparse. Hence I thought we could simply enable those for existing iio_device_claim_direct_mode() / iio_device_release_direct_mode() via similar magic to that used for __cond_lock() that is rename existing iio_device_claim_direct_mode to do_iio_device_claim_direct_mode and

#define iio_device_cliam_direct_mode(iio_dev) \
	do_iio_device_claim_direct_mode(iio_dev) ? : ({ __acquire(iio_dev); 0; })

Unfortunatley that gives a few false positives. Seems sparse is tripping up on this magic in some more complex switch statements.

Rather than figure out how to fix sparse, this patch set currently proposes some new handlers that can use __cond_acquires() and __releases() markings.

iio_device_claim_direct() and iio_device_claim_release(). Key is that iio_device_claim_direct() returns a boolean (true for the claim succeeding, false for it not). Naming is based on no one seeming bothered that we dropped mode from the scoped case. Long term plan would be to drop the _direct_mode() calls.

To test this out I've included converting some of the sources of false positives with the first approach above and all but 1 of the users of iio_device_claim_direct_scoped() (That 1 is being removed in a another series). It's possible there will be false positives when converting all the other drivers but I can't see why similar would not have been seen for the trylock equivalent markings.

I'm not sure which way to go here:

1) Transition to this lock like scheme. Advantage is that this code looks more 'standard' when it comes to new checks etc in future.
2) Figure out how to avoid the false positives from sparse (see patch 1 for a little more information on that)
It is easy to surpress them but that's not a long term solution as false positives will continue to annoy us from time to time.

Luc, if you have any suggestions on that it would be most welcome. I don't have the patch to hand any more but I can easilly recreate it to test out any theories on the reasons for the false positives.

Hence the RFC.

Note that replacing of _scoped() calls takes a mixture of different paths and in some cases involves moving locks / direct_claims up or down the call stack, and in others adding aditional utility functions with the claim done around calls of those. Which makes sense depends on the complexity of the particular code being called.

Jonathan

Jonathan Cameron (27):
iio: core: Rework claim and release of direct mode to work with
sparse.
iio: chemical: scd30: Switch to sparse friendly claim/release_direct()
iio: temperature: tmp006: Stop using iio_device_claim_direct_scoped()
iio: imu: st_lsm6dsx: Switch to sparse friendly claim/release_direct()
iio: proximity: sx9310: Stop using iio_device_claim_direct_scoped()
iio: proximity: sx9324: Stop using iio_device_claim_direct_scoped()
iio: proximity: sx9360: Stop using iio_device_claim_direct_scoped()
iio: accel: adxl367: Stop using iio_device_claim_direct_scoped()
iio: adc: ad4000: Stop using iio_device_claim_direct_scoped()
iio: adc: ad4130: Stop using iio_device_claim_direct_scoped()
iio: adc: ad4130: Stop using iio_device_claim_direct_scoped()
iio: adc: ad4695: Stop using iio_device_claim_direct_scoped()
iio: adc: ad7606: Stop using iio_device_claim_direct_scoped()
iio: adc: ad7625: Stop using iio_device_claim_direct_scoped()
iio: adc: ad7779: Stop using iio_device_claim_direct_scoped()
iio: adc: ad9467: Stop using iio_device_claim_direct_scoped()
iio: adc: max1363: Stop using iio_device_claim_direct_scoped()
iio: adc: rtq6056: Stop using iio_device_claim_direct_scoped()
iio: adc: ti-adc161s626: Stop using iio_device_claim_direct_scoped()
iio: adc: ti-ads1119: Stop using iio_device_claim_direct_scoped()
iio: addac: ad74413r: Stop using iio_device_claim_direct_scoped()
iio: chemical: ens160: Stop using iio_device_claim_direct_scoped()
iio: dac: ad3552r-hs: Stop using iio_device_claim_direct_scoped()
iio: dac: ad8460: Stop using iio_device_claim_direct_scoped()
iio: dummy: Stop using iio_device_claim_direct_scoped()
iio: imu: bmi323: Stop using iio_device_claim_direct_scoped()
iio: light: bh1745: Stop using iio_device_claim_direct_scoped()

 drivers/iio/accel/adxl367.c                  | 194 ++++++++-------
 drivers/iio/adc/ad4000.c                     |  61 +++--
 drivers/iio/adc/ad4130.c                     |  18 +-
 drivers/iio/adc/ad4695.c                     | 240 ++++++++++---------
 drivers/iio/adc/ad7606.c                     |  14 +-
 drivers/iio/adc/ad7625.c                     |   9 +-
 drivers/iio/adc/ad7779.c                     | 103 ++++----
 drivers/iio/adc/ad9467.c                     |  23 +-
 drivers/iio/adc/max1363.c                    | 165 +++++++------
 drivers/iio/adc/rtq6056.c                    |  39 +--
 drivers/iio/adc/ti-adc161s626.c              |  14 +-
 drivers/iio/adc/ti-ads1119.c                 |  17 +-
 drivers/iio/addac/ad74413r.c                 |  14 +-
 drivers/iio/chemical/ens160_core.c           |  32 ++-
 drivers/iio/chemical/scd30_core.c            |   9 +-
 drivers/iio/dac/ad3552r-hs.c                 |  15 +-
 drivers/iio/dac/ad8460.c                     |  18 +-
 drivers/iio/dummy/iio_simple_dummy.c         | 119 +++++----
 drivers/iio/imu/bmi323/bmi323_core.c         |  51 ++--
 drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_core.c |  14 +-
 drivers/iio/light/bh1745.c                   |  18 +-
 drivers/iio/proximity/sx9310.c               |  19 +-
 drivers/iio/proximity/sx9324.c               |  19 +-
 drivers/iio/proximity/sx9360.c               |  19 +-
 drivers/iio/temperature/tmp006.c             |  33 +--
 include/linux/iio/iio.h                      |  22 ++
 26 files changed, 765 insertions(+), 534 deletions(-)
Signature · 1 line
2.47.1