PBS.h File Reference

PBS library, contains the interface to initialization routines for PBS. More...

#include <PBS/MBA.h>
#include <PBS/impl/PBS.h.px-xxx-xxx>

Classes
struct	_PBS_crashCtx
	Defines the application context parameters of a crash. More...
Defines
#define	PBS_CRASH_HANDLER_DEFAULT   (PBS_crashHandler)(-1)
	Specifies to PBS_crashHandlerSet that the default crash handler is requested.
#define	PBS_V_CRASH_OPTION_VX_REBOOT   28
	Starting bit of the VxWorks reboot field in the options. This is a 3 bit wide field passed directly to 'reboot'.
Typedefs
typedef struct _PBS_crashCtx	PBS_crashCtx
	Typedef for struct _PBS_crashCtx.
typedef int(*	PBS_crashHandler )(PBS_crashType type, const PBS_crashCtx *ctx, unsigned int options, const char *string)
	User callback routine to handle a crash.
typedef enum _PBS_crashOptions	PBS_crashOptions
	Typedef for.
Enumerations
enum	_PBS_crashOptions {   PBS_M_CRASH_OPTION_CRASH_NO = (1<<31),   PBS_M_CRASH_OPTION_VX_REBOOT_QUICK = (1<< 30),   PBS_M_CRASH_OPTION_VX_REBOOT_CLEAR = (1<< 29),   PBS_M_CRASH_OPTION_VX_REBOOT_NOAUTO = (1<< 28) }
	Enumerates those bits of the options argument that PBS uses. More...
Functions
void	PBS_fast_clear (void *ptr, unsigned int nbytes)
int	PBS_configure (void)
int	PBS_initialize (int wut_tmr_cnt, int keepalive_period)
int	PBS_initialize2 (int wut_tmr_cnt, int keepalive_period, MBA_create_cb mba_create, void *mba_prm)
int	PBS_shutdown (void)
void	PBS_crash (PBS_crashType type, const PBS_crashCtx *ctx, unsigned int options, const char *string)
void	PBS_panic (unsigned int reason, unsigned int parameter, void *pc, unsigned int options, const char *string)
void	PBS_reboot (unsigned int reason, unsigned int parameter, void *pc, unsigned int options, const char *string)
PBS_crashHandler	PBS_crashHandlerSet (PBS_crashHandler crashHandler)
int	PBS_crashPrint (PBS_crashType type, const PBS_crashCtx *ctx, unsigned int options, const char *string)

---

Detailed Description

PBS library, contains the interface to initialization routines for PBS.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: PBS.h,v 1.9 2011/03/24 23:05:42 apw Exp $

---

Typedef Documentation

PBS_crashCtx

Typedef for struct _PBS_crashCtx.

This data structure contains the application specific context parameters of the crash. The intent is to provide enough information that the reason of the crash can be diagnosed.

This block is limited to 8 32-bit values and, if the OS supports it, is committed to the area of memory saved across boots.

unsigned int(* PBS_crashHandler)(PBS_crashType type, const PBS_crashCtx ctx, unsigned int options, const char *string)

User callback routine to handle a crash.

Returns:

The new options value

Parameters:

type

The crash type, i.e. one of

See also:

PBS_crashType 's.

Parameters:

	ctx	The crash context block
	options	The crash options (OS dependent)
	string	An arbitrary user string

This routine is meant to provide a formatted dump of the crash. It is user provided by calling

See also:

PBS_crashHandlerSet (). A default version

PBS_crashPrint () has been provided.

PBS_crashOptions

Typedef for.

See also:

enum _PBS_crashOptions

The options word present in many of the PBS crash routines, e.g.

See also:

PBS_crash,

PBS_panic and

PBS_reboot, is a series of bit flags shared between the PBS layer and the underlying OS reboot layer.

The tenative agreement is that PBS gets the upper 16 and the OS reboot layer gets the lower 16. PBS will begin allocating these bits from the top down.

Some of the PBS options are generic, i.e. they have the same meaning on all platforms, while others only have meaning on certain platforms.

In the former category is

See also:

PBS_M_CRASH_OPTION_REBOOT_NO. This option inhibits the calling of the underlying OS reboot function, essentially reducing the call to PBS_crash, PBS_panic and PBS_reboot to only filling out the context block and calling back the user defined handler. This feature may prove useful in testing.

In the latter category is

See also:

PBS_M_CRASH_OPTION_REBOOT_NOAUTO. This option is relevant only to those platforms calling the VXWORKs reboot function. These platforms are mv2304 and the mcp750. This option effectively translates in the the BOOT_NORMAL (option cleared) and BOOT_NOAUTOBOOT.

---

Enumeration Type Documentation

enum _PBS_crashOptions

Enumerates those bits of the options argument that PBS uses.

Enumerator:

PBS_M_CRASH_OPTION_CRASH_NO	Only call the user level handler,do no call the underlying OS crash/reboot function.
PBS_M_CRASH_OPTION_VX_REBOOT_QUICK	Meaningful only MV23xx and MCP750 platforms, this translates into BOOT_QUICK_AUTOBOOT (4)
PBS_M_CRASH_OPTION_VX_REBOOT_CLEAR	Meaningful only MV23xx and MCP750 platforms, this translates into BOOT_CLEAR (2), clearing memory on the reboot
PBS_M_CRASH_OPTION_VX_REBOOT_NOAUTO	Meaningful only MV23xx and MCP750 platforms, this translates into BOOT_NO_AUTOBOOT (1)