[PATCH 1/2] jiffies: Define secs_to_jiffies()

[PATCH 1/2] jiffies: Define secs_to_jiffies()

[Easwar Hariharan]

There are ~500 usages of msecs_to_jiffies() that either use a multiplier
value of 1000 or equivalently MSEC_PER_SEC. Define secs_to_jiffies() to
allow such code to be less clunky.

Suggested-by: Michael Kelley <mhklinux@outlook.com>
Signed-off-by: Easwar Hariharan <eahariha@linux.microsoft.com>
---
 include/linux/jiffies.h   | 2 ++
 net/bluetooth/hci_event.c | 2 --
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h
index 1220f0fbe5bf..50dba516fd2f 100644
--- a/include/linux/jiffies.h
+++ b/include/linux/jiffies.h
@@ -526,6 +526,8 @@ static __always_inline unsigned long msecs_to_jiffies(const unsigned int m)
 	}
 }
 
+#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * MSEC_PER_SEC)
+
 extern unsigned long __usecs_to_jiffies(const unsigned int u);
 #if !(USEC_PER_SEC % HZ)
 static inline unsigned long _usecs_to_jiffies(const unsigned int u)
diff --git a/net/bluetooth/hci_event.c b/net/bluetooth/hci_event.c
index 0bbad90ddd6f..7b35c58bbbeb 100644
--- a/net/bluetooth/hci_event.c
+++ b/net/bluetooth/hci_event.c
@@ -42,8 +42,6 @@
 #define ZERO_KEY "\x00\x00\x00\x00\x00\x00\x00\x00" \
 		 "\x00\x00\x00\x00\x00\x00\x00\x00"
 
-#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * 1000)
-
 /* Handle HCI Event packets */
 
 static void *hci_ev_skb_pull(struct hci_dev *hdev, struct sk_buff *skb,
-- 
2.34.1

Re: [PATCH 1/2] jiffies: Define secs_to_jiffies()

[Easwar Hariharan]

On 10/22/2024 11:53 AM, Easwar Hariharan wrote:
> There are ~500 usages of msecs_to_jiffies() that either use a multiplier
> value of 1000 or equivalently MSEC_PER_SEC. Define secs_to_jiffies() to
> allow such code to be less clunky.
> 
> Suggested-by: Michael Kelley <mhklinux@outlook.com>
> Signed-off-by: Easwar Hariharan <eahariha@linux.microsoft.com>
> ---
>  include/linux/jiffies.h   | 2 ++
>  net/bluetooth/hci_event.c | 2 --
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h
> index 1220f0fbe5bf..50dba516fd2f 100644
> --- a/include/linux/jiffies.h
> +++ b/include/linux/jiffies.h
> @@ -526,6 +526,8 @@ static __always_inline unsigned long msecs_to_jiffies(const unsigned int m)
>  	}
>  }
>  
> +#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * MSEC_PER_SEC)
> +
>  extern unsigned long __usecs_to_jiffies(const unsigned int u);
>  #if !(USEC_PER_SEC % HZ)
>  static inline unsigned long _usecs_to_jiffies(const unsigned int u)
> diff --git a/net/bluetooth/hci_event.c b/net/bluetooth/hci_event.c
> index 0bbad90ddd6f..7b35c58bbbeb 100644
> --- a/net/bluetooth/hci_event.c
> +++ b/net/bluetooth/hci_event.c
> @@ -42,8 +42,6 @@
>  #define ZERO_KEY "\x00\x00\x00\x00\x00\x00\x00\x00" \
>  		 "\x00\x00\x00\x00\x00\x00\x00\x00"
>  
> -#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * 1000)
> -
>  /* Handle HCI Event packets */
>  
>  static void *hci_ev_skb_pull(struct hci_dev *hdev, struct sk_buff *skb,

Sorry, I should have combined distribution lists for the two patches, so
everyone received both patches. Combining the lists with this email.

Here's the lore link for the series:
https://lore.kernel.org/all/20241022185353.2080021-1-eahariha@linux.microsoft.com/

Thanks,
Easwar

Re: [PATCH 2/2] drivers: hv: Convert open-coded timeouts to secs_to_jiffies()

[Easwar Hariharan]

On 10/22/2024 11:53 AM, Easwar Hariharan wrote:
> We have several places where timeouts are open-coded as N (seconds) * HZ,
> but best practice is to use the utility functions from jiffies.h. Convert
> the timeouts to be compliant. This doesn't fix any bugs, it's a simple code
> improvement.
> 
> Signed-off-by: Easwar Hariharan <eahariha@linux.microsoft.com>
> ---
>  drivers/hv/hv_balloon.c  | 8 ++++----
>  drivers/hv/hv_kvp.c      | 4 ++--
>  drivers/hv/hv_snapshot.c | 3 ++-
>  drivers/hv/vmbus_drv.c   | 2 +-
>  4 files changed, 9 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/hv/hv_balloon.c b/drivers/hv/hv_balloon.c
> index c38dcdfcb914..79a72e68f427 100644
> --- a/drivers/hv/hv_balloon.c
> +++ b/drivers/hv/hv_balloon.c
> @@ -756,7 +756,7 @@ static void hv_mem_hot_add(unsigned long start, unsigned long size,
>  		 * adding succeeded, it is ok to proceed even if the memory was
>  		 * not onlined in time.
>  		 */
> -		wait_for_completion_timeout(&dm_device.ol_waitevent, 5 * HZ);
> +		wait_for_completion_timeout(&dm_device.ol_waitevent, secs_to_jiffies(5));
>  		post_status(&dm_device);
>  	}
>  }
> @@ -1373,7 +1373,7 @@ static int dm_thread_func(void *dm_dev)
>  	struct hv_dynmem_device *dm = dm_dev;
>  
>  	while (!kthread_should_stop()) {
> -		wait_for_completion_interruptible_timeout(&dm_device.config_event, 1 * HZ);
> +		wait_for_completion_interruptible_timeout(&dm_device.config_event, secs_to_jiffies(1));
>  		/*
>  		 * The host expects us to post information on the memory
>  		 * pressure every second.
> @@ -1748,7 +1748,7 @@ static int balloon_connect_vsp(struct hv_device *dev)
>  	if (ret)
>  		goto out;
>  
> -	t = wait_for_completion_timeout(&dm_device.host_event, 5 * HZ);
> +	t = wait_for_completion_timeout(&dm_device.host_event, secs_to_jiffies(5));
>  	if (t == 0) {
>  		ret = -ETIMEDOUT;
>  		goto out;
> @@ -1806,7 +1806,7 @@ static int balloon_connect_vsp(struct hv_device *dev)
>  	if (ret)
>  		goto out;
>  
> -	t = wait_for_completion_timeout(&dm_device.host_event, 5 * HZ);
> +	t = wait_for_completion_timeout(&dm_device.host_event, secs_to_jiffies(5));
>  	if (t == 0) {
>  		ret = -ETIMEDOUT;
>  		goto out;
> diff --git a/drivers/hv/hv_kvp.c b/drivers/hv/hv_kvp.c
> index d35b60c06114..29e01247a087 100644
> --- a/drivers/hv/hv_kvp.c
> +++ b/drivers/hv/hv_kvp.c
> @@ -655,7 +655,7 @@ void hv_kvp_onchannelcallback(void *context)
>  		if (host_negotiatied == NEGO_NOT_STARTED) {
>  			host_negotiatied = NEGO_IN_PROGRESS;
>  			schedule_delayed_work(&kvp_host_handshake_work,
> -				      HV_UTIL_NEGO_TIMEOUT * HZ);
> +						secs_to_jiffies(HV_UTIL_NEGO_TIMEOUT));
>  		}
>  		return;
>  	}
> @@ -724,7 +724,7 @@ void hv_kvp_onchannelcallback(void *context)
>  		 */
>  		schedule_work(&kvp_sendkey_work);
>  		schedule_delayed_work(&kvp_timeout_work,
> -					HV_UTIL_TIMEOUT * HZ);
> +				      secs_to_jiffies(HV_UTIL_TIMEOUT));
>  
>  		return;
>  
> diff --git a/drivers/hv/hv_snapshot.c b/drivers/hv/hv_snapshot.c
> index 0d2184be1691..86d87486ed40 100644
> --- a/drivers/hv/hv_snapshot.c
> +++ b/drivers/hv/hv_snapshot.c
> @@ -193,7 +193,8 @@ static void vss_send_op(void)
>  	vss_transaction.state = HVUTIL_USERSPACE_REQ;
>  
>  	schedule_delayed_work(&vss_timeout_work, op == VSS_OP_FREEZE ?
> -			VSS_FREEZE_TIMEOUT * HZ : HV_UTIL_TIMEOUT * HZ);
> +				secs_to_jiffies(VSS_FREEZE_TIMEOUT) :
> +				secs_to_jiffies(HV_UTIL_TIMEOUT));
>  
>  	rc = hvutil_transport_send(hvt, vss_msg, sizeof(*vss_msg), NULL);
>  	if (rc) {
> diff --git a/drivers/hv/vmbus_drv.c b/drivers/hv/vmbus_drv.c
> index 9b15f7daf505..7db30881e83a 100644
> --- a/drivers/hv/vmbus_drv.c
> +++ b/drivers/hv/vmbus_drv.c
> @@ -2507,7 +2507,7 @@ static int vmbus_bus_resume(struct device *dev)
>  	vmbus_request_offers();
>  
>  	if (wait_for_completion_timeout(
> -		&vmbus_connection.ready_for_resume_event, 10 * HZ) == 0)
> +		&vmbus_connection.ready_for_resume_event, secs_to_jiffies(10)) == 0)
>  		pr_err("Some vmbus device is missing after suspending?\n");
>  
>  	/* Reset the event for the next suspend. */

Sorry, I should have combined distribution lists for the two patches, so
everyone received both patches. Combining the lists with this email.

Here's the lore link for the series:
https://lore.kernel.org/all/20241022185353.2080021-1-eahariha@linux.microsoft.com/

Thanks,
Easwar

Re: [PATCH 1/2] jiffies: Define secs_to_jiffies()

[Anna-Maria Behnsen]

Easwar Hariharan <eahariha@linux.microsoft.com> writes:

> There are ~500 usages of msecs_to_jiffies() that either use a multiplier
> value of 1000 or equivalently MSEC_PER_SEC. Define secs_to_jiffies() to
> allow such code to be less clunky.

Can you please provide a proper cover letter for a series (also if it is
a series with only 2 patches)?

Regarding your commit message: secs_to_jiffies() is defined in hci_event
and cannot be reused by other callsites and this is why it's valuable to
move it into core code. Especially because there are ~500 users which do
the multiplier thing and there are also several users which use (secs *
HZ).

What do you think about converting the other users e.g. using
Coccinelle?

> Suggested-by: Michael Kelley <mhklinux@outlook.com>
> Signed-off-by: Easwar Hariharan <eahariha@linux.microsoft.com>
> ---
>  include/linux/jiffies.h   | 2 ++
>  net/bluetooth/hci_event.c | 2 --
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h
> index 1220f0fbe5bf..50dba516fd2f 100644
> --- a/include/linux/jiffies.h
> +++ b/include/linux/jiffies.h
> @@ -526,6 +526,8 @@ static __always_inline unsigned long msecs_to_jiffies(const unsigned int m)
>  	}
>  }
>  
> +#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * MSEC_PER_SEC)
> +

Why not only doing

#define secs_to_jiffies(s) (s * HZ)

>  extern unsigned long __usecs_to_jiffies(const unsigned int u);
>  #if !(USEC_PER_SEC % HZ)
>  static inline unsigned long _usecs_to_jiffies(const unsigned int u)
> diff --git a/net/bluetooth/hci_event.c b/net/bluetooth/hci_event.c
> index 0bbad90ddd6f..7b35c58bbbeb 100644
> --- a/net/bluetooth/hci_event.c
> +++ b/net/bluetooth/hci_event.c
> @@ -42,8 +42,6 @@
>  #define ZERO_KEY "\x00\x00\x00\x00\x00\x00\x00\x00" \
>  		 "\x00\x00\x00\x00\x00\x00\x00\x00"
>  
> -#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * 1000)
> -
>  /* Handle HCI Event packets */
>  
>  static void *hci_ev_skb_pull(struct hci_dev *hdev, struct sk_buff *skb,

Thanks,

	Anna-Maria

Re: [PATCH 1/2] jiffies: Define secs_to_jiffies()

[Easwar Hariharan]

On 10/23/2024 5:36 AM, Anna-Maria Behnsen wrote:
> Easwar Hariharan <eahariha@linux.microsoft.com> writes:
> 
>> There are ~500 usages of msecs_to_jiffies() that either use a multiplier
>> value of 1000 or equivalently MSEC_PER_SEC. Define secs_to_jiffies() to
>> allow such code to be less clunky.
> 
> Can you please provide a proper cover letter for a series (also if it is
> a series with only 2 patches)?

Yes, apologies, this isn't my usual mode of operations.

> 
> Regarding your commit message: secs_to_jiffies() is defined in hci_event
> and cannot be reused by other callsites and this is why it's valuable to
> move it into core code. Especially because there are ~500 users which do
> the multiplier thing and there are also several users which use (secs *
> HZ).
> 
> What do you think about converting the other users e.g. using
> Coccinelle?
> 

I intended to follow up this series with such. I'm not super familiar
with Coccinelle and am occupied by commercial work, so that may take longer.

>> Suggested-by: Michael Kelley <mhklinux@outlook.com>
>> Signed-off-by: Easwar Hariharan <eahariha@linux.microsoft.com>
>> ---
>>  include/linux/jiffies.h   | 2 ++
>>  net/bluetooth/hci_event.c | 2 --
>>  2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h
>> index 1220f0fbe5bf..50dba516fd2f 100644
>> --- a/include/linux/jiffies.h
>> +++ b/include/linux/jiffies.h
>> @@ -526,6 +526,8 @@ static __always_inline unsigned long msecs_to_jiffies(const unsigned int m)
>>  	}
>>  }
>>  
>> +#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * MSEC_PER_SEC)
>> +
> 
> Why not only doing
> 
> #define secs_to_jiffies(s) (s * HZ)

Yes, fair enough, I can change accordingly.

Thanks,
Easwar

[PATCH 1/2] jiffies: Define secs_to_jiffies()

[Easwar Hariharan]

There are ~500 usages of msecs_to_jiffies() that either use a multiplier
value of 1000 or equivalently MSEC_PER_SEC. Define secs_to_jiffies() to
allow such code to be less clunky.

Suggested-by: Michael Kelley <mhklinux@outlook.com>
Signed-off-by: Easwar Hariharan <eahariha@linux.microsoft.com>
---
 include/linux/jiffies.h   | 2 ++
 net/bluetooth/hci_event.c | 2 --
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h
index 1220f0fbe5bf..50dba516fd2f 100644
--- a/include/linux/jiffies.h
+++ b/include/linux/jiffies.h
@@ -526,6 +526,8 @@ static __always_inline unsigned long msecs_to_jiffies(const unsigned int m)
 	}
 }
 
+#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * MSEC_PER_SEC)
+
 extern unsigned long __usecs_to_jiffies(const unsigned int u);
 #if !(USEC_PER_SEC % HZ)
 static inline unsigned long _usecs_to_jiffies(const unsigned int u)
diff --git a/net/bluetooth/hci_event.c b/net/bluetooth/hci_event.c
index 0bbad90ddd6f..7b35c58bbbeb 100644
--- a/net/bluetooth/hci_event.c
+++ b/net/bluetooth/hci_event.c
@@ -42,8 +42,6 @@
 #define ZERO_KEY "\x00\x00\x00\x00\x00\x00\x00\x00" \
 		 "\x00\x00\x00\x00\x00\x00\x00\x00"
 
-#define secs_to_jiffies(_secs) msecs_to_jiffies((_secs) * 1000)
-
 /* Handle HCI Event packets */
 
 static void *hci_ev_skb_pull(struct hci_dev *hdev, struct sk_buff *skb,
-- 
2.34.1