perf: Have arches handle the backtrace
[akaros.git] / kern / drivers / dev / kprof.c
1 /*
2  * This file is part of the UCB release of Plan 9. It is subject to the license
3  * terms in the LICENSE file found in the top-level directory of this
4  * distribution and at http://akaros.cs.berkeley.edu/files/Plan9License. No
5  * part of the UCB release of Plan 9, including this file, may be copied,
6  * modified, propagated, or distributed except according to the terms contained
7  * in the LICENSE file.
8  */
9
10 #include <ros/profiler_records.h>
11 #include <arch/time.h>
12 #include <vfs.h>
13 #include <slab.h>
14 #include <kmalloc.h>
15 #include <kref.h>
16 #include <atomic.h>
17 #include <kthread.h>
18 #include <string.h>
19 #include <stdio.h>
20 #include <assert.h>
21 #include <error.h>
22 #include <pmap.h>
23 #include <smp.h>
24 #include <time.h>
25 #include <circular_buffer.h>
26 #include <umem.h>
27 #include <profiler.h>
28 #include <kprof.h>
29 #include <ros/procinfo.h>
30
31 #define KTRACE_BUFFER_SIZE (128 * 1024)
32 #define TRACE_PRINTK_BUFFER_SIZE (8 * 1024)
33
34 enum {
35         Kprofdirqid = 0,
36         Kprofdataqid,
37         Kprofctlqid,
38         Kptraceqid,
39         Kprintxqid,
40         Kmpstatqid,
41         Kmpstatrawqid,
42 };
43
44 struct trace_printk_buffer {
45         atomic_t in_use;
46         char buffer[TRACE_PRINTK_BUFFER_SIZE];
47 };
48
49 struct kprof {
50         qlock_t lock;
51         bool mpstat_ipi;
52         bool profiling;
53         bool opened;
54 };
55
56 struct dev kprofdevtab;
57 struct dirtab kproftab[] = {
58         {".",                   {Kprofdirqid,           0, QTDIR}, 0,   DMDIR|0550},
59         {"kpdata",              {Kprofdataqid},         0,      0600},
60         {"kpctl",               {Kprofctlqid},          0,      0600},
61         {"kptrace",             {Kptraceqid},           0,      0600},
62         {"kprintx",             {Kprintxqid},           0,      0600},
63         {"mpstat",              {Kmpstatqid},           0,      0600},
64         {"mpstat-raw",  {Kmpstatrawqid},        0,      0600},
65 };
66
67 static struct kprof kprof;
68 static bool ktrace_init_done = FALSE;
69 static spinlock_t ktrace_lock = SPINLOCK_INITIALIZER_IRQSAVE;
70 static struct circular_buffer ktrace_data;
71 static char ktrace_buffer[KTRACE_BUFFER_SIZE];
72 static char kprof_control_usage[128];
73
74 static size_t mpstat_len(void)
75 {
76         size_t each_row = 7 + NR_CPU_STATES * 26;
77
78         return each_row * (num_cores + 1) + 1;
79 }
80
81 static size_t mpstatraw_len(void)
82 {
83         size_t header_row = 27 + NR_CPU_STATES * 7 + 1;
84         size_t cpu_row = 7 + NR_CPU_STATES * 17;
85
86         return header_row + cpu_row * num_cores + 1;
87 }
88
89 static char *devname(void)
90 {
91         return kprofdevtab.name;
92 }
93
94 static struct chan *kprof_attach(char *spec)
95 {
96         return devattach(devname(), spec);
97 }
98
99 /* Start collecting samples from perf events into the profiler.
100  *
101  * This command only runs if the user successfully opened kpctl, which gives
102  * them a profiler (the global profiler, for now). */
103 static void kprof_start_profiler(void)
104 {
105         ERRSTACK(1);
106
107         qlock(&kprof.lock);
108         if (waserror()) {
109                 qunlock(&kprof.lock);
110                 nexterror();
111         }
112         if (!kprof.profiling) {
113                 profiler_start();
114                 kprof.profiling = TRUE;
115         }
116         poperror();
117         qunlock(&kprof.lock);
118 }
119
120 /* Stops collecting samples from perf events.
121  *
122  * This command only runs if the user successfully opened kpctl, which gives
123  * them a profiler (the global profiler, for now). */
124 static void kprof_stop_profiler(void)
125 {
126         ERRSTACK(1);
127
128         qlock(&kprof.lock);
129         if (waserror()) {
130                 qunlock(&kprof.lock);
131                 nexterror();
132         }
133         if (kprof.profiling) {
134                 profiler_stop();
135                 kprof.profiling = FALSE;
136         }
137         poperror();
138         qunlock(&kprof.lock);
139 }
140
141 /* Makes each core flush its results into the profiler queue.  You can do this
142  * while the profiler is still running.  However, this does not hang up the
143  * queue, so reads on kpdata will block. */
144 static void kprof_flush_profiler(void)
145 {
146         ERRSTACK(1);
147
148         qlock(&kprof.lock);
149         if (waserror()) {
150                 qunlock(&kprof.lock);
151                 nexterror();
152         }
153         if (kprof.profiling)
154                 profiler_trace_data_flush();
155         poperror();
156         qunlock(&kprof.lock);
157 }
158
159 static void kprof_init(void)
160 {
161         profiler_init();
162
163         qlock_init(&kprof.lock);
164         kprof.profiling = FALSE;
165         kprof.opened = FALSE;
166
167         for (int i = 0; i < ARRAY_SIZE(kproftab); i++)
168                 kproftab[i].length = 0;
169
170         kprof.mpstat_ipi = TRUE;
171         kproftab[Kmpstatqid].length = mpstat_len();
172         kproftab[Kmpstatrawqid].length = mpstatraw_len();
173
174         strlcpy(kprof_control_usage, "start|stop|flush",
175                 sizeof(kprof_control_usage));
176         profiler_append_configure_usage(kprof_control_usage,
177                                         sizeof(kprof_control_usage));
178 }
179
180 static void kprof_shutdown(void)
181 {
182 }
183
184 static struct walkqid *kprof_walk(struct chan *c, struct chan *nc, char **name,
185                                   int nname)
186 {
187         return devwalk(c, nc, name, nname, kproftab, ARRAY_SIZE(kproftab), devgen);
188 }
189
190 static size_t kprof_profdata_size(void)
191 {
192         return profiler_size();
193 }
194
195 static long kprof_profdata_read(void *dest, long size, int64_t off)
196 {
197         return profiler_read(dest, size);
198 }
199
200 static int kprof_stat(struct chan *c, uint8_t *db, int n)
201 {
202         kproftab[Kprofdataqid].length = kprof_profdata_size();
203         kproftab[Kptraceqid].length = kprof_tracedata_size();
204
205         return devstat(c, db, n, kproftab, ARRAY_SIZE(kproftab), devgen);
206 }
207
208 static struct chan *kprof_open(struct chan *c, int omode)
209 {
210         if (c->qid.type & QTDIR) {
211                 if (openmode(omode) != O_READ)
212                         error(EPERM, ERROR_FIXME);
213         }
214         switch ((int) c->qid.path) {
215         case Kprofctlqid:
216                 /* We have one global profiler.  Only one FD may be opened at a time for
217                  * it.  If we ever have separate profilers, we can create the profiler
218                  * here, and every open would get a separate instance. */
219                 qlock(&kprof.lock);
220                 if (kprof.opened) {
221                         qunlock(&kprof.lock);
222                         error(EBUSY, "Global profiler is already open");
223                 }
224                 kprof.opened = TRUE;
225                 /* TODO: have a real creation function for a non-global profiler */
226                 profiler_setup();
227                 qunlock(&kprof.lock);
228                 break;
229         }
230         c->mode = openmode(omode);
231         c->flag |= COPEN;
232         c->offset = 0;
233         return c;
234 }
235
236 static void kprof_close(struct chan *c)
237 {
238         if (c->flag & COPEN) {
239                 switch ((int) c->qid.path) {
240                 case Kprofctlqid:
241                         kprof_stop_profiler();
242                         qlock(&kprof.lock);
243                         profiler_cleanup();
244                         kprof.opened = FALSE;
245                         qunlock(&kprof.lock);
246                         break;
247                 }
248         }
249 }
250
251 static long mpstat_read(void *va, long n, int64_t off)
252 {
253         size_t bufsz = mpstat_len();
254         char *buf = kmalloc(bufsz, MEM_WAIT);
255         int len = 0;
256         struct per_cpu_info *pcpui;
257         uint64_t cpu_total;
258         struct timespec ts;
259
260         /* the IPI interferes with other cores, might want to disable that. */
261         if (kprof.mpstat_ipi)
262                 send_broadcast_ipi(I_POKE_CORE);
263
264         len += snprintf(buf + len, bufsz - len, "  CPU: ");
265         for (int j = 0; j < NR_CPU_STATES; j++)
266                 len += snprintf(buf + len, bufsz - len, "%23s%s", cpu_state_names[j],
267                                 j != NR_CPU_STATES - 1 ? "   " : "  \n");
268
269         for (int i = 0; i < num_cores; i++) {
270                 pcpui = &per_cpu_info[i];
271                 cpu_total = 0;
272                 len += snprintf(buf + len, bufsz - len, "%5d: ", i);
273                 for (int j = 0; j < NR_CPU_STATES; j++)
274                         cpu_total += pcpui->state_ticks[j];
275                 cpu_total = MAX(cpu_total, 1);  /* for the divide later */
276                 for (int j = 0; j < NR_CPU_STATES; j++) {
277                         ts = tsc2timespec(pcpui->state_ticks[j]);
278                         len += snprintf(buf + len, bufsz - len, "%10d.%06d (%3d%%)%s",
279                                         ts.tv_sec, ts.tv_nsec / 1000,
280                                         MIN((pcpui->state_ticks[j] * 100) / cpu_total, 100),
281                                         j != NR_CPU_STATES - 1 ? ", " : " \n");
282                 }
283         }
284         n = readstr(off, va, n, buf);
285         kfree(buf);
286         return n;
287 }
288
289 static long mpstatraw_read(void *va, long n, int64_t off)
290 {
291         size_t bufsz = mpstatraw_len();
292         char *buf = kmalloc(bufsz, MEM_WAIT);
293         int len = 0;
294         struct per_cpu_info *pcpui;
295
296         /* could spit it all out in binary, though then it'd be harder to process
297          * the data across a mnt (if we export #K).  probably not a big deal. */
298
299         /* header line: version, num_cores, tsc freq, state names */
300         len += snprintf(buf + len, bufsz - len, "v%03d %5d %16llu", 1, num_cores,
301                         __proc_global_info.tsc_freq);
302         for (int j = 0; j < NR_CPU_STATES; j++)
303                 len += snprintf(buf + len, bufsz - len, " %6s", cpu_state_names[j]);
304         len += snprintf(buf + len, bufsz - len, "\n");
305
306         for (int i = 0; i < num_cores; i++) {
307                 pcpui = &per_cpu_info[i];
308                 len += snprintf(buf + len, bufsz - len, "%5d: ", i);
309                 for (int j = 0; j < NR_CPU_STATES; j++) {
310                         len += snprintf(buf + len, bufsz - len, "%16llx%s",
311                                         pcpui->state_ticks[j],
312                                         j != NR_CPU_STATES - 1 ? " " : "\n");
313                 }
314         }
315         n = readstr(off, va, n, buf);
316         kfree(buf);
317         return n;
318 }
319
320 static long kprof_read(struct chan *c, void *va, long n, int64_t off)
321 {
322         uint64_t w, *bp;
323         char *a, *ea;
324         uintptr_t offset = off;
325         uint64_t pc;
326
327         switch ((int) c->qid.path) {
328         case Kprofdirqid:
329                 return devdirread(c, va, n, kproftab, ARRAY_SIZE(kproftab), devgen);
330         case Kprofdataqid:
331                 n = kprof_profdata_read(va, n, off);
332                 break;
333         case Kptraceqid:
334                 n = kprof_tracedata_read(va, n, off);
335                 break;
336         case Kprintxqid:
337                 n = readstr(offset, va, n, printx_on ? "on" : "off");
338                 break;
339         case Kmpstatqid:
340                 n = mpstat_read(va, n, offset);
341                 break;
342         case Kmpstatrawqid:
343                 n = mpstatraw_read(va, n, offset);
344                 break;
345         default:
346                 n = 0;
347                 break;
348         }
349         return n;
350 }
351
352 static long kprof_write(struct chan *c, void *a, long n, int64_t unused)
353 {
354         ERRSTACK(1);
355         struct cmdbuf *cb = parsecmd(a, n);
356
357         if (waserror()) {
358                 kfree(cb);
359                 nexterror();
360         }
361         switch ((int) c->qid.path) {
362         case Kprofctlqid:
363                 if (cb->nf < 1)
364                         error(EFAIL, kprof_control_usage);
365                 if (profiler_configure(cb))
366                         break;
367                 if (!strcmp(cb->f[0], "start")) {
368                         kprof_start_profiler();
369                 } else if (!strcmp(cb->f[0], "flush")) {
370                         kprof_flush_profiler();
371                 } else if (!strcmp(cb->f[0], "stop")) {
372                         kprof_stop_profiler();
373                 } else {
374                         error(EFAIL, kprof_control_usage);
375                 }
376                 break;
377         case Kptraceqid:
378                 if (a && (n > 0)) {
379                         char *uptr = user_strdup_errno(current, a, n);
380
381                         if (uptr) {
382                                 trace_printk(false, "%s", uptr);
383                                 user_memdup_free(current, uptr);
384                         } else {
385                                 n = -1;
386                         }
387                 }
388                 break;
389         case Kprintxqid:
390                 if (!strncmp(a, "on", 2))
391                         set_printx(1);
392                 else if (!strncmp(a, "off", 3))
393                         set_printx(0);
394                 else if (!strncmp(a, "toggle", 6))
395                         set_printx(2);
396                 else
397                         error(EFAIL, "Invalid option to Kprintx %s\n", a);
398                 break;
399         case Kmpstatqid:
400         case Kmpstatrawqid:
401                 if (cb->nf < 1)
402                         error(EFAIL, "Bad mpstat option (reset|ipi|on|off)");
403                 if (!strcmp(cb->f[0], "reset")) {
404                         for (int i = 0; i < num_cores; i++)
405                                 reset_cpu_state_ticks(i);
406                 } else if (!strcmp(cb->f[0], "on")) {
407                         /* TODO: enable the ticks */ ;
408                 } else if (!strcmp(cb->f[0], "off")) {
409                         /* TODO: disable the ticks */ ;
410                 } else if (!strcmp(cb->f[0], "ipi")) {
411                         if (cb->nf < 2)
412                                 error(EFAIL, "Need another arg: ipi [on|off]");
413                         if (!strcmp(cb->f[1], "on"))
414                                 kprof.mpstat_ipi = TRUE;
415                         else if (!strcmp(cb->f[1], "off"))
416                                 kprof.mpstat_ipi = FALSE;
417                         else
418                                 error(EFAIL, "ipi [on|off]");
419                 } else {
420                         error(EFAIL, "Bad mpstat option (reset|ipi|on|off)");
421                 }
422                 break;
423         default:
424                 error(EBADFD, ERROR_FIXME);
425         }
426         kfree(cb);
427         poperror();
428         return n;
429 }
430
431 size_t kprof_tracedata_size(void)
432 {
433         return circular_buffer_size(&ktrace_data);
434 }
435
436 size_t kprof_tracedata_read(void *data, size_t size, size_t offset)
437 {
438         spin_lock_irqsave(&ktrace_lock);
439         if (likely(ktrace_init_done))
440                 size = circular_buffer_read(&ktrace_data, data, size, offset);
441         else
442                 size = 0;
443         spin_unlock_irqsave(&ktrace_lock);
444
445         return size;
446 }
447
448 void kprof_tracedata_write(const char *pretty_buf, size_t len)
449 {
450         spin_lock_irqsave(&ktrace_lock);
451         if (unlikely(!ktrace_init_done)) {
452                 circular_buffer_init(&ktrace_data, sizeof(ktrace_buffer),
453                                      ktrace_buffer);
454                 ktrace_init_done = TRUE;
455         }
456         circular_buffer_write(&ktrace_data, pretty_buf, len);
457         spin_unlock_irqsave(&ktrace_lock);
458 }
459
460 static struct trace_printk_buffer *kprof_get_printk_buffer(void)
461 {
462         static struct trace_printk_buffer boot_tpb;
463         static struct trace_printk_buffer *cpu_tpbs;
464         static atomic_t alloc_done;
465
466         if (unlikely(!num_cores))
467                 return &boot_tpb;
468         if (unlikely(!cpu_tpbs)) {
469                 /* Poor man per-CPU data structure. I really do no like littering global
470                  * data structures with module specific data.
471                  * We cannot take the ktrace_lock to protect the kzmalloc() call, as
472                  * that might trigger printk()s, and we would reenter here.
473                  * Let only one core into the kzmalloc() path, and let the others get
474                  * the boot_tpb until finished.
475                  */
476                 if (!atomic_cas(&alloc_done, 0, 1))
477                         return &boot_tpb;
478                 cpu_tpbs = kzmalloc(num_cores * sizeof(struct trace_printk_buffer), 0);
479         }
480
481         return cpu_tpbs + core_id_early();
482 }
483
484 void trace_vprintk(bool btrace, const char *fmt, va_list args)
485 {
486         struct print_buf {
487                 char *ptr;
488                 char *top;
489         };
490
491         void emit_print_buf_str(struct print_buf *pb, const char *str, ssize_t size)
492         {
493                 if (size < 0) {
494                         for (; *str && (pb->ptr < pb->top); str++)
495                                 *(pb->ptr++) = *str;
496                 } else {
497                         for (; (size > 0) && (pb->ptr < pb->top); str++, size--)
498                                 *(pb->ptr++) = *str;
499                 }
500         }
501
502         void bt_print(void *opaque, const char *str)
503         {
504                 struct print_buf *pb = (struct print_buf *) opaque;
505
506                 emit_print_buf_str(pb, "\t", 1);
507                 emit_print_buf_str(pb, str, -1);
508         }
509
510         static const size_t bufsz = TRACE_PRINTK_BUFFER_SIZE;
511         static const size_t usr_bufsz = (3 * bufsz) / 8;
512         static const size_t kp_bufsz = bufsz - usr_bufsz;
513         struct trace_printk_buffer *tpb = kprof_get_printk_buffer();
514         struct timespec ts_now = { 0, 0 };
515         struct print_buf pb;
516         char *usrbuf = tpb->buffer, *kpbuf = tpb->buffer + usr_bufsz;
517         const char *utop, *uptr;
518         char hdr[64];
519
520         if (!atomic_cas(&tpb->in_use, 0, 1))
521                 return;
522         if (likely(__proc_global_info.tsc_freq))
523                 ts_now = tsc2timespec(read_tsc());
524         snprintf(hdr, sizeof(hdr), "[%lu.%09lu]:cpu%d: ", ts_now.tv_sec,
525                  ts_now.tv_nsec, core_id_early());
526
527         pb.ptr = usrbuf + vsnprintf(usrbuf, usr_bufsz, fmt, args);
528         pb.top = usrbuf + usr_bufsz;
529
530         if (pb.ptr[-1] != '\n')
531                 emit_print_buf_str(&pb, "\n", 1);
532         if (btrace) {
533                 emit_print_buf_str(&pb, "\tBacktrace:\n", -1);
534                 gen_backtrace(bt_print, &pb);
535         }
536         /* snprintf null terminates the buffer, and does not count that as part of
537          * the len.  If we maxed out the buffer, let's make sure it has a \n.
538          */
539         if (pb.ptr == pb.top)
540                 pb.ptr[-1] = '\n';
541         utop = pb.ptr;
542
543         pb.ptr = kpbuf;
544         pb.top = kpbuf + kp_bufsz;
545         for (uptr = usrbuf; uptr < utop;) {
546                 const char *nlptr = memchr(uptr, '\n', utop - uptr);
547
548                 if (nlptr == NULL)
549                         nlptr = utop;
550                 emit_print_buf_str(&pb, hdr, -1);
551                 emit_print_buf_str(&pb, uptr, (nlptr - uptr) + 1);
552                 uptr = nlptr + 1;
553         }
554         kprof_tracedata_write(kpbuf, pb.ptr - kpbuf);
555         atomic_set(&tpb->in_use, 0);
556 }
557
558 void trace_printk(bool btrace, const char *fmt, ...)
559 {
560         va_list args;
561
562         va_start(args, fmt);
563         trace_vprintk(btrace, fmt, args);
564         va_end(args);
565 }
566
567 struct dev kprofdevtab __devtab = {
568         .name = "kprof",
569
570         .reset = devreset,
571         .init = kprof_init,
572         .shutdown = kprof_shutdown,
573         .attach = kprof_attach,
574         .walk = kprof_walk,
575         .stat = kprof_stat,
576         .open = kprof_open,
577         .create = devcreate,
578         .close = kprof_close,
579         .read = kprof_read,
580         .bread = devbread,
581         .write = kprof_write,
582         .bwrite = devbwrite,
583         .remove = devremove,
584         .wstat = devwstat,
585 };