src/vsl_rcp.h

Go to the documentation of this file.

/*
 * Copyright 2005, 2006, Internet2
 * Legal conditions are in file LICENSE
 * (MD5 = c434f2e53b8089d8b4d0172c7ce07360).
 */

/**
 * @file   vsl_rcp.h
 * @author Nikolaus Rath
 * @brief  Headers for VSL file transfer tools
 */

#ifndef VSL_RCP_H
#define VSL_RCP_H

#include "vsl_api.h"

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

//! default file for server debug output
#define DEBUGLOG        "./vsl_rcp.log"

//! parameter that indicates when vsl_rcpd is called from vsl_rcp
#define MAGIC_PARM      "234958oehtedu"

//! structure used as a client message from the client rcp program
typedef struct vsl_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 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 */
} vsl_client_msg_t;


//! server return codes
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 vsl_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)) */
} vsl_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           (ms)  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


/*
 * Local Variables:
 * compile-command: "cd ..; make file_xfer"
 * compilation-search-path: ("..")
 * End:
 */

---