sys/sys/ttyqueue.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Portions of this software were developed under sponsorship from Snow
   8  * B.V., the Netherlands.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef _SYS_TTYQUEUE_H_
  33 #define _SYS_TTYQUEUE_H_
  34
  35 #ifndef _SYS_TTY_H_
  36 #error "can only be included through <sys/tty.h>"
  37 #endif /* !_SYS_TTY_H_ */
  38
  39 struct tty;
  40 struct ttyinq_block;
  41 struct ttyoutq_block;
  42 struct uio;
  43
  44 /* Data input queue. */
  45 struct ttyinq {
  46         struct ttyinq_block     *ti_firstblock;
  47         struct ttyinq_block     *ti_startblock;
  48         struct ttyinq_block     *ti_reprintblock;
  49         struct ttyinq_block     *ti_lastblock;
  50         unsigned int            ti_begin;
  51         unsigned int            ti_linestart;
  52         unsigned int            ti_reprint;
  53         unsigned int            ti_end;
  54         unsigned int            ti_nblocks;
  55         unsigned int            ti_quota;
  56 };
  57 #define TTYINQ_DATASIZE 128
  58
  59 /* Data output queue. */
  60 struct ttyoutq {
  61         struct ttyoutq_block    *to_firstblock;
  62         struct ttyoutq_block    *to_lastblock;
  63         unsigned int            to_begin;
  64         unsigned int            to_end;
  65         unsigned int            to_nblocks;
  66         unsigned int            to_quota;
  67 };
  68 #define TTYOUTQ_DATASIZE (256 - sizeof(struct ttyoutq_block *))
  69
  70 #ifdef _KERNEL
  71 /* Input queue handling routines. */
  72 int     ttyinq_setsize(struct ttyinq *ti, struct tty *tp, size_t len);
  73 void    ttyinq_free(struct ttyinq *ti);
  74 int     ttyinq_read_uio(struct ttyinq *ti, struct tty *tp, struct uio *uio,
  75     size_t readlen, size_t flushlen);
  76 size_t  ttyinq_write(struct ttyinq *ti, const void *buf, size_t len,
  77     int quote);
  78 int     ttyinq_write_nofrag(struct ttyinq *ti, const void *buf, size_t len,
  79     int quote);
  80 void    ttyinq_canonicalize(struct ttyinq *ti);
  81 void    ttyinq_canonicalize_break(struct ttyinq *ti, const char *breakc);
  82 size_t  ttyinq_findchar(struct ttyinq *ti, const char *breakc, size_t maxlen,
  83     char *lastc);
  84 void    ttyinq_flush(struct ttyinq *ti);
  85 int     ttyinq_peekchar(struct ttyinq *ti, char *c, int *quote);
  86 void    ttyinq_unputchar(struct ttyinq *ti);
  87 void    ttyinq_reprintpos_set(struct ttyinq *ti);
  88 void    ttyinq_reprintpos_reset(struct ttyinq *ti);
  89
  90 static __inline size_t
  91 ttyinq_getsize(struct ttyinq *ti)
  92 {
  93         return (ti->ti_nblocks * TTYINQ_DATASIZE);
  94 }
  95
  96 static __inline size_t
  97 ttyinq_getallocatedsize(struct ttyinq *ti)
  98 {
  99
 100         return (ti->ti_quota * TTYINQ_DATASIZE);
 101 }
 102
 103 static __inline size_t
 104 ttyinq_bytesleft(struct ttyinq *ti)
 105 {
 106         size_t len;
 107
 108         /* Make sure the usage never exceeds the length. */
 109         len = ti->ti_nblocks * TTYINQ_DATASIZE;
 110         MPASS(len >= ti->ti_end);
 111
 112         return (len - ti->ti_end);
 113 }
 114
 115 static __inline size_t
 116 ttyinq_bytescanonicalized(struct ttyinq *ti)
 117 {
 118         MPASS(ti->ti_begin <= ti->ti_linestart);
 119
 120         return (ti->ti_linestart - ti->ti_begin);
 121 }
 122
 123 static __inline size_t
 124 ttyinq_bytesline(struct ttyinq *ti)
 125 {
 126         MPASS(ti->ti_linestart <= ti->ti_end);
 127
 128         return (ti->ti_end - ti->ti_linestart);
 129 }
 130
 131 /* Input buffer iteration. */
 132 typedef void ttyinq_line_iterator_t(void *data, char c, int flags);
 133 void    ttyinq_line_iterate_from_linestart(struct ttyinq *ti,
 134     ttyinq_line_iterator_t *iterator, void *data);
 135 void    ttyinq_line_iterate_from_reprintpos(struct ttyinq *ti,
 136     ttyinq_line_iterator_t *iterator, void *data);
 137
 138 /* Output queue handling routines. */
 139 void    ttyoutq_flush(struct ttyoutq *to);
 140 int     ttyoutq_setsize(struct ttyoutq *to, struct tty *tp, size_t len);
 141 void    ttyoutq_free(struct ttyoutq *to);
 142 size_t  ttyoutq_read(struct ttyoutq *to, void *buf, size_t len);
 143 int     ttyoutq_read_uio(struct ttyoutq *to, struct tty *tp, struct uio *uio);
 144 size_t  ttyoutq_write(struct ttyoutq *to, const void *buf, size_t len);
 145 int     ttyoutq_write_nofrag(struct ttyoutq *to, const void *buf, size_t len);
 146
 147 static __inline size_t
 148 ttyoutq_getsize(struct ttyoutq *to)
 149 {
 150         return (to->to_nblocks * TTYOUTQ_DATASIZE);
 151 }
 152
 153 static __inline size_t
 154 ttyoutq_getallocatedsize(struct ttyoutq *to)
 155 {
 156
 157         return (to->to_quota * TTYOUTQ_DATASIZE);
 158 }
 159
 160 static __inline size_t
 161 ttyoutq_bytesleft(struct ttyoutq *to)
 162 {
 163         size_t len;
 164
 165         /* Make sure the usage never exceeds the length. */
 166         len = to->to_nblocks * TTYOUTQ_DATASIZE;
 167         MPASS(len >= to->to_end);
 168
 169         return (len - to->to_end);
 170 }
 171
 172 static __inline size_t
 173 ttyoutq_bytesused(struct ttyoutq *to)
 174 {
 175         return (to->to_end - to->to_begin);
 176 }
 177 #endif /* _KERNEL */
 178
 179 #endif /* !_SYS_TTYQUEUE_H_ */