flowgrind.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2013-2014 Alexander Zimmermann <alexander.zimmermann@netapp.com>
 * Copyright (C) 2010-2013 Arnd Hannemann <arnd@arndnet.de>
 * 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 _FLOWGRIND_H_
#define _FLOWGRIND_H_
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /* HAVE_CONFIG_H */
 
#include <stdbool.h>
#include <limits.h>
 
#include "common.h"
#include "fg_list.h"
 
#define GUARDBAND 2
 
#define MAX_COLUM_TOO_LARGE 5
 
#define MAX_REPORTS_IN_ROW 25
 
enum protocol_t {
        PROTO_TCP = 1,
        PROTO_UDP,
};
 
enum os_t {
        LINUX = 0,
        FREEBSD,
        DARWIN,
        NUM_OSes,
};
 
enum tcp_stack_t {
        SEGMENT_BASED = 0,
        BYTE_BASED,
};
 
#ifndef HAVE_TCP_CA_STATE
 
enum tcp_ca_state {
        TCP_CA_Open = 0,
        TCP_CA_Disorder = 1,
        TCP_CA_CWR = 2,
        TCP_CA_Recovery = 3,
        TCP_CA_Loss = 4,
};
#endif /* HAVE_TCP_CA_STATE */
 
enum column_id {
        COL_FLOW_ID = 0,
        COL_BEGIN,
        COL_END,                                            
        COL_THROUGH,
        COL_TRANSAC,
        COL_BLOCK_REQU,
        COL_BLOCK_RESP,                                     
        COL_RTT_MIN,
        COL_RTT_AVG,
        COL_RTT_MAX,                                        
        COL_IAT_MIN,
        COL_IAT_AVG,
        COL_IAT_MAX,                                        
        COL_DLY_MIN,
        COL_DLY_AVG,
        COL_DLY_MAX,                                        
        COL_TCP_CWND,
        COL_TCP_SSTH,
        COL_TCP_UACK,
        COL_TCP_SACK,
        COL_TCP_LOST,
        COL_TCP_RETR,
        COL_TCP_TRET,
        COL_TCP_FACK,
        COL_TCP_REOR,
        COL_TCP_BKOF,
        COL_TCP_RTT,
        COL_TCP_RTTVAR,
        COL_TCP_RTO,
        COL_TCP_CA_STATE,
        COL_SMSS,
        COL_PMTU,                                           
#ifdef DEBUG
 
        COL_STATUS,
#endif /* DEBUG */
 
        NUM_COL,
};
 
enum option_t {
        OPT_CONTROLLER,
        OPT_SELECTOR,
        OPT_FLOW,
        OPT_FLOW_ENDPOINT
};
 
enum mutex_context_t {
        MUTEX_CONTEXT_CONTROLLER = 0,
        MUTEX_CONTEXT_TWO_SIDED,
        MUTEX_CONTEXT_SOURCE,
        MUTEX_CONTEXT_DESTINATION
};
 
enum long_opt_only {
        LOG_FILE_OPTION = CHAR_MAX + 1,
};
 
struct controller_options {
        unsigned short num_flows;
        double reporting_interval;
        bool log_to_stdout;
        bool log_to_file;
        const char *dump_prefix;
        bool clobber;
        bool mbyte;
        bool symbolic;
        enum tcp_stack_t force_unit;
};
 
struct daemon {
/* Note: a daemon can potentially managing multiple flows */
        char uuid[38];
        int api_version;
        char os_name[257];
        char os_release[257];
        char *url;
};
 
struct rpc_info {
        char server_url[1000];
        char server_name[257];
        unsigned short server_port;
};
 
struct flow_endpoint {
        int send_buffer_size_real;
        int receive_buffer_size_real;
        struct rpc_info* rpc_info;
        struct daemon* daemon;
        char test_address[1000];
};
 
struct cflow {
        enum protocol_t proto;
 
        /* TODO Some of this flow option members are duplicates from the
         * _flow_settings struct (see common.h). Flowgrind contoller
         * should use this one */
 
        char late_connect;
        char shutdown;
        char summarize_only;
        char byte_counting;
        unsigned random_seed;
 
        /* For the following arrays: 0 stands for source; 1 for destination */
 
        int endpoint_id[2];
        struct timespec start_timestamp[2];
        struct flow_endpoint endpoint[2];
        struct flow_settings settings[2];
        char finished[2];
        struct report *final_report[2];
};
 
struct column_header {
        const char* name;
        const char* unit;
};
 
struct column_state {
        bool visible;
        unsigned oversized;
        size_t last_width;
};
 
struct column {
        enum column_id type;
        struct column_header header;
        struct column_state state;
};
 
#endif /* _FLOWGRIND_H_ */