The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/ttyhook.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
    3  *
    4  * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
    5  * All rights reserved.
    6  *
    7  * Redistribution and use in source and binary forms, with or without
    8  * modification, are permitted provided that the following conditions
    9  * are met:
   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.
   15  *
   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
   26  * SUCH DAMAGE.
   27  *
   28  * $FreeBSD: stable/12/sys/sys/ttyhook.h 326256 2017-11-27 15:01:59Z pfg $
   29  */
   30 
   31 #ifndef _SYS_TTYHOOK_H_
   32 #define _SYS_TTYHOOK_H_
   33 
   34 #ifndef _SYS_TTY_H_
   35 #error "can only be included through <sys/tty.h>"
   36 #endif /* !_SYS_TTY_H_ */
   37 
   38 struct tty;
   39 
   40 /*
   41  * Hooks interface, which allows to capture and inject traffic into the
   42  * input and output paths of a TTY.
   43  */
   44 
   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);
   49 
   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);
   53 
   54 typedef void th_close_t(struct tty *tp);
   55 
   56 struct ttyhook {
   57         /* Character input. */
   58         th_rint_t               *th_rint;
   59         th_rint_bypass_t        *th_rint_bypass;
   60         th_rint_done_t          *th_rint_done;
   61         th_rint_poll_t          *th_rint_poll;
   62 
   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;
   67 
   68         th_close_t              *th_close;
   69 };
   70 
   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)
   77 
   78 static __inline int
   79 ttyhook_rint(struct tty *tp, char c, int flags)
   80 {
   81         tty_lock_assert(tp, MA_OWNED);
   82         MPASS(!tty_gone(tp));
   83 
   84         return tp->t_hook->th_rint(tp, c, flags);
   85 }
   86 
   87 static __inline size_t
   88 ttyhook_rint_bypass(struct tty *tp, const void *buf, size_t len)
   89 {
   90         tty_lock_assert(tp, MA_OWNED);
   91         MPASS(!tty_gone(tp));
   92 
   93         return tp->t_hook->th_rint_bypass(tp, buf, len);
   94 }
   95 
   96 static __inline void
   97 ttyhook_rint_done(struct tty *tp)
   98 {
   99         tty_lock_assert(tp, MA_OWNED);
  100         MPASS(!tty_gone(tp));
  101 
  102         tp->t_hook->th_rint_done(tp);
  103 }
  104 
  105 static __inline size_t
  106 ttyhook_rint_poll(struct tty *tp)
  107 {
  108         tty_lock_assert(tp, MA_OWNED);
  109         MPASS(!tty_gone(tp));
  110 
  111         return tp->t_hook->th_rint_poll(tp);
  112 }
  113 
  114 static __inline size_t
  115 ttyhook_getc_inject(struct tty *tp, void *buf, size_t len)
  116 {
  117         tty_lock_assert(tp, MA_OWNED);
  118         MPASS(!tty_gone(tp));
  119 
  120         return tp->t_hook->th_getc_inject(tp, buf, len);
  121 }
  122 
  123 static __inline void
  124 ttyhook_getc_capture(struct tty *tp, const void *buf, size_t len)
  125 {
  126         tty_lock_assert(tp, MA_OWNED);
  127         MPASS(!tty_gone(tp));
  128 
  129         tp->t_hook->th_getc_capture(tp, buf, len);
  130 }
  131 
  132 static __inline size_t
  133 ttyhook_getc_poll(struct tty *tp)
  134 {
  135         tty_lock_assert(tp, MA_OWNED);
  136         MPASS(!tty_gone(tp));
  137 
  138         return tp->t_hook->th_getc_poll(tp);
  139 }
  140 
  141 static __inline void
  142 ttyhook_close(struct tty *tp)
  143 {
  144         tty_lock_assert(tp, MA_OWNED);
  145 
  146         tp->t_hook->th_close(tp);
  147 }
  148 
  149 #endif /* !_SYS_TTYHOOK_H_ */

Cache object: 4a97992452a3557fa3b110b1d8f64cc4


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.