Commit | Line | Data |
---|---|---|
096102bd DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <dgoulet@efficios.com> | |
fbb9748b | 3 | * 2014 - Jan Glauber <jan.glauber@gmail.com> |
096102bd | 4 | * |
d14d33bf AM |
5 | * This program is free software; you can redistribute it and/or modify |
6 | * it under the terms of the GNU General Public License, version 2 only, | |
7 | * as published by the Free Software Foundation. | |
096102bd | 8 | * |
d14d33bf AM |
9 | * This program is distributed in the hope that it will be useful, |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
096102bd | 13 | * |
d14d33bf AM |
14 | * You should have received a copy of the GNU General Public License along |
15 | * with this program; if not, write to the Free Software Foundation, Inc., | |
16 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
096102bd DG |
17 | */ |
18 | ||
19 | #define _GNU_SOURCE | |
c9d42407 | 20 | #include <assert.h> |
096102bd DG |
21 | #include <stdio.h> |
22 | #include <stdlib.h> | |
23 | #include <sys/wait.h> | |
24 | ||
25 | #include <common/common.h> | |
fbb9748b | 26 | #include <common/utils.h> |
096102bd DG |
27 | |
28 | #include "modprobe.h" | |
29 | #include "kern-modules.h" | |
30 | ||
ab57d7d3 JG |
31 | #define LTTNG_MOD_REQUIRED 1 |
32 | #define LTTNG_MOD_OPTIONAL 0 | |
33 | ||
34 | /* LTTng kernel tracer mandatory core modules list */ | |
35 | struct kern_modules_param kern_modules_control_core[] = { | |
36 | { "lttng-tracer" }, /* MUST be loaded first so keep at top */ | |
37 | { "lttng-lib-ring-buffer" }, | |
38 | { "lttng-ring-buffer-client-discard" }, | |
39 | { "lttng-ring-buffer-client-overwrite" }, | |
40 | { "lttng-ring-buffer-metadata-client" }, | |
41 | { "lttng-ring-buffer-client-mmap-discard" }, | |
42 | { "lttng-ring-buffer-client-mmap-overwrite" }, | |
43 | { "lttng-ring-buffer-metadata-mmap-client" }, | |
44 | }; | |
45 | ||
46 | /* LTTng kernel tracer optional base modules list */ | |
47 | struct kern_modules_param kern_modules_control_opt[] = { | |
48 | { "lttng-types" }, | |
49 | { "lttng-ftrace" }, | |
50 | { "lttng-kprobes" }, | |
51 | { "lttng-kretprobes" }, | |
3fa9646c JG |
52 | }; |
53 | ||
54 | /* LTTng kernel tracer probe modules list */ | |
fbb9748b | 55 | struct kern_modules_param kern_modules_probes_default[] = { |
ab57d7d3 JG |
56 | { "lttng-probe-asoc" }, |
57 | { "lttng-probe-block" }, | |
58 | { "lttng-probe-btrfs" }, | |
59 | { "lttng-probe-compaction" }, | |
60 | { "lttng-probe-ext3" }, | |
61 | { "lttng-probe-ext4" }, | |
62 | { "lttng-probe-gpio" }, | |
63 | { "lttng-probe-irq" }, | |
64 | { "lttng-probe-jbd" }, | |
65 | { "lttng-probe-jbd2" }, | |
66 | { "lttng-probe-kmem" }, | |
67 | { "lttng-probe-kvm" }, | |
68 | { "lttng-probe-kvm-x86" }, | |
69 | { "lttng-probe-kvm-x86-mmu" }, | |
70 | { "lttng-probe-lock" }, | |
71 | { "lttng-probe-module" }, | |
72 | { "lttng-probe-napi" }, | |
73 | { "lttng-probe-net" }, | |
74 | { "lttng-probe-power" }, | |
75 | { "lttng-probe-printk" }, | |
76 | { "lttng-probe-random" }, | |
77 | { "lttng-probe-rcu" }, | |
78 | { "lttng-probe-regmap" }, | |
79 | { "lttng-probe-regulator" }, | |
80 | { "lttng-probe-rpm" }, | |
81 | { "lttng-probe-sched" }, | |
82 | { "lttng-probe-scsi" }, | |
83 | { "lttng-probe-signal" }, | |
84 | { "lttng-probe-skb" }, | |
85 | { "lttng-probe-sock" }, | |
86 | { "lttng-probe-statedump" }, | |
87 | { "lttng-probe-sunrpc" }, | |
88 | { "lttng-probe-timer" }, | |
89 | { "lttng-probe-udp" }, | |
90 | { "lttng-probe-vmscan" }, | |
91 | { "lttng-probe-v4l2" }, | |
92 | { "lttng-probe-workqueue" }, | |
93 | { "lttng-probe-writeback" }, | |
096102bd DG |
94 | }; |
95 | ||
fbb9748b JG |
96 | /* dynamic probe modules list */ |
97 | static struct kern_modules_param *probes; | |
98 | static int nr_probes; | |
c9d42407 | 99 | static int probes_capacity; |
fbb9748b | 100 | |
e23b81ed | 101 | void modprobe_remove_lttng(const struct kern_modules_param *modules, |
ab57d7d3 | 102 | int entries, int required) |
096102bd DG |
103 | { |
104 | int ret = 0, i; | |
105 | char modprobe[256]; | |
106 | ||
e23b81ed | 107 | for (i = entries - 1; i >= 0; i--) { |
096102bd DG |
108 | ret = snprintf(modprobe, sizeof(modprobe), |
109 | "/sbin/modprobe -r -q %s", | |
e23b81ed | 110 | modules[i].name); |
096102bd DG |
111 | if (ret < 0) { |
112 | PERROR("snprintf modprobe -r"); | |
ab57d7d3 | 113 | return; |
096102bd DG |
114 | } |
115 | modprobe[sizeof(modprobe) - 1] = '\0'; | |
116 | ret = system(modprobe); | |
117 | if (ret == -1) { | |
118 | ERR("Unable to launch modprobe -r for module %s", | |
ab57d7d3 JG |
119 | modules[i].name); |
120 | } else if (required && WEXITSTATUS(ret) != 0) { | |
096102bd | 121 | ERR("Unable to remove module %s", |
ab57d7d3 | 122 | modules[i].name); |
096102bd DG |
123 | } else { |
124 | DBG("Modprobe removal successful %s", | |
ab57d7d3 | 125 | modules[i].name); |
096102bd DG |
126 | } |
127 | } | |
e23b81ed JG |
128 | } |
129 | ||
130 | /* | |
131 | * Remove control kernel module(s) in reverse load order. | |
132 | */ | |
133 | void modprobe_remove_lttng_control(void) | |
134 | { | |
ab57d7d3 | 135 | modprobe_remove_lttng(kern_modules_control_opt, |
fbb9748b JG |
136 | ARRAY_SIZE(kern_modules_control_opt), |
137 | LTTNG_MOD_OPTIONAL); | |
ab57d7d3 | 138 | modprobe_remove_lttng(kern_modules_control_core, |
fbb9748b JG |
139 | ARRAY_SIZE(kern_modules_control_core), |
140 | LTTNG_MOD_REQUIRED); | |
096102bd DG |
141 | } |
142 | ||
3dcf593a MD |
143 | static void free_probes(void) |
144 | { | |
145 | int i; | |
146 | ||
147 | if (!probes) { | |
148 | return; | |
149 | } | |
150 | for (i = 0; i < nr_probes; ++i) { | |
151 | free(probes[i].name); | |
152 | } | |
153 | free(probes); | |
154 | probes = NULL; | |
155 | nr_probes = 0; | |
156 | } | |
157 | ||
096102bd DG |
158 | /* |
159 | * Remove data kernel modules in reverse load order. | |
160 | */ | |
161 | void modprobe_remove_lttng_data(void) | |
162 | { | |
3dcf593a MD |
163 | if (!probes) { |
164 | return; | |
c9d42407 | 165 | } |
3dcf593a MD |
166 | modprobe_remove_lttng(probes, nr_probes, LTTNG_MOD_OPTIONAL); |
167 | free_probes(); | |
096102bd DG |
168 | } |
169 | ||
170 | /* | |
171 | * Remove all kernel modules in reverse order. | |
172 | */ | |
173 | void modprobe_remove_lttng_all(void) | |
174 | { | |
175 | modprobe_remove_lttng_data(); | |
176 | modprobe_remove_lttng_control(); | |
177 | } | |
178 | ||
234170ac UTL |
179 | #if HAVE_KMOD |
180 | #include <libkmod.h> | |
181 | static void log_kmod(void *data, int priority, const char *file, int line, | |
182 | const char *fn, const char *format, va_list args) | |
183 | { | |
184 | char *str; | |
185 | ||
186 | if (vasprintf(&str, format, args) < 0) { | |
187 | return; | |
188 | } | |
189 | ||
190 | DBG("libkmod: %s", str); | |
191 | free(str); | |
192 | } | |
193 | static int modprobe_lttng(struct kern_modules_param *modules, | |
194 | int entries, int required) | |
195 | { | |
196 | int ret = 0, i; | |
197 | struct kmod_ctx *ctx; | |
198 | ||
199 | ctx = kmod_new(NULL, NULL); | |
200 | if (!ctx) { | |
201 | PERROR("Unable to create kmod library context"); | |
202 | ret = -ENOMEM; | |
203 | goto error; | |
204 | } | |
205 | ||
206 | kmod_set_log_fn(ctx, log_kmod, NULL); | |
207 | kmod_load_resources(ctx); | |
208 | ||
209 | for (i = 0; i < entries; i++) { | |
210 | struct kmod_module *mod = NULL; | |
211 | ||
212 | ret = kmod_module_new_from_name(ctx, modules[i].name, &mod); | |
213 | if (ret < 0) { | |
214 | PERROR("Failed to create kmod module for %s", modules[i].name); | |
215 | goto error; | |
216 | } | |
217 | ||
218 | ret = kmod_module_probe_insert_module(mod, KMOD_PROBE_IGNORE_LOADED, | |
219 | NULL, NULL, NULL, NULL); | |
16c2e854 PP |
220 | if (ret < 0) { |
221 | if (required) { | |
222 | ERR("Unable to load required module %s", | |
223 | modules[i].name); | |
224 | goto error; | |
225 | } else { | |
226 | DBG("Unable to load optional module %s; continuing", | |
227 | modules[i].name); | |
228 | ret = 0; | |
229 | } | |
234170ac UTL |
230 | } else { |
231 | DBG("Modprobe successfully %s", modules[i].name); | |
232 | } | |
233 | ||
234 | kmod_module_unref(mod); | |
235 | } | |
236 | ||
237 | error: | |
238 | if (ctx) { | |
239 | kmod_unref(ctx); | |
240 | } | |
241 | return ret; | |
242 | } | |
243 | ||
244 | #else /* HAVE_KMOD */ | |
245 | ||
fbb9748b | 246 | static int modprobe_lttng(struct kern_modules_param *modules, |
234170ac | 247 | int entries, int required) |
096102bd DG |
248 | { |
249 | int ret = 0, i; | |
250 | char modprobe[256]; | |
251 | ||
e23b81ed | 252 | for (i = 0; i < entries; i++) { |
096102bd DG |
253 | ret = snprintf(modprobe, sizeof(modprobe), |
254 | "/sbin/modprobe %s%s", | |
ab57d7d3 | 255 | required ? "" : "-q ", |
e23b81ed | 256 | modules[i].name); |
096102bd DG |
257 | if (ret < 0) { |
258 | PERROR("snprintf modprobe"); | |
259 | goto error; | |
260 | } | |
261 | modprobe[sizeof(modprobe) - 1] = '\0'; | |
262 | ret = system(modprobe); | |
263 | if (ret == -1) { | |
16c2e854 PP |
264 | if (required) { |
265 | ERR("Unable to launch modprobe for required module %s", | |
266 | modules[i].name); | |
267 | goto error; | |
268 | } else { | |
269 | DBG("Unable to launch modprobe for optional module %s; continuing", | |
270 | modules[i].name); | |
271 | ret = 0; | |
272 | } | |
273 | } else if (WEXITSTATUS(ret) != 0) { | |
274 | if (required) { | |
275 | ERR("Unable to load required module %s", | |
276 | modules[i].name); | |
277 | goto error; | |
278 | } else { | |
279 | DBG("Unable to load optional module %s; continuing", | |
280 | modules[i].name); | |
281 | ret = 0; | |
282 | } | |
096102bd | 283 | } else { |
ab57d7d3 | 284 | DBG("Modprobe successfully %s", modules[i].name); |
096102bd DG |
285 | } |
286 | } | |
287 | ||
288 | error: | |
289 | return ret; | |
290 | } | |
291 | ||
234170ac UTL |
292 | #endif /* HAVE_KMOD */ |
293 | ||
e23b81ed JG |
294 | /* |
295 | * Load control kernel module(s). | |
296 | */ | |
297 | int modprobe_lttng_control(void) | |
298 | { | |
ab57d7d3 JG |
299 | int ret; |
300 | ||
301 | ret = modprobe_lttng(kern_modules_control_core, | |
302 | ARRAY_SIZE(kern_modules_control_core), | |
303 | LTTNG_MOD_REQUIRED); | |
304 | if (ret != 0) | |
305 | return ret; | |
306 | ret = modprobe_lttng(kern_modules_control_opt, | |
fbb9748b JG |
307 | ARRAY_SIZE(kern_modules_control_opt), |
308 | LTTNG_MOD_OPTIONAL); | |
ab57d7d3 | 309 | return ret; |
e23b81ed | 310 | } |
ab57d7d3 | 311 | |
c9d42407 PP |
312 | /** |
313 | * Grow global list of probes (double capacity or set it to 1 if | |
314 | * currently 0 and copy existing data). | |
096102bd | 315 | */ |
c9d42407 | 316 | static int grow_probes(void) |
096102bd | 317 | { |
c9d42407 PP |
318 | int i; |
319 | struct kern_modules_param *tmp_probes; | |
fbb9748b | 320 | |
c9d42407 PP |
321 | /* Initialize capacity to 1 if 0. */ |
322 | if (probes_capacity == 0) { | |
323 | probes = zmalloc(sizeof(*probes)); | |
324 | if (!probes) { | |
325 | PERROR("malloc probe list"); | |
326 | return -ENOMEM; | |
327 | } | |
328 | ||
329 | probes_capacity = 1; | |
330 | return 0; | |
fbb9748b JG |
331 | } |
332 | ||
c9d42407 PP |
333 | /* Double size. */ |
334 | probes_capacity *= 2; | |
335 | ||
336 | tmp_probes = zmalloc(sizeof(*tmp_probes) * probes_capacity); | |
337 | if (!tmp_probes) { | |
fbb9748b JG |
338 | PERROR("malloc probe list"); |
339 | return -ENOMEM; | |
340 | } | |
341 | ||
c9d42407 PP |
342 | for (i = 0; i < nr_probes; ++i) { |
343 | /* Move name pointer. */ | |
344 | tmp_probes[i].name = probes[i].name; | |
345 | } | |
346 | ||
347 | /* Replace probes with larger copy. */ | |
348 | free(probes); | |
349 | probes = tmp_probes; | |
350 | ||
351 | return 0; | |
352 | } | |
353 | ||
354 | /* | |
355 | * Appends a comma-separated list of probes to the global list | |
356 | * of probes. | |
357 | */ | |
358 | static int append_list_to_probes(const char *list) | |
359 | { | |
360 | char *next; | |
361 | int index = nr_probes, ret; | |
dcb0735b | 362 | char *tmp_list, *cur_list; |
c9d42407 PP |
363 | |
364 | assert(list); | |
365 | ||
dcb0735b | 366 | cur_list = tmp_list = strdup(list); |
c9d42407 PP |
367 | if (!tmp_list) { |
368 | PERROR("strdup temp list"); | |
369 | return -ENOMEM; | |
370 | } | |
371 | ||
372 | for (;;) { | |
fbb9748b | 373 | size_t name_len; |
c9d42407 | 374 | struct kern_modules_param *cur_mod; |
fbb9748b | 375 | |
dcb0735b | 376 | next = strtok(cur_list, ","); |
fbb9748b | 377 | if (!next) { |
c9d42407 | 378 | break; |
fbb9748b | 379 | } |
dcb0735b | 380 | cur_list = NULL; |
fbb9748b JG |
381 | |
382 | /* filter leading spaces */ | |
383 | while (*next == ' ') { | |
384 | next++; | |
385 | } | |
386 | ||
c9d42407 PP |
387 | if (probes_capacity <= nr_probes) { |
388 | ret = grow_probes(); | |
389 | if (ret) { | |
3dcf593a | 390 | goto error; |
c9d42407 PP |
391 | } |
392 | } | |
393 | ||
fbb9748b JG |
394 | /* Length 13 is "lttng-probe-" + \0 */ |
395 | name_len = strlen(next) + 13; | |
396 | ||
623f7b88 | 397 | cur_mod = &probes[index++]; |
c9d42407 PP |
398 | cur_mod->name = zmalloc(name_len); |
399 | if (!cur_mod->name) { | |
fbb9748b | 400 | PERROR("malloc probe list"); |
3dcf593a MD |
401 | ret = -ENOMEM; |
402 | goto error; | |
fbb9748b JG |
403 | } |
404 | ||
c9d42407 | 405 | ret = snprintf(cur_mod->name, name_len, "lttng-probe-%s", next); |
fbb9748b JG |
406 | if (ret < 0) { |
407 | PERROR("snprintf modprobe name"); | |
3dcf593a MD |
408 | ret = -ENOMEM; |
409 | goto error; | |
fbb9748b | 410 | } |
c9d42407 PP |
411 | |
412 | cur_mod++; | |
413 | nr_probes++; | |
fbb9748b JG |
414 | } |
415 | ||
c9d42407 | 416 | free(tmp_list); |
c9d42407 | 417 | return 0; |
3dcf593a MD |
418 | |
419 | error: | |
420 | free(tmp_list); | |
421 | free_probes(); | |
422 | return ret; | |
c9d42407 PP |
423 | } |
424 | ||
425 | /* | |
426 | * Load data kernel module(s). | |
427 | */ | |
428 | int modprobe_lttng_data(void) | |
429 | { | |
430 | int ret, i; | |
431 | char *list; | |
432 | ||
433 | /* | |
434 | * Base probes: either from command line option, environment | |
435 | * variable or default list. | |
436 | */ | |
437 | if (kmod_probes_list) { | |
438 | list = kmod_probes_list; | |
439 | } else { | |
440 | list = utils_get_kmod_probes_list(); | |
441 | } | |
442 | ||
443 | if (list) { | |
444 | /* User-specified probes. */ | |
445 | ret = append_list_to_probes(list); | |
c9d42407 PP |
446 | if (ret) { |
447 | return ret; | |
448 | } | |
449 | } else { | |
450 | /* Default probes. */ | |
451 | int def_len = ARRAY_SIZE(kern_modules_probes_default); | |
452 | probes = zmalloc(sizeof(*probes) * def_len); | |
453 | ||
454 | if (!probes) { | |
455 | PERROR("malloc probe list"); | |
456 | return -ENOMEM; | |
457 | } | |
458 | ||
459 | nr_probes = probes_capacity = def_len; | |
460 | ||
461 | for (i = 0; i < def_len; ++i) { | |
462 | char* name = strdup(kern_modules_probes_default[i].name); | |
463 | ||
464 | if (!name) { | |
465 | PERROR("strdup probe item"); | |
3dcf593a MD |
466 | ret = -ENOMEM; |
467 | goto error; | |
c9d42407 PP |
468 | } |
469 | ||
470 | probes[i].name = name; | |
471 | } | |
472 | } | |
473 | ||
474 | /* | |
475 | * Extra modules? Append them to current probes list. | |
476 | */ | |
477 | if (kmod_extra_probes_list) { | |
478 | list = kmod_extra_probes_list; | |
479 | } else { | |
480 | list = utils_get_extra_kmod_probes_list(); | |
481 | } | |
482 | ||
483 | if (list) { | |
484 | ret = append_list_to_probes(list); | |
485 | if (ret) { | |
3dcf593a | 486 | goto error; |
c9d42407 PP |
487 | } |
488 | } | |
489 | ||
490 | /* | |
491 | * Load probes modules now. | |
492 | */ | |
3dcf593a MD |
493 | ret = modprobe_lttng(probes, nr_probes, LTTNG_MOD_OPTIONAL); |
494 | if (ret) { | |
495 | goto error; | |
496 | } | |
497 | return ret; | |
498 | ||
499 | error: | |
500 | free_probes(); | |
501 | return ret; | |
096102bd | 502 | } |