source: vbox/trunk/src/VBox/Devices/Network/slirp/if.c@ 13610

/*
 * Copyright (c) 1995 Danny Gasparovski.
 *
 * Please read the file COPYRIGHT for the
 * terms and conditions of the copyright.
 */

#include <slirp.h>


#define ifs_init(ifm) ((ifm)->ifs_next = (ifm)->ifs_prev = (ifm))

static void ifs_insque(struct mbuf *ifm, struct mbuf *ifmhead)
{
        ifm->ifs_next = ifmhead->ifs_next;
        ifmhead->ifs_next = ifm;
        ifm->ifs_prev = ifmhead;
        ifm->ifs_next->ifs_prev = ifm;
}

static void ifs_remque(struct mbuf *ifm)
{
        ifm->ifs_prev->ifs_next = ifm->ifs_next;
        ifm->ifs_next->ifs_prev = ifm->ifs_prev;
}

void
if_init(PNATState pData)
{
#if 0
        /*
         * Set if_maxlinkhdr to 48 because it's 40 bytes for TCP/IP,
         * and 8 bytes for PPP, but need to have it on an 8byte boundary
         */
#ifdef USE_PPP
        if_maxlinkhdr = 48;
#else
        if_maxlinkhdr = 40;
#endif
#else
        /* 2 for alignment, 14 for ethernet, 40 for TCP/IP */
        if_maxlinkhdr = 2 + 14 + 40;
#endif
        if_queued = 0;
        if_thresh = 10;
        if_mtu = 1500;
        if_mru = 1500;
        if_comp = IF_AUTOCOMP;
        if_fastq.ifq_next = if_fastq.ifq_prev = &if_fastq;
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexCreate(&pData->if_fastq_mutex);
        RTSemMutexCreate(&if_fastq.m_mutex);
#endif

        if_batchq.ifq_next = if_batchq.ifq_prev = &if_batchq;
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexCreate(&pData->if_batchq_mutex);
        RTSemMutexCreate(&if_batchq.m_mutex);
#endif
        /*      sl_compress_init(&comp_s); */
        next_m = &if_batchq;
}

#if 0
/*
 * This shouldn't be needed since the modem is blocking and
 * we don't expect any signals, but what the hell..
 */
inline int
writen(fd, bptr, n)
        int fd;
        char *bptr;
        int n;
{
        int ret;
        int total;

        /* This should succeed most of the time */
        ret = send(fd, bptr, n,0);
        if (ret == n || ret <= 0)
           return ret;

        /* Didn't write everything, go into the loop */
        total = ret;
        while (n > total) {
                ret = send(fd, bptr+total, n-total,0);
                if (ret <= 0)
                   return ret;
                total += ret;
        }
        return total;
}

/*
 * if_input - read() the tty, do "top level" processing (ie: check for any escapes),
 * and pass onto (*ttyp->if_input)
 *
 * XXXXX Any zeros arriving by themselves are NOT placed into the arriving packet.
 */
#define INBUFF_SIZE 2048 /* XXX */
void
if_input(ttyp)
        struct ttys *ttyp;
{
        u_char if_inbuff[INBUFF_SIZE];
        int if_n;

        DEBUG_CALL("if_input");
        DEBUG_ARG("ttyp = %lx", (long)ttyp);

        if_n = recv(ttyp->fd, (char *)if_inbuff, INBUFF_SIZE,0);

        DEBUG_MISC((dfd, " read %d bytes\n", if_n));

        if (if_n <= 0) {
                if (if_n == 0 || (errno != EINTR && errno != EAGAIN)) {
                        if (ttyp->up)
                           link_up--;
                        tty_detached(ttyp, 0);
                }
                return;
        }
        if (if_n == 1) {
                if (*if_inbuff == '0') {
                        ttyp->ones = 0;
                        if (++ttyp->zeros >= 5)
                           slirp_exit(0);
                        return;
                }
                if (*if_inbuff == '1') {
                        ttyp->zeros = 0;
                        if (++ttyp->ones >= 5)
                           tty_detached(ttyp, 0);
                        return;
                }
        }
        ttyp->ones = ttyp->zeros = 0;

        (*ttyp->if_input)(ttyp, if_inbuff, if_n);
}
#endif

/*
 * if_output: Queue packet into an output queue.
 * There are 2 output queue's, if_fastq and if_batchq.
 * Each output queue is a doubly linked list of double linked lists
 * of mbufs, each list belonging to one "session" (socket).  This
 * way, we can output packets fairly by sending one packet from each
 * session, instead of all the packets from one session, then all packets
 * from the next session, etc.  Packets on the if_fastq get absolute
 * priority, but if one session hogs the link, it gets "downgraded"
 * to the batchq until it runs out of packets, then it'll return
 * to the fastq (eg. if the user does an ls -alR in a telnet session,
 * it'll temporarily get downgraded to the batchq)
 */
void
if_output(PNATState pData, struct socket *so, struct mbuf *ifm)
{
        struct mbuf *ifq;
#ifdef VBOX_WITH_SYNC_SLIRP
        struct mbuf *ifqprev;
#endif
        int on_fastq = 1;

        DEBUG_CALL("if_output");
        DEBUG_ARG("so = %lx", (long)so);
        DEBUG_ARG("ifm = %lx", (long)ifm);
#ifdef VBOX_WITH_SYNC_SLIRP
    if (so != NULL)
        RTSemMutexRequest(so->so_mutex, RT_INDEFINITE_WAIT);
#endif

        /*
         * First remove the mbuf from m_usedlist,
         * since we're gonna use m_next and m_prev ourselves
         * XXX Shouldn't need this, gotta change dtom() etc.
         */
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRequest(pData->m_usedlist_mutex, RT_INDEFINITE_WAIT);
        RTSemMutexRequest(ifm->m_mutex, RT_INDEFINITE_WAIT);
#endif
        if (ifm->m_flags & M_USEDLIST) {
                remque(pData, ifm);
                ifm->m_flags &= ~M_USEDLIST;
        }
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRelease(pData->m_usedlist_mutex);
#endif

        /*
         * See if there's already a batchq list for this session.
         * This can include an interactive session, which should go on fastq,
         * but gets too greedy... hence it'll be downgraded from fastq to batchq.
         * We mustn't put this packet back on the fastq (or we'll send it out of order)
         * XXX add cache here?
         */
#ifndef VBOX_WITH_SYNC_SLIRP
        for (ifq = if_batchq.ifq_prev; ifq != &if_batchq; ifq = ifq->ifq_prev) {
#else
        RTSemMutexRequest(pData->if_batchq_mutex, RT_INDEFINITE_WAIT);
        ifq = if_batchq.ifq_prev;
        while(1){
            if (ifq == &if_batchq) {
                RTSemMutexRelease(pData->if_batchq_mutex);
                break;
            }
            ifqprev = ifq->ifq_prev;
            RTSemMutexRequest(ifq->m_mutex, RT_INDEFINITE_WAIT);
            RTSemMutexRelease(pData->if_batchq_mutex);
#endif
                if (so == ifq->ifq_so) {
                        /* A match! */
                        ifm->ifq_so = so;
                        ifs_insque(ifm, ifq->ifs_prev);
                        goto diddit;
                }
#ifdef VBOX_WITH_SYNC_SLIRP
            RTSemMutexRequest(pData->if_batchq_mutex, RT_INDEFINITE_WAIT);
            RTSemMutexRelease(ifq->m_mutex);
            ifq = ifqprev;
#endif
        }

        /* No match, check which queue to put it on */
        if (so && (so->so_iptos & IPTOS_LOWDELAY)) {
#ifdef VBOX_WITH_SYNC_SLIRP
                RTSemMutexRequest(pData->if_fastq_mutex, RT_INDEFINITE_WAIT);
#endif
                ifq = if_fastq.ifq_prev;
#ifdef VBOX_WITH_SYNC_SLIRP
                RTSemMutexRequest(ifq->m_mutex, RT_INDEFINITE_WAIT);
                RTSemMutexRelease(pData->if_fastq_mutex);
#endif
                on_fastq = 1;
                /*
                 * Check if this packet is a part of the last
                 * packet's session
                 */
                if (ifq->ifq_so == so) {
                        ifm->ifq_so = so;
                        ifs_insque(ifm, ifq->ifs_prev);
                        goto diddit;
                }
        }
        else {
#ifdef VBOX_WITH_SYNC_SLIRP
                RTSemMutexRequest(pData->if_batchq_mutex, RT_INDEFINITE_WAIT);
#endif
                ifq = if_batchq.ifq_prev;
#ifdef VBOX_WITH_SYNC_SLIRP
                RTSemMutexRequest(ifq->m_mutex, RT_INDEFINITE_WAIT);
                RTSemMutexRelease(pData->if_batchq_mutex);
#endif
        }

        /* Create a new doubly linked list for this session */
        ifm->ifq_so = so;
        ifs_init(ifm);
        insque(pData, ifm, ifq);

diddit:
#ifdef VBOX_WITH_SYNC_SLIRP
    RTSemMutexRequest(pData->if_queued_mutex, RT_INDEFINITE_WAIT);
#endif
        ++if_queued;
#ifdef VBOX_WITH_SYNC_SLIRP
    RTSemMutexRelease(pData->if_queued_mutex);
#endif

        if (so) {
                /* Update *_queued */
                so->so_queued++;
                so->so_nqueued++;
                /*
                 * Check if the interactive session should be downgraded to
                 * the batchq.  A session is downgraded if it has queued 6
                 * packets without pausing, and at least 3 of those packets
                 * have been sent over the link
                 * (XXX These are arbitrary numbers, probably not optimal..)
                 */
                if (on_fastq && ((so->so_nqueued >= 6) &&
                                 (so->so_nqueued - so->so_queued) >= 3)) {

#ifdef VBOX_WITH_SYNC_SLIRP
                        RTSemMutexRequest(pData->if_fastq_mutex, RT_INDEFINITE_WAIT);
#endif
                        /* Remove from current queue... */
                        remque(pData, ifm->ifs_next);
#ifdef VBOX_WITH_SYNC_SLIRP
                        RTSemMutexRequest(pData->if_batchq_mutex, RT_INDEFINITE_WAIT);
#endif

                        /* ...And insert in the new.  That'll teach ya! */
                        insque(pData, ifm->ifs_next, &if_batchq);
#ifdef VBOX_WITH_SYNC_SLIRP
                    RTSemMutexRelease(pData->if_fastq_mutex);
                    RTSemMutexRelease(pData->if_batchq_mutex);
#endif
                }
                RTSemMutexRelease(so->so_mutex);
        }
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRelease(ifq->m_mutex);
        RTSemMutexRelease(ifm->m_mutex);
#endif

#ifndef FULL_BOLT
        /*
         * This prevents us from malloc()ing too many mbufs
         */
        if (link_up) {
                /* if_start will check towrite */
                if_start(pData);
        }
#endif
}

/*
 * Send a packet
 * We choose a packet based on it's position in the output queues;
 * If there are packets on the fastq, they are sent FIFO, before
 * everything else.  Otherwise we choose the first packet from the
 * batchq and send it.  the next packet chosen will be from the session
 * after this one, then the session after that one, and so on..  So,
 * for example, if there are 3 ftp session's fighting for bandwidth,
 * one packet will be sent from the first session, then one packet
 * from the second session, then one packet from the third, then back
 * to the first, etc. etc.
 */
void
if_start(PNATState pData)
{
        struct mbuf *ifm, *ifqt;
#ifdef VBOX_WITH_SYNC_SLIRP
        int on_fast = 0; /*required for correctness */
        struct mbuf *ifm_prev;
#endif

        DEBUG_CALL("if_start");

#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRequest(pData->if_queued_mutex, RT_INDEFINITE_WAIT);
#endif
        if (if_queued <= 0) {
#ifdef VBOX_WITH_SYNC_SLIRP
            RTSemMutexRelease(pData->if_queued_mutex);
#endif
           return; /* Nothing to do */
        }

 again:
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRelease(pData->if_queued_mutex);
#endif
        /* check if we can really output */
        if (!slirp_can_output(pData->pvUser))
            return;

        /*
         * See which queue to get next packet from
         * If there's something in the fastq, select it immediately
         */
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRequest(pData->if_fastq_mutex, RT_INDEFINITE_WAIT);
#endif
        if (if_fastq.ifq_next != &if_fastq) {
                ifm = if_fastq.ifq_next;
#ifdef VBOX_WITH_SYNC_SLIRP
                on_fast = 1;
                RTSemMutexRequest(ifm->m_mutex, RT_INDEFINITE_WAIT);
#endif
        } else {
#ifdef VBOX_WITH_SYNC_SLIRP
                RTSemMutexRelease(pData->if_fastq_mutex);
                RTSemMutexRequest(pData->next_m_mutex, RT_INDEFINITE_WAIT);
                RTSemMutexRequest(pData->if_batchq_mutex, RT_INDEFINITE_WAIT);
#endif
                /* Nothing on fastq, see if next_m is valid */
                if (next_m != &if_batchq)
                   ifm = next_m;
                else
                   ifm = if_batchq.ifq_next;

                /* Set which packet to send on next iteration */
                next_m = ifm->ifq_next;
#ifdef VBOX_WITH_SYNC_SLIRP
                RTSemMutexRelease(pData->next_m_mutex);
#endif
        }
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRequest(ifm->m_mutex, RT_INDEFINITE_WAIT);
        RTSemMutexRequest(pData->if_queued_mutex, RT_INDEFINITE_WAIT);
#endif
        /* Remove it from the queue */
        ifqt = ifm->ifq_prev;
        ifqt = ifm->ifq_prev;
        remque(pData, ifm);

        --if_queued;
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRelease(pData->if_queued_mutex);
        if (on_fast == 1) {
            RTSemMutexRelease(pData->if_fastq_mutex);
        }
        else {
            RTSemMutexRelease(pData->if_batchq_mutex);
        }
#endif

        /* If there are more packets for this session, re-queue them */
        if (ifm->ifs_next != /* ifm->ifs_prev != */ ifm) {
                insque(pData, ifm->ifs_next, ifqt);
                ifs_remque(ifm);
        }

        /* Update so_queued */
        if (ifm->ifq_so) {
#ifdef VBOX_WITH_SYNC_SLIRP
            RTSemMutexRequest(ifm->ifq_so->so_mutex, RT_INDEFINITE_WAIT);
#endif
                if (--ifm->ifq_so->so_queued == 0)
                   /* If there's no more queued, reset nqueued */
                   ifm->ifq_so->so_nqueued = 0;
#ifdef VBOX_WITH_SYNC_SLIRP
            RTSemMutexRelease(ifm->ifq_so->so_mutex);
#endif
        }

        /* Encapsulate the packet for sending */
        if_encap(pData, (const uint8_t *)ifm->m_data, ifm->m_len);
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRelease(ifm->m_mutex);
#endif

        m_free(pData, ifm);

#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRequest(pData->if_queued_mutex, RT_INDEFINITE_WAIT);
        /*We release if_queued_mutex after again label and before return*/
#endif
        if (if_queued > 0)
           goto again;
#ifdef VBOX_WITH_SYNC_SLIRP
        RTSemMutexRelease(pData->if_queued_mutex);
#endif
}