retry.h File Reference

Retry timers. More...

#include <ipxe/list.h>

Go to the source code of this file.

Data Structures
struct	retry_timer
	A retry timer. More...

Macros
#define	DEFAULT_MIN_TIMEOUT   ( TICKS_PER_SEC / 4 )
	Default minimum timeout value (in ticks)
#define	DEFAULT_MAX_TIMEOUT   ( 10 * TICKS_PER_SEC )
	Default maximum timeout value (in ticks)
#define	TIMER_INIT(expired_fn)
	Initialise a static timer.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static	__attribute__ ((always_inline)) void timer_init(struct retry_timer *timer
	Initialise a timer.
void	start_timer (struct retry_timer *timer)
	Start timer.
void	start_timer_fixed (struct retry_timer *timer, unsigned long timeout)
	Start timer with a specified timeout.
void	stop_timer (struct retry_timer *timer)
	Stop timer.
void	retry_poll (void)
	Poll the retry timer list.
static void	start_timer_nodelay (struct retry_timer *timer)
	Start timer with no delay.

Variables
static void(*	expired )(struct retry_timer *timer, int over)
static void struct refcnt *	refcnt
static unsigned long	min
static unsigned long unsigned long	max

Detailed Description

Retry timers.

Definition in file retry.h.

Macro Definition Documentation

DEFAULT_MIN_TIMEOUT

#define DEFAULT_MIN_TIMEOUT   ( TICKS_PER_SEC / 4 )

Default minimum timeout value (in ticks)

Definition at line 16 of file retry.h.

Referenced by start_timer().

DEFAULT_MAX_TIMEOUT

#define DEFAULT_MAX_TIMEOUT   ( 10 * TICKS_PER_SEC )

Default maximum timeout value (in ticks)

Definition at line 19 of file retry.h.

Referenced by timer_expired().

TIMER_INIT

#define TIMER_INIT

(

expired_fn

)

Value:

                {                       \
                .expired = (expired_fn),                \
        }

Initialise a static timer.

Parameters

expired_fn

Timer expired callback

Definition at line 83 of file retry.h.

#define TIMER_INIT( expired_fn ) {                      \
                .expired = (expired_fn),                \
        }

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

__attribute__()

__attribute__ ( (always_inline) )

inlinestatic

Initialise a timer.

Set minimum and maximum timeouts.

Test to see if timer is currently running.

Parameters

timer	Retry timer
expired	Timer expired callback
refcnt	Reference counter, or NULL
timer	Retry timer

Return values

running

Non-zero if timer is running

Parameters

timer	Retry timer
min	Minimum timeout (in ticks), or zero to use default
max	Maximum timeout (in ticks), or zero to use default

Definition at line 110 of file retry.h.

                                            {
        return ( timer->running );
}

start_timer()

void start_timer ( struct retry_timer * timer )

extern

Start timer.

Parameters

timer

Retry timer

This starts the timer running with the current timeout value (rounded up to the minimum timeout value). If stop_timer() is not called before the timer expires, the timer will be stopped and the timer's callback function will be called.

Definition at line 94 of file retry.c.

                                               {
        unsigned long timeout = timer->timeout;
        unsigned long min;
 
        /* Calculate minimum timeout */
        min = ( timer->min ? timer->min : DEFAULT_MIN_TIMEOUT );
        if ( min < MIN_TIMEOUT )
                min = MIN_TIMEOUT;
 
        /* Ensure timeout is at least the minimum */
        if ( timeout < min )
                timeout = min;
 
        /* Start timer with this timeout */
        start_timer_fixed ( timer, timeout );
}

References DEFAULT_MIN_TIMEOUT, min, MIN_TIMEOUT, start_timer_fixed(), and timeout().

Referenced by aoecmd_tx(), dhcp_tx(), dhcpv6_timer_expired(), dns_send_packet(), ib_mi_timer_expired(), ipv6conf_expired(), neighbour_expired(), ntp_expired(), slam_master_timer_expired(), slam_slave_timer_expired(), slam_socket_deliver(), tcp_xmit_sack(), tftp_send_packet(), xcm_close(), and xcm_reopen().

start_timer_fixed()

void start_timer_fixed ( struct retry_timer * timer, unsigned long timeout )

extern

Start timer with a specified timeout.

Parameters

timer	Retry timer
timeout	Timeout, in ticks

This starts the timer running with the specified timeout value. If stop_timer() is not called before the timer expires, the timer will be stopped and the timer's callback function will be called.

Definition at line 65 of file retry.c.

                                                                            {
 
        /* Add to list of running timers (if applicable) */
        if ( ! timer->running ) {
                list_add ( &timer->list, &timers );
                ref_get ( timer->refcnt );
                timer->running = 1;
        }
 
        /* Record start time */
        timer->start = currticks();
 
        /* Record timeout */
        timer->timeout = timeout;
 
        DBGC2 ( timer, "Timer %p started at time %ld (expires at %ld)\n",
                timer, timer->start, ( timer->start + timer->timeout ) );
}

References currticks(), DBGC2, list_add, ref_get, and timeout().

Referenced by bnxt_er_task(), bnxt_er_task_timer(), bnxt_process_er_event(), cgem_expired(), cgem_open(), dhcp_defer(), eapol_eap_rx(), eapol_expired(), efi_watchdog_expired(), exanic_expired(), exanic_open(), fc_link_err(), fc_link_expired(), fc_xchg_rx(), fc_xchg_tx(), fcoe_expired(), fragment_reassemble(), gve_open(), gve_watchdog(), http_transfer_complete(), http_watchdog(), ipair_rx_pair_error(), iphone_expired(), ipv6conf_expired(), neighbour_tx_queue(), netdev_link_block(), peerblk_open(), peerblk_raw_open(), peerblk_raw_rx(), peerblk_retrieval_open(), peerblk_retrieval_rx(), peerdisc_expired(), pinger_expired(), pool_add(), sandev_command(), slam_mc_socket_deliver(), slam_open(), slirp_timer_mod(), start_timer(), start_timer_nodelay(), tcp_keepalive_expired(), tcp_rx(), tcp_rx_ack(), xcm_keepalive(), xcm_reopen(), xsigo_discover(), xsigo_ib_open(), and xsigo_xcm_complete().

stop_timer()

void stop_timer ( struct retry_timer * timer )

extern

Stop timer.

Parameters

timer

Retry timer

This stops the timer and updates the timer's timeout value.

Definition at line 118 of file retry.c.

                                              {
        unsigned long old_timeout = timer->timeout;
        unsigned long now = currticks();
        unsigned long runtime;
 
        /* If timer was already stopped, do nothing */
        if ( ! timer->running )
                return;
 
        list_del ( &timer->list );
        runtime = ( now - timer->start );
        timer->running = 0;
        DBGC2 ( timer, "Timer %p stopped at time %ld (ran for %ld)\n",
                timer, now, runtime );
 
        /* Update timer.  Variables are:
         *
         *   r = round-trip time estimate (i.e. runtime)
         *   t = timeout value (i.e. timer->timeout)
         *   s = smoothed round-trip time
         *
         * By choice, we set t = 4s, i.e. allow for four times the
         * normal round-trip time to pass before retransmitting.
         *
         * We want to smooth according to s := ( 7 s + r ) / 8
         *
         * Since we don't actually store s, this reduces to
         * t := ( 7 t / 8 ) + ( r / 2 )
         *
         */
        if ( timer->count ) {
                timer->count--;
        } else {
                timer->timeout -= ( timer->timeout >> 3 );
                timer->timeout += ( runtime >> 1 );
                if ( timer->timeout != old_timeout ) {
                        DBGC ( timer, "Timer %p timeout updated to %ld\n",
                               timer, timer->timeout );
                }
        }
 
        ref_put ( timer->refcnt );
}

References currticks(), DBGC, DBGC2, list_del, and ref_put.

Referenced by aoecmd_close(), bnxt_close(), bnxt_er_task(), bnxt_er_wait_timer(), bnxt_process_er_event(), cgem_close(), dhcp_finished(), dhcp_set_state(), dhcpv6_finished(), dns_done(), eapol_eap_rx(), eapol_notify(), efi_watchdog_stop(), exanic_close(), fc_link_stop(), fc_link_up(), fc_xchg_close(), fcoe_close(), fcoe_expired(), fcoe_reset(), fragment_reassemble(), gve_close(), http_close(), http_transfer_complete(), ib_destroy_madx(), ipair_close(), iphone_close(), ipv6conf_done(), ipv6conf_rx_router_advertisement(), neighbour_destroy(), neighbour_tx_queue(), netdev_close(), netdev_link_err(), netdev_link_unblock(), ntp_close(), peerblk_reset(), peerblk_retrieval_close(), peerdisc_destroy(), pinger_close(), pool_del(), sandev_command_close(), slam_finished(), slam_mc_socket_deliver(), slam_socket_deliver(), slirp_timer_free(), tcp_close(), tcp_rx(), tcp_rx_ack(), tftp_done(), tftp_send_packet(), xcm_close(), xcm_destroy(), xcm_reopen(), xsigo_ib_notify(), and xsigo_ib_remove().

retry_poll()

void retry_poll ( void )

extern

Poll the retry timer list.

Definition at line 198 of file retry.c.

                         {
        struct retry_timer *timer;
        unsigned long now = currticks();
        unsigned long used;
 
        /* Process at most one timer expiry.  We cannot process
         * multiple expiries in one pass, because one timer expiring
         * may end up triggering another timer's deletion from the
         * list.
         */
        list_for_each_entry ( timer, &timers, list ) {
                used = ( now - timer->start );
                if ( used >= timer->timeout ) {
                        timer_expired ( timer );
                        break;
                }
        }
}

References currticks(), retry_timer::list, list_for_each_entry, and timer_expired().

Referenced by eoib_poll(), ipoib_poll(), and retry_step().

start_timer_nodelay()

void start_timer_nodelay ( struct retry_timer * timer )

inlinestatic

Start timer with no delay.

Parameters

timer

Retry timer

This starts the timer running with a zero timeout value.

Definition at line 100 of file retry.h.

                                                                     {
        start_timer_fixed ( timer, 0 );
}

References start_timer_fixed().

Referenced by dhcp_set_state(), dhcpv6_set_state(), dns_resolv(), eapol_notify(), efi_watchdog_start(), fc_link_start(), fcoe_expired(), fcoe_reset(), ib_create_madx(), imux_close(), ipair_create(), ipair_rx_pair(), ipair_rx_pubkey(), ipair_rx_session_error(), iphone_open(), neighbour_discover(), neighbour_tx_queue(), ntp_window_changed(), peerblk_discovered(), peerblk_done(), peerdisc_create(), pinger_window_changed(), start_ipv6conf(), tcp_open(), tftp_core_open(), tftp_send_packet(), tftp_timer_expired(), xcm_create(), xcm_list(), xsigo_ib_notify(), xsigo_ib_open(), and xsigo_ib_probe().

Variable Documentation

expired

void(* expired) (struct retry_timer *timer, int over)	(	struct retry_timer *	timer,
		int	over )

Definition at line 72 of file retry.h.

refcnt

timer refcnt

Initial value:

{
        timer->expired = expired

Definition at line 73 of file retry.h.

min

unsigned long min

Definition at line 123 of file retry.h.

max

timer max

Initial value:

{
        timer->min = min

Definition at line 124 of file retry.h.