linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@intel.com>
To: Devarsh Thakkar <devarsht@ti.com>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: mchehab@kernel.org, hverkuil-cisco@xs4all.nl,
	linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
	sebastian.fricke@collabora.com, linux-doc@vger.kernel.org,
	praneeth@ti.com, nm@ti.com, vigneshr@ti.com, s-jain1@ti.com,
	r-donadkar@ti.com, b-brnich@ti.com, detheridge@ti.com,
	p-mantena@ti.com, vijayp@ti.com, andi.shyti@linux.intel.com,
	nicolas@ndufresne.ca, jirislaby@kernel.org, davidgow@google.com,
	dlatypov@google.com, corbet@lwn.net, broonie@kernel.org,
	rdunlap@infradead.org, nik.borisov@suse.com, Dave.Martin@arm.com
Subject: Re: [PATCH v2 1/6] math.h: Add macros for rounding to the closest value
Date: Tue, 27 Aug 2024 15:40:00 +0300	[thread overview]
Message-ID: <87frqqyw9r.fsf@intel.com> (raw)
In-Reply-To: <9c41f6b7-6b06-cd5b-74bd-24873c4beaf7@ti.com>

On Tue, 27 Aug 2024, Devarsh Thakkar <devarsht@ti.com> wrote:
> Hi Andy,
>
> Thanks for the review.
>
> On 26/08/24 23:14, Andy Shevchenko wrote:
>> On Mon, Aug 26, 2024 at 08:38:17PM +0530, Devarsh Thakkar wrote:
>>> Add below rounding related macros:
>>>
>>> round_closest_up(x, y) : Rounds x to the closest multiple of y where y is a
>>> power of 2, with a preference to round up in case two nearest values are
>>> possible.
>>>
>>> round_closest_down(x, y) : Rounds x to the closest multiple of y where y is
>>> a power of 2, with a preference to round down in case two nearest values
>>> are possible.
>>>
>>> roundclosest(x, y) : Rounds x to the closest multiple of y, this macro
>>> should generally be used only when y is not multiple of 2 as otherwise
>>> round_closest* macros should be used which are much faster.
>> 
>> I understand the point, but if you need to send a v3, please explain
>> the equivalency between roundclosest() and one (or both?) of the
>> round_closest_*() in case the argument is power-of-2.
>> 
>
> The equivalency between roundclosest w.r.t round_closest is same as
> equivalency between existing macros rounddown w.r.t round_down. Functionally
> both are same but the former is recommended to be used only for the scenario
> where multiple is not power of 2 and latter is faster but is strictly for the
> scenario where multiple is power of 2. I think the same is already summarized
> well in commit message and further elaborated in the patch itself as part of
> header file comments [1] so I personally don't think any update is required
> w.r.t this.

I still don't think rounddown vs. round_down naming is a good example to
model anything after.

I have yet to hear a single compelling argument in favor of having a
single underscore in the middle of a name having implications about the
inputs of a macro/function.

The macros being added here are at 2 or 3 in Rusty's scale [1]. We could
aim for 6 (The name tells you how to use it), but also do opportunistic
8 (The compiler will warn if you get it wrong) for compile-time
constants.

As-is, these, and round_up/round_down, are just setting a trap for an
unsuspecting kernel developer to fall into.


BR,
Jani.


[1] https://ozlabs.org/~rusty/index.cgi/tech/2008-03-30.html


>
> [1]: https://lore.kernel.org/all/20240826150822.4057164-2-devarsht@ti.com
>
> Regards
> Devarsh

-- 
Jani Nikula, Intel

  reply	other threads:[~2024-08-27 12:40 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-26 15:08 [PATCH v2 0/6] Add rounding macros and enable KUnit tests Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 1/6] math.h: Add macros for rounding to the closest value Devarsh Thakkar
2024-08-26 17:44   ` Andy Shevchenko
2024-08-27 11:27     ` Devarsh Thakkar
2024-08-27 12:40       ` Jani Nikula [this message]
2024-08-27 15:14         ` Devarsh Thakkar
2024-08-29  9:19           ` Jani Nikula
2024-08-29  9:54             ` Jiri Slaby
2024-08-30 16:09               ` Devarsh Thakkar
2024-09-30  1:18               ` Randy Dunlap
2024-08-30 13:45   ` Dave Martin
2024-08-26 15:08 ` [PATCH v2 2/6] math.h: Use kernel-doc syntax for division macros Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 3/6] Documentation: core-api: Add math.h macros and functions Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 4/6] lib: Add basic KUnit test for lib/math Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 5/6] lib: math_kunit: Add tests for new macros related to rounding to nearest value Devarsh Thakkar
2024-08-30 14:07   ` Dave Martin
2024-08-26 15:08 ` [PATCH v2 6/6] media: imagination: Round to closest multiple for cropping region Devarsh Thakkar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87frqqyw9r.fsf@intel.com \
    --to=jani.nikula@intel.com \
    --cc=Dave.Martin@arm.com \
    --cc=andi.shyti@linux.intel.com \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=b-brnich@ti.com \
    --cc=broonie@kernel.org \
    --cc=corbet@lwn.net \
    --cc=davidgow@google.com \
    --cc=detheridge@ti.com \
    --cc=devarsht@ti.com \
    --cc=dlatypov@google.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=jirislaby@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=nicolas@ndufresne.ca \
    --cc=nik.borisov@suse.com \
    --cc=nm@ti.com \
    --cc=p-mantena@ti.com \
    --cc=praneeth@ti.com \
    --cc=r-donadkar@ti.com \
    --cc=rdunlap@infradead.org \
    --cc=s-jain1@ti.com \
    --cc=sebastian.fricke@collabora.com \
    --cc=vigneshr@ti.com \
    --cc=vijayp@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).