]> granicus.if.org Git - sysstat/blob - tapestat.c
tapestat: do a proper realloc
[sysstat] / tapestat.c
1 /*
2  * tapestat: report tape statistics
3  * (C) 2015 Hewlett-Packard Development Company, L.P.
4  *
5  * Initial revision by Shane M. SEYMOUR (shane.seymour <at> hpe.com)
6  * Modified for sysstat by Sebastien GODARD (sysstat <at> orange.fr)
7  *
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.                                              *
13  *                                                                         *
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 *
17  * for more details.                                                       *
18  *                                                                         *
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  ***************************************************************************
23  */
24
25 #include <stdio.h>
26 #include <string.h>
27 #include <stdlib.h>
28 #include <unistd.h>
29 #include <time.h>
30 #include <dirent.h>
31 #define __DO_NOT_DEFINE_COMPILE
32 #include <regex.h>
33 #include <inttypes.h>
34 #include <stdint.h>
35 #include <signal.h>
36 #include <sys/stat.h>
37 #include <sys/time.h>
38 #include <sys/utsname.h>
39 #include <sys/param.h>
40 #undef HZ /* sys/param.h defines HZ but needed for MAXPATHLEN */
41
42 #include "version.h"
43 #include "tapestat.h"
44 #include "common.h"
45 #include "count.h"
46
47 #ifdef USE_NLS
48 #include <locale.h>
49 #include <libintl.h>
50 #define _(string) gettext(string)
51 #else
52 #define _(string) (string)
53 #endif
54
55 #define SCCSID "@(#)sysstat-" VERSION ": " __FILE__ " compiled " __DATE__ " " __TIME__
56 char *sccsid(void) { return (SCCSID); }
57
58 int cpu_nr = 0;         /* Nb of processors on the machine */
59 int flags = 0;          /* Flag for common options and system state */
60
61 long interval = 0;
62 char timestamp[64];
63
64 struct sigaction alrm_act;
65
66 /*
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.
73  */
74 int max_tape_drives = 0;
75 struct tape_stats *tape_new_stats = { NULL };
76 struct tape_stats *tape_old_stats = { NULL };
77 regex_t tape_reg;
78
79 /*
80  ***************************************************************************
81  * Print usage and exit.
82  *
83  * IN:
84  * @progname    Name of sysstat command.
85  ***************************************************************************
86  */
87 void usage(char *progname)
88 {
89         fprintf(stderr, _("Usage: %s [ options ] [ <interval> [ <count> ] ]\n"),
90                 progname);
91         fprintf(stderr, _("Options are:\n"
92                           "[ -k | -m ] [ -t ] [ -V ] [ -y ] [ -z ]\n"));
93         exit(1);
94 }
95
96 /*
97  ***************************************************************************
98  * SIGALRM signal handler. No need to reset the handler here.
99  *
100  * IN:
101  * @sig Signal number.
102  ***************************************************************************
103  */
104 void alarm_handler(int sig)
105 {
106         alarm(interval);
107 }
108
109 /*
110  ***************************************************************************
111  * Initialization.
112  ***************************************************************************
113  */
114 void tape_initialise(void)
115 {
116         /* How many processors on this machine? */
117         cpu_nr = get_cpu_nr(~0, FALSE);
118
119         /* Compile regular expression for tape names */
120         if (regcomp(&tape_reg, "^st[0-9]+$", REG_EXTENDED) != 0) {
121                 exit(1);
122         }
123 }
124
125 /*
126  ***************************************************************************
127  * Free structures.
128  ***************************************************************************
129  */
130 void tape_uninitialise(void)
131 {
132         regfree(&tape_reg);
133         if (tape_old_stats != NULL) {
134                 free(tape_old_stats);
135         }
136         if (tape_new_stats != NULL) {
137                 free(tape_new_stats);
138         }
139 }
140
141 /*
142  ***************************************************************************
143  * Get maximum number of tapes in the system.
144  *
145  * RETURNS:
146  * Number of tapes found.
147  ***************************************************************************
148  */
149 int get_max_tape_drives(void)
150 {
151         DIR *dir;
152         struct dirent *entry;
153         int new_max_tape_drives, tmp, num_stats_dir = 0;
154         regmatch_t match;
155         char stats_dir[MAXPATHLEN + 1];
156         struct stat stat_buf;
157
158         new_max_tape_drives = max_tape_drives;
159
160         /* Open sysfs tree */
161         dir = opendir(SYSFS_CLASS_TAPE_DIR);
162         if (dir == NULL)
163                 return 0;
164
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;
171                         }
172                 }
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)) {
177                                 num_stats_dir++;
178                         }
179                 }
180         }
181         closedir(dir);
182
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;
186         }
187
188         return new_max_tape_drives;
189 }
190
191 /*
192  ***************************************************************************
193  * Check if new tapes have been added and reallocate structures accordingly.
194  ***************************************************************************
195  */
196 void tape_check_tapes_and_realloc(void)
197 {
198         int new_max_tape_drives, i;
199
200         /* Count again number of tapes */
201         new_max_tape_drives = get_max_tape_drives();
202
203         if (new_max_tape_drives > max_tape_drives) {
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;
213                         }
214                         if (tape_new_stats_t != NULL) {
215                                 free(tape_new_stats_t);
216                                 tape_new_stats_t = NULL;
217                         }
218                         free(tape_old_stats);
219                         tape_old_stats = NULL;
220                         free(tape_new_stats);
221                         tape_new_stats = NULL;
222
223                         perror("realloc");
224                         exit(4);
225                 }
226
227                 for (i = max_tape_drives; i < new_max_tape_drives; i++) {
228                         tape_old_stats[i].valid = TAPE_STATS_INVALID;
229                         tape_new_stats[i].valid = TAPE_STATS_INVALID;
230                 }
231                 max_tape_drives = new_max_tape_drives;
232         }
233 }
234
235 /*
236  ***************************************************************************
237  * Collect initial statistics for all existing tapes in the system.
238  * This function should be called only once.
239  ***************************************************************************
240  */
241 void tape_gather_initial_stats(void)
242 {
243         int new_max_tape_drives, i;
244         FILE *fp;
245         char filename[MAXPATHLEN + 1];
246
247         /* Get number of tapes in the system */
248         new_max_tape_drives = get_max_tape_drives();
249
250         if (new_max_tape_drives == 0) {
251                 /* No tapes found */
252                 fprintf(stderr, _("No tape drives with statistics found\n"));
253                 exit(1);
254         }
255         else {
256                 /* Allocate structures */
257                 if (tape_old_stats == NULL) {
258                         tape_old_stats = (struct tape_stats *)
259                                 malloc(sizeof(struct tape_stats) * new_max_tape_drives);
260                         tape_new_stats = (struct tape_stats *)
261                                 malloc(sizeof(struct tape_stats) * new_max_tape_drives);
262                         for (i = 0; i < new_max_tape_drives; i++) {
263                                 tape_old_stats[i].valid = TAPE_STATS_INVALID;
264                                 tape_new_stats[i].valid = TAPE_STATS_INVALID;
265                         }
266                         max_tape_drives = new_max_tape_drives;
267                 } else
268                         /* This should only be called once */
269                         return;
270         }
271
272         /* Read stats for each tape */
273         for (i = 0; i < max_tape_drives; i++) {
274                 /*
275                  * Everything starts out valid but failing to open
276                  * a file gets the tape drive marked invalid.
277                  */
278                 tape_new_stats[i].valid = TAPE_STATS_VALID;
279                 tape_old_stats[i].valid = TAPE_STATS_VALID;
280
281                 gettimeofday(&tape_old_stats[i].tv, NULL);
282
283                 tape_new_stats[i].tv.tv_sec = tape_old_stats[i].tv.tv_sec;
284                 tape_new_stats[i].tv.tv_usec = tape_old_stats[i].tv.tv_usec;
285
286                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_ns", read_time)
287                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_ns", write_time)
288                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "io_ns", other_time)
289                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_byte_cnt", read_bytes)
290                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_byte_cnt", write_bytes)
291                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_cnt", read_count)
292                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_cnt", write_count)
293                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "other_cnt", other_count)
294                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "resid_cnt", resid_count)
295
296                 tape_old_stats[i].read_time = 0;
297                 tape_old_stats[i].write_time = 0;
298                 tape_old_stats[i].other_time = 0;
299                 tape_old_stats[i].read_bytes = 0;
300                 tape_old_stats[i].write_bytes = 0;
301                 tape_old_stats[i].read_count = 0;
302                 tape_old_stats[i].write_count = 0;
303                 tape_old_stats[i].other_count = 0;
304                 tape_old_stats[i].resid_count = 0;
305         }
306 }
307
308 /*
309  ***************************************************************************
310  * Collect a new sample of statistics for all existing tapes in the system.
311  ***************************************************************************
312  */
313 void tape_get_updated_stats(void)
314 {
315         int i;
316         FILE *fp;
317         char filename[MAXPATHLEN + 1] = { 0 };
318
319         /* Check tapes and realloc structures if  needed */
320         tape_check_tapes_and_realloc();
321
322         for (i = 0; i < max_tape_drives; i++) {
323                 /*
324                  * Everything starts out valid but failing
325                  * to open a file gets the tape drive marked invalid.
326                  */
327                 tape_new_stats[i].valid = TAPE_STATS_VALID;
328                 gettimeofday(&tape_new_stats[i].tv, NULL);
329
330                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_ns", read_time)
331                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_ns", write_time)
332                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "io_ns", other_time)
333                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_byte_cnt", read_bytes)
334                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_byte_cnt", write_bytes)
335                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "read_cnt", read_count)
336                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "write_cnt", write_count)
337                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "other_cnt", other_count)
338                 TAPE_STAT_FILE_VAL(TAPE_STAT_PATH "resid_cnt", resid_count)
339
340                 if ((tape_new_stats[i].read_time < tape_old_stats[i].read_time) ||
341                     (tape_new_stats[i].write_time < tape_old_stats[i].write_time) ||
342                     (tape_new_stats[i].other_time < tape_old_stats[i].other_time)) {
343                         tape_new_stats[i].valid = TAPE_STATS_INVALID;
344                 }
345         }
346 }
347
348 /*
349  ***************************************************************************
350  * Display tapes statistics headings.
351  ***************************************************************************
352  */
353 void tape_write_headings(void)
354 {
355         printf("Tape:     r/s     w/s   ");
356         if (DISPLAY_MEGABYTES(flags)) {
357                 printf("MB_read/s   MB_wrtn/s");
358         } else {
359                 printf("kB_read/s   kB_wrtn/s");
360         }
361         printf(" %%Rd %%Wr %%Oa    Rs/s    Ot/s\n");
362 }
363
364 /*
365  ***************************************************************************
366  * Calculate statistics for current tape.
367  *
368  * IN:
369  * @i           Index in array for current tape.
370  *
371  * OUT:
372  * @stats       Statistics for current tape.
373  ***************************************************************************
374  */
375 void tape_calc_one_stats(struct calc_stats *stats, int i)
376 {
377         uint64_t duration;
378         double temp;
379         FILE *fp;
380
381         /* Duration in ms done in ms to prevent rounding issues with using seconds */
382         duration = (tape_new_stats[i].tv.tv_sec -
383                 tape_old_stats[i].tv.tv_sec) * 1000;
384         duration -= tape_old_stats[i].tv.tv_usec / 1000;
385         duration += tape_new_stats[i].tv.tv_usec / 1000;
386
387         /* If duration is zero we need to calculate the ms since boot time */
388         if (duration == 0) {
389                 fp = fopen("/proc/uptime", "r");
390
391                 /*
392                  * Get uptime from /proc/uptime and if we can't then just set duration to
393                  * be 0 - it will mean that we don't calculate stats.
394                  */
395                 if (fp == NULL) {
396                         duration = 0;
397                 } else {
398                         if (fscanf(fp, "%lf", &temp) != 1) {
399                                 temp = 0;
400                         }
401                         duration = (uint64_t) (temp * 1000);
402                         fclose(fp);
403                 }
404         }
405
406         /* The second value passed into the macro is the thing being calculated */
407         CALC_STAT_CNT(read_count, reads_per_second)
408         CALC_STAT_CNT(write_count, writes_per_second)
409         CALC_STAT_CNT(other_count, other_per_second)
410         CALC_STAT_KB(read_bytes, kbytes_read_per_second)
411         CALC_STAT_KB(write_bytes, kbytes_written_per_second)
412         CALC_STAT_PCT(read_time, read_pct_wait)
413         CALC_STAT_PCT(write_time, write_pct_wait)
414         CALC_STAT_PCT(other_time, all_pct_wait)
415         CALC_STAT_CNT(resid_count, resids_per_second)
416 }
417
418 /*
419  ***************************************************************************
420  * Display statistics for current tape.
421  *
422  * IN:
423  * @tape        Statistics for current tape.
424  * @i           Index in array for current tape.
425  ***************************************************************************
426  */
427 void tape_write_stats(struct calc_stats *tape, int i)
428 {
429         char buffer[32];
430         uint64_t divisor = 1;
431
432         if (DISPLAY_MEGABYTES(flags))
433                 divisor = 1024;
434
435         sprintf(buffer, "st%i        ", i);
436         buffer[5] = 0;
437         cprintf_in(IS_STR, "%s", buffer, 0);
438         cprintf_u64(2, 7,
439                     tape->reads_per_second,
440                     tape->writes_per_second);
441         cprintf_u64(2, 11,
442                     tape->kbytes_read_per_second / divisor,
443                     tape->kbytes_written_per_second / divisor);
444         cprintf_pc(3, 3, 0,
445                    (double) tape->read_pct_wait,
446                    (double) tape->write_pct_wait,
447                    (double) tape->all_pct_wait);
448         cprintf_u64(2, 7,
449                     tape->resids_per_second,
450                     tape->other_per_second);
451         printf("\n");
452 }
453
454 /*
455  ***************************************************************************
456  * Print everything now (stats and uptime).
457  *
458  * IN:
459  * @rectime     Current date and time.
460  ***************************************************************************
461  */
462 void write_stats(struct tm *rectime)
463 {
464         int i;
465         struct calc_stats tape;
466         struct tape_stats *tmp;
467
468         /* Test stdout */
469         TEST_STDOUT(STDOUT_FILENO);
470
471         /* Print time stamp */
472         if (DISPLAY_TIMESTAMP(flags)) {
473                 if (DISPLAY_ISO(flags)) {
474                         strftime(timestamp, sizeof(timestamp), "%FT%T%z", rectime);
475                 }
476                 else {
477                         strftime(timestamp, sizeof(timestamp), "%x %X", rectime);
478                 }
479                 printf("%s\n", timestamp);
480         }
481
482         /* Print the headings */
483         tape_write_headings();
484
485         /*
486          * If either new or old is invalid or the I/Os per second is 0 and
487          * zero omit is true then we print nothing.
488          */
489         if (max_tape_drives > 0) {
490
491                 for (i = 0; i < max_tape_drives; i++) {
492                         if ((tape_new_stats[i].valid == TAPE_STATS_VALID) &&
493                                 (tape_old_stats[i].valid == TAPE_STATS_VALID)) {
494                                 tape_calc_one_stats(&tape, i);
495                                 if (!(DISPLAY_ZERO_OMIT(flags)
496                                         && (tape.other_per_second == 0)
497                                         && (tape.reads_per_second == 0)
498                                         && (tape.writes_per_second == 0)
499                                         && (tape.kbytes_read_per_second == 0)
500                                         && (tape.kbytes_written_per_second == 0)
501                                         && (tape.read_pct_wait == 0)
502                                         && (tape.write_pct_wait == 0)
503                                         && (tape.all_pct_wait == 0)
504                                         && (tape.resids_per_second == 0))) {
505                                         tape_write_stats(&tape, i);
506                                 }
507                         }
508                 }
509                 /*
510                  * Swap new and old so next time we compare against the new old stats.
511                  * If a new tape drive appears it won't appear in the output until after
512                  * the second time we gather information about it.
513                  */
514                 tmp = tape_old_stats;
515                 tape_old_stats = tape_new_stats;
516                 tape_new_stats = tmp;
517         }
518         printf("\n");
519 }
520
521 /*
522  ***************************************************************************
523  * Main loop: Read tape stats from the relevant sources and display them.
524  *
525  * IN:
526  * @count       Number of lines of stats to print.
527  * @rectime     Current date and time.
528  ***************************************************************************
529  */
530 void rw_tape_stat_loop(long int count, struct tm *rectime)
531 {
532         struct tape_stats *tmp;
533         int skip = 0;
534
535         /* Should we skip first report? */
536         if (DISPLAY_OMIT_SINCE_BOOT(flags) && interval > 0) {
537                 skip = 1;
538         }
539
540         /* Don't buffer data if redirected to a pipe */
541         setbuf(stdout, NULL);
542
543         do {
544
545                 if (tape_new_stats == NULL) {
546                         tape_gather_initial_stats();
547                 } else {
548                         tape_get_updated_stats();
549                 }
550
551                 /* Get time */
552                 get_localtime(rectime, 0);
553
554                 /* Check whether we should skip first report */
555                 if (!skip) {
556                         /* Print results */
557                         write_stats(rectime);
558
559                         if (count > 0) {
560                                 count--;
561                         }
562                 }
563                 else {
564                         skip = 0;
565                         tmp = tape_old_stats;
566                         tape_old_stats = tape_new_stats;
567                         tape_new_stats = tmp;
568                 }
569
570                 if (count) {
571                         pause();
572                 }
573         }
574         while (count);
575 }
576
577 /*
578  ***************************************************************************
579  * Main entry to the tapestat program.
580  ***************************************************************************
581  */
582 int main(int argc, char **argv)
583 {
584         int it = 0;
585         int opt = 1;
586         int i;
587         long count = 1;
588         struct utsname header;
589         struct tm rectime;
590
591 #ifdef USE_NLS
592         /* Init National Language Support */
593         init_nls();
594 #endif
595
596         /* Init color strings */
597         init_colors();
598
599         /* Get HZ */
600         get_HZ();
601
602         /* Process args... */
603         while (opt < argc) {
604                         if (!strncmp(argv[opt], "-", 1)) {
605                         for (i = 1; *(argv[opt] + i); i++) {
606
607                                 switch (*(argv[opt] + i)) {
608
609                                 case 'k':
610                                         if (DISPLAY_MEGABYTES(flags)) {
611                                                 usage(argv[0]);
612                                         }
613                                         /* Display stats in kB/s */
614                                         flags |= T_D_KILOBYTES;
615                                         break;
616
617                                 case 'm':
618                                         if (DISPLAY_KILOBYTES(flags)) {
619                                                 usage(argv[0]);
620                                         }
621                                         /* Display stats in MB/s */
622                                         flags |= T_D_MEGABYTES;
623                                         break;
624
625                                 case 't':
626                                         /* Display timestamp */
627                                         flags |= T_D_TIMESTAMP;
628                                         break;
629
630                                 case 'y':
631                                         /* Don't display stats since system restart */
632                                         flags |= T_D_OMIT_SINCE_BOOT;
633                                         break;
634
635                                 case 'z':
636                                         /* Omit output for devices with no activity */
637                                         flags |= T_D_ZERO_OMIT;
638                                         break;
639
640                                 case 'V':
641                                         /* Print version number and exit */
642                                         print_version();
643                                         break;
644
645                                 default:
646                                         usage(argv[0]);
647                                 }
648                         }
649                         opt++;
650                 }
651
652                 else if (!it) {
653                         interval = atol(argv[opt++]);
654                         if (interval < 0) {
655                                 usage(argv[0]);
656                         }
657                         count = -1;
658                         it = 1;
659                 }
660
661                 else if (it > 0) {
662                         count = atol(argv[opt++]);
663                         if ((count < 1) || !interval) {
664                                 usage(argv[0]);
665                         }
666                         it = -1;
667                 }
668                 else {
669                         usage(argv[0]);
670                 }
671         }
672
673         if (!interval) {
674                 count = 1;
675         }
676
677         tape_initialise();
678
679         get_localtime(&rectime, 0);
680
681         /* Get system name, release number and hostname */
682         uname(&header);
683         if (print_gal_header(&rectime, header.sysname, header.release,
684                              header.nodename, header.machine, cpu_nr)) {
685                 flags |= T_D_ISO;
686         }
687         printf("\n");
688
689         /* Set a handler for SIGALRM */
690         memset(&alrm_act, 0, sizeof(alrm_act));
691         alrm_act.sa_handler = alarm_handler;
692         sigaction(SIGALRM, &alrm_act, NULL);
693         alarm(interval);
694
695         /* Main loop */
696         rw_tape_stat_loop(count, &rectime);
697
698         /* Free structures */
699         tape_uninitialise();
700
701         return 0;
702 }