OpenClovis Product Documentation - User contributions [en]

Doc:latest/evalguide/cmPlugin

2013-10-15T15:02:26Z

Natesh: /* Example Code: */

== CM Plug-in Guide==

===Objective===

CM-Plugin is an event controlling policy in Platform-Support-Package(PSP) to allow, restrict, or modify the events received from HPI and forwarded to the Application during run-time. The policy is defined by the Application programmer and is loaded into the Chassis Manager and called whenever a hardware event is received.

The purpose of this plugin is to allow the application programmer to intercept events that may be miscategorized by the hardware and transform them. For example, if a voltage loss event is reported as MAJOR in a dual power supply system, this even should not cause system shutdown so can be reduced to a MINOR level event.

===What you can learn===

How to define a policy to control the events in the CM, so that only interested events are forwarded to the Application and unintended events are discarded.

===Building the CM-Plugin model and controlling Events in run-time===

The example code containing Application and CM-Policy is available in
'''[https://github.com/OpenClovis/SAFplus-Platform-Support-Package/tree/master/src/example/cmplugin PSP/src/example]'''

====Usage of CM-Plugin====

The policy to control the events is defined in cmPolicy.c and is available in the location: .../CmPlugin/src/app/common/plugins/cmPolicy.c in specified example.

* HpiEventFilter() will be contain the details of specific event to be handled and specific modification for that event.
* We shall show the usage of the filter for a SENSOR Event.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| cmPolicy.c
|-
|<code><pre>

ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
/* Define the policy to Allow, Block or Change the events here */
if ((event->EventType == SAHPI_ET_SENSOR) && (event->EventDataUnion.SensorEvent.SensorNum == 4))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
else if ((event->EventType == SAHPI_ET_SENSOR) && (event->Source == 0x10))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}

In the above example, the Sensor Events from Sensor #4 is changed to lower severity, so that the event is given lower importance or can be ignored and other events which are of importance can be received and processed by Application.

===How to Run cmPlugin model===

Copy the image to new directory (/root/SAFplus/).

<ol>

<li>Start the SAFplus Platform on deployed node <code><pre>
# cd /root/SAFplus/
# ./etc/init.d/safplus start</pre></code>

<li>Generate event using HPI Event Simulator OR through actual hardware <code><pre>
# cd /root/SAFplus/bin
# ./hpithres</pre></code>
</ol>
The logs are available in var/log/sys.latest and application_name.latest.

===Advanced Usage:===
The Shelf Manager in AdvancedTCA/MicroTCA is notified about health and management status changes in the shelf via standard IPMI event messages that are forwarded to the active Shelf Manager. IPM Controllers are configured to generate event messages when they detect a significant condition getting asserted or deasserted in the system. This includes messages for events such as ‘temperature threshold exceeded’, ‘voltage threshold exceeded’, ‘power fault’, ‘watchdog expired’, etc. IPMI event messages are typically associated with a Sensor. The type and event type of the Sensor associated with an event helps the Shelf Manager and HPI User decide on actions to be taken on account of that event.

HPI layer can handle events for various kinds which can be originated for Resource Details, Domain events, Sensor, Hot-Swap, Watchdog, Software-Events, OEM, User events, Dimi, Fumi events. While developing any event specific change either in Middleware or in Application, the specific event is allowed from PSP and is received by Application and rest of events are suppressed.

The event received is containing fields which indicate

Source : ResourceId of FRU

EventType : Sensor Type

TimeStamp : Time when the HPI Server receives the event.

Severity : SAHPI_MINOR, SAHPI_MAJOR, SAHPI_CRITICAL

===Details in Event Union===

{| cellspacing="0" border="1" align="center"
|+align="bottom"| '''SA Forum APIs with the SAFplus Platform equivalent'''
|- style="color:black;background-color:#ffffaa;" align="center"
!SensorEventT
!Event Request Message
|-
|SensorNum
|Sensor #
|-
|SensorType
|Type of Sensor (Ex: Voltage, Temp.)
|-
|EventState
|SAHPI_ES_LOWER_MINOR
|-
|
|SAHPI_ES_LOWER_MAJOR
|-
|
|SAHPI_ES_LOWER_CRITICAL
|-
|
|-
|
|SAHPI_ES_UPPER_MINOR
|-
|
|SAHPI_ES_UPPER_MAJOR
|-
|
|SAHPI_ES_UPPER_CRITICAL
|-
|SensorSpecific
|Event Specific Data.
|}

===Code Build and Execution details:===

The file cmPolicy.c contain the details of policies to inhibit/change the event details is available in location .../CmPlugin/src/app/common/plugins/cmPolicy.c in function HpiEventFilter(). For including this file, the make file in location .../src/app/common/plugins/Makefile needs to be changed so that the libraries are included as defined by Application while creating the image and executed by PSP during the handling of events.
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Makefile in location .../src/app/common/plugins/
|-
|<code><pre>
/* change PLUGIN_NAME to LIB_NAMES and assign cmPolicy */
LIB_NAMES := cmPolicy
...

/* add cpp flags */
# List any third party libs needed to get this server built (or None):
CPPFLAGS += -I$(ASP_CONFIG)
-I$(CLOVIS_ROOT)/../../PSP/src/cm/include
-I$(CLOVIS_ROOT)/../../buildtools/local/include/openhpi
</pre></code>
|}
===Example Code:===

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Sensor Event: Temperature
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_SENSOR) && \
(event.EventDataUnion.SensorEvent.Assertion == SAHPI_TRUE))
{
return CL_ERR_OP_NOT_PERMITTED; /* Event is skipped and is not forwarded to application */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}
The Sensor Event is received for a temperature raise is for one of the blades in chassis, which was a false-alarm. To suppress this, the severity of that event is reduced to minor, so as to prevent from slot reboot/ shutdown. The same can be extended for false alarms in voltage.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| HOT SWAP Event:
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_HOTSWAP) && \
(event.EventDataUnion.HotSwapEvent.HotSwapState != event.EventDataUnion.HotSwapEvent.PreviousHotSwapState))
{
event->Severity = SAHPI_MAJOR; /* Changing event severity to major */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}
When a FRU event is generated which is a false-alarm, these kind of events are blocked by checking whether there is an actual change in states by comparing its current state with previous state. If there is a real change in FRU, then only forward this to application else block the event.

Doc:latest/evalguide/cmPlugin

2013-10-15T15:01:14Z

Natesh: /* How to Run cmPlugin model */

== CM Plug-in Guide==

===Objective===

CM-Plugin is an event controlling policy in Platform-Support-Package(PSP) to allow, restrict, or modify the events received from HPI and forwarded to the Application during run-time. The policy is defined by the Application programmer and is loaded into the Chassis Manager and called whenever a hardware event is received.

The purpose of this plugin is to allow the application programmer to intercept events that may be miscategorized by the hardware and transform them. For example, if a voltage loss event is reported as MAJOR in a dual power supply system, this even should not cause system shutdown so can be reduced to a MINOR level event.

===What you can learn===

How to define a policy to control the events in the CM, so that only interested events are forwarded to the Application and unintended events are discarded.

===Building the CM-Plugin model and controlling Events in run-time===

The example code containing Application and CM-Policy is available in
'''[https://github.com/OpenClovis/SAFplus-Platform-Support-Package/tree/master/src/example/cmplugin PSP/src/example]'''

====Usage of CM-Plugin====

The policy to control the events is defined in cmPolicy.c and is available in the location: .../CmPlugin/src/app/common/plugins/cmPolicy.c in specified example.

* HpiEventFilter() will be contain the details of specific event to be handled and specific modification for that event.
* We shall show the usage of the filter for a SENSOR Event.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| cmPolicy.c
|-
|<code><pre>

ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
/* Define the policy to Allow, Block or Change the events here */
if ((event->EventType == SAHPI_ET_SENSOR) && (event->EventDataUnion.SensorEvent.SensorNum == 4))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
else if ((event->EventType == SAHPI_ET_SENSOR) && (event->Source == 0x10))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}

In the above example, the Sensor Events from Sensor #4 is changed to lower severity, so that the event is given lower importance or can be ignored and other events which are of importance can be received and processed by Application.

===How to Run cmPlugin model===

Copy the image to new directory (/root/SAFplus/).

<ol>

<li>Start the SAFplus Platform on deployed node <code><pre>
# cd /root/SAFplus/
# ./etc/init.d/safplus start</pre></code>

<li>Generate event using HPI Event Simulator OR through actual hardware <code><pre>
# cd /root/SAFplus/bin
# ./hpithres</pre></code>
</ol>
The logs are available in var/log/sys.latest and application_name.latest.

===Advanced Usage:===
The Shelf Manager in AdvancedTCA/MicroTCA is notified about health and management status changes in the shelf via standard IPMI event messages that are forwarded to the active Shelf Manager. IPM Controllers are configured to generate event messages when they detect a significant condition getting asserted or deasserted in the system. This includes messages for events such as ‘temperature threshold exceeded’, ‘voltage threshold exceeded’, ‘power fault’, ‘watchdog expired’, etc. IPMI event messages are typically associated with a Sensor. The type and event type of the Sensor associated with an event helps the Shelf Manager and HPI User decide on actions to be taken on account of that event.

HPI layer can handle events for various kinds which can be originated for Resource Details, Domain events, Sensor, Hot-Swap, Watchdog, Software-Events, OEM, User events, Dimi, Fumi events. While developing any event specific change either in Middleware or in Application, the specific event is allowed from PSP and is received by Application and rest of events are suppressed.

The event received is containing fields which indicate

Source : ResourceId of FRU

EventType : Sensor Type

TimeStamp : Time when the HPI Server receives the event.

Severity : SAHPI_MINOR, SAHPI_MAJOR, SAHPI_CRITICAL

===Details in Event Union===

{| cellspacing="0" border="1" align="center"
|+align="bottom"| '''SA Forum APIs with the SAFplus Platform equivalent'''
|- style="color:black;background-color:#ffffaa;" align="center"
!SensorEventT
!Event Request Message
|-
|SensorNum
|Sensor #
|-
|SensorType
|Type of Sensor (Ex: Voltage, Temp.)
|-
|EventState
|SAHPI_ES_LOWER_MINOR
|-
|
|SAHPI_ES_LOWER_MAJOR
|-
|
|SAHPI_ES_LOWER_CRITICAL
|-
|
|-
|
|SAHPI_ES_UPPER_MINOR
|-
|
|SAHPI_ES_UPPER_MAJOR
|-
|
|SAHPI_ES_UPPER_CRITICAL
|-
|SensorSpecific
|Event Specific Data.
|}

===Code Build and Execution details:===

The file cmPolicy.c contain the details of policies to inhibit/change the event details is available in location .../CmPlugin/src/app/common/plugins/cmPolicy.c in function HpiEventFilter(). For including this file, the make file in location .../src/app/common/plugins/Makefile needs to be changed so that the libraries are included as defined by Application while creating the image and executed by PSP during the handling of events.
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Makefile in location .../src/app/common/plugins/
|-
|<code><pre>
/* change PLUGIN_NAME to LIB_NAMES and assign cmPolicy */
LIB_NAMES := cmPolicy
...

/* add cpp flags */
# List any third party libs needed to get this server built (or None):
CPPFLAGS += -I$(ASP_CONFIG)
-I$(CLOVIS_ROOT)/../../PSP/src/cm/include
-I$(CLOVIS_ROOT)/../../buildtools/local/include/openhpi
</pre></code>
|}
===Example Code:===

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Sensor Event: Temperature
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_SENSOR) && \
(event.EventDataUnion.SensorEvent.Assertion == SAHPI_TRUE))
{
return CL_ERR_OP_NOT_PERMITTED; /* Event is skipped and is not forwarded to application */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}
The Sensor Event is received for a temperature raise is for one of the blades in chassis, which was a false-alarm. To suppress this, the severity of that event is reduced to minor, so as to prevent from slot reboot/ shutdown. The same can be extended for false alarms in voltage.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| HOT SWAP Event:
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_HOTSWAP) && \
(event.EventDataUnion.HotSwapEvent.HotSwapState != event.EventDataUnion.HotSwapEvent.PreviousHotSwapState))
{
event->Severity = SAHPI_MAJOR; /* Changing event severity to minor */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to major */
}
return CL_OK;
}
</pre></code>
|}
When a FRU event is generated which is a false-alarm, these kind of events are blocked by checking whether there is an actual change in states by comparing its current state with previous state. If there is a real change in FRU, then only forward this to application else block the event.

Doc:latest/evalguide/cmPlugin

2013-10-15T14:59:41Z

Natesh: /* Example Code: */

== CM Plug-in Guide==

===Objective===

CM-Plugin is an event controlling policy in Platform-Support-Package(PSP) to allow, restrict, or modify the events received from HPI and forwarded to the Application during run-time. The policy is defined by the Application programmer and is loaded into the Chassis Manager and called whenever a hardware event is received.

The purpose of this plugin is to allow the application programmer to intercept events that may be miscategorized by the hardware and transform them. For example, if a voltage loss event is reported as MAJOR in a dual power supply system, this even should not cause system shutdown so can be reduced to a MINOR level event.

===What you can learn===

How to define a policy to control the events in the CM, so that only interested events are forwarded to the Application and unintended events are discarded.

===Building the CM-Plugin model and controlling Events in run-time===

The example code containing Application and CM-Policy is available in
'''[https://github.com/OpenClovis/SAFplus-Platform-Support-Package/tree/master/src/example/cmplugin PSP/src/example]'''

====Usage of CM-Plugin====

The policy to control the events is defined in cmPolicy.c and is available in the location: .../CmPlugin/src/app/common/plugins/cmPolicy.c in specified example.

* HpiEventFilter() will be contain the details of specific event to be handled and specific modification for that event.
* We shall show the usage of the filter for a SENSOR Event.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| cmPolicy.c
|-
|<code><pre>

ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
/* Define the policy to Allow, Block or Change the events here */
if ((event->EventType == SAHPI_ET_SENSOR) && (event->EventDataUnion.SensorEvent.SensorNum == 4))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
else if ((event->EventType == SAHPI_ET_SENSOR) && (event->Source == 0x10))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}

In the above example, the Sensor Events from Sensor #4 is changed to lower severity, so that the event is given lower importance or can be ignored and other events which are of importance can be received and processed by Application.

===How to Run cmPlugin model===

Copy the image to new directory (/root/SAFplus/).

<ol>

<li>Start the SAFplus Platform on deployed node <code><pre>
# cd /root/asp/
# ./etc/init.d/asp start</pre></code>

<li>Generate event using HPI Event Simulator OR through actual hardware <code><pre>
# cd /root/asp/bin
# ./hpithres</pre></code>
</ol>
The logs are available in var/log/sys.latest and application_name.latest.

===Advanced Usage:===
The Shelf Manager in AdvancedTCA/MicroTCA is notified about health and management status changes in the shelf via standard IPMI event messages that are forwarded to the active Shelf Manager. IPM Controllers are configured to generate event messages when they detect a significant condition getting asserted or deasserted in the system. This includes messages for events such as ‘temperature threshold exceeded’, ‘voltage threshold exceeded’, ‘power fault’, ‘watchdog expired’, etc. IPMI event messages are typically associated with a Sensor. The type and event type of the Sensor associated with an event helps the Shelf Manager and HPI User decide on actions to be taken on account of that event.

HPI layer can handle events for various kinds which can be originated for Resource Details, Domain events, Sensor, Hot-Swap, Watchdog, Software-Events, OEM, User events, Dimi, Fumi events. While developing any event specific change either in Middleware or in Application, the specific event is allowed from PSP and is received by Application and rest of events are suppressed.

The event received is containing fields which indicate

Source : ResourceId of FRU

EventType : Sensor Type

TimeStamp : Time when the HPI Server receives the event.

Severity : SAHPI_MINOR, SAHPI_MAJOR, SAHPI_CRITICAL

===Details in Event Union===

{| cellspacing="0" border="1" align="center"
|+align="bottom"| '''SA Forum APIs with the SAFplus Platform equivalent'''
|- style="color:black;background-color:#ffffaa;" align="center"
!SensorEventT
!Event Request Message
|-
|SensorNum
|Sensor #
|-
|SensorType
|Type of Sensor (Ex: Voltage, Temp.)
|-
|EventState
|SAHPI_ES_LOWER_MINOR
|-
|
|SAHPI_ES_LOWER_MAJOR
|-
|
|SAHPI_ES_LOWER_CRITICAL
|-
|
|-
|
|SAHPI_ES_UPPER_MINOR
|-
|
|SAHPI_ES_UPPER_MAJOR
|-
|
|SAHPI_ES_UPPER_CRITICAL
|-
|SensorSpecific
|Event Specific Data.
|}

===Code Build and Execution details:===

The file cmPolicy.c contain the details of policies to inhibit/change the event details is available in location .../CmPlugin/src/app/common/plugins/cmPolicy.c in function HpiEventFilter(). For including this file, the make file in location .../src/app/common/plugins/Makefile needs to be changed so that the libraries are included as defined by Application while creating the image and executed by PSP during the handling of events.
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Makefile in location .../src/app/common/plugins/
|-
|<code><pre>
/* change PLUGIN_NAME to LIB_NAMES and assign cmPolicy */
LIB_NAMES := cmPolicy
...

/* add cpp flags */
# List any third party libs needed to get this server built (or None):
CPPFLAGS += -I$(ASP_CONFIG)
-I$(CLOVIS_ROOT)/../../PSP/src/cm/include
-I$(CLOVIS_ROOT)/../../buildtools/local/include/openhpi
</pre></code>
|}
===Example Code:===

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Sensor Event: Temperature
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_SENSOR) && \
(event.EventDataUnion.SensorEvent.Assertion == SAHPI_TRUE))
{
return CL_ERR_OP_NOT_PERMITTED; /* Event is skipped and is not forwarded to application */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}
The Sensor Event is received for a temperature raise is for one of the blades in chassis, which was a false-alarm. To suppress this, the severity of that event is reduced to minor, so as to prevent from slot reboot/ shutdown. The same can be extended for false alarms in voltage.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| HOT SWAP Event:
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_HOTSWAP) && \
(event.EventDataUnion.HotSwapEvent.HotSwapState != event.EventDataUnion.HotSwapEvent.PreviousHotSwapState))
{
event->Severity = SAHPI_MAJOR; /* Changing event severity to minor */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to major */
}
return CL_OK;
}
</pre></code>
|}
When a FRU event is generated which is a false-alarm, these kind of events are blocked by checking whether there is an actual change in states by comparing its current state with previous state. If there is a real change in FRU, then only forward this to application else block the event.

Doc:latest/evalguide/cmPlugin

2013-10-15T11:47:54Z

Natesh:

== CM Plug-in Guide==

===Objective===

CM-Plugin is an event controlling policy in Platform-Support-Package(PSP) to allow, restrict, or modify the events received from HPI and forwarded to the Application during run-time. The policy is defined by the Application programmer and is loaded into the Chassis Manager and called whenever a hardware event is received.

The purpose of this plugin is to allow the application programmer to intercept events that may be miscategorized by the hardware and transform them. For example, if a voltage loss event is reported as MAJOR in a dual power supply system, this even should not cause system shutdown so can be reduced to a MINOR level event.

===What you can learn===

How to define a policy to control the events in the CM, so that only interested events are forwarded to the Application and unintended events are discarded.

===Building the CM-Plugin model and controlling Events in run-time===

The example code containing Application and CM-Policy is available in
'''[https://github.com/OpenClovis/SAFplus-Platform-Support-Package/tree/master/src/example/cmplugin PSP/src/example]'''

====Usage of CM-Plugin====

The policy to control the events is defined in cmPolicy.c and is available in the location: .../CmPlugin/src/app/common/plugins/cmPolicy.c in specified example.

* HpiEventFilter() will be contain the details of specific event to be handled and specific modification for that event.
* We shall show the usage of the filter for a SENSOR Event.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| cmPolicy.c
|-
|<code><pre>

ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
/* Define the policy to Allow, Block or Change the events here */
if ((event->EventType == SAHPI_ET_SENSOR) && (event->EventDataUnion.SensorEvent.SensorNum == 4))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
else if ((event->EventType == SAHPI_ET_SENSOR) && (event->Source == 0x10))
{
event->Severity = SAHPI_MINOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}

In the above example, the Sensor Events from Sensor #4 is changed to lower severity, so that the event is given lower importance or can be ignored and other events which are of importance can be received and processed by Application.

===How to Run cmPlugin model===

Copy the image to new directory (/root/SAFplus/).

<ol>

<li>Start the SAFplus Platform on deployed node <code><pre>
# cd /root/asp/
# ./etc/init.d/asp start</pre></code>

<li>Generate event using HPI Event Simulator OR through actual hardware <code><pre>
# cd /root/asp/bin
# ./hpithres</pre></code>
</ol>
The logs are available in var/log/sys.latest and application_name.latest.

===Advanced Usage:===
The Shelf Manager in AdvancedTCA/MicroTCA is notified about health and management status changes in the shelf via standard IPMI event messages that are forwarded to the active Shelf Manager. IPM Controllers are configured to generate event messages when they detect a significant condition getting asserted or deasserted in the system. This includes messages for events such as ‘temperature threshold exceeded’, ‘voltage threshold exceeded’, ‘power fault’, ‘watchdog expired’, etc. IPMI event messages are typically associated with a Sensor. The type and event type of the Sensor associated with an event helps the Shelf Manager and HPI User decide on actions to be taken on account of that event.

HPI layer can handle events for various kinds which can be originated for Resource Details, Domain events, Sensor, Hot-Swap, Watchdog, Software-Events, OEM, User events, Dimi, Fumi events. While developing any event specific change either in Middleware or in Application, the specific event is allowed from PSP and is received by Application and rest of events are suppressed.

The event received is containing fields which indicate

Source : ResourceId of FRU

EventType : Sensor Type

TimeStamp : Time when the HPI Server receives the event.

Severity : SAHPI_MINOR, SAHPI_MAJOR, SAHPI_CRITICAL

===Details in Event Union===

{| cellspacing="0" border="1" align="center"
|+align="bottom"| '''SA Forum APIs with the SAFplus Platform equivalent'''
|- style="color:black;background-color:#ffffaa;" align="center"
!SensorEventT
!Event Request Message
|-
|SensorNum
|Sensor #
|-
|SensorType
|Type of Sensor (Ex: Voltage, Temp.)
|-
|EventState
|SAHPI_ES_LOWER_MINOR
|-
|
|SAHPI_ES_LOWER_MAJOR
|-
|
|SAHPI_ES_LOWER_CRITICAL
|-
|
|-
|
|SAHPI_ES_UPPER_MINOR
|-
|
|SAHPI_ES_UPPER_MAJOR
|-
|
|SAHPI_ES_UPPER_CRITICAL
|-
|SensorSpecific
|Event Specific Data.
|}

===Code Build and Execution details:===

The file cmPolicy.c contain the details of policies to inhibit/change the event details is available in location .../CmPlugin/src/app/common/plugins/cmPolicy.c in function HpiEventFilter(). For including this file, the make file in location .../src/app/common/plugins/Makefile needs to be changed so that the libraries are included as defined by Application while creating the image and executed by PSP during the handling of events.
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Makefile in location .../src/app/common/plugins/
|-
|<code><pre>
/* change PLUGIN_NAME to LIB_NAMES and assign cmPolicy */
LIB_NAMES := cmPolicy
...

/* add cpp flags */
# List any third party libs needed to get this server built (or None):
CPPFLAGS += -I$(ASP_CONFIG)
-I$(CLOVIS_ROOT)/../../PSP/src/cm/include
-I$(CLOVIS_ROOT)/../../buildtools/local/include/openhpi
</pre></code>
|}
===Example Code:===

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| Sensor Event: Temperature
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_SENSOR) && \
(event.EventDataUnion.SensorEvent.Assertion == SAHPI_TRUE))
{
event->Severity = SAHPI_MAJOR; /* Changing event severity to minor */
}
return CL_OK;
}
</pre></code>
|}
The Sensor Event is received for a temperature raise is for one of the blades in chassis, which was a false-alarm. To suppress this, the severity of that event is reduced to minor, so as to prevent from slot reboot/ shutdown. The same can be extended for false alarms in voltage.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| HOT SWAP Event:
|-
|<code><pre>
ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
if ((event->EventType == SAHPI_ET_HOTSWAP) && \
(event.EventDataUnion.HotSwapEvent.HotSwapState != event.EventDataUnion.HotSwapEvent.PreviousHotSwapState))
{
event->Severity = SAHPI_MAJOR; /* Changing event severity to minor */
}
else
{
event->Severity = SAHPI_MINOR; /* Changing event severity to major */
}
return CL_OK;
}
</pre></code>
|}
When a FRU event is generated which is a false-alarm, these kind of events are blocked by checking whether there is an actual change in states by comparing its current state with previous state. If there is a real change in FRU, then only forward this to application else block the event.

Doc:latest/evalguide/cmPlugin

2013-10-11T09:40:42Z

Natesh:

Doc:latest/evalguide/cmPlugin

2013-10-11T09:23:37Z

Natesh: /* Advanced Usage: */

Doc:latest/evalguide/cmPlugin

2013-10-10T11:59:48Z

Natesh:

Doc:latest/evalguide/cmPlugin

2013-10-10T11:46:46Z

Natesh: /* How to Run cmPlugin model */

Doc:latest/evalguide/cmPlugin

2013-10-10T11:46:29Z

Natesh: /* What you can learn */

Doc:latest/evalguide/cmPlugin

2013-10-10T11:46:09Z

Natesh:

Doc:latest/evalguide/cmPlugin

2013-10-10T10:47:20Z

Natesh:

Doc:latest/evalguide/cmPlugin

2013-10-10T10:22:11Z

Natesh: /* Usage of CM-Plugin */

Doc:latest/evalguide/cmPlugin

2013-10-10T10:17:31Z

Natesh: /* Building the CM-Plugin model and controlling Events in run-time */

Doc:latest/evalguide/cmPlugin

2013-10-10T10:15:38Z

Natesh: /* How to Run cmPlugin model */

Doc:latest/evalguide/cmPlugin

2013-10-10T09:48:54Z

Natesh: /* Usage of CM-Plugin */

Doc:latest/evalguide/cmPlugin

2013-10-08T11:51:26Z

Natesh:

== CM Plug-in Guide==

===Objective===

CM-Plugin is an event controlling policy in Platform-Support-Package(PSP) to allow and/or restrict the events received from HPI and forward them to Application during run-time. The policy is defined by Application.

===What you can learn===

How to define a policy to control the events in PSP, so that only interested events are forwarded to Application and unintended events are discarded.

===Building the CM-Plugin model and controlling Events in run-time===

The example code containing Application and CM-Policy is available in
'''[https://github.com/OpenClovis/SAFplus-Platform-Support-Package/tree/6.0/src/example/cmplugin PSP/src/example]'''

====Usage of CM-Plugin====

The policy to control the events are defined in cmPolicy.c and is available in location: \CmPlugin\src\app\common\plugins\cmPolicy.c in specified example.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| cmPolicy.c
|-
|<code><pre>

ClRcT HpiEventFilter(SaHpiSessionIdT session, SaHpiEventT* event, SaHpiRdrT* rdr, SaHpiRptEntryT* rpt)
{
/* Define the policy to Allow, Block or Change the events here */
if ( /* For Specific condition of Event Ex: event->Severity==SAHPI_MAJOR */)
{
/* Change the event to required form */
/* event->Severity=SAHPI_MINOR; */
}

return CL_OK;
}
</pre></code>
|}

* HpiEventFilter() will be contain the details of specific event to be handled and specific modification for that event.

===How to Run cmPlugin model===

Copy the image to required location (/root/asp/).

<ol>

<li>Start the SAFplus Platform on deployed node <code><pre>
# cd /root/asp/
# ./etc/init.d/asp start</pre></code>

<li>Generate event using HPI Event Simulator OR through actual hardware <code><pre>
# cd /root/asp/bin
# ./hpithres</pre></code>
The logs are available in var/log/sys.latest and application_name.latest

Doc:latest/evalguide/cmPlugin

2013-10-07T15:46:10Z

Natesh: /* Objective */

This is a page to demo CM Plugin.

== CM Plug-in Guide==

===Objective===

Plug-in for CM is an event controlling policy in PSP to allow and restrict the events received and forward them to Application during run-time. The policy has a component defined by Application.

===What you will learn===

Doc:latest/evalguide/cmPlugin

2013-10-07T15:44:22Z

Natesh:

This is a page to demo CM Plugin.

== CM Plug-in Guide==

===Objective===

Plug-in for CM is a controlling policy to allow and restrict the events received in PSP and forwarded to Application during run-time. The policy has a component defined by Application and used in PSP

===What you will learn===

Doc:latest/evalguide/cmPlugin

2013-10-07T15:31:59Z

Natesh: This is a page to demo CM Plugin.

This is a page to demo CM Plugin.

Doc:latest/evalguide

2013-10-07T15:29:21Z

Natesh:

Table of contents:
* [[Doc:latest/evalguide/preface | Preface ]]
* [[Doc:latest/evalguide/scope | Objectives and Scope ]]
* [[Doc:latest/evalguide/prerequisites | Hardware and Software Prerequisites]]
* [[Doc:latest/evalguide/setup | Runtime Hardware Setup ]]
* [[Doc:latest/evalguide/app_ide | Examining the Evaluation Model ]]
* [[Doc:latest/evalguide/build | Building the Evaluation System and Deploying Runtime Images]]
* [[Doc:latest/evalguide/csa |Sample Applications]]

**[[Doc:latest/evalguide/csa101 | csa101 Creating Basic SA-Forum Compliant Applications]]
**[[Doc:latest/evalguide/csa102 | csa102 Redundancy and Failover]]
**[[Doc:latest/evalguide/csa103 | csa103 Checkpointing]]
**[[Doc:latest/evalguide/csa104m | csa104 Messaging]]



**[[Doc:latest/evalguide/csa112 | csa112 Event Subscription]]
**[[Doc:latest/evalguide/csa113 | csa113 Event Publication]]



**[[Doc:latest/evalguide/dhaDemo | Dynamic HA application]]
**[[Doc:latest/evalguide/cmPlugin | CM Plugin Application]]
**[[Doc:latest/evalguide/csasum | Summary and Next Steps]]

Doc:latest/evalguide/csa102

2013-06-11T04:05:09Z

Natesh: /* How to create new Project Model csa102 */

==csa102 Redundancy and Failover==

===Objective===

This sample demonstrates basic HA (High Availability) and SU (Service Unit) fail-over functionality. The application has two components, both processing the same workload as csa101, that is, repeatedly printing "Hello World". The difference, however, is that in this case there is now an active component and a standby component, with only the active component performing the printing function.

csa102 is quite similar to csa101, and this section will discuss the areas in which they deviate.

===What you will learn===

*Keeping track of HA states and how to respond to callbacks requesting HA state changes.

===How to create new Project Model csa102===
The first step in setting up our example is to create a model which represents the system that we will eventually deploy. This is done through the '''SAFplus Platform IDE'''. In this chapter we will step through the following tasks:
* Create a project area
* Launch the '''SAFplus Platform IDE'''
* Create the IDE project
* Specify the Resource model for csa102(the types of physical hardware in our system)
* Specify the Component model (the types of components or applications in our system)
* Specify which Components run on which Resources
* Specify important build and boot parameters

===Creating a New Project Area===
A project area is a directory on your system where you can develop SAFplus Platform models and generate the code corresponding to those models. This is same as created for ''csa101''.

Create a project area using a script from the command line. To create a project area named '''projectarea1''' in the '''/home/clovis''' directory you should execute the following command:
<code><pre>
# cl-create-project-area /home/clovis/projectarea1
</pre></code>

===Launching the SAFplus Platform IDE===
You can launch the '''SAFplus Platform IDE''' from the command line. If you chose to create symbolic links during installation you can simply enter <code>'''cl-ide'''</code> from any directory. If you did not create symbolic links during installation you can either:

<ul>
<li>Add the installation directory to the shells search path and then launch the IDE as follows:</li>
<code><pre>
# cl-ide
</pre></code>
<li>Start cl-ide by specifying the full path</li>
</ul>

The splash screen for SAFplus Platform IDE is displayed as illustrated in Figure [[#SAFplus Platform IDE Opening Screen | SAFplus Platform IDE Opening Screen]].

[[File:Tutorial_GettingStartedIDE_OpeningScreen.png|frame|center| '''SAFplus Platform IDE Opening Screen''' ]]

You will then be prompted to select a workspace in which to do your work as illustrated in Figure [[#SAFplus Platform IDE Workspace Launcher | SAFplus Platform IDE Workspace Launcher]].

The workspace you select should correspond to the project area that you created in the previous section (in this case "/home/clovis/projectarea1"). Note that the workspace includes a subdirectory of "/ide_workspace". This is done strictly for organizational purposes. It keeps the IDE models separate from the generated SAFplus Platform models and code. Select the workspace and click '''OK''' to launch SAFplus Platform IDE.

The '''SAFplus Platform''' IDE is launched and you are now looking at the main work area. For more information about the components of this main work area including the SAFplus Platform IDE menu and toolbar, see ''SAFplus Platform IDE User Guide''.

===Creating the Sample Project===
We will now create a project within the '''SAFplus Platform IDE'''. This project will hold both the resource model and the component model '''csa102''' for our example system. The resource model is a physical view of the resources (the chassis, the blade types, etc.) in our system. The component model is a logical view of the components (applications, etc.) in our system.

We will be using the '''New Project Wizard''' to create our project. The wizard captures some high-level information about the system that we are building and performs a lot of the basic setup for us.

[[File:OpenClovis_Note.png]]The same model that we are building through the wizard could also be created manually through the Resource and Component Editors. For more information on the Resource and Component Editors see ''SAFplus Platform IDE User Guide''.This step is similar compared to ''csa101''.

To launch the '''New Project Wizard''' select '''File''' > '''New''' > '''Project''' from the IDE menu bar.

The '''New Project Wizard''' is displayed and '''Clovis System Project''' is selected by default as illustrated in Figure [[#New Project Wizard | New Project Wizard]].

Click '''Next'''. The '''Clovis System Project''' window is displayed as illustrated in Figure [[#Clovis System Project | Clovis System Project]].

Enter the following information (These steps are similar compared to ''csa101''):

<ul>
<li>'''Project Name''' : Enter the name of your new project as '''SampleModel'''.
 Do not use spaces or special characters for the project name. The project name can be alphanumeric, but cannot start with a number or have only numbers.
 Select '''Use default''' to use the same directory mentioned in the '''Directory''' field.

<li>'''SDK Location''': Enter the location where the SAFplus Platform SDK was installed. For e.g. if the SDK was installed at location /opt/clovis, then the SDK location is /opt/clovis/sdk-<version>.

<li>'''Project Area Location''': Enter the location where the generated source code for the model should be stored.
 This can be any existing directory but is usually the project area that was created in the previous section.

<li>'''Python Location''': Enter the location where Python 2.5.0 is installed on your system. If Python 2.5.0 was installed by SAFplus Platform SDK, the directory is <code>'''<installation_directory>/buildtools/local/bin'''</code>.
</ul>

Click '''Next'''. The '''Add New Blade Type''' window is displayed. This dialog is used to define the blade types that are in our system.

[[File:Tutorial_csa102_AddBlade.png|frame|center| '''Add New Blade Type''' ]]

Remember that the system we are modelling has only one blade type...a System Controller.
<ul>
<li>Use the '''Add''' button to add a new blade type to the list. Name this blade type 'SysBlade' (for System Controller blade).
</ul>

Click '''Next'''. The '''Add New SAF Node Type''' window is displayed. This dialog is used to define the type of logical node that will be run on the corresponding blade type defined in the previous dialog.

[[File:Tutorial_csa102_AddNode.png|frame|center| '''Add New SAF Node Type''' ]]

Node types represent groups of software. They are classified as either a System Controller class or a Payload class. This distinction gives the node type certain characteristics which cause it to behave in a well-defined manner. Since we have only a System Controller in our system we will add a node type of class System Controller.

<ul>
<li>Use the '''Add''' button to add a new node type to the list. Name the node type 'SCNode' and ensure that its node class is 'System Controller (SAF Class B)'.
</ul>

Click '''Next'''. The '''Specify Program Names''' window is displayed. This dialog is used to create programs or SAF Service Types and associate them with the SAF Node Types specified in the previous dialog.

[[File:Tutorial_csa102_DefineProgramNames.png|frame|center| '''Specify Program Names''' ]]

In our system we need one SAF Service Type which represents our high availability software (csa102 continuously prints "Hello World!" '''redundantly''').

<ul>
<li>Use the '''Add''' button to add a program name to the list. Change the program name to 'csa102' and associate the program with the 'SCNode' node type.
</ul>

Click '''Finish'''. This will create the sample model using the blade type, node type, and program name information collected through the 'New Project Wizard' dialogs.

====Configuring the Service Group====
To make changes to the Service Group double-click on the box titled '''csa101SG'''. The '''Service Group Details''' dialog is displayed.

[[File:Tutorial_csa102_ServiceGroupDetails.png|frame|center| '''Service Group Details''' ]]

<ul>
<li>The first change we want to make is to the '''Redundancy Model'''. The '''Redundancy Model''' is the strategy that is used by the SAFplus Platform system to recover from a node failure. For our redundant model (which only has one node with one Active component and another standby component used for redundancy) change the '''Redundancy Model''' to '2N Redundancy' as shown.

 [[File:OpenClovis_Note.png]]You will notice that when you change the redundancy model some of the other fields are modified automatically and become read-only. This is to ensure integrity of the redundancy models.

<li>The second change that we want to make is to the '''Admin State'''. The '''Admin State''' defines the state of the component when the system is first brought up. In our case we want to change the '''Admin State''' to be 'Locked Initialized'. This means that when the system first starts up this '''Service Group''' (and its subcomponents) will be initialized but not yet put into a running state. So our csa102 application will not yet start printing "Hello World!".

<li>The third change that we want to make is to the '''Auto repair'''. The '''Auto repair''' defines the state of the component to be achieved after failure of the component. So our csa102 application will not yet start printing "Hello World!".
<li>When you are finished making the changes click the '''OK''' button to commit the changes.
</ul>

====Configuring the SAF Component====
To make changes to the SAF Component double-click on the box titled '''csa102'''. The '''SAF Component Details''' dialog is displayed.

[[File:Tutorial_csa102_SAFComponentDetails.png|frame|center| '''SAF Component Details''' ]]

To make the model to recover from failure by Stand-by component, the field '''Recovery action on error''' needs to be changed to ''Component fail over''.

The SAF Component represents our high availabilty program or executable. We need to pass a command line argument to this executable. The reason for this argument is to force the program to print the 'Hello World!' output to a special log file for our viewing. We will look at this more closely when we customize our code.

===Configuring Physical Instances===
The configuration of our logical models is complete. During this process we have defined all of the 'types' of objects in our system. Now it is time to configure actual instances of those objects so that they can be built and deployed.

Object instance configuration is done through the Availability Management Framework (AMF) via the '''AMF Configuration''' dialog.

<ul>
<li>To launch this dialog go to the the '''Clovis''' menu and select '''AMF Configuration...'''
</ul>

The '''AMF Configuration''' window will be displayed. If you now completely expand the AMF Configuration branch of the tree in the left-hand pane you will see the following.

[[File:Tutorial_csa102_AMFConfig.png|frame|center| '''AMF Configuration Dialog''' ]]

===Code===

The code can be geneteted using the same steps as mentioned for csa101. The genetated code can be found within the following directory
<project-area_dir>/eval/src/app/csa102Comp

This sample component is implemented in a few C modules that are quite similar to the csa101 module. We will discuss the additions in detail.

We change the logging from the default "application" stream to a custom stream. To do this, we include the header that defines our config routines, change the default "clLogApp" macro to use a different stream, and define that stream as a global variable:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| clCompAppMain.c
|-
|<code><pre>
#include "../ev/ev.h"
...
#define clprintf(severity, ...) clAppLog(gEvalLogStream, severity, 10, CL_LOG_AREA_UNSPECIFIED, CL_LOG_CONTEXT_UNSPECIFIED, __VA_ARGS__)
...
ClLogStreamHandleT gEvalLogStream = CL_HANDLE_INVALID_VALUE;
</pre></code>
|}

Next, the log stream is initialized in the application's "main" function:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| clCompAppMain.c
|-
|<code><pre>
/*
* Initialize the log stream
*/
clEvalAppLogStreamOpen((ClCharT*)appName.value, &gEvalLogStream);
</pre></code>
|}

This function is implemented in the src/app/ev.c file.

As with csa101, the <code>clCompAppAMFCSISet()</code> function is called to set the component's HA state, and the following block of code assigns this requested state to the component, while verbosely detailing this process:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| clCompAppMain.c
|-
|<code><pre>
void clCompAppAMFCSISet(SaInvocationT invocation,
const SaNameT *compName,
SaAmfHAStateT haState,
SaAmfCSIDescriptorT csiDescriptor)
{
/*
* Print information about the CSI Set
*/

clprintf (CL_LOG_SEV_INFO, "Component [%.*s] : PID [%d]. CSI Set Received\n",
compName->length, compName->value, mypid);

clCompAppAMFPrintCSI(csiDescriptor, haState);

/*
* Take appropriate action based on state
*/

switch ( haState )
{
case SA_AMF_HA_ACTIVE:
{
/*
* AMF has requested application to take the active HA state
* for the CSI.
*/
pthread_t thr;

clprintf(CL_LOG_SEV_INFO,"csa102: ACTIVE state requested; activating service");
running = 1;
pthread_create(&thr,NULL,activeLoop,NULL);

saAmfResponse(amfHandle, invocation, SA_AIS_OK);
break;
}

case SA_AMF_HA_STANDBY:
{
/*
* AMF has requested application to take the standby HA state
* for this CSI.
*/
clprintf(CL_LOG_SEV_INFO,"csa102: Standby state requested");
running = 0;
saAmfResponse(amfHandle, invocation, SA_AIS_OK);
break;
}

case SA_AMF_HA_QUIESCED:
{
/*
* AMF has requested application to quiesce the CSI currently
* assigned the active or quiescing HA state. The application
* must stop work associated with the CSI immediately.
*/
clprintf(CL_LOG_SEV_INFO,"csa102: Acknowledging new state quiesced");
running = 0;

saAmfResponse(amfHandle, invocation, SA_AIS_OK);
break;
}

case SA_AMF_HA_QUIESCING:
{
/*
* AMF has requested application to quiesce the CSI currently
* assigned the active HA state. The application must stop work
* associated with the CSI gracefully and not accept any new
* workloads while the work is being terminated.
*/
clprintf(CL_LOG_SEV_INFO,"csa102: Signaling completion of QUIESCING");
running = 0;

saAmfCSIQuiescingComplete(amfHandle, invocation, SA_AIS_OK);
break;
}
...
</pre></code>
|}

In this case the application spawns a thread when it is assigned active which is a very common strategy for threaded applications. It also sets a global variable "running" to true. When the application is "quesced" -- that is when the active work assignment is taken away -- the application sets this global variable back to 0 to trigger the active thread to quit itself. The thread is simply defined as:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| clCompAppMain.c
|-
|<code><pre>
void* activeLoop(void* p)
{
while (running)
{
clprintf(CL_LOG_SEV_INFO,"csa102: Threaded Hello World! %s", show_progress());
sleep(2);
}
return NULL;
}

static char* show_progress(void)
{
static char bar[] = " .";
static int progress = 0;

/* Show a little progress bar */
return &bar[sizeof(bar)-2-(progress++)%(sizeof(bar)-2)];
}
</pre></code>
|}

The example also demonstrates a non-threaded approach. But first, some background: for both threaded and non-threaded applications, the main must have a "dispatch" loop that handles incoming AMF notifications and calls the relevant callback. So to implement a single threaded SAF aware application, the programmer must modify this dispatch loop adding active (and potentially standby) functionality:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"| clCompAppMain.c
|-
|<code><pre>
main(...)

do
{
struct timeval timeout;
timeout.tv_sec = 2; timeout.tv_usec = 0;

FD_ZERO(&read_fds);
FD_SET(dispatch_fd, &read_fds);

if( select(dispatch_fd + 1, &read_fds, NULL, NULL, &timeout) < 0)
{
if (EINTR == errno)
{
continue;
}
clprintf (CL_LOG_SEV_ERROR, "Error in select()");
perror("");
break;
}
if (FD_ISSET(dispatch_fd,&read_fds)) saAmfDispatch(amfHandle, SA_DISPATCH_ALL);

if (running) clprintf(CL_LOG_SEV_INFO,"csa102: Unthreaded Hello World! %s", show_progress()); // Run the "active" code
else clprintf(CL_LOG_SEV_INFO,"csa102: idle");
}while(!unblockNow);

</pre></code>
|}

This code should be very familiar to anyone who has written single threaded "event loop" style code. As can be seen in the code snippet above, the select is given an idle timeout (in a real application the timeout would be much smaller) and the application only calls <code>saAmfDispatch</code> if the select actually indicates that the there is data in the FD. Then it falls down into an "if" statement that checks if we are active "if (running)..." and outputs a log if that is the case.

===How to Run csa102 and What to Observe===

As with the csa101 example we will use the SAFplus Platform Console to manipulate the administrative state of the csa102 service group.

<ol>
<li>Start the SAFplus Platform Console<code><pre>
# cd /root/asp/bin
# ./asp_console</pre></code>

<li>Then put the csa102SGI0 service group into lock assignment state using the following commands.<code><pre>
cli[Test]-> setc 1
cli[Test:SCNodeI0]-> setc cpm
cli[Test:SCNodeI0:CPM]-> amsLockAssignment sg csa102SGI0
</pre></code>

Because example 102 has two components there will be two application log files to view. These are <code>/root/asp/var/log/csa102CompI0Log.latest</code> and <code>/root/asp/var/log/csa102CompI1Log.latest</code>. Viewing these application logs using the <code>tail -f</code>, you should see the following.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa102CompI0Log.latest
|-
|<code><pre>
Sun Jul 13 22:38:17 2008 (SCNodeI0.13418 : csa102CompEO.---.---.00029 : INFO)
Component [csa102CompI0] : PID [13418]. Initializing

Sun Jul 13 22:38:17 2008 (SCNodeI0.13418 : csa102CompEO.---.---.00030 : INFO)
IOC Address : 0x1

Sun Jul 13 22:38:17 2008 (SCNodeI0.13418 : csa102CompEO.---.---.00031 : INFO)
IOC Port : 0x80

Sun Jul 13 22:38:17 2008 (SCNodeI0.13418 : csa102CompEO.---.---.00032 : INFO)
csa102: Instantiated as component instance csa102CompI0.

Sun Jul 13 22:38:17 2008 (SCNodeI0.13418 : csa102CompEO.---.---.00033 : INFO)
csa102CompI0: Waiting for CSI assignment...
</pre></code>
|}

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| //root/asp/var/log/csa102CompI1Log.latest
|-
|<code><pre>
Sun Jul 13 22:38:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00028 : INFO)
Component [csa102CompI1] : PID [13422]. Initializing

Sun Jul 13 22:38:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00029 : INFO)
IOC Address : 0x1

Sun Jul 13 22:38:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00030 : INFO)
IOC Port : 0x81

Sun Jul 13 22:38:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00031 : INFO)
csa102: Instantiated as component instance csa102CompI1.

Sun Jul 13 22:38:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00032 : INFO)
csa102CompI1: Waiting for CSI assignment...
</pre></code>
|}

<li>Next, unlock the service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SCNodeI0:CPM]-> amsUnlock sg csa102SGI0
</pre></code>
and in the /var/log/csa102CompI*.log files we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa102CompI0Log.latest
|-
|<code><pre>
Sun Jul 13 23:00:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00487 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:19 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00488 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:20 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00489 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:21 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00490 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:22 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00491 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:23 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00492 : INFO)
csa102: Hello World! .
</pre></code>
|}

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa102CompI1Log.latest
|-
|<code><pre>
Sun Jul 13 22:43:00 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00043 : INFO)
csa102: New state is not the ACTIVE; deactivating service
</pre></code>
|}

These can be watched in a separate terminal window using <code>tail -f</code>. csa102CompI0 is the active component in this case, and csa102CompI1 is the standby. Consequently, the "Hello world!" lines appear in csa102CompI0.log and not in csa102CompI1.log. They will continue to be logged to that file until the HA state of that component changes, for example, when the process logging those lines is killed. In the mean time the standby component: csa102CompI1 just waits until it is told that it should take over the workload.
</ol>

'''Changing the HA state of the Client/Server'''

The easiest way to test component fail-over is to kill the process associated with the active component using the <code>kill</code> command. For this you need to know the process ID of the active component. To find the process ID issue the following command from a bash shell.
# ps -eaf | grep csa102
This should produce an output that looks similar to the following.
root 15872 15663 0 13:49 ? 00:00:01 csa102Comp -p
root 16328 15663 0 13:56 ? 00:00:00 csa102Comp -p
root 17304 16145 0 14:11 pts/4 00:00:00 grep csa102
Notice the two entries that end with <code>csa102Comp -p</code>. These are our two component processes. The first one is usually the active process. This is the one that we will kill. In this case the process ID is 15872. So to kill the active component you issue the command:
# kill -9 15872
[[File:OpenClovis_Note.png]]If this step does not result in the active component being killed then it is likely that the standby component was killed. In this case simply try killing the other process.

After executing the <code>kill</code> command you can see in the csa102CompI1 application that the standby component is now active.
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa102CompI1Log.latest
|-
|<code><pre>
Sun Jul 13 23:00:18 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00487 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:19 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00488 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:20 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00489 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:21 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00490 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:22 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00491 : INFO)
csa102: Hello World! .

Sun Jul 13 23:00:23 2008 (SCNodeI0.13422 : csa102CompEO.---.---.00492 : INFO)
csa102: Hello World! . .
</pre></code>
|}

This indicates that the standby component has taken over for the failed active component.

Looking in the csa102CompI0 application log you can see that this component was killed and has been restarted. Since csa102CompI1 took over as the active component this component now goes into the standby state.
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa102CompI0Log.latest
|-
|<code><pre>
Sun Jul 13 22:53:02 2008 (SCNodeI0.13712 : csa102CompEO.---.---.00040 : INFO)
Component [csa102CompI0] : PID [13712]. Initializing

Sun Jul 13 22:53:02 2008 (SCNodeI0.13712 : csa102CompEO.---.---.00041 : INFO)
IOC Address : 0x1

Sun Jul 13 22:53:02 2008 (SCNodeI0.13712 : csa102CompEO.---.---.00042 : INFO)
IOC Port : 0x80

Sun Jul 13 22:53:02 2008 (SCNodeI0.13712 : csa102CompEO.---.---.00043 : INFO)
csa102: Instantiated as component instance csa102CompI0.

Sun Jul 13 22:53:02 2008 (SCNodeI0.13712 : csa102CompEO.---.---.00044 : INFO)
csa102CompI0: Waiting for CSI assignment...
</pre></code>
|}

You can continue to observe this failover by alternately killing the active component.

To stop csa102 using the SAFplus Platform Console.
cli[Test:SCNodeI0:CPM]-> amsLockAssignment sg csa102SGI0
Successfully changed state of csa102SGI0 to LockAssignment
cli[Test:SCNodeI0:CPM]-> amsLockInstantiation sg csa102SGI0
cli[Test:SCNodeI0:CPM] -> end
cli[Test:SCNodeI0] -> end
cli[Test] -> bye
Successfully changed state of csa102SGI0 to LockInstantiation and exit.

===Summary===

This Sample Application has covered basic HA and failover, with changing the state of a component to active and standby.

File:Tutorial csa102 AMFConfig.png

2013-06-11T03:58:49Z

Natesh: Tutorial_csa102_AMFConfig

Tutorial_csa102_AMFConfig

File:Tutorial csa102 SAFComponentDetails.png

2013-06-11T03:58:02Z

Natesh: Tutorial_csa102_SAFComponentDetails

Tutorial_csa102_SAFComponentDetails

File:Tutorial csa102 ServiceGroupDetails.png

2013-06-11T03:57:17Z

Natesh:

File:Tutorial csa102 DefineProgramNames.png

2013-06-11T03:56:40Z

Natesh: Tutorial_csa102_DefineProgramNames

Tutorial_csa102_DefineProgramNames

File:Tutorial csa102 AddNode.png

2013-06-11T03:55:54Z

Natesh: Tutorial_csa102_AddNode

Tutorial_csa102_AddNode

File:Tutorial csa102 AddBlade.png

2013-06-11T03:54:19Z

Natesh: Tutorial_csa102_AddBlade

Tutorial_csa102_AddBlade