perfstat.c revision 7c478bd95313f5f23a4c958a745db2134aa03244
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 1997 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
/* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
/* All Rights Reserved */
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* This module is intended to collect performance statistics about the
* operation of uucico. All instances of uucico will write their log
* entries to the files who's path is defined by PERFLOG. Statistics
* will only be collected if PERFLOG exists when uucico starts, it will
* not be created automatically. This gives the SA an easy way to turn
* statistics collection on or off at run time. Three types
* of records will be written to the file, and each record will be
* identified by a mnemonic type at the begining of the record. The record
* types are as follows:
*
* conn - Contains statistics about the establishment of
* a connection.
*
* xfer - Contains statistics about a file transfer.
*
* The intention is to use grep to select the conn and xfer records and put
* them in two Unity data bases. No attempt will be made to process the
* error records with Unity.
*
* Both the conn and the xfer records will contain a time stamp field.
* This field will be written in case there is a desire to do time of
* day traffic studies. The time that will be written will be GMT
* to avoid the vagaries of time zone setting for uucico. The time
* stamp will contain 12 digits of the form YYMMDDhhmmss. This allows
* proper sorting by time, and the fixed length field type of Unity
* can be used to pick it apart if necessary. The time stamp is the
* time that the record is written.
*
* Statistics will be collected on the wall clock (real) time to perform
* an action and CPU consumption to perform an action. These times will
* be written in seconds and fractions of a second to two decimal places.
*
* The conn and xfer records will be written so that they can be processed
* with the following Unity schema (D files). For those not familiar with
* Unity, the columns are:
*
* column 1 - field name
* column 2 - field type (t=variable width) and field separator.
* column 3 - number of columns to use when printing the field
* with uprint.
* column 4 - a user friendly field name.
*
* Conn:
*
* type t| 4 record type (always conn)
* ts t| 12 time stamp
* procid t| 5 uucico's process id
* myname t| 6 name of the machine where the record is written
* role t| 1 M = master, S = slave
* remote t| 6 name of remote system
* device t| 6 name of device used for connection
* protocol t| 1 the protocal that is used for communication
* netid t| 6 physical network ID
* real t| 6 real time to connect
* user t| 6 user time to connect
* sys t\n 6 system (kernal) time to connect
*
* The timer for connection processing starts immediately after the
* command line processing is complete, and it is stopped after the
* protocol has been selected.
*
* Xfer:
*
* type t| 4 record type (always xfer)
* jobgrade t| 1 job grade ID
* ts t| 12 time stamp
* procid t| 5 uucico's process id
* myname t| 6 name of the machine where the record is written
* role t| 1 M = master, S = slave
* remote t| 6 name of remote system
* device t| 6 name of device used for connection
* protocol t| 1 the protocal that is used for communication
* netid t| 6 physical network ID
* job t| 7 name of the job. (Master only).
* inqueue t| 6 time in seconds that file was in queue (Master
* only).
* tat t| 6 turn around time in sec. (Master only).
* bytes t| 6 size of the file that was transferred
* flags t| 3 m = mail to requester on completion,
* n = notify remote user, s = write status
* file. (Master only).
* streal t| 6 real time to start up transfer (master only).
* stuser t| 6
* stsys t| 6
* xfrreal t| 6 real time to transfer file
* xfruser t| 6
* xfrsys t| 6
* trmreal t| 6 real time to terminate the transfer
* trmuser t| 6
* trmsys t| 6
* text t| 12 "PARTIAL FILE" if the data is being transmitted
* before breaking the transmission; blank if the
* partial file after the breakpoint or the whole
* file is being transmitted completely.
*
* Start up time includes the time for the master to search the queues
* for the next file, for the master and slave to exchange work vectors,
* and time to open files. It is only recorded on the master.
* Xfer times is the time to transfer the data, close the file, and
* exchange confirmation messages. Termination time is the time to send
* mail notifications and write status files. Turn around time is the
* difference between the time that the file was queued and the time that
* the final notification was sent.
*/
#include "uucp.h"
#include "log.h"
/*
* SYMBOL DEFINITIONS
*/
(Collecting == FALSE)) return; }
/* Subscripts for connection time marks: */
#define CT_START 0 /* Start connection establishment. */
/* Subscripts for xfer time marks: */
#define XT_LOOK 0 /* Start looking for a file (master only). */
/*
* STRUCTURE DEFINITIONS
*/
typedef struct timeUsed /* Time consummed between events. */
{
float tu_real; /* Real time used. */
float tu_user; /* User time used. */
float tu_sys; /* System time used. */
} TUSED;
typedef struct timeMark /* Holds times for an event. */
{
int tm_valid; /* True if data present. */
long tm_real; /* Relative wall clock. */
} TMARK;
struct connData /* Data for construction of conn record. */
{
};
struct xferData /* Data for construction of xfer record. */
{
char xf_direction; /* Send/receive indicator. */
* in the queue. (master
* only). */
long xf_deque; /* Time that file was
* dequeued. (master only)*/
long xf_filedone; /* Time that file was
* completed. */
};
/*
* LOCAL DATA
*/
* data. */
* device. */
* initialized. */
. */
/* Messages: */
static char Msg_badopen[] = "failed to open %s. Errno=%%d\n";
static char Msg_opening[] = "attempting to open %s\n";
static char Msg_write[] = "error in writing to %s. Errno=%%d.\n";
/*
* LOCAL FUNCTIONS
*/
/* Declarations of functions: */
STATIC_FUNC void grabTimes();
STATIC_FUNC void pfloat();
STATIC_FUNC void reportConn();
STATIC_FUNC void reportFile();
STATIC_FUNC void reportTimes();
STATIC_FUNC void subTimes();
/*
* Local Function: grabTimes - Get Real and CPU Times
*
* This function uses times(2) to obtain the current real time and CPU
* consumption. The time mark is also marked as valid.
*
* Parameters:
*
* markptr - Address of structure to save times.
*
* Return:
*
* none.
*/
STATIC_FUNC void
{
return;
}
/*
* Local Function: pfloat - Print a Floating Number
*
* Format a floating point number for output to the Unity data base.
* If the number is NOTIME, "na" will be displayed instead.
*
* Parameters:
*
* dest - The result will be concatenated to this string.
*
* number - The number to be formated.
*
* sep - Field separator character.
*/
STATIC_FUNC void
char * dest;
double number; /* float is promoted to double for args. */
char sep;
{
static char rformat[] = "%c%.2f";
static char naformat[] = "%c%s";
register char * cp;
else
return;
}
/*
* Local Function: reportConn - Write Out Conn Record
*
* This function writes a conn record to the logfile.
*
* Parameters:
*
* None.
*
* Returns:
*
* None.
*/
STATIC_FUNC void
reportConn ()
{
static char format[] = "%s%c%s%c%ld%c%s%c%c%c%s%c%s%c%s%c%s";
Netid /* Network ID */
);
return;
}
/*
* Local Function: reportFile - Write File Statistics to Log
*
* This function writes statistics about the current file to the log
* file.
*
* Parameters:
*
* none.
*/
STATIC_FUNC void
char * breakmsg;
{
/* minuend, subtrahand */
static int drvtab[] = {
};
static char format1[] = "%s%c%s%c%s%c%ld%c%s%c%c%c%s%c%s%c%s%c%s%c%s";
register int i;
float inque; /* time in queue. */
int lastbyte; /* Offset to last byte in Record. */
float tat; /* Turn around time. */
);
/* Do time in queue and turn around time. */
{
} else
{
}
/*
* Report bytes transferred and notification flags.
*/
);
/*
* Report resource consumption for file startup, file transfer,
* and file termination. This means reporting the differences
* between pairs of elements in the xf_times array of Xfer. This
* will be controled by drvtab which contains pairs of subscripts
* to designate the xf_times elements.
*/
for (i = 0; i < sizeof(drvtab)/(sizeof(int)); i += 2)
{
}
/*
* write file status
*/
/* Terminate the record and write it out. */
return;
}
/*
* Local Function: reportTimes - Print Real, User, and Sys Times
*
* This function is used to convert the real, user, and system times from
* a TUSED structure to Ascii strings. The results are concatenated to
* the dest string. If any of the times are NOTIME, they will be reported
* as "na". The fields will be seperated by the sep character and the
* sep character will be the first character concatenated to the buffer. No
* seperator character will be placed at the end. Thus, the output string
* will be of the form:
*
* |real|user|sys
*
* Parameters:
*
* dest - String to receive Ascii times.
*
* diffptr - Address of the time data.
*
* sep - The field seperator character.
*/
STATIC_FUNC void
register char * dest;
char sep;
{
return;
}
/*
* Local Function: subTimes - Subtract Times Between Events
*
* This function takes the output from two calls to times(2) in the form
* of two TMARK structures, and determines the amount of time consummed
* for various categories. The result is stored in the specified
* TUSED structure.
*
* Parameters:
*
* diff - Place to store the result of the subtraction.
* minuend - The second time event.
* subtra - The subtrahend in the subtraction. This should
* be the first of two time events.
*
* On the large scale this function does the following:
*
* diff = minuend - subtra
*/
STATIC_FUNC void
{
long ltemp; /* Temporary storage for long arith. */
float ticks; /* Clock interrupts per second. */
{ /* If data has not been collected. */
} else
{
/* Calculate real time. */
/* Calculate user time. */
+ mintms->tms_cutime
- subtms->tms_cutime;
/* Calculate user time. */
+ mintms->tms_cstime
- subtms->tms_cstime;
}
return;
}
/*
* EXTERNAL FUNCTIONS
*/
/*
* Function: gmt - Generate Current Time String
*
* This function returns the address a string containing the current
* GMT in the form YYMMDDhhmmss.
*
* Parameters:
*
* none
*
* Return:
*
* An address of a static character array containing the date.
*/
char *
gmt()
{
static char date[] = "YYMMDDhhmmss";
);
return date;
}
/*
* Function: writeLog - Write String to Log File
*
* After insuring that the log file is open, this function will write
* the specified string to the log file. If a write error occurs,
* statistics collection will be disabled.
*
* Parameters:
*
* string - Null terminated string to be written out.
* logfile - file descripter
* logname - name of log file.
*/
void
char * string;
int * logfile;
char * logname;
int * collecting;
{
register int length; /* Length of the string. */
register int rv; /* Return value from write. */
*collecting = FALSE;
return;
}
do
{
{ /* Error or incomplete output. */
/* If we had a write error, lets give up on loggine. */
*collecting = FALSE;
}
return;
}
/*
* Function: closeLog - Close the Log File
*
* This function allows uucico to close the log file in preparation for
* forking.
*
* Parameters:
*
* log file descriptor
*/
void
int *logfile;
{
{
}
return;
}
/*
* Function: copyText - Copy String to Dynamic Memory
*
* This function copies a string to a buffer. It insures that there is
* no overflow of the buffer and that the result is null terminated.
*
* Parameters:
*
* tptr - address of the buffer where the string is to
* be stored.
*
* size - number of bytes in the buffer.
*
* string - string to be saved.
*
* Returns:
*
* none.
*/
void
register char * tptr;
register int size;
char * string;
{
return;
}
/*
* Function: pfConnected - Report Connection Completion
*
* Uucico uses pfConnected to tell this performance package that a connection
* has been established with the remote system.
*
* Parameters:
*
* remote - name of the remote system.
*
* device - the type of device being used for communicaitons.
*/
void
char * remote;
char * device;
{
register int i;
reportConn();
/*
* Mark connection times as invalid. This is really unnecessary
* since there should only be one connection per invocation of uucico.
* We do it for consistency with use of the transfer data.
*/
return;
}
/*
* Function: pfEndFile - Report End of File
*
* Uucico uses pfEndFile to tell our statistics collection package that
* all processing has been finished on the current file. PfEndfile should
* be called after all notifications have been done and after the status
* file has been written. PfEndfile writes out a xfer record for the
* file that just completed.
*
* Parameters:
*
* none
*/
void
char * breakmsg;
{
register int i;
/* Now that we have reported them, mark all times as invalid. */
return;
}
/*
* Function: pfEndXfer - File Transfer Complete
*
* Calling pfEndXfer tells the performance package that a file transfer
* has been completed. It should be called after the destination site
* closes the file and confirms receipt, but before notifications are done.
*
* Parameters:
*
* none
*/
void
pfEndXfer ()
{
return;
}
/*
* Function: pfFindFile - Looking for Another File
*
* Uucico uses pfFindFile to announce that it is going to explore the
* queues for another file transfer to do. PfFindFile is only called
* when uucico is in the role of master.
*
* Parameters:
*
* none
*/
void
pfFindFile ()
{
return;
}
/*
* Function: pfFound - Found Another File
*
* PfFound is a counterpart of pfFindFile. It is called when a new file
* has been found. Like pfFindFile it is called only by a master uucico.
*
* Parameters:
*
* jobid - The name of the job that was found.
*
* flags - Options flags that were stored in the queue.
* These flags are originally set by uucp.
*
* intoQue - The time that the C. file was placed in the queue.
*/
void
char * jobid;
char * flags;
{
/* Save time that file was placed in queue and current time. */
return;
}
/*
* Function: pfInit - Initialize Performance Package
*
* This function allows the performance package to initialize its internal
* data structures. It should be called one time only when uucico starts
* running.
*
* Parameters:
*
* none
*/
void
pfInit ()
{
if (Initialized == TRUE)
return;
/*
* Attempt to open the log file. If we can't do it, then we
* won't collect statistics.
*/
Collecting = TRUE;
else
Collecting = FALSE;
Initialized = TRUE;
return;
}
/*
* Function: pfStrtConn - Going to Establish Connection
*
* Uucico uses pfStrtConn to announce that it is going to attempt
* to establish a connection.
*
* Parameters:
*
* role - An indication of whether uucico is currently
* running in master or slave mode. M = master,
* S = slave.
*/
void
char role;
{
return;
}
/*
* Function: pfStrtXfer - Starting File Transfer
*
* This function should be called just as the first byte of data is
* about to be transferred.
*
* Parameters:
*
* role - An indication of whether uucico is currently
* running in master or slave mode. M = master,
* S = slave.
*
* direction - Direction of file transfer. S = sending to
* remote, R = receiving from remote.
*/
void
char role;
char direction;
{
return;
}
/*
A protocol which both master and slave sides agree on
*/
void
char *str;
{
return;
}
/*
* Function: openLog - Open the Log File
*
* If the log file is already open this function immediately returns
* success. Otherwise, an attempt is made to open the logfile in append
* mode.
*
* Parameters:
*
* logfile - file descripter
* logname - name of log file.
*
* Returns:
*
* SUCCESS - The log file is open.
* FAIL - Unable to open logfile.
*/
int
int *logfile;
char *logname;
{
register int fd; /* File descriptor of log file. */
int level; /* Level for debug message. */
/* See if file already open. */
return (SUCCESS);
/* Attempt to open the file. */
do
{
if (fd < 0) { /* Error on open. */
* it will usually mean
* that the SA doesn't
* want to collect
* statisitcs. */
else
return FAIL;
} else {
return SUCCESS;
}
}
#ifdef BSD4_2
#include <sys/resource.h>
static clock_t
{
}
{
return (clock_t)(-1);
return (clock_t)(-1);
return (clock_t)(-1);
if (epoch == 0)
}
#endif /* BSD4_2 */