badvpn/flow/FragmentProtoDisassembler.c

/**
 * @file FragmentProtoDisassembler.c
 * @author Ambroz Bizjak <ambrop7@gmail.com>
 * 
 * @section LICENSE
 * 
 * This file is part of BadVPN.
 * 
 * BadVPN is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 * 
 * BadVPN 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <stdint.h>
#include <stdlib.h>
#include <string.h>

#include <misc/debug.h>
#include <misc/byteorder.h>

#include <flow/FragmentProtoDisassembler.h>

static void write_chunks (FragmentProtoDisassembler *o)
{
    ASSERT(o->in_len >= 0)
    ASSERT(o->out)
    ASSERT(o->output_mtu - o->out_used >= sizeof(struct fragmentproto_chunk_header))
    
    int in_avail = o->in_len - o->in_used;
    int out_avail = (o->output_mtu - o->out_used) - sizeof(struct fragmentproto_chunk_header);
    
    // write chunks to output packet
    do {
        ASSERT(in_avail >= 0)
        ASSERT(!(in_avail == 0) || out_avail >= 0)
        
        // check if we have space in the output packet
        // (if this is a zero input packet, only one chunk is written, which
        // is always possible)
        if (in_avail > 0 && out_avail <= 0) {
            break;
        }
        
        // calculate chunk length
        int chunk_len = in_avail;
        if (chunk_len > out_avail) {
            chunk_len = out_avail;
        }
        if (o->chunk_mtu > 0) {
            if (chunk_len > o->chunk_mtu) {
                chunk_len = o->chunk_mtu;
            }
        }
        
        // write chunk header
        struct fragmentproto_chunk_header *header = (struct fragmentproto_chunk_header *)(o->out + o->out_used);
        header->frame_id = htol16(o->frame_id);
        header->chunk_start = htol16(o->in_used);
        header->chunk_len = htol16(chunk_len);
        header->is_last = (chunk_len == in_avail);
        
        // write chunk data
        memcpy(o->out + o->out_used + sizeof(struct fragmentproto_chunk_header), o->in + o->in_used, chunk_len);
        
        // increment pointers
        o->in_used += chunk_len;
        o->out_used += sizeof(struct fragmentproto_chunk_header) + chunk_len;
        
        in_avail = o->in_len - o->in_used;
        out_avail = (o->output_mtu - o->out_used) - sizeof(struct fragmentproto_chunk_header);
    } while (in_avail > 0);
    
    // have we finished the input packet?
    if (in_avail == 0) {
        o->in_len = -1;
        o->frame_id++;
    }
    
    // should we finish the output packet?
    if (
        out_avail < 0 ||
        (in_avail > 0 && out_avail <= 0) ||
        o->latency < 0
    ) {
        // finish output packet
        o->out = NULL;
        // stop timer (if it's running)
        if (o->latency >= 0) {
            BReactor_RemoveTimer(o->reactor, &o->timer);
        }
    } else {
        // start timer if we have output and it's not running (output was empty before)
        if (!BTimer_IsRunning(&o->timer)) {
            BReactor_SetTimer(o->reactor, &o->timer);
        }
    }
    
    ASSERT(o->in_len < 0 || !o->out)
}

static int input_handler_send (FragmentProtoDisassembler *o, uint8_t *data, int data_len)
{
    ASSERT(o->in_len == -1)
    ASSERT(!o->doing_send)
    ASSERT(data_len >= 0)
    ASSERT(data_len <= o->input_mtu)
    
    // set input packet
    o->in_len = data_len;
    o->in = data;
    o->in_used = 0;
    
    // if there is no output, block input
    if (!o->out) {
        return 0;
    }
    
    // write input to output
    write_chunks(o);
    
    // if we finished the output packet and are not in recv, notify output
    if (!o->out && !o->doing_recv) {
        o->doing_send = 1;
        DEAD_ENTER(o->dead)
        PacketRecvInterface_Done(&o->output, o->out_used);
        if (DEAD_LEAVE(o->dead)) {
            return -1;
        }
        o->doing_send = 0;
    }
    
    // if we still have some input, block input
    if (o->in_len >= 0) {
        return 0;
    }
    
    // all input was processed, accept packet
    return 1;
}

static void input_handler_cancel (FragmentProtoDisassembler *o)
{
    ASSERT(o->in_len >= 0)
    ASSERT(!o->out)
    ASSERT(!o->doing_send)
    
    o->in_len = -1;
}

static int output_handler_recv (FragmentProtoDisassembler *o, uint8_t *data, int *data_len)
{
    ASSERT(!o->out)
    ASSERT(!o->doing_recv)
    ASSERT(data)
    
    // set output packet
    o->out = data;
    o->out_used = 0;
    
    // if there is no input, block output
    if (o->in_len < 0) {
        return 0;
    }
    
    // write input to output
    write_chunks(o);
    
    // if we finished the input packet and are not in send, notify input
    if (o->in_len < 0 && !o->doing_send) {
        o->doing_recv = 1;
        DEAD_ENTER(o->dead)
        PacketPassInterface_Done(&o->input);
        if (DEAD_LEAVE(o->dead)) {
            return -1;
        }
        o->doing_recv = 0;
    }
    
    // if we are not going to finish the output packet now, block output
    if (o->out) {
        return 0;
    }
    
    // return packet now
    *data_len = o->out_used;
    return 1;
}

static void timer_handler (FragmentProtoDisassembler *o)
{
    ASSERT(o->latency >= 0)
    ASSERT(o->out)
    ASSERT(o->in_len = -1)
    ASSERT(!o->doing_send)
    ASSERT(!o->doing_recv)
    
    // finish output packet
    o->out = NULL;
    
    // inform output
    PacketRecvInterface_Done(&o->output, o->out_used);
    return;
}

void FragmentProtoDisassembler_Init (FragmentProtoDisassembler *o, BReactor *reactor, int input_mtu, int output_mtu, int chunk_mtu, btime_t latency)
{
    ASSERT(input_mtu >= 0)
    ASSERT(input_mtu <= UINT16_MAX)
    ASSERT(output_mtu > sizeof(struct fragmentproto_chunk_header))
    ASSERT(chunk_mtu > 0 || chunk_mtu < 0)
    
    // init arguments
    o->reactor = reactor;
    o->input_mtu = input_mtu;
    o->output_mtu = output_mtu;
    o->chunk_mtu = chunk_mtu;
    o->latency = latency;
    
    // init dead var
    DEAD_INIT(o->dead);
    
    // init input
    PacketPassInterface_Init(&o->input, o->input_mtu, (PacketPassInterface_handler_send)input_handler_send, o);
    PacketPassInterface_EnableCancel(&o->input, (PacketPassInterface_handler_cancel)input_handler_cancel);
    
    // init output
    PacketRecvInterface_Init(&o->output, o->output_mtu, (PacketRecvInterface_handler_recv)output_handler_recv, o);
    
    // init timer
    if (o->latency >= 0) {
        BTimer_Init(&o->timer, o->latency, (BTimer_handler)timer_handler, o);
    }
    
    // have no input packet
    o->in_len = -1;
    
    // have no output packet
    o->out = NULL;
    
    // start with zero frame ID
    o->frame_id = 0;
    
    // not callback from send
    o->doing_send = 0;
    
    // not callback from recv
    o->doing_recv = 0;
    
    // init debug object
    DebugObject_Init(&o->d_obj);
}

void FragmentProtoDisassembler_Free (FragmentProtoDisassembler *o)
{
    // free debug object
    DebugObject_Free(&o->d_obj);

    // free timer
    if (o->latency >= 0) {
        BReactor_RemoveTimer(o->reactor, &o->timer);
    }
    
    // free output
    PacketRecvInterface_Free(&o->output);
    
    // free input
    PacketPassInterface_Free(&o->input);
    
    // free dead var
    DEAD_KILL(o->dead);
}

PacketPassInterface * FragmentProtoDisassembler_GetInput (FragmentProtoDisassembler *o)
{
    return &o->input;
}

PacketRecvInterface * FragmentProtoDisassembler_GetOutput (FragmentProtoDisassembler *o)
{
    return &o->output;
}