Received-SPF: pass (google.com: domain of linux-kernel+bounces-105191-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Sat, 16 Mar 2024 13:51:28 +0000
From: Jonathan Cameron <jic23@kernel.org>
To: Vasileios Amoiridis <vassilisamir@gmail.com>
Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com>, lars@metafoo.de,
 ang.iglesiasg@gmail.com, mazziesaccount@gmail.com, ak@it-klinger.de,
 petre.rodan@subdimension.ro, linus.walleij@linaro.org,
 phil@raspberrypi.com, 579lpy@gmail.com, linux-iio@vger.kernel.org,
 linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 3/6] iio: pressure: add SCALE and RAW values for
 channels
Message-ID: <20240316135128.28f01ed6@jic23-huawei>
In-Reply-To: <ZfRI6oAxr6SXPLcf@vamoirid-EDL-PC>
References: <20240313174007.1934983-1-vassilisamir@gmail.com>
	<20240313174007.1934983-4-vassilisamir@gmail.com>
	<ZfH4bET-HX0e3PO_@smile.fi.intel.com>
	<20240313195110.GB1938985@vamoiridPC>
	<ZfIGtUPZpyDBnWwz@smile.fi.intel.com>
	<20240313212812.GE1938985@vamoiridPC>
	<ZfLYGL/vXMHUGghz@vamoirid-EDL-PC>
	<20240314144647.291a1100@jic23-huawei>
	<ZfRI6oAxr6SXPLcf@vamoirid-EDL-PC>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit

On Fri, 15 Mar 2024 14:11:06 +0100
Vasileios Amoiridis <vassilisamir@gmail.com> wrote:

> On Thu, Mar 14, 2024 at 02:46:47PM +0000, Jonathan Cameron wrote:
> > On Thu, 14 Mar 2024 11:57:28 +0100
> > vamoirid <vassilisamir@gmail.com> wrote:
> >   
> > > On Wed, Mar 13, 2024 at 10:28:12PM +0100, Vasileios Amoiridis wrote:  
> > > > On Wed, Mar 13, 2024 at 10:04:05PM +0200, Andy Shevchenko wrote:    
> > > > > On Wed, Mar 13, 2024 at 08:51:10PM +0100, Vasileios Amoiridis wrote:    
> > > > > > On Wed, Mar 13, 2024 at 09:03:08PM +0200, Andy Shevchenko wrote:    
> > > > > > > On Wed, Mar 13, 2024 at 06:40:04PM +0100, Vasileios Amoiridis wrote:    
> > > > > > > > Add extra IIO_CHAN_INFO_SCALE and IIO_CHAN_INFO_RAW in order to be
> > > > > > > > able to calculate the processed value with standard userspace IIO
> > > > > > > > tools. Can be used for triggered buffers as well.    
> > > > > 
> > > > > ...
> > > > >     
> > > > > > > > +	case IIO_CHAN_INFO_RAW:
> > > > > > > > +		switch (chan->type) {
> > > > > > > > +		case IIO_HUMIDITYRELATIVE:
> > > > > > > > +			*val = data->chip_info->read_humid(data);
> > > > > > > > +			ret = IIO_VAL_INT;
> > > > > > > > +			break;
> > > > > > > > +		case IIO_PRESSURE:
> > > > > > > > +			*val = data->chip_info->read_press(data);
> > > > > > > > +			ret = IIO_VAL_INT;
> > > > > > > > +			break;
> > > > > > > > +		case IIO_TEMP:
> > > > > > > > +			*val = data->chip_info->read_temp(data);
> > > > > > > > +			ret = IIO_VAL_INT;
> > > > > > > > +			break;
> > > > > > > > +		default:
> > > > > > > > +			ret = -EINVAL;
> > > > > > > > +			break;    
> > > > > > > 
> > > > > > > Is it mutex that prevents us from returning here?
> > > > > > > If so, perhaps switching to use cleanup.h first?    
> > > > > > 
> > > > > > I haven't seen cleanup.h used in any file and now that I searched,
> > > > > > only 5-6 are including it.    
> > > > > 
> > > > > Hmm... Which repository you are checking with?
> > > > > 
> > > > > $ git grep -lw cleanup.h -- drivers/ | wc -l
> > > > > 47
> > > > > 
> > > > > (Today's Linux Next)
> > > > >    
> > > > 
> > > > I am checking the drivers/iio of 6.8 (on sunday) and I can only find 7
> > > > drivers that use it.  
> > 
> > Yes - but that's because it's new - most of the stuff in 6.8 was the proof
> > points for the patches originally introducing support for autocleanup (so typically
> > one or two cases for each type of handling) That doesn't mean we don't want it
> > in drivers that are being worked upon if it gives a significant advantage.
> > Some features we need will merge shortly, and a great deal more usage
> > of this autocleanup will occur.
> >   
> > > >     
> > > > > > I am currently thinking if the mutex
> > > > > > that already exists is really needed since most of the drivers
> > > > > > don't have it + I feel like this is something that should be done
> > > > > > by IIO, thus maybe it's not even needed here.    
> > > > >    
> > > 
> > > After some researching today, I realized that all the                           
> > > {read/write}_{raw/avail}_{multi/}() functions are in drivers/iio/inkern.c
> > > for channel mapping in the kernel and it looks like they are guarded by
> > > the mutex_{un}lock(&iio_dev_opaque->info_exist_lock).  
> > 
> > Why is that relevant to this patch which isn't using that interface at all?
> > Those protections are to ensure that a consumer driver doesn't access a removed
> > IIO device, not accesses directly from userspace.
> >   
> > >so I feel that the
> > > mutexes in the aforementioned functions can be dropped. When you have the
> > > time please have a look, maybe the could be dropped.  
> > 
> > Identify what your locks are protecting.  Those existence locks have
> > very specific purpose and should not be relied on for anything else.
> > 
> > If this driver is protecting state known only to itself, then it must
> > be responsible for appropriate locking.
> >   
> > > 
> > > In general, there is quite some cleaning that can be done in this driver
> > > but is it wise to include it in the triggered buffer support series???   
> > 
> > Generally if working on a driver and you see cleanup that you think should
> > be done, it belongs before any series adding new features, precisely because
> > that code can typically end up simpler as a result.  This sounds like one
> > of those cases.  Normally that only includes things that are directly related
> > to resulting code for new features (or applying the same cleanup across a driver)
> > as we don't want to make people do a full scrub of a driver before adding
> > anything as it will just create too much noise.
> > 
> > So for this case, it does look like a quick use of guard(mutex) in
> > a precursor patch will simplify what you add here - hence that's a reasonable
> > request for Andy to make.
> > 
> > Jonathan
> >   
> 
> After looking into how to change the code to introduce the new guard(mutex)
> I encountered the following situation

No problem. We are all getting used to how to use this stuff. There
have been a few 'comments' from Linus Torvalds on people doing it wrong.
One of those (it was about cond_guard() proposal if you want to find it)
is applicable here (note that Linus was rather abrupt in that thread and
got called out for it, not in my view a good example of kernel process).

Make more use of helper functions to avoid gotos.

>
> In general, with the new guard(mutex) functinality you can remove most of the
> goto statements and return immediately without doing the cleanup yourself. 
> In the case of this driver, in the read_raw() call, apart from the mutex, 
> the power management functions are also used. This means that in each case, 
> before returning, the pm functions will need to be called, which I don't
> know if it will actually make the code cleaner. Have a look below with
> an example.
> 
> ----- Current Implementation -----
> 
> static int bmp280_read_raw( ... )
> {
> 	...
> 
> 	pm_runtime_get_sync_data(data->dev);

Pull from here...
> 	mutex_lock(&data->lock);
> 
> 	switch (mask) {
> 	case 1:
> 		switch (channel) {
> 		case TEMP:
> 			ret = read_temp();
> 			break;
> 		case PRESS:
> 			ret = read_press();
> 			break;
> 		...
> 	case 2:
> 		switch (channel) {
> 		...
> 
> 	case 3:
> 		...
> 	default:
> 		ret = -EINVAL;
> 		break;
> 	}
> 
> 	mutex_unlock(&data->lock);

.. to here out as a separate little function - somethimg like
bmp280_read_raw_impl() which can use guard() and direct returns
internally.

Then this block will be

	pm_runtime_get_sync_data(data->dev);
	ret = bmp280_read_raw_impl(...);
	pm_runtime_mark_last_busy(data->dev);
	pm_runtime_put_autosuspend(data->dev);

	return ret;

> 	pm_runtime_mark_last_busy(data->dev);
> 	pm_runtime_put_autosuspend(data->dev);
> 
> 	return ret;
> }
> 
> ----- End of Current Implementation -----
> 
> With the use of the guard(mutex)(&data->lock) you could immediately
> return without all the break statements. But we still need to call
> the pm functions. So the code, as far as I can understand will look
> like this:
> 
> ----- Guard Mutex Implementation -----
> 
> static int bmp280_read_raw( ... )
> {
> 	...
> 
> 	pm_runtime_get_sync_data(data->dev);
> 	guard(mutex)(&data->lock);
> 
> 	switch (mask) {
> 	case 1:
> 		switch (channel {
> 		case TEMP:
> 			ret = read_temp();

This inverts ordering of pm and the guard mutex, so not a good idea.

> 			pm_runtime_mark_last_busy(data->dev);
> 			pm_runtime_put_autosuspend(data->dev);
> 			return ret;
> 		case PRESS:
> 			ret = read_press();
> 			pm_runtime_mark_last_busy(data->dev);
> 			pm_runtime_put_autosuspend(data->dev);
> 			return ret;
> 		...
> 	case 2:
> 		switch (channel) {
> 		...
> 	case 3:
> 		...
> 	default:
> 		return -EINVAL;
> 	}
> 
> 	return 0;
> }
> 
> ----- End of Guard Mutex Implementation -----
> 
> Have I completely misunderstood something? If what I explain
> above is correct, you think that this is a better implementation
> and I should move forward becasue we want to use the guard(mutex)
> functionality? 
> 
> Maybe it is necessary to create some new type of guard to call
> also the pm functions before exiting?

Don't try that approach - it's complexity that will get a response
you don't want from Linus.  Helper functions solve this one
for us nicely.

At somepoint maybe generic infrastructure for runtime pm handling
will be added, but that stuff is complex enough already so I suspect
not or not until people are in general much more confident with the
cleanup.h infrastructure and where it is appropriate.

What you are doing here should all be standard usage at the simpler
end of the scale, so not a risky as a few things I'm trying to get in :)

Jonathan

> 
> Cheers,
> Vasilis
> 
> >   
> > > I
> > > have noticed quite some things that could be improved but I am hesitating
> > > to do it now in order to not "pollute" this series with many cleanups and
> > > leave it for another cleanup series for example.
> > > 
> > > Best regards,
> > > Vasilis Amoiridis
> > >   
> > > > > > > > +		}
> > > > > > > > +		break;    
> > > > > 
> > > > > -- 
> > > > > With Best Regards,
> > > > > Andy Shevchenko
> > > > > 
> > > > >     
> >   
>