xref: /linux/tools/perf/builtin-buildid-cache.c (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9)
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 <subcmd/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 *p;
29 
30 	strlcpy(root_dir, proc_dir, sizeof(root_dir));
31 
32 	p = strrchr(root_dir, '/');
33 	if (!p)
34 		return -1;
35 	*p = '\0';
36 	return sysfs__sprintf_build_id(root_dir, sbuildid);
37 }
38 
39 static int build_id_cache__kcore_dir(char *dir, size_t sz)
40 {
41 	return fetch_current_timestamp(dir, sz);
42 }
43 
44 static bool same_kallsyms_reloc(const char *from_dir, char *to_dir)
45 {
46 	char from[PATH_MAX];
47 	char to[PATH_MAX];
48 	const char *name;
49 	u64 addr1 = 0, addr2 = 0;
50 	int i;
51 
52 	scnprintf(from, sizeof(from), "%s/kallsyms", from_dir);
53 	scnprintf(to, sizeof(to), "%s/kallsyms", to_dir);
54 
55 	for (i = 0; (name = ref_reloc_sym_names[i]) != NULL; i++) {
56 		addr1 = kallsyms__get_function_start(from, name);
57 		if (addr1)
58 			break;
59 	}
60 
61 	if (name)
62 		addr2 = kallsyms__get_function_start(to, name);
63 
64 	return addr1 == addr2;
65 }
66 
67 static int build_id_cache__kcore_existing(const char *from_dir, char *to_dir,
68 					  size_t to_dir_sz)
69 {
70 	char from[PATH_MAX];
71 	char to[PATH_MAX];
72 	char to_subdir[PATH_MAX];
73 	struct dirent *dent;
74 	int ret = -1;
75 	DIR *d;
76 
77 	d = opendir(to_dir);
78 	if (!d)
79 		return -1;
80 
81 	scnprintf(from, sizeof(from), "%s/modules", from_dir);
82 
83 	while (1) {
84 		dent = readdir(d);
85 		if (!dent)
86 			break;
87 		if (dent->d_type != DT_DIR)
88 			continue;
89 		scnprintf(to, sizeof(to), "%s/%s/modules", to_dir,
90 			  dent->d_name);
91 		scnprintf(to_subdir, sizeof(to_subdir), "%s/%s",
92 			  to_dir, dent->d_name);
93 		if (!compare_proc_modules(from, to) &&
94 		    same_kallsyms_reloc(from_dir, to_subdir)) {
95 			strlcpy(to_dir, to_subdir, to_dir_sz);
96 			ret = 0;
97 			break;
98 		}
99 	}
100 
101 	closedir(d);
102 
103 	return ret;
104 }
105 
106 static int build_id_cache__add_kcore(const char *filename, bool force)
107 {
108 	char dir[32], sbuildid[SBUILD_ID_SIZE];
109 	char from_dir[PATH_MAX], to_dir[PATH_MAX];
110 	char *p;
111 
112 	strlcpy(from_dir, filename, sizeof(from_dir));
113 
114 	p = strrchr(from_dir, '/');
115 	if (!p || strcmp(p + 1, "kcore"))
116 		return -1;
117 	*p = '\0';
118 
119 	if (build_id_cache__kcore_buildid(from_dir, sbuildid) < 0)
120 		return -1;
121 
122 	scnprintf(to_dir, sizeof(to_dir), "%s/%s/%s",
123 		  buildid_dir, DSO__NAME_KCORE, sbuildid);
124 
125 	if (!force &&
126 	    !build_id_cache__kcore_existing(from_dir, to_dir, sizeof(to_dir))) {
127 		pr_debug("same kcore found in %s\n", to_dir);
128 		return 0;
129 	}
130 
131 	if (build_id_cache__kcore_dir(dir, sizeof(dir)))
132 		return -1;
133 
134 	scnprintf(to_dir, sizeof(to_dir), "%s/%s/%s/%s",
135 		  buildid_dir, DSO__NAME_KCORE, sbuildid, dir);
136 
137 	if (mkdir_p(to_dir, 0755))
138 		return -1;
139 
140 	if (kcore_copy(from_dir, to_dir)) {
141 		/* Remove YYYYmmddHHMMSShh directory */
142 		if (!rmdir(to_dir)) {
143 			p = strrchr(to_dir, '/');
144 			if (p)
145 				*p = '\0';
146 			/* Try to remove buildid directory */
147 			if (!rmdir(to_dir)) {
148 				p = strrchr(to_dir, '/');
149 				if (p)
150 					*p = '\0';
151 				/* Try to remove [kernel.kcore] directory */
152 				rmdir(to_dir);
153 			}
154 		}
155 		return -1;
156 	}
157 
158 	pr_debug("kcore added to build-id cache directory %s\n", to_dir);
159 
160 	return 0;
161 }
162 
163 static int build_id_cache__add_file(const char *filename)
164 {
165 	char sbuild_id[SBUILD_ID_SIZE];
166 	u8 build_id[BUILD_ID_SIZE];
167 	int err;
168 
169 	if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
170 		pr_debug("Couldn't read a build-id in %s\n", filename);
171 		return -1;
172 	}
173 
174 	build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
175 	err = build_id_cache__add_s(sbuild_id, filename,
176 				    false, false);
177 	pr_debug("Adding %s %s: %s\n", sbuild_id, filename,
178 		 err ? "FAIL" : "Ok");
179 	return err;
180 }
181 
182 static int build_id_cache__remove_file(const char *filename)
183 {
184 	u8 build_id[BUILD_ID_SIZE];
185 	char sbuild_id[SBUILD_ID_SIZE];
186 
187 	int err;
188 
189 	if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
190 		pr_debug("Couldn't read a build-id in %s\n", filename);
191 		return -1;
192 	}
193 
194 	build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
195 	err = build_id_cache__remove_s(sbuild_id);
196 	pr_debug("Removing %s %s: %s\n", sbuild_id, filename,
197 		 err ? "FAIL" : "Ok");
198 
199 	return err;
200 }
201 
202 static int build_id_cache__purge_path(const char *pathname)
203 {
204 	struct strlist *list;
205 	struct str_node *pos;
206 	int err;
207 
208 	err = build_id_cache__list_build_ids(pathname, &list);
209 	if (err)
210 		goto out;
211 
212 	strlist__for_each_entry(pos, list) {
213 		err = build_id_cache__remove_s(pos->s);
214 		pr_debug("Removing %s %s: %s\n", pos->s, pathname,
215 			 err ? "FAIL" : "Ok");
216 		if (err)
217 			break;
218 	}
219 	strlist__delete(list);
220 
221 out:
222 	pr_debug("Purging %s: %s\n", pathname, err ? "FAIL" : "Ok");
223 
224 	return err;
225 }
226 
227 static bool dso__missing_buildid_cache(struct dso *dso, int parm __maybe_unused)
228 {
229 	char filename[PATH_MAX];
230 	u8 build_id[BUILD_ID_SIZE];
231 
232 	if (dso__build_id_filename(dso, filename, sizeof(filename)) &&
233 	    filename__read_build_id(filename, build_id,
234 				    sizeof(build_id)) != sizeof(build_id)) {
235 		if (errno == ENOENT)
236 			return false;
237 
238 		pr_warning("Problems with %s file, consider removing it from the cache\n",
239 			   filename);
240 	} else if (memcmp(dso->build_id, build_id, sizeof(dso->build_id))) {
241 		pr_warning("Problems with %s file, consider removing it from the cache\n",
242 			   filename);
243 	}
244 
245 	return true;
246 }
247 
248 static int build_id_cache__fprintf_missing(struct perf_session *session, FILE *fp)
249 {
250 	perf_session__fprintf_dsos_buildid(session, fp, dso__missing_buildid_cache, 0);
251 	return 0;
252 }
253 
254 static int build_id_cache__update_file(const char *filename)
255 {
256 	u8 build_id[BUILD_ID_SIZE];
257 	char sbuild_id[SBUILD_ID_SIZE];
258 
259 	int err = 0;
260 
261 	if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
262 		pr_debug("Couldn't read a build-id in %s\n", filename);
263 		return -1;
264 	}
265 
266 	build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
267 	if (build_id_cache__cached(sbuild_id))
268 		err = build_id_cache__remove_s(sbuild_id);
269 
270 	if (!err)
271 		err = build_id_cache__add_s(sbuild_id, filename, false, false);
272 
273 	pr_debug("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 		   *purge_name_list_str = NULL,
289 		   *missing_filename = NULL,
290 		   *update_name_list_str = NULL,
291 		   *kcore_filename = NULL;
292 	char sbuf[STRERR_BUFSIZE];
293 
294 	struct perf_data_file file = {
295 		.mode  = PERF_DATA_MODE_READ,
296 	};
297 	struct perf_session *session = NULL;
298 
299 	const struct option buildid_cache_options[] = {
300 	OPT_STRING('a', "add", &add_name_list_str,
301 		   "file list", "file(s) to add"),
302 	OPT_STRING('k', "kcore", &kcore_filename,
303 		   "file", "kcore file to add"),
304 	OPT_STRING('r', "remove", &remove_name_list_str, "file list",
305 		    "file(s) to remove"),
306 	OPT_STRING('p', "purge", &purge_name_list_str, "path list",
307 		    "path(s) to remove (remove old caches too)"),
308 	OPT_STRING('M', "missing", &missing_filename, "file",
309 		   "to find missing build ids in the cache"),
310 	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
311 	OPT_STRING('u', "update", &update_name_list_str, "file list",
312 		    "file(s) to update"),
313 	OPT_INCR('v', "verbose", &verbose, "be more verbose"),
314 	OPT_END()
315 	};
316 	const char * const buildid_cache_usage[] = {
317 		"perf buildid-cache [<options>]",
318 		NULL
319 	};
320 
321 	argc = parse_options(argc, argv, buildid_cache_options,
322 			     buildid_cache_usage, 0);
323 
324 	if (argc || (!add_name_list_str && !kcore_filename &&
325 		     !remove_name_list_str && !purge_name_list_str &&
326 		     !missing_filename && !update_name_list_str))
327 		usage_with_options(buildid_cache_usage, buildid_cache_options);
328 
329 	if (missing_filename) {
330 		file.path = missing_filename;
331 		file.force = force;
332 
333 		session = perf_session__new(&file, false, NULL);
334 		if (session == NULL)
335 			return -1;
336 	}
337 
338 	if (symbol__init(session ? &session->header.env : NULL) < 0)
339 		goto out;
340 
341 	setup_pager();
342 
343 	if (add_name_list_str) {
344 		list = strlist__new(add_name_list_str, NULL);
345 		if (list) {
346 			strlist__for_each_entry(pos, list)
347 				if (build_id_cache__add_file(pos->s)) {
348 					if (errno == EEXIST) {
349 						pr_debug("%s already in the cache\n",
350 							 pos->s);
351 						continue;
352 					}
353 					pr_warning("Couldn't add %s: %s\n",
354 						   pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
355 				}
356 
357 			strlist__delete(list);
358 		}
359 	}
360 
361 	if (remove_name_list_str) {
362 		list = strlist__new(remove_name_list_str, NULL);
363 		if (list) {
364 			strlist__for_each_entry(pos, list)
365 				if (build_id_cache__remove_file(pos->s)) {
366 					if (errno == ENOENT) {
367 						pr_debug("%s wasn't in the cache\n",
368 							 pos->s);
369 						continue;
370 					}
371 					pr_warning("Couldn't remove %s: %s\n",
372 						   pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
373 				}
374 
375 			strlist__delete(list);
376 		}
377 	}
378 
379 	if (purge_name_list_str) {
380 		list = strlist__new(purge_name_list_str, NULL);
381 		if (list) {
382 			strlist__for_each_entry(pos, list)
383 				if (build_id_cache__purge_path(pos->s)) {
384 					if (errno == ENOENT) {
385 						pr_debug("%s wasn't in the cache\n",
386 							 pos->s);
387 						continue;
388 					}
389 					pr_warning("Couldn't remove %s: %s\n",
390 						   pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
391 				}
392 
393 			strlist__delete(list);
394 		}
395 	}
396 
397 	if (missing_filename)
398 		ret = build_id_cache__fprintf_missing(session, stdout);
399 
400 	if (update_name_list_str) {
401 		list = strlist__new(update_name_list_str, NULL);
402 		if (list) {
403 			strlist__for_each_entry(pos, list)
404 				if (build_id_cache__update_file(pos->s)) {
405 					if (errno == ENOENT) {
406 						pr_debug("%s wasn't in the cache\n",
407 							 pos->s);
408 						continue;
409 					}
410 					pr_warning("Couldn't update %s: %s\n",
411 						   pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
412 				}
413 
414 			strlist__delete(list);
415 		}
416 	}
417 
418 	if (kcore_filename && build_id_cache__add_kcore(kcore_filename, force))
419 		pr_warning("Couldn't add %s\n", kcore_filename);
420 
421 out:
422 	perf_session__delete(session);
423 
424 	return ret;
425 }
426