tools/perf/util/color.c

   1 #include <linux/kernel.h>
   2 #include "cache.h"
   3 #include "color.h"
   4 #include <math.h>
   5
   6 int perf_use_color_default = -1;
   7
   8 int perf_config_colorbool(const char *var, const char *value, int stdout_is_tty)
   9 {
  10         if (value) {
  11                 if (!strcasecmp(value, "never"))
  12                         return 0;
  13                 if (!strcasecmp(value, "always"))
  14                         return 1;
  15                 if (!strcasecmp(value, "auto"))
  16                         goto auto_color;
  17         }
  18
  19         /* Missing or explicit false to turn off colorization */
  20         if (!perf_config_bool(var, value))
  21                 return 0;
  22
  23         /* any normal truth value defaults to 'auto' */
  24  auto_color:
  25         if (stdout_is_tty < 0)
  26                 stdout_is_tty = isatty(1);
  27         if (stdout_is_tty || (pager_in_use() && pager_use_color)) {
  28                 char *term = getenv("TERM");
  29                 if (term && strcmp(term, "dumb"))
  30                         return 1;
  31         }
  32         return 0;
  33 }
  34
  35 int perf_color_default_config(const char *var, const char *value, void *cb)
  36 {
  37         if (!strcmp(var, "color.ui")) {
  38                 perf_use_color_default = perf_config_colorbool(var, value, -1);
  39                 return 0;
  40         }
  41
  42         return perf_default_config(var, value, cb);
  43 }
  44
  45 static int __color_vsnprintf(char *bf, size_t size, const char *color,
  46                              const char *fmt, va_list args, const char *trail)
  47 {
  48         int r = 0;
  49
  50         /*
  51          * Auto-detect:
  52          */
  53         if (perf_use_color_default < 0) {
  54                 if (isatty(1) || pager_in_use())
  55                         perf_use_color_default = 1;
  56                 else
  57                         perf_use_color_default = 0;
  58         }
  59
  60         if (perf_use_color_default && *color)
  61                 r += scnprintf(bf, size, "%s", color);
  62         r += vscnprintf(bf + r, size - r, fmt, args);
  63         if (perf_use_color_default && *color)
  64                 r += scnprintf(bf + r, size - r, "%s", PERF_COLOR_RESET);
  65         if (trail)
  66                 r += scnprintf(bf + r, size - r, "%s", trail);
  67         return r;
  68 }
  69
  70 static int __color_vfprintf(FILE *fp, const char *color, const char *fmt,
  71                 va_list args)
  72 {
  73         int r = 0;
  74
  75         /*
  76          * Auto-detect:
  77          */
  78         if (perf_use_color_default < 0) {
  79                 if (isatty(fileno(fp)) || pager_in_use())
  80                         perf_use_color_default = 1;
  81                 else
  82                         perf_use_color_default = 0;
  83         }
  84
  85         if (perf_use_color_default && *color)
  86                 r += fprintf(fp, "%s", color);
  87         r += vfprintf(fp, fmt, args);
  88         if (perf_use_color_default && *color)
  89                 r += fprintf(fp, "%s", PERF_COLOR_RESET);
  90         return r;
  91 }
  92
  93 int color_vsnprintf(char *bf, size_t size, const char *color,
  94                     const char *fmt, va_list args)
  95 {
  96         return __color_vsnprintf(bf, size, color, fmt, args, NULL);
  97 }
  98
  99 int color_vfprintf(FILE *fp, const char *color, const char *fmt, va_list args)
 100 {
 101         return __color_vfprintf(fp, color, fmt, args);
 102 }
 103
 104 int color_snprintf(char *bf, size_t size, const char *color,
 105                    const char *fmt, ...)
 106 {
 107         va_list args;
 108         int r;
 109
 110         va_start(args, fmt);
 111         r = color_vsnprintf(bf, size, color, fmt, args);
 112         va_end(args);
 113         return r;
 114 }
 115
 116 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
 117 {
 118         va_list args;
 119         int r;
 120
 121         va_start(args, fmt);
 122         r = color_vfprintf(fp, color, fmt, args);
 123         va_end(args);
 124         return r;
 125 }
 126
 127 /*
 128  * This function splits the buffer by newlines and colors the lines individually.
 129  *
 130  * Returns 0 on success.
 131  */
 132 int color_fwrite_lines(FILE *fp, const char *color,
 133                 size_t count, const char *buf)
 134 {
 135         if (!*color)
 136                 return fwrite(buf, count, 1, fp) != 1;
 137
 138         while (count) {
 139                 char *p = memchr(buf, '\n', count);
 140
 141                 if (p != buf && (fputs(color, fp) < 0 ||
 142                                 fwrite(buf, p ? (size_t)(p - buf) : count, 1, fp) != 1 ||
 143                                 fputs(PERF_COLOR_RESET, fp) < 0))
 144                         return -1;
 145                 if (!p)
 146                         return 0;
 147                 if (fputc('\n', fp) < 0)
 148                         return -1;
 149                 count -= p + 1 - buf;
 150                 buf = p + 1;
 151         }
 152         return 0;
 153 }
 154
 155 const char *get_percent_color(double percent)
 156 {
 157         const char *color = PERF_COLOR_NORMAL;
 158
 159         /*
 160          * We color high-overhead entries in red, mid-overhead
 161          * entries in green - and keep the low overhead places
 162          * normal:
 163          */
 164         if (fabs(percent) >= MIN_RED)
 165                 color = PERF_COLOR_RED;
 166         else {
 167                 if (fabs(percent) > MIN_GREEN)
 168                         color = PERF_COLOR_GREEN;
 169         }
 170         return color;
 171 }
 172
 173 int percent_color_fprintf(FILE *fp, const char *fmt, double percent)
 174 {
 175         int r;
 176         const char *color;
 177
 178         color = get_percent_color(percent);
 179         r = color_fprintf(fp, color, fmt, percent);
 180
 181         return r;
 182 }
 183
 184 int value_color_snprintf(char *bf, size_t size, const char *fmt, double value)
 185 {
 186         const char *color = get_percent_color(value);
 187         return color_snprintf(bf, size, color, fmt, value);
 188 }
 189
 190 int percent_color_snprintf(char *bf, size_t size, const char *fmt, ...)
 191 {
 192         va_list args;
 193         double percent;
 194
 195         va_start(args, fmt);
 196         percent = va_arg(args, double);
 197         va_end(args);
 198         return value_color_snprintf(bf, size, fmt, percent);
 199 }
 200
 201 int percent_color_len_snprintf(char *bf, size_t size, const char *fmt, ...)
 202 {
 203         va_list args;
 204         int len;
 205         double percent;
 206         const char *color;
 207
 208         va_start(args, fmt);
 209         len = va_arg(args, int);
 210         percent = va_arg(args, double);
 211         va_end(args);
 212
 213         color = get_percent_color(percent);
 214         return color_snprintf(bf, size, color, fmt, len, percent);
 215 }