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