src/uvt.h

   1 /*
   2  * UVT - Userspace Virtual Terminals
   3  *
   4  * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files
   8  * (the "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /*
  27  * Userspace Virtual Terminals
  28  * Virtual terminals were historically implemented in the kernel via a
  29  * character-device. This layer provides a user-space implementation via
  30  * CUSE/FUSE that can be used to provide the same API from user-space.
  31  */
  32
  33 #ifndef UVT_H
  34 #define UVT_H
  35
  36 #include <inttypes.h>
  37 #include <linux/kd.h>
  38 #include <linux/vt.h>
  39 #include <stdbool.h>
  40 #include <stdlib.h>
  41 #include <termio.h>
  42 #include <termios.h>
  43
  44 /* UVT types */
  45
  46 struct uvt_client;
  47 struct uvt_cdev;
  48 struct uvt_ctx;
  49
  50 /* TTYs */
  51
  52 enum uvt_tty_event_type {
  53         UVT_TTY_HUP             = 0x01,
  54         UVT_TTY_READ            = 0x02,
  55         UVT_TTY_WRITE           = 0x04,
  56 };
  57
  58 struct uvt_tty_event {
  59         unsigned int type;
  60 };
  61
  62 typedef void (*uvt_tty_cb) (void *tty, struct uvt_tty_event *ev, void *data);
  63
  64 struct uvt_tty_ops {
  65         void (*ref) (void *data);
  66         void (*unref) (void *data);
  67         int (*register_cb) (void *data, uvt_tty_cb cb, void *cb_data);
  68         void (*unregister_cb) (void *data, uvt_tty_cb cb, void *cb_data);
  69
  70         int (*read) (void *data, uint8_t *mem, size_t len);
  71         int (*write) (void *data, const uint8_t *mem, size_t len);
  72         unsigned int (*poll) (void *data);
  73 };
  74
  75 /* virtual terminals */
  76
  77 enum uvt_vt_event_type {
  78         UVT_VT_HUP              = 0x01,
  79         UVT_VT_TTY              = 0x02,
  80 };
  81
  82 struct uvt_vt_event {
  83         unsigned int type;
  84
  85         union {
  86                 struct uvt_tty_event tty;
  87         };
  88 };
  89
  90 typedef void (*uvt_vt_cb) (void *vt, struct uvt_vt_event *ev, void *data);
  91
  92 struct uvt_vt_ops {
  93         void (*ref) (void *data);
  94         void (*unref) (void *data);
  95         int (*register_cb) (void *data, uvt_vt_cb cb, void *cb_data);
  96         void (*unregister_cb) (void *data, uvt_vt_cb cb, void *cb_data);
  97
  98         int (*read) (void *data, uint8_t *mem, size_t len);
  99         int (*write) (void *data, const uint8_t *mem, size_t len);
 100         unsigned int (*poll) (void *data);
 101
 102         /* TTY ioctls */
 103         int (*ioctl_TCFLSH) (void *data, unsigned long arg);
 104
 105         /* VT ioctls */
 106         int (*ioctl_VT_ACTIVATE) (void *data, unsigned long arg);
 107         int (*ioctl_VT_WAITACTIVE) (void *data, unsigned long arg);
 108         int (*ioctl_VT_GETSTATE) (void *data, struct vt_stat *arg);
 109         int (*ioctl_VT_OPENQRY) (void *data, unsigned int *arg);
 110         int (*ioctl_VT_GETMODE) (void *data, struct vt_mode *arg);
 111         int (*ioctl_VT_SETMODE) (void *data, const struct vt_mode *arg,
 112                                  pid_t pid);
 113         int (*ioctl_VT_RELDISP) (void *data, unsigned long arg);
 114         int (*ioctl_KDGETMODE) (void *data, unsigned int *arg);
 115         int (*ioctl_KDSETMODE) (void *data, unsigned int arg);
 116         int (*ioctl_KDGKBMODE) (void *data, unsigned int *arg);
 117         int (*ioctl_KDSKBMODE) (void *data, unsigned int arg);
 118
 119 /*
 120    Complete list of all ioctls that the kernel supports. The internal handler
 121    returns -EOPNOTSUPP for all of them as they haven't been implemented, yet.
 122    We need to check if they are actually required or whether it's not worth the
 123    effort.
 124    Please implement them only if you know a client that requires them. Also
 125    consider implementing them as a no-op if the client doesn't depend on the
 126    call to actually do something. We want to keep the actual callbacks at a
 127    minimum.
 128
 129    TTY ioctls
 130
 131         int (*ioctl_TIOCPKT) (void *data, ...);
 132         int (*ioctl_TCXONC) (void *data, ...);
 133         int (*ioctl_TCGETS) (void *data, struct termios *arg);
 134         int (*ioctl_TCSETS) (void *data, const struct termios *arg);
 135         int (*ioctl_TCSETSF) (void *data, const struct termios *arg);
 136         int (*ioctl_TCSETSW) (void *data, const struct termios *arg);
 137         int (*ioctl_TCGETA) (void *data, ...);
 138         int (*ioctl_TCSETA) (void *data, ...);
 139         int (*ioctl_TCSETAF) (void *data, ...);
 140         int (*ioctl_TCSETAW) (void *data, ...);
 141         int (*ioctl_TIOCGLCKTRMIOS) (void *data, ...);
 142         int (*ioctl_TIOCSLCKTRMIOS) (void *data, ...);
 143         int (*ioctl_TCGETX) (void *data, ...);
 144         int (*ioctl_TCSETX) (void *data, ...);
 145         int (*ioctl_TCSETXW) (void *data, ...);
 146         int (*ioctl_TCSETXF) (void *data, ...);
 147         int (*ioctl_TIOCGSOFTCAR) (void *data, ...);
 148         int (*ioctl_TIOCSSOFTCAR) (void *data, ...);
 149
 150    VT ioctls
 151
 152         int (*ioctl_TIOCLINUX) (void *data, ...);
 153         int (*ioctl_KIOCSOUND) (void *data, ...);
 154         int (*ioctl_KDMKTONE) (void *data, ...);
 155         int (*ioctl_KDGKBTYPE) (void *data, char *arg);
 156         int (*ioctl_KDADDIO) (void *data, unsigned long arg);
 157         int (*ioctl_KDDELIO) (void *data, unsigned long arg);
 158         int (*ioctl_KDENABIO) (void *data);
 159         int (*ioctl_KDDISABIO) (void *data);
 160         int (*ioctl_KDKBDREP) (void *data, struct kbd_repeat *arg);
 161         int (*ioctl_KDMAPDISP) (void *data);
 162         int (*ioctl_KDUNMAPDISP) (void *data);
 163         int (*ioctl_KDGKBMETA) (void *data, long *arg);
 164         int (*ioctl_KDSKBMETA) (void *data, long arg);
 165         int (*ioctl_KDGETKEYCODE) (void *data, ...);
 166         int (*ioctl_KDSETKEYCODE) (void *data, ...);
 167         int (*ioctl_KDGKBENT) (void *data, ...);
 168         int (*ioctl_KDSKBENT) (void *data, ...);
 169         int (*ioctl_KDGKBSENT) (void *data, ...);
 170         int (*ioctl_KDSKBSENT) (void *data, ...);
 171         int (*ioctl_KDGKBDIACR) (void *data, ...);
 172         int (*ioctl_KDSKBDIACR) (void *data, ...);
 173         int (*ioctl_KDGKBDIACRUC) (void *data, ...);
 174         int (*ioctl_KDSKBDIACRUC) (void *data, ...);
 175         int (*ioctl_KDGETLED) (void *data, char *arg);
 176         int (*ioctl_KDSETLED) (void *data, long arg);
 177         int (*ioctl_KDGKBLED) (void *data, char *arg);
 178         int (*ioctl_KDSKBLED) (void *data, long arg);
 179         int (*ioctl_KDSIGACCEPT) (void *data, ...);
 180         int (*ioctl_VT_SETACTIVATE) (void *data, ...);
 181         int (*ioctl_VT_DISALLOCATE) (void *data, ...);
 182         int (*ioctl_VT_RESIZE) (void *data, ...);
 183         int (*ioctl_VT_RESIZEX) (void *data, ...);
 184         int (*ioctl_GIO_FONT) (void *data, ...);
 185         int (*ioctl_PIO_FONT) (void *data, ...);
 186         int (*ioctl_GIO_CMAP) (void *data, ...);
 187         int (*ioctl_PIO_CMAP) (void *data, ...);
 188         int (*ioctl_GIO_FONTX) (void *data, ...);
 189         int (*ioctl_PIO_FONTX) (void *data, ...);
 190         int (*ioctl_PIO_FONTRESET) (void *data, ...);
 191         int (*ioctl_KDFONTOP) (void *data, ...);
 192         int (*ioctl_GIO_SCRNMAP) (void *data, ...);
 193         int (*ioctl_PIO_SCRNMAP) (void *data, ...);
 194         int (*ioctl_GIO_UNISCRNMAP) (void *data, ...);
 195         int (*ioctl_PIO_UNISCRNMAP) (void *data, ...);
 196         int (*ioctl_PIO_UNIMAPCLR) (void *data, ...);
 197         int (*ioctl_GIO_UNIMAP) (void *data, ...);
 198         int (*ioctl_PIO_UNIMAP) (void *data, ...);
 199         int (*ioctl_VT_LOCKSWITCH) (void *data);
 200         int (*ioctl_VT_UNLOCKSWITCH) (void *data);
 201         int (*ioctl_VT_GETHIFONTMASK) (void *data, ...);
 202         int (*ioctl_VT_WAITEVENT) (void *data, ...);
 203 */
 204 };
 205
 206 /* client sessions */
 207
 208 void uvt_client_ref(struct uvt_client *client);
 209 void uvt_client_unref(struct uvt_client *client);
 210
 211 int uvt_client_set_vt(struct uvt_client *client, const struct uvt_vt_ops *vt,
 212                       void *vt_data);
 213 void uvt_client_kill(struct uvt_client *client);
 214 bool uvt_client_is_dead(struct uvt_client *client);
 215
 216 /* character devices */
 217
 218 enum uvt_cdev_event_type {
 219         UVT_CDEV_HUP,
 220         UVT_CDEV_OPEN,
 221 };
 222
 223 struct uvt_cdev_event {
 224         unsigned int type;
 225
 226         union {
 227                 struct uvt_client *client;
 228         };
 229 };
 230
 231 typedef void (*uvt_cdev_cb) (struct uvt_cdev *cdev,
 232                              struct uvt_cdev_event *ev,
 233                              void *data);
 234
 235 int uvt_cdev_new(struct uvt_cdev **out, struct uvt_ctx *ctx,
 236                  const char *name, unsigned int major, unsigned int minor);
 237 void uvt_cdev_ref(struct uvt_cdev *cdev);
 238 void uvt_cdev_unref(struct uvt_cdev *cdev);
 239
 240 int uvt_cdev_register_cb(struct uvt_cdev *cdev, uvt_cdev_cb cb, void *data);
 241 void uvt_cdev_unregister_cb(struct uvt_cdev *cdev, uvt_cdev_cb cb, void *data);
 242
 243 /* contexts */
 244
 245 typedef void (*uvt_log_t) (void *data,
 246                            const char *file,
 247                            int line,
 248                            const char *func,
 249                            const char *subs,
 250                            unsigned int sev,
 251                            const char *format,
 252                            va_list args);
 253
 254 int uvt_ctx_new(struct uvt_ctx **out, uvt_log_t log, void *log_data);
 255 void uvt_ctx_ref(struct uvt_ctx *ctx);
 256 void uvt_ctx_unref(struct uvt_ctx *ctx);
 257
 258 int uvt_ctx_get_fd(struct uvt_ctx *ctx);
 259 void uvt_ctx_dispatch(struct uvt_ctx *ctx);
 260
 261 unsigned int uvt_ctx_get_major(struct uvt_ctx *ctx);
 262 int uvt_ctx_new_minor(struct uvt_ctx *ctx, unsigned int *out);
 263 void uvt_ctx_free_minor(struct uvt_ctx *ctx, unsigned int minor);
 264
 265 /* pty tty implementation */
 266
 267 struct uvt_tty_null;
 268 extern const struct uvt_tty_ops uvt_tty_null_ops;
 269
 270 int uvt_tty_null_new(struct uvt_tty_null **out, struct uvt_ctx *ctx);
 271 void uvt_tty_null_ref(struct uvt_tty_null *tty);
 272 void uvt_tty_null_unref(struct uvt_tty_null *tty);
 273
 274 #endif /* UVT_H */