graphene/Pal/src/host/Linux-SGX/db_sockets.c

/* -*- mode:c; c-file-style:"k&r"; c-basic-offset: 4; tab-width:4; indent-tabs-mode:nil; mode:auto-fill; fill-column:78; -*- */
/* vim: set ts=4 sw=4 et tw=78 fo=cqt wm=0: */

/* Copyright (C) 2014 OSCAR lab, Stony Brook University
   This file is part of Graphene Library OS.

   Graphene Library OS is free software: you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.

   Graphene Library OS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

/*
 * db_socket.c
 *
 * This file contains operands for streams with URIs that start with
 * "tcp:", "tcp.srv:", "udp:", "udp.srv:".
 */

#include "pal_defs.h"
#include "pal_linux_defs.h"
#include "pal.h"
#include "pal_internal.h"
#include "pal_linux.h"
#include "pal_debug.h"
#include "pal_security.h"
#include "pal_error.h"
#include "api.h"

#include <linux/types.h>
#include <linux/poll.h>
#include <linux/in.h>
#include <linux/in6.h>
typedef __kernel_pid_t pid_t;
#include <asm/fcntl.h>
#include <asm-generic/socket.h>

/* 96 bytes is the minimal size of buffer to store a IPv4/IPv6
   address */
#define PAL_SOCKADDR_SIZE   96

static inline int addr_size (struct sockaddr * addr)
{
    switch (addr->sa_family) {
        case AF_INET:
            return sizeof(struct sockaddr_in);
        case AF_INET6:
            return sizeof(struct sockaddr_in6);
        default:
            return 0;
    }
}

/* parsing the string of uri, and fill in the socket address structure.
   the latest pointer of uri, length of socket address are returned. */
static int inet_parse_uri (char ** uri, struct sockaddr * addr, unsigned int * addrlen)
{
    char * tmp = *uri, * end;
    char * addr_str = NULL, * port_str;
    int af;
    void * addr_buf;
    int addr_len;
    __be16 * port_buf;
    int slen;

    if (tmp[0] == '[') {
        /* for IPv6, the address will be in the form of
           "[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:port". */
        struct sockaddr_in6 * addr_in6 = (struct sockaddr_in6 *) addr;

        slen = sizeof(struct sockaddr_in6);
        memset(addr, 0, slen);

        end = strchr(tmp + 1, ']');
        if (!end || *(end + 1) != ':')
            goto inval;

        addr_str = tmp + 1;
        addr_len = end - tmp - 1;
        port_str = end + 2;
        for (end = port_str ; *end >= '0' && *end <= '9' ; end++);
        addr_in6->sin6_family = af = AF_INET6;
        addr_buf = &addr_in6->sin6_addr.s6_addr;
        port_buf = &addr_in6->sin6_port;
    } else {
        /* for IP, the address will be in the form of "x.x.x.x:port". */
        struct sockaddr_in * addr_in = (struct sockaddr_in *) addr;

        slen = sizeof(struct sockaddr_in);
        memset(addr, 0, slen);

        end = strchr(tmp, ':');
        if (!end)
            goto inval;

        addr_str = tmp;
        addr_len = end - tmp;
        port_str = end + 1;
        for (end = port_str ; *end >= '0' && *end <= '9' ; end++);
        addr_in->sin_family = af = AF_INET;
        addr_buf = &addr_in->sin_addr.s_addr;
        port_buf = &addr_in->sin_port;
    }

    if (af == AF_INET) {
        if (!inet_pton4(addr_str, addr_len, addr_buf))
            goto inval;
    } else {
        if (!inet_pton6(addr_str, addr_len, addr_buf))
            goto inval;
    }

    *port_buf = __htons(atoi(port_str));
    *uri = *end ? end + 1 : NULL;

    if (addrlen)
        *addrlen = slen;

    return 0;

inval:
    return -PAL_ERROR_INVAL;
}

/* create the string of uri from the given socket address */
static int inet_create_uri (char * uri, int count, struct sockaddr * addr,
                            int addrlen)
{
    int len = 0;

    if (addr->sa_family == AF_INET) {
        if (addrlen != sizeof(struct sockaddr_in))
            return PAL_ERROR_INVAL;

        struct sockaddr_in * addr_in = (struct sockaddr_in *) addr;
        char * addr = (char *) &addr_in->sin_addr.s_addr;

        /* for IP, the address will be in the form of "x.x.x.x:port". */
        len = snprintf(uri, count, "%u.%u.%u.%u:%u",
                       (unsigned char) addr[0],
                       (unsigned char) addr[1],
                       (unsigned char) addr[2],
                       (unsigned char) addr[3],
                       __ntohs(addr_in->sin_port));
    } else if (addr->sa_family == AF_INET6) {
        if (addrlen != sizeof(struct sockaddr_in6))
            return PAL_ERROR_INVAL;

        struct sockaddr_in6 * addr_in6 = (struct sockaddr_in6 *) addr;
        unsigned short * addr = (unsigned short *) &addr_in6->sin6_addr.s6_addr;

        /* for IPv6, the address will be in the form of
           "[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:port". */
        len = snprintf(uri, count, "[%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x]:%u",
                       addr[0], addr[1], addr[2], addr[3],
                       addr[4], addr[5], addr[6], addr[7],
                       __ntohs(addr_in6->sin6_port));
    } else {
        return -PAL_ERROR_INVAL;
    }

    if (len >= count)
        return -PAL_ERROR_TOOLONG;

    return len;
}

/* parse the uri for a socket stream. The uri might have both binding
   address and connecting address, or connecting address only. The form
   of uri will be either "bind-addr:bind-port:connect-addr:connect-port"
   or "addr:port". */
static int socket_parse_uri (char * uri,
                struct sockaddr ** bind_addr, unsigned int * bind_addrlen,
                struct sockaddr ** dest_addr, unsigned int * dest_addrlen)
{
    int ret;

    if (!bind_addr && !dest_addr)
        return 0;

    if (!uri || !(*uri)) {
        if (bind_addr)
            *bind_addr = NULL;
        if (dest_addr)
            *dest_addr = NULL;
        return 0;
    }

    /* at least parse uri once */
    if ((ret = inet_parse_uri(&uri, bind_addr ? *bind_addr : *dest_addr,
                              bind_addr ? bind_addrlen : dest_addrlen)) < 0)
        return ret;

    if (!(bind_addr && dest_addr))
        return 0;

    /* if you reach here, it can only be connection address */
    if (!uri || (ret = inet_parse_uri(&uri, *dest_addr, dest_addrlen)) < 0) {
        *dest_addr = *bind_addr;
        *dest_addrlen = *bind_addrlen;
        *bind_addr = NULL;
        *bind_addrlen = 0;
    }

    return 0;
}

/* fill in the PAL handle based on the file descriptors and address given. */
static inline
PAL_HANDLE socket_create_handle (int type, int fd, int options,
                                 struct sockaddr * bind_addr,
                                 unsigned int bind_addrlen,
                                 struct sockaddr * dest_addr,
                                 unsigned int dest_addrlen,
                                 struct sockopt * sock_options)
{
    PAL_HANDLE hdl = malloc(HANDLE_SIZE(sock) + (bind_addr ? bind_addrlen : 0) +
                            (dest_addr ? dest_addrlen : 0));

    if (!hdl)
        return NULL;

    memset(hdl, 0, sizeof(union pal_handle));
    HANDLE_TYPE(hdl) = type;
    HANDLE_HDR(hdl)->flags |= RFD(0)|(type != pal_type_tcpsrv ? WFD(0) : 0);
    hdl->sock.fd = fd;
    void * addr = (void *) hdl + HANDLE_SIZE(sock);
    if (bind_addr) {
        hdl->sock.bind = (PAL_PTR) addr;
        memcpy(addr, bind_addr, bind_addrlen);
        addr += bind_addrlen;
    } else {
        hdl->sock.bind = (PAL_PTR) NULL;
    }
    if (dest_addr) {
        hdl->sock.conn = (PAL_PTR) addr;
        memcpy(addr, dest_addr, dest_addrlen);
        addr += dest_addrlen;
    } else {
        hdl->sock.conn = (PAL_PTR) NULL;
    }

    hdl->sock.nonblocking = (options & PAL_OPTION_NONBLOCK) ?
                            PAL_TRUE : PAL_FALSE;

    hdl->sock.linger         = sock_options->linger;
    hdl->sock.receivebuf     = sock_options->receivebuf;
    hdl->sock.sendbuf        = sock_options->sendbuf;
    hdl->sock.receivetimeout = sock_options->receivetimeout;
    hdl->sock.sendtimeout    = sock_options->sendtimeout;
    hdl->sock.tcp_cork       = sock_options->tcp_cork;
    hdl->sock.tcp_keepalive  = sock_options->tcp_keepalive;
    hdl->sock.tcp_nodelay    = sock_options->tcp_nodelay;
    return hdl;
}

static int check_zero (void * mem, int size)
{
    void * p = mem, * q = mem + size;
    while (p < q) {
        if (p <= q - sizeof(long)) {
            if (*(long *) p)
                return 1;
            p += sizeof(long);
        } else if (p <= q - sizeof(int)) {
            if (*(int *) p)
                return 1;
            p += sizeof(int);
        } else if (p <= q - sizeof(short)) {
            if (*(short *) p)
                return 1;
            p += sizeof(short);
        } else {
            if (*(char *) p)
                return 1;
            p++;
        }
    }
    return 0;
}

/* check if an address is "Any" */
static int addr_check_any (struct sockaddr * addr)
{
    if (addr->sa_family == AF_INET) {
        struct sockaddr_in * addr_in =
                        (struct sockaddr_in *) addr;

        return addr_in->sin_port ||
               check_zero(&addr_in->sin_addr,
                          sizeof(addr_in->sin_addr));
    } else if (addr->sa_family == AF_INET6) {
        struct sockaddr_in6 * addr_in6 =
                        (struct sockaddr_in6 *) addr;

        return addr_in6->sin6_port ||
               check_zero(&addr_in6->sin6_addr,
                          sizeof(addr_in6->sin6_addr));
    }

    return -PAL_ERROR_NOTSUPPORT;
}

static inline int sock_type (int type, int options)
{
    if (options & PAL_OPTION_NONBLOCK)
        type |= SOCK_NONBLOCK;
    return type;
}

/* listen on a tcp socket */
static int tcp_listen (PAL_HANDLE * handle, char * uri, int options)
{
    struct sockaddr buffer, * bind_addr = &buffer;
    unsigned int bind_addrlen;
    int ret;

    if ((ret = socket_parse_uri(uri, &bind_addr, &bind_addrlen,
                                NULL, NULL)) < 0)
        return ret;

    /* the socket need to have a binding address, a null address or an
       any address is not allowed */
    if (!bind_addr || addr_check_any(bind_addr) == 0)
        return -PAL_ERROR_INVAL;

    struct sockopt sock_options;
    ret = ocall_sock_listen(bind_addr->sa_family,
                            sock_type(SOCK_STREAM, options), 0,
                            bind_addr, bind_addrlen,
                            &sock_options);
    if (ret < 0)
        return ret;

    *handle = socket_create_handle(pal_type_tcpsrv, ret, options,
                                   bind_addr, bind_addrlen, NULL, 0,
                                   &sock_options);
    if (!(*handle)) {
        ocall_close(ret);
        return -PAL_ERROR_NOMEM;
    }

    return 0;
}

/* accept a tcp connection */
static int tcp_accept (PAL_HANDLE handle, PAL_HANDLE * client)
{
    if (!IS_HANDLE_TYPE(handle, tcpsrv) ||
        !handle->sock.bind || handle->sock.conn)
        return -PAL_ERROR_NOTSERVER;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    struct sockaddr * bind_addr = (struct sockaddr *) handle->sock.bind;
    unsigned int bind_addrlen = addr_size(bind_addr);
    struct sockaddr dest_addr;
    unsigned int dest_addrlen = sizeof(struct sockaddr);
    int ret = 0;

    struct sockopt sock_options;
    ret = ocall_sock_accept(handle->sock.fd, &dest_addr, &dest_addrlen,
                            &sock_options);
    if (ret < 0)
        return ret;

    *client = socket_create_handle(pal_type_tcp, ret, 0, bind_addr,
                                   bind_addrlen,
                                   &dest_addr, dest_addrlen,
                                   &sock_options);

    if (!(*client)) {
        ocall_close(ret);
        return -PAL_ERROR_NOMEM;
    }

    return 0;
}

/* connect on a tcp socket */
static int tcp_connect (PAL_HANDLE * handle, char * uri, int options)
{
    struct sockaddr buffer[2];
    struct sockaddr * bind_addr = buffer, * dest_addr = buffer + 1;
    unsigned int bind_addrlen, dest_addrlen;
    int ret;

    /* accepting two kind of different uri:
       dest-ip:dest-port or bind-ip:bind-port:dest-ip:dest-port */
    if ((ret = socket_parse_uri(uri, &bind_addr, &bind_addrlen,
                                &dest_addr, &dest_addrlen)) < 0)
        return ret;

    if (!dest_addr)
        return -PAL_ERROR_INVAL;

    if (bind_addr && bind_addr->sa_family != dest_addr->sa_family)
        return -PAL_ERROR_INVAL;

    struct sockopt sock_options;
    ret = ocall_sock_connect(dest_addr->sa_family,
                             sock_type(SOCK_STREAM, options), 0,
                             dest_addr, dest_addrlen,
                             bind_addr, &bind_addrlen, &sock_options);
    if (ret < 0)
        return ret;

    *handle = socket_create_handle(pal_type_tcp, ret, options,
                                   bind_addr, bind_addrlen,
                                   dest_addr, dest_addrlen,
                                   &sock_options);

    if (!(*handle)) {
        ocall_close(ret);
        return -PAL_ERROR_NOMEM;
    }

    return 0;
}

/* 'open' operation of tcp stream */
static int tcp_open (PAL_HANDLE *handle, const char * type, const char * uri,
                     int access, int share, int create, int options)
{
    int uri_len = strlen(uri) + 1;

    if (uri_len > PAL_SOCKADDR_SIZE)
        return -PAL_ERROR_TOOLONG;

    char uri_buf[PAL_SOCKADDR_SIZE];
    memcpy(uri_buf, uri, uri_len);

    if (strpartcmp_static(type, "tcp.srv:"))
        return tcp_listen(handle, uri_buf, options);

    if (strpartcmp_static(type, "tcp:"))
        return tcp_connect(handle, uri_buf, options);

    return -PAL_ERROR_NOTSUPPORT;
}

/* 'read' operation of tcp stream */
static int tcp_read (PAL_HANDLE handle, int offset, int len, void * buf)
{
    if (!IS_HANDLE_TYPE(handle, tcp) || !handle->sock.conn)
        return -PAL_ERROR_NOTCONNECTION;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_ENDOFSTREAM;

    int bytes = ocall_sock_recv(handle->sock.fd, buf, len, NULL, NULL);

    if (bytes < 0)
        return bytes;

    if (!bytes)
        return -PAL_ERROR_ENDOFSTREAM;

    return bytes;
}

/* write' operation of tcp stream */
static int tcp_write (PAL_HANDLE handle, int offset, int len, const void * buf)
{
    if (!IS_HANDLE_TYPE(handle, tcp) || !handle->sock.conn)
        return -PAL_ERROR_NOTCONNECTION;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_CONNFAILED;

    int bytes = ocall_sock_send(handle->sock.fd, buf, len, NULL, 0);

    if (bytes == -PAL_ERROR_TRYAGAIN)
            HANDLE_HDR(handle)->flags &= ~WRITEABLE(0);

    if (bytes < 0)
        return bytes;

    if (bytes == len)
        HANDLE_HDR(handle)->flags |= WRITEABLE(0);
    else
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(0);

    return bytes;
}

/* used by 'open' operation of tcp stream for bound socket */
static int udp_bind (PAL_HANDLE * handle, char * uri, int options)
{
    struct sockaddr buffer, * bind_addr = &buffer;
    unsigned int bind_addrlen;
    int ret = 0;

    if ((ret = socket_parse_uri(uri, &bind_addr, &bind_addrlen,
                                NULL, NULL)) < 0)
        return ret;

    assert(bind_addr);
    assert(bind_addrlen == addr_size(bind_addr));

    struct sockopt sock_options;
    ret = ocall_sock_listen(bind_addr->sa_family,
                            sock_type(SOCK_DGRAM, options), 0,
                            bind_addr, bind_addrlen, &sock_options);
    if (ret < 0)
        return ret;

    *handle = socket_create_handle(pal_type_udpsrv, ret, options,
                                   bind_addr, bind_addrlen, NULL, 0,
                                   &sock_options);

    if (!(*handle)) {
        ocall_close(ret);
        return -PAL_ERROR_NOMEM;
    }

    return 0;
}

/* used by 'open' operation of tcp stream for connected socket */
static int udp_connect (PAL_HANDLE * handle, char * uri, int options)
{
    struct sockaddr buffer[2];
    struct sockaddr * bind_addr = buffer, * dest_addr = buffer + 1;
    unsigned int bind_addrlen, dest_addrlen;
    int ret;

    if ((ret = socket_parse_uri(uri, &bind_addr, &bind_addrlen,
                                &dest_addr, &dest_addrlen)) < 0)
        return ret;

    struct sockopt sock_options;
    ret = ocall_sock_connect(dest_addr ? dest_addr->sa_family : AF_INET,
                             sock_type(SOCK_DGRAM, options), 0,
                             dest_addr, dest_addrlen,
                             bind_addr, &bind_addrlen, &sock_options);

    if (ret < 0)
        return ret;

    *handle = socket_create_handle(dest_addr ? pal_type_udp :
                                   pal_type_udpsrv, ret, options,
                                   bind_addr, bind_addrlen,
                                   dest_addr, dest_addrlen,
                                   &sock_options);

    if (!(*handle)) {
        ocall_close(ret);
        return -PAL_ERROR_NOMEM;
    }

    return 0;
}

static int udp_open (PAL_HANDLE *hdl, const char * type, const char * uri,
                     int access, int share, int create, int options)
{
    char buf[PAL_SOCKADDR_SIZE];
    int len = strlen(uri);

    if (len >= PAL_SOCKADDR_SIZE)
        return -PAL_ERROR_TOOLONG;

    memcpy(buf, uri, len + 1);
    options &= PAL_OPTION_MASK;

    if (strpartcmp_static(type, "udp.srv:"))
        return udp_bind(hdl, buf, options);

    if (strpartcmp_static(type, "udp:"))
        return udp_connect(hdl, buf, options);

    return -PAL_ERROR_NOTSUPPORT;
}

static int udp_receive (PAL_HANDLE handle, int offset, int len, void * buf)
{
    if (!IS_HANDLE_TYPE(handle, udp))
        return -PAL_ERROR_NOTCONNECTION;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    return ocall_sock_recv(handle->sock.fd, buf, len, NULL, NULL);
}

static int udp_receivebyaddr (PAL_HANDLE handle, int offset, int len,
                              void * buf, char * addr, int addrlen)
{
    if (!IS_HANDLE_TYPE(handle, udpsrv))
        return -PAL_ERROR_NOTCONNECTION;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    struct sockaddr conn_addr;
    socklen_t conn_addrlen = sizeof(struct sockaddr);

    int bytes = ocall_sock_recv(handle->sock.fd, buf, len, &conn_addr,
                                &conn_addrlen);

    if (bytes < 0)
        return bytes;

    char * addr_uri = strcpy_static(addr, "udp:", addrlen);
    if (!addr_uri)
        return -PAL_ERROR_OVERFLOW;

    int ret = inet_create_uri(addr_uri, addr + addrlen - addr_uri, &conn_addr,
                              conn_addrlen);
    if (ret < 0)
        return ret;

    return bytes;
}

static int udp_send (PAL_HANDLE handle, int offset, int len, const void * buf)
{
    if (!IS_HANDLE_TYPE(handle, udp))
        return -PAL_ERROR_NOTCONNECTION;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    int bytes = ocall_sock_send(handle->sock.fd, buf, len, NULL, 0);

    if (bytes == -PAL_ERROR_TRYAGAIN)
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(0);

    if (bytes < 0)
        return bytes;

    if (bytes == len)
        HANDLE_HDR(handle)->flags |= WRITEABLE(0);
    else
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(0);

    return bytes;
}

static int udp_sendbyaddr (PAL_HANDLE handle, int offset, int len,
                           const void * buf, const char * addr, int addrlen)
{
    if (!IS_HANDLE_TYPE(handle, udpsrv))
        return -PAL_ERROR_NOTCONNECTION;

    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    if (!strpartcmp_static(addr, "udp:"))
        return -PAL_ERROR_INVAL;

    addr    += static_strlen("udp:");
    addrlen -= static_strlen("udp:");

    char * addrbuf = __alloca(addrlen);
    memcpy(addrbuf, addr, addrlen);

    struct sockaddr conn_addr;
    unsigned int conn_addrlen = sizeof(struct sockaddr);

    int ret = inet_parse_uri(&addrbuf, &conn_addr, &conn_addrlen);
    if (ret < 0)
        return ret;

    int bytes = ocall_sock_send(handle->sock.fd, buf, len, &conn_addr,
                                conn_addrlen);

    if (bytes == -PAL_ERROR_TRYAGAIN)
            HANDLE_HDR(handle)->flags &= ~WRITEABLE(0);

    if (bytes < 0)
        return bytes;

    if (bytes == len)
        HANDLE_HDR(handle)->flags |= WRITEABLE(0);
    else
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(0);

    return bytes;
}

static int socket_delete (PAL_HANDLE handle, int access)
{
    if (handle->sock.fd == PAL_IDX_POISON)
        return 0;

    if (!IS_HANDLE_TYPE(handle, tcp) && access)
        return -PAL_ERROR_INVAL;

    if (IS_HANDLE_TYPE(handle, tcp) || IS_HANDLE_TYPE(handle, tcpsrv)) {
        int shutdown;
        switch (access) {
            case 0:
                shutdown = SHUT_RDWR;
                break;
            case PAL_DELETE_RD:
                shutdown = SHUT_RD;
                break;
            case PAL_DELETE_WR:
                shutdown = SHUT_WR;
                break;
            default:
                return -PAL_ERROR_INVAL;
        }

        ocall_sock_shutdown(handle->sock.fd, shutdown);
    }

    return 0;
}

static int socket_close (PAL_HANDLE handle)
{
    if (handle->sock.fd != PAL_IDX_POISON) {
        ocall_close(handle->sock.fd);
        handle->sock.fd = PAL_IDX_POISON;
    }

    if (handle->sock.bind)
        handle->sock.bind = (PAL_PTR) NULL;

    if (handle->sock.conn)
        handle->sock.conn = (PAL_PTR) NULL;

    return 0;
}

static int socket_attrquerybyhdl (PAL_HANDLE handle, PAL_STREAM_ATTR  * attr)
{
    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    attr->handle_type           = HANDLE_HDR(handle)->type;
    attr->disconnected          = HANDLE_HDR(handle)->flags & ERROR(0);
    attr->nonblocking           = handle->sock.nonblocking;
    attr->writeable             = HANDLE_HDR(handle)->flags & WRITEABLE(0);
    attr->pending_size          = 0; /* fill in later */
    attr->socket.linger         = handle->sock.linger;
    attr->socket.receivebuf     = handle->sock.receivebuf;
    attr->socket.sendbuf        = handle->sock.sendbuf;
    attr->socket.receivetimeout = handle->sock.receivetimeout;
    attr->socket.sendtimeout    = handle->sock.sendtimeout;
    attr->socket.tcp_cork       = handle->sock.tcp_cork;
    attr->socket.tcp_keepalive  = handle->sock.tcp_keepalive;
    attr->socket.tcp_nodelay    = handle->sock.tcp_nodelay;

    int fd = handle->sock.fd, ret;

    if (handle->sock.conn) {
        /* try use ioctl FIONEAD to get the size of socket */
        ret = ocall_fionread(fd);
        if (ret < 0)
            return ret;

        attr->pending_size = ret;
        attr->readable = !!attr->pending_size > 0;
    } else {
        attr->readable = !attr->disconnected;
    }

    return 0;
}

#ifndef SOL_TCP
# define SOL_TCP 6
#endif

#ifndef TCP_NODELAY
# define TCP_NODELAY 1
#endif

#ifndef TCP_CORK
# define TCP_CORK 3
#endif

static int socket_attrsetbyhdl (PAL_HANDLE handle, PAL_STREAM_ATTR  * attr)
{
    if (handle->sock.fd == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    int fd = handle->sock.fd, ret, val;

    if (attr->nonblocking != handle->sock.nonblocking) {
        ret = ocall_fsetnonblock(fd, attr->nonblocking);

        if (ret < 0)
            return ret;

        handle->sock.nonblocking = attr->nonblocking;
    }

    if (HANDLE_TYPE(handle) != pal_type_tcpsrv) {
        struct __kernel_linger {
            int l_onoff;
            int l_linger;
        };

        if (attr->socket.linger != handle->sock.linger) {
            struct __kernel_linger l;
            l.l_onoff = attr->socket.linger ? 1 : 0;
            l.l_linger = attr->socket.linger;
            ret = ocall_sock_setopt(fd, SOL_SOCKET, SO_LINGER, &l,
                                    sizeof(struct __kernel_linger));
            if (ret < 0)
                return ret;

            handle->sock.linger = attr->socket.linger;
        }

        if (attr->socket.receivebuf != handle->sock.receivebuf) {
            val = attr->socket.receivebuf;
            ret = ocall_sock_setopt(fd, SOL_SOCKET, SO_RCVBUF, &val,
                                    sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.receivebuf = attr->socket.receivebuf;
        }

        if (attr->socket.sendbuf != handle->sock.sendbuf) {
            val = attr->socket.sendbuf;
            ret = ocall_sock_setopt(fd, SOL_SOCKET, SO_SNDBUF,
                                    &val, sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.sendbuf = attr->socket.sendbuf;
        }

        if (attr->socket.receivetimeout != handle->sock.receivetimeout) {
            val = attr->socket.receivetimeout;
            ret = ocall_sock_setopt(fd, SOL_SOCKET, SO_RCVTIMEO,
                                    &val, sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.receivetimeout = attr->socket.receivetimeout;
        }

        if (attr->socket.sendtimeout != handle->sock.sendtimeout) {
            val = attr->socket.sendtimeout;
            ret = ocall_sock_setopt(fd, SOL_SOCKET, SO_SNDTIMEO,
                                    &val, sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.sendtimeout = attr->socket.sendtimeout;
        }
    }

    if (HANDLE_TYPE(handle) == pal_type_tcp ||
        HANDLE_TYPE(handle) == pal_type_tcpsrv) {

        if (attr->socket.tcp_cork != handle->sock.tcp_cork) {
            val = attr->socket.tcp_cork ? 1 : 0;
            ret = ocall_sock_setopt(fd, SOL_TCP, TCP_CORK,
                                    &val, sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.tcp_cork = attr->socket.tcp_cork;
        }

        if (attr->socket.tcp_keepalive != handle->sock.tcp_keepalive) {
            val = attr->socket.tcp_keepalive ? 1 : 0;
            ret = ocall_sock_setopt(fd, SOL_SOCKET, SO_KEEPALIVE,
                                     &val, sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.tcp_keepalive = attr->socket.tcp_keepalive;
        }

        if (attr->socket.tcp_nodelay != handle->sock.tcp_nodelay) {
            val = attr->socket.tcp_nodelay ? 1 : 0;
            ret = ocall_sock_setopt(fd, SOL_TCP, TCP_NODELAY,
                                    &val, sizeof(int));
            if (ret < 0)
                return ret;

            handle->sock.tcp_nodelay = attr->socket.tcp_nodelay;
        }
    }

    return 0;
}

static int socket_getname (PAL_HANDLE handle, char * buffer, int count)
{
    int old_count = count;
    int ret;

    const char * prefix = NULL;
    int prefix_len = 0;
    struct sockaddr * bind_addr = NULL, * dest_addr = NULL;

    switch (HANDLE_TYPE(handle)) {
        case pal_type_tcpsrv:
            prefix_len = static_strlen("tcp.srv");
            prefix = "tcp.srv";
            bind_addr = (struct sockaddr *) handle->sock.bind;
            break;
        case pal_type_tcp:
            prefix_len = static_strlen("tcp");
            prefix = "tcp";
            bind_addr = (struct sockaddr *) handle->sock.bind;
            dest_addr = (struct sockaddr *) handle->sock.conn;
            break;
        case pal_type_udpsrv:
            prefix_len = static_strlen("udp.srv");
            prefix = "udp.srv";
            bind_addr = (struct sockaddr *) handle->sock.bind;
            break;
        case pal_type_udp:
            prefix_len = static_strlen("udp");
            prefix = "udp";
            bind_addr = (struct sockaddr *) handle->sock.bind;
            dest_addr = (struct sockaddr *) handle->sock.conn;
            break;
        default:
            return -PAL_ERROR_INVAL;
    }

    if (prefix_len >= count)
        return -PAL_ERROR_OVERFLOW;

    memcpy(buffer, prefix, prefix_len + 1);
    buffer += prefix_len;
    count -= prefix_len;

    for (int i = 0 ; i < 2 ; i++) {
        struct sockaddr * addr = i ? dest_addr : bind_addr;
        if (addr) {
            if (count <= 1)
                return -PAL_ERROR_OVERFLOW;

            buffer[0] = ':';
            buffer[1] = 0;
            buffer++;
            count--;

            if ((ret = inet_create_uri(buffer, count, addr,
                                       addr_size(addr))) < 0)
                return ret;

            buffer += ret;
            count -= ret;
        }
    }

    return old_count - count;
}

struct handle_ops tcp_ops = {
        .getname        = &socket_getname,
        .open           = &tcp_open,
        .waitforclient  = &tcp_accept,
        .read           = &tcp_read,
        .write          = &tcp_write,
        .delete         = &socket_delete,
        .close          = &socket_close,
        .attrquerybyhdl = &socket_attrquerybyhdl,
        .attrsetbyhdl   = &socket_attrsetbyhdl,
    };

struct handle_ops udp_ops = {
        .getname        = &socket_getname,
        .open           = &udp_open,
        .read           = &udp_receive,
        .write          = &udp_send,
        .delete         = &socket_delete,
        .close          = &socket_close,
        .attrquerybyhdl = &socket_attrquerybyhdl,
        .attrsetbyhdl   = &socket_attrsetbyhdl,
    };

struct handle_ops udpsrv_ops = {
        .getname        = &socket_getname,
        .open           = &udp_open,
        .readbyaddr     = &udp_receivebyaddr,
        .writebyaddr    = &udp_sendbyaddr,
        .delete         = &socket_delete,
        .close          = &socket_close,
        .attrquerybyhdl = &socket_attrquerybyhdl,
        .attrsetbyhdl   = &socket_attrsetbyhdl,
    };

PAL_HANDLE _DkBroadcastStreamOpen (void)
{
    PAL_HANDLE hdl = malloc(HANDLE_SIZE(file));
    SET_HANDLE_TYPE(hdl, mcast);
    HANDLE_HDR(hdl)->flags |= RFD(0)|WFD(1)|WRITEABLE(1);
    hdl->mcast.port = pal_sec.mcast_port;
    hdl->mcast.srv  = pal_sec.mcast_srv;
    hdl->mcast.cli  = pal_sec.mcast_cli;
    return hdl;
}

static int mcast_send (PAL_HANDLE handle, int offset, int size,
                       const void * buf)
{
    if (handle->mcast.srv == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    int bytes = ocall_sock_send(handle->mcast.srv, buf, size,
                                NULL, 0);

    if (bytes == -PAL_ERROR_TRYAGAIN)
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(1);

    if (bytes < 0)
        return bytes;

    if (bytes == size)
        HANDLE_HDR(handle)->flags |= WRITEABLE(1);
    else
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(1);

    return bytes;
}

static int mcast_receive (PAL_HANDLE handle, int offset, int size, void * buf)
{
    if (handle->mcast.cli == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    int bytes = ocall_sock_recv(handle->mcast.cli, buf, size, NULL,
                                NULL);

    if (bytes == -PAL_ERROR_TRYAGAIN)
        HANDLE_HDR(handle)->flags &= ~WRITEABLE(1);

    return bytes;
}

static int mcast_close (PAL_HANDLE handle)
{
    if (handle->mcast.srv != PAL_IDX_POISON) {
        ocall_close(handle->mcast.srv);
        handle->mcast.srv = PAL_IDX_POISON;
    }
    if (handle->mcast.cli != PAL_IDX_POISON) {
        ocall_close(handle->mcast.cli);
        handle->mcast.cli = PAL_IDX_POISON;
    }
    return 0;
}

static int mcast_attrquerybyhdl (PAL_HANDLE handle, PAL_STREAM_ATTR * attr)
{
    if (handle->mcast.cli == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    int ret = ocall_fionread(handle->mcast.cli);
    if (ret < 0)
        return ret;

    memset(attr, 0, sizeof(PAL_STREAM_ATTR));
    attr->pending_size = ret;
    attr->disconnected = HANDLE_HDR(handle)->flags & (ERROR(0)|ERROR(1));
    attr->readable = (attr->pending_size > 0);
    attr->writeable = HANDLE_HDR(handle)->flags & WRITEABLE(1);
    attr->nonblocking = handle->mcast.nonblocking;
    return 0;
}

static int mcast_attrsetbyhdl (PAL_HANDLE handle, PAL_STREAM_ATTR * attr)
{
    if (handle->mcast.cli == PAL_IDX_POISON)
        return -PAL_ERROR_BADHANDLE;

    PAL_BOL * nonblocking = &handle->mcast.nonblocking;

    if (attr->nonblocking != *nonblocking) {
        int ret = ocall_fsetnonblock(handle->mcast.cli, *nonblocking);

        if (ret < 0)
            return ret;

        *nonblocking = attr->nonblocking;
    }

    return 0;
}

struct handle_ops mcast_ops = {
        .write              = &mcast_send,
        .read               = &mcast_receive,
        .close              = &mcast_close,
        .attrquerybyhdl     = &mcast_attrquerybyhdl,
        .attrsetbyhdl       = &mcast_attrsetbyhdl,
    };