2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2007 Joseph Koshy
5 * Copyright (c) 2007 The FreeBSD Foundation
8 * Portions of this software were developed by A. Joseph Koshy under
9 * sponsorship from the FreeBSD Foundation and Google, Inc.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
38 #include <sys/pmclog.h>
51 #include <machine/pmc_mdep.h>
53 #include "libpmcinternal.h"
55 #define PMCLOG_BUFFER_SIZE 4096
60 * The pmclog(3) API is oriented towards parsing an event stream in
61 * "realtime", i.e., from an data source that may or may not preserve
62 * record boundaries -- for example when the data source is elsewhere
63 * on a network. The API allows data to be fed into the parser zero
64 * or more bytes at a time.
66 * The state for a log file parser is maintained in a 'struct
67 * pmclog_parse_state'. Parser invocations are done by calling
68 * 'pmclog_read()'; this function will inform the caller when a
69 * complete event is parsed.
71 * The parser first assembles a complete log file event in an internal
72 * work area (see "ps_saved" below). Once a complete log file event
73 * is read, the parser then parses it and converts it to an event
74 * descriptor usable by the client. We could possibly avoid this two
75 * step process by directly parsing the input log to set fields in the
76 * event record. However the parser's state machine would get
77 * insanely complicated, and this code is unlikely to be used in
78 * performance critical paths.
81 #define PMCLOG_HEADER_FROM_SAVED_STATE(PS) \
82 (* ((uint32_t *) &(PS)->ps_saved))
84 #define PMCLOG_INITIALIZE_READER(LE,A) LE = (uint32_t *) &(A)
85 #define PMCLOG_READ32(LE,V) do { \
88 #define PMCLOG_READ64(LE,V) do { \
90 _v = (uint64_t) *(LE)++; \
91 _v |= ((uint64_t) *(LE)++) << 32; \
95 #define PMCLOG_READSTRING(LE,DST,LEN) strlcpy((DST), (char *) (LE), (LEN))
98 * Assemble a log record from '*len' octets starting from address '*data'.
99 * Update 'data' and 'len' to reflect the number of bytes consumed.
101 * '*data' is potentially an unaligned address and '*len' octets may
102 * not be enough to complete a event record.
105 static enum pmclog_parser_state
106 pmclog_get_record(struct pmclog_parse_state *ps, char **data, ssize_t *len)
108 int avail, copylen, recordsize, used;
110 const int HEADERSIZE = sizeof(uint32_t);
113 if ((avail = *len) <= 0)
114 return (ps->ps_state = PL_STATE_ERROR);
119 if (ps->ps_state == PL_STATE_NEW_RECORD)
122 dst = (char *) &ps->ps_saved + ps->ps_svcount;
124 switch (ps->ps_state) {
125 case PL_STATE_NEW_RECORD:
130 * Case A: avail < headersize
131 * -> 'expecting header'
133 * Case B: avail >= headersize
134 * B.1: avail < recordsize
135 * -> 'partial record'
136 * B.2: avail >= recordsize
140 copylen = avail < HEADERSIZE ? avail : HEADERSIZE;
141 bcopy(src, dst, copylen);
142 ps->ps_svcount = used = copylen;
144 if (copylen < HEADERSIZE) {
145 ps->ps_state = PL_STATE_EXPECTING_HEADER;
152 h = PMCLOG_HEADER_FROM_SAVED_STATE(ps);
153 recordsize = PMCLOG_HEADER_TO_LENGTH(h);
158 if (recordsize <= avail) { /* full record available */
159 bcopy(src, dst, recordsize - copylen);
160 ps->ps_svcount = used = recordsize;
164 /* header + a partial record is available */
165 bcopy(src, dst, avail - copylen);
166 ps->ps_svcount = used = avail;
167 ps->ps_state = PL_STATE_PARTIAL_RECORD;
171 case PL_STATE_EXPECTING_HEADER:
176 * Case C: avail+saved < headersize
177 * -> 'expecting header'
179 * Case D: avail+saved >= headersize
180 * D.1: avail+saved < recordsize
181 * -> 'partial record'
182 * D.2: avail+saved >= recordsize
184 * (see PARTIAL_RECORD handling below)
187 if (avail + ps->ps_svcount < HEADERSIZE) {
188 bcopy(src, dst, avail);
189 ps->ps_svcount += avail;
194 used = copylen = HEADERSIZE - ps->ps_svcount;
195 bcopy(src, dst, copylen);
199 ps->ps_svcount += copylen;
203 case PL_STATE_PARTIAL_RECORD:
208 * Case E: avail+saved < recordsize
209 * -> 'partial record'
211 * Case F: avail+saved >= recordsize
215 h = PMCLOG_HEADER_FROM_SAVED_STATE(ps);
216 recordsize = PMCLOG_HEADER_TO_LENGTH(h);
221 if (avail + ps->ps_svcount < recordsize) {
223 ps->ps_state = PL_STATE_PARTIAL_RECORD;
225 copylen = recordsize - ps->ps_svcount;
226 ps->ps_state = PL_STATE_NEW_RECORD;
229 bcopy(src, dst, copylen);
230 ps->ps_svcount += copylen;
244 ps->ps_state = PL_STATE_ERROR;
249 * Get an event from the stream pointed to by '*data'. '*len'
250 * indicates the number of bytes available to parse. Arguments
251 * '*data' and '*len' are updated to indicate the number of bytes
256 pmclog_get_event(void *cookie, char **data, ssize_t *len,
257 struct pmclog_ev *ev)
260 uint32_t h, *le, npc, noop;
261 enum pmclog_parser_state e;
262 struct pmclog_parse_state *ps;
264 ps = (struct pmclog_parse_state *) cookie;
266 assert(ps->ps_state != PL_STATE_ERROR);
268 if ((e = pmclog_get_record(ps,data,len)) == PL_STATE_ERROR) {
269 ev->pl_state = PMCLOG_ERROR;
270 printf("state error\n");
274 if (e != PL_STATE_NEW_RECORD) {
275 ev->pl_state = PMCLOG_REQUIRE_DATA;
279 PMCLOG_INITIALIZE_READER(le, ps->ps_saved);
283 if (!PMCLOG_HEADER_CHECK_MAGIC(h)) {
284 printf("bad magic\n");
285 ps->ps_state = PL_STATE_ERROR;
286 ev->pl_state = PMCLOG_ERROR;
290 /* copy out the time stamp */
291 PMCLOG_READ32(le,ev->pl_ts.tv_sec);
292 PMCLOG_READ32(le,ev->pl_ts.tv_nsec);
294 evlen = PMCLOG_HEADER_TO_LENGTH(h);
296 #define PMCLOG_GET_PATHLEN(P,E,TYPE) do { \
297 (P) = (E) - offsetof(struct TYPE, pl_pathname); \
298 if ((P) > PATH_MAX || (P) < 0) \
302 #define PMCLOG_GET_CALLCHAIN_SIZE(SZ,E) do { \
303 (SZ) = ((E) - offsetof(struct pmclog_callchain, pl_pc)) \
304 / sizeof(uintfptr_t); \
307 switch (ev->pl_type = PMCLOG_HEADER_TO_TYPE(h)) {
308 case PMCLOG_TYPE_CALLCHAIN:
309 PMCLOG_READ32(le,ev->pl_u.pl_cc.pl_pid);
310 PMCLOG_READ32(le,ev->pl_u.pl_cc.pl_tid);
311 PMCLOG_READ32(le,ev->pl_u.pl_cc.pl_pmcid);
312 PMCLOG_READ32(le,ev->pl_u.pl_cc.pl_cpuflags);
313 PMCLOG_READ32(le,ev->pl_u.pl_cc.pl_cpuflags2);
314 PMCLOG_GET_CALLCHAIN_SIZE(ev->pl_u.pl_cc.pl_npc,evlen);
315 for (npc = 0; npc < ev->pl_u.pl_cc.pl_npc; npc++)
316 PMCLOG_READADDR(le,ev->pl_u.pl_cc.pl_pc[npc]);
317 for (;npc < PMC_CALLCHAIN_DEPTH_MAX; npc++)
318 ev->pl_u.pl_cc.pl_pc[npc] = (uintfptr_t) 0;
320 case PMCLOG_TYPE_CLOSELOG:
321 ev->pl_state = PMCLOG_EOF;
323 case PMCLOG_TYPE_DROPNOTIFY:
326 case PMCLOG_TYPE_INITIALIZE:
327 PMCLOG_READ32(le,ev->pl_u.pl_i.pl_version);
328 PMCLOG_READ32(le,ev->pl_u.pl_i.pl_arch);
329 PMCLOG_READSTRING(le, ev->pl_u.pl_i.pl_cpuid, PMC_CPUID_LEN);
330 memcpy(ev->pl_u.pl_i.pl_cpuid, le, PMC_CPUID_LEN);
331 ps->ps_version = ev->pl_u.pl_i.pl_version;
332 ps->ps_arch = ev->pl_u.pl_i.pl_arch;
333 ps->ps_initialized = 1;
335 case PMCLOG_TYPE_MAP_IN:
336 PMCLOG_GET_PATHLEN(pathlen,evlen,pmclog_map_in);
337 PMCLOG_READ32(le,ev->pl_u.pl_mi.pl_pid);
338 PMCLOG_READADDR(le,ev->pl_u.pl_mi.pl_start);
339 PMCLOG_READSTRING(le, ev->pl_u.pl_mi.pl_pathname, pathlen);
341 case PMCLOG_TYPE_MAP_OUT:
342 PMCLOG_READ32(le,ev->pl_u.pl_mo.pl_pid);
343 PMCLOG_READADDR(le,ev->pl_u.pl_mo.pl_start);
344 PMCLOG_READADDR(le,ev->pl_u.pl_mo.pl_end);
346 case PMCLOG_TYPE_PMCALLOCATE:
347 PMCLOG_READ32(le,ev->pl_u.pl_a.pl_pmcid);
348 PMCLOG_READ32(le,ev->pl_u.pl_a.pl_event);
349 PMCLOG_READ32(le,ev->pl_u.pl_a.pl_flags);
350 PMCLOG_READ32(le,noop);
351 ev->pl_u.pl_a.pl_evname = pmc_pmu_event_get_by_idx(ev->pl_u.pl_a.pl_event);
352 if (ev->pl_u.pl_a.pl_evname != NULL)
354 else if ((ev->pl_u.pl_a.pl_evname =
355 _pmc_name_of_event(ev->pl_u.pl_a.pl_event, ps->ps_arch))
357 printf("unknown event\n");
361 case PMCLOG_TYPE_PMCALLOCATEDYN:
362 PMCLOG_READ32(le,ev->pl_u.pl_ad.pl_pmcid);
363 PMCLOG_READ32(le,ev->pl_u.pl_ad.pl_event);
364 PMCLOG_READ32(le,ev->pl_u.pl_ad.pl_flags);
365 PMCLOG_READSTRING(le,ev->pl_u.pl_ad.pl_evname,PMC_NAME_MAX);
367 case PMCLOG_TYPE_PMCATTACH:
368 PMCLOG_GET_PATHLEN(pathlen,evlen,pmclog_pmcattach);
369 PMCLOG_READ32(le,ev->pl_u.pl_t.pl_pmcid);
370 PMCLOG_READ32(le,ev->pl_u.pl_t.pl_pid);
371 PMCLOG_READSTRING(le,ev->pl_u.pl_t.pl_pathname,pathlen);
373 case PMCLOG_TYPE_PMCDETACH:
374 PMCLOG_READ32(le,ev->pl_u.pl_d.pl_pmcid);
375 PMCLOG_READ32(le,ev->pl_u.pl_d.pl_pid);
377 case PMCLOG_TYPE_PROCCSW:
378 PMCLOG_READ32(le,ev->pl_u.pl_c.pl_pmcid);
379 PMCLOG_READ64(le,ev->pl_u.pl_c.pl_value);
380 PMCLOG_READ32(le,ev->pl_u.pl_c.pl_pid);
381 PMCLOG_READ32(le,ev->pl_u.pl_c.pl_tid);
383 case PMCLOG_TYPE_PROCEXEC:
384 PMCLOG_GET_PATHLEN(pathlen,evlen,pmclog_procexec);
385 PMCLOG_READ32(le,ev->pl_u.pl_x.pl_pid);
386 PMCLOG_READ32(le,ev->pl_u.pl_x.pl_pmcid);
387 PMCLOG_READ32(le,noop);
388 PMCLOG_READADDR(le,ev->pl_u.pl_x.pl_entryaddr);
389 PMCLOG_READSTRING(le,ev->pl_u.pl_x.pl_pathname,pathlen);
391 case PMCLOG_TYPE_PROCEXIT:
392 PMCLOG_READ32(le,ev->pl_u.pl_e.pl_pmcid);
393 PMCLOG_READ32(le,ev->pl_u.pl_e.pl_pid);
394 PMCLOG_READ32(le,noop);
395 PMCLOG_READ64(le,ev->pl_u.pl_e.pl_value);
397 case PMCLOG_TYPE_PROCFORK:
398 PMCLOG_READ32(le,ev->pl_u.pl_f.pl_oldpid);
399 PMCLOG_READ32(le,ev->pl_u.pl_f.pl_newpid);
401 case PMCLOG_TYPE_SYSEXIT:
402 PMCLOG_READ32(le,ev->pl_u.pl_se.pl_pid);
404 case PMCLOG_TYPE_USERDATA:
405 PMCLOG_READ32(le,ev->pl_u.pl_u.pl_userdata);
407 default: /* unknown record type */
408 ps->ps_state = PL_STATE_ERROR;
409 ev->pl_state = PMCLOG_ERROR;
413 ev->pl_offset = (ps->ps_offset += evlen);
414 ev->pl_count = (ps->ps_count += 1);
416 ev->pl_state = PMCLOG_OK;
420 ev->pl_state = PMCLOG_ERROR;
421 ps->ps_state = PL_STATE_ERROR;
426 * Extract and return the next event from the byte stream.
428 * Returns 0 and sets the event's state to PMCLOG_OK in case an event
429 * was successfully parsed. Otherwise this function returns -1 and
430 * sets the event's state to one of PMCLOG_REQUIRE_DATA (if more data
431 * is needed) or PMCLOG_EOF (if an EOF was seen) or PMCLOG_ERROR if
432 * a parse error was encountered.
436 pmclog_read(void *cookie, struct pmclog_ev *ev)
440 struct pmclog_parse_state *ps;
442 ps = (struct pmclog_parse_state *) cookie;
444 if (ps->ps_state == PL_STATE_ERROR) {
445 ev->pl_state = PMCLOG_ERROR;
450 * If there isn't enough data left for a new event try and get
453 if (ps->ps_len == 0) {
454 ev->pl_state = PMCLOG_REQUIRE_DATA;
457 * If we have a valid file descriptor to read from, attempt
458 * to read from that. This read may return with an error,
459 * (which may be EAGAIN or other recoverable error), or
462 if (ps->ps_fd != PMCLOG_FD_NONE) {
464 nread = read(ps->ps_fd, ps->ps_buffer,
469 ev->pl_state = PMCLOG_EOF;
470 else if (errno != EAGAIN) /* not restartable */
471 ev->pl_state = PMCLOG_ERROR;
476 ps->ps_data = ps->ps_buffer;
482 assert(ps->ps_len > 0);
485 /* Retrieve one event from the byte stream. */
486 retval = pmclog_get_event(ps, &ps->ps_data, &ps->ps_len, ev);
488 * If we need more data and we have a configured fd, try read
491 if (retval < 0 && ev->pl_state == PMCLOG_REQUIRE_DATA &&
493 assert(ps->ps_len == 0);
501 * Feed data to a memory based parser.
503 * The memory area pointed to by 'data' needs to be valid till the
504 * next error return from pmclog_next_event().
508 pmclog_feed(void *cookie, char *data, int len)
510 struct pmclog_parse_state *ps;
512 ps = (struct pmclog_parse_state *) cookie;
514 if (len < 0 || /* invalid length */
515 ps->ps_buffer || /* called for a file parser */
516 ps->ps_len != 0) /* unnecessary call */
526 * Allocate and initialize parser state.
532 struct pmclog_parse_state *ps;
534 if ((ps = (struct pmclog_parse_state *) malloc(sizeof(*ps))) == NULL)
537 ps->ps_state = PL_STATE_NEW_RECORD;
539 ps->ps_initialized = 0;
541 ps->ps_offset = (off_t) 0;
542 bzero(&ps->ps_saved, sizeof(ps->ps_saved));
546 ps->ps_buffer = NULL;
549 /* allocate space for a work area */
550 if (ps->ps_fd != PMCLOG_FD_NONE) {
551 if ((ps->ps_buffer = malloc(PMCLOG_BUFFER_SIZE)) == NULL) {
562 * Free up parser state.
566 pmclog_close(void *cookie)
568 struct pmclog_parse_state *ps;
570 ps = (struct pmclog_parse_state *) cookie;