linux/tools/perf/util/util.c
<<
>>
Prefs
   1#include "../perf.h"
   2#include "util.h"
   3#include "debug.h"
   4#include <api/fs/fs.h>
   5#include <sys/mman.h>
   6#include <sys/utsname.h>
   7#ifdef HAVE_BACKTRACE_SUPPORT
   8#include <execinfo.h>
   9#endif
  10#include <stdio.h>
  11#include <stdlib.h>
  12#include <string.h>
  13#include <errno.h>
  14#include <limits.h>
  15#include <byteswap.h>
  16#include <linux/kernel.h>
  17#include <linux/log2.h>
  18#include <linux/time64.h>
  19#include <unistd.h>
  20#include "callchain.h"
  21#include "strlist.h"
  22
  23#define CALLCHAIN_PARAM_DEFAULT                 \
  24        .mode           = CHAIN_GRAPH_ABS,      \
  25        .min_percent    = 0.5,                  \
  26        .order          = ORDER_CALLEE,         \
  27        .key            = CCKEY_FUNCTION,       \
  28        .value          = CCVAL_PERCENT,        \
  29
  30struct callchain_param callchain_param = {
  31        CALLCHAIN_PARAM_DEFAULT
  32};
  33
  34struct callchain_param callchain_param_default = {
  35        CALLCHAIN_PARAM_DEFAULT
  36};
  37
  38/*
  39 * XXX We need to find a better place for these things...
  40 */
  41unsigned int page_size;
  42int cacheline_size;
  43
  44int sysctl_perf_event_max_stack = PERF_MAX_STACK_DEPTH;
  45int sysctl_perf_event_max_contexts_per_stack = PERF_MAX_CONTEXTS_PER_STACK;
  46
  47bool test_attr__enabled;
  48
  49bool perf_host  = true;
  50bool perf_guest = false;
  51
  52void event_attr_init(struct perf_event_attr *attr)
  53{
  54        if (!perf_host)
  55                attr->exclude_host  = 1;
  56        if (!perf_guest)
  57                attr->exclude_guest = 1;
  58        /* to capture ABI version */
  59        attr->size = sizeof(*attr);
  60}
  61
  62int mkdir_p(char *path, mode_t mode)
  63{
  64        struct stat st;
  65        int err;
  66        char *d = path;
  67
  68        if (*d != '/')
  69                return -1;
  70
  71        if (stat(path, &st) == 0)
  72                return 0;
  73
  74        while (*++d == '/');
  75
  76        while ((d = strchr(d, '/'))) {
  77                *d = '\0';
  78                err = stat(path, &st) && mkdir(path, mode);
  79                *d++ = '/';
  80                if (err)
  81                        return -1;
  82                while (*d == '/')
  83                        ++d;
  84        }
  85        return (stat(path, &st) && mkdir(path, mode)) ? -1 : 0;
  86}
  87
  88int rm_rf(char *path)
  89{
  90        DIR *dir;
  91        int ret = 0;
  92        struct dirent *d;
  93        char namebuf[PATH_MAX];
  94
  95        dir = opendir(path);
  96        if (dir == NULL)
  97                return 0;
  98
  99        while ((d = readdir(dir)) != NULL && !ret) {
 100                struct stat statbuf;
 101
 102                if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
 103                        continue;
 104
 105                scnprintf(namebuf, sizeof(namebuf), "%s/%s",
 106                          path, d->d_name);
 107
 108                /* We have to check symbolic link itself */
 109                ret = lstat(namebuf, &statbuf);
 110                if (ret < 0) {
 111                        pr_debug("stat failed: %s\n", namebuf);
 112                        break;
 113                }
 114
 115                if (S_ISDIR(statbuf.st_mode))
 116                        ret = rm_rf(namebuf);
 117                else
 118                        ret = unlink(namebuf);
 119        }
 120        closedir(dir);
 121
 122        if (ret < 0)
 123                return ret;
 124
 125        return rmdir(path);
 126}
 127
 128/* A filter which removes dot files */
 129bool lsdir_no_dot_filter(const char *name __maybe_unused, struct dirent *d)
 130{
 131        return d->d_name[0] != '.';
 132}
 133
 134/* lsdir reads a directory and store it in strlist */
 135struct strlist *lsdir(const char *name,
 136                      bool (*filter)(const char *, struct dirent *))
 137{
 138        struct strlist *list = NULL;
 139        DIR *dir;
 140        struct dirent *d;
 141
 142        dir = opendir(name);
 143        if (!dir)
 144                return NULL;
 145
 146        list = strlist__new(NULL, NULL);
 147        if (!list) {
 148                errno = ENOMEM;
 149                goto out;
 150        }
 151
 152        while ((d = readdir(dir)) != NULL) {
 153                if (!filter || filter(name, d))
 154                        strlist__add(list, d->d_name);
 155        }
 156
 157out:
 158        closedir(dir);
 159        return list;
 160}
 161
 162static int slow_copyfile(const char *from, const char *to)
 163{
 164        int err = -1;
 165        char *line = NULL;
 166        size_t n;
 167        FILE *from_fp = fopen(from, "r"), *to_fp;
 168
 169        if (from_fp == NULL)
 170                goto out;
 171
 172        to_fp = fopen(to, "w");
 173        if (to_fp == NULL)
 174                goto out_fclose_from;
 175
 176        while (getline(&line, &n, from_fp) > 0)
 177                if (fputs(line, to_fp) == EOF)
 178                        goto out_fclose_to;
 179        err = 0;
 180out_fclose_to:
 181        fclose(to_fp);
 182        free(line);
 183out_fclose_from:
 184        fclose(from_fp);
 185out:
 186        return err;
 187}
 188
 189int copyfile_offset(int ifd, loff_t off_in, int ofd, loff_t off_out, u64 size)
 190{
 191        void *ptr;
 192        loff_t pgoff;
 193
 194        pgoff = off_in & ~(page_size - 1);
 195        off_in -= pgoff;
 196
 197        ptr = mmap(NULL, off_in + size, PROT_READ, MAP_PRIVATE, ifd, pgoff);
 198        if (ptr == MAP_FAILED)
 199                return -1;
 200
 201        while (size) {
 202                ssize_t ret = pwrite(ofd, ptr + off_in, size, off_out);
 203                if (ret < 0 && errno == EINTR)
 204                        continue;
 205                if (ret <= 0)
 206                        break;
 207
 208                size -= ret;
 209                off_in += ret;
 210                off_out -= ret;
 211        }
 212        munmap(ptr, off_in + size);
 213
 214        return size ? -1 : 0;
 215}
 216
 217int copyfile_mode(const char *from, const char *to, mode_t mode)
 218{
 219        int fromfd, tofd;
 220        struct stat st;
 221        int err = -1;
 222        char *tmp = NULL, *ptr = NULL;
 223
 224        if (stat(from, &st))
 225                goto out;
 226
 227        /* extra 'x' at the end is to reserve space for '.' */
 228        if (asprintf(&tmp, "%s.XXXXXXx", to) < 0) {
 229                tmp = NULL;
 230                goto out;
 231        }
 232        ptr = strrchr(tmp, '/');
 233        if (!ptr)
 234                goto out;
 235        ptr = memmove(ptr + 1, ptr, strlen(ptr) - 1);
 236        *ptr = '.';
 237
 238        tofd = mkstemp(tmp);
 239        if (tofd < 0)
 240                goto out;
 241
 242        if (fchmod(tofd, mode))
 243                goto out_close_to;
 244
 245        if (st.st_size == 0) { /* /proc? do it slowly... */
 246                err = slow_copyfile(from, tmp);
 247                goto out_close_to;
 248        }
 249
 250        fromfd = open(from, O_RDONLY);
 251        if (fromfd < 0)
 252                goto out_close_to;
 253
 254        err = copyfile_offset(fromfd, 0, tofd, 0, st.st_size);
 255
 256        close(fromfd);
 257out_close_to:
 258        close(tofd);
 259        if (!err)
 260                err = link(tmp, to);
 261        unlink(tmp);
 262out:
 263        free(tmp);
 264        return err;
 265}
 266
 267int copyfile(const char *from, const char *to)
 268{
 269        return copyfile_mode(from, to, 0755);
 270}
 271
 272unsigned long convert_unit(unsigned long value, char *unit)
 273{
 274        *unit = ' ';
 275
 276        if (value > 1000) {
 277                value /= 1000;
 278                *unit = 'K';
 279        }
 280
 281        if (value > 1000) {
 282                value /= 1000;
 283                *unit = 'M';
 284        }
 285
 286        if (value > 1000) {
 287                value /= 1000;
 288                *unit = 'G';
 289        }
 290
 291        return value;
 292}
 293
 294static ssize_t ion(bool is_read, int fd, void *buf, size_t n)
 295{
 296        void *buf_start = buf;
 297        size_t left = n;
 298
 299        while (left) {
 300                ssize_t ret = is_read ? read(fd, buf, left) :
 301                                        write(fd, buf, left);
 302
 303                if (ret < 0 && errno == EINTR)
 304                        continue;
 305                if (ret <= 0)
 306                        return ret;
 307
 308                left -= ret;
 309                buf  += ret;
 310        }
 311
 312        BUG_ON((size_t)(buf - buf_start) != n);
 313        return n;
 314}
 315
 316/*
 317 * Read exactly 'n' bytes or return an error.
 318 */
 319ssize_t readn(int fd, void *buf, size_t n)
 320{
 321        return ion(true, fd, buf, n);
 322}
 323
 324/*
 325 * Write exactly 'n' bytes or return an error.
 326 */
 327ssize_t writen(int fd, void *buf, size_t n)
 328{
 329        return ion(false, fd, buf, n);
 330}
 331
 332size_t hex_width(u64 v)
 333{
 334        size_t n = 1;
 335
 336        while ((v >>= 4))
 337                ++n;
 338
 339        return n;
 340}
 341
 342static int hex(char ch)
 343{
 344        if ((ch >= '0') && (ch <= '9'))
 345                return ch - '0';
 346        if ((ch >= 'a') && (ch <= 'f'))
 347                return ch - 'a' + 10;
 348        if ((ch >= 'A') && (ch <= 'F'))
 349                return ch - 'A' + 10;
 350        return -1;
 351}
 352
 353/*
 354 * While we find nice hex chars, build a long_val.
 355 * Return number of chars processed.
 356 */
 357int hex2u64(const char *ptr, u64 *long_val)
 358{
 359        const char *p = ptr;
 360        *long_val = 0;
 361
 362        while (*p) {
 363                const int hex_val = hex(*p);
 364
 365                if (hex_val < 0)
 366                        break;
 367
 368                *long_val = (*long_val << 4) | hex_val;
 369                p++;
 370        }
 371
 372        return p - ptr;
 373}
 374
 375/* Obtain a backtrace and print it to stdout. */
 376#ifdef HAVE_BACKTRACE_SUPPORT
 377void dump_stack(void)
 378{
 379        void *array[16];
 380        size_t size = backtrace(array, ARRAY_SIZE(array));
 381        char **strings = backtrace_symbols(array, size);
 382        size_t i;
 383
 384        printf("Obtained %zd stack frames.\n", size);
 385
 386        for (i = 0; i < size; i++)
 387                printf("%s\n", strings[i]);
 388
 389        free(strings);
 390}
 391#else
 392void dump_stack(void) {}
 393#endif
 394
 395void sighandler_dump_stack(int sig)
 396{
 397        psignal(sig, "perf");
 398        dump_stack();
 399        signal(sig, SIG_DFL);
 400        raise(sig);
 401}
 402
 403int parse_nsec_time(const char *str, u64 *ptime)
 404{
 405        u64 time_sec, time_nsec;
 406        char *end;
 407
 408        time_sec = strtoul(str, &end, 10);
 409        if (*end != '.' && *end != '\0')
 410                return -1;
 411
 412        if (*end == '.') {
 413                int i;
 414                char nsec_buf[10];
 415
 416                if (strlen(++end) > 9)
 417                        return -1;
 418
 419                strncpy(nsec_buf, end, 9);
 420                nsec_buf[9] = '\0';
 421
 422                /* make it nsec precision */
 423                for (i = strlen(nsec_buf); i < 9; i++)
 424                        nsec_buf[i] = '0';
 425
 426                time_nsec = strtoul(nsec_buf, &end, 10);
 427                if (*end != '\0')
 428                        return -1;
 429        } else
 430                time_nsec = 0;
 431
 432        *ptime = time_sec * NSEC_PER_SEC + time_nsec;
 433        return 0;
 434}
 435
 436unsigned long parse_tag_value(const char *str, struct parse_tag *tags)
 437{
 438        struct parse_tag *i = tags;
 439
 440        while (i->tag) {
 441                char *s;
 442
 443                s = strchr(str, i->tag);
 444                if (s) {
 445                        unsigned long int value;
 446                        char *endptr;
 447
 448                        value = strtoul(str, &endptr, 10);
 449                        if (s != endptr)
 450                                break;
 451
 452                        if (value > ULONG_MAX / i->mult)
 453                                break;
 454                        value *= i->mult;
 455                        return value;
 456                }
 457                i++;
 458        }
 459
 460        return (unsigned long) -1;
 461}
 462
 463int get_stack_size(const char *str, unsigned long *_size)
 464{
 465        char *endptr;
 466        unsigned long size;
 467        unsigned long max_size = round_down(USHRT_MAX, sizeof(u64));
 468
 469        size = strtoul(str, &endptr, 0);
 470
 471        do {
 472                if (*endptr)
 473                        break;
 474
 475                size = round_up(size, sizeof(u64));
 476                if (!size || size > max_size)
 477                        break;
 478
 479                *_size = size;
 480                return 0;
 481
 482        } while (0);
 483
 484        pr_err("callchain: Incorrect stack dump size (max %ld): %s\n",
 485               max_size, str);
 486        return -1;
 487}
 488
 489int parse_callchain_record(const char *arg, struct callchain_param *param)
 490{
 491        char *tok, *name, *saveptr = NULL;
 492        char *buf;
 493        int ret = -1;
 494
 495        /* We need buffer that we know we can write to. */
 496        buf = malloc(strlen(arg) + 1);
 497        if (!buf)
 498                return -ENOMEM;
 499
 500        strcpy(buf, arg);
 501
 502        tok = strtok_r((char *)buf, ",", &saveptr);
 503        name = tok ? : (char *)buf;
 504
 505        do {
 506                /* Framepointer style */
 507                if (!strncmp(name, "fp", sizeof("fp"))) {
 508                        if (!strtok_r(NULL, ",", &saveptr)) {
 509                                param->record_mode = CALLCHAIN_FP;
 510                                ret = 0;
 511                        } else
 512                                pr_err("callchain: No more arguments "
 513                                       "needed for --call-graph fp\n");
 514                        break;
 515
 516                /* Dwarf style */
 517                } else if (!strncmp(name, "dwarf", sizeof("dwarf"))) {
 518                        const unsigned long default_stack_dump_size = 8192;
 519
 520                        ret = 0;
 521                        param->record_mode = CALLCHAIN_DWARF;
 522                        param->dump_size = default_stack_dump_size;
 523
 524                        tok = strtok_r(NULL, ",", &saveptr);
 525                        if (tok) {
 526                                unsigned long size = 0;
 527
 528                                ret = get_stack_size(tok, &size);
 529                                param->dump_size = size;
 530                        }
 531                } else if (!strncmp(name, "lbr", sizeof("lbr"))) {
 532                        if (!strtok_r(NULL, ",", &saveptr)) {
 533                                param->record_mode = CALLCHAIN_LBR;
 534                                ret = 0;
 535                        } else
 536                                pr_err("callchain: No more arguments "
 537                                        "needed for --call-graph lbr\n");
 538                        break;
 539                } else {
 540                        pr_err("callchain: Unknown --call-graph option "
 541                               "value: %s\n", arg);
 542                        break;
 543                }
 544
 545        } while (0);
 546
 547        free(buf);
 548        return ret;
 549}
 550
 551const char *get_filename_for_perf_kvm(void)
 552{
 553        const char *filename;
 554
 555        if (perf_host && !perf_guest)
 556                filename = strdup("perf.data.host");
 557        else if (!perf_host && perf_guest)
 558                filename = strdup("perf.data.guest");
 559        else
 560                filename = strdup("perf.data.kvm");
 561
 562        return filename;
 563}
 564
 565int perf_event_paranoid(void)
 566{
 567        int value;
 568
 569        if (sysctl__read_int("kernel/perf_event_paranoid", &value))
 570                return INT_MAX;
 571
 572        return value;
 573}
 574
 575void mem_bswap_32(void *src, int byte_size)
 576{
 577        u32 *m = src;
 578        while (byte_size > 0) {
 579                *m = bswap_32(*m);
 580                byte_size -= sizeof(u32);
 581                ++m;
 582        }
 583}
 584
 585void mem_bswap_64(void *src, int byte_size)
 586{
 587        u64 *m = src;
 588
 589        while (byte_size > 0) {
 590                *m = bswap_64(*m);
 591                byte_size -= sizeof(u64);
 592                ++m;
 593        }
 594}
 595
 596bool find_process(const char *name)
 597{
 598        size_t len = strlen(name);
 599        DIR *dir;
 600        struct dirent *d;
 601        int ret = -1;
 602
 603        dir = opendir(procfs__mountpoint());
 604        if (!dir)
 605                return false;
 606
 607        /* Walk through the directory. */
 608        while (ret && (d = readdir(dir)) != NULL) {
 609                char path[PATH_MAX];
 610                char *data;
 611                size_t size;
 612
 613                if ((d->d_type != DT_DIR) ||
 614                     !strcmp(".", d->d_name) ||
 615                     !strcmp("..", d->d_name))
 616                        continue;
 617
 618                scnprintf(path, sizeof(path), "%s/%s/comm",
 619                          procfs__mountpoint(), d->d_name);
 620
 621                if (filename__read_str(path, &data, &size))
 622                        continue;
 623
 624                ret = strncmp(name, data, len);
 625                free(data);
 626        }
 627
 628        closedir(dir);
 629        return ret ? false : true;
 630}
 631
 632int
 633fetch_kernel_version(unsigned int *puint, char *str,
 634                     size_t str_size)
 635{
 636        struct utsname utsname;
 637        int version, patchlevel, sublevel, err;
 638
 639        if (uname(&utsname))
 640                return -1;
 641
 642        if (str && str_size) {
 643                strncpy(str, utsname.release, str_size);
 644                str[str_size - 1] = '\0';
 645        }
 646
 647        err = sscanf(utsname.release, "%d.%d.%d",
 648                     &version, &patchlevel, &sublevel);
 649
 650        if (err != 3) {
 651                pr_debug("Unablt to get kernel version from uname '%s'\n",
 652                         utsname.release);
 653                return -1;
 654        }
 655
 656        if (puint)
 657                *puint = (version << 16) + (patchlevel << 8) + sublevel;
 658        return 0;
 659}
 660
 661const char *perf_tip(const char *dirpath)
 662{
 663        struct strlist *tips;
 664        struct str_node *node;
 665        char *tip = NULL;
 666        struct strlist_config conf = {
 667                .dirname = dirpath,
 668                .file_only = true,
 669        };
 670
 671        tips = strlist__new("tips.txt", &conf);
 672        if (tips == NULL)
 673                return errno == ENOENT ? NULL : "Tip: get more memory! ;-p";
 674
 675        if (strlist__nr_entries(tips) == 0)
 676                goto out;
 677
 678        node = strlist__entry(tips, random() % strlist__nr_entries(tips));
 679        if (asprintf(&tip, "Tip: %s", node->s) < 0)
 680                tip = (char *)"Tip: get more memory! ;-)";
 681
 682out:
 683        strlist__delete(tips);
 684
 685        return tip;
 686}
 687
 688bool is_regular_file(const char *file)
 689{
 690        struct stat st;
 691
 692        if (stat(file, &st))
 693                return false;
 694
 695        return S_ISREG(st.st_mode);
 696}
 697
 698int fetch_current_timestamp(char *buf, size_t sz)
 699{
 700        struct timeval tv;
 701        struct tm tm;
 702        char dt[32];
 703
 704        if (gettimeofday(&tv, NULL) || !localtime_r(&tv.tv_sec, &tm))
 705                return -1;
 706
 707        if (!strftime(dt, sizeof(dt), "%Y%m%d%H%M%S", &tm))
 708                return -1;
 709
 710        scnprintf(buf, sz, "%s%02u", dt, (unsigned)tv.tv_usec / 10000);
 711
 712        return 0;
 713}
 714
 715void print_binary(unsigned char *data, size_t len,
 716                  size_t bytes_per_line, print_binary_t printer,
 717                  void *extra)
 718{
 719        size_t i, j, mask;
 720
 721        if (!printer)
 722                return;
 723
 724        bytes_per_line = roundup_pow_of_two(bytes_per_line);
 725        mask = bytes_per_line - 1;
 726
 727        printer(BINARY_PRINT_DATA_BEGIN, 0, extra);
 728        for (i = 0; i < len; i++) {
 729                if ((i & mask) == 0) {
 730                        printer(BINARY_PRINT_LINE_BEGIN, -1, extra);
 731                        printer(BINARY_PRINT_ADDR, i, extra);
 732                }
 733
 734                printer(BINARY_PRINT_NUM_DATA, data[i], extra);
 735
 736                if (((i & mask) == mask) || i == len - 1) {
 737                        for (j = 0; j < mask-(i & mask); j++)
 738                                printer(BINARY_PRINT_NUM_PAD, -1, extra);
 739
 740                        printer(BINARY_PRINT_SEP, i, extra);
 741                        for (j = i & ~mask; j <= i; j++)
 742                                printer(BINARY_PRINT_CHAR_DATA, data[j], extra);
 743                        for (j = 0; j < mask-(i & mask); j++)
 744                                printer(BINARY_PRINT_CHAR_PAD, i, extra);
 745                        printer(BINARY_PRINT_LINE_END, -1, extra);
 746                }
 747        }
 748        printer(BINARY_PRINT_DATA_END, -1, extra);
 749}
 750
 751int is_printable_array(char *p, unsigned int len)
 752{
 753        unsigned int i;
 754
 755        if (!p || !len || p[len - 1] != 0)
 756                return 0;
 757
 758        len--;
 759
 760        for (i = 0; i < len; i++) {
 761                if (!isprint(p[i]) && !isspace(p[i]))
 762                        return 0;
 763        }
 764        return 1;
 765}
 766