tools/perf/builtin-buildid-cache.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * builtin-buildid-cache.c
   4  *
   5  * Builtin buildid-cache command: Manages build-id cache
   6  *
   7  * Copyright (C) 2010, Red Hat Inc.
   8  * Copyright (C) 2010, Arnaldo Carvalho de Melo <acme@redhat.com>
   9  */
  10 #include <sys/types.h>
  11 #include <sys/time.h>
  12 #include <time.h>
  13 #include <dirent.h>
  14 #include <errno.h>
  15 #include <unistd.h>
  16 #include "builtin.h"
  17 #include "namespaces.h"
  18 #include "util/debug.h"
  19 #include "util/header.h"
  20 #include <subcmd/pager.h>
  21 #include <subcmd/parse-options.h>
  22 #include "util/strlist.h"
  23 #include "util/build-id.h"
  24 #include "util/session.h"
  25 #include "util/dso.h"
  26 #include "util/symbol.h"
  27 #include "util/time-utils.h"
  28 #include "util/util.h"
  29 #include "util/probe-file.h"
  30 #include <linux/string.h>
  31
  32 static int build_id_cache__kcore_buildid(const char *proc_dir, char *sbuildid)
  33 {
  34         char root_dir[PATH_MAX];
  35         char *p;
  36
  37         strlcpy(root_dir, proc_dir, sizeof(root_dir));
  38
  39         p = strrchr(root_dir, '/');
  40         if (!p)
  41                 return -1;
  42         *p = '\0';
  43         return sysfs__sprintf_build_id(root_dir, sbuildid);
  44 }
  45
  46 static int build_id_cache__kcore_dir(char *dir, size_t sz)
  47 {
  48         return fetch_current_timestamp(dir, sz);
  49 }
  50
  51 static bool same_kallsyms_reloc(const char *from_dir, char *to_dir)
  52 {
  53         char from[PATH_MAX];
  54         char to[PATH_MAX];
  55         const char *name;
  56         u64 addr1 = 0, addr2 = 0;
  57         int i, err = -1;
  58
  59         scnprintf(from, sizeof(from), "%s/kallsyms", from_dir);
  60         scnprintf(to, sizeof(to), "%s/kallsyms", to_dir);
  61
  62         for (i = 0; (name = ref_reloc_sym_names[i]) != NULL; i++) {
  63                 err = kallsyms__get_function_start(from, name, &addr1);
  64                 if (!err)
  65                         break;
  66         }
  67
  68         if (err)
  69                 return false;
  70
  71         if (kallsyms__get_function_start(to, name, &addr2))
  72                 return false;
  73
  74         return addr1 == addr2;
  75 }
  76
  77 static int build_id_cache__kcore_existing(const char *from_dir, char *to_dir,
  78                                           size_t to_dir_sz)
  79 {
  80         char from[PATH_MAX];
  81         char to[PATH_MAX];
  82         char to_subdir[PATH_MAX];
  83         struct dirent *dent;
  84         int ret = -1;
  85         DIR *d;
  86
  87         d = opendir(to_dir);
  88         if (!d)
  89                 return -1;
  90
  91         scnprintf(from, sizeof(from), "%s/modules", from_dir);
  92
  93         while (1) {
  94                 dent = readdir(d);
  95                 if (!dent)
  96                         break;
  97                 if (dent->d_type != DT_DIR)
  98                         continue;
  99                 scnprintf(to, sizeof(to), "%s/%s/modules", to_dir,
 100                           dent->d_name);
 101                 scnprintf(to_subdir, sizeof(to_subdir), "%s/%s",
 102                           to_dir, dent->d_name);
 103                 if (!compare_proc_modules(from, to) &&
 104                     same_kallsyms_reloc(from_dir, to_subdir)) {
 105                         strlcpy(to_dir, to_subdir, to_dir_sz);
 106                         ret = 0;
 107                         break;
 108                 }
 109         }
 110
 111         closedir(d);
 112
 113         return ret;
 114 }
 115
 116 static int build_id_cache__add_kcore(const char *filename, bool force)
 117 {
 118         char dir[32], sbuildid[SBUILD_ID_SIZE];
 119         char from_dir[PATH_MAX], to_dir[PATH_MAX];
 120         char *p;
 121
 122         strlcpy(from_dir, filename, sizeof(from_dir));
 123
 124         p = strrchr(from_dir, '/');
 125         if (!p || strcmp(p + 1, "kcore"))
 126                 return -1;
 127         *p = '\0';
 128
 129         if (build_id_cache__kcore_buildid(from_dir, sbuildid) < 0)
 130                 return -1;
 131
 132         scnprintf(to_dir, sizeof(to_dir), "%s/%s/%s",
 133                   buildid_dir, DSO__NAME_KCORE, sbuildid);
 134
 135         if (!force &&
 136             !build_id_cache__kcore_existing(from_dir, to_dir, sizeof(to_dir))) {
 137                 pr_debug("same kcore found in %s\n", to_dir);
 138                 return 0;
 139         }
 140
 141         if (build_id_cache__kcore_dir(dir, sizeof(dir)))
 142                 return -1;
 143
 144         scnprintf(to_dir, sizeof(to_dir), "%s/%s/%s/%s",
 145                   buildid_dir, DSO__NAME_KCORE, sbuildid, dir);
 146
 147         if (mkdir_p(to_dir, 0755))
 148                 return -1;
 149
 150         if (kcore_copy(from_dir, to_dir)) {
 151                 /* Remove YYYYmmddHHMMSShh directory */
 152                 if (!rmdir(to_dir)) {
 153                         p = strrchr(to_dir, '/');
 154                         if (p)
 155                                 *p = '\0';
 156                         /* Try to remove buildid directory */
 157                         if (!rmdir(to_dir)) {
 158                                 p = strrchr(to_dir, '/');
 159                                 if (p)
 160                                         *p = '\0';
 161                                 /* Try to remove [kernel.kcore] directory */
 162                                 rmdir(to_dir);
 163                         }
 164                 }
 165                 return -1;
 166         }
 167
 168         pr_debug("kcore added to build-id cache directory %s\n", to_dir);
 169
 170         return 0;
 171 }
 172
 173 static int build_id_cache__add_file(const char *filename, struct nsinfo *nsi)
 174 {
 175         char sbuild_id[SBUILD_ID_SIZE];
 176         u8 build_id[BUILD_ID_SIZE];
 177         int err;
 178         struct nscookie nsc;
 179
 180         nsinfo__mountns_enter(nsi, &nsc);
 181         err = filename__read_build_id(filename, &build_id, sizeof(build_id));
 182         nsinfo__mountns_exit(&nsc);
 183         if (err < 0) {
 184                 pr_debug("Couldn't read a build-id in %s\n", filename);
 185                 return -1;
 186         }
 187
 188         build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 189         err = build_id_cache__add_s(sbuild_id, filename, nsi,
 190                                     false, false);
 191         pr_debug("Adding %s %s: %s\n", sbuild_id, filename,
 192                  err ? "FAIL" : "Ok");
 193         return err;
 194 }
 195
 196 static int build_id_cache__remove_file(const char *filename, struct nsinfo *nsi)
 197 {
 198         u8 build_id[BUILD_ID_SIZE];
 199         char sbuild_id[SBUILD_ID_SIZE];
 200         struct nscookie nsc;
 201
 202         int err;
 203
 204         nsinfo__mountns_enter(nsi, &nsc);
 205         err = filename__read_build_id(filename, &build_id, sizeof(build_id));
 206         nsinfo__mountns_exit(&nsc);
 207         if (err < 0) {
 208                 pr_debug("Couldn't read a build-id in %s\n", filename);
 209                 return -1;
 210         }
 211
 212         build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 213         err = build_id_cache__remove_s(sbuild_id);
 214         pr_debug("Removing %s %s: %s\n", sbuild_id, filename,
 215                  err ? "FAIL" : "Ok");
 216
 217         return err;
 218 }
 219
 220 static int build_id_cache__purge_path(const char *pathname, struct nsinfo *nsi)
 221 {
 222         struct strlist *list;
 223         struct str_node *pos;
 224         int err;
 225
 226         err = build_id_cache__list_build_ids(pathname, nsi, &list);
 227         if (err)
 228                 goto out;
 229
 230         strlist__for_each_entry(pos, list) {
 231                 err = build_id_cache__remove_s(pos->s);
 232                 pr_debug("Removing %s %s: %s\n", pos->s, pathname,
 233                          err ? "FAIL" : "Ok");
 234                 if (err)
 235                         break;
 236         }
 237         strlist__delete(list);
 238
 239 out:
 240         pr_debug("Purging %s: %s\n", pathname, err ? "FAIL" : "Ok");
 241
 242         return err;
 243 }
 244
 245 static int build_id_cache__purge_all(void)
 246 {
 247         struct strlist *list;
 248         struct str_node *pos;
 249         int err = 0;
 250         char *buf;
 251
 252         list = build_id_cache__list_all(false);
 253         if (!list) {
 254                 pr_debug("Failed to get buildids: -%d\n", errno);
 255                 return -EINVAL;
 256         }
 257
 258         strlist__for_each_entry(pos, list) {
 259                 buf = build_id_cache__origname(pos->s);
 260                 err = build_id_cache__remove_s(pos->s);
 261                 pr_debug("Removing %s (%s): %s\n", buf, pos->s,
 262                          err ? "FAIL" : "Ok");
 263                 free(buf);
 264                 if (err)
 265                         break;
 266         }
 267         strlist__delete(list);
 268
 269         pr_debug("Purged all: %s\n", err ? "FAIL" : "Ok");
 270         return err;
 271 }
 272
 273 static bool dso__missing_buildid_cache(struct dso *dso, int parm __maybe_unused)
 274 {
 275         char filename[PATH_MAX];
 276         u8 build_id[BUILD_ID_SIZE];
 277
 278         if (dso__build_id_filename(dso, filename, sizeof(filename), false) &&
 279             filename__read_build_id(filename, build_id,
 280                                     sizeof(build_id)) != sizeof(build_id)) {
 281                 if (errno == ENOENT)
 282                         return false;
 283
 284                 pr_warning("Problems with %s file, consider removing it from the cache\n",
 285                            filename);
 286         } else if (memcmp(dso->build_id, build_id, sizeof(dso->build_id))) {
 287                 pr_warning("Problems with %s file, consider removing it from the cache\n",
 288                            filename);
 289         }
 290
 291         return true;
 292 }
 293
 294 static int build_id_cache__fprintf_missing(struct perf_session *session, FILE *fp)
 295 {
 296         perf_session__fprintf_dsos_buildid(session, fp, dso__missing_buildid_cache, 0);
 297         return 0;
 298 }
 299
 300 static int build_id_cache__update_file(const char *filename, struct nsinfo *nsi)
 301 {
 302         u8 build_id[BUILD_ID_SIZE];
 303         char sbuild_id[SBUILD_ID_SIZE];
 304         struct nscookie nsc;
 305
 306         int err;
 307
 308         nsinfo__mountns_enter(nsi, &nsc);
 309         err = filename__read_build_id(filename, &build_id, sizeof(build_id));
 310         nsinfo__mountns_exit(&nsc);
 311         if (err < 0) {
 312                 pr_debug("Couldn't read a build-id in %s\n", filename);
 313                 return -1;
 314         }
 315         err = 0;
 316
 317         build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 318         if (build_id_cache__cached(sbuild_id))
 319                 err = build_id_cache__remove_s(sbuild_id);
 320
 321         if (!err)
 322                 err = build_id_cache__add_s(sbuild_id, filename, nsi, false,
 323                                             false);
 324
 325         pr_debug("Updating %s %s: %s\n", sbuild_id, filename,
 326                  err ? "FAIL" : "Ok");
 327
 328         return err;
 329 }
 330
 331 static int build_id_cache__show_all(void)
 332 {
 333         struct strlist *bidlist;
 334         struct str_node *nd;
 335         char *buf;
 336
 337         bidlist = build_id_cache__list_all(true);
 338         if (!bidlist) {
 339                 pr_debug("Failed to get buildids: -%d\n", errno);
 340                 return -1;
 341         }
 342         strlist__for_each_entry(nd, bidlist) {
 343                 buf = build_id_cache__origname(nd->s);
 344                 fprintf(stdout, "%s %s\n", nd->s, buf);
 345                 free(buf);
 346         }
 347         strlist__delete(bidlist);
 348         return 0;
 349 }
 350
 351 int cmd_buildid_cache(int argc, const char **argv)
 352 {
 353         struct strlist *list;
 354         struct str_node *pos;
 355         int ret = 0;
 356         int ns_id = -1;
 357         bool force = false;
 358         bool list_files = false;
 359         bool opts_flag = false;
 360         bool purge_all = false;
 361         char const *add_name_list_str = NULL,
 362                    *remove_name_list_str = NULL,
 363                    *purge_name_list_str = NULL,
 364                    *missing_filename = NULL,
 365                    *update_name_list_str = NULL,
 366                    *kcore_filename = NULL;
 367         char sbuf[STRERR_BUFSIZE];
 368
 369         struct perf_data data = {
 370                 .mode  = PERF_DATA_MODE_READ,
 371         };
 372         struct perf_session *session = NULL;
 373         struct nsinfo *nsi = NULL;
 374
 375         const struct option buildid_cache_options[] = {
 376         OPT_STRING('a', "add", &add_name_list_str,
 377                    "file list", "file(s) to add"),
 378         OPT_STRING('k', "kcore", &kcore_filename,
 379                    "file", "kcore file to add"),
 380         OPT_STRING('r', "remove", &remove_name_list_str, "file list",
 381                     "file(s) to remove"),
 382         OPT_STRING('p', "purge", &purge_name_list_str, "file list",
 383                     "file(s) to remove (remove old caches too)"),
 384         OPT_BOOLEAN('P', "purge-all", &purge_all, "purge all cached files"),
 385         OPT_BOOLEAN('l', "list", &list_files, "list all cached files"),
 386         OPT_STRING('M', "missing", &missing_filename, "file",
 387                    "to find missing build ids in the cache"),
 388         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 389         OPT_STRING('u', "update", &update_name_list_str, "file list",
 390                     "file(s) to update"),
 391         OPT_INCR('v', "verbose", &verbose, "be more verbose"),
 392         OPT_INTEGER(0, "target-ns", &ns_id, "target pid for namespace context"),
 393         OPT_END()
 394         };
 395         const char * const buildid_cache_usage[] = {
 396                 "perf buildid-cache [<options>]",
 397                 NULL
 398         };
 399
 400         argc = parse_options(argc, argv, buildid_cache_options,
 401                              buildid_cache_usage, 0);
 402
 403         opts_flag = add_name_list_str || kcore_filename ||
 404                 remove_name_list_str || purge_name_list_str ||
 405                 missing_filename || update_name_list_str ||
 406                 purge_all;
 407
 408         if (argc || !(list_files || opts_flag))
 409                 usage_with_options(buildid_cache_usage, buildid_cache_options);
 410
 411         /* -l is exclusive. It can not be used with other options. */
 412         if (list_files && opts_flag) {
 413                 usage_with_options_msg(buildid_cache_usage,
 414                         buildid_cache_options, "-l is exclusive.\n");
 415         }
 416
 417         if (ns_id > 0)
 418                 nsi = nsinfo__new(ns_id);
 419
 420         if (missing_filename) {
 421                 data.path  = missing_filename;
 422                 data.force = force;
 423
 424                 session = perf_session__new(&data, false, NULL);
 425                 if (session == NULL)
 426                         return -1;
 427         }
 428
 429         if (symbol__init(session ? &session->header.env : NULL) < 0)
 430                 goto out;
 431
 432         setup_pager();
 433
 434         if (list_files) {
 435                 ret = build_id_cache__show_all();
 436                 goto out;
 437         }
 438
 439         if (add_name_list_str) {
 440                 list = strlist__new(add_name_list_str, NULL);
 441                 if (list) {
 442                         strlist__for_each_entry(pos, list)
 443                                 if (build_id_cache__add_file(pos->s, nsi)) {
 444                                         if (errno == EEXIST) {
 445                                                 pr_debug("%s already in the cache\n",
 446                                                          pos->s);
 447                                                 continue;
 448                                         }
 449                                         pr_warning("Couldn't add %s: %s\n",
 450                                                    pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
 451                                 }
 452
 453                         strlist__delete(list);
 454                 }
 455         }
 456
 457         if (remove_name_list_str) {
 458                 list = strlist__new(remove_name_list_str, NULL);
 459                 if (list) {
 460                         strlist__for_each_entry(pos, list)
 461                                 if (build_id_cache__remove_file(pos->s, nsi)) {
 462                                         if (errno == ENOENT) {
 463                                                 pr_debug("%s wasn't in the cache\n",
 464                                                          pos->s);
 465                                                 continue;
 466                                         }
 467                                         pr_warning("Couldn't remove %s: %s\n",
 468                                                    pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
 469                                 }
 470
 471                         strlist__delete(list);
 472                 }
 473         }
 474
 475         if (purge_name_list_str) {
 476                 list = strlist__new(purge_name_list_str, NULL);
 477                 if (list) {
 478                         strlist__for_each_entry(pos, list)
 479                                 if (build_id_cache__purge_path(pos->s, nsi)) {
 480                                         if (errno == ENOENT) {
 481                                                 pr_debug("%s wasn't in the cache\n",
 482                                                          pos->s);
 483                                                 continue;
 484                                         }
 485                                         pr_warning("Couldn't remove %s: %s\n",
 486                                                    pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
 487                                 }
 488
 489                         strlist__delete(list);
 490                 }
 491         }
 492
 493         if (purge_all) {
 494                 if (build_id_cache__purge_all()) {
 495                         pr_warning("Couldn't remove some caches. Error: %s.\n",
 496                                 str_error_r(errno, sbuf, sizeof(sbuf)));
 497                 }
 498         }
 499
 500         if (missing_filename)
 501                 ret = build_id_cache__fprintf_missing(session, stdout);
 502
 503         if (update_name_list_str) {
 504                 list = strlist__new(update_name_list_str, NULL);
 505                 if (list) {
 506                         strlist__for_each_entry(pos, list)
 507                                 if (build_id_cache__update_file(pos->s, nsi)) {
 508                                         if (errno == ENOENT) {
 509                                                 pr_debug("%s wasn't in the cache\n",
 510                                                          pos->s);
 511                                                 continue;
 512                                         }
 513                                         pr_warning("Couldn't update %s: %s\n",
 514                                                    pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
 515                                 }
 516
 517                         strlist__delete(list);
 518                 }
 519         }
 520
 521         if (kcore_filename && build_id_cache__add_kcore(kcore_filename, force))
 522                 pr_warning("Couldn't add %s\n", kcore_filename);
 523
 524 out:
 525         perf_session__delete(session);
 526         nsinfo__zput(nsi);
 527
 528         return ret;
 529 }