MON_idle.h File Reference

Interface to the IDLE monitor functions. More...

#include <MON/MON_pubdefs.h>
#include <PBS/TASK.h>

Classes
struct	_MON_Idle_Sample
	IDLE monitor data sample. More...
struct	_MON_Idle_Control
	IDLE monitor control block. More...
Typedefs
typedef struct _MON_Idle_Sample	MON_Idle_Sample
	Typedef for _MON_Idle_Sample.
typedef struct _MON_Idle_Control	MON_Idle_Control
	Typedef for _MON_Idle_Control.
Functions
unsigned int	MON_idle_init (MON_Idle_Control *ctl_p, unsigned int dog_seconds, unsigned int dog_cpu_msecs)
	Initialize the IDLE monitor.
unsigned int	MON_idle_shutdown (MON_Idle_Control *ctl_p)
	Shutdown the IDLE monitor.
unsigned int	MON_idle_start (MON_Idle_Control *ctl_p, TASK_attr *attr_p)
	Start the IDLE monitor functions.
unsigned int	MON_idle_stop (MON_Idle_Control *ctl_p)
	Stop the IDLE monitor functions.
unsigned int	MON_idle_update_history (MON_Idle_Control *ctl_p)
	Update the IDLE time history.
unsigned int	MON_idle_get_stats (MON_Idle_Control *ctl_p, MON_Load_Stats *load_p)
	Get CPU loading statistics.
void	MON_idle_set_watchdog (MON_Idle_Control *ctl_p)
	Set the hardware watchdog timer.

---

Detailed Description

Interface to the IDLE monitor functions.

**  CVS $Id: MON_idle.h,v 1.6 2011/03/28 23:52:03 russell Exp $
**  

Defines the interface to the functions found in MON_idle.c.

---

Function Documentation

unsigned int MON_idle_get_stats	(	MON_Idle_Control *	ctl_p,
		MON_Load_Stats *	load_p
	)

Get CPU loading statistics.

Parameters:

	ctl_p	Pointer to IDLE state.
	load_p	Pointer to location to return stats.

Returns:

MSG code.

References _MON_Load_Stats::avg_prev_min, _MON_Load_Stats::avg_prev_sec, _MON_Idle_Control::history, _MON_Idle_Control::history_count, _MON_Load_Stats::max_prev_min, _MON_Load_Stats::min_prev_min, and mon_idle_get_load().

Referenced by MON_get_loading().

unsigned int MON_idle_init	(	MON_Idle_Control *	ctl_p,
		unsigned int	dog_seconds,
		unsigned int	dog_cpu_msecs
	)

Initialize the IDLE monitor.

Parameters:

	ctl_p	Pointer to IDLE state.
	dog_seconds	Hardware watchdog timer setting value.
	dog_cpu_msecs	IDLE loop run time between watchdog settings.

Returns:

MSG code.

References _MON_Idle_Control::dog_cpu_msecs, _MON_Idle_Control::dog_seconds, _MON_Idle_Control::dog_setting, and _MON_Idle_Control::tcb_p.

Referenced by MON_initialize().

void MON_idle_set_watchdog

(

MON_Idle_Control *

ctl_p

)

Set the hardware watchdog timer.

Parameters:

ctl_p

Pointer to IDLE state.

Returns:

Nothing.

References _MON_Idle_Control::dog_count, and _MON_Idle_Control::dog_setting.

Referenced by mon_idle_loop(), MON_idle_start(), and MON_set_watchdog().

unsigned int MON_idle_shutdown

(

MON_Idle_Control *

ctl_p

)

Shutdown the IDLE monitor.

Parameters:

ctl_p

Pointer to IDLE state.

Returns:

MSG code.

References _MON_Idle_Control::tcb_p.

Referenced by MON_shutdown().

unsigned int MON_idle_start	(	MON_Idle_Control *	ctl_p,
		TASK_attr *	attr_p
	)

Start the IDLE monitor functions.

Parameters:

	ctl_p	Pointer to IDLE state.
	attr_p	Pointer to IDLE task attributes.

Returns:

MSG code.

References _MON_Idle_Control::dog_count, _MON_Idle_Control::history_count, _MON_Idle_Control::loop_count, _MON_Idle_Control::loop_cycles, _MON_Idle_Control::loop_end, _MON_Idle_Control::loop_start, mon_idle_loop(), MON_idle_set_watchdog(), mon_idle_task(), _MON_Idle_Control::run, and _MON_Idle_Control::tcb_p.

Referenced by MON_start().

unsigned int MON_idle_stop

(

MON_Idle_Control *

ctl_p

)

Stop the IDLE monitor functions.

Parameters:

ctl_p

Pointer to IDLE state.

Returns:

MSG code.

References _MON_Idle_Control::run, and _MON_Idle_Control::tcb_p.

Referenced by MON_stop().

unsigned int MON_idle_update_history

(

MON_Idle_Control *

ctl_p

)

Update the IDLE time history.

Parameters:

ctl_p

Pointer to IDLE state.

Returns:

Nothing.

References _MON_Idle_Control::history, _MON_Idle_Control::history_count, _MON_Idle_Control::loop_count, _MON_Idle_Sample::loop_count, and _MON_Idle_Sample::time.

Referenced by mon_poll_task().