tty: switch tty_{,un}throttle_safe() to return a bool
authorJiri Slaby (SUSE) <jirislaby@kernel.org>
Tue, 19 Sep 2023 08:51:47 +0000 (10:51 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 3 Oct 2023 12:31:15 +0000 (14:31 +0200)
They return 0 or 1 -- a boolean value, so make it clear than noone
should expect negative or other values.

Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Link: https://lore.kernel.org/r/20230919085156.1578-7-jirislaby@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/tty/tty_ioctl.c
include/linux/tty.h

index 7958bf6..ba60fcf 100644 (file)
@@ -124,17 +124,16 @@ EXPORT_SYMBOL(tty_unthrottle);
  *     conditions when throttling is conditional on factors evaluated prior to
  *     throttling.
  *
- *     Returns 0 if tty is throttled (or was already throttled)
+ *     Returns false if tty is throttled (or was already throttled)
  */
-
-int tty_throttle_safe(struct tty_struct *tty)
+bool tty_throttle_safe(struct tty_struct *tty)
 {
-       int ret = 0;
+       bool ret = false;
 
        mutex_lock(&tty->throttle_mutex);
        if (!tty_throttled(tty)) {
                if (tty->flow_change != TTY_THROTTLE_SAFE)
-                       ret = 1;
+                       ret = true;
                else {
                        set_bit(TTY_THROTTLED, &tty->flags);
                        if (tty->ops->throttle)
@@ -155,17 +154,16 @@ int tty_throttle_safe(struct tty_struct *tty)
  *     unthrottle due to race conditions when unthrottling is conditional
  *     on factors evaluated prior to unthrottling.
  *
- *     Returns 0 if tty is unthrottled (or was already unthrottled)
+ *     Returns false if tty is unthrottled (or was already unthrottled)
  */
-
-int tty_unthrottle_safe(struct tty_struct *tty)
+bool tty_unthrottle_safe(struct tty_struct *tty)
 {
-       int ret = 0;
+       bool ret = false;
 
        mutex_lock(&tty->throttle_mutex);
        if (tty_throttled(tty)) {
                if (tty->flow_change != TTY_UNTHROTTLE_SAFE)
-                       ret = 1;
+                       ret = true;
                else {
                        clear_bit(TTY_THROTTLED, &tty->flags);
                        if (tty->ops->unthrottle)
index f002d0f..59d675f 100644 (file)
@@ -416,8 +416,8 @@ unsigned int tty_chars_in_buffer(struct tty_struct *tty);
 unsigned int tty_write_room(struct tty_struct *tty);
 void tty_driver_flush_buffer(struct tty_struct *tty);
 void tty_unthrottle(struct tty_struct *tty);
-int tty_throttle_safe(struct tty_struct *tty);
-int tty_unthrottle_safe(struct tty_struct *tty);
+bool tty_throttle_safe(struct tty_struct *tty);
+bool tty_unthrottle_safe(struct tty_struct *tty);
 int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
 int tty_get_icount(struct tty_struct *tty,
                struct serial_icounter_struct *icount);