profile.h File Reference

Profiling. More...

#include <bits/profile.h>
#include <ipxe/tables.h>

Go to the source code of this file.

Data Structures
struct	profiler
	A data structure for storing profiling information. More...

Macros
#define	PROFILING   1
#define	PROFILERS   __table ( struct profiler, "profilers" )
	Profiler table. More...
#define	__profiler   __table_entry ( PROFILERS, 01 )
	Declare a profiler. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
unsigned long	profile_timestamp (void)
void	profile_update (struct profiler *profiler, unsigned long sample)
	Update profiler with a new sample. More...
unsigned long	profile_mean (struct profiler *profiler)
	Get mean sample value. More...
unsigned long	profile_variance (struct profiler *profiler)
	Get sample variance. More...
unsigned long	profile_stddev (struct profiler *profiler)
	Get sample standard deviation. More...
static unsigned long	profile_started (struct profiler *profiler)
	Get start time. More...
static unsigned long	profile_stopped (struct profiler *profiler)
	Get stop time. More...
static unsigned long	profile_elapsed (struct profiler *profiler)
	Get elapsed time. More...
static void	profile_start_at (struct profiler *profiler, unsigned long started)
	Start profiling. More...
static void	profile_stop_at (struct profiler *profiler, unsigned long stopped)
	Stop profiling. More...
static void	profile_start (struct profiler *profiler)
	Start profiling. More...
static void	profile_stop (struct profiler *profiler)
	Stop profiling. More...
static void	profile_exclude (struct profiler *profiler)
	Exclude time from other ongoing profiling results. More...
static void	profile_custom (struct profiler *profiler, unsigned long sample)
	Record profiling sample in custom units. More...

Variables
unsigned long	profile_excluded
	Accumulated time excluded from profiling. More...

Detailed Description

Profiling.

Definition in file profile.h.

Macro Definition Documentation

PROFILING

#define PROFILING   1

Definition at line 20 of file profile.h.

PROFILERS

#define PROFILERS   __table ( struct profiler, "profilers" )

Profiler table.

Definition at line 55 of file profile.h.

__profiler

static struct undinet_profiler undinet_misc_profiler __profiler   __table_entry ( PROFILERS, 01 )

Declare a profiler.

PXENV_UNDI_ISR profiler.

PXENV_UNDI_TRANSMIT profiler.

Virtual call profiler.

Real-mode call profiler.

Real-to-protected mode transition profiler.

Other interrupt profiler.

Miscellaneous PXE API call profiler.

PXE unknown API call profiler.

PXENV_UNDI_ISR API call profiler.

Transfer event profiler.

Event ring profiler.

Stream transfer profiler.

VM event profiler.

VM transmit profiler.

Bulk IN per-datagram profiler.

VM poll profiler.

VM receive refill profiler.

Bulk OUT profiler.

Bulk IN completion profiler.

Server profiler.

Data transfer profiler.

PeerDist block download discovery timeout profiler.

PeerDist block download discovery success profiler.

PeerDist block download attempt timeout profiler.

PeerDist block download attempt failure profiler.

PeerDist block download attempt success profiler.

Network transmit profiler.

Network receive profiler.

Receive profiler.

Post receive work queue entry profiler.

Data read profiler.

Data write profiler.

This profiler can be used to measure the overhead of a dummy PXE API call.

Note that this profiler will not see calls to PXENV_UNDI_ISR_IN_START, which are handled by the UNDI ISR and do not go via undinet_call().

Definition at line 59 of file profile.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

profile_timestamp()

unsigned long profile_timestamp

(

void

)

Referenced by efi_entropy_tick(), efi_stack_cookie(), profile_start(), and profile_stop().

profile_update()

void profile_update	(	struct profiler *	profiler,
		unsigned long	sample
	)

Update profiler with a new sample.

Parameters

profiler	Profiler
sample	Sample value

Definition at line 111 of file profile.c.

                                                                        {
        unsigned int sample_msb;
        unsigned int mean_shift;
        unsigned int delta_shift;
        signed long pre_delta;
        signed long post_delta;
        signed long long accvar_delta;
        unsigned int accvar_delta_shift;
        unsigned int accvar_delta_msb;
        unsigned int accvar_shift;

        /* Our scaling logic assumes that sample values never overflow
         * a signed long (i.e. that the high bit is always zero).
         */
        assert ( ( ( signed ) sample ) >= 0 );

        /* Update sample count, limiting to avoid signed overflow */
        if ( profiler->count < INT_MAX )
                profiler->count++;

        /* Adjust mean sample value scale if necessary.  Skip if
         * sample is zero (in which case flsl(sample)-1 would
         * underflow): in the case of a zero sample we have no need to
         * adjust the scale anyway.
         */
        if ( sample ) {
                sample_msb = ( flsl ( sample ) - 1 );
                if ( profiler->mean_msb < sample_msb ) {
                        profiler->mean >>= ( sample_msb - profiler->mean_msb );
                        profiler->mean_msb = sample_msb;
                }
        }

        /* Scale sample to internal units */
        mean_shift = profile_mean_shift ( profiler );
        sample <<= mean_shift;

        /* Update mean */
        pre_delta = ( sample - profiler->mean );
        profiler->mean += ( pre_delta / ( ( signed ) profiler->count ) );
        post_delta = ( sample - profiler->mean );
        delta_shift = mean_shift;
        DBGC ( profiler, "PROFILER %p sample %#lx mean %s", profiler,
               ( sample >> mean_shift ),
                profile_hex_fraction ( profiler->mean, mean_shift ) );
        DBGC ( profiler, " pre %s",
               profile_hex_fraction ( pre_delta, delta_shift ) );
        DBGC ( profiler, " post %s\n",
               profile_hex_fraction ( post_delta, delta_shift ) );

        /* Scale both deltas to fit in half of an unsigned long long
         * to avoid potential overflow on multiplication.  Note that
         * shifting a signed quantity is "implementation-defined"
         * behaviour in the C standard, but gcc documents that it will
         * always perform sign extension.
         */
        if ( sizeof ( pre_delta ) > ( sizeof ( accvar_delta ) / 2 ) ) {
                unsigned int shift = ( 8 * ( sizeof ( pre_delta ) -
                                             ( sizeof ( accvar_delta ) / 2 ) ));
                pre_delta >>= shift;
                post_delta >>= shift;
                delta_shift -= shift;
        }

        /* Update variance, if applicable.  Skip if either delta is
         * zero (in which case flsl(delta)-1 would underflow): in the
         * case of a zero delta there is no change to the accumulated
         * variance anyway.
         */
        if ( pre_delta && post_delta ) {

                /* Calculate variance delta */
                accvar_delta = ( ( ( signed long long ) pre_delta ) *
                                 ( ( signed long long ) post_delta ) );
                accvar_delta_shift = ( 2 * delta_shift );
                assert ( accvar_delta > 0 );

                /* Calculate variance delta MSB, using flsl() on each
                 * delta individually to provide an upper bound rather
                 * than requiring the existence of flsll().
                 */
                accvar_delta_msb = ( flsll ( accvar_delta ) - 1 );
                if ( accvar_delta_msb > accvar_delta_shift ) {
                        accvar_delta_msb -= accvar_delta_shift;
                } else {
                        accvar_delta_msb = 0;
                }

                /* Adjust scales as necessary */
                if ( profiler->accvar_msb < accvar_delta_msb ) {
                        /* Rescale accumulated variance */
                        profiler->accvar >>= ( accvar_delta_msb -
                                               profiler->accvar_msb );
                        profiler->accvar_msb = accvar_delta_msb;
                } else {
                        /* Rescale variance delta */
                        accvar_delta >>= ( profiler->accvar_msb -
                                           accvar_delta_msb );
                        accvar_delta_shift -= ( profiler->accvar_msb -
                                                accvar_delta_msb );
                }

                /* Scale delta to internal units */
                accvar_shift = profile_accvar_shift ( profiler );
                accvar_delta <<= ( accvar_shift - accvar_delta_shift );

                /* Accumulate variance */
                profiler->accvar += accvar_delta;

                /* Adjust scale if necessary */
                if ( profiler->accvar &
                     ( 1ULL << ( ( 8 * sizeof ( profiler->accvar ) ) - 1 ) ) ) {
                        profiler->accvar >>= 1;
                        profiler->accvar_msb++;
                        accvar_delta >>= 1;
                        accvar_shift--;
                }

                DBGC ( profiler, "PROFILER %p accvar %s", profiler,
                       profile_hex_fraction ( profiler->accvar, accvar_shift ));
                DBGC ( profiler, " delta %s\n",
                       profile_hex_fraction ( accvar_delta, accvar_shift ) );
        }
}

References profiler::accvar, profiler::accvar_msb, assert(), profiler::count, DBGC, flsl, flsll, INT_MAX, profiler::mean, profiler::mean_msb, profile_accvar_shift(), profile_hex_fraction(), and profile_mean_shift().

Referenced by profile_custom(), profile_okx(), and profile_stop_at().

profile_mean()

unsigned long profile_mean

(

struct profiler *

profiler

)

Get mean sample value.

Parameters

profiler

Profiler

Return values

mean	Mean sample value

Definition at line 242 of file profile.c.

                                                         {
        unsigned int mean_shift = profile_mean_shift ( profiler );

        /* Round to nearest and scale down to original units */
        return ( ( profiler->mean + ( 1UL << ( mean_shift - 1 ) ) )
                 >> mean_shift );
}

References profiler::mean, and profile_mean_shift().

Referenced by cipher_cost(), digest_cost(), memcpy_test_speed(), profile_okx(), profstat(), and tcpip_random_okx().

profile_variance()

unsigned long profile_variance

(

struct profiler *

profiler

)

Get sample variance.

Parameters

profiler

Profiler

Return values

variance

Sample variance

Definition at line 256 of file profile.c.

                                                             {
        unsigned int accvar_shift = profile_accvar_shift ( profiler );

        /* Variance is zero if fewer than two samples exist (avoiding
         * division by zero error).
         */
        if ( profiler->count < 2 )
                return 0;

        /* Calculate variance, round to nearest, and scale to original units */
        return ( ( ( profiler->accvar / ( profiler->count - 1 ) )
                   + ( 1ULL << ( accvar_shift - 1 ) ) ) >> accvar_shift );
}

References profiler::accvar, profiler::count, and profile_accvar_shift().

Referenced by profile_stddev().

profile_stddev()

unsigned long profile_stddev

(

struct profiler *

profiler

)

Get sample standard deviation.

Parameters

profiler

Profiler

Return values

stddev

Sample standard deviation

Definition at line 276 of file profile.c.

                                                           {

        return isqrt ( profile_variance ( profiler ) );
}

References isqrt(), and profile_variance().

Referenced by memcpy_test_speed(), profile_okx(), profstat(), and tcpip_random_okx().

profile_started()

static unsigned long profile_started ( struct profiler *  profiler )

inlinestatic

Get start time.

Parameters

profiler

Profiler

Return values

started

Start time

Definition at line 80 of file profile.h.

                                              {

        /* If profiling is active then return start time */
        if ( PROFILING ) {
                return ( profiler->started + profile_excluded );
        } else {
                return 0;
        }
}

References profile_excluded, PROFILING, and profiler::started.

Referenced by profile_elapsed(), and undinet_call().

profile_stopped()

static unsigned long profile_stopped ( struct profiler *  profiler )

inlinestatic

Get stop time.

Parameters

profiler

Profiler

Return values

stopped

Stop time

Definition at line 97 of file profile.h.

                                              {

        /* If profiling is active then return start time */
        if ( PROFILING ) {
                return ( profiler->stopped + profile_excluded );
        } else {
                return 0;
        }
}

References profile_excluded, PROFILING, and profiler::stopped.

Referenced by profile_elapsed(), and undinet_call().

profile_elapsed()

static unsigned long profile_elapsed ( struct profiler *  profiler )

inlinestatic

Get elapsed time.

Parameters

profiler

Profiler

Return values

elapsed

Elapsed time

Definition at line 114 of file profile.h.

                                              {

        /* If profiling is active then return elapsed time */
        if ( PROFILING ) {
                return ( profile_stopped ( profiler ) -
                         profile_started ( profiler ) );
        } else {
                return 0;
        }
}

References profile_started(), profile_stopped(), and PROFILING.

Referenced by profile_exclude(), and profile_stop_at().

profile_start_at()

static void profile_start_at ( struct profiler *  profiler, unsigned long  started  )

inlinestatic

Start profiling.

Parameters

profiler	Profiler
started	Start timestamp

Definition at line 132 of file profile.h.

                                                                      {

        /* If profiling is active then record start timestamp */
        if ( PROFILING )
                profiler->started = ( started - profile_excluded );
}

References profile_excluded, PROFILING, profiler::started, and started.

Referenced by librm_test_exec(), profile_start(), and undinet_call().

profile_stop_at()

static void profile_stop_at ( struct profiler *  profiler, unsigned long  stopped  )

inlinestatic

Stop profiling.

Parameters

profiler	Profiler
stopped	Stop timestamp

Definition at line 146 of file profile.h.

                                                                     {

        /* If profiling is active then record end timestamp and update stats */
        if ( PROFILING ) {
                profiler->stopped = ( stopped - profile_excluded );
                profile_update ( profiler, profile_elapsed ( profiler ) );
        }
}

References profile_elapsed(), profile_excluded, profile_update(), PROFILING, and profiler::stopped.

Referenced by librm_test_exec(), profile_stop(), and undinet_call().

profile_start()

static void profile_start ( struct profiler *  profiler )

inlinestatic

Start profiling.

Parameters

profiler

Profiler

Definition at line 161 of file profile.h.

                                            {

        /* If profiling is active then record start timestamp */
        if ( PROFILING )
                profile_start_at ( profiler, profile_timestamp() );
}

References profile_start_at(), profile_timestamp(), and PROFILING.

Referenced by acm_in_complete(), acm_intr_complete(), acm_out_transmit(), axge_in_complete(), axge_intr_complete(), axge_out_transmit(), cipher_cost(), digest_cost(), ecm_in_complete(), ecm_intr_complete(), ecm_out_transmit(), http_conn_deliver(), http_content_deliver(), ib_post_recv(), ib_post_send(), intel_poll(), intel_refill_rx(), intel_transmit(), interrupt(), iphone_in_complete(), iphone_out_transmit(), ipv4_rx(), ipv4_tx(), librm_test_exec(), memcpy_test_speed(), ncm_in_complete(), ncm_intr_complete(), ncm_out_transmit(), net_poll(), netdev_tx(), pxe_api_call(), pxenv_undi_transmit(), smsc75xx_in_complete(), smsc75xx_out_transmit(), smsc95xx_in_complete(), smsc95xx_out_transmit(), smscusb_intr_complete(), tcp_rx(), tcp_rx_data(), tcp_xmit_sack(), tcpip_random_okx(), tftp_rx(), tftp_rx_data(), undinet_call(), undinet_poll(), vmxnet3_command(), vmxnet3_poll_events(), vmxnet3_refill_rx(), vmxnet3_transmit(), xferbuf_deliver(), xferbuf_read(), xferbuf_write(), xhci_endpoint_message(), xhci_endpoint_stream(), xhci_event_poll(), and xhci_transfer().

profile_stop()

static void profile_stop ( struct profiler *  profiler )

inlinestatic

Stop profiling.

Parameters

profiler

Profiler

Definition at line 174 of file profile.h.

                                           {

        /* If profiling is active then record end timestamp and update stats */
        if ( PROFILING )
                profile_stop_at ( profiler, profile_timestamp() );
}

References profile_stop_at(), profile_timestamp(), and PROFILING.

Referenced by acm_in_complete(), acm_intr_complete(), acm_out_transmit(), axge_in_complete(), axge_intr_complete(), axge_out_transmit(), cipher_cost(), digest_cost(), ecm_in_complete(), ecm_intr_complete(), ecm_out_transmit(), http_conn_deliver(), http_content_deliver(), ib_post_recv(), ib_post_send(), intel_poll(), intel_refill_rx(), intel_transmit(), interrupt(), iphone_in_complete(), iphone_out_transmit(), ipv4_rx(), ipv4_tx(), librm_test_exec(), memcpy_test_speed(), ncm_in_complete(), ncm_intr_complete(), ncm_out_transmit(), net_poll(), netdev_tx(), pxe_api_call(), pxenv_undi_transmit(), smsc75xx_in_complete(), smsc75xx_out_transmit(), smsc95xx_in_complete(), smsc95xx_out_transmit(), smscusb_intr_complete(), tcp_rx(), tcp_rx_data(), tcp_xmit_sack(), tcpip_random_okx(), tftp_rx_data(), undinet_call(), undinet_poll(), vmxnet3_command(), vmxnet3_poll_events(), vmxnet3_refill_rx(), vmxnet3_transmit(), xferbuf_deliver(), xferbuf_read(), xferbuf_write(), xhci_endpoint_message(), xhci_endpoint_stream(), xhci_event_poll(), and xhci_transfer().

profile_exclude()

static void profile_exclude ( struct profiler *  profiler )

inlinestatic

Exclude time from other ongoing profiling results.

Parameters

profiler

Profiler

Definition at line 187 of file profile.h.

                                              {

        /* If profiling is active then update accumulated excluded time */
        if ( PROFILING )
                profile_excluded += profile_elapsed ( profiler );
}

References profile_elapsed(), profile_excluded, and PROFILING.

Referenced by intel_poll(), intel_refill_rx(), intel_transmit(), interrupt(), vmxnet3_command(), vmxnet3_poll_events(), vmxnet3_refill_rx(), and vmxnet3_transmit().

profile_custom()

static void profile_custom ( struct profiler *  profiler, unsigned long  sample  )

inlinestatic

Record profiling sample in custom units.

Parameters

profiler	Profiler
sample	Profiling sample

Definition at line 201 of file profile.h.

                                                                   {

        /* If profiling is active then update stats */
        if ( PROFILING )
                profile_update ( profiler, sample );
}

References profile_update(), and PROFILING.

Referenced by peerblk_close(), peerblk_discovered(), peerblk_done(), and peerblk_expired().

Variable Documentation

profile_excluded

unsigned long profile_excluded

Accumulated time excluded from profiling.

Definition at line 50 of file profile.c.

Referenced by profile_exclude(), profile_start_at(), profile_started(), profile_stop_at(), and profile_stopped().