path: root/src/ipcpd/normal/fa.c

/*
 * Ouroboros - Copyright (C) 2016 - 2017
 *
 * Flow allocator of the IPC Process
 *
 *    Dimitri Staessens <dimitri.staessens@ugent.be>
 *    Sander Vrijders   <sander.vrijders@ugent.be>
 *
 * This program 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.
 *
 * This program 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., http://www.fsf.org/about/contact/.
 */

#define _POSIX_C_SOURCE 200112L

#include "config.h"

#define OUROBOROS_PREFIX "flow-allocator"

#include <ouroboros/logs.h>
#include <ouroboros/fqueue.h>
#include <ouroboros/errno.h>
#include <ouroboros/dev.h>
#include <ouroboros/ipcp-dev.h>

#include "dir.h"
#include "dt_pci.h"
#include "fa.h"
#include "sdu_sched.h"
#include "ipcp.h"
#include "dt.h"

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

#include "flow_alloc.pb-c.h"
typedef FlowAllocMsg flow_alloc_msg_t;

#define TIMEOUT 10000 /* nanoseconds */

struct {
        pthread_rwlock_t   flows_lock;
        int                r_fd[AP_MAX_FLOWS];
        uint64_t           r_addr[AP_MAX_FLOWS];
        int                fd;

        struct sdu_sched * sdu_sched;
} fa;

static void sdu_handler(int                  fd,
                        qoscube_t            qc,
                        struct shm_du_buff * sdb)
{
        pthread_rwlock_rdlock(&fa.flows_lock);

        if (dt_write_sdu(fa.r_addr[fd], qc, fa.r_fd[fd], sdb)) {
                pthread_rwlock_unlock(&fa.flows_lock);
                ipcp_sdb_release(sdb);
                log_warn("Failed to forward SDU.");
                return;
        }

        pthread_rwlock_unlock(&fa.flows_lock);
}

static void destroy_conn(int fd)
{
        fa.r_fd[fd]   = -1;
        fa.r_addr[fd] = INVALID_ADDR;
}

static void fa_post_sdu(void *               ae,
                        struct shm_du_buff * sdb)
{
        struct timespec    ts  = {0, TIMEOUT * 1000};
        struct timespec    abstime;
        int                fd;
        flow_alloc_msg_t * msg;

        (void) ae;

        assert(ae == &fa);
        assert(sdb);

        /* Depending on the message call the function in ipcp-dev.h */

        msg = flow_alloc_msg__unpack(NULL,
                                     shm_du_buff_tail(sdb) -
                                     shm_du_buff_head(sdb),
                                     shm_du_buff_head(sdb));

        ipcp_sdb_release(sdb);

        if (msg == NULL) {
                log_err("Failed to unpack flow alloc message.");
                return;
        }

        switch (msg->code) {
        case FLOW_ALLOC_CODE__FLOW_REQ:
                clock_gettime(PTHREAD_COND_CLOCK, &abstime);

                pthread_mutex_lock(&ipcpi.alloc_lock);

                if (!msg->has_hash || !msg->has_s_fd || !msg->has_s_addr) {
                        log_err("Bad flow request.");
                        pthread_mutex_unlock(&ipcpi.alloc_lock);
                        flow_alloc_msg__free_unpacked(msg, NULL);
                        return;
                }

                while (ipcpi.alloc_id != -1 &&
                       ipcp_get_state() == IPCP_OPERATIONAL) {
                        ts_add(&abstime, &ts, &abstime);
                        pthread_cond_timedwait(&ipcpi.alloc_cond,
                                               &ipcpi.alloc_lock,
                                               &abstime);
                }

                if (ipcp_get_state() != IPCP_OPERATIONAL) {
                        log_dbg("Won't allocate over non-operational IPCP.");
                        pthread_mutex_unlock(&ipcpi.alloc_lock);
                        flow_alloc_msg__free_unpacked(msg, NULL);
                        return;
                }

                assert(ipcpi.alloc_id == -1);

                fd = ipcp_flow_req_arr(getpid(),
                                       msg->hash.data,
                                       ipcp_dir_hash_len(),
                                       msg->qc);
                if (fd < 0) {
                        pthread_mutex_unlock(&ipcpi.alloc_lock);
                        flow_alloc_msg__free_unpacked(msg, NULL);
                        log_err("Failed to get fd for flow.");
                        return;
                }

                pthread_rwlock_wrlock(&fa.flows_lock);

                fa.r_fd[fd]   = msg->s_fd;
                fa.r_addr[fd] = msg->s_addr;

                pthread_rwlock_unlock(&fa.flows_lock);

                ipcpi.alloc_id = fd;
                pthread_cond_broadcast(&ipcpi.alloc_cond);

                pthread_mutex_unlock(&ipcpi.alloc_lock);

                break;
        case FLOW_ALLOC_CODE__FLOW_REPLY:
                pthread_rwlock_wrlock(&fa.flows_lock);

                fa.r_fd[msg->r_fd] = msg->s_fd;

                ipcp_flow_alloc_reply(msg->r_fd, msg->response);

                if (msg->response < 0)
                        destroy_conn(msg->r_fd);
                else
                        sdu_sched_add(fa.sdu_sched, msg->r_fd);

                pthread_rwlock_unlock(&fa.flows_lock);

                break;
        default:
                log_err("Got an unknown flow allocation message.");
                flow_alloc_msg__free_unpacked(msg, NULL);
                return;
        }

        flow_alloc_msg__free_unpacked(msg, NULL);
}

int fa_init(void)
{
        int i;

        for (i = 0; i < AP_MAX_FLOWS; ++i)
                destroy_conn(i);

        if (pthread_rwlock_init(&fa.flows_lock, NULL))
                return -1;

        fa.fd = dt_reg_ae(&fa, &fa_post_sdu);

        return 0;
}

void fa_fini(void)
{
        pthread_rwlock_destroy(&fa.flows_lock);
}

int fa_start(void)
{
        fa.sdu_sched = sdu_sched_create(sdu_handler);
        if (fa.sdu_sched == NULL) {
                log_err("Failed to create SDU scheduler.");
                return -1;
        }

        return 0;
}

void fa_stop(void)
{
        sdu_sched_destroy(fa.sdu_sched);
}

static struct shm_du_buff * create_fa_sdb(flow_alloc_msg_t * msg)
{
        struct shm_du_buff * sdb;
        size_t len;

        len = flow_alloc_msg__get_packed_size(msg);
        if (len == 0)
                return NULL;

        if (ipcp_sdb_reserve(&sdb, len))
                return NULL;

        flow_alloc_msg__pack(msg, shm_du_buff_head(sdb));

        return sdb;
}

int fa_alloc(int             fd,
             const uint8_t * dst,
             qoscube_t       qc)
{
        flow_alloc_msg_t     msg = FLOW_ALLOC_MSG__INIT;
        uint64_t             addr;
        struct shm_du_buff * sdb;

        addr = dir_query(dst);

        msg.code         = FLOW_ALLOC_CODE__FLOW_REQ;
        msg.has_hash     = true;
        msg.hash.len     = ipcp_dir_hash_len();
        msg.hash.data    = (uint8_t *) dst;
        msg.has_qc       = true;
        msg.qc           = qc;
        msg.has_s_fd     = true;
        msg.s_fd         = fd;
        msg.has_s_addr   = true;
        msg.s_addr       = ipcpi.dt_addr;

        sdb = create_fa_sdb(&msg);
        if (sdb == NULL)
                return -1;

        if (dt_write_sdu(addr, qc, fa.fd, sdb)) {
                ipcp_sdb_release(sdb);
                return -1;
        }

        pthread_rwlock_wrlock(&fa.flows_lock);

        assert(fa.r_fd[fd] == -1);
        fa.r_addr[fd] = addr;

        pthread_rwlock_unlock(&fa.flows_lock);

        return 0;
}

int fa_alloc_resp(int fd,
                  int response)
{
        struct timespec      ts = {0, TIMEOUT * 1000};
        struct timespec      abstime;
        flow_alloc_msg_t     msg = FLOW_ALLOC_MSG__INIT;
        struct shm_du_buff * sdb;
        qoscube_t            qc;

        clock_gettime(PTHREAD_COND_CLOCK, &abstime);

        pthread_mutex_lock(&ipcpi.alloc_lock);

        while (ipcpi.alloc_id != fd && ipcp_get_state() == IPCP_OPERATIONAL) {
                ts_add(&abstime, &ts, &abstime);
                pthread_cond_timedwait(&ipcpi.alloc_cond,
                                       &ipcpi.alloc_lock,
                                       &abstime);
        }

        if (ipcp_get_state() != IPCP_OPERATIONAL) {
                pthread_mutex_unlock(&ipcpi.alloc_lock);
                return -1;
        }

        ipcpi.alloc_id = -1;
        pthread_cond_broadcast(&ipcpi.alloc_cond);

        pthread_mutex_unlock(&ipcpi.alloc_lock);

        pthread_rwlock_wrlock(&fa.flows_lock);

        msg.code         = FLOW_ALLOC_CODE__FLOW_REPLY;
        msg.has_r_fd     = true;
        msg.r_fd         = fa.r_fd[fd];
        msg.has_s_fd     = true;
        msg.s_fd         = fd;
        msg.response     = response;
        msg.has_response = true;

        sdb = create_fa_sdb(&msg);
        if (sdb == NULL) {
                destroy_conn(fd);
                pthread_rwlock_unlock(&fa.flows_lock);
                return -1;
        }

        if (response < 0) {
                destroy_conn(fd);
                ipcp_sdb_release(sdb);
        } else {
                sdu_sched_add(fa.sdu_sched, fd);
        }

        ipcp_flow_get_qoscube(fd, &qc);

        assert(qc >= 0 && qc < QOS_CUBE_MAX);

        if (dt_write_sdu(fa.r_addr[fd], qc, fa.fd, sdb)) {
                destroy_conn(fd);
                pthread_rwlock_unlock(&fa.flows_lock);
                ipcp_sdb_release(sdb);
                return -1;
        }

        pthread_rwlock_unlock(&fa.flows_lock);

        return 0;
}

int fa_dealloc(int fd)
{
        ipcp_flow_fini(fd);

        pthread_rwlock_wrlock(&fa.flows_lock);

        sdu_sched_del(fa.sdu_sched, fd);

        destroy_conn(fd);

        pthread_rwlock_unlock(&fa.flows_lock);

        flow_dealloc(fd);

        return 0;
}