2 * builtin-buildid-cache.c
4 * Builtin buildid-cache command: Manages build-id cache
6 * Copyright (C) 2010, Red Hat Inc.
7 * Copyright (C) 2010, Arnaldo Carvalho de Melo <acme@redhat.com>
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"
25 static int build_id_cache__kcore_buildid(const char *proc_dir, char *sbuildid)
27 char root_dir[PATH_MAX];
29 u8 build_id[BUILD_ID_SIZE];
32 strlcpy(root_dir, proc_dir, sizeof(root_dir));
34 p = strrchr(root_dir, '/');
39 scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
41 if (sysfs__read_build_id(notes, build_id, sizeof(build_id)))
44 build_id__sprintf(build_id, sizeof(build_id), sbuildid);
49 static int build_id_cache__kcore_dir(char *dir, size_t sz)
55 if (gettimeofday(&tv, NULL) || !localtime_r(&tv.tv_sec, &tm))
58 if (!strftime(dt, sizeof(dt), "%Y%m%d%H%M%S", &tm))
61 scnprintf(dir, sz, "%s%02u", dt, (unsigned)tv.tv_usec / 10000);
66 static bool same_kallsyms_reloc(const char *from_dir, char *to_dir)
71 u64 addr1 = 0, addr2 = 0;
74 scnprintf(from, sizeof(from), "%s/kallsyms", from_dir);
75 scnprintf(to, sizeof(to), "%s/kallsyms", to_dir);
77 for (i = 0; (name = ref_reloc_sym_names[i]) != NULL; i++) {
78 addr1 = kallsyms__get_function_start(from, name);
84 addr2 = kallsyms__get_function_start(to, name);
86 return addr1 == addr2;
89 static int build_id_cache__kcore_existing(const char *from_dir, char *to_dir,
94 char to_subdir[PATH_MAX];
103 scnprintf(from, sizeof(from), "%s/modules", from_dir);
109 if (dent->d_type != DT_DIR)
111 scnprintf(to, sizeof(to), "%s/%s/modules", to_dir,
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);
128 static int build_id_cache__add_kcore(const char *filename, bool force)
130 char dir[32], sbuildid[BUILD_ID_SIZE * 2 + 1];
131 char from_dir[PATH_MAX], to_dir[PATH_MAX];
134 strlcpy(from_dir, filename, sizeof(from_dir));
136 p = strrchr(from_dir, '/');
137 if (!p || strcmp(p + 1, "kcore"))
141 if (build_id_cache__kcore_buildid(from_dir, sbuildid))
144 scnprintf(to_dir, sizeof(to_dir), "%s/[kernel.kcore]/%s",
145 buildid_dir, sbuildid);
148 !build_id_cache__kcore_existing(from_dir, to_dir, sizeof(to_dir))) {
149 pr_debug("same kcore found in %s\n", to_dir);
153 if (build_id_cache__kcore_dir(dir, sizeof(dir)))
156 scnprintf(to_dir, sizeof(to_dir), "%s/[kernel.kcore]/%s/%s",
157 buildid_dir, sbuildid, dir);
159 if (mkdir_p(to_dir, 0755))
162 if (kcore_copy(from_dir, to_dir)) {
163 /* Remove YYYYmmddHHMMSShh directory */
164 if (!rmdir(to_dir)) {
165 p = strrchr(to_dir, '/');
168 /* Try to remove buildid directory */
169 if (!rmdir(to_dir)) {
170 p = strrchr(to_dir, '/');
173 /* Try to remove [kernel.kcore] directory */
180 pr_debug("kcore added to build-id cache directory %s\n", to_dir);
185 static int build_id_cache__add_file(const char *filename)
187 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
188 u8 build_id[BUILD_ID_SIZE];
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);
196 build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
197 err = build_id_cache__add_s(sbuild_id, filename,
199 pr_debug("Adding %s %s: %s\n", sbuild_id, filename,
200 err ? "FAIL" : "Ok");
204 static int build_id_cache__remove_file(const char *filename)
206 u8 build_id[BUILD_ID_SIZE];
207 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
211 if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
212 pr_debug("Couldn't read a build-id in %s\n", filename);
216 build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
217 err = build_id_cache__remove_s(sbuild_id);
218 pr_debug("Removing %s %s: %s\n", sbuild_id, filename,
219 err ? "FAIL" : "Ok");
224 static int build_id_cache__purge_path(const char *pathname)
226 struct strlist *list;
227 struct str_node *pos;
230 err = build_id_cache__list_build_ids(pathname, &list);
234 strlist__for_each(pos, list) {
235 err = build_id_cache__remove_s(pos->s);
236 pr_debug("Removing %s %s: %s\n", pos->s, pathname,
237 err ? "FAIL" : "Ok");
241 strlist__delete(list);
244 pr_debug("Purging %s: %s\n", pathname, err ? "FAIL" : "Ok");
249 static bool dso__missing_buildid_cache(struct dso *dso, int parm __maybe_unused)
251 char filename[PATH_MAX];
252 u8 build_id[BUILD_ID_SIZE];
254 if (dso__build_id_filename(dso, filename, sizeof(filename)) &&
255 filename__read_build_id(filename, build_id,
256 sizeof(build_id)) != sizeof(build_id)) {
260 pr_warning("Problems with %s file, consider removing it from the cache\n",
262 } else if (memcmp(dso->build_id, build_id, sizeof(dso->build_id))) {
263 pr_warning("Problems with %s file, consider removing it from the cache\n",
270 static int build_id_cache__fprintf_missing(struct perf_session *session, FILE *fp)
272 perf_session__fprintf_dsos_buildid(session, fp, dso__missing_buildid_cache, 0);
276 static int build_id_cache__update_file(const char *filename)
278 u8 build_id[BUILD_ID_SIZE];
279 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
283 if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
284 pr_debug("Couldn't read a build-id in %s\n", filename);
288 build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
289 if (build_id_cache__cached(sbuild_id))
290 err = build_id_cache__remove_s(sbuild_id);
293 err = build_id_cache__add_s(sbuild_id, filename, false, false);
295 pr_debug("Updating %s %s: %s\n", sbuild_id, filename,
296 err ? "FAIL" : "Ok");
301 int cmd_buildid_cache(int argc, const char **argv,
302 const char *prefix __maybe_unused)
304 struct strlist *list;
305 struct str_node *pos;
308 char const *add_name_list_str = NULL,
309 *remove_name_list_str = NULL,
310 *purge_name_list_str = NULL,
311 *missing_filename = NULL,
312 *update_name_list_str = NULL,
313 *kcore_filename = NULL;
314 char sbuf[STRERR_BUFSIZE];
316 struct perf_data_file file = {
317 .mode = PERF_DATA_MODE_READ,
319 struct perf_session *session = NULL;
321 const struct option buildid_cache_options[] = {
322 OPT_STRING('a', "add", &add_name_list_str,
323 "file list", "file(s) to add"),
324 OPT_STRING('k', "kcore", &kcore_filename,
325 "file", "kcore file to add"),
326 OPT_STRING('r', "remove", &remove_name_list_str, "file list",
327 "file(s) to remove"),
328 OPT_STRING('p', "purge", &purge_name_list_str, "path list",
329 "path(s) to remove (remove old caches too)"),
330 OPT_STRING('M', "missing", &missing_filename, "file",
331 "to find missing build ids in the cache"),
332 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
333 OPT_STRING('u', "update", &update_name_list_str, "file list",
334 "file(s) to update"),
335 OPT_INCR('v', "verbose", &verbose, "be more verbose"),
338 const char * const buildid_cache_usage[] = {
339 "perf buildid-cache [<options>]",
343 argc = parse_options(argc, argv, buildid_cache_options,
344 buildid_cache_usage, 0);
346 if (argc || (!add_name_list_str && !kcore_filename &&
347 !remove_name_list_str && !purge_name_list_str &&
348 !missing_filename && !update_name_list_str))
349 usage_with_options(buildid_cache_usage, buildid_cache_options);
351 if (missing_filename) {
352 file.path = missing_filename;
355 session = perf_session__new(&file, false, NULL);
360 if (symbol__init(session ? &session->header.env : NULL) < 0)
365 if (add_name_list_str) {
366 list = strlist__new(true, add_name_list_str);
368 strlist__for_each(pos, list)
369 if (build_id_cache__add_file(pos->s)) {
370 if (errno == EEXIST) {
371 pr_debug("%s already in the cache\n",
375 pr_warning("Couldn't add %s: %s\n",
376 pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
379 strlist__delete(list);
383 if (remove_name_list_str) {
384 list = strlist__new(true, remove_name_list_str);
386 strlist__for_each(pos, list)
387 if (build_id_cache__remove_file(pos->s)) {
388 if (errno == ENOENT) {
389 pr_debug("%s wasn't in the cache\n",
393 pr_warning("Couldn't remove %s: %s\n",
394 pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
397 strlist__delete(list);
401 if (purge_name_list_str) {
402 list = strlist__new(true, purge_name_list_str);
404 strlist__for_each(pos, list)
405 if (build_id_cache__purge_path(pos->s)) {
406 if (errno == ENOENT) {
407 pr_debug("%s wasn't in the cache\n",
411 pr_warning("Couldn't remove %s: %s\n",
412 pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
415 strlist__delete(list);
419 if (missing_filename)
420 ret = build_id_cache__fprintf_missing(session, stdout);
422 if (update_name_list_str) {
423 list = strlist__new(true, update_name_list_str);
425 strlist__for_each(pos, list)
426 if (build_id_cache__update_file(pos->s)) {
427 if (errno == ENOENT) {
428 pr_debug("%s wasn't in the cache\n",
432 pr_warning("Couldn't update %s: %s\n",
433 pos->s, strerror_r(errno, sbuf, sizeof(sbuf)));
436 strlist__delete(list);
440 if (kcore_filename && build_id_cache__add_kcore(kcore_filename, force))
441 pr_warning("Couldn't add %s\n", kcore_filename);
445 perf_session__delete(session);