2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #ifndef _SYS_TTYHOOK_H_
32 #define _SYS_TTYHOOK_H_
35 #error "can only be included through <sys/tty.h>"
36 #endif /* !_SYS_TTY_H_ */
41 * Hooks interface, which allows to capture and inject traffic into the
42 * input and output paths of a TTY.
45 typedef int th_rint_t(struct tty *tp, char c, int flags);
46 typedef size_t th_rint_bypass_t(struct tty *tp, const void *buf, size_t len);
47 typedef void th_rint_done_t(struct tty *tp);
48 typedef size_t th_rint_poll_t(struct tty *tp);
50 typedef size_t th_getc_inject_t(struct tty *tp, void *buf, size_t len);
51 typedef void th_getc_capture_t(struct tty *tp, const void *buf, size_t len);
52 typedef size_t th_getc_poll_t(struct tty *tp);
54 typedef void th_close_t(struct tty *tp);
57 /* Character input. */
59 th_rint_bypass_t *th_rint_bypass;
60 th_rint_done_t *th_rint_done;
61 th_rint_poll_t *th_rint_poll;
63 /* Character output. */
64 th_getc_inject_t *th_getc_inject;
65 th_getc_capture_t *th_getc_capture;
66 th_getc_poll_t *th_getc_poll;
71 int ttyhook_register(struct tty **, struct proc *, int,
72 struct ttyhook *, void *);
73 void ttyhook_unregister(struct tty *);
74 #define ttyhook_softc(tp) ((tp)->t_hooksoftc)
75 #define ttyhook_hashook(tp,hook) ((tp)->t_hook != NULL && \
76 (tp)->t_hook->th_ ## hook != NULL)
79 ttyhook_rint(struct tty *tp, char c, int flags)
81 tty_assert_locked(tp);
84 return tp->t_hook->th_rint(tp, c, flags);
87 static __inline size_t
88 ttyhook_rint_bypass(struct tty *tp, const void *buf, size_t len)
90 tty_assert_locked(tp);
93 return tp->t_hook->th_rint_bypass(tp, buf, len);
97 ttyhook_rint_done(struct tty *tp)
99 tty_assert_locked(tp);
100 MPASS(!tty_gone(tp));
102 tp->t_hook->th_rint_done(tp);
105 static __inline size_t
106 ttyhook_rint_poll(struct tty *tp)
108 tty_assert_locked(tp);
109 MPASS(!tty_gone(tp));
111 return tp->t_hook->th_rint_poll(tp);
114 static __inline size_t
115 ttyhook_getc_inject(struct tty *tp, void *buf, size_t len)
117 tty_assert_locked(tp);
118 MPASS(!tty_gone(tp));
120 return tp->t_hook->th_getc_inject(tp, buf, len);
124 ttyhook_getc_capture(struct tty *tp, const void *buf, size_t len)
126 tty_assert_locked(tp);
127 MPASS(!tty_gone(tp));
129 tp->t_hook->th_getc_capture(tp, buf, len);
132 static __inline size_t
133 ttyhook_getc_poll(struct tty *tp)
135 tty_assert_locked(tp);
136 MPASS(!tty_gone(tp));
138 return tp->t_hook->th_getc_poll(tp);
142 ttyhook_close(struct tty *tp)
144 tty_assert_locked(tp);
146 tp->t_hook->th_close(tp);
149 #endif /* !_SYS_TTYHOOK_H_ */