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