source: mainline/uspace/srv/hid/console/console.c@ eb13ef8

/*
 * Copyright (c) 2011 Martin Decky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup console
 * @{
 */
/** @file
 */

#include <async.h>
#include <stdio.h>
#include <adt/prodcons.h>
#include <io/input.h>
#include <ipc/vfs.h>
#include <errno.h>
#include <str_error.h>
#include <loc.h>
#include <io/con_srv.h>
#include <io/kbd_event.h>
#include <io/keycode.h>
#include <io/chargrid.h>
#include <io/output.h>
#include <align.h>
#include <as.h>
#include <task.h>
#include <fibril_synch.h>
#include <stdatomic.h>
#include <stdlib.h>
#include <str.h>
#include "console.h"

#define NAME       "console"
#define NAMESPACE  "term"

#define UTF8_CHAR_BUFFER_SIZE  (STR_BOUNDS(1) + 1)

typedef struct {
        atomic_flag refcnt;      /**< Connection reference count */
        prodcons_t input_pc;  /**< Incoming keyboard events */

        /**
         * Not yet sent bytes of last char event.
         */
        char char_remains[UTF8_CHAR_BUFFER_SIZE];
        size_t char_remains_len;  /**< Number of not yet sent bytes. */

        fibril_mutex_t mtx;  /**< Lock protecting mutable fields */

        size_t index;           /**< Console index */
        service_id_t dsid;      /**< Service handle */

        sysarg_t cols;         /**< Number of columns */
        sysarg_t rows;         /**< Number of rows */
        console_caps_t ccaps;  /**< Console capabilities */

        chargrid_t *frontbuf;    /**< Front buffer */
        frontbuf_handle_t fbid;  /**< Front buffer handle */
        con_srvs_t srvs;         /**< Console service setup */
} console_t;

/** Input server proxy */
static input_t *input;
static bool active = false;

/** Session to the output server */
static async_sess_t *output_sess;

/** Output dimensions */
static sysarg_t cols;
static sysarg_t rows;

/** Array of data for virtual consoles */
static console_t consoles[CONSOLE_COUNT];

/** Mutex for console switching */
static FIBRIL_MUTEX_INITIALIZE(switch_mtx);

static console_t *active_console = &consoles[0];

static errno_t input_ev_active(input_t *);
static errno_t input_ev_deactive(input_t *);
static errno_t input_ev_key(input_t *, kbd_event_type_t, keycode_t, keymod_t, wchar_t);
static errno_t input_ev_move(input_t *, int, int);
static errno_t input_ev_abs_move(input_t *, unsigned, unsigned, unsigned, unsigned);
static errno_t input_ev_button(input_t *, int, int);

static input_ev_ops_t input_ev_ops = {
        .active = input_ev_active,
        .deactive = input_ev_deactive,
        .key = input_ev_key,
        .move = input_ev_move,
        .abs_move = input_ev_abs_move,
        .button = input_ev_button
};

static errno_t cons_open(con_srvs_t *, con_srv_t *);
static errno_t cons_close(con_srv_t *);
static errno_t cons_read(con_srv_t *, void *, size_t, size_t *);
static errno_t cons_write(con_srv_t *, void *, size_t, size_t *);
static void cons_sync(con_srv_t *);
static void cons_clear(con_srv_t *);
static void cons_set_pos(con_srv_t *, sysarg_t col, sysarg_t row);
static errno_t cons_get_pos(con_srv_t *, sysarg_t *, sysarg_t *);
static errno_t cons_get_size(con_srv_t *, sysarg_t *, sysarg_t *);
static errno_t cons_get_color_cap(con_srv_t *, console_caps_t *);
static void cons_set_style(con_srv_t *, console_style_t);
static void cons_set_color(con_srv_t *, console_color_t, console_color_t,
    console_color_attr_t);
static void cons_set_rgb_color(con_srv_t *, pixel_t, pixel_t);
static void cons_set_cursor_visibility(con_srv_t *, bool);
static errno_t cons_get_event(con_srv_t *, cons_event_t *);

static con_ops_t con_ops = {
        .open = cons_open,
        .close = cons_close,
        .read = cons_read,
        .write = cons_write,
        .sync = cons_sync,
        .clear = cons_clear,
        .set_pos = cons_set_pos,
        .get_pos = cons_get_pos,
        .get_size = cons_get_size,
        .get_color_cap = cons_get_color_cap,
        .set_style = cons_set_style,
        .set_color = cons_set_color,
        .set_rgb_color = cons_set_rgb_color,
        .set_cursor_visibility = cons_set_cursor_visibility,
        .get_event = cons_get_event
};

static console_t *srv_to_console(con_srv_t *srv)
{
        return srv->srvs->sarg;
}

static void cons_update(console_t *cons)
{
        fibril_mutex_lock(&switch_mtx);
        fibril_mutex_lock(&cons->mtx);

        if ((active) && (cons == active_console)) {
                output_update(output_sess, cons->fbid);
                output_cursor_update(output_sess, cons->fbid);
        }

        fibril_mutex_unlock(&cons->mtx);
        fibril_mutex_unlock(&switch_mtx);
}

static void cons_update_cursor(console_t *cons)
{
        fibril_mutex_lock(&switch_mtx);
        fibril_mutex_lock(&cons->mtx);

        if ((active) && (cons == active_console))
                output_cursor_update(output_sess, cons->fbid);

        fibril_mutex_unlock(&cons->mtx);
        fibril_mutex_unlock(&switch_mtx);
}

static void cons_damage(console_t *cons)
{
        fibril_mutex_lock(&switch_mtx);
        fibril_mutex_lock(&cons->mtx);

        if ((active) && (cons == active_console)) {
                output_damage(output_sess, cons->fbid, 0, 0, cons->cols,
                    cons->rows);
                output_cursor_update(output_sess, cons->fbid);
        }

        fibril_mutex_unlock(&cons->mtx);
        fibril_mutex_unlock(&switch_mtx);
}

static void cons_switch(unsigned int index)
{
        /*
         * The first undefined index is reserved
         * for switching to the kernel console.
         */
        if (index == CONSOLE_COUNT) {
                if (console_kcon())
                        active = false;

                return;
        }

        if (index > CONSOLE_COUNT)
                return;

        console_t *cons = &consoles[index];

        fibril_mutex_lock(&switch_mtx);

        if (cons == active_console) {
                fibril_mutex_unlock(&switch_mtx);
                return;
        }

        active_console = cons;

        fibril_mutex_unlock(&switch_mtx);

        cons_damage(cons);
}

static errno_t input_ev_active(input_t *input)
{
        active = true;
        output_claim(output_sess);
        cons_damage(active_console);

        return EOK;
}

static errno_t input_ev_deactive(input_t *input)
{
        active = false;
        output_yield(output_sess);

        return EOK;
}

static errno_t input_ev_key(input_t *input, kbd_event_type_t type, keycode_t key,
    keymod_t mods, wchar_t c)
{
        if ((key >= KC_F1) && (key <= KC_F1 + CONSOLE_COUNT) &&
            ((mods & KM_CTRL) == 0)) {
                cons_switch(key - KC_F1);
        } else {
                /* Got key press/release event */
                kbd_event_t *event =
                    (kbd_event_t *) malloc(sizeof(kbd_event_t));
                if (event == NULL) {
                        return ENOMEM;
                }

                link_initialize(&event->link);
                event->type = type;
                event->key = key;
                event->mods = mods;
                event->c = c;

                prodcons_produce(&active_console->input_pc,
                    &event->link);
        }

        return EOK;
}

static errno_t input_ev_move(input_t *input, int dx, int dy)
{
        return EOK;
}

static errno_t input_ev_abs_move(input_t *input, unsigned x, unsigned y,
    unsigned max_x, unsigned max_y)
{
        return EOK;
}

static errno_t input_ev_button(input_t *input, int bnum, int bpress)
{
        return EOK;
}

/** Process a character from the client (TTY emulation). */
static void cons_write_char(console_t *cons, wchar_t ch)
{
        sysarg_t updated = 0;

        fibril_mutex_lock(&cons->mtx);

        switch (ch) {
        case '\n':
                updated = chargrid_newline(cons->frontbuf);
                break;
        case '\r':
                break;
        case '\t':
                updated = chargrid_tabstop(cons->frontbuf, 8);
                break;
        case '\b':
                updated = chargrid_backspace(cons->frontbuf);
                break;
        default:
                updated = chargrid_putwchar(cons->frontbuf, ch, true);
        }

        fibril_mutex_unlock(&cons->mtx);

        if (updated > 1)
                cons_update(cons);
}

static void cons_set_cursor_vis(console_t *cons, bool visible)
{
        fibril_mutex_lock(&cons->mtx);
        chargrid_set_cursor_visibility(cons->frontbuf, visible);
        fibril_mutex_unlock(&cons->mtx);

        cons_update_cursor(cons);
}

static errno_t cons_open(con_srvs_t *srvs, con_srv_t *srv)
{
        return EOK;
}

static errno_t cons_close(con_srv_t *srv)
{
        return EOK;
}

static errno_t cons_read(con_srv_t *srv, void *buf, size_t size, size_t *nread)
{
        uint8_t *bbuf = buf;
        console_t *cons = srv_to_console(srv);
        size_t pos = 0;

        /*
         * Read input from keyboard and copy it to the buffer.
         * We need to handle situation when wchar is split by 2 following
         * reads.
         */
        while (pos < size) {
                /* Copy to the buffer remaining characters. */
                while ((pos < size) && (cons->char_remains_len > 0)) {
                        bbuf[pos] = cons->char_remains[0];
                        pos++;

                        /* Unshift the array. */
                        for (size_t i = 1; i < cons->char_remains_len; i++)
                                cons->char_remains[i - 1] = cons->char_remains[i];

                        cons->char_remains_len--;
                }

                /* Still not enough? Then get another key from the queue. */
                if (pos < size) {
                        link_t *link = prodcons_consume(&cons->input_pc);
                        kbd_event_t *event = list_get_instance(link, kbd_event_t, link);

                        /* Accept key presses of printable chars only. */
                        if ((event->type == KEY_PRESS) && (event->c != 0)) {
                                wchar_t tmp[2] = { event->c, 0 };
                                wstr_to_str(cons->char_remains, UTF8_CHAR_BUFFER_SIZE, tmp);
                                cons->char_remains_len = str_size(cons->char_remains);
                        }

                        free(event);
                }
        }

        *nread = size;
        return EOK;
}

static errno_t cons_write(con_srv_t *srv, void *data, size_t size, size_t *nwritten)
{
        console_t *cons = srv_to_console(srv);

        size_t off = 0;
        while (off < size)
                cons_write_char(cons, str_decode(data, &off, size));

        *nwritten = size;
        return EOK;
}

static void cons_sync(con_srv_t *srv)
{
        console_t *cons = srv_to_console(srv);

        cons_update(cons);
}

static void cons_clear(con_srv_t *srv)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        chargrid_clear(cons->frontbuf);
        fibril_mutex_unlock(&cons->mtx);

        cons_update(cons);
}

static void cons_set_pos(con_srv_t *srv, sysarg_t col, sysarg_t row)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        chargrid_set_cursor(cons->frontbuf, col, row);
        fibril_mutex_unlock(&cons->mtx);

        cons_update_cursor(cons);
}

static errno_t cons_get_pos(con_srv_t *srv, sysarg_t *col, sysarg_t *row)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        chargrid_get_cursor(cons->frontbuf, col, row);
        fibril_mutex_unlock(&cons->mtx);

        return EOK;
}

static errno_t cons_get_size(con_srv_t *srv, sysarg_t *cols, sysarg_t *rows)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        *cols = cons->cols;
        *rows = cons->rows;
        fibril_mutex_unlock(&cons->mtx);

        return EOK;
}

static errno_t cons_get_color_cap(con_srv_t *srv, console_caps_t *ccaps)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        *ccaps = cons->ccaps;
        fibril_mutex_unlock(&cons->mtx);

        return EOK;
}

static void cons_set_style(con_srv_t *srv, console_style_t style)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        chargrid_set_style(cons->frontbuf, style);
        fibril_mutex_unlock(&cons->mtx);
}

static void cons_set_color(con_srv_t *srv, console_color_t bgcolor,
    console_color_t fgcolor, console_color_attr_t attr)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        chargrid_set_color(cons->frontbuf, bgcolor, fgcolor, attr);
        fibril_mutex_unlock(&cons->mtx);
}

static void cons_set_rgb_color(con_srv_t *srv, pixel_t bgcolor,
    pixel_t fgcolor)
{
        console_t *cons = srv_to_console(srv);

        fibril_mutex_lock(&cons->mtx);
        chargrid_set_rgb_color(cons->frontbuf, bgcolor, fgcolor);
        fibril_mutex_unlock(&cons->mtx);
}

static void cons_set_cursor_visibility(con_srv_t *srv, bool visible)
{
        console_t *cons = srv_to_console(srv);

        cons_set_cursor_vis(cons, visible);
}

static errno_t cons_get_event(con_srv_t *srv, cons_event_t *event)
{
        console_t *cons = srv_to_console(srv);
        link_t *link = prodcons_consume(&cons->input_pc);
        kbd_event_t *kevent = list_get_instance(link, kbd_event_t, link);

        event->type = CEV_KEY;
        event->ev.key = *kevent;

        free(kevent);
        return EOK;
}

static void client_connection(ipc_call_t *icall, void *arg)
{
        console_t *cons = NULL;

        for (size_t i = 0; i < CONSOLE_COUNT; i++) {
                if (consoles[i].dsid == (service_id_t) IPC_GET_ARG2(icall)) {
                        cons = &consoles[i];
                        break;
                }
        }

        if (cons == NULL) {
                async_answer_0(icall, ENOENT);
                return;
        }

        if (!atomic_flag_test_and_set(&cons->refcnt))
                cons_set_cursor_vis(cons, true);

        con_conn(icall, &cons->srvs);
}

static errno_t input_connect(const char *svc)
{
        async_sess_t *sess;
        service_id_t dsid;

        errno_t rc = loc_service_get_id(svc, &dsid, 0);
        if (rc != EOK) {
                printf("%s: Input service %s not found\n", NAME, svc);
                return rc;
        }

        sess = loc_service_connect(dsid, INTERFACE_INPUT, 0);
        if (sess == NULL) {
                printf("%s: Unable to connect to input service %s\n", NAME,
                    svc);
                return EIO;
        }

        rc = input_open(sess, &input_ev_ops, NULL, &input);
        if (rc != EOK) {
                async_hangup(sess);
                printf("%s: Unable to communicate with service %s (%s)\n",
                    NAME, svc, str_error(rc));
                return rc;
        }

        return EOK;
}

static async_sess_t *output_connect(const char *svc)
{
        async_sess_t *sess;
        service_id_t dsid;

        errno_t rc = loc_service_get_id(svc, &dsid, 0);
        if (rc == EOK) {
                sess = loc_service_connect(dsid, INTERFACE_OUTPUT, 0);
                if (sess == NULL) {
                        printf("%s: Unable to connect to output service %s\n",
                            NAME, svc);
                        return NULL;
                }
        } else
                return NULL;

        return sess;
}

static bool console_srv_init(char *input_svc, char *output_svc)
{
        /* Connect to input service */
        errno_t rc = input_connect(input_svc);
        if (rc != EOK)
                return false;

        /* Connect to output service */
        output_sess = output_connect(output_svc);
        if (output_sess == NULL)
                return false;

        /* Register server */
        async_set_fallback_port_handler(client_connection, NULL);
        rc = loc_server_register(NAME);
        if (rc != EOK) {
                printf("%s: Unable to register server (%s)\n", NAME,
                    str_error(rc));
                return false;
        }

        output_get_dimensions(output_sess, &cols, &rows);
        output_set_style(output_sess, STYLE_NORMAL);

        console_caps_t ccaps;
        output_get_caps(output_sess, &ccaps);

        /*
         * Inititalize consoles only if there are
         * actually some output devices.
         */
        if (ccaps != 0) {
                for (size_t i = 0; i < CONSOLE_COUNT; i++) {
                        consoles[i].index = i;
                        atomic_flag_clear(&consoles[i].refcnt);
                        fibril_mutex_initialize(&consoles[i].mtx);
                        prodcons_initialize(&consoles[i].input_pc);
                        consoles[i].char_remains_len = 0;

                        consoles[i].cols = cols;
                        consoles[i].rows = rows;
                        consoles[i].ccaps = ccaps;
                        consoles[i].frontbuf =
                            chargrid_create(cols, rows, CHARGRID_FLAG_SHARED);

                        if (consoles[i].frontbuf == NULL) {
                                printf("%s: Unable to allocate frontbuffer %zu\n", NAME, i);
                                return false;
                        }

                        consoles[i].fbid = output_frontbuf_create(output_sess,
                            consoles[i].frontbuf);
                        if (consoles[i].fbid == 0) {
                                printf("%s: Unable to create frontbuffer %zu\n", NAME, i);
                                return false;
                        }

                        con_srvs_init(&consoles[i].srvs);
                        consoles[i].srvs.ops = &con_ops;
                        consoles[i].srvs.sarg = &consoles[i];

                        char vc[LOC_NAME_MAXLEN + 1];
                        snprintf(vc, LOC_NAME_MAXLEN, "%s/vc%zu", NAMESPACE, i);

                        if (loc_service_register(vc, &consoles[i].dsid) != EOK) {
                                printf("%s: Unable to register device %s\n", NAME, vc);
                                return false;
                        }
                }

                input_activate(input);
        }

        return true;
}

static void usage(char *name)
{
        printf("Usage: %s <input_dev> <output_dev>\n", name);
}

int main(int argc, char *argv[])
{
        if (argc < 3) {
                usage(argv[0]);
                return -1;
        }

        printf("%s: HelenOS Console service\n", NAME);

        if (!console_srv_init(argv[1], argv[2]))
                return -1;

        printf("%s: Accepting connections\n", NAME);
        task_retval(0);
        async_manager();

        /* Never reached */
        return 0;
}

/** @}
 */