1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * TTY core internal functions 4 */ 5 6#ifndef _TTY_INTERNAL_H 7#define _TTY_INTERNAL_H 8 9#define tty_msg(fn, tty, f, ...) \ 10 fn("%s %s: " f, tty_driver_name(tty), tty_name(tty), ##__VA_ARGS__) 11 12#define tty_debug(tty, f, ...) tty_msg(pr_debug, tty, f, ##__VA_ARGS__) 13#define tty_notice(tty, f, ...) tty_msg(pr_notice, tty, f, ##__VA_ARGS__) 14#define tty_warn(tty, f, ...) tty_msg(pr_warn, tty, f, ##__VA_ARGS__) 15#define tty_err(tty, f, ...) tty_msg(pr_err, tty, f, ##__VA_ARGS__) 16 17#define tty_info_ratelimited(tty, f, ...) \ 18 tty_msg(pr_info_ratelimited, tty, f, ##__VA_ARGS__) 19 20/* 21 * Lock subclasses for tty locks 22 * 23 * TTY_LOCK_NORMAL is for normal ttys and master ptys. 24 * TTY_LOCK_SLAVE is for slave ptys only. 25 * 26 * Lock subclasses are necessary for handling nested locking with pty pairs. 27 * tty locks which use nested locking: 28 * 29 * legacy_mutex - Nested tty locks are necessary for releasing pty pairs. 30 * The stable lock order is master pty first, then slave pty. 31 * termios_rwsem - The stable lock order is tty_buffer lock->termios_rwsem. 32 * Subclassing this lock enables the slave pty to hold its 33 * termios_rwsem when claiming the master tty_buffer lock. 34 * tty_buffer lock - slave ptys can claim nested buffer lock when handling 35 * signal chars. The stable lock order is slave pty, then 36 * master. 37 */ 38enum { 39 TTY_LOCK_NORMAL = 0, 40 TTY_LOCK_SLAVE, 41}; 42 43/* Values for tty->flow_change */ 44#define TTY_THROTTLE_SAFE 1 45#define TTY_UNTHROTTLE_SAFE 2 46 47static inline void __tty_set_flow_change(struct tty_struct *tty, int val) 48{ 49 tty->flow_change = val; 50} 51 52static inline void tty_set_flow_change(struct tty_struct *tty, int val) 53{ 54 tty->flow_change = val; 55 smp_mb(); 56} 57 58int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout); 59void tty_ldisc_unlock(struct tty_struct *tty); 60 61int __tty_check_change(struct tty_struct *tty, int sig); 62int tty_check_change(struct tty_struct *tty); 63void __stop_tty(struct tty_struct *tty); 64void __start_tty(struct tty_struct *tty); 65void tty_write_unlock(struct tty_struct *tty); 66int tty_write_lock(struct tty_struct *tty, bool ndelay); 67void tty_vhangup_session(struct tty_struct *tty); 68void tty_open_proc_set_tty(struct file *filp, struct tty_struct *tty); 69int tty_signal_session_leader(struct tty_struct *tty, int exit_session); 70void session_clear_tty(struct pid *session); 71void tty_buffer_free_all(struct tty_port *port); 72void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld); 73void tty_buffer_init(struct tty_port *port); 74void tty_buffer_set_lock_subclass(struct tty_port *port); 75bool tty_buffer_restart_work(struct tty_port *port); 76bool tty_buffer_cancel_work(struct tty_port *port); 77void tty_buffer_flush_work(struct tty_port *port); 78speed_t tty_termios_input_baud_rate(const struct ktermios *termios); 79void tty_ldisc_hangup(struct tty_struct *tty, bool reset); 80int tty_ldisc_reinit(struct tty_struct *tty, int disc); 81long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 82long tty_jobctrl_ioctl(struct tty_struct *tty, struct tty_struct *real_tty, 83 struct file *file, unsigned int cmd, unsigned long arg); 84void tty_default_fops(struct file_operations *fops); 85struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx); 86int tty_alloc_file(struct file *file); 87void tty_add_file(struct tty_struct *tty, struct file *file); 88void tty_free_file(struct file *file); 89int tty_release(struct inode *inode, struct file *filp); 90 91#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock)) 92 93int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty); 94void tty_ldisc_release(struct tty_struct *tty); 95int __must_check tty_ldisc_init(struct tty_struct *tty); 96void tty_ldisc_deinit(struct tty_struct *tty); 97 98extern int tty_ldisc_autoload; 99 100/* tty_audit.c */ 101#ifdef CONFIG_AUDIT 102void tty_audit_add_data(const struct tty_struct *tty, const void *data, 103 size_t size); 104void tty_audit_tiocsti(const struct tty_struct *tty, u8 ch); 105#else 106static inline void tty_audit_add_data(const struct tty_struct *tty, 107 const void *data, size_t size) 108{ 109} 110static inline void tty_audit_tiocsti(const struct tty_struct *tty, u8 ch) 111{ 112} 113#endif 114 115ssize_t redirected_tty_write(struct kiocb *, struct iov_iter *); 116 117int tty_insert_flip_string_and_push_buffer(struct tty_port *port, 118 const u8 *chars, size_t cnt); 119 120#endif 121