Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Message-ID: <5e77017a.1c69fb81.dc341.8ab9@mx.google.com>
Date:   Sun, 22 Mar 2020 11:41:02 +0530
From:   Rohit Sarkar <rohitsarkar5398@gmail.com>
To:     Andy Shevchenko <andriy.shevchenko@intel.com>
Cc:     linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
        jic23@kernel.org, dragos.bogdan@analog.com,
        Lars-Peter Clausen <lars@metafoo.de>,
        Michael Hennerich <Michael.Hennerich@analog.com>,
        Stefan Popa <stefan.popa@analog.com>, knaack.h@gmx.de,
        pmeerw@pmeerw.net
Subject: Re: [PATCH] iio: gyro: adis16136: use scnprintf instead of snprintf
References: <5e723666.1c69fb81.3545b.79c3@mx.google.com>
 <20200322002542.GA2826015@smile.fi.intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20200322002542.GA2826015@smile.fi.intel.com>
User-Agent: Mutt/1.9.4 (2018-02-28)
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Sun, Mar 22, 2020 at 02:25:42AM +0200, Andy Shevchenko wrote:
> On Wed, Mar 18, 2020 at 08:25:22PM +0530, Rohit Sarkar wrote:
> > scnprintf returns the actual number of bytes written into the buffer as
> > opposed to snprintf which returns the number of bytes that would have
> > been written if the buffer was big enough. Using the output of snprintf
> > may lead to difficult to detect bugs.
> 
> Nice. Have you investigate the code?
> 
> > @@ -96,7 +96,7 @@ static ssize_t adis16136_show_serial(struct file *file,
> >  	if (ret)
> >  		return ret;
> >  
> > -	len = snprintf(buf, sizeof(buf), "%.4x%.4x%.4x-%.4x\n", lot1, lot2,
> > +	len = scnprintf(buf, sizeof(buf), "%.4x%.4x%.4x-%.4x\n", lot1, lot2,
> >  		lot3, serial);
> >  
> >  	return simple_read_from_buffer(userbuf, count, ppos, buf, len);
> 
> The buffer size is 20, the pattern size I count to 19. Do you think snprintf()
> can fail?
That might be the case, but IMO using scnprintf can be considered as a
best practice. There is no overhead with this change and further if the
pattern is changed by someone in the future they might overlook the
buffersize
Thanks,
Rohit
> -- 
> With Best Regards,
> Andy Shevchenko
> 
>