NetPlane Core Services Overview User’s Guide 6806800C08B September 2007
007 Motorola All rights reserved. Trademarks Motorola and the stylized M logo are trademarks registered in the U.S. Patent and Trademark Office. All other product or service names are the property of their respective owners. Intel® is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States and other countries. Java™ and all other Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.
Contents About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 1.1 1.2 2 Avantellis 3000 Series Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Avantellis 3000 Series Software Architecture . . . . .
Contents 2.6.2 2.7 2.8 2.9 A A.5 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Toolkit Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Toolkit Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Building the Samples . . . . . . . . . . . . . . . . . .
List of Tables Table 2-1 Table 2-2 Table 2-3 Table B-1 Table B-2 SAF Compliant NCS Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Motorola-Complementary NCS Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Description Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Motorola Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of Tables 6 NetPlane Core Services Overview User’s Guide (6806800C08B)
List of Figures Figure 1-1 Figure 2-1 Figure 2-2 Figure 2-3 Figure 2-4 Figure 2-5 Figure 2-6 Figure 2-7 Avantellis Main Software Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NetPlane Core Services Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NCS Service Distribution - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NCS Directors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of Figures 8 NetPlane Core Services Overview User’s Guide (6806800C08B)
About this Manual Overview of Contents This manual provides an overview on the Netplane Cores Services (NCS) software which is part of the Avantellis system software. It is divided into the following chapters and appendices.
About this Manual 10 Abbreviation Definition CSIs Component Service Instances CPU Central Processing Unit DHCP Dynamic Host Configuration Protocol DTA Distributed Trace Agents DTS Distributed Trace Server DTSv Distributed Trace service ECC Embedded Communications Computing EDA Event Distribution Agent EDS Event Distribution Server EDSv Event Distribution Service EVT Event service FRU Field Replaceable Unit FUF Firmware Upgrade Facility GLA Global Locking Agent GLD Global Loc
About this Manual Abbreviation Definition MQD Message Queue Director MQND Message Queue Node Director MQSv Message Queue Service MSG Messaging Service NCS NetPlane Core Services software OAA Object Access Agent PCS Platform Control Software PSA Persistent Store Agent PSS Persistent Store Server PSSv Persistent Store Service SAF Service Availability Forum™ SG Service Groups SI Service Instances SRMA System Resource Monitoring Agent SRMND System Resource Monitoring Node Directo
About this Manual Notation Description [text] Notation for software buttons to click on the screen and parameter description ... Repeated item for example node 1, node 2, ..., node 12 . Omission of information from example/command that is necessary at the time being . . .. Ranges, for example: 0..4 means one of the integers 0,1,2,3, and 4 (used in registers) | Logical OR No danger encountered.
Introduction 1.1 1 Avantellis 3000 Series Overview The Avantellis 3000 Series communications server represents the highest level of hardware and software integration to date within Motorola’s family of Open Application-Enabling Platforms.
Introduction 1.2 Avantellis 3000 Series Software Architecture Avantellis 3000 Series Software Architecture The following figure illustrates the main software components which constitute an Avantellis 3000 Series system. Figure 1-1 1.2.1 Avantellis Main Software Components NetPlane Software The NetPlane software can be subdivided into the NetPlane Core Services and the Platform Control Software. 1.2.1.
Carrier Grade Linux Operating System Introduction NCS functionality is a service user of PCS functionality. However from another perspective, PCS is a service user of NCS since the HA of PCS software components is achieved through the HA services provided by NCS. 1.2.2 Carrier Grade Linux Operating System In an Avantellis 3000 Series system the underlying operating system is Carrier Grade Linux (CGL) V. 4.0.1.
Introduction 16 Carrier Grade Linux Operating System NetPlane Core Services Overview User’s Guide (6806800C08B)
NetPlane Core Services 2.1 2 Architectural Overview This chapter provides an overview on the different components of the Netplane Core Services and provides brief insights into each service.
NetPlane Core Services 2.1.1 NCS Services NCS Services The following table lists and briefly explains the NCS services that implement the Service Availability Forum (SAF) Application Interface Specification (AIS).
Message Distribution Service NetPlane Core Services The following table lists and briefly describes complementary NCS services which were developped by Motorola. Table 2-2 Motorola-Complementary NCS Services NCS Service Name Description Distributed Trace Service (DTSv) This service allows clients to direct debug information to a file for later analysis. HPI Integration Service (HISv) This services allows other NCS services to access HPI events and to invoke a limited set of HPI functions.
NetPlane Core Services 2.1.4 System Description System Description This System Description is involved in the definition of a system model. It is an XML file which defines system entities and their relation for the purpose of system configuration and management. The System Description is read in once at system start-up and from that time on stored in persistent memory. 2.2 Distribution of NCS Services in the Avantellis System Many NCS services are subdivided into subparts.
NCS Directors NetPlane Core Services A director communicates with Node Directors that are located on blades in a system. Node Directors handle node-scoped activities such as messaging with the central Director or with the local NCS agent. The NCS agent makes service capabilities available to clients such as customer applications, by way of shared linkable libraries that expose well defined APIs. The following figure illustrates Directors and their interaction with other NCS subparts.
NetPlane Core Services 2.2.2 NCS Servers NCS Servers An NCS Server provides central intelligence for a particular NCS service, but unlike with NCS Directors, there is no corresponding Node Director for an NCS Server. Instead the NCS Server communicates directly with NCS Agents. NCS Servers are implemented in a 2N redundancy fashion. The following figure illustrates the role of NCS Servers in a system.
System Description 2.3 NetPlane Core Services System Description The System Description is an XML file which is defined prior to installation of any hardware. It describes the hardware and software configuration of a system. The System Description file is loaded to the System manager node and read by the Availability manager during the NCS initialization.
NetPlane Core Services Management Access The following table provides more details. Table 2-3 System Description Content Description Category Description Validation Description This describes all possible ATCA-blade population profiles for a particular product. The description explains the inventory and legal combinations of hardware resources, primarily those hosting one or more SAF AMF nodes. Hardware resources are identified by HPI Entity Path names with key 'identifier' attributes called out.
Management Access NetPlane Core Services 3. The MAS then forwards the transaction to the proper object owner, wherever that happens to be in the NCS system. 4. The object owner is informed via a callback at the Object Access Agent (OAA) library APIs 5. The Object owner then does a more detailed validation check before carrying out the transaction. 6. When done (or fails), the object owner uses the OAA APIs to explain its response. 7.
NetPlane Core Services SAF-Compliant NCS Services The SNMP access point comprises an SNMP agent and subagent based on an open-source Linux implementation, The NCS SNMP subagent integrates SNMP requests via the management Access agent. Application-specified additional managed objects (MIBs) can be dynamically added to the subagent. 2.5 SAF-Compliant NCS Services This section briefly describes those NCS services which implement standard SAF services.
Availability Service NetPlane Core Services validation data for managed FRUs and the linkages between entities and AMF logical nodes. All the processor environment entities in the hardware entity containment tree, which correspond to AMF nodes, contain the node name of the associated node. The node name provides the linkage between the hardware and the software system models.
NetPlane Core Services Checkpoint Service When the Availability Manager detects failures or hardware events such as extraction/insertion requests, it triggers the Availability Director to recover affected software services. When the Availability Manager receives a hot-swap event via HPI, it checks the component’s FRU validation data to determine whether the component can be powered-on or not. A further task includes reset management.
Checkpoint Service NetPlane Core Services In the case of asynchronous update option, one of the replicas is designated as the active replica. Data is always read from the active replica and there is no guarantee that all the other replicas contain identical data. A write call returns after updating the active replica. In the case of synchronous update options, the call invoked to write to the replicas returns only when all replicas have been updated, i.e.
NetPlane Core Services 2.5.2.2.2 Message Queue Service Checkpoint Node Director The Checkpoint Node Director (CPND) runs as process both on payload blades and on the two system manager nodes. Its tasks are: 2.5.2.2.
Event Distribution Service 2.5.3.2.1 NetPlane Core Services Message Queue Director The Message Queue Director (MQD) runs as process on a system manager node. Its main tasks are: z Maintaining location and state data of all queues and queue groups in a system z Resolving all queue and queue group names and location information z Supporting group change tracking on behalf of registering clients There is an active and a stand-by MQD running respectively on the two system manager nodes.
NetPlane Core Services 2.5.4.1.1 Global Lock Service Event Distribution Server The Event Distribution Server (EDS) is an NCS process on the System Controller blade which handles the distribution of events based on client subscriptions and filtering mechanisms. If an event was posted and event persistence was specified, the event will be retained by the server process for the time period specified in the call.
Motorola Complementary NCS Services NetPlane Core Services There is an active and a stand-by GLD running respectively on the two system manager nodes. GLD uses the NCS Message based Checkpoint Service to keep the two synchronized and available for failover situations. 2.5.5.2.1 Global Locking Director The Global Locking Director performs the following tasks: 2.5.5.2.
NetPlane Core Services 2.6.1.1.1 HPI Integration Service Distributed Trace Server The Distributed Trace Server (DTS) is responsible for defining policies based on which logs will be collected from the Distributed Trace Agents (DTA) at run-time. The logging policies can be configured via a Logging Policy MIB which is owned by the DTS. At system-start default policies will be used which can then be customized at run-time via the MIB. 2.6.1.1.
Simple Software Upgrade NetPlane Core Services HCD is scoped to one chassis and there are two instances of HCD in a chassis: one active and one stand-by. The main tasks of HCD are: 2.6.2.1.
NetPlane Core Services 2.6.5 Persistent Store-Restore Service Persistent Store-Restore Service The Persistent Store-Restore Service (PSSv) allows to store system configuration data on a persistent storage medium. It allows to store the current configuration as well as to maintain alternate configurations. 2.6.5.1 Basic Functionality Saving the desired configuration allows the system to initialize, retrieve the saved configuration and reach the desired state quickly, for example after a reboot.
Management Access Services 2.6.5.2.2 NetPlane Core Services z PSS processes set/get requests it receives from the Management Access Service. z PSS allows the owner of a managed object to provide a template determining the method and contents of data that will be stored for that objects. System Description Parser The persistent data maintained by the PSS service includes application configuration data as well as system configuration data.
NetPlane Core Services Management Access Services z SNMP subagent which integrates the MASv with an SNMP agent and which can be configured to support any additional customer-defined managed objects z Interface to PSSv for non-volatile storage of the values of all managed objects MASv provides a normalized structure for the managed objects of a system. Although this structure is NCS-specific in many aspects, in many cases it uses a table indexing that is identical to that used in SNMP standard MIBs.
Message-Based Checkpointing Service 2.6.6.2.3 NetPlane Core Services Management Access Server The Management Access Server (MAS) manages the database of managed objects. It performs the following tasks: 2.6.6.2.4 z Receiving managed object row ownership information from the OAAs z Direct management access requests from MAAs to the proper OAA Command Line Interpreter Management Access Point The Command Line Interpreter (CLI) provides a command-line based user interface for the NCS system.
NetPlane Core Services 2.6.7.1 Interface Service Basic Functionality The main tasks of the MBCSv are: 2.6.7.
Message Distribution Service 2.6.8.2.1 NetPlane Core Services Interface Director The Interface Director (IfD) is located on the system manager node. Its main functions include: 2.6.8.2.
NetPlane Core Services Message Distribution Service The following figure provides an overview of the components that constitute the MDS. Figure 2-7 Message Distribution Service Software Components The MDS Services API make the MDS available to its clients, i.e. other NCS services, customer applications or ECC applications. For a detailed description of the API, refer to the Message Distribution Service Programmer's Reference.
LEAP Portability Layer 2.8 NetPlane Core Services LEAP Portability Layer The LEAP (Layered Enhancement for Accelerated Portability) layer was introduced to facilitate the porting of NCS applications and user applications to other operating systems. It provides various abstractions from OS-specific details.
NetPlane Core Services 44 Cancelling Application Threads NetPlane Core Services Overview User’s Guide (6806800C08B)
A NCS Toolkit A.1 A Introduction The NCS software is accompanied by a toolkit that enables you to develop NCS-based applications. This section describes the toolkit and its functions. A.2 Toolkit Installation The NCS toolkit is a tar file with the naming convention: ncs_dev_.tar.gz. (for example: ncs06A_dev_3.1.4.tar.gz, where the release name is "06A" and the build name is "3.1.4"). The tar file is packaged to be installed on a SuSE 9.0, i386 platform.
NCS Toolkit A.4 Building the Samples z NCS MIBs These are implemented by NCS services and are used to configure them. They are located in the $(TOOLKIT_HOME)/source /mib directory. z NCS sample programs and makefiles These are provided to jump-start the application development process by providing code that is illustrative of the usage of NCS.The sample programs also serve to demonstrate the basic capabilities of each service.
"Make" Commands NCS Toolkit Synopsis ./make_env.sh Parameters The parameter target-architecture determines the CPU architecture of the target.
NCS Toolkit Running the Sample programs z mds_demo Builds the MDS sample program z mbcsv_demo Builds the Message-based Checkpointing Service sample program z srmsv_demo Builds the System Resource Monitoring Service sample program Example To build the LEAP sample application for a PowerPC target, run the following command: ./make_env.sh mvl-ppc leaptest_demo A.5 Running the Sample programs This sections describes the steps to run the sample programs. A.5.
Setting LD_LIBRARY_PATH A.5.2 NCS Toolkit Setting LD_LIBRARY_PATH Set the environment variable LD_LIBRARY_PATH to include the directory in which NCS libraries are installed. For a system manager host setup, the path is: export LD_LIBRARY_PATH=/opt/motorola/ncs/scxb/lib For a payload node setup, the path is: export LD_LIBRARY_PATH=/opt/motorola/ncs/pld/lib For running the AvSv demo, the Xerces XML parser must be installed and available. The Xerces package should be installed in /opt/xerces-c-src_2_5_0.
NCS Toolkit 50 Running the Sample Programs NetPlane Core Services Overview User’s Guide (6806800C08B)
B Related Documentation B.1 B Motorola Embedded Communications Computing Documents The Motorola publications listed below are referenced in this manual. You can obtain electronic copies of Embedded Communications Computing (ECC) publications by contacting your local Motorola sales office or by visiting ECC’s World Wide Web literature site: http://www.motorola.com/computer/literature. This site provides the most up-to-date copies of ECC product documentation.
Related Documentation B.2 Related Specifications Related Specifications For additional information, refer to the following table for related specifications. As an additional help, a source for the listed document is provided. Please note that, while these sources have been verified, the information is subject to change without notice.
