common.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2013-2014 Alexander Zimmermann <alexander.zimmermann@netapp.com>
 * Copyright (C) 2010-2013 Christian Samsel <christian.samsel@rwth-aachen.de>
 * Copyright (C) 2009 Tim Kosse <tim.kosse@gmx.de>
 * Copyright (C) 2007-2008 Daniel Schaffrath <daniel.schaffrath@mac.com>
 *
 * This file is part of Flowgrind.
 *
 * Flowgrind 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.
 *
 * Flowgrind 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 Flowgrind.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef _COMMON_H_
#define _COMMON_H_
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /* HAVE_CONFIG_H */
 
#include <sys/time.h>
#include <time.h>
#include <stdint.h>
 
#include "gitversion.h"
 
#ifdef GITVERSION
 
#define FLOWGRIND_VERSION GITVERSION
#elif defined PACKAGE_VERSION
#define FLOWGRIND_VERSION PACKAGE_VERSION
#else /* GITVERSION */
#define FLOWGRIND_VERSION "(n/a)"
#endif /* GITVERSION */
 
#define FLOWGRIND_API_VERSION 3
 
#define DEFAULT_LISTEN_PORT 5999
 
#define MAX_FLOWS_CONTROLLER 2048
 
#define MAX_FLOWS_DAEMON FD_SETSIZE >> 1
 
#define MAX_EXTRA_SOCKET_OPTIONS 10
 
#define MAX_EXTRA_SOCKET_OPTION_VALUE_LENGTH 100
 
#ifndef TCP_CA_NAME_MAX
 
#define TCP_CA_NAME_MAX 16
#endif /* TCP_CA_NAME_MAX */
 
#define MIN_BLOCK_SIZE (signed) sizeof (struct block)
 
#define FLOWGRIND_COPYRIGHT "Copyright (C) 2007 - 2021 Flowgrind authors."
 
#define FLOWGRIND_COPYING                                                                   \
        "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"  \
        "This is free software: you are free to change and redistribute it.\n"              \
        "There is NO WARRANTY, to the extent permitted by law."
 
#define FLOWGRIND_AUTHORS                                                                   \
        "Written by Arnd Hannemann, Tim Kosse, Christian Samsel, Daniel Schaffrath\n"       \
        "and Alexander Zimmermann."
 
enum endpoint_t {
        SOURCE = 0,
        DESTINATION,
};
 
enum io_t {
        WRITE = 0,
        READ,
};
 
enum report_t {
        INTERVAL = 0,
        FINAL,
};
 
/* XXX add a brief description doxygen. */
enum extra_socket_option_level {
        level_sol_socket,
        level_sol_tcp,
        level_ipproto_ip,
        level_ipproto_sctp,
        level_ipproto_tcp,
        level_ipproto_udp,
};
 
enum distribution_t {
        CONSTANT = 0,
        NORMAL,
        WEIBULL,
        UNIFORM,
        EXPONENTIAL,
        PARETO,
        LOGNORMAL,
};
 
struct block {
        int32_t this_block_size;
 
        int32_t request_block_size;
 
        struct timespec data;
        struct timespec data2;
};
 
struct trafgen_options {
        enum distribution_t distribution;
        double param_one;
        double param_two;
 
};
 
struct flow_settings {
        char bind_address[1000];
 
        int flow_id;
        double delay[2];
        double duration[2];
 
        double reporting_interval;
 
        int requested_send_buffer_size;
        int requested_read_buffer_size;
 
        int maximum_block_size;
 
        int traffic_dump;
        int so_debug;
        int route_record;
        int pushy;
        int shutdown;
 
        const char *write_rate_str;
        int write_rate;
 
        unsigned random_seed;
 
        int flow_control;
 
        int byte_counting;
 
        int cork;
        int nonagle;
        char cc_alg[TCP_CA_NAME_MAX];
        int elcn;
        int lcd;
        int mtcp;
        int dscp;
        int ipmtudiscover;
 
        struct trafgen_options request_trafgen_options;
        struct trafgen_options response_trafgen_options;
        struct trafgen_options interpacket_gap_trafgen_options;
 
        /* XXX add a brief description doxygen + is this obsolete? */
        struct extra_socket_options {
                int level;
                int optname;
                int optlen;
                char optval[MAX_EXTRA_SOCKET_OPTION_VALUE_LENGTH];
        } extra_socket_options[MAX_EXTRA_SOCKET_OPTIONS];
        int num_extra_socket_options;
};
 
/* Flowgrinds view on the tcp_info struct for
 * serialization / deserialization */
struct fg_tcp_info {
        int tcpi_snd_cwnd;
        int tcpi_snd_ssthresh;
        int tcpi_unacked;
        int tcpi_sacked;
        int tcpi_lost;
        int tcpi_retrans;
        int tcpi_retransmits;
        int tcpi_fackets;
        int tcpi_reordering;
        int tcpi_rtt;
        int tcpi_rttvar;
        int tcpi_rto;
        int tcpi_backoff;
        int tcpi_snd_mss;
        int tcpi_ca_state;
};
 
/* Report (measurement sample) of a flow */
struct report {
        int id;
        enum endpoint_t endpoint;
        enum report_t type;
        struct timespec begin;
        struct timespec end;
#ifdef HAVE_UNSIGNED_LONG_LONG_INT
        unsigned long long bytes_read;
        unsigned long long bytes_written;
#else /* HAVE_UNSIGNED_LONG_LONG_INT */
        long bytes_read;
        long bytes_written;
#endif /* HAVE_UNSIGNED_LONG_LONG_INT */
        unsigned request_blocks_read;
        unsigned request_blocks_written;
        unsigned response_blocks_read;
        unsigned response_blocks_written;
 
        /* TODO Create an array for IAT / RTT and delay */
 
        double iat_min;
        double iat_max;
        double iat_sum;
        double delay_min;
        double delay_max;
        double delay_sum;
        double rtt_min;
        double rtt_max;
        double rtt_sum;
 
        /* on the Daemon this is filled from the os specific
         * tcp_info struct */
        struct fg_tcp_info tcp_info;
 
        unsigned pmtu;
        unsigned imtu;
 
        int status;
 
        struct report* next;
};
 
#endif /* _COMMON_H_*/