2 * tapestat: report tape statistics
3 * (C) 2015 Hewlett-Packard Development Company, L.P.
5 * Initial revision by Shane M. SEYMOUR (shane.seymour <at> hpe.com)
6 * Modified for sysstat by Sebastien GODARD (sysstat <at> orange.fr)
8 ***************************************************************************
9 * This program is free software; you can redistribute it and/or modify it *
10 * under the terms of the GNU General Public License as published by the *
11 * Free Software Foundation; either version 2 of the License, or (at your *
12 * option) any later version. *
14 * This program is distributed in the hope that it will be useful, but *
15 * WITHOUT ANY WARRANTY; without the implied warranty of MERCHANTABILITY *
16 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License *
19 * You should have received a copy of the GNU General Public License along *
20 * with this program; if not, write to the Free Software Foundation, Inc., *
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA *
22 ***************************************************************************
31 #define __DO_NOT_DEFINE_COMPILE
38 #include <sys/utsname.h>
39 #include <sys/param.h>
40 #undef HZ /* sys/param.h defines HZ but needed for MAXPATHLEN */
50 #define _(string) gettext(string)
52 #define _(string) (string)
55 #define SCCSID "@(#)sysstat-" VERSION ": " __FILE__ " compiled " __DATE__ " " __TIME__
56 char *sccsid(void) { return (SCCSID); }
58 int cpu_nr = 0; /* Nb of processors on the machine */
59 int flags = 0; /* Flag for common options and system state */
64 struct sigaction alrm_act;
67 * For tape stats - it would be extremely rare for there to be a very large
68 * number of tape drives attached to a system. I wouldn't expect to see more
69 * than 20-30 in a very large configuration and discontinguous ones should
70 * be even more rare. Because of this we keep the old and new data in a
71 * simple data structure with the tape index being the number after the tape
72 * drive, st0 at index 0, etc.
74 int max_tape_drives = 0;
75 struct tape_stats *tape_new_stats = { NULL };
76 struct tape_stats *tape_old_stats = { NULL };
80 ***************************************************************************
81 * Print usage and exit.
84 * @progname Name of sysstat command.
85 ***************************************************************************
87 void usage(char *progname)
89 fprintf(stderr, _("Usage: %s [ options ] [ <interval> [ <count> ] ]\n"),
91 fprintf(stderr, _("Options are:\n"
92 "[ -k | -m ] [ -t ] [ -V ] [ -y ] [ -z ]\n"));
97 ***************************************************************************
98 * SIGALRM signal handler. No need to reset the handler here.
101 * @sig Signal number.
102 ***************************************************************************
104 void alarm_handler(int sig)
110 ***************************************************************************
112 ***************************************************************************
114 void tape_initialise(void)
116 /* How many processors on this machine? */
117 cpu_nr = get_cpu_nr(~0, FALSE);
119 /* Compile regular expression for tape names */
120 if (regcomp(&tape_reg, "^st[0-9]+$", REG_EXTENDED) != 0) {
126 ***************************************************************************
128 ***************************************************************************
130 void tape_uninitialise(void)
133 if (tape_old_stats != NULL) {
134 free(tape_old_stats);
136 if (tape_new_stats != NULL) {
137 free(tape_new_stats);
142 ***************************************************************************
143 * Get maximum number of tapes in the system.
146 * Number of tapes found.
147 ***************************************************************************
149 int get_max_tape_drives(void)
152 struct dirent *entry;
153 int new_max_tape_drives, tmp, num_stats_dir = 0;
155 char stats_dir[MAXPATHLEN + 1];
156 struct stat stat_buf;
158 new_max_tape_drives = max_tape_drives;
160 /* Open sysfs tree */
161 dir = opendir(SYSFS_CLASS_TAPE_DIR);
165 while ((entry = readdir(dir)) != NULL) {
166 if (regexec(&tape_reg, &entry->d_name[0], 1, &match, 0) == 0) {
167 /* d_name[2] to skip the st at the front */
168 tmp = atoi(&entry->d_name[2]) + 1;
169 if (tmp > new_max_tape_drives) {
170 new_max_tape_drives = tmp;
173 snprintf(stats_dir, MAXPATHLEN, "%s/%s/%s",
174 SYSFS_CLASS_TAPE_DIR, &entry->d_name[0], "stats");
175 if (stat(stats_dir, &stat_buf) == 0) {
176 if (S_ISDIR(stat_buf.st_mode)) {
183 /* If there are no stats directories make the new number of tape drives 0 */
184 if (num_stats_dir == 0) {
185 new_max_tape_drives = 0;
188 return new_max_tape_drives;
192 ***************************************************************************
193 * Check if new tapes have been added and reallocate structures accordingly.
194 ***************************************************************************
196 void tape_check_tapes_and_realloc(void)
198 int new_max_tape_drives, i;
200 /* Count again number of tapes */
201 new_max_tape_drives = get_max_tape_drives();
203 if (new_max_tape_drives > max_tape_drives && new_max_tape_drives > 0) {
204 /* New tapes found: Realloc structures */
205 struct tape_stats *tape_old_stats_t = (struct tape_stats *)
206 realloc(tape_old_stats, sizeof(struct tape_stats) * new_max_tape_drives);
207 struct tape_stats *tape_new_stats_t = (struct tape_stats *)
208 realloc(tape_new_stats, sizeof(struct tape_stats) * new_max_tape_drives);
209 if ((tape_old_stats_t == NULL) || (tape_new_stats_t == NULL)) {
210 if (tape_old_stats_t != NULL) {
211 free(tape_old_stats_t);
212 tape_old_stats_t = NULL;
214 free(tape_old_stats);
215 tape_old_stats = NULL;
217 if (tape_new_stats_t != NULL) {
218 free(tape_new_stats_t);
219 tape_new_stats_t = NULL;
221 free(tape_new_stats);
222 tape_new_stats = NULL;
229 tape_old_stats = tape_old_stats_t;
230 tape_new_stats = tape_new_stats_t;
232 for (i = max_tape_drives; i < new_max_tape_drives; i++) {
233 tape_old_stats[i].valid = TAPE_STATS_INVALID;
234 tape_new_stats[i].valid = TAPE_STATS_INVALID;
236 max_tape_drives = new_max_tape_drives;
241 ***************************************************************************
242 * Collect initial statistics for all existing tapes in the system.
243 * This function should be called only once.
244 ***************************************************************************
246 void tape_gather_initial_stats(void)
248 int new_max_tape_drives, i;
250 char filename[MAXPATHLEN + 1];
252 /* Get number of tapes in the system */
253 new_max_tape_drives = get_max_tape_drives();
255 if (new_max_tape_drives == 0) {
257 fprintf(stderr, _("No tape drives with statistics found\n"));
261 /* Allocate structures */
262 if (tape_old_stats == NULL) {
263 tape_old_stats = (struct tape_stats *)
264 malloc(sizeof(struct tape_stats) * new_max_tape_drives);
265 tape_new_stats = (struct tape_stats *)
266 malloc(sizeof(struct tape_stats) * new_max_tape_drives);
267 for (i = 0; i < new_max_tape_drives; i++) {
268 tape_old_stats[i].valid = TAPE_STATS_INVALID;
269 tape_new_stats[i].valid = TAPE_STATS_INVALID;
271 max_tape_drives = new_max_tape_drives;
273 /* This should only be called once */
277 /* Read stats for each tape */
278 for (i = 0; i < max_tape_drives; i++) {
280 * Everything starts out valid but failing to open
281 * a file gets the tape drive marked invalid.
283 tape_new_stats[i].valid = TAPE_STATS_VALID;
284 tape_old_stats[i].valid = TAPE_STATS_VALID;
286 gettimeofday(&tape_old_stats[i].tv, NULL);
288 tape_new_stats[i].tv.tv_sec = tape_old_stats[i].tv.tv_sec;
289 tape_new_stats[i].tv.tv_usec = tape_old_stats[i].tv.tv_usec;
291 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_ns", read_time)
292 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_ns", write_time)
293 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "io_ns", other_time)
294 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_byte_cnt", read_bytes)
295 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_byte_cnt", write_bytes)
296 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_cnt", read_count)
297 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_cnt", write_count)
298 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "other_cnt", other_count)
299 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "resid_cnt", resid_count)
301 tape_old_stats[i].read_time = 0;
302 tape_old_stats[i].write_time = 0;
303 tape_old_stats[i].other_time = 0;
304 tape_old_stats[i].read_bytes = 0;
305 tape_old_stats[i].write_bytes = 0;
306 tape_old_stats[i].read_count = 0;
307 tape_old_stats[i].write_count = 0;
308 tape_old_stats[i].other_count = 0;
309 tape_old_stats[i].resid_count = 0;
314 ***************************************************************************
315 * Collect a new sample of statistics for all existing tapes in the system.
316 ***************************************************************************
318 void tape_get_updated_stats(void)
322 char filename[MAXPATHLEN + 1] = { 0 };
324 /* Check tapes and realloc structures if needed */
325 tape_check_tapes_and_realloc();
327 for (i = 0; i < max_tape_drives; i++) {
329 * Everything starts out valid but failing
330 * to open a file gets the tape drive marked invalid.
332 tape_new_stats[i].valid = TAPE_STATS_VALID;
333 gettimeofday(&tape_new_stats[i].tv, NULL);
335 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_ns", read_time)
336 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_ns", write_time)
337 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "io_ns", other_time)
338 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_byte_cnt", read_bytes)
339 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_byte_cnt", write_bytes)
340 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_cnt", read_count)
341 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_cnt", write_count)
342 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "other_cnt", other_count)
343 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "resid_cnt", resid_count)
345 if ((tape_new_stats[i].read_time < tape_old_stats[i].read_time) ||
346 (tape_new_stats[i].write_time < tape_old_stats[i].write_time) ||
347 (tape_new_stats[i].other_time < tape_old_stats[i].other_time)) {
348 tape_new_stats[i].valid = TAPE_STATS_INVALID;
354 ***************************************************************************
355 * Display tapes statistics headings.
356 ***************************************************************************
358 void tape_write_headings(void)
360 printf("Tape: r/s w/s ");
361 if (DISPLAY_MEGABYTES(flags)) {
362 printf("MB_read/s MB_wrtn/s");
364 printf("kB_read/s kB_wrtn/s");
366 printf(" %%Rd %%Wr %%Oa Rs/s Ot/s\n");
370 ***************************************************************************
371 * Calculate statistics for current tape.
374 * @i Index in array for current tape.
377 * @stats Statistics for current tape.
378 ***************************************************************************
380 void tape_calc_one_stats(struct calc_stats *stats, int i)
386 /* Duration in ms done in ms to prevent rounding issues with using seconds */
387 duration = (tape_new_stats[i].tv.tv_sec -
388 tape_old_stats[i].tv.tv_sec) * 1000;
389 duration -= tape_old_stats[i].tv.tv_usec / 1000;
390 duration += tape_new_stats[i].tv.tv_usec / 1000;
392 /* If duration is zero we need to calculate the ms since boot time */
394 fp = fopen("/proc/uptime", "r");
397 * Get uptime from /proc/uptime and if we can't then just set duration to
398 * be 0 - it will mean that we don't calculate stats.
403 if (fscanf(fp, "%lf", &temp) != 1) {
406 duration = (uint64_t) (temp * 1000);
411 /* The second value passed into the macro is the thing being calculated */
412 CALC_STAT_CNT(read_count, reads_per_second)
413 CALC_STAT_CNT(write_count, writes_per_second)
414 CALC_STAT_CNT(other_count, other_per_second)
415 CALC_STAT_KB(read_bytes, kbytes_read_per_second)
416 CALC_STAT_KB(write_bytes, kbytes_written_per_second)
417 CALC_STAT_PCT(read_time, read_pct_wait)
418 CALC_STAT_PCT(write_time, write_pct_wait)
419 CALC_STAT_PCT(other_time, all_pct_wait)
420 CALC_STAT_CNT(resid_count, resids_per_second)
424 ***************************************************************************
425 * Display statistics for current tape.
428 * @tape Statistics for current tape.
429 * @i Index in array for current tape.
430 ***************************************************************************
432 void tape_write_stats(struct calc_stats *tape, int i)
435 uint64_t divisor = 1;
437 if (DISPLAY_MEGABYTES(flags))
440 sprintf(buffer, "st%i ", i);
442 cprintf_in(IS_STR, "%s", buffer, 0);
444 tape->reads_per_second,
445 tape->writes_per_second);
447 tape->kbytes_read_per_second / divisor,
448 tape->kbytes_written_per_second / divisor);
450 (double) tape->read_pct_wait,
451 (double) tape->write_pct_wait,
452 (double) tape->all_pct_wait);
454 tape->resids_per_second,
455 tape->other_per_second);
460 ***************************************************************************
461 * Print everything now (stats and uptime).
464 * @rectime Current date and time.
465 ***************************************************************************
467 void write_stats(struct tm *rectime)
470 struct calc_stats tape;
471 struct tape_stats *tmp;
474 TEST_STDOUT(STDOUT_FILENO);
476 /* Print time stamp */
477 if (DISPLAY_TIMESTAMP(flags)) {
478 if (DISPLAY_ISO(flags)) {
479 strftime(timestamp, sizeof(timestamp), "%FT%T%z", rectime);
482 strftime(timestamp, sizeof(timestamp), "%x %X", rectime);
484 printf("%s\n", timestamp);
487 /* Print the headings */
488 tape_write_headings();
491 * If either new or old is invalid or the I/Os per second is 0 and
492 * zero omit is true then we print nothing.
494 if (max_tape_drives > 0) {
496 for (i = 0; i < max_tape_drives; i++) {
497 if ((tape_new_stats[i].valid == TAPE_STATS_VALID) &&
498 (tape_old_stats[i].valid == TAPE_STATS_VALID)) {
499 tape_calc_one_stats(&tape, i);
500 if (!(DISPLAY_ZERO_OMIT(flags)
501 && (tape.other_per_second == 0)
502 && (tape.reads_per_second == 0)
503 && (tape.writes_per_second == 0)
504 && (tape.kbytes_read_per_second == 0)
505 && (tape.kbytes_written_per_second == 0)
506 && (tape.read_pct_wait == 0)
507 && (tape.write_pct_wait == 0)
508 && (tape.all_pct_wait == 0)
509 && (tape.resids_per_second == 0))) {
510 tape_write_stats(&tape, i);
515 * Swap new and old so next time we compare against the new old stats.
516 * If a new tape drive appears it won't appear in the output until after
517 * the second time we gather information about it.
519 tmp = tape_old_stats;
520 tape_old_stats = tape_new_stats;
521 tape_new_stats = tmp;
527 ***************************************************************************
528 * Main loop: Read tape stats from the relevant sources and display them.
531 * @count Number of lines of stats to print.
532 * @rectime Current date and time.
533 ***************************************************************************
535 void rw_tape_stat_loop(long int count, struct tm *rectime)
537 struct tape_stats *tmp;
540 /* Should we skip first report? */
541 if (DISPLAY_OMIT_SINCE_BOOT(flags) && interval > 0) {
545 /* Don't buffer data if redirected to a pipe */
546 setbuf(stdout, NULL);
550 if (tape_new_stats == NULL) {
551 tape_gather_initial_stats();
553 tape_get_updated_stats();
557 get_localtime(rectime, 0);
559 /* Check whether we should skip first report */
562 write_stats(rectime);
570 tmp = tape_old_stats;
571 tape_old_stats = tape_new_stats;
572 tape_new_stats = tmp;
583 ***************************************************************************
584 * Main entry to the tapestat program.
585 ***************************************************************************
587 int main(int argc, char **argv)
593 struct utsname header;
597 /* Init National Language Support */
601 /* Init color strings */
607 /* Process args... */
609 if (!strncmp(argv[opt], "-", 1)) {
610 for (i = 1; *(argv[opt] + i); i++) {
612 switch (*(argv[opt] + i)) {
615 if (DISPLAY_MEGABYTES(flags)) {
618 /* Display stats in kB/s */
619 flags |= T_D_KILOBYTES;
623 if (DISPLAY_KILOBYTES(flags)) {
626 /* Display stats in MB/s */
627 flags |= T_D_MEGABYTES;
631 /* Display timestamp */
632 flags |= T_D_TIMESTAMP;
636 /* Don't display stats since system restart */
637 flags |= T_D_OMIT_SINCE_BOOT;
641 /* Omit output for devices with no activity */
642 flags |= T_D_ZERO_OMIT;
646 /* Print version number and exit */
658 interval = atol(argv[opt++]);
667 count = atol(argv[opt++]);
668 if ((count < 1) || !interval) {
684 get_localtime(&rectime, 0);
686 /* Get system name, release number and hostname */
688 if (print_gal_header(&rectime, header.sysname, header.release,
689 header.nodename, header.machine, cpu_nr)) {
694 /* Set a handler for SIGALRM */
695 memset(&alrm_act, 0, sizeof(alrm_act));
696 alrm_act.sa_handler = alarm_handler;
697 sigaction(SIGALRM, &alrm_act, NULL);
701 rw_tape_stat_loop(count, &rectime);
703 /* Free structures */