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, const char *debugdir)
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 		  debugdir, sbuildid);
146 
147 	if (!build_id_cache__kcore_existing(from_dir, to_dir, sizeof(to_dir))) {
148 		pr_debug("same kcore found in %s\n", to_dir);
149 		return 0;
150 	}
151 
152 	if (build_id_cache__kcore_dir(dir, sizeof(dir)))
153 		return -1;
154 
155 	scnprintf(to_dir, sizeof(to_dir), "%s/[kernel.kcore]/%s/%s",
156 		  debugdir, sbuildid, dir);
157 
158 	if (mkdir_p(to_dir, 0755))
159 		return -1;
160 
161 	if (kcore_copy(from_dir, to_dir)) {
162 		/* Remove YYYYmmddHHMMSShh directory */
163 		if (!rmdir(to_dir)) {
164 			p = strrchr(to_dir, '/');
165 			if (p)
166 				*p = '\0';
167 			/* Try to remove buildid directory */
168 			if (!rmdir(to_dir)) {
169 				p = strrchr(to_dir, '/');
170 				if (p)
171 					*p = '\0';
172 				/* Try to remove [kernel.kcore] directory */
173 				rmdir(to_dir);
174 			}
175 		}
176 		return -1;
177 	}
178 
179 	pr_debug("kcore added to build-id cache directory %s\n", to_dir);
180 
181 	return 0;
182 }
183 
184 static int build_id_cache__add_file(const char *filename, const char *debugdir)
185 {
186 	char sbuild_id[BUILD_ID_SIZE * 2 + 1];
187 	u8 build_id[BUILD_ID_SIZE];
188 	int err;
189 
190 	if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
191 		pr_debug("Couldn't read a build-id in %s\n", filename);
192 		return -1;
193 	}
194 
195 	build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
196 	err = build_id_cache__add_s(sbuild_id, debugdir, filename,
197 				    false, false);
198 	if (verbose)
199 		pr_info("Adding %s %s: %s\n", sbuild_id, filename,
200 			err ? "FAIL" : "Ok");
201 	return err;
202 }
203 
204 static int build_id_cache__remove_file(const char *filename,
205 				       const char *debugdir)
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, debugdir);
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(const char *filename, bool force, FILE *fp)
248 {
249 	struct perf_data_file file = {
250 		.path  = filename,
251 		.mode  = PERF_DATA_MODE_READ,
252 		.force = force,
253 	};
254 	struct perf_session *session = perf_session__new(&file, false, NULL);
255 	if (session == NULL)
256 		return -1;
257 
258 	perf_session__fprintf_dsos_buildid(session, fp, dso__missing_buildid_cache, 0);
259 	perf_session__delete(session);
260 
261 	return 0;
262 }
263 
264 static int build_id_cache__update_file(const char *filename,
265 				       const char *debugdir)
266 {
267 	u8 build_id[BUILD_ID_SIZE];
268 	char sbuild_id[BUILD_ID_SIZE * 2 + 1];
269 
270 	int err;
271 
272 	if (filename__read_build_id(filename, &build_id, sizeof(build_id)) < 0) {
273 		pr_debug("Couldn't read a build-id in %s\n", filename);
274 		return -1;
275 	}
276 
277 	build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
278 	err = build_id_cache__remove_s(sbuild_id, debugdir);
279 	if (!err) {
280 		err = build_id_cache__add_s(sbuild_id, debugdir, filename,
281 					    false, false);
282 	}
283 	if (verbose)
284 		pr_info("Updating %s %s: %s\n", sbuild_id, filename,
285 			err ? "FAIL" : "Ok");
286 
287 	return err;
288 }
289 
290 int cmd_buildid_cache(int argc, const char **argv,
291 		      const char *prefix __maybe_unused)
292 {
293 	struct strlist *list;
294 	struct str_node *pos;
295 	int ret = 0;
296 	bool force = false;
297 	char debugdir[PATH_MAX];
298 	char const *add_name_list_str = NULL,
299 		   *remove_name_list_str = NULL,
300 		   *missing_filename = NULL,
301 		   *update_name_list_str = NULL,
302 		   *kcore_filename;
303 
304 	const struct option buildid_cache_options[] = {
305 	OPT_STRING('a', "add", &add_name_list_str,
306 		   "file list", "file(s) to add"),
307 	OPT_STRING('k', "kcore", &kcore_filename,
308 		   "file", "kcore file to add"),
309 	OPT_STRING('r', "remove", &remove_name_list_str, "file list",
310 		    "file(s) to remove"),
311 	OPT_STRING('M', "missing", &missing_filename, "file",
312 		   "to find missing build ids in the cache"),
313 	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
314 	OPT_STRING('u', "update", &update_name_list_str, "file list",
315 		    "file(s) to update"),
316 	OPT_INCR('v', "verbose", &verbose, "be more verbose"),
317 	OPT_END()
318 	};
319 	const char * const buildid_cache_usage[] = {
320 		"perf buildid-cache [<options>]",
321 		NULL
322 	};
323 
324 	argc = parse_options(argc, argv, buildid_cache_options,
325 			     buildid_cache_usage, 0);
326 
327 	if (symbol__init() < 0)
328 		return -1;
329 
330 	setup_pager();
331 
332 	snprintf(debugdir, sizeof(debugdir), "%s", buildid_dir);
333 
334 	if (add_name_list_str) {
335 		list = strlist__new(true, add_name_list_str);
336 		if (list) {
337 			strlist__for_each(pos, list)
338 				if (build_id_cache__add_file(pos->s, debugdir)) {
339 					if (errno == EEXIST) {
340 						pr_debug("%s already in the cache\n",
341 							 pos->s);
342 						continue;
343 					}
344 					pr_warning("Couldn't add %s: %s\n",
345 						   pos->s, strerror(errno));
346 				}
347 
348 			strlist__delete(list);
349 		}
350 	}
351 
352 	if (remove_name_list_str) {
353 		list = strlist__new(true, remove_name_list_str);
354 		if (list) {
355 			strlist__for_each(pos, list)
356 				if (build_id_cache__remove_file(pos->s, debugdir)) {
357 					if (errno == ENOENT) {
358 						pr_debug("%s wasn't in the cache\n",
359 							 pos->s);
360 						continue;
361 					}
362 					pr_warning("Couldn't remove %s: %s\n",
363 						   pos->s, strerror(errno));
364 				}
365 
366 			strlist__delete(list);
367 		}
368 	}
369 
370 	if (missing_filename)
371 		ret = build_id_cache__fprintf_missing(missing_filename, force, stdout);
372 
373 	if (update_name_list_str) {
374 		list = strlist__new(true, update_name_list_str);
375 		if (list) {
376 			strlist__for_each(pos, list)
377 				if (build_id_cache__update_file(pos->s, debugdir)) {
378 					if (errno == ENOENT) {
379 						pr_debug("%s wasn't in the cache\n",
380 							 pos->s);
381 						continue;
382 					}
383 					pr_warning("Couldn't update %s: %s\n",
384 						   pos->s, strerror(errno));
385 				}
386 
387 			strlist__delete(list);
388 		}
389 	}
390 
391 	if (kcore_filename &&
392 	    build_id_cache__add_kcore(kcore_filename, debugdir))
393 		pr_warning("Couldn't add %s\n", kcore_filename);
394 
395 	return ret;
396 }
397