| Portability | ghc |
|---|---|
| Stability | experimental |
| Maintainer | florbitous@gmail.com |
| Safe Haskell | None |
Profiling.Linux.Perf.Types
Contents
Description
Types for representing the parsed contents of a perf.data file output
the perf record command on Linux (Linux performance counter information).
There is an intentional close correspondence between the types in this module and the representation in the C implementation of perf.
- newtype PID = PID {}
- newtype TID = TID {}
- newtype EventID = EventID {}
- newtype EventTypeID = EventTypeID {}
- newtype ByteCount64 = ByteCount64 {}
- newtype ByteCount32 = ByteCount32 {}
- newtype ByteCount16 = ByteCount16 {}
- newtype TimeStamp = TimeStamp {}
- data FileSection = FileSection {}
- data FileHeader = FileHeader {}
- data FileAttr = FileAttr {}
- data Event = Event {}
- data EventCPUMode
- data EventAttr = EventAttr {}
- data EventHeader = EventHeader {}
- data EventPayload
- = CommEvent { }
- | MmapEvent { }
- | ForkEvent { }
- | ExitEvent { }
- | LostEvent { }
- | ReadEvent { }
- | SampleEvent {
- eventPayload_SampleIP :: Maybe Word64
- eventPayload_SamplePID :: Maybe PID
- eventPayload_SampleTID :: Maybe TID
- eventPayload_SampleTime :: Maybe TimeStamp
- eventPayload_SampleAddr :: Maybe Word64
- eventPayload_SampleID :: Maybe EventID
- eventPayload_SampleStreamID :: Maybe Word64
- eventPayload_SampleCPU :: Maybe Word32
- eventPayload_SamplePeriod :: Maybe Word64
- | ThrottleEvent { }
- | UnThrottleEvent { }
- | UnknownEvent
- data EventType
- data SampleFormat
- data TraceEventType = TraceEventType {}
- data EventAttrFlag
- = Disabled
- | Inherit
- | Pinned
- | Exclusive
- | ExcludeUser
- | ExcludeKernel
- | ExcludeHV
- | ExcludeIdle
- | Mmap
- | Comm
- | Freq
- | InheritStat
- | EnableOnExec
- | Task
- | WaterMark
- | ArbitrarySkid
- | ConstantSkid
- | RequestedZeroSkid
- | CompulsoryZeroSkid
- | MmapData
- | SampleIdAll
- data EventSource
- newtype SampleTypeBitMap = SampleTypeBitMap {}
- testEventAttrFlag :: Word64 -> EventAttrFlag -> Bool
- data PerfData = PerfData {
- perfData_fileHeader :: FileHeader
- perfData_attrs :: [FileAttr]
- perfData_idss :: [[EventID]]
- perfData_types :: [TraceEventType]
- perfData_events :: [Event]
Identifiers
Process ID.
Thread ID.
Event ID. Not really an identity. This number is used to link an event to an event type. Multiple events can have the same EventID, which means they all have the same event type.
newtype EventTypeID Source
Event type ID (magic unique number of an event type).
Constructors
| EventTypeID | |
Fields | |
Instances
Byte counters
newtype ByteCount64 Source
A 64 bit measurement in bytes. For example the size of an object, or an offset.
Constructors
| ByteCount64 | |
Fields | |
newtype ByteCount32 Source
A 32 bit measurement in bytes. For example the size of an object, or an offset.
Constructors
| ByteCount32 | |
Fields | |
newtype ByteCount16 Source
A 16 bit measurement in bytes. For example the size of an object, or an offset.
Constructors
| ByteCount16 | |
Fields | |
Timestamps
Measurement of time passed in nanoseconds since a given point.
File structure
data FileSection Source
Corresponds with the perf_file_section struct in <perf source>/util/header.h
Constructors
| FileSection | |
Fields
| |
Instances
data FileHeader Source
Corresponds with the perf_file_header struct in <perf source>/util/header.h
Constructors
| FileHeader | |
Fields
| |
Instances
Layout of event attribute and attribute ids.
Constructors
| FileAttr | |
Fields
| |
Event data
A Single event record.
Constructors
| Event | |
Fields
| |
data EventCPUMode Source
A bitfield in perf_event_header->misc.
Constructors
| PERF_RECORD_CPUMODE_UNKNOWN | 0 |
| PERF_RECORD_MISC_KERNEL | 1 |
| PERF_RECORD_MISC_USER | 2 |
| PERF_RECORD_MISC_HYPERVISOR | 3 |
Instances
Corresponds with the perf_event_attr struct in include/linux/perf_event.h
Constructors
| EventAttr | |
Fields
| |
data EventHeader Source
Corresponds with the perf_event_header struct in <perf source>/util/perf_event.h
Constructors
| EventHeader | |
Instances
data EventPayload Source
Constructors
Instances
Event type information
Encoding of the perf_event_header->type.
data SampleFormat Source
Information about what is stored in a sample event.
Constructors
| PERF_SAMPLE_IP | 1U << 0 |
| PERF_SAMPLE_TID | 1U << 1 |
| PERF_SAMPLE_TIME | 1U << 2 |
| PERF_SAMPLE_ADDR | 1U << 3 |
| PERF_SAMPLE_READ | 1U << 4 |
| PERF_SAMPLE_CALLCHAIN | 1U << 5 |
| PERF_SAMPLE_ID | 1U << 6 |
| PERF_SAMPLE_CPU | 1U << 7 |
| PERF_SAMPLE_PERIOD | 1U << 8 |
| PERF_SAMPLE_STREAM_ID | 1U << 9 |
| PERF_SAMPLE_RAW | 1U << 10 |
Instances
data TraceEventType Source
Identity and printable name of an event type.
Constructors
| TraceEventType | |
Fields
| |
Instances
data EventAttrFlag Source
See struct perf_event_attr in linux/perf_event.h
Constructors
| Disabled | off by default |
| Inherit | children inherit it |
| Pinned | must always be on PMU |
| Exclusive | only group on PMU |
| ExcludeUser | don't count user |
| ExcludeKernel | ditto kernel |
| ExcludeHV | ditto hypervisor |
| ExcludeIdle | don't count when idle |
| Mmap | include mmap data |
| Comm | include comm data |
| Freq | use freq, not period |
| InheritStat | per task counts |
| EnableOnExec | next exec enables |
| Task | trace fork/exit |
| WaterMark | wakeup_watermark |
| ArbitrarySkid | precise_ip, See also |
| ConstantSkid | precise_ip, See also |
| RequestedZeroSkid | precise_ip, See also |
| CompulsoryZeroSkid | precise_ip, See also |
| MmapData | non-exec mmap data |
| SampleIdAll | sample_type all events |
data EventSource Source
Corresponds with the enum perf_type_id in include/linux/perf_event.h
newtype SampleTypeBitMap Source
A bitmap encoding information about the content of sample events.
Constructors
| SampleTypeBitMap | |
Fields | |
testEventAttrFlag :: Word64 -> EventAttrFlag -> BoolSource
Test if a given EventAttrFlag is set.
An abstract representation of the perf data file
The various parts of the perf.data file collected together.
Constructors
| PerfData | |
Fields
| |