tools/perf/builtin-buildid-cache.c

   1 /*
   2  * builtin-buildid-cache.c
   3  *
   4  * Builtin buildid-cache command: Manages build-id cache
   5  *
   6  * Copyright (C) 2010, Red Hat Inc.
   7  * Copyright (C) 2010, Arnaldo Carvalho de Melo <acme@redhat.com>
   8  */
   9 #include <sys/types.h>
  10 #include <sys/time.h>
  11 #include <time.h>
  12 #include <dirent.h>
  13 #include <unistd.h>
  14 #include "builtin.h"
  15 #include "perf.h"
  16 #include "util/cache.h"
  17 #include "util/debug.h"
  18 #include "util/header.h"
  19 #include "util/parse-options.h"
  20 #include "util/strlist.h"
  21 #include "util/build-id.h"
  22 #include "util/session.h"
  23 #include "util/symbol.h"
  24
  25 static int build_id_cache__kcore_buildid(const char *proc_dir, char *sbuildid)
  26 {
  27         char root_dir[PATH_MAX];
  28         char notes[PATH_MAX];
  29         u8 build_id[BUILD_ID_SIZE];
  30         char *p;
  31
  32         strlcpy(root_dir, proc_dir, sizeof(root_dir));
  33
  34         p = strrchr(root_dir, '/');
  35         if (!p)
  36                 return -1;
  37         *p = '\0';
  38
  39         scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
  40
  41         if (sysfs__read_build_id(notes, build_id, sizeof(build_id)))
  42                 return -1;
  43
  44         build_id__sprintf(build_id, sizeof(build_id), sbuildid);
  45
  46         return 0;
  47 }
  48
  49 static int build_id_cache__kcore_dir(char *dir, size_t sz)
  50 {
  51         struct timeval tv;
  52         struct tm tm;
  53         char dt[32];
  54
  55         if (gettimeofday(&tv, NULL) || !localtime_r(&tv.tv_sec, &tm))
  56                 return -1;
  57
  58         if (!strftime(dt, sizeof(dt), "%Y%m%d%H%M%S", &tm))
  59                 return -1;
  60
  61         scnprintf(dir, sz, "%s%02u", dt, (unsigned)tv.tv_usec / 10000);
  62
  63         return 0;
  64 }
  65
  66 static bool same_kallsyms_reloc(const char *from_dir, char *to_dir)
  67 {
  68         char from[PATH_MAX];
  69         char to[PATH_MAX];
  70         const char *name;
  71         u64 addr1 = 0, addr2 = 0;
  72         int i;
  73
  74         scnprintf(from, sizeof(from), "%s/kallsyms", from_dir);
  75         scnprintf(to, sizeof(to), "%s/kallsyms", to_dir);
  76
  77         for (i = 0; (name = ref_reloc_sym_names[i]) != NULL; i++) {
  78                 addr1 = kallsyms__get_function_start(from, name);
  79                 if (addr1)
  80                         break;
  81         }
  82
  83         if (name)
  84                 addr2 = kallsyms__get_function_start(to, name);
  85
  86         return addr1 == addr2;
  87 }
  88
  89 static int build_id_cache__kcore_existing(const char *from_dir, char *to_dir,
  90                                           size_t to_dir_sz)
  91 {
  92         char from[PATH_MAX];
  93         char to[PATH_MAX];
  94         char to_subdir[PATH_MAX];
  95         struct dirent *dent;
  96         int ret = -1;
  97         DIR *d;
  98
  99         d = opendir(to_dir);
 100         if (!d)
 101                 return -1;
 102
 103         scnprintf(from, sizeof(from), "%s/modules", from_dir);
 104
 105         while (1) {
 106                 dent = readdir(d);
 107                 if (!dent)
 108                         break;
 109                 if (dent->d_type != DT_DIR)
 110                         continue;
 111                 scnprintf(to, sizeof(to), "%s/%s/modules", to_dir,
 112                           dent->d_name);
 113                 scnprintf(to_subdir, sizeof(to_subdir), "%s/%s",
 114                           to_dir, dent->d_name);
 115                 if (!compare_proc_modules(from, to) &&
 116                     same_kallsyms_reloc(from_dir, to_subdir)) {
 117                         strlcpy(to_dir, to_subdir, to_dir_sz);
 118                         ret = 0;
 119                         break;
 120                 }
 121         }
 122
 123         closedir(d);
 124
 125         return ret;
 126 }
 127
 128 static int build_id_cache__add_kcore(const char *filename, bool force)
 129 {
 130         char dir[32], sbuildid[BUILD_ID_SIZE * 2 + 1];
 131         char from_dir[PATH_MAX], to_dir[PATH_MAX];
 132         char *p;
 133
 134         strlcpy(from_dir, filename, sizeof(from_dir));
 135
 136         p = strrchr(from_dir, '/');
 137         if (!p || strcmp(p + 1, "kcore"))
 138                 return -1;
 139         *p = '\0';
 140
 141         if (build_id_cache__kcore_buildid(from_dir, sbuildid))
 142                 return -1;
 143
 144         scnprintf(to_dir, sizeof(to_dir), "%s/[kernel.kcore]/%s",
 145                   buildid_dir, sbuildid);
 146
 147         if (!force &&
 148             !build_id_cache__kcore_existing(from_dir, to_dir, sizeof(to_dir))) {
 149                 pr_debug("same kcore found in %s\n", to_dir);
 150                 return 0;
 151         }
 152
 153         if (build_id_cache__kcore_dir(dir, sizeof(dir)))
 154                 return -1;
 155
 156         scnprintf(to_dir, sizeof(to_dir), "%s/[kernel.kcore]/%s/%s",
 157                   buildid_dir, sbuildid, dir);
 158
 159         if (mkdir_p(to_dir, 0755))
 160                 return -1;
 161
 162         if (kcore_copy(from_dir, to_dir)) {
 163                 /* Remove YYYYmmddHHMMSShh directory */
 164                 if (!rmdir(to_dir)) {
 165                         p = strrchr(to_dir, '/');
 166                         if (p)
 167                                 *p = '\0';
 168                         /* Try to remove buildid directory */
 169                         if (!rmdir(to_dir)) {
 170                                 p = strrchr(to_dir, '/');
 171                                 if (p)
 172                                         *p = '\0';
 173                                 /* Try to remove [kernel.kcore] directory */
 174                                 rmdir(to_dir);
 175                         }
 176                 }
 177                 return -1;
 178         }
 179
 180         pr_debug("kcore added to build-id cache directory %s\n", to_dir);
 181
 182         return 0;
 183 }
 184
 185 static int build_id_cache__add_file(const char *filename)
 186 {
 187         char sbuild_id[BUILD_ID_SIZE * 2 + 1];
 188         u8 build_id[BUILD_ID_SIZE];
 189         int err;
 190
 191         if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
 192                 pr_debug("Couldn't read a build-id in %s\n", filename);
 193                 return -1;
 194         }
 195
 196         build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 197         err = build_id_cache__add_s(sbuild_id, filename,
 198                                     false, false);
 199         if (verbose)
 200                 pr_info("Adding %s %s: %s\n", sbuild_id, filename,
 201                         err ? "FAIL" : "Ok");
 202         return err;
 203 }
 204
 205 static int build_id_cache__remove_file(const char *filename)
 206 {
 207         u8 build_id[BUILD_ID_SIZE];
 208         char sbuild_id[BUILD_ID_SIZE * 2 + 1];
 209
 210         int err;
 211
 212         if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
 213                 pr_debug("Couldn't read a build-id in %s\n", filename);
 214                 return -1;
 215         }
 216
 217         build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 218         err = build_id_cache__remove_s(sbuild_id);
 219         if (verbose)
 220                 pr_info("Removing %s %s: %s\n", sbuild_id, filename,
 221                         err ? "FAIL" : "Ok");
 222
 223         return err;
 224 }
 225
 226 static bool dso__missing_buildid_cache(struct dso *dso, int parm __maybe_unused)
 227 {
 228         char filename[PATH_MAX];
 229         u8 build_id[BUILD_ID_SIZE];
 230
 231         if (dso__build_id_filename(dso, filename, sizeof(filename)) &&
 232             filename__read_build_id(filename, build_id,
 233                                     sizeof(build_id)) != sizeof(build_id)) {
 234                 if (errno == ENOENT)
 235                         return false;
 236
 237                 pr_warning("Problems with %s file, consider removing it from the cache\n",
 238                            filename);
 239         } else if (memcmp(dso->build_id, build_id, sizeof(dso->build_id))) {
 240                 pr_warning("Problems with %s file, consider removing it from the cache\n",
 241                            filename);
 242         }
 243
 244         return true;
 245 }
 246
 247 static int build_id_cache__fprintf_missing(struct perf_session *session, FILE *fp)
 248 {
 249         perf_session__fprintf_dsos_buildid(session, fp, dso__missing_buildid_cache, 0);
 250         return 0;
 251 }
 252
 253 static int build_id_cache__update_file(const char *filename)
 254 {
 255         u8 build_id[BUILD_ID_SIZE];
 256         char sbuild_id[BUILD_ID_SIZE * 2 + 1];
 257
 258         int err = 0;
 259
 260         if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
 261                 pr_debug("Couldn't read a build-id in %s\n", filename);
 262                 return -1;
 263         }
 264
 265         build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 266         if (build_id_cache__cached(sbuild_id))
 267                 err = build_id_cache__remove_s(sbuild_id);
 268
 269         if (!err)
 270                 err = build_id_cache__add_s(sbuild_id, filename, false, false);
 271
 272         if (verbose)
 273                 pr_info("Updating %s %s: %s\n", sbuild_id, filename,
 274                         err ? "FAIL" : "Ok");
 275
 276         return err;
 277 }
 278
 279 int cmd_buildid_cache(int argc, const char **argv,
 280                       const char *prefix __maybe_unused)
 281 {
 282         struct strlist *list;
 283         struct str_node *pos;
 284         int ret = 0;
 285         bool force = false;
 286         char const *add_name_list_str = NULL,
 287                    *remove_name_list_str = NULL,
 288                    *missing_filename = NULL,
 289                    *update_name_list_str = NULL,
 290                    *kcore_filename = NULL;
 291         char sbuf[STRERR_BUFSIZE];
 292
 293         struct perf_data_file file = {
 294                 .mode  = PERF_DATA_MODE_READ,
 295         };
 296         struct perf_session *session = NULL;
 297
 298         const struct option buildid_cache_options[] = {
 299         OPT_STRING('a', "add", &add_name_list_str,
 300                    "file list", "file(s) to add"),
 301         OPT_STRING('k', "kcore", &kcore_filename,
 302                    "file", "kcore file to add"),
 303         OPT_STRING('r', "remove", &remove_name_list_str, "file list",
 304                     "file(s) to remove"),
 305         OPT_STRING('M', "missing", &missing_filename, "file",
 306                    "to find missing build ids in the cache"),
 307         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 308         OPT_STRING('u', "update", &update_name_list_str, "file list",
 309                     "file(s) to update"),
 310         OPT_INCR('v', "verbose", &verbose, "be more verbose"),
 311         OPT_END()
 312         };
 313         const char * const buildid_cache_usage[] = {
 314                 "perf buildid-cache [<options>]",
 315                 NULL
 316         };
 317
 318         argc = parse_options(argc, argv, buildid_cache_options,
 319                              buildid_cache_usage, 0);
 320
 321         if (missing_filename) {
 322                 file.path = missing_filename;
 323                 file.force = force;
 324
 325                 session = perf_session__new(&file, false, NULL);
 326                 if (session == NULL)
 327                         return -1;
 328         }
 329
 330         if (symbol__init(session ? &session->header.env : NULL) < 0)
 331                 goto out;
 332
 333         setup_pager();
 334
 335         if (add_name_list_str) {
 336                 list = strlist__new(true, add_name_list_str);
 337                 if (list) {
 338                         strlist__for_each(pos, list)
 339                                 if (build_id_cache__add_file(pos->s)) {
 340                                         if (errno == EEXIST) {
 341                                                 pr_debug("%s already in the cache\n",
 342                                                          pos->s);
 343                                                 continue;
 344                                         }
 345                                         pr_warning("Couldn't add %s: %s\n",
 346                                                    pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
 347                                 }
 348
 349                         strlist__delete(list);
 350                 }
 351         }
 352
 353         if (remove_name_list_str) {
 354                 list = strlist__new(true, remove_name_list_str);
 355                 if (list) {
 356                         strlist__for_each(pos, list)
 357                                 if (build_id_cache__remove_file(pos->s)) {
 358                                         if (errno == ENOENT) {
 359                                                 pr_debug("%s wasn't in the cache\n",
 360                                                          pos->s);
 361                                                 continue;
 362                                         }
 363                                         pr_warning("Couldn't remove %s: %s\n",
 364                                                    pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
 365                                 }
 366
 367                         strlist__delete(list);
 368                 }
 369         }
 370
 371         if (missing_filename)
 372                 ret = build_id_cache__fprintf_missing(session, stdout);
 373
 374         if (update_name_list_str) {
 375                 list = strlist__new(true, update_name_list_str);
 376                 if (list) {
 377                         strlist__for_each(pos, list)
 378                                 if (build_id_cache__update_file(pos->s)) {
 379                                         if (errno == ENOENT) {
 380                                                 pr_debug("%s wasn't in the cache\n",
 381                                                          pos->s);
 382                                                 continue;
 383                                         }
 384                                         pr_warning("Couldn't update %s: %s\n",
 385                                                    pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
 386                                 }
 387
 388                         strlist__delete(list);
 389                 }
 390         }
 391
 392         if (kcore_filename && build_id_cache__add_kcore(kcore_filename, force))
 393                 pr_warning("Couldn't add %s\n", kcore_filename);
 394
 395 out:
 396         if (session)
 397                 perf_session__delete(session);
 398
 399         return ret;
 400 }