graph.c

   1 /*
   2  * gfio - gui front end for fio - the flexible io tester
   3  *
   4  * Copyright (C) 2012 Stephen M. Cameron <stephenmcameron@gmail.com>
   5  *
   6  * The license below covers all files distributed with fio unless otherwise
   7  * noted in the file itself.
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License version 2 as
  11  *  published by the Free Software Foundation.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #include <string.h>
  24 #include <malloc.h>
  25 #include <math.h>
  26 #include <assert.h>
  27
  28 #include <cairo.h>
  29 #include <gtk/gtk.h>
  30
  31 #include "tickmarks.h"
  32
  33 struct xyvalue {
  34         double x, y;
  35 };
  36
  37 struct graph_value {
  38         struct graph_value *next;
  39         void *value;
  40 };
  41
  42 struct graph_label {
  43         char *label;
  44         struct graph_value *tail;
  45         struct graph_value *values;
  46         struct graph_label *next;
  47         double r, g, b;
  48         int value_count;
  49         struct graph *parent;
  50 };
  51
  52 struct graph {
  53         char *title;
  54         char *xtitle;
  55         char *ytitle;
  56         unsigned int xdim, ydim;
  57         struct graph_label *labels;
  58         struct graph_label *tail;
  59         int per_label_limit;
  60         const char *font;
  61 };
  62
  63 void graph_set_size(struct graph *g, unsigned int xdim, unsigned int ydim)
  64 {
  65         g->xdim = xdim;
  66         g->ydim = ydim;
  67 }
  68
  69 struct graph *graph_new(unsigned int xdim, unsigned int ydim, const char *font)
  70 {
  71         struct graph *g;
  72
  73         g = calloc(1, sizeof(*g));
  74         graph_set_size(g, xdim, ydim);
  75         g->per_label_limit = -1;
  76         g->font = font;
  77         if (!g->font)
  78                 g->font = "Sans";
  79         return g;
  80 }
  81
  82 static int count_labels(struct graph_label *labels)
  83 {
  84         int count = 0;
  85         struct graph_label *i;
  86
  87         for (i = labels; i; i = i->next)
  88                 count++;
  89         return count;
  90 }
  91
  92 static int count_values(struct graph_value *values)
  93 {
  94         int count = 0;
  95         struct graph_value *i;
  96
  97         for (i = values; i; i = i->next)
  98                 count++;
  99         return count;
 100 }
 101
 102 typedef double (*double_comparator)(double a, double b);
 103
 104 static double mindouble(double a, double b)
 105 {
 106         return a < b ? a : b;
 107 }
 108
 109 static double maxdouble(double a, double b)
 110 {
 111         return a < b ? b : a;
 112 }
 113
 114 static double find_double_values(struct graph_value *values, double_comparator cmp)
 115 {
 116         struct graph_value *i;
 117         int first = 1;
 118         double answer, tmp;
 119
 120         assert(values != NULL);
 121         answer = 0.0; /* shut the compiler up, might need to think harder though. */
 122         for (i = values; i; i = i->next) {
 123                 tmp = *(double *) i->value;
 124                 if (first) {
 125                         answer = tmp;
 126                         first = 0;
 127                 } else {
 128                         answer = cmp(answer, tmp);
 129                 }
 130         }
 131         return answer;
 132 }
 133
 134 static double find_double_data(struct graph_label *labels, double_comparator cmp)
 135 {
 136         struct graph_label *i;
 137         int first = 1;
 138         double answer, tmp;
 139
 140         assert(labels != NULL);
 141         answer = 0.0; /* shut the compiler up, might need to think harder though. */
 142         for (i = labels; i; i = i->next) {
 143                 tmp = find_double_values(i->values, cmp);
 144                 if (first) {
 145                         answer = tmp;
 146                         first = 0;
 147                 } else {
 148                         answer = cmp(tmp, answer);
 149                 }
 150         }
 151         return answer;
 152 }
 153
 154 static double find_min_data(struct graph_label *labels)
 155 {
 156         return find_double_data(labels, mindouble);
 157 }
 158
 159 static double find_max_data(struct graph_label *labels)
 160 {
 161         return find_double_data(labels, maxdouble);
 162 }
 163
 164 static void draw_bars(struct graph *bg, cairo_t *cr, struct graph_label *lb,
 165                         double label_offset, double bar_width,
 166                         double mindata, double maxdata)
 167 {
 168         struct graph_value *i;
 169         double x1, y1, x2, y2;
 170         int bar_num = 0;
 171         double domain, range, v;
 172
 173         domain = (maxdata - mindata);
 174         range = (double) bg->ydim * 0.80; /* FIXME */
 175         cairo_stroke(cr);
 176         for (i = lb->values; i; i = i->next) {
 177
 178                 x1 = label_offset + (double) bar_num * bar_width + (bar_width * 0.05);
 179                 x2 = x1 + bar_width * 0.90;
 180                 y2 = bg->ydim * 0.90;
 181                 v = *(double *) i->value;
 182                 y1 = y2 - (((v - mindata) / domain) * range);
 183                 cairo_move_to(cr, x1, y1);
 184                 cairo_line_to(cr, x1, y2);
 185                 cairo_line_to(cr, x2, y2);
 186                 cairo_line_to(cr, x2, y1);
 187                 cairo_close_path(cr);
 188                 cairo_fill(cr);
 189                 cairo_stroke(cr);
 190                 bar_num++;
 191         }
 192 }
 193
 194 static void draw_aligned_text(struct graph *g, cairo_t *cr, double x, double y,
 195                                double fontsize, const char *text, int alignment)
 196 {
 197 #define CENTERED 0
 198 #define LEFT_JUSTIFIED 1
 199 #define RIGHT_JUSTIFIED 2
 200
 201         double factor, direction;
 202         cairo_text_extents_t extents;
 203
 204         switch(alignment) {
 205                 case CENTERED:
 206                         direction = -1.0;
 207                         factor = 0.5;
 208                         break;
 209                 case RIGHT_JUSTIFIED:
 210                         direction = -1.0;
 211                         factor = 1.0;
 212                         break;
 213                 case LEFT_JUSTIFIED:
 214                 default:
 215                         direction = 1.0;
 216                         factor = 1.0;
 217                         break;
 218         }
 219         cairo_select_font_face (cr, g->font, CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
 220
 221         cairo_set_font_size(cr, fontsize);
 222         cairo_text_extents(cr, text, &extents);
 223         x = x + direction * (factor * extents.width  + extents.x_bearing);
 224         y = y - (extents.height / 2 + extents.y_bearing);
 225
 226         cairo_move_to(cr, x, y);
 227         cairo_show_text(cr, text);
 228 }
 229
 230 static inline void draw_centered_text(struct graph *g, cairo_t *cr, double x, double y,
 231                                double fontsize, const char *text)
 232 {
 233         draw_aligned_text(g, cr, x, y, fontsize, text, CENTERED);
 234 }
 235
 236 static inline void draw_right_justified_text(struct graph *g, cairo_t *cr,
 237                                 double x, double y,
 238                                 double fontsize, const char *text)
 239 {
 240         draw_aligned_text(g, cr, x, y, fontsize, text, RIGHT_JUSTIFIED);
 241 }
 242
 243 static inline void draw_left_justified_text(struct graph *g, cairo_t *cr,
 244                                 double x, double y,
 245                                 double fontsize, const char *text)
 246 {
 247         draw_aligned_text(g, cr, x, y, fontsize, text, LEFT_JUSTIFIED);
 248 }
 249
 250 static void draw_vertical_centered_text(struct graph *g, cairo_t *cr, double x,
 251                                         double y, double fontsize,
 252                                         const char *text)
 253 {
 254         double sx, sy;
 255         cairo_text_extents_t extents;
 256
 257         cairo_select_font_face(cr, g->font, CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
 258
 259         cairo_set_font_size(cr, fontsize);
 260         cairo_text_extents(cr, text, &extents);
 261         sx = x;
 262         sy = y;
 263         y = y + (extents.width / 2.0 + extents.x_bearing);
 264         x = x - (extents.height / 2.0 + extents.y_bearing);
 265
 266         cairo_move_to(cr, x, y);
 267         cairo_save(cr);
 268         cairo_translate(cr, -sx, -sy);
 269         cairo_rotate(cr, -90.0 * M_PI / 180.0);
 270         cairo_translate(cr, sx, sy);
 271         cairo_show_text(cr, text);
 272         cairo_restore(cr);
 273 }
 274
 275 static void graph_draw_common(struct graph *g, cairo_t *cr,
 276         double *x1, double *y1, double *x2, double *y2)
 277 {
 278         cairo_set_source_rgb(cr, 0, 0, 0);
 279         cairo_set_line_width (cr, 0.8);
 280
 281         /* for now just set margins at 10% of width.  This is not very good. */
 282         *x1 = g->xdim / 10.0;
 283         *x2 = 9.0 * *x1;
 284         *y1 = g->ydim / 10.0;
 285         *y2 = 9.0 * *y1;
 286
 287         cairo_move_to(cr, *x1, *y1);
 288         cairo_line_to(cr, *x1, *y2);
 289         cairo_line_to(cr, *x2, *y2);
 290         cairo_line_to(cr, *x2, *y1);
 291         cairo_line_to(cr, *x1, *y1);
 292         cairo_stroke(cr);
 293
 294         draw_centered_text(g, cr, g->xdim / 2, g->ydim / 20, 20.0, g->title);
 295         draw_centered_text(g, cr, g->xdim / 2, g->ydim * 0.97, 14.0, g->xtitle);
 296         draw_vertical_centered_text(g, cr, g->xdim * 0.02, g->ydim / 2, 14.0, g->ytitle);
 297         cairo_stroke(cr);
 298 }
 299
 300 static void graph_draw_x_ticks(struct graph *g, cairo_t *cr,
 301         double x1, double y1, double x2, double y2,
 302         double minx, double maxx, int nticks)
 303 {
 304         struct tickmark *tm;
 305         double tx;
 306         int i;
 307         static double dash[] = { 1.0, 2.0 };
 308
 309         nticks = calc_tickmarks(minx, maxx, nticks, &tm);
 310
 311         for (i = 0; i < nticks; i++) {
 312                 tx = (((tm[i].value) - minx) / (maxx - minx)) * (x2 - x1) + x1;
 313                 if (tx < x1 || tx > x2)
 314                         continue;
 315
 316                 /* Draw tick mark */
 317                 cairo_set_line_width(cr, 0.8);
 318                 cairo_move_to(cr, tx, y2);
 319                 cairo_line_to(cr, tx, y2 + (y2 - y1) * 0.03);
 320                 cairo_stroke(cr);
 321
 322                 /* draw grid lines */
 323                 cairo_save(cr);
 324                 cairo_set_dash(cr, dash, 2, 2.0);
 325                 cairo_set_line_width(cr, 0.5);
 326                 cairo_move_to(cr, tx, y1);
 327                 cairo_line_to(cr, tx, y2);
 328                 cairo_stroke(cr);
 329                 cairo_restore(cr);
 330
 331                 /* draw tickmark label */
 332                 draw_centered_text(g, cr, tx, y2 * 1.04, 12.0, tm[i].string);
 333                 cairo_stroke(cr);
 334
 335         }
 336 }
 337
 338 static void graph_draw_y_ticks(struct graph *g, cairo_t *cr,
 339         double x1, double y1, double x2, double y2,
 340         double miny, double maxy, int nticks)
 341 {
 342         struct tickmark *tm;
 343         double ty;
 344         int i;
 345         static double dash[] = { 2.0, 2.0 };
 346
 347         nticks = calc_tickmarks(miny, maxy, nticks, &tm);
 348
 349         for (i = 0; i < nticks; i++) {
 350                 ty = y2 - (((tm[i].value) - miny) / (maxy - miny)) * (y2 - y1);
 351                 if (ty < y1 || ty > y2)
 352                         continue;
 353                 /* draw tick mark */
 354                 cairo_move_to(cr, x1, ty);
 355                 cairo_line_to(cr, x1 - (x2 - x1) * 0.02, ty);
 356                 cairo_stroke(cr);
 357
 358                 /* draw grid lines */
 359                 cairo_save(cr);
 360                 cairo_set_dash(cr, dash, 2, 2.0);
 361                 cairo_set_line_width(cr, 0.5);
 362                 cairo_move_to(cr, x1, ty);
 363                 cairo_line_to(cr, x2, ty);
 364                 cairo_stroke(cr);
 365                 cairo_restore(cr);
 366
 367                 /* draw tickmark label */
 368                 draw_right_justified_text(g, cr, x1 - (x2 - x1) * 0.025, ty, 12.0, tm[i].string);
 369                 cairo_stroke(cr);
 370         }
 371 }
 372
 373 void bar_graph_draw(struct graph *bg, cairo_t *cr)
 374 {
 375         double x1, y1, x2, y2;
 376         double space_per_label, bar_width;
 377         double label_offset, mindata, maxdata;
 378         int i, nlabels;
 379         struct graph_label *lb;
 380
 381         cairo_save(cr);
 382         graph_draw_common(bg, cr, &x1, &y1, &x2, &y2);
 383
 384         nlabels = count_labels(bg->labels);
 385         space_per_label = (x2 - x1) / (double) nlabels;
 386
 387         mindata = find_min_data(bg->labels);
 388         maxdata = find_max_data(bg->labels);
 389
 390         if (fabs(maxdata - mindata) < 1e-20) {
 391                 draw_centered_text(bg, cr,
 392                         x1 + (x2 - x1) / 2.0,
 393                         y1 + (y2 - y1) / 2.0, 20.0, "No good data");
 394                 return;
 395         }
 396
 397         graph_draw_y_ticks(bg, cr, x1, y1, x2, y2, mindata, maxdata, 10);
 398
 399         i = 0;
 400         for (lb = bg->labels; lb; lb = lb->next) {
 401                 int nvalues;
 402                 nvalues = count_values(lb->values);
 403                 bar_width = (space_per_label - space_per_label * 0.2) / (double) nvalues;
 404                 label_offset = bg->xdim * 0.1 + space_per_label * (double) i + space_per_label * 0.1;
 405                 draw_bars(bg, cr, lb, label_offset, bar_width, mindata, maxdata);
 406                 // draw_centered_text(cr, label_offset + (bar_width / 2.0 + bar_width * 0.1), bg->ydim * 0.93,
 407                 draw_centered_text(bg, cr, x1 + space_per_label * (i + 0.5), bg->ydim * 0.93,
 408                         12.0, lb->label);
 409                 i++;
 410         }
 411         cairo_stroke(cr);
 412         cairo_restore(cr);
 413 }
 414
 415 typedef double (*xy_value_extractor)(struct graph_value *v);
 416
 417 static double getx(struct graph_value *v)
 418 {
 419         struct xyvalue *xy = v->value;
 420         return xy->x;
 421 }
 422
 423 static double gety(struct graph_value *v)
 424 {
 425         struct xyvalue *xy = v->value;
 426         return xy->y;
 427 }
 428
 429 static double find_xy_value(struct graph *g, xy_value_extractor getvalue, double_comparator cmp)
 430 {
 431         double tmp, answer = 0.0;
 432         struct graph_label *i;
 433         struct graph_value *j;
 434         int first = 1;
 435
 436         for (i = g->labels; i; i = i->next)
 437                 for (j = i->values; j; j = j->next) {
 438                         tmp = getvalue(j);
 439                         if (first) {
 440                                 first = 0;
 441                                 answer = tmp;
 442                         }
 443                         answer = cmp(tmp, answer);
 444                 }
 445         return answer;
 446 }
 447
 448 void line_graph_draw(struct graph *g, cairo_t *cr)
 449 {
 450         double x1, y1, x2, y2;
 451         double minx, miny, maxx, maxy;
 452         double tx, ty;
 453         struct graph_label *i;
 454         struct graph_value *j;
 455         int good_data = 1, first = 1;
 456
 457         cairo_save(cr);
 458         graph_draw_common(g, cr, &x1, &y1, &x2, &y2);
 459
 460         minx = find_xy_value(g, getx, mindouble);
 461         maxx = find_xy_value(g, getx, maxdouble);
 462         miny = find_xy_value(g, gety, mindouble);
 463         maxy = find_xy_value(g, gety, maxdouble);
 464
 465         if (fabs(maxx - minx) < 1e-20 || fabs(maxy - miny) < 1e-20) {
 466                 good_data = 0;
 467                 minx = 0.0;
 468                 miny = 0.0;
 469                 maxx = 10.0;
 470                 maxy = 100.0;
 471         }
 472
 473         graph_draw_x_ticks(g, cr, x1, y1, x2, y2, minx, maxx, 10);
 474         graph_draw_y_ticks(g, cr, x1, y1, x2, y2, miny, maxy, 10);
 475
 476         if (!good_data)
 477                 goto skip_data;
 478
 479         cairo_set_line_width(cr, 1.5);
 480         for (i = g->labels; i; i = i->next) {
 481                 first = 1;
 482                 if (i->r < 0) /* invisible data */
 483                         continue;
 484                 cairo_set_source_rgb(cr, i->r, i->g, i->b);
 485                 for (j = i->values; j; j = j->next) {
 486                         tx = ((getx(j) - minx) / (maxx - minx)) * (x2 - x1) + x1;
 487                         ty = y2 - ((gety(j) - miny) / (maxy - miny)) * (y2 - y1);
 488                         if (first) {
 489                                 cairo_move_to(cr, tx, ty);
 490                                 first = 0;
 491                         } else {
 492                                 cairo_line_to(cr, tx, ty);
 493                         }
 494                 }
 495                 cairo_stroke(cr);
 496         }
 497
 498 skip_data:
 499         cairo_restore(cr);
 500
 501 }
 502
 503 static void gfree(void *f)
 504 {
 505         if (f)
 506                 free(f);
 507 }
 508
 509 static void setstring(char **str, const char *value)
 510 {
 511         gfree(*str);
 512         *str = strdup(value);
 513 }
 514
 515 void graph_title(struct graph *bg, const char *title)
 516 {
 517         setstring(&bg->title, title);
 518 }
 519
 520 void graph_x_title(struct graph *bg, const char *title)
 521 {
 522         setstring(&bg->xtitle, title);
 523 }
 524
 525 void graph_y_title(struct graph *bg, const char *title)
 526 {
 527         setstring(&bg->ytitle, title);
 528 }
 529
 530 static struct graph_label *graph_find_label(struct graph *bg,
 531                                 const char *label)
 532 {
 533         struct graph_label *i;
 534
 535         for (i = bg->labels; i; i = i->next)
 536                 if (strcmp(label, i->label) == 0)
 537                         return i;
 538         return NULL;
 539 }
 540
 541 void graph_add_label(struct graph *bg, const char *label)
 542 {
 543         struct graph_label *i;
 544
 545         i = graph_find_label(bg, label);
 546         if (i)
 547                 return; /* already present. */
 548         i = calloc(1, sizeof(*i));
 549         i->parent = bg;
 550         setstring(&i->label, label);
 551         i->next = NULL;
 552         if (!bg->tail)
 553                 bg->labels = i;
 554         else
 555                 bg->tail->next = i;
 556         bg->tail = i;
 557 }
 558
 559 static void graph_label_add_value(struct graph_label *i, void *value)
 560 {
 561         struct graph_value *x;
 562
 563         x = malloc(sizeof(*x));
 564         x->value = value;
 565         x->next = NULL;
 566         if (!i->tail) {
 567                 i->values = x;
 568         } else {
 569                 i->tail->next = x;
 570         }
 571         i->tail = x;
 572         i->value_count++;
 573
 574         if (i->parent->per_label_limit != -1 &&
 575                 i->value_count > i->parent->per_label_limit) {
 576                 x = i->values;
 577                 i->values = i->values->next;
 578                 free(x->value);
 579                 free(x);
 580                 i->value_count--;
 581         }
 582 }
 583
 584 int graph_add_data(struct graph *bg, const char *label, const double value)
 585 {
 586         struct graph_label *i;
 587         double *d;
 588
 589         d = malloc(sizeof(*d));
 590         *d = value;
 591
 592         i = graph_find_label(bg, label);
 593         if (!i)
 594                 return -1;
 595         graph_label_add_value(i, d);
 596         return 0;
 597 }
 598
 599 int graph_add_xy_data(struct graph *bg, const char *label,
 600                 const double x, const double y)
 601 {
 602         struct graph_label *i;
 603         struct xyvalue *xy;
 604
 605         xy = malloc(sizeof(*xy));
 606         xy->x = x;
 607         xy->y = y;
 608
 609         i = graph_find_label(bg, label);
 610         if (!i)
 611                 return -1;
 612         graph_label_add_value(i, xy);
 613         return 0;
 614 }
 615
 616 static void graph_free_values(struct graph_value *values)
 617 {
 618         struct graph_value *i, *next;
 619
 620         for (i = values; i; i = next) {
 621                 next = i->next;
 622                 gfree(i->value);
 623                 gfree(i);
 624         }
 625 }
 626
 627 static void graph_free_labels(struct graph_label *labels)
 628 {
 629         struct graph_label *i, *next;
 630
 631         for (i = labels; i; i = next) {
 632                 next = i->next;
 633                 graph_free_values(i->values);
 634                 gfree(i);
 635         }
 636 }
 637
 638 void graph_set_color(struct graph *gr, const char *label,
 639         double red, double green, double blue)
 640 {
 641         struct graph_label *i;
 642         double r, g, b;
 643
 644         if (red < 0.0) { /* invisible color */
 645                 r = -1.0;
 646                 g = -1.0;
 647                 b = -1.0;
 648         } else {
 649                 r = fabs(red);
 650                 g = fabs(green);
 651                 b = fabs(blue);
 652
 653                 if (r > 1.0)
 654                         r = 1.0;
 655                 if (g > 1.0)
 656                         g = 1.0;
 657                 if (b > 1.0)
 658                         b =1.0;
 659         }
 660
 661         for (i = gr->labels; i; i = i->next)
 662                 if (strcmp(i->label, label) == 0) {
 663                         i->r = r;
 664                         i->g = g;
 665                         i->b = b;
 666                         break;
 667                 }
 668 }
 669
 670 void graph_free(struct graph *bg)
 671 {
 672         gfree(bg->title);
 673         gfree(bg->xtitle);
 674         gfree(bg->ytitle);
 675         graph_free_labels(bg->labels);
 676 }
 677
 678 /* For each line in the line graph, up to per_label_limit segments may
 679  * be added.  After that, adding more data to the end of the line
 680  * causes data to drop off of the front of the line.
 681  */
 682 void line_graph_set_data_count_limit(struct graph *g, int per_label_limit)
 683 {
 684         g->per_label_limit = per_label_limit;
 685 }
 686