/*
* Get next input command from terminal.
*
* Returns: 1 if got input
* 0 if timeout
* -1 if EOF or error
*/
int get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec)
{
int len;
if (!stop) {
if (output == stdout || teeout) {
sendit(prompt);
}
}
again:
switch (wait_for_readable_fd(fileno(input), sec, true)) {
case 0:
return 0; /* timeout */
case -1:
return -1; /* error */
default:
len = sizeof_pool_memory(sock->msg) - 1;
if (stop) {
sleep(1);
goto again;
}
#ifdef HAVE_CONIO
if (bisatty(fileno(input))) {
input_line(sock->msg, len);
break;
}
#endif
if (fgets(sock->msg, len, input) == NULL) {
return -1;
}
break;
}
if (usrbrk()) {
clrbrk();
}
strip_trailing_junk(sock->msg);
sock->msglen = strlen(sock->msg);
return 1;
}
/**
* Perform the C2S Throughput test. This test intends to measure throughput
* from the client to the server by performing a 10 seconds memory-to-memory
* data transfer.
*
* Protocol messages are exchanged between the Client and the Server using the
* same connection and message format as the NDTP-Control protocol.Throughput
* packets are sent on the new connection and do not follow the NDTP-Control
* protocol message format.
*
* When the Client stops streaming the test data (or the server test routine
* times out), the Server sends the Client its calculated throughput value.
*
* @param ctl Client control Connection
* @param agent Web100 agent used to track the connection
* @param testOptions Test options
* @param conn_options connection options
* @param c2sspd In-out parameter to store C2S throughput value
* @param set_buff enable setting TCP send/recv buffer size to be used (seems
* unused in file)
* @param window value of TCP send/rcv buffer size intended to be used.
* @param autotune autotuning option. Deprecated.
* @param device string device name inout parameter
* @param options Test Option variables
* @param record_reverse integer indicating whether receiver-side statistics
* have to be logged
* @param count_vars count of web100 variables
* @param spds[] [] speed check array
* @param spd_index index used for speed check array
* @param conn_options Connection options
* @param ctx The SSL context (possibly NULL)
* @param c2s_ThroughputSnapshots Variable used to set c2s throughput snapshots
* @param extended indicates if extended c2s test should be performed
* @return 0 on success, an error code otherwise
* Error codes:
* -1 - Listener socket creation failed
* -100 - Timeout while waiting for client to connect to server's
* ephemeral port
* -101 - Retries exceeded while waiting for client to connect
* -102 - Retries exceeded while waiting for data from connected
* client
* -errno - Other specific socket error numbers
*/
int test_c2s(Connection *ctl, tcp_stat_agent *agent, TestOptions *testOptions,
int conn_options, double *c2sspd, int set_buff, int window,
int autotune, char *device, Options *options, int record_reverse,
int count_vars, char spds[4][256], int *spd_index, SSL_CTX *ctx,
struct throughputSnapshot **c2s_ThroughputSnapshots,
int extended) {
tcp_stat_connection conn;
tcp_stat_group *group = NULL;
/* The pipe that will return packet pair results */
int mon_pipe[2];
int packet_trace_running = 0;
pid_t c2s_childpid = 0; // child process pids
int msgretvalue, read_error; // used during the "read"/"write" process
int i; // used as loop iterator
int conn_index, attempts;
int retvalue = 0;
int streamsNum = 1;
int activeStreams = 1;
int local_errno;
struct sockaddr_storage cli_addr[MAX_STREAMS];
Connection c2s_conns[MAX_STREAMS];
struct throughputSnapshot *lastThroughputSnapshot;
socklen_t clilen;
char tmpstr[256]; // string array used for all sorts of temp storage purposes
double start_time, measured_test_duration;
double throughputSnapshotTime; // specify the next snapshot time
double testDuration = 10; // default test duration
double bytes_read = 0; // number of bytes read during the throughput tests
struct timeval sel_tv; // time
fd_set rfd; // receive file descriptors
int max_fd;
char buff[BUFFSIZE + 1]; // message "payload" buffer
PortPair pair; // socket ports
I2Addr c2ssrv_addr = NULL; // c2s test's server address
// I2Addr src_addr=NULL; // c2s test source address
char listenc2sport[10]; // listening port
pthread_t workerThreadId;
// snap related variables
SnapArgs snapArgs;
snapArgs.snap = NULL;
#if USE_WEB100
snapArgs.log = NULL;
#endif
snapArgs.delay = options->snapDelay;
// Test ID and status descriptors
enum TEST_ID testids = extended ? C2S_EXT : C2S;
enum TEST_STATUS_INT teststatuses = TEST_NOT_STARTED;
char namesuffix[256] = "c2s_snaplog";
for (i = 0; i < MAX_STREAMS; i++) {
c2s_conns[i].socket = 0;
c2s_conns[i].ssl = NULL;
}
if (!extended && testOptions->c2sopt) {
setCurrentTest(TEST_C2S);
} else if (extended && testOptions->c2sextopt) {
setCurrentTest(TEST_C2S_EXT);
} else {
return 0;
}
log_println(1, " <-- %d - C2S throughput test -->", testOptions->child0);
strlcpy(listenc2sport, PORT2, sizeof(listenc2sport));
// log protocol validation logs
teststatuses = TEST_STARTED;
protolog_status(testOptions->child0, testids, teststatuses, ctl->socket);
// Determine port to be used. Compute based on options set earlier
// by reading from config file, or use default port2 (3002).
if (testOptions->c2ssockport) {
snprintf(listenc2sport, sizeof(listenc2sport), "%d",
testOptions->c2ssockport);
} else if (testOptions->mainport) {
snprintf(listenc2sport, sizeof(listenc2sport), "%d",
testOptions->mainport + 1);
}
if (testOptions->multiple) {
strlcpy(listenc2sport, "0", sizeof(listenc2sport));
}
// attempt to bind to a new port and obtain address structure with details
// of listening port
while (c2ssrv_addr == NULL) {
c2ssrv_addr = CreateListenSocket(
NULL, (testOptions->multiple
? mrange_next(listenc2sport, sizeof(listenc2sport))
: listenc2sport),
conn_options, 0);
if (strcmp(listenc2sport, "0") == 0) {
log_println(1, "WARNING: ephemeral port number was bound");
break;
}
if (testOptions->multiple == 0) {
break;
}
}
if (c2ssrv_addr == NULL) {
log_println(0,
"Server (C2S throughput test): CreateListenSocket failed: %s",
strerror(errno));
snprintf(buff, sizeof(buff),
"Server (C2S throughput test): CreateListenSocket failed: %s",
strerror(errno));
send_json_message_any(ctl, MSG_ERROR, buff, strlen(buff),
testOptions->connection_flags, JSON_SINGLE_VALUE);
return -1;
}
// get socket FD and the ephemeral port number that client will connect to
// run tests
testOptions->c2ssockfd = I2AddrFD(c2ssrv_addr);
testOptions->c2ssockport = I2AddrPort(c2ssrv_addr);
log_println(1, " -- c2s %d port: %d", testOptions->child0,
testOptions->c2ssockport);
if (extended) {
log_println(1, " -- c2s ext -- duration = %d", options->c2s_duration);
log_println(1,
" -- c2s ext -- throughput snapshots: enabled = %s, "
"delay = %d, offset = %d",
options->c2s_throughputsnaps ? "true" : "false",
options->c2s_snapsdelay, options->c2s_snapsoffset);
log_println(1, " -- c2s ext -- number of streams: %d",
options->c2s_streamsnum);
}
pair.port1 = testOptions->c2ssockport;
pair.port2 = -1;
log_println(
1, "listening for Inet connection on testOptions->c2ssockfd, fd=%d",
testOptions->c2ssockfd);
log_println(
1, "Sending 'GO' signal, to tell client %d to head for the next test",
testOptions->child0);
snprintf(buff, sizeof(buff), "%d", testOptions->c2ssockport);
if (extended) {
snprintf(buff, sizeof(buff), "%d %d %d %d %d %d",
testOptions->c2ssockport, options->c2s_duration,
options->c2s_throughputsnaps, options->c2s_snapsdelay,
options->c2s_snapsoffset, options->c2s_streamsnum);
lastThroughputSnapshot = NULL;
}
// send TEST_PREPARE message with ephemeral port detail, indicating start
// of tests
if ((msgretvalue = send_json_message_any(
ctl, TEST_PREPARE, buff, strlen(buff),
testOptions->connection_flags, JSON_SINGLE_VALUE)) < 0) {
log_println(2, "Child %d could not send details about ephemeral port",
getpid());
return msgretvalue;
}
// Wait on listening socket and read data once ready.
// Retry 5 times, waiting for activity on the socket
clilen = sizeof(cli_addr);
log_println(6, "child %d - sent c2s prepare to client",
testOptions->child0);
FD_ZERO(&rfd);
FD_SET(testOptions->c2ssockfd, &rfd);
sel_tv.tv_sec = 5;
sel_tv.tv_usec = 0;
if (extended) {
streamsNum = options->c2s_streamsnum;
testDuration = options->c2s_duration / 1000.0;
}
conn_index = 0;
for (attempts = 0;
attempts < RETRY_COUNT * streamsNum && conn_index < streamsNum;
attempts++) {
msgretvalue = select((testOptions->c2ssockfd) + 1, &rfd, NULL, NULL,
&sel_tv); // TODO
// socket interrupted. continue waiting for activity on socket
if ((msgretvalue == -1) && (errno == EINTR)) {
continue;
}
if (msgretvalue == 0) // timeout
retvalue = -SOCKET_CONNECT_TIMEOUT;
if (msgretvalue < 0) // other socket errors. exit
retvalue = -errno;
if (!retvalue) {
// If a valid connection request is received, client has connected.
// Proceed.
c2s_conns[conn_index].socket = accept(
testOptions->c2ssockfd,
(struct sockaddr *)&cli_addr[conn_index],
&clilen);
// socket interrupted, wait some more
if ((c2s_conns[conn_index].socket == -1) && (errno == EINTR)) {
log_println(
6,
"Child %d interrupted while waiting for accept() to complete",
testOptions->child0);
continue;
}
if (c2s_conns[conn_index].socket <= 0) {
continue;
}
log_println(6, "accept(%d/%d) for %d completed", conn_index + 1,
streamsNum, testOptions->child0);
// log protocol validation indicating client accept
protolog_procstatus(testOptions->child0, testids, CONNECT_TYPE,
PROCESS_STARTED, c2s_conns[conn_index].socket);
if (testOptions->connection_flags & TLS_SUPPORT) {
errno = setup_SSL_connection(&c2s_conns[conn_index], ctx);
if (errno != 0) return -errno;
}
// To preserve user privacy, make sure that the HTTP header
// processing is done prior to the start of packet capture, as many
// browsers have headers that uniquely identify a single user.
if (testOptions->connection_flags & WEBSOCKET_SUPPORT) {
if (initialize_websocket_connection(&c2s_conns[conn_index], 0, "c2s") !=
0) {
close_all_connections(c2s_conns, streamsNum);
return -EIO;
}
}
conn_index++;
}
if (retvalue) {
log_println(
6,
"------- C2S connection setup for %d returned because (%d)",
testOptions->child0, retvalue);
close_all_connections(c2s_conns, streamsNum);
return retvalue;
}
}
// If we haven't created enough streams after the loop is over, quit.
if (conn_index != streamsNum) {
log_println(
6,
"c2s child %d, unable to open connection, return from test",
testOptions->child0);
close_all_connections(c2s_conns, streamsNum);
return RETRY_EXCEEDED_WAITING_DATA;
}
// Get address associated with the throughput test. Used for packet tracing
log_println(6, "child %d - c2s ready for test with fd=%d",
testOptions->child0, c2s_conns[0].socket);
// commenting out below to move to init_pkttrace function
I2Addr src_addr = I2AddrByLocalSockFD(get_errhandle(), c2s_conns[0].socket, 0);
// Get tcp_stat connection. Used to collect tcp_stat variable statistics
conn = tcp_stat_connection_from_socket(agent, c2s_conns[0].socket);
// set up packet tracing. Collected data is used for bottleneck link
// calculations
if (getuid() == 0) {
if (pipe(mon_pipe) != 0) {
log_println(0, "C2S test error: can't create pipe.");
} else {
if ((c2s_childpid = fork()) == 0) {
close(testOptions->c2ssockfd);
close_all_connections(c2s_conns, streamsNum);
// Don't capture more than 14 seconds of packet traces:
// 2 seconds of sleep + 10 seconds of test + 2 seconds of slop
alarm(testDuration + RACE_CONDITION_WAIT_TIME + 2);
log_println(
5,
"C2S test Child %d thinks pipe() returned fd0=%d, fd1=%d",
testOptions->child0, mon_pipe[0], mon_pipe[1]);
log_println(2, "C2S test calling init_pkttrace() with pd=%p",
&cli_addr[0]);
init_pkttrace(src_addr, cli_addr, streamsNum, clilen,
mon_pipe, device, &pair, "c2s", options->c2s_duration / 1000.0);
log_println(1, "c2s is exiting gracefully");
/* Close the pipe */
close(mon_pipe[0]);
close(mon_pipe[1]);
exit(0); /* Packet trace finished, terminate gracefully */
} else if (c2s_childpid < 0) {
log_println(0, "C2S test error: can't create child process.");
}
}
packet_trace_running = wait_for_readable_fd(mon_pipe[0]);
if (packet_trace_running) {
// Get data collected from packet tracing into the C2S "ndttrace" file
memset(tmpstr, 0, 256);
for (i = 0; i < 5; i++) {
msgretvalue = read(mon_pipe[0], tmpstr, 128);
if ((msgretvalue == -1) && (errno == EINTR))
continue;
break;
}
if (strlen(tmpstr) > 5)
memcpy(meta.c2s_ndttrace, tmpstr, strlen(tmpstr));
// name of nettrace file passed back from pcap child
log_println(3, "--tracefile after packet_trace %s",
meta.c2s_ndttrace);
} else {
log_println(0, "Packet trace was unable to be created");
packet_trace_emergency_shutdown(mon_pipe);
}
}
log_println(5, "C2S test Parent thinks pipe() returned fd0=%d, fd1=%d",
mon_pipe[0], mon_pipe[1]);
// experimental code, delete when finished
setCwndlimit(conn, group, agent, options);
// Create C->S snaplog directories, and perform some initialization based on
// options
create_client_logdir((struct sockaddr *) &cli_addr[0], clilen,
options->c2s_logname, sizeof(options->c2s_logname),
namesuffix, sizeof(namesuffix));
sleep(RACE_CONDITION_WAIT_TIME);
// Reset alarm() again. This 10 sec test should finish before this signal is
// generated, but sleep() can render existing alarm()s invalid, and alarm() is
// our watchdog timer.
alarm(30);
// send empty TEST_START indicating start of the test
send_json_message_any(ctl, TEST_START, "", 0, testOptions->connection_flags,
JSON_SINGLE_VALUE);
// If snaplog recording is enabled, update meta file to indicate the same
// and proceed to get snapshot and log it.
// This block is needed here since the meta file stores names without the
// full directory but fopen needs full path. Else, it could have gone into
// the "start_snap_worker" method
if (options->snapshots && options->snaplog) {
memcpy(meta.c2s_snaplog, namesuffix, strlen(namesuffix));
/*start_snap_worker(&snapArgs, agent, options->snaplog, &workerLoop,
&workerThreadId, meta.c2s_snaplog, options->c2s_logname,
conn, group); */
}
if (options->snapshots)
start_snap_worker(&snapArgs, agent, NULL, options->snaplog, &workerThreadId,
options->c2s_logname, conn, group);
// Wait on listening socket and read data once ready.
start_time = secs();
throughputSnapshotTime = start_time + (options->c2s_snapsoffset / 1000.0);
activeStreams = connections_to_fd_set(c2s_conns, streamsNum, &rfd, &max_fd);
while (activeStreams > 0 && (secs() - start_time) < testDuration) {
// POSIX says "Upon successful completion, the select() function may
// modify the object pointed to by the timeout argument."
// Therefore sel_tv is undefined afterwards and we must set it every time.
sel_tv.tv_sec = testDuration + 1; // time out after test duration + 1sec
sel_tv.tv_usec = 0;
msgretvalue = select(max_fd + 1, &rfd, NULL, NULL, &sel_tv);
if (msgretvalue == -1) {
if (errno == EINTR) {
// select interrupted. Continue waiting for activity on socket
continue;
} else {
log_println(1,
"Error while trying to wait for incoming data in c2s: %s",
strerror(errno));
break;
}
}
if (extended && options->c2s_throughputsnaps && secs() > throughputSnapshotTime) {
if (lastThroughputSnapshot != NULL) {
lastThroughputSnapshot->next = (struct throughputSnapshot*) malloc(sizeof(struct throughputSnapshot));
lastThroughputSnapshot = lastThroughputSnapshot->next;
} else {
*c2s_ThroughputSnapshots = lastThroughputSnapshot = (struct throughputSnapshot*) malloc(sizeof(struct throughputSnapshot));
}
lastThroughputSnapshot->next = NULL;
lastThroughputSnapshot->time = secs() - start_time;
lastThroughputSnapshot->throughput = (8.e-3 * bytes_read) / (lastThroughputSnapshot->time); // kbps
log_println(6, " ---C->S: Throughput at %0.2f secs: Received %0.0f bytes, Spdin= %f",
lastThroughputSnapshot->time, bytes_read, lastThroughputSnapshot->throughput);
throughputSnapshotTime += options->c2s_snapsdelay / 1000.0;
}
if (msgretvalue > 0) {
read_error = read_ready_streams(&rfd, c2s_conns, streamsNum, buff, sizeof(buff), &bytes_read);
if (read_error != 0 && read_error != EINTR) {
// EINTR is expected, but all other errors are actually errors
log_println(1, "Error while trying to read incoming data in c2s: %s",
strerror(read_error));
break;
}
}
// Set up the FD_SET and activeStreams for the next select.
activeStreams = connections_to_fd_set(c2s_conns, streamsNum, &rfd, &max_fd);
}
measured_test_duration = secs() - start_time;
// From the NDT spec:
// throughput in kilo bits per sec =
// (transmitted_byte_count * 8) / (time_duration)*(1000)
*c2sspd = (8.0e-3 * bytes_read) / measured_test_duration;
// As a kindness to old clients, drain their queues for a second or two.
// TODO: Fix web100clt code to eliminate the need for this. In general,
// clients that need this line should be removed from their respective
// gene pools and this code should be deleted.
drain_old_clients(c2s_conns, streamsNum, buff, sizeof(buff));
// c->s throuput value calculated and assigned ! Release resources, conclude
// snap writing.
if (options->snapshots)
stop_snap_worker(&workerThreadId, options->snaplog, &snapArgs);
// send the server calculated value of C->S throughput as result to client
snprintf(buff, sizeof(buff), "%6.0f kbps outbound for child %d", *c2sspd,
testOptions->child0);
log_println(1, "%s", buff);
snprintf(buff, sizeof(buff), "%0.0f", *c2sspd);
if (extended && options->c2s_throughputsnaps && *c2s_ThroughputSnapshots != NULL) {
struct throughputSnapshot *snapshotsPtr = *c2s_ThroughputSnapshots;
while (snapshotsPtr != NULL) {
int currBuffLength = strlen(buff);
snprintf(&buff[currBuffLength], sizeof(buff)-currBuffLength, " %0.2f %0.2f", snapshotsPtr->time, snapshotsPtr->throughput);
snapshotsPtr = snapshotsPtr->next;
}
}
send_json_message_any(ctl, TEST_MSG, buff, strlen(buff),
testOptions->connection_flags, JSON_SINGLE_VALUE);
// get receiver side Web100 stats and write them to the log file. close
// sockets
if (record_reverse == 1)
tcp_stat_get_data_recv(c2s_conns[0].socket, agent, conn, count_vars);
close_all_connections(c2s_conns, streamsNum);
close(testOptions->c2ssockfd);
if (packet_trace_running) {
log_println(1, "Signal USR1(%d) sent to child [%d]", SIGUSR1,
c2s_childpid);
testOptions->child1 = c2s_childpid;
kill(c2s_childpid, SIGUSR1);
i = 0;
for (;;) {
FD_ZERO(&rfd);
FD_SET(mon_pipe[0], &rfd);
sel_tv.tv_sec = 1;
sel_tv.tv_usec = 100000;
msgretvalue = select(mon_pipe[0] + 1, &rfd, NULL, NULL, &sel_tv);
if (msgretvalue <= 0) {
local_errno = (msgretvalue == -1) ? errno : 0;
if (local_errno == EINTR) continue;
// Either a timeout or an error that wasn't EINTR...
log_println(4, "Failed to read pkt-pair data from C2S flow, "
"retcode=%d, reason=%d", msgretvalue, local_errno);
snprintf(spds[(*spd_index)++],
sizeof(spds[*spd_index]),
" -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 0.0 0 0 0 0 0 -1");
snprintf(spds[(*spd_index)++],
sizeof(spds[*spd_index]),
" -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 0.0 0 0 0 0 0 -1");
break;
} else {
/* There is something to read, so get it from the pktpair child. If an
* interrupt occurs, just skip the read and go on
* RAC 2/8/10
*/
if ((msgretvalue = read(mon_pipe[0], spds[*spd_index],
sizeof(spds[*spd_index]))) < 0) {
snprintf(
spds[*spd_index],
sizeof(spds[*spd_index]),
" -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 0.0 0 0 0 0 0 -1");
}
log_println(1, "%d bytes read '%s' from C2S monitor pipe",
msgretvalue, spds[*spd_index]);
(*spd_index)++;
if (i++ == 1) break;
}
}
}
// An empty TEST_FINALIZE message is sent to conclude the test
send_json_message_any(ctl, TEST_FINALIZE, "", 0,
testOptions->connection_flags, JSON_SINGLE_VALUE);
// Close opened resources for packet capture
if (packet_trace_running) {
// TODO: Determine whether this shutdown can be performed in a non-blocking
// manner, and if so then refactor packet_trace_emergency_shutdown to have
// better error handling and use that refactored and renamed function here.
stop_packet_trace(mon_pipe);
packet_trace_running = 0;
}
// log end of C->S test
log_println(1, " <----------- %d -------------->", testOptions->child0);
// protocol logs
teststatuses = TEST_ENDED;
protolog_status(testOptions->child0, testids, teststatuses, ctl->socket);
// set current test status and free address
setCurrentTest(TEST_NONE);
return 0;
}