src/vfer_rcp.h

Go to the documentation of this file.

/*
 * Copyright 2005, 2006, Internet2
 * Legal conditions are in file LICENSE
 * (MD5 = c434f2e53b8089d8b4d0172c7ce07360).
 */
/**
 * @file   vfer_rcp.h
 * @author Ivan Beschastnikh
 * @brief  Header file of common structures and globals defs for use by vfer_rcp.c and vfer_rcpd.c
 *
 * This file is the only file included by vfer_rcpd.c and
 * vfer_rcp.c. It contains the structures, defs and other include
 * files for the rcp daemon and client.
 *
 * -     04/30/06        ivan            made server msg into a structure, added file_size to both client and server msgs
 * -     04/12/06        ivan            Added vfer_rcp_print_stats()
 * -     02/18/06        ivan            Changed name to vfer_rcp.h, added signal.h include
 * -     02/16/06        ivan            Header created
 */

#ifndef TEST_RCP_H
#define TEST_RCP_H

#include <netdb.h>
#include <sys/select.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <getopt.h>
#include <strings.h>
#include <pwd.h>
#include <sys/stat.h>
#include <signal.h>
#include <dirent.h>

#include "vfer_tests.h"
#include "vfer_api.h"

inline void vfer_rcp_print_stats(vfer_stats* stats);

/* constants controlling the max buffer sizes for paths, usernames, etc */
#define MAX_PATH        128
#define MAX_USER        16
#define MAX_HOST        64
#define DEFAULT_PORT    2046

/**
 * @brief structure used as a client message from the client rcp program
 */
typedef struct client_msg {
        char local_name [MAX_PATH];     /* filename of the file on the local system */
        char remote_path[MAX_PATH];     /* path on the remote host specified on the cmd line */
        char user       [MAX_USER];     /* user name to authenticate */
        char from_remote;               /* 0: yes (get remote file to local sys), 1: no (put local file to remote sys)*/
        uint32_t file_size;             /* file size to transfer if from_remote = 1, ow. set to 0 */
} client_msg_t;

typedef enum status_t {RCP_READY=0,     /* success, ready/OK */
                       RCP_ENOENT,      /* error, component of the path does not exist, or the path is an empty string */
                       RCP_EOPEN,       /* error, can't open file for reading or writing */
                       RCP_ENOFILE,     /* error, file doesn't exist (if from_remote==0) */
                       RCP_EUSER,       /* error, user name does not match for authentication purposes */
                       RCP_EOTHER       /* error, some other error occured */
} status_t;

/**
 * @brief structure used as a server message reply from the server rcpd program to the client msg
 */
typedef struct server_msg {
        uint32_t status;                /* status of the server rcpd proccess (actually of status_t type) */
        uint32_t file_size;             /* file size the client should expect (if from_remote set to 0 in client msg (see above)) */
} server_msg_t;

/**
 * This function prints the final transfer statistics after file transfer
 *
 * @param stats vfer stats structure pointer
 */
inline void vfer_rcp_print_stats(vfer_stats* stats) {
        double duration;        /* in seconds */
        struct timeval tv_end;
        uint32_t data_retransmitted;
        
        if (stats->tv_end.tv_sec == 0 && stats->tv_end.tv_usec == 0) {
                GET_TIME_OF_DAY(&(tv_end));
                printf("-- real time stats --\n");
        } else {
                bcopy(&(stats->tv_end), &(tv_end), sizeof(struct timeval));
        }

        /* printf("start: %d %d\n", (int)stats->tv_start.tv_sec, (int)stats->tv_start.tv_usec);
           printf("end: %d %d\n", (int)tv_end.tv_sec, (int)tv_end.tv_usec);  */
        
        duration = (tv_end.tv_sec - stats->tv_start.tv_sec);
        duration += 0.000000001 * (tv_end.tv_usec - stats->tv_start.tv_usec);
        /* retransmit traffic (data payload only) in bytes */
        data_retransmitted = (stats->data_bytes_sent - stats->data_bytes_sender_sent);
        
        printf("\n");
        printf("VFER transfer statistics:\n");
        printf("\n");
        printf("Duration      (s)       conn    %f\n", duration);
        printf("Avg rate      (Mb/s)    sending %-16.2f recving %.2f\n", ((stats->bytes_sent * 8.0) / (duration * 1000000)), ((stats->bytes_recvd * 8.0) / (duration * 1000000)));
        printf("Total         (packets) sent    %-14u   recvd   %u\n", stats->packets_sent, stats->packets_recvd);
        printf("Total         (bytes)   sent    %-14u   recvd   %u\n", stats->bytes_sent, stats->bytes_recvd);
        printf("Total data    (bytes)   sent    %-14u   recvd   %-16u retrans      %u\n", stats->data_bytes_sent, stats->data_bytes_recvd, data_retransmitted);
        printf("Avg data rate (Mb/s)    sending %-16.2f recving %-16.2f eff. sending %.2f\n",
               ((stats->data_bytes_sent * 8.0) / (duration * 1000000)),
               ((stats->data_bytes_recvd * 8.0) / (duration * 1000000)),
               (((stats->data_bytes_sent - data_retransmitted) * 8.0) / (duration * 1000000)));
        printf("RTT           (us)      avg     %-16.2f max     %-16.2f min          %.2f\n", stats->avg_rtt, (double)(stats->max_rtt), (double)(stats->min_rtt));
        printf("\n");
} /* vfer_rcp_print_stats() */


#endif /* TEST_RCP_H */

---