Profiling.Heap.OpenGL

This module provides some half-ready solutions to visualise heap profiles both during and after execution with the help of OpenGL. All the rendering functions will fill the viewport if the model view matrix is the identity (they also change the matrix), assuming the projection matrix is the following:

 matrixMode $= Projection
 loadIdentity
 translate $ Vector3 (-1) (-1) 0
 scale 2 2 1

In other words, these functions fill the unit square at the origin.

Documentation

colours :: [Color3 GLubyte]

A list of highly different colours, where the differences diminish as we advance in the list. The first element is black, and there is no white.

backgroundColour :: Color3 GLubyte

The colour of the background (white). It is not a member of colours.

otherColour :: Color3 GLubyte

The colour used for unimportant cost centres (black). It is the first element of colours.

Processing raw samples (full profiles)

data SamplePair

Two heap profile samples which contain the exact same cost centres in the exact same order.

Constructors

SP

Fields

spTime1 :: !Time

spTime2 :: !Time

spData1 :: !ProfileSample

spData2 :: !ProfileSample

Instances

Show SamplePair

prepareSamples :: ProfileQuery p => p -> [SamplePair]

Create a list of sample pairs where each cost centre is paired up with the consecutive one, so it is easier to render them. Cost centres with small costs (below costLimit) are lumped together under identifier 0, reserved for "Other".

renderSamples :: GraphMode -> [SamplePair] -> Time -> IO ()

Render a given list of prepared samples in the given mode. The third argument is the maximum time of the graph, which affects horizontal scaling.

addSample :: [SamplePair] -> (Time, ProfileSample) -> [SamplePair]

Integrating a new sample into the list of merged sample pairs we have so far. The input list should start with the latest sample, and the new sample pair will be the head of the result.

Processing optimised renders (profile streams)

data GraphData

An optimised graph rendering designed to be easily updated when a new sample arrives.

graphNames :: GraphData -> IntMap String

The names of cost centres in a graph rendering.

emptyGraph :: GraphData

An empty rendering.

growGraph :: GraphData -> SinkInput -> IO GraphData

Integrate a new sample in an extensible graph.

renderGraph :: GraphMode -> GraphData -> IO ()

Render a stream in the given graph mode.

data GraphMode

The possible ways of displaying heap profiles.

Constructors

Accumulated

Cost centres are stacked on top of each other without overlapping.

Separate

Each cost centre yields a separate line graph on the same scale.

Instances

Eq GraphMode

nextGraphMode :: GraphMode -> GraphMode

A cyclic successor function for graph modes.