tty: remove TTY_MAGIC
authorнаб <nabijaczleweli@nabijaczleweli.xyz>
Fri, 16 Sep 2022 01:54:59 +0000 (03:54 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 22 Sep 2022 14:12:34 +0000 (16:12 +0200)
According to Greg, in the context of magic numbers as defined in
magic-number.rst, "the tty layer should not need this and I'll gladly
take patches"

Acked-by: Jiri Slaby <jirislaby@kernel.org>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Ref: https://lore.kernel.org/linux-doc/YyMlovoskUcHLEb7@kroah.com/
Link: https://lore.kernel.org/r/476d024cd6b04160a5de381ea2b9856b60088cbd.1663288066.git.nabijaczleweli@nabijaczleweli.xyz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/process/magic-number.rst
Documentation/translations/it_IT/process/magic-number.rst
Documentation/translations/zh_CN/process/magic-number.rst
Documentation/translations/zh_TW/process/magic-number.rst
drivers/tty/tty_io.c
drivers/tty/tty_mutex.c
include/linux/tty.h

index f5ba36e..b4c7ec6 100644 (file)
@@ -84,7 +84,6 @@ SLIP_MAGIC            0x5302           slip                     ``drivers/net/sl
 STRIP_MAGIC           0x5303           strip                    ``drivers/net/strip.c``
 SIXPACK_MAGIC         0x5304           sixpack                  ``drivers/net/hamradio/6pack.h``
 AX25_MAGIC            0x5316           ax_disp                  ``drivers/net/mkiss.h``
-TTY_MAGIC             0x5401           tty_struct               ``include/linux/tty.h``
 MGSL_MAGIC            0x5401           mgsl_info                ``drivers/char/synclink.c``
 TTY_DRIVER_MAGIC      0x5402           tty_driver               ``include/linux/tty_driver.h``
 MGSLPC_MAGIC          0x5402           mgslpc_info              ``drivers/char/pcmcia/synclink_cs.c``
index f452faf..bcb2338 100644 (file)
@@ -90,7 +90,6 @@ SLIP_MAGIC            0x5302           slip                     ``drivers/net/sl
 STRIP_MAGIC           0x5303           strip                    ``drivers/net/strip.c``
 SIXPACK_MAGIC         0x5304           sixpack                  ``drivers/net/hamradio/6pack.h``
 AX25_MAGIC            0x5316           ax_disp                  ``drivers/net/mkiss.h``
-TTY_MAGIC             0x5401           tty_struct               ``include/linux/tty.h``
 MGSL_MAGIC            0x5401           mgsl_info                ``drivers/char/synclink.c``
 TTY_DRIVER_MAGIC      0x5402           tty_driver               ``include/linux/tty_driver.h``
 MGSLPC_MAGIC          0x5402           mgslpc_info              ``drivers/char/pcmcia/synclink_cs.c``
index 42f0635..6250087 100644 (file)
@@ -73,7 +73,6 @@ SLIP_MAGIC            0x5302           slip                     ``drivers/net/sl
 STRIP_MAGIC           0x5303           strip                    ``drivers/net/strip.c``
 SIXPACK_MAGIC         0x5304           sixpack                  ``drivers/net/hamradio/6pack.h``
 AX25_MAGIC            0x5316           ax_disp                  ``drivers/net/mkiss.h``
-TTY_MAGIC             0x5401           tty_struct               ``include/linux/tty.h``
 MGSL_MAGIC            0x5401           mgsl_info                ``drivers/char/synclink.c``
 TTY_DRIVER_MAGIC      0x5402           tty_driver               ``include/linux/tty_driver.h``
 MGSLPC_MAGIC          0x5402           mgslpc_info              ``drivers/char/pcmcia/synclink_cs.c``
index ae321a9..fd169d7 100644 (file)
@@ -76,7 +76,6 @@ SLIP_MAGIC            0x5302           slip                     ``drivers/net/sl
 STRIP_MAGIC           0x5303           strip                    ``drivers/net/strip.c``
 SIXPACK_MAGIC         0x5304           sixpack                  ``drivers/net/hamradio/6pack.h``
 AX25_MAGIC            0x5316           ax_disp                  ``drivers/net/mkiss.h``
-TTY_MAGIC             0x5401           tty_struct               ``include/linux/tty.h``
 MGSL_MAGIC            0x5401           mgsl_info                ``drivers/char/synclink.c``
 TTY_DRIVER_MAGIC      0x5402           tty_driver               ``include/linux/tty_driver.h``
 MGSLPC_MAGIC          0x5402           mgslpc_info              ``drivers/char/pcmcia/synclink_cs.c``
index 571c94c..1da7431 100644 (file)
@@ -170,7 +170,6 @@ static void free_tty_struct(struct tty_struct *tty)
        tty_ldisc_deinit(tty);
        put_device(tty->dev);
        kvfree(tty->write_buf);
-       tty->magic = 0xDEADDEAD;
        kfree(tty);
 }
 
@@ -265,11 +264,6 @@ static int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
                        imajor(inode), iminor(inode), routine);
                return 1;
        }
-       if (tty->magic != TTY_MAGIC) {
-               pr_warn("(%d:%d): %s: bad magic number\n",
-                       imajor(inode), iminor(inode), routine);
-               return 1;
-       }
 #endif
        return 0;
 }
@@ -1533,7 +1527,6 @@ static void release_one_tty(struct work_struct *work)
        if (tty->ops->cleanup)
                tty->ops->cleanup(tty);
 
-       tty->magic = 0;
        tty_driver_kref_put(driver);
        module_put(owner);
 
@@ -3093,7 +3086,6 @@ struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
                return NULL;
 
        kref_init(&tty->kref);
-       tty->magic = TTY_MAGIC;
        if (tty_ldisc_init(tty)) {
                kfree(tty);
                return NULL;
index 393518a..784e46a 100644 (file)
@@ -14,8 +14,6 @@
 
 void tty_lock(struct tty_struct *tty)
 {
-       if (WARN(tty->magic != TTY_MAGIC, "L Bad %p\n", tty))
-               return;
        tty_kref_get(tty);
        mutex_lock(&tty->legacy_mutex);
 }
@@ -25,8 +23,6 @@ int tty_lock_interruptible(struct tty_struct *tty)
 {
        int ret;
 
-       if (WARN(tty->magic != TTY_MAGIC, "L Bad %p\n", tty))
-               return -EIO;
        tty_kref_get(tty);
        ret = mutex_lock_interruptible(&tty->legacy_mutex);
        if (ret)
@@ -36,8 +32,6 @@ int tty_lock_interruptible(struct tty_struct *tty)
 
 void tty_unlock(struct tty_struct *tty)
 {
-       if (WARN(tty->magic != TTY_MAGIC, "U Bad %p\n", tty))
-               return;
        mutex_unlock(&tty->legacy_mutex);
        tty_kref_put(tty);
 }
index ae41893..730c330 100644 (file)
@@ -122,8 +122,6 @@ struct tty_operations;
 /**
  * struct tty_struct - state associated with a tty while open
  *
- * @magic: magic value set early in @alloc_tty_struct to %TTY_MAGIC, for
- *        debugging purposes
  * @kref: reference counting by tty_kref_get() and tty_kref_put(), reaching zero
  *       frees the structure
  * @dev: class device or %NULL (e.g. ptys, serdev)
@@ -193,7 +191,6 @@ struct tty_operations;
  * &struct tty_port.
  */
 struct tty_struct {
-       int     magic;
        struct kref kref;
        struct device *dev;
        struct tty_driver *driver;
@@ -260,9 +257,6 @@ struct tty_file_private {
        struct list_head list;
 };
 
-/* tty magic number */
-#define TTY_MAGIC              0x5401
-
 /**
  * DOC: TTY Struct Flags
  *