blkrawverify.c

   1 /*
   2  * block queue tracing application
   3  *
   4  * Copyright (C) 2006 Alan D. Brunelle <Alan.Brunelle@hp.com>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <errno.h>
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <unistd.h>
  28
  29 #include "blktrace.h"
  30
  31 struct trace_info {
  32         int bit_field;
  33         char *string;
  34 };
  35
  36 int data_is_native = -1;
  37
  38 #define TRACE_TO_STRING(f)      {.bit_field = f, .string = #f}
  39 static struct trace_info traces[] = {
  40         TRACE_TO_STRING( BLK_TC_READ ),
  41         TRACE_TO_STRING( BLK_TC_WRITE ),
  42         TRACE_TO_STRING( BLK_TC_BARRIER ),
  43         TRACE_TO_STRING( BLK_TC_SYNC ),
  44         TRACE_TO_STRING( BLK_TC_QUEUE ),
  45         TRACE_TO_STRING( BLK_TC_REQUEUE ),
  46         TRACE_TO_STRING( BLK_TC_ISSUE ),
  47         TRACE_TO_STRING( BLK_TC_COMPLETE ),
  48         TRACE_TO_STRING( BLK_TC_FS ),
  49         TRACE_TO_STRING( BLK_TC_PC )
  50 };
  51 #define N_TRACES (sizeof(traces) / sizeof(struct trace_info))
  52
  53 struct act_info {
  54         __u32 val;
  55         char *string;
  56 };
  57
  58 #define ACT_TO_STRING(f)        {.val = f, .string = #f}
  59 static struct act_info acts[] = {
  60         ACT_TO_STRING( __BLK_TA_QUEUE ),
  61         ACT_TO_STRING( __BLK_TA_QUEUE ),
  62         ACT_TO_STRING( __BLK_TA_BACKMERGE ),
  63         ACT_TO_STRING( __BLK_TA_FRONTMERGE ),
  64         ACT_TO_STRING( __BLK_TA_GETRQ ),
  65         ACT_TO_STRING( __BLK_TA_SLEEPRQ ),
  66         ACT_TO_STRING( __BLK_TA_REQUEUE ),
  67         ACT_TO_STRING( __BLK_TA_ISSUE ),
  68         ACT_TO_STRING( __BLK_TA_COMPLETE ),
  69         ACT_TO_STRING( __BLK_TA_PLUG ),
  70         ACT_TO_STRING( __BLK_TA_UNPLUG_IO ),
  71         ACT_TO_STRING( __BLK_TA_UNPLUG_TIMER ),
  72         ACT_TO_STRING( __BLK_TA_INSERT ),
  73         ACT_TO_STRING( __BLK_TA_SPLIT ),
  74         ACT_TO_STRING( __BLK_TA_BOUNCE ),
  75         ACT_TO_STRING( __BLK_TA_REMAP )
  76 };
  77 #define N_ACTS (sizeof(acts) / sizeof(struct act_info))
  78
  79 static char *act_to_str(__u32 action)
  80 {
  81         static char buf[1024];
  82         unsigned int i;
  83         unsigned int act = action & 0xffff;
  84         unsigned int trace = (action >> BLK_TC_SHIFT) & 0xffff;
  85
  86         if (act <= N_ACTS) {
  87                 sprintf(buf, "%s ", acts[act].string);
  88                 for (i = 0; i < N_TRACES; i++)
  89                         if (trace & (1 << i)) {
  90                                 char buf2[1024];
  91                                 sprintf(buf2, "| %s ", traces[i].string);
  92                                 strcat(buf, buf2);
  93                         }
  94         }
  95         else
  96                 sprintf(buf, "Invalid action=%08x", action);
  97
  98         return buf;
  99 }
 100
 101 static void dump_trace(FILE *ofp, char *prefix, struct blk_io_trace *bit)
 102 {
 103         fprintf(ofp, "    Dump %s\n", prefix);
 104         fprintf(ofp, "        %8s: %08x\n", "magic", bit->magic);
 105         fprintf(ofp, "        %8s: %u\n", "sequence", bit->sequence);
 106         fprintf(ofp, "        %8s: %llu\n", "time", (unsigned long long) bit->time);
 107         fprintf(ofp, "        %8s: %llu\n", "sector", (unsigned long long) bit->sector);
 108         fprintf(ofp, "        %8s: %u\n", "bytes", bit->bytes);
 109         fprintf(ofp, "        %8s: %s\n", "action", act_to_str(bit->action));
 110         fprintf(ofp, "        %8s: %u\n", "bytes", bit->bytes);
 111         fprintf(ofp, "        %8s: %u\n", "cpu", bit->cpu);
 112         fprintf(ofp, "        %8s: %u\n", "error", bit->error);
 113         fprintf(ofp, "        %8s: %u\n", "pdu_len", bit->pdu_len);
 114         fprintf(ofp, "        %8s: (%u,%u)\n\n", "device", MAJOR(bit->device),
 115                                                            MINOR(bit->device));
 116 }
 117
 118 static int process(FILE *ofp, char *file, unsigned int cpu)
 119 {
 120 #       define SWAP_BITS() do {                                         \
 121                 if (bit_save) {                                         \
 122                         struct blk_io_trace *tmp = bit_save;            \
 123                         bit_save = bit;                                 \
 124                         bit = tmp;                                      \
 125                 }                                                       \
 126                 else {                                                  \
 127                         bit_save = bit;                                 \
 128                         bit = malloc(sizeof(struct blk_io_trace));      \
 129                 }                                                       \
 130         } while (0)
 131
 132 #       define INC_BAD(str) do {                                        \
 133                 nbad++;                                                 \
 134                 fprintf(ofp, "    ----------------\n");                 \
 135                 if (bit_save) dump_trace(ofp,"seq-1",bit_save);         \
 136                 dump_trace(ofp, str, bit);                              \
 137                 SWAP_BITS();                                            \
 138         } while (0)
 139
 140         size_t n;
 141         FILE *ifp;
 142         __u32 save_device = 0, save_sequence = 0;
 143         __u64 save_time = 0;
 144         struct blk_io_trace *bit_save = NULL;
 145         struct blk_io_trace *bit = malloc(sizeof(struct blk_io_trace));
 146         unsigned int ngood = 0;
 147         unsigned int nbad = 0;
 148         unsigned int nbad_trace = 0, nbad_pdu = 0, nbad_cpu = 0;
 149         unsigned int nbad_seq = 0, nbad_dev = 0, nbad_time = 0;
 150
 151         ifp = fopen(file, "r");
 152         while ((n = fread(bit, sizeof(struct blk_io_trace), 1, ifp)) == 1) {
 153                 if (data_is_native == -1)
 154                         check_data_endianness(bit->magic);
 155
 156                 trace_to_cpu(bit);
 157
 158                 if (!CHECK_MAGIC(bit)) {
 159                         INC_BAD("bad trace");
 160                         continue;
 161                 }
 162
 163                 if ((bit->magic & 0xff) != SUPPORTED_VERSION) {
 164                         fprintf(stderr, "unsupported trace version\n");
 165                         break;
 166                 }
 167
 168                 if (bit->pdu_len) {
 169                         char *pdu_buf;
 170
 171                         pdu_buf = malloc(bit->pdu_len);
 172                         n = fread(pdu_buf, bit->pdu_len, 1, ifp);
 173                         if (n == 0) {
 174                                 INC_BAD("bad pdu");
 175                                 nbad_seq++;
 176                                 break;
 177                         }
 178                         free(pdu_buf);
 179                 }
 180
 181                 if (bit->cpu != cpu) {
 182                         INC_BAD("bad cpu");
 183                         nbad_cpu++;
 184                         continue;
 185                 }
 186
 187                 /*
 188                  * skip notify traces, they don't have valid sequences
 189                  */
 190                 if (bit->action & BLK_TC_ACT(BLK_TC_NOTIFY))
 191                         continue;
 192
 193                 if (ngood) {
 194                         if (bit->sequence <= save_sequence) {
 195                                 INC_BAD("bad seq");
 196                                 nbad_seq++;
 197                                 continue;
 198                         }
 199                         else if (bit->time <= save_time) {
 200                                 INC_BAD("time regression");
 201                                 nbad_time++;
 202                                 continue;
 203                         }
 204                         else if (bit->device != save_device) {
 205                                 INC_BAD("bad dev");
 206                                 nbad_dev++;
 207                                 continue;
 208                         }
 209                 }
 210
 211                 save_sequence = bit->sequence;
 212                 save_time = bit->time;
 213                 save_device = bit->device;
 214
 215                 ngood++;
 216                 SWAP_BITS();
 217         }
 218
 219         if (n == 0 && !feof(ifp))
 220                 fprintf(stderr,"%s: fread failed %d/%s\n",
 221                         file, errno, strerror(errno));
 222         fclose(ifp);
 223
 224         fprintf(ofp, "    ---------------------\n");
 225         fprintf(ofp, "    Summary for cpu %d:\n", cpu);
 226         fprintf(ofp, "    %10d valid + %10d invalid (%5.1f%%) processed\n\n",
 227                 ngood, nbad,
 228                 ngood ? 100.0 * (float)ngood / (float)(ngood + nbad) : 0.0);
 229
 230         if (nbad) {
 231                 if (nbad_trace)
 232                         fprintf(ofp, "%8s %d traces\n", "", nbad_trace);
 233                 if (nbad_trace)
 234                         fprintf(ofp, "%8s %d pdu\n", "", nbad_pdu);
 235                 if (nbad_cpu)
 236                         fprintf(ofp, "%8s %d cpu\n", "", nbad_cpu);
 237                 if (nbad_seq)
 238                         fprintf(ofp, "%8s %d seq\n", "", nbad_seq);
 239                 if (nbad_dev)
 240                         fprintf(ofp, "%8s %d dev\n", "", nbad_dev);
 241                 if (nbad_time)
 242                         fprintf(ofp, "%8s %d time\n", "", nbad_time);
 243                 fprintf(ofp,"\n");
 244         }
 245
 246         return nbad;
 247 }
 248
 249 int main(int argc, char *argv[])
 250 {
 251         char *devname;
 252         struct stat st;
 253         int i, cpu, nbad;
 254         FILE *ofp;
 255         char *ofname = malloc(1024);
 256         char *fname = malloc(1024);
 257
 258         if (argc < 2) {
 259                 fprintf(stderr,"FATAL: Need device name(s)\n");
 260                 fprintf(stderr,"Usage: blkrawverify <dev> [<dev>...]\n");
 261                 exit(1);
 262         }
 263
 264         for (i = 1; i < argc; i++) {
 265                 devname = argv[i];
 266                 sprintf(ofname, "%s.verify.out", devname);
 267                 ofp = fopen(ofname, "w");
 268                 if (ofp == NULL) {
 269                         fprintf(stderr,"Failed to open %s (%s), skipping %s\n",
 270                                 ofname, strerror(errno), devname);
 271                         continue;
 272                 }
 273
 274                 fprintf(ofp, "\n---------------\n" );
 275                 fprintf(ofp, "Verifying %s\n", devname);
 276                 printf("Verifying %s\n", devname); fflush(stdout);
 277                 for (cpu = 0; ; cpu++) {
 278                         sprintf(fname, "%s.blktrace.%d", devname, cpu);
 279                         if (stat(fname, &st) < 0)
 280                                 break;
 281                         printf("    CPU %d ", cpu); fflush(stdout);
 282                         nbad = process(ofp, fname, cpu);
 283                         if (nbad)
 284                                 printf("-- %d bad", nbad);
 285                         printf("\n");
 286                 }
 287                 fclose(ofp);
 288                 fprintf(stdout, "Wrote output to %s\n", ofname);
 289         }
 290
 291         return 0;
 292 }